Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Get correct absolute path of changed files when .changeset/ is not in the root of the repository#770

Merged
Andarist merged 7 commits intochangesets:mainfrom
alizeait:fix-changed-since-absolute-path
Mar 13, 2022
Merged

Get correct absolute path of changed files when .changeset/ is not in the root of the repository#770
Andarist merged 7 commits intochangesets:mainfrom
alizeait:fix-changed-since-absolute-path

Conversation

@alizeait
Copy link
Contributor

@alizeait alizeait commented Mar 5, 2022

When creating absolute paths from changed files, we assume cwd is the repository root but that is not always the case like when .changesets is set in a subfolder. Instead we can ask git for the repository root and create correct absolute path of the files returned from git diff

@changeset-bot
Copy link

changeset-bot bot commented Mar 5, 2022 •
edited
Loading

🦋 Changeset detected

Latest commit: 08770b0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@changesets/cli Patch
@changesets/git Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@codesandbox-ci
Copy link

codesandbox-ci bot commented Mar 5, 2022 •
edited
Loading

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 08770b0:

Sandbox Source
Vanilla Configuration

@Andarist
Copy link
Member

Andarist commented Mar 5, 2022

Ok, I think I understand what you are saying... but we would need a test case for this change, ideally one that would involve some changesets command, or at least a full user story that involves Changesets.

@alizeait
Copy link
Contributor Author

alizeait commented Mar 6, 2022

Ok, I think I understand what you are saying... but we would need a test case for this change, ideally one that would involve some changesets command, or at least a full user story that involves Changesets.

Sure, I added a unit test that asserts the changed behavior. Not sure how adding a Changeset command test case would be beneficial here considering that the git functions are simply mocked in those test files. Would appreciate any pointers if you have something else in mind

@Andarist
Copy link
Member

Andarist commented Mar 6, 2022

I was just wondering how exactly this has manifested in a bug in Changesets. Did changesets status report a wrong value~? Or maybe changesets add didn't list the packages correctly?

@alizeait
Copy link
Contributor Author

alizeait commented Mar 6, 2022 •
edited
Loading

Exactly, changesets add would not report the list of changed packages since changed files full paths were not correct. For example in a monorepo with this setup where .changeset folder is not in the monorepo root:

monorepo/
├── packages/
│   ├── .changeset/
│   │   └── config.json
│   ├── pkg-a/
│   │   └── package.josn
│   ├── pkg-b/
│   │   └── package.json
│   └── package.json
└── package.json

When running changesets add from /packages folder, let's say pkg-a/package.json was modified, the reported full path of that file would be:
/home/user/monorepo/packages/packages/pkg-a/package.json, notice the double /packages, this is because we have cwd as /home/user/monorepo/packages and changed file reported by git is packages/pkg-a/package.json (always relative repository root).
Now when we do path.resolve(cwd, 'packages/pkg-a/package.json') we get:
/home/user/monorepo/packages/packages/pkg-a/package.json which is not correct. So instead of using cwd in path.resolve, we can ask git for the repository root and always get the correct full path of the changed file.

@alizeait alizeait changed the title Get correct repository root instead of cwd Get correct absolute path of changed files when .changeset/ is not in the root of the repository Mar 6, 2022
Andarist
Andarist reviewed Mar 12, 2022
View reviewed changes
packages/git/src/index.ts
Comment on lines +192 to +194
if (code !== 0) {
return cwd;
}
Copy link
Member

@Andarist Andarist Mar 12, 2022

Choose a reason for hiding this comment

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

Is this a defensive check or perhaps this can sometimes happen for some legitimate reason?

Copy link
Contributor Author

@alizeait alizeait Mar 12, 2022

Choose a reason for hiding this comment

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

I doubt It'll fail, but if it does, fallback to the previous behavior

Andarist
Andarist reviewed Mar 12, 2022
View reviewed changes
@alizeait alizeait requested a review from Andarist March 13, 2022 15:26
Andarist
Andarist reviewed Mar 13, 2022
View reviewed changes
packages/git/src/index.ts
Comment on lines +192 to +194
if (code !== 0) {
return cwd;
}
Copy link
Member

@Andarist Andarist Mar 13, 2022

Choose a reason for hiding this comment

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

according to the docs:

Show the (by default, absolute) path of the top-level directory of the working tree. If there is no working tree, report an error.

So I think that we should throw an error here:

Suggested change
if (code !== 0) {
return cwd;
}
if (code !== 0) {
throw new Error(gitCmd.stderr.toString());
}

Where for us this actually shouldn't ever throw, but this function is quite generic - so if we ever expose it then somebody could call it with cwd outside of a git repo.

I think that it's better to throw here to raise potential issues early, rather than to swallow the error and lead to undetermined behavior.

Copy link
Contributor Author

@alizeait alizeait Mar 13, 2022

Choose a reason for hiding this comment

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

Sounds reasonable

@Andarist Andarist merged commit eb86652 into changesets:main Mar 13, 2022
@github-actions github-actions bot mentioned this pull request Mar 13, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Andarist Andarist Andarist left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@alizeait @Andarist