Skip to content
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

chore: Add NPM duplicate dependency check to canaries #11333

Merged
merged 3 commits into from
May 4, 2023
Merged

chore: Add NPM duplicate dependency check to canaries #11333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
573671d
chore: Add NPM duplicate dependency check & integrate with canaries.
jimblanc May 3, 2023
c1813a6
Merge branch 'main' into chore/npm-duplicate-detection
jimblanc May 4, 2023
3d9c0dc
Merge branch 'main' into chore/npm-duplicate-detection
jimblanc May 4, 2023
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
5 changes: 4 additions & 1 deletion .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2512,7 +2512,10 @@ orbs:
no_output_timeout: 2m
- run-with-retry:
label: Install AmplifyJS
command: npm i -S aws-amplify && npm i -g wait-on serve
command: |
npm i -S aws-amplify
npm i -g wait-on serve
~/amplify-js/.circleci/duplicates-npm.sh
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems odd to see this directly in the circle folder. That said, there is prior art and wouldn't recommend we move things around in this change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is required for CircleCI to be able to access the script (we do this with some other shell scripts in the .circleci folder, e.g. retry-yarn-script.sh). The duplication is largely for this reason as well. We could move our build-time script into the .circleci folder and adapt it to try to be "smarter" and take a parameter to selectively use NPM or Yarn, but this felt like overkill to me. And our build time script using something in the .circleci folder would also be just as strange as the reverse.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we move the logic into a script, capture the execution in a scripts entry in package.json and then call it in both places to isolate the shared code?

- run:
name: Call Amplify library in code
command: |
Expand Down
17 changes: 17 additions & 0 deletions .circleci/duplicates-npm.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#!/usr/bin/env bash

# This script detects duplicated Amplify dependencies in the dependency graph (with NPM)
duplicatedDependencies=$(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we copying this from the scripts location? Code duplication within the package seems like a smell.

npm ls -all 2>/dev/null | \
grep -o -e '@\?aws-amplify[^ ]*' | \
sort | uniq | \
sed -E 's/^(@?[^@]+).*$/\1/g' | \
uniq -d | sort
)

if [ ! "$duplicatedDependencies" ]; then
echo "No duplicated Amplify dependencies detected."
else
echo "Duplicated Amplify dependencies detected: $duplicatedDependencies"
false
fi
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"bootstrap": "lerna bootstrap",
"test": "lerna run test --stream",
"test:size": "lerna run test:size",
"test:duplicates": "./scripts/duplicates.sh",
"test:duplicates": "./scripts/duplicates-yarn.sh",
"cypress": "lerna run cypress",
"cypress:open": "lerna run cypress:open",
"coverage": "codecov || exit 0",
Expand Down
2 changes: 1 addition & 1 deletion scripts/duplicates.sh → scripts/duplicates-yarn.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env bash

# This script detects duplicated Amplify dependencies in the dependency graph
# This script detects duplicated Amplify dependencies in the dependency graph (with Yarn)
duplicatedDependencies=$(
yarn list --pattern amplify |
grep -o -e '@\?aws-amplify[^ ]*' |
Expand Down