Skip to content

feat: only report newly introduced duplicate dependencies #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ocavue wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: only report newly introduced duplicate dependencies #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This action compares dependencies between your base branch and current branch, a
- 🔒 **Package trust levels** - Detects decreases in package trust levels (provenance and trusted publisher status)
- 📈 **Dependency growth** - Warns when dependency count increases significantly
- 📦 **Install size** - Warns when package size increases significantly
- 🔄 **Duplicate versions** - Detects packages with multiple versions installed
- 🔄 **Duplicate versions** - Detects packages which gain newly introduced duplicate versions
- ⚠️ **Module replacements** - Identifies new packages that have community-recommended alternatives

## Usage
Expand Down Expand Up @@ -44,7 +44,7 @@ jobs:
| `pr-number` | The number of the pull request to comment on | Yes | `${{ github.event.pull_request.number }}` |
| `dependency-threshold` | Threshold for warning about significant increase in number of dependencies | No | `10` |
| `size-threshold` | Threshold (in bytes) for warning about significant increase in package size | No | `100000` |
| `duplicate-threshold` | Threshold for warning about packages with multiple versions | No | `1` |
| `duplicate-threshold` | Threshold for warning about packages which gain newly introduced duplicate versions | No | `1` |
| `base-packages` | Glob pattern for base branch pack files (e.g., `"./base-packs/*.tgz"`) | No | None |
| `source-packages` | Glob pattern for source branch pack files (e.g., `"./source-packs/*.tgz"`) | No | None |
| `pack-size-threshold` | Threshold (in bytes) for warning about significant increase in total pack size. Set to `-1` to always report size changes. | No | `50000` |
Expand Down
2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ inputs:
required: false
default: '50000'
duplicate-threshold:
description: 'Threshold for warning about packages with multiple versions'
description: 'Threshold for warning about packages which gain newly introduced duplicate versions'
required: false
default: '1'
detect-replacements:
Expand Down
8 changes: 5 additions & 3 deletions build/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24615,11 +24615,12 @@ function computeParentPaths(lockfile, duplicateDependencyNames, dependencyMap) {
traverse(lockfile.root, visitor);
return parentPaths;
}
function scanForDuplicates(messages, threshold, dependencyMap, lockfilePath, lockfile) {
function scanForDuplicates(messages, threshold, dependencyMap, baseDependencyMap, lockfilePath, lockfile) {
const duplicateRows = [];
const duplicateDependencyNames = /* @__PURE__ */ new Set();
for (const [packageName, currentVersionSet] of dependencyMap) {
if (currentVersionSet.size > threshold) {
const baseVersionCount = baseDependencyMap.get(packageName)?.size ?? 0;
if (currentVersionSet.size > threshold && currentVersionSet.size > baseVersionCount) {
duplicateDependencyNames.add(packageName);
}
}
Expand Down Expand Up @@ -24673,7 +24674,7 @@ function scanForDuplicates(messages, threshold, dependencyMap, lockfilePath, loc

\u{1F4A1} To find out what depends on a specific package, run: \`${exampleCommand}\`` : "";
messages.push(
`## \u26A0\uFE0F Duplicate Dependencies (found: ${duplicateRows.length}, threshold: ${threshold})
`## \u26A0\uFE0F New Duplicate Dependencies (found: ${duplicateRows.length}, threshold: ${threshold})

| \u{1F4E6} Package | \u{1F4CB} Versions |
| --- | --- |
Expand Down Expand Up @@ -25129,6 +25130,7 @@ async function analyzeAndComment() {
messages,
duplicateThreshold,
currentDeps,
baseDeps,
lockfilePath,
parsedCurrentLock
);
Expand Down
9 changes: 7 additions & 2 deletions src/checks/duplicates.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,19 @@ export function scanForDuplicates(
messages: string[],
threshold: number,
dependencyMap: Map<string, Set<string>>,
baseDependencyMap: Map<string, Set<string>>,
lockfilePath: string,
lockfile: ParsedLockFile
): void {
const duplicateRows: string[] = [];
const duplicateDependencyNames = new Set<string>();

for (const [packageName, currentVersionSet] of dependencyMap) {
if (currentVersionSet.size > threshold) {
const baseVersionCount = baseDependencyMap.get(packageName)?.size ?? 0;
if (
currentVersionSet.size > threshold &&
currentVersionSet.size > baseVersionCount
) {
duplicateDependencyNames.add(packageName);
}
}
Expand Down Expand Up @@ -126,7 +131,7 @@ export function scanForDuplicates(
? `\n\n💡 To find out what depends on a specific package, run: \`${exampleCommand}\``
: '';
messages.push(
`## ⚠️ Duplicate Dependencies (found: ${duplicateRows.length}, threshold: ${threshold})
`## ⚠️ New Duplicate Dependencies (found: ${duplicateRows.length}, threshold: ${threshold})

| 📦 Package | 📋 Versions |
| --- | --- |
Expand Down
1 change: 1 addition & 0 deletions src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ async function analyzeAndComment(): Promise<void> {
messages,
duplicateThreshold,
currentDeps,
baseDeps,
lockfilePath,
parsedCurrentLock
);
Expand Down
16 changes: 14 additions & 2 deletions test/checks/__snapshots__/duplicates_test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`scanForDuplicates > should only report packages with more versions than the base 1`] = `
[
"## ⚠️ New Duplicate Dependencies (found: 1, threshold: 1)

| 📦 Package | 📋 Versions |
| --- | --- |
| package-a | <details><summary>2 versions</summary><br><ul><li>root-package@1.0.0<ul><li>**package-a@1.0.0**</li></ul></li></ul><br><ul><li>root-package@1.0.0<ul><li>package-b@3.0.0<ul><li>**package-a@1.1.0**</li></ul></li></ul></li></ul><br></details> |

💡 To find out what depends on a specific package, run: \`npm ls example-package\`",
]
`;

exports[`scanForDuplicates > should report duplicates when threshold is exceeded 1`] = `
[
"## ⚠️ Duplicate Dependencies (found: 1, threshold: 1)
"## ⚠️ New Duplicate Dependencies (found: 1, threshold: 1)

| 📦 Package | 📋 Versions |
| --- | --- |
Expand All @@ -14,7 +26,7 @@ exports[`scanForDuplicates > should report duplicates when threshold is exceeded

exports[`scanForDuplicates > should truncate long parent paths in the report 1`] = `
[
"## ⚠️ Duplicate Dependencies (found: 1, threshold: 1)
"## ⚠️ New Duplicate Dependencies (found: 1, threshold: 1)

| 📦 Package | 📋 Versions |
| --- | --- |
Expand Down
186 changes: 186 additions & 0 deletions test/checks/duplicates_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ describe('scanForDuplicates', () => {
messages,
threshold,
dependencyMap,
new Map(),
lockfilePath,
lockfile
);
Expand Down Expand Up @@ -84,6 +85,7 @@ describe('scanForDuplicates', () => {
messages,
threshold,
dependencyMap,
new Map(),
lockfilePath,
lockfile
);
Expand Down Expand Up @@ -140,6 +142,7 @@ describe('scanForDuplicates', () => {
messages,
threshold,
dependencyMap,
new Map(),
lockfilePath,
lockfile
);
Expand Down Expand Up @@ -203,6 +206,189 @@ describe('scanForDuplicates', () => {
messages,
threshold,
dependencyMap,
new Map(),
lockfilePath,
lockfile
);

expect(messages).toMatchSnapshot();
});

it('should not report duplicates which already exist in the base', () => {
const messages: string[] = [];
const threshold = 1;
const dependencyMap = new Map<string, Set<string>>([
['package-a', new Set(['1.0.0', '1.1.0'])]
]);
const baseDependencyMap = new Map<string, Set<string>>([
['package-a', new Set(['1.0.0', '1.1.0'])]
]);
const lockfilePath = 'package-lock.json';
const lockfile: ParsedLockFile = {
type: 'npm',
packages: [],
root: {
name: 'root-package',
version: '1.0.0',
dependencies: [],
devDependencies: [],
optionalDependencies: [],
peerDependencies: []
}
};

scanForDuplicates(
messages,
threshold,
dependencyMap,
baseDependencyMap,
lockfilePath,
lockfile
);

expect(messages).toHaveLength(0);
});

it('should not report duplicates when the version count is unchanged', () => {
const messages: string[] = [];
const threshold = 1;
const dependencyMap = new Map<string, Set<string>>([
['package-a', new Set(['1.0.0', '1.2.0'])]
]);
const baseDependencyMap = new Map<string, Set<string>>([
['package-a', new Set(['1.0.0', '1.1.0'])]
]);
const lockfilePath = 'package-lock.json';
const lockfile: ParsedLockFile = {
type: 'npm',
packages: [],
root: {
name: 'root-package',
version: '1.0.0',
dependencies: [],
devDependencies: [],
optionalDependencies: [],
peerDependencies: []
}
};

scanForDuplicates(
messages,
threshold,
dependencyMap,
baseDependencyMap,
lockfilePath,
lockfile
);

expect(messages).toHaveLength(0);
});

it('should not report duplicates when versions are removed', () => {
const messages: string[] = [];
const threshold = 1;
const dependencyMap = new Map<string, Set<string>>([
['package-a', new Set(['1.0.0', '1.1.0'])]
]);
const baseDependencyMap = new Map<string, Set<string>>([
['package-a', new Set(['1.0.0', '1.1.0', '1.2.0'])]
]);
const lockfilePath = 'package-lock.json';
const lockfile: ParsedLockFile = {
type: 'npm',
packages: [],
root: {
name: 'root-package',
version: '1.0.0',
dependencies: [],
devDependencies: [],
optionalDependencies: [],
peerDependencies: []
}
};

scanForDuplicates(
messages,
threshold,
dependencyMap,
baseDependencyMap,
lockfilePath,
lockfile
);

expect(messages).toHaveLength(0);
});

it('should only report packages with more versions than the base', () => {
const messages: string[] = [];
const threshold = 1;
const dependencyMap = new Map<string, Set<string>>([
['package-a', new Set(['1.0.0', '1.1.0'])],
['package-c', new Set(['2.0.0', '2.1.0'])]
]);
const baseDependencyMap = new Map<string, Set<string>>([
['package-a', new Set(['1.0.0'])],
['package-c', new Set(['2.0.0', '2.1.0'])]
]);
const lockfilePath = 'package-lock.json';
const packageA: ParsedDependency = {
name: 'package-a',
version: '1.0.0',
dependencies: [],
devDependencies: [],
optionalDependencies: [],
peerDependencies: []
};
const packageAAlt: ParsedDependency = {
name: 'package-a',
version: '1.1.0',
dependencies: [],
devDependencies: [],
optionalDependencies: [],
peerDependencies: []
};
const packageC: ParsedDependency = {
name: 'package-c',
version: '2.0.0',
dependencies: [],
devDependencies: [],
optionalDependencies: [],
peerDependencies: []
};
const packageCAlt: ParsedDependency = {
name: 'package-c',
version: '2.1.0',
dependencies: [],
devDependencies: [],
optionalDependencies: [],
peerDependencies: []
};
const packageB: ParsedDependency = {
name: 'package-b',
version: '3.0.0',
dependencies: [packageAAlt, packageCAlt],
devDependencies: [],
optionalDependencies: [],
peerDependencies: []
};
const lockfile: ParsedLockFile = {
type: 'npm',
packages: [packageA, packageAAlt, packageB, packageC, packageCAlt],
root: {
name: 'root-package',
version: '1.0.0',
dependencies: [packageA, packageB, packageC],
devDependencies: [],
optionalDependencies: [],
peerDependencies: []
}
};

scanForDuplicates(
messages,
threshold,
dependencyMap,
baseDependencyMap,
lockfilePath,
lockfile
);
Expand Down