Fix constraints and update yarn lock at the end of release process by cryptodev-2s · Pull Request #145 · MetaMask/create-release-branch

cryptodev-2s · 2024-05-17T14:30:13Z

Description

In our current release process, we often encounter issues with dependency constraints, outdated yarn.lock files, and duplicated dependencies. These issues can lead to inconsistencies in our release process. Additionally, these steps are frequently needed whenever we release our packages, making the process cumbersome and error-prone.

Solution

This PR adds a new step to our release tool to streamline and automate the process. This step will:

Fix Constraints: Ensure that all package versions adhere to the specified constraints,-.
Update the Yarn Lockfile: Refresh the yarn.lock file to include the latest dependency resolutions..
Deduplicate Dependencies: Remove duplicate dependencies to streamline the dependency tree, which helps in reducing the overall package size and avoiding multiple versions of the same dependency.

Implementation Details

Constraint Fixing: Introduces a command to enforce and fix version constraints for dependencies.
Yarn Lockfile Update: Runs yarn install to regenerate the yarn.lock file with the latest dependency resolutions.
Dependency Deduplication: Utilizes the yarn deduplicate command to clean up duplicated dependencies in the lockfile.
Release Tool Update: Integrates these steps into our release tool to automate the process, making it more fluid and less error-prone.

kanthesha · 2024-05-21T09:30:27Z

The tests are failing!

    @scope/d does not seem to have a changelog. Skipping.
    Error: Command failed with exit code 1: yarn constraints --fix
    Internal Error: @scope/monorepo@workspace:.: This package doesn't seem to be present in your lockfile; run "yarn install" to update the lockfile

And in the local as well.

  ● create-release-branch (functional) › against a monorepo with independent versions › does not update the changelogs of any packages that have been tagged with intentionally-skip

    Command failed with exit code 1: /Users/dck/Workspace/metamask/create-release-branch/node_modules/.bin/tsx /Users/dck/Workspace/metamask/create-release-branch/src/cli.ts --project-directory /var/folders/25/ryczmnrj08g0xdlfv3h5jlpw0000gn/T/create-release-branch-tests/wDg3SIGTUwN_Cn8M5rJCZ/local-repo --temp-directory /var/folders/25/ryczmnrj08g0xdlfv3h5jlpw0000gn/T/create-release-branch-tests/wDg3SIGTUwN_Cn8M5rJCZ/local-repo/tmp
    Error: Command failed with exit code 1: yarn constraints --fix
error Command "constraints" not found.

cryptodev-2s · 2024-05-21T09:34:39Z

@kanthesha yes the functional test are failing. In the current testing configuration I need to add a constraints file, currently working on it.

kanthesha

Overall LGTM. I have made some minor suggestions.

src/yarn-commands.test.ts

src/yarn-commands.ts

kanthesha

LGTM.

…onstraints-lock

mcmire

Is there a functional test we can add to confirm that the workflow bug we are trying to solve is fixed?

src/yarn-commands.test.ts

src/yarn-commands.ts

mcmire · 2024-05-29T20:08:31Z

tests/functional/helpers/local-monorepo.ts

+      packageManager: 'yarn@3.2.1',
+    });
+
+    const constraintsProContent = `


Hmm... this constraints file doesn't really check anything I don't think? I believe that Yarn looks for certain predicates to exist. Perhaps this just file just needs to be present?

It checks that each package has a name and a version field.
it's required for the constraints fix otherwise it throws This package doesn't seem to be present in your lockfile; run "yarn install" to update the lockfile

That's a strange error when the constraints file doesn't exist. I would have expected something like "constraints.pro not found".

I just tried removing these lines and running the tests and they don't seem to fail with the error you describe 🤔

we can remove the constraints file only the plugin installation is required (the error I sent earlier was related to the plugin installation removal), but don't we want to test that constraints check really works as this constraints at least checks that each package has a version and name, we can add more checks ? in this case we can also make this testing in a separate scenario as you proposed later (sorry I just saw the other comment)

mcmire · 2024-05-29T20:14:29Z

Also can we update the PR description to describe the problem that we are solving here and how the changes solve that problem instead of just describing the changes? That would help us understand the context behind this PR in the future.

cryptodev-2s · 2024-05-30T11:04:18Z

Also can we update the PR description to describe the problem that we are solving here and how the changes solve that problem instead of just describing the changes? That would help us understand the context behind this PR in the future.

I updated the description

src/yarn-commands.ts

mcmire · 2024-05-31T04:09:04Z

tests/functional/helpers/local-monorepo.ts

+      packageManager: 'yarn@3.2.1',
+    });
+
+    const constraintsProContent = `


That's a strange error when the constraints file doesn't exist. I would have expected something like "constraints.pro not found".

