From b5a95665c81bd8460cff01c32cc0c7746306504d Mon Sep 17 00:00:00 2001 From: ashup Date: Tue, 17 Nov 2026 21:16:59 +0530 Subject: [PATCH] fix(concerto-analysis): report AST instances in finding.element (closes #1645) Signed-off-by: ashup --- .../src/comparers/properties.ts | 2 +- .../src/comparers/scalar-declarations.ts | 14 +++++++------- .../concerto-analysis/test/unit/compare.test.ts | 17 ++++++++++++++--- 3 files changed, 22 insertions(+), 11 deletions(-) diff --git a/packages/concerto-analysis/src/comparers/properties.ts b/packages/concerto-analysis/src/comparers/properties.ts index 69504ad0e..0e9f603eb 100644 --- a/packages/concerto-analysis/src/comparers/properties.ts +++ b/packages/concerto-analysis/src/comparers/properties.ts @@ -287,7 +287,7 @@ const propertyDefaultChanged: ComparerFactory = (context) => ({ message: changeType === 'added' ? `Default value "${bDefaultValue}" added to property "${a.getName()}" in the ${classDeclarationType} "${a.getParent().getName()}"` : changeType === 'removed' ? `Default value "${aDefaultValue}" removed from property "${a.getName()}" in the ${classDeclarationType} "${a.getParent().getName()}"` : `Default value changed from "${aDefaultValue}" to "${bDefaultValue}" in property "${a.getName()}" in the ${classDeclarationType} "${a.getParent().getName()}"`, - element: a.getName() + element: a }); } }); diff --git a/packages/concerto-analysis/src/comparers/scalar-declarations.ts b/packages/concerto-analysis/src/comparers/scalar-declarations.ts index 343fcc250..df1f56466 100644 --- a/packages/concerto-analysis/src/comparers/scalar-declarations.ts +++ b/packages/concerto-analysis/src/comparers/scalar-declarations.ts @@ -26,7 +26,7 @@ const scalarDeclarationExtendsChanged: ComparerFactory = (context) => ({ context.report({ key: 'scalar-extends-changed', message: `The scalar extends was changed from "${a.getType()}" to "${b.getType()}"`, - element: b.getName() + element: a }); } }, @@ -46,7 +46,7 @@ const scalarValidatorChanged: ComparerFactory = (context) => ({ context.report({ key: 'scalar-validator-added', message: `A ${bValidatorType} validator was added to the scalar "${a.getName()}"`, - element: a.getName() + element: a }); return; } else if (aValidator && !bValidator) { @@ -54,7 +54,7 @@ const scalarValidatorChanged: ComparerFactory = (context) => ({ context.report({ key: 'scalar-validator-removed', message: `A ${aValidatorType} validator was removed from the scalar "${a.getName()}"`, - element: a.getName() + element: a }); return; } else if (!aValidator!.compatibleWith(bValidator)) { @@ -62,7 +62,7 @@ const scalarValidatorChanged: ComparerFactory = (context) => ({ context.report({ key: 'scalar-validator-changed', message: `A ${aValidatorType} validator for the scalar "${a.getName()}" was changed and is no longer compatible`, - element: a.getName() + element: a }); return; } @@ -82,19 +82,19 @@ const scalarDefaultValueChanged: ComparerFactory = (context) => ({ context.report({ key: 'scalar-default-value-added', message: `Default value "${bDefaultValue}" added to scalar "${a.getName()}"`, - element: a.getName() + element: a }); } else if (bDefaultValue === null) { context.report({ key: 'scalar-default-value-removed', message: `Default value "${aDefaultValue}" removed from scalar "${a.getName()}"`, - element: a.getName() + element: a }); } else { context.report({ key: 'scalar-default-value-changed', message: `Default value changed from "${aDefaultValue}" to "${bDefaultValue}" in scalar "${a.getName()}"`, - element: a.getName() + element: a }); } } diff --git a/packages/concerto-analysis/test/unit/compare.test.ts b/packages/concerto-analysis/test/unit/compare.test.ts index 4b5713607..e867fcdb8 100644 --- a/packages/concerto-analysis/test/unit/compare.test.ts +++ b/packages/concerto-analysis/test/unit/compare.test.ts @@ -279,14 +279,17 @@ test('should detect a map value type changing from x to y', async () => { test('should detect a scalar extends changing from x to y', async () => { const [a, b] = await getModelFiles('scalar-added.cto', 'scalar-changed-extends.cto'); + const scalar = a.getScalarDeclarations().find(s => s.getName() === 'Thing'); const results = new Compare().compare(a, b); expect(results.findings).toEqual(expect.arrayContaining([ expect.objectContaining({ key: 'scalar-extends-changed', - message: 'The scalar extends was changed from "String" to "Integer"' + message: 'The scalar extends was changed from "String" to "Integer"', + element: scalar }) ])); expect(results.findings[0].message).toBe('The scalar extends was changed from "String" to "Integer"'); + expect(results.findings[0].element).toBe(scalar); expect(results.result).toBe(CompareResult.MAJOR); }); @@ -514,11 +517,13 @@ test('should detect a string validator being changed on a property (incompatible test('should detect a number validator being added to a scalar', async () => { const [a, b] = await getModelFiles('scalar-number-validators.cto', 'scalar-number-validator-added.cto'); + const scalar = a.getScalarDeclarations().find(s => s.getName() === 'Thing'); const results = new Compare().compare(a, b); expect(results.findings).toEqual(expect.arrayContaining([ expect.objectContaining({ key: 'scalar-validator-added', - message: 'A number validator was added to the scalar "Thing"' + message: 'A number validator was added to the scalar "Thing"', + element: scalar }) ])); expect(results.result).toBe(CompareResult.MAJOR); @@ -526,11 +531,13 @@ test('should detect a number validator being added to a scalar', async () => { test('should detect a number validator being removed from a scalar', async () => { const [a, b] = await getModelFiles('scalar-number-validator-added.cto', 'scalar-number-validators.cto'); + const scalar = a.getScalarDeclarations().find(s => s.getName() === 'Thing'); const results = new Compare().compare(a, b); expect(results.findings).toEqual(expect.arrayContaining([ expect.objectContaining({ key: 'scalar-validator-removed', - message: 'A number validator was removed from the scalar "Thing"' + message: 'A number validator was removed from the scalar "Thing"', + element: scalar }) ])); expect(results.result).toBe(CompareResult.PATCH); @@ -711,6 +718,7 @@ test('should detect an optional property changed to required', async () => { test('should detect a default value being added to a scalar', async () => { const [a, b] = await getModelFiles('scalar-added.cto', 'scalar-default-value-added.cto'); + const scalar = a.getScalarDeclarations().find(s => s.getName() === 'Thing'); const results = new Compare().compare(a, b); const findings = results.findings.map(finding => ({ key: finding.key, @@ -722,6 +730,7 @@ test('should detect a default value being added to a scalar', async () => { message: 'Default value "hello" added to scalar "Thing"', }), ])); + expect(results.findings[0].element).toBe(scalar); expect(results.result).toBe(CompareResult.MINOR); }); @@ -775,6 +784,7 @@ test('should detect a falsy default value being removed from a scalar', async () test('should detect a default value being added to a property', async () => { const [a, b] = await getModelFiles('property-added.cto', 'property-default-value-added.cto'); + const property = a.getConceptDeclarations().find(c => c.getName() === 'Thing')?.getProperty('name'); const results = new Compare().compare(a, b); const findings = results.findings.map(finding => ({ key: finding.key, @@ -786,6 +796,7 @@ test('should detect a default value being added to a property', async () => { message: 'Default value "Fred" added to property "name" in the concept "Thing"', }), ])); + expect(results.findings[0].element).toBe(property); expect(results.result).toBe(CompareResult.MINOR); });