Feat/block suggestions plugin/remove extra chars (#730)

* feat(packages/plugins/block-field-suggestions): remove trailing question mark from masked message * feat(packages/plugins/block-field-suggestions): remove trailing whitespace from masked message * style(test): format expected error message mapping * chore(changeset): add major update for graphql-armor-block-field-suggestions --------- Co-authored-by: nullswan <[email protected]>
Escape-Technologies · Nov 5, 2024 · 0a26be4 · 0a26be4
1 parent 638ee7d
commit 0a26be4
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 4 deletions.
diff --git a/.changeset/long-peas-develop.md b/.changeset/long-peas-develop.md
@@ -0,0 +1,5 @@
+---
+'@escape.tech/graphql-armor-block-field-suggestions': major
+---
+
+feat(field-suggestion): remove extra chars
diff --git a/examples/yoga/test/index.spec.ts b/examples/yoga/test/index.spec.ts
@@ -88,7 +88,7 @@ describe('startup', () => {
     expect(body.data?.books).toBeUndefined();
     expect(body.errors).toBeDefined();
     expect(body.errors?.map((e) => e.message)).toContain(
-      'Cannot query field "titlee" on type "Book". [Suggestion hidden]?',
+      'Cannot query field "titlee" on type "Book". [Suggestion hidden]',
     );
   });
 

diff --git a/packages/plugins/block-field-suggestions/src/index.ts b/packages/plugins/block-field-suggestions/src/index.ts
@@ -8,7 +8,7 @@ const blockFieldSuggestionsDefaultOptions: Required<BlockFieldSuggestionsOptions
 
 const formatter = (error: GraphQLError, mask: string): GraphQLError => {
   if (error instanceof GraphQLError) {
-    error.message = error.message.replace(/Did you mean ".+"/g, mask);
+    error.message = error.message.replace(/Did you mean ".+"\?/g, mask).trim();
   }
   return error as GraphQLError;
 };

diff --git a/packages/plugins/block-field-suggestions/test/index.spec.ts b/packages/plugins/block-field-suggestions/test/index.spec.ts
@@ -84,7 +84,7 @@ describe('global', () => {
     assertSingleExecutionValue(result);
     expect(result.errors).toBeDefined();
     expect(result.errors?.map((error) => error.message)).toEqual([
-      'Cannot query field "titlee" on type "Book". [Suggestion hidden]?',
+      'Cannot query field "titlee" on type "Book". [Suggestion hidden]',
     ]);
   });
 
@@ -95,7 +95,16 @@ describe('global', () => {
     assertSingleExecutionValue(result);
     expect(result.errors).toBeDefined();
     expect(result.errors?.map((error) => error.message)).toEqual([
-      'Cannot query field "titlee" on type "Book". <[REDACTED]>?',
+      'Cannot query field "titlee" on type "Book". <[REDACTED]>',
     ]);
   });
+
+  it('should use remove suggestion completely with emptry string for mask', async () => {
+    const testkit = createTestkit([blockFieldSuggestionsPlugin({ mask: '' })], schema);
+    const result = await testkit.execute(query);
+
+    assertSingleExecutionValue(result);
+    expect(result.errors).toBeDefined();
+    expect(result.errors?.map((error) => error.message)).toEqual(['Cannot query field "titlee" on type "Book".']);
+  });
 });