generic message reporting

salesforce · May 22, 2024 · cbac675 · cbac675
1 parent 27b51cd
commit cbac675
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 30 deletions.
diff --git a/src/rules/graphql/unsupported-scope.ts b/src/rules/graphql/unsupported-scope.ts
@@ -3,25 +3,19 @@ import { Kind } from 'graphql';
 
 export const UNSUPPORTED_SCOPE_RULE_ID = 'offline-graphql-unsupported-scope';
 
-export const ASSIGNED_TO_ME_SUPPORTED_FOR_SERVICEAPPOINTMENT_ONLY =
-    'ASSIGNED_TO_ME__SERVICEAPPOINTMENT_ONLY';
+export const SCOPE_SUPPORTED_FOR_CERTAIN_ENTITIES_ONLY = 'ASSIGNED_TO_ME__SERVICEAPPOINTMENT_ONLY';
 export const OTHER_UNSUPPORTED_SCOPE = 'OTHER_UNSUPPORTED_SCOPE';
 
-const unsupportedScopes = [
-    'TEAM',
-    'QUEUE_OWNED',
-    'USER_OWNED',
-    'EVERYTHING',
-    'TEAM_BY_ROLE',
-    'GENERICTEAM',
-    'FOLLOWING',
-    'FILES_SHARED_WITH_ME'
-];
+// key is scope name, value is the array of supported entities. Empty array means that all entities are supported.
+const supportedScopes: Record<string, string[]> = {
+    MINE: [],
+    ASSIGNEDTOME: ['ServiceAppointment']
+};
 export const rule: GraphQLESLintRule = {
     meta: {
         type: 'problem',
         docs: {
-            description: `For mobile offline use cases, scope "ASSIGNEDTOME" is only supported for ServiceAppointment . All other unsupported scopes are team, queue-owned, user-owned and everything. `,
+            description: `For mobile offline use cases, scope "MINE" is supported and scope "ASSIGNEDTOME" is only supported for ServiceAppointment . All other scopes like TEAM, QUEUE_OWNED and USER_OWNED are not supported `,
             category: 'Operations',
             recommended: true,
             examples: [
@@ -64,8 +58,8 @@ export const rule: GraphQLESLintRule = {
             ]
         },
         messages: {
-            [ASSIGNED_TO_ME_SUPPORTED_FOR_SERVICEAPPOINTMENT_ONLY]:
-                'Offline GraphQL: Scope ‘ASSIGNEDTOME’ is only supported for the ServiceAppointment entity, for mobile offline use cases',
+            [SCOPE_SUPPORTED_FOR_CERTAIN_ENTITIES_ONLY]:
+                'Offline GraphQL: Scope "{{scopeName}}" is only supported for the "{{supportedEntities}}" entity, for mobile offline use cases',
             [OTHER_UNSUPPORTED_SCOPE]:
                 'Offline GraphQL: Scope "{{scopeName}}" is unsupported for mobile offline use cases.'
         },
@@ -78,7 +72,7 @@ export const rule: GraphQLESLintRule = {
                 if (node.name.value === 'scope') {
                     if (node.value.kind === Kind.ENUM) {
                         const scopeName = node.value.value;
-                        if (unsupportedScopes.includes(scopeName)) {
+                        if (supportedScopes[scopeName] === undefined) {
                             context.report({
                                 messageId: OTHER_UNSUPPORTED_SCOPE,
                                 data: {
@@ -89,19 +83,26 @@ export const rule: GraphQLESLintRule = {
                                     end: node.value.loc.end
                                 }
                             });
-                        } else if (node.value.value === 'ASSIGNEDTOME') {
-                            const entityNode = node.parent as any;
-                            if (
-                                entityNode.name.kind === Kind.NAME &&
-                                entityNode.name.value !== 'ServiceAppointment'
-                            ) {
-                                context.report({
-                                    messageId: ASSIGNED_TO_ME_SUPPORTED_FOR_SERVICEAPPOINTMENT_ONLY,
-                                    loc: {
-                                        start: node.loc.start,
-                                        end: node.value.loc.end
+                        } else {
+                            const entities = supportedScopes[scopeName];
+                            if (entities.length > 0) {
+                                const entityNode = node.parent as any;
+                                if (entityNode.name.kind === Kind.NAME) {
+                                    const entityName = entityNode.name.value;
+                                    if (!entities.includes(entityName)) {
+                                        context.report({
+                                            messageId: SCOPE_SUPPORTED_FOR_CERTAIN_ENTITIES_ONLY,
+                                            loc: {
+                                                start: node.loc.start,
+                                                end: node.value.loc.end
+                                            },
+                                            data: {
+                                                scopeName,
+                                                supportedEntities: entities.join(', ')
+                                            }
+                                        });
                                     }
-                                });
+                                }
                             }
                         }
                     }

diff --git a/test/rules/graphql/unsupported-scope.spec.ts b/test/rules/graphql/unsupported-scope.spec.ts
@@ -1,7 +1,7 @@
 import { RuleTester } from '@typescript-eslint/rule-tester';
 import {
     rule,
-    ASSIGNED_TO_ME_SUPPORTED_FOR_SERVICEAPPOINTMENT_ONLY,
+    SCOPE_SUPPORTED_FOR_CERTAIN_ENTITIES_ONLY,
     OTHER_UNSUPPORTED_SCOPE
 } from '../../../src/rules/graphql/unsupported-scope';
 import { RULE_TESTER_CONFIG } from '../../shared';
@@ -76,7 +76,15 @@ ruleTester.run('@salesforce/lwc-mobile/offline-graphql-unsupported-scope', rule
                     }
                 }
             `,
-            errors: [{ messageId: ASSIGNED_TO_ME_SUPPORTED_FOR_SERVICEAPPOINTMENT_ONLY }]
+            errors: [
+                {
+                    messageId: SCOPE_SUPPORTED_FOR_CERTAIN_ENTITIES_ONLY,
+                    data: {
+                        scopeName: 'ASSIGNEDTOME',
+                        supportedEntities: 'ServiceAppointment'
+                    }
+                }
+            ]
         }
     ]
 });