[Synthtrace] Sanitize default value for error grouping key (elastic#2…

…10010) ## Summary Closes elastic#209096
nreese · Feb 7, 2025 · ba5ae97 · ba5ae97
1 parent 9409a43
commit ba5ae97
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 9 deletions.
diff --git a/packages/kbn-apm-synthtrace-client/src/lib/apm/instance.ts b/packages/kbn-apm-synthtrace-client/src/lib/apm/instance.ts
@@ -7,7 +7,6 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import { createHash } from 'crypto';
 import { ApmError } from './apm_error';
 import { Entity } from '../entity';
 import { Metricset } from './metricset';
@@ -114,7 +113,3 @@ export class Instance extends Entity<ApmFields> {
     });
   }
 }
-
-export function getErrorGroupingKey(content: string) {
-  return createHash('sha256').update(content).digest('hex');
-}
diff --git a/packages/kbn-apm-synthtrace-client/src/lib/utils/generate_id.ts b/packages/kbn-apm-synthtrace-client/src/lib/utils/generate_id.ts
@@ -24,7 +24,10 @@ function generateId(length: number = LONG_ID_LENGTH) {
 }
 
 function generateIdWithSeed(seed: string, length: number = LONG_ID_LENGTH) {
-  return seed?.padStart(length, '0');
+  // this is needed to sanitize errors like "No handler for /order/{id}",
+  // as encodeURIComponent is not enough and can cause errors in the client
+  const encodedSeed = seed.replace(/[/]/g, '_').replace(/[{}]/g, '');
+  return encodedSeed?.padStart(length, '0');
 }
 
 export function generateShortId() {

diff --git a/x-pack/solutions/observability/plugins/apm/ftr_e2e/cypress/e2e/errors/error_details.cy.ts b/x-pack/solutions/observability/plugins/apm/ftr_e2e/cypress/e2e/errors/error_details.cy.ts
@@ -5,7 +5,6 @@
  * 2.0.
  */
 
-import { getErrorGroupingKey } from '@kbn/apm-synthtrace-client/src/lib/apm/instance';
 import { generateLongIdWithSeed } from '@kbn/apm-synthtrace-client/src/lib/utils/generate_id';
 
 import url from 'url';
@@ -36,7 +35,7 @@ describe('Error details', () => {
     });
 
     it('has no detectable a11y violations on load', () => {
-      const errorGroupingKey = getErrorGroupingKey('Error 1');
+      const errorGroupingKey = generateLongIdWithSeed('Error 1');
       const errorGroupingKeyShort = errorGroupingKey.slice(0, 5);
       const errorDetailsPageHref = url.format({
         pathname: `/app/apm/services/opbeans-java/errors/${errorGroupingKey}`,
@@ -54,7 +53,7 @@ describe('Error details', () => {
 
     describe('when error has no occurrences', () => {
       it('shows zero occurrences', () => {
-        const errorGroupingKey = getErrorGroupingKey('Error foo bar');
+        const errorGroupingKey = generateLongIdWithSeed('Error foo bar');
 
         cy.visitKibana(
           url.format({