I just tried removing these lines and running the tests and they don't seem to fail with the error you describe 🤔

mcmire · 2024-05-31T04:14:38Z

Just repeating my comment above about adding a functional test here. I think the problem that running yarn was intended to solve was so that the release PR wouldn't fail CI. CI runs yarn --immutable and then it runs yarn constraints as a part of the lint step, so it seems like we ought to have a test that runs the tool, then runs yarn --immutable, then yarn constraints and expects both of these commands to return an exit code of 0. This way we can be sure that we've solved the original problem. Is this possible to add?

mcmire

Sorry for the long delay in reviewing this. Looks good to me.

mcmire · 2024-06-20T22:57:14Z

src/functional.test.ts

      );
    });

+    it('updates the dependency version in package "b" when package "a" version is bumped', async () => {


create-release-branch runs yarn constraints --fix and doesn't care what the constraints are exactly. So it isn't necessary the case that create-release-branch always updates dependencies like this — it really depends on what the project's constraints file does (a project may have different constraints, in theory). That said, I'm okay with using this test name since it points to why we decided to add yarn constraints --fix in the first place. If we ever want to run constraints for a different reason we may have to adjust this test name to be more accurate, but I don't anticipate that happening any time soon.

Fix constraints and update yarn lock at the end of release process

708d7d9

cryptodev-2s requested a review from a team as a code owner May 17, 2024 14:30

cryptodev-2s added 2 commits May 20, 2024 15:21

Fix yarn commands order

de55c97

Add unit tests for yarn commands

0a8394a

Fix function tests handle case yarn version is less than 2

165ebe4

cryptodev-2s requested a review from kanthesha May 21, 2024 12:05

cryptodev-2s added 6 commits May 21, 2024 14:24

Fix add getYarnVersion missing tests

e01e3a4

Fix missing constraints plugin

2e7d127

Fix invalid yarn version message

27f5cc2

Fix functional test yarn lock content version

e7a18d2

Fix run yarn install with no immutable flag

aa118fe

Rename install dependencies function

6298981

kanthesha suggested changes May 22, 2024

View reviewed changes

Fix minor text changes

e5f0844

cryptodev-2s requested a review from kanthesha May 22, 2024 10:12

kanthesha previously approved these changes May 22, 2024

View reviewed changes

desi requested a review from a team May 23, 2024 18:34

cryptodev-2s requested a review from mcmire May 29, 2024 11:00

fix: remove yarn lock content

d004bb0

cryptodev-2s dismissed kanthesha’s stale review via d004bb0 May 29, 2024 16:15

Merge remote-tracking branch 'origin/main' into feature/update-yarn-c…

db2b6de

…onstraints-lock

cryptodev-2s requested a review from kanthesha May 29, 2024 17:15

mcmire reviewed May 29, 2024

View reviewed changes

cryptodev-2s added 2 commits May 29, 2024 22:26

fix: minor fixes

a360a8b

feat: add yarn dedupe step

ca1667d

mcmire reviewed May 31, 2024

View reviewed changes

cryptodev-2s added 4 commits May 31, 2024 11:37

fix: remove yarn v1 check

f0d1081

fix: remove constraints file

1c53e0b

fix: jsdoc

2a75ae6

fix: add missing functional tests

c68518c

mcmire approved these changes Jun 20, 2024

View reviewed changes

cryptodev-2s merged commit 03b300a into main Jun 25, 2024

cryptodev-2s deleted the feature/update-yarn-constraints-lock branch June 25, 2024 11:50

mcmire mentioned this pull request Jun 26, 2024

Yarn lockfile is outdated after creating release branch #142

Closed

Uh oh!

Conversation

cryptodev-2s commented May 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Solution

Uh oh!

kanthesha commented May 21, 2024

Uh oh!

cryptodev-2s commented May 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kanthesha left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kanthesha left a comment

Choose a reason for hiding this comment

Uh oh!

mcmire left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mcmire May 29, 2024

Choose a reason for hiding this comment

Uh oh!

cryptodev-2s May 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mcmire May 31, 2024

Choose a reason for hiding this comment

Uh oh!

cryptodev-2s May 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mcmire commented May 29, 2024

Uh oh!

cryptodev-2s commented May 30, 2024

Uh oh!

Uh oh!

mcmire May 31, 2024

Choose a reason for hiding this comment

Uh oh!

mcmire commented May 31, 2024

Uh oh!

mcmire left a comment

Choose a reason for hiding this comment

Uh oh!

mcmire Jun 20, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cryptodev-2s commented May 17, 2024 •

edited

Loading

cryptodev-2s commented May 21, 2024 •

edited

Loading

cryptodev-2s May 29, 2024 •

edited

Loading

cryptodev-2s May 31, 2024 •

edited

Loading