refactor: only include "required by modules" suffix for checks that a…

…re module-specific As soon as a module includes a field or type, it includes all of its specialities. Checks like whether the type match are independent of the module selection. For this reason, it is noisy and confusing to include the list of modules in the messages.
AEB-labs · Sep 12, 2024 · 5e5635c · 5e5635c
1 parent f066a10
commit 5e5635c
Show file tree

Hide file tree

Showing 29 changed files with 107 additions and 213 deletions.
diff --git a/spec/model/compatibility-check/check-business-object.spec.ts b/spec/model/compatibility-check/check-business-object.spec.ts
@@ -22,7 +22,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Type "Test" needs to be decorated with @businessObject (required by module "module1").',
+                'Type "Test" needs to be decorated with @businessObject.',
             );
         });
 

diff --git a/spec/model/compatibility-check/check-calc-mutations.spec.ts b/spec/model/compatibility-check/check-calc-mutations.spec.ts
@@ -22,7 +22,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "Test.test" should be decorated with @calcMutations(operators: [ADD]) (required by module "module1").',
+                'Field "Test.test" should be decorated with @calcMutations(operators: [ADD]).',
             );
         });
 
@@ -41,7 +41,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "Test.test" should be decorated with @calcMutations(operators: [ADD, MULTIPLY]) (required by module "module1").',
+                'Field "Test.test" should be decorated with @calcMutations(operators: [ADD, MULTIPLY]).',
             );
         });
 
@@ -58,10 +58,7 @@ describe('checkModel', () => {
                     }
                 `,
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Operator MULTIPLY is missing (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Operator MULTIPLY is missing.');
         });
 
         it('rejects three missing operators', () => {
@@ -79,7 +76,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Operators ADD, SUBTRACT and DIVIDE are missing (required by module "module1").',
+                'Operators ADD, SUBTRACT and DIVIDE are missing.',
             );
         });
 

diff --git a/spec/model/compatibility-check/check-collect-field.spec.ts b/spec/model/compatibility-check/check-collect-field.spec.ts
@@ -32,7 +32,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "Test.items2" should not be a collect field (required by module "module1").',
+                'Field "Test.items2" should not be a collect field.',
             );
         });
 
@@ -61,7 +61,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "Test.items2" should be decorated with @collect(path: "items") (required by module "module1").',
+                'Field "Test.items2" should be decorated with @collect(path: "items").',
             );
         });
 
@@ -90,7 +90,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "Test.sum" should be decorated with @collect(path: "items.value", aggregate: SUM) (required by module "module1").',
+                'Field "Test.sum" should be decorated with @collect(path: "items.value", aggregate: SUM).',
             );
         });
 
@@ -119,10 +119,7 @@ describe('checkModel', () => {
                     }
                 `,
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Path should be "items.value1" (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Path should be "items.value1".');
         });
 
         it('rejects a wrong aggregate argument', () => {
@@ -150,7 +147,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Collect field should specify aggregate: COUNT_NULL (required by module "module1").',
+                'Collect field should specify aggregate: COUNT_NULL.',
             );
         });
 

diff --git a/spec/model/compatibility-check/check-default-value.spec.ts b/spec/model/compatibility-check/check-default-value.spec.ts
@@ -27,7 +27,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "Test.field" should not have a default value (required by module "module1").',
+                'Field "Test.field" should not have a default value.',
             );
         });
 
@@ -51,7 +51,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "Test.field" should be decorated with @defaultValue(value: "hello") (required by module "module1").',
+                'Field "Test.field" should be decorated with @defaultValue(value: "hello").',
             );
         });
 
@@ -73,10 +73,7 @@ describe('checkModel', () => {
                     allowWarningsAndInfosInProjectToCheck: true,
                 },
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Default value should be "correct" (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Default value should be "correct".');
         });
 
         it('rejects a wrong @defaultValue with an Int type', () => {
@@ -97,10 +94,7 @@ describe('checkModel', () => {
                     allowWarningsAndInfosInProjectToCheck: true,
                 },
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Default value should be 42 (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Default value should be 42.');
         });
 
         it('rejects a wrong @defaultValue with a Float type', () => {
@@ -121,10 +115,7 @@ describe('checkModel', () => {
                     allowWarningsAndInfosInProjectToCheck: true,
                 },
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Default value should be 6.28 (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Default value should be 6.28.');
         });
 
         it('rejects a wrong @defaultValue with an [Int] type', () => {
@@ -145,10 +136,7 @@ describe('checkModel', () => {
                     allowWarningsAndInfosInProjectToCheck: true,
                 },
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Default value should be [1, 2, 3] (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Default value should be [1, 2, 3].');
         });
 
         it('rejects a wrong @defaultValue with a value object type', () => {
@@ -179,10 +167,7 @@ describe('checkModel', () => {
                     allowWarningsAndInfosInProjectToCheck: true,
                 },
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Default value should be {a: true, b: false} (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Default value should be {a: true, b: false}.');
         });
 
         it('accepts a correct @defaultValue with a String type', () => {

diff --git a/spec/model/compatibility-check/check-enums.spec.ts b/spec/model/compatibility-check/check-enums.spec.ts
@@ -21,10 +21,7 @@ describe('checkModel', () => {
                     }
                 `,
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Enum value "VALUE2" is missing (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Enum value "VALUE2" is missing.');
         });
 
         it('accepts an additional enum value', () => {

diff --git a/spec/model/compatibility-check/check-field-type.spec.ts b/spec/model/compatibility-check/check-field-type.spec.ts
@@ -39,7 +39,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "Test.field" needs to be of type "String" (required by module "module1").',
+                'Field "Test.field" needs to be of type "String".',
             );
             expectQuickFix(
                 result,
@@ -63,10 +63,7 @@ describe('checkModel', () => {
                     }
                 `,
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Field "Test.field" needs to be a list (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Field "Test.field" needs to be a list.');
             expectQuickFix(
                 result,
                 'Change type to "[String]"',
@@ -89,10 +86,7 @@ describe('checkModel', () => {
                     }
                 `,
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Field "Test.field" should not be a list (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Field "Test.field" should not be a list.');
             expectQuickFix(
                 result,
                 'Change type to "String"',

diff --git a/spec/model/compatibility-check/check-flex-search-on-field.spec.ts b/spec/model/compatibility-check/check-flex-search-on-field.spec.ts
@@ -20,10 +20,7 @@ describe('checkModel', () => {
                     }
                 `,
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Field "field" should enable @flexSearch (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Field "field" should enable @flexSearch.');
         });
 
         it('accepts @flexSearch is present', () => {
@@ -73,7 +70,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "field" should enable @flexSearch(includeInSearch: true) (required by module "module1").',
+                'Field "field" should enable @flexSearch(includeInSearch: true).',
             );
         });
 
@@ -92,7 +89,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "field" should enable @flexSearch(includeInSearch: true) (required by module "module1").',
+                'Field "field" should enable @flexSearch(includeInSearch: true).',
             );
         });
 
@@ -145,7 +142,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "field" should enable @flexSearchFulltext (required by module "module1").',
+                'Field "field" should enable @flexSearchFulltext.',
             );
         });
 
@@ -164,7 +161,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "field" should enable @flexSearchFulltext (required by module "module1").',
+                'Field "field" should enable @flexSearchFulltext.',
             );
         });
 
@@ -215,7 +212,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "field" should enable @flexSearch(includeInSearch: true) (required by module "module1").',
+                'Field "field" should enable @flexSearch(includeInSearch: true).',
             );
         });
 
@@ -234,7 +231,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "field" should enable @flexSearch(includeInSearch: true) (required by module "module1").',
+                'Field "field" should enable @flexSearch(includeInSearch: true).',
             );
         });
 

diff --git a/spec/model/compatibility-check/check-flex-search-on-type.spec.ts b/spec/model/compatibility-check/check-flex-search-on-type.spec.ts
@@ -20,10 +20,7 @@ describe('checkModel', () => {
                     }
                 `,
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Type "Test" needs to be enable flexSearch (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Type "Test" needs to be enable flexSearch.');
         });
 
         it('rejects if flexSearch is set to false', () => {
@@ -39,10 +36,7 @@ describe('checkModel', () => {
                     }
                 `,
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Type "Test" needs to be enable flexSearch (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Type "Test" needs to be enable flexSearch.');
         });
 
         it('accepts if flexSearch is set to true even if not needed', () => {
@@ -81,7 +75,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Type "Test" should specify flexSearchOrder: [{field: "field", direction: ASC}] (required by module "module1").',
+                'Type "Test" should specify flexSearchOrder: [{field: "field", direction: ASC}].',
             );
         });
 
@@ -104,7 +98,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Type "Test" should not specify a custom flexSearchOrder (required by module "module1").',
+                'Type "Test" should not specify a custom flexSearchOrder.',
             );
         });
 
@@ -132,7 +126,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Type "Test" should specify flexSearchOrder: [{field: "field", direction: DESC}] (required by module "module1").',
+                'Type "Test" should specify flexSearchOrder: [{field: "field", direction: DESC}].',
             );
         });
     });

diff --git a/spec/model/compatibility-check/check-key-field.spec.ts b/spec/model/compatibility-check/check-key-field.spec.ts
@@ -22,7 +22,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "Test.field" needs to be decorated with @key (required by module "module1").',
+                'Field "Test.field" needs to be decorated with @key.',
             );
         });
         it('accepts if the field is properly decorated with @key', () => {
@@ -55,10 +55,7 @@ describe('checkModel', () => {
                     }
                 `,
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Field "id: ID @key" needs to be specified (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Field "id: ID @key" needs to be specified.');
         });
 
         it('rejects if the id field needs to be decorated with @key', () => {
@@ -79,7 +76,7 @@ describe('checkModel', () => {
             );
             expectSingleCompatibilityIssue(
                 result,
-                'Field "Test.id" needs to be decorated with @key (required by module "module1").',
+                'Field "Test.id" needs to be decorated with @key.',
             );
         });
 

diff --git a/spec/model/compatibility-check/check-model.spec.ts b/spec/model/compatibility-check/check-model.spec.ts
@@ -79,10 +79,7 @@ type Test @rootEntity {
                     }
                 `,
             );
-            expectSingleCompatibilityIssue(
-                result,
-                'Type "Test" needs to be a root entity type (required by module "module1").',
-            );
+            expectSingleCompatibilityIssue(result, 'Type "Test" needs to be a root entity type.');
         });
     });
 });
-Original file line number
+Diff line change
@@ Expand Up / @@ -22,7 +22,7 @@ describe('checkModel', () => { @@
                 );
                 expectSingleCompatibilityIssue(
                     result,
-                    'Type "Test" needs to be decorated with @businessObject (required by module "module1").',
+                    'Type "Test" needs to be decorated with @businessObject.',
                 );
             });
@@ Expand Down @@