Clean up dependencies [FC-0062] #1255

bradenmacdonald · 2024-09-04T18:10:13Z

Description

This fixes some problems with the dependencies and removes unused dependencies.

See inline comments for explanations of each change.

Supporting information

n/a

Testing instructions

Run npm ci --omit=dev && npm run build to ensure that this MFE can be built without devDependencies
Verify that tests are passing.

Other information

Private ref: FAL-3819

openedx-webhooks · 2024-09-04T18:10:16Z

Thanks for the pull request, @bradenmacdonald!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/2u-tnl. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

bradenmacdonald · 2024-09-04T18:12:34Z

package.json

@@ -47,6 +47,7 @@
    "@dnd-kit/sortable": "^8.0.0",
    "@dnd-kit/utilities": "^3.2.2",
    "@edx/brand": "npm:@openedx/brand-openedx@^1.2.3",
+    "@edx/browserslist-config": "1.2.0",


browserslist-config is required for webpack to build the MFE so it should be a dependency, not a devDependency.

Ref: OEP-67 - Frontend Technology Selection - 15 Development dependencies should be separated into devDependencies

bradenmacdonald · 2024-09-04T18:12:44Z

package.json

@@ -62,6 +63,7 @@
    "@openedx-plugins/course-app-teams": "file:plugins/course-apps/teams",
    "@openedx-plugins/course-app-wiki": "file:plugins/course-apps/wiki",
    "@openedx-plugins/course-app-xpert_unit_summary": "file:plugins/course-apps/xpert_unit_summary",
+    "@openedx/frontend-build": "^14.0.14",


frontend-build is required for webpack to build the MFE so it should be a dependency, not a devDependency.

Ref: OEP-67 - Frontend Technology Selection - 15 Development dependencies should be separated into devDependencies

bradenmacdonald · 2024-09-04T18:13:06Z

package.json

@@ -97,7 +99,6 @@
    "react-transition-group": "4.4.5",
    "redux": "4.0.5",
    "redux-logger": "^3.0.6",
-    "redux-mock-store": "^1.5.4",


This is only used in tests, so it's supposed to be a devDependency

bradenmacdonald · 2024-09-04T18:13:30Z

package.json

    "@edx/react-unit-test-utils": "3.0.0",
-    "@edx/reactifex": "^1.0.3",


Doesn't appear to be used [directly] in this MFE.

bradenmacdonald · 2024-09-04T18:13:54Z

package.json

    "@testing-library/jest-dom": "5.17.0",
    "@testing-library/react": "12.1.5",
    "@testing-library/react-hooks": "^8.0.1",
    "@testing-library/user-event": "^13.2.1",
    "@types/lodash": "^4.17.7",
-    "axios": "^0.28.0",


We shouldn't specify an axios version as it's never directly imported. frontend-platform wraps it for us and determines which version to use.

bradenmacdonald · 2024-09-04T18:14:07Z

package.json

    "axios-mock-adapter": "1.22.0",
    "eslint-import-resolver-webpack": "^0.13.8",
    "fetch-mock-jest": "^1.5.1",
-    "glob": "7.2.3",


Doesn't appear to be used [directly] in this MFE.

bradenmacdonald · 2024-09-04T18:14:13Z

package.json

    "husky": "7.0.4",
    "jest-canvas-mock": "^2.5.2",
    "jest-expect-message": "^1.1.3",
    "react-test-renderer": "17.0.2",
-    "reactifex": "1.1.1",


Doesn't appear to be used [directly] in this MFE.

bradenmacdonald · 2024-09-04T18:14:26Z

package.json

-    "ts-loader": "^9.5.1"
-  },
-  "peerDependencies": {
-    "decode-uri-component": ">=0.2.2"


Doesn't appear to be used [directly] in this MFE.

bradenmacdonald · 2024-09-04T18:14:48Z

package.json

    "husky": "7.0.4",
    "jest-canvas-mock": "^2.5.2",
    "jest-expect-message": "^1.1.3",
    "react-test-renderer": "17.0.2",
-    "reactifex": "1.1.1",
-    "ts-loader": "^9.5.1"


TS support is configured by frontend-build; we don't need to specify a loader version here.

codecov · 2024-09-04T18:59:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.22%. Comparing base (34f0bf5) to head (e86222d).
Report is 5 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1255   +/-   ##
=======================================
  Coverage   92.22%   92.22%           
=======================================
  Files        1008     1008           
  Lines       18514    18514           
  Branches     3947     3958   +11     
=======================================
  Hits        17074    17074           
  Misses       1371     1371           
  Partials       69       69

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ChrisChV

Looks good 👍

I tested this: I followed the testing instructions.
I read through the code and considered the security, stability and performance implications of the changes.
Includes documentation

chore: clean up dependencies

e86222d

bradenmacdonald requested a review from a team as a code owner September 4, 2024 18:10

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 4, 2024

bradenmacdonald commented Sep 4, 2024

View reviewed changes

bradenmacdonald requested a review from ChrisChV September 4, 2024 18:15

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Sep 6, 2024

ChrisChV approved these changes Sep 9, 2024

View reviewed changes

KristinAoki approved these changes Sep 9, 2024

View reviewed changes

bradenmacdonald merged commit 376f31e into openedx:master Sep 9, 2024
9 checks passed

bradenmacdonald deleted the braden/fix-dependencies branch September 9, 2024 16:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up dependencies [FC-0062] #1255

Clean up dependencies [FC-0062] #1255

bradenmacdonald commented Sep 4, 2024

openedx-webhooks commented Sep 4, 2024

bradenmacdonald Sep 4, 2024

bradenmacdonald Sep 4, 2024

bradenmacdonald Sep 4, 2024 •

edited

Loading

bradenmacdonald Sep 4, 2024

bradenmacdonald Sep 4, 2024

bradenmacdonald Sep 4, 2024

bradenmacdonald Sep 4, 2024

bradenmacdonald Sep 4, 2024

bradenmacdonald Sep 4, 2024

codecov bot commented Sep 4, 2024 •

edited

Loading

ChrisChV left a comment

		"@edx/react-unit-test-utils": "3.0.0",
		"@edx/reactifex": "^1.0.3",

Clean up dependencies [FC-0062] #1255

Clean up dependencies [FC-0062] #1255

Conversation

bradenmacdonald commented Sep 4, 2024

Description

Supporting information

Testing instructions

Other information

openedx-webhooks commented Sep 4, 2024

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

🔘 Let us know that your PR is ready for review:

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradenmacdonald Sep 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Sep 4, 2024 • edited Loading

Codecov Report

ChrisChV left a comment

Choose a reason for hiding this comment

bradenmacdonald Sep 4, 2024 •

edited

Loading

codecov bot commented Sep 4, 2024 •

edited

Loading