fix(metadata): prevent framework misclassification in codebase detection #96
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -211,6 +211,8 @@ export interface FrameworkInfo { | |
| stateManagement?: string[]; // 'ngrx', 'redux', 'zustand', 'pinia', etc. | ||
| uiLibraries?: string[]; | ||
| testingFrameworks?: string[]; | ||
| /** Enumerated evidence signals that triggered this framework claim (e.g. 'dep:next', 'disk:app-router'). */ | ||
| indicators?: readonly string[]; | ||
| } | ||
|
|
||
| export interface LanguageInfo { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -143,4 +143,92 @@ describe('CodebaseIndexer.detectMetadata', () => { | |
| expect(typeof metadata.customMetadata).toBe('object'); | ||
| }); | ||
| }); | ||
|
|
||
| describe('framework misclassification guards', () => { | ||
| it('does not claim framework for plain Node project', async () => { | ||
| await fs.writeFile( | ||
| path.join(tempDir, 'package.json'), | ||
| JSON.stringify({ name: 'plain-node', dependencies: { zod: '^3' } }) | ||
| ); | ||
|
|
||
| const indexer = new CodebaseIndexer({ rootPath: tempDir }); | ||
| const metadata = await indexer.detectMetadata(); | ||
|
|
||
| expect(metadata.framework).toBeUndefined(); | ||
| }); | ||
|
|
||
| it('drops React claim when indicators are below threshold', async () => { | ||
| // react alone is only 1 indicator — should not meet the >=3 threshold | ||
| await fs.writeFile( | ||
| path.join(tempDir, 'package.json'), | ||
| JSON.stringify({ name: 'thin-react', dependencies: { react: '^18' } }) | ||
| ); | ||
|
|
||
| const indexer = new CodebaseIndexer({ rootPath: tempDir }); | ||
|
Comment on lines
+155
to
+167
Contributor
There was a problem hiding this comment.
The comment on this test says "react alone is only 1 indicator — should not meet the >=3 threshold." The symmetric case — it('drops React claim for react + react-dom without @types/react (2 indicators)', async () => {
await fs.writeFile(
path.join(tempDir, 'package.json'),
JSON.stringify({ name: 'js-react', dependencies: { react: '^18', 'react-dom': '^18' } })
);
const indexer = new CodebaseIndexer({ rootPath: tempDir });
const metadata = await indexer.detectMetadata();
// Decide: should this be undefined (current) or 'react' (intended)?
expect(metadata.framework?.type).toBe('react'); // currently fails
}); |
||
| const metadata = await indexer.detectMetadata(); | ||
|
|
||
| expect(metadata.framework).toBeUndefined(); | ||
| }); | ||
|
|
||
| it('preserves Next.js preference over React when both pass threshold', async () => { | ||
| // next + react + react-dom + app/ = 4 Next.js indicators; react + react-dom = 2 React indicators | ||
| await fs.writeFile( | ||
| path.join(tempDir, 'package.json'), | ||
| JSON.stringify({ | ||
| name: 'next-project', | ||
| dependencies: { next: '^14.1.0', react: '^18.2.0', 'react-dom': '^18.2.0' }, | ||
| }) | ||
| ); | ||
| await fs.mkdir(path.join(tempDir, 'app'), { recursive: true }); | ||
|
|
||
| const indexer = new CodebaseIndexer({ rootPath: tempDir }); | ||
| const metadata = await indexer.detectMetadata(); | ||
|
|
||
| expect(metadata.framework?.type).toBe('nextjs'); | ||
| }); | ||
|
|
||
| it('detects React when sufficient indicators are present', async () => { | ||
| await fs.writeFile( | ||
| path.join(tempDir, 'package.json'), | ||
| JSON.stringify({ | ||
| name: 'react-app', | ||
| dependencies: { react: '^18', 'react-dom': '^18' }, | ||
| devDependencies: { '@types/react': '^18' }, | ||
| }) | ||
| ); | ||
|
|
||
| const indexer = new CodebaseIndexer({ rootPath: tempDir }); | ||
| const metadata = await indexer.detectMetadata(); | ||
|
|
||
| expect(metadata.framework?.type).toBe('react'); | ||
| expect(metadata.framework?.indicators).toContain('dep:react'); | ||
| }); | ||
|
|
||
| it('detects Angular library project with @angular/core in peerDependencies + ng-package.json', async () => { | ||
| await fs.writeFile( | ||
| path.join(tempDir, 'package.json'), | ||
| JSON.stringify({ | ||
| name: 'my-angular-lib', | ||
| peerDependencies: { | ||
| '@angular/core': '^17.0.0', | ||
| '@angular/common': '^17.0.0', | ||
| }, | ||
| devDependencies: { | ||
| '@angular/compiler-cli': '^17.0.0', | ||
| } | ||
| }) | ||
| ); | ||
| await fs.writeFile( | ||
| path.join(tempDir, 'ng-package.json'), | ||
| JSON.stringify({ lib: { entryFile: 'src/public-api.ts' } }) | ||
| ); | ||
|
|
||
| const indexer = new CodebaseIndexer({ rootPath: tempDir }); | ||
| const metadata = await indexer.detectMetadata(); | ||
|
|
||
| expect(metadata.framework?.type).toBe('angular'); | ||
| expect(metadata.framework?.indicators).toContain('dep:@angular/core'); | ||
| expect(metadata.framework?.indicators).toContain('disk:ng-package-json'); | ||
| }); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
dep:@angular/coreis the only guaranteed indicator in this block — the rest are conditional. An Angular library project that lists@angular/coreinpeerDependencies(no@angular/common, and no CLI-generatedangular.jsonortsconfig.app.json) ends up with just 1 indicator, well belowMIN_INDICATORS = 3. Unlike the oldbase.framework || incoming.frameworkpath,selectFrameworkwill silently returnundefined.Before this PR,
angularCoreVersionalone was sufficient to classify a project as Angular (which is a much tighter guard than justdep:react). The same threshold now uniformly penalises Angular, which had a more reliable single-dep signal to begin with.Suggested mitigations:
ng-package.json(Angular library projects) andtsconfig.jsonso library projects get extra indicators.