pnpm store usages <package>... #1529

nareddyt · 2018-12-02T20:39:27Z

Closes #1527

Overview

Adds a new CLI command to find all pnpm projects that link to specific packages in the global store.

#1527 outlines the user experience, use case, and limitations. This PR implements the feature exactly as described.

Implementation Details

The commits below describe the changes made to each package to enable this feature.

When a user makes a query against pnpm store usages <query>, the query flows in the following format:

pnpm user query via the CLI
supi programmatic query against the store API or the store server
package-store internal traversal of store to fulfill query

Testing Done

Added minimal tests to a few of the submodules. Plan on adding more tests after the code in src is approved.

Comments

I added a few comments to my PR about areas I'm unsure about.

- Add documentation for `pnpm store usages` - Refactor docs for `pnpm store` to be more readable

Introduces functionality to search the package store for packages. Reports all matching packages and the node projects they are used in. Allows for searching a specific version, or all versions.

Exposes an API for finding package usages in the store.

…nality Publicly exposes the findPackageUsages function in the store-controller. Also exposes the expected response type, allowing clients to be type-safe.

Publicly exposes the findPackageUsages function SUPI.

Enabled CLI command to find usages of a package in the global store. Pretty-prints a tree with queries and results.

packages/package-store/src/storeController/index.ts

packages/pnpm/package.json

packages/pnpm/src/cmd/help.ts

packages/supi/test/storeUsages.ts

packages/package-store/src/storeController/index.ts

packages/pnpm/src/cmd/help.ts

packages/pnpm/package.json

packages/supi/test/storeUsages.ts

Removed semicolons to follow style guide.

…info # Conflicts: # packages/pnpm/package.json # packages/pnpm/src/cmd/store.ts # packages/server/src/createServer.ts

pnpm#1528 was merged, modified test to use new SUPI API.

nareddyt · 2018-12-03T06:46:01Z

Everything should be merged and all issues should be fixed. I can add some more tests if this code structure looks good to you.

Could you take a look at the failing AppVeyor build? I'm not entirely sure what that error means, I don't think I touched that part of the project.

packages/pnpm/src/cmd/store.ts

zkochan · 2018-12-03T16:48:48Z

Could you take a look at the failing AppVeyor build? I'm not entirely sure what that error means, I don't think I touched that part of the project.

AppVeyor was failing on master as well. I fixed it

(For some reason tslint catches more issues on Windows. I don't know why)

…info

Better naming of the types returned in the pnpm store usages feature.

zkochan · 2018-12-03T19:30:47Z

@etamponi is it OK for Glitch to have this new command or do you need a config to disable it?

Like the ignore-stop-requests, ignore-upload-requests configs

etamponi · 2018-12-04T16:14:30Z

If it is just informative, it's okay... I would still be happier with a config option to disable it but it's not super urgent :) thanks!

nareddyt · 2018-12-04T17:45:59Z

@etamponi I'll create an issue for that and work on it right after this PR is merged in.

@zkochan I'll go ahead and add some tests for my changes. I'll let you know when I'm done

…-package-info

Add tests to `supi` to ensure datamodel returned by `package-store` is correct. Fix test messages in `server`

nareddyt · 2018-12-06T05:30:20Z

@zkochan added tests, should be ready to merge if all checks pass

* docs(pnpm): docs for the package usages feature - Add documentation for `pnpm store usages` - Refactor docs for `pnpm store` to be more readable * feat(package-store): implement findPackageUsages Introduces functionality to search the package store for packages. Reports all matching packages and the node projects they are used in. Allows for searching a specific version, or all versions. * feat(server): expose findPackageUsages API Exposes an API for finding package usages in the store. * feat(store-controller-types): Exposes findPackageUsages store functionality Publicly exposes the findPackageUsages function in the store-controller. Also exposes the expected response type, allowing clients to be type-safe. * feat(supi): implement findStoreUsages functionality, add API Publicly exposes the findPackageUsages function SUPI. * feat(pnpm): pnpm store usages Enabled CLI command to find usages of a package in the global store. Pretty-prints a tree with queries and results. * style: remove semicolons Removed semicolons to follow style guide. * refactor(supi): change test after merge of #1528 * refactor: rename findPackageUsages return type Better naming of the types returned in the pnpm store usages feature. * tests: add tests for `pnpm store usages` Add tests to `supi` to ensure datamodel returned by `package-store` is correct. Fix test messages in `server` PR #1529

zkochan · 2018-12-07T23:45:50Z

I was too fast to merge it. I will fix some things myself because I don't want to revert now

ref #1529 ref #1527

nareddyt · 2018-12-08T15:05:24Z

@zkochan do you have a list of things that were broken? Just curious so I can prevent making the same mistakes next time

ref #1529 ref #1527

zkochan · 2018-12-09T23:33:08Z

you can see in this PR the changes I've made.

using parseWantedDependencies() for parsing the package specs seemed unreliable to me. For instance, that method would parse a spec like foo@npm:bar@1.0.0 and return foo as alias. Though the real name of the package is bar. It is better to not support that syntax at all to avoid confusion.

And I somewhat simplified the search function in the store controller

Anyway, next time I will spend more time on review

Thanks for the contribution!

nareddyt · 2018-12-10T05:42:45Z

Thanks, looked over them and that looks much cleaner. This is my first big project with js/ts, so glad to see those changes and I'm learning a lot from them!

nareddyt added 6 commits November 28, 2018 23:34

docs(pnpm): docs for the package usages feature

6a071f7

- Add documentation for `pnpm store usages` - Refactor docs for `pnpm store` to be more readable

feat(package-store): implement findPackageUsages

9617de6

Introduces functionality to search the package store for packages. Reports all matching packages and the node projects they are used in. Allows for searching a specific version, or all versions.

feat(server): expose findPackageUsages API

789c77b

Exposes an API for finding package usages in the store.

feat(store-controller-types): Exposes findPackageUsages store functio…

bbca2e5

…nality Publicly exposes the findPackageUsages function in the store-controller. Also exposes the expected response type, allowing clients to be type-safe.

feat(supi): implement findStoreUsages functionality, add API

04f47a3

Publicly exposes the findPackageUsages function SUPI.

feat(pnpm): pnpm store usages

727e9af

Enabled CLI command to find usages of a package in the global store. Pretty-prints a tree with queries and results.

nareddyt requested a review from zkochan as a code owner December 2, 2018 20:39

Merge branch 'master' into pnpm-store-package-info

16ffe9c

nareddyt commented Dec 2, 2018

View reviewed changes

packages/package-store/src/storeController/index.ts Outdated Show resolved Hide resolved

nareddyt commented Dec 2, 2018

View reviewed changes

packages/pnpm/package.json Show resolved Hide resolved

nareddyt commented Dec 2, 2018

View reviewed changes

packages/pnpm/src/cmd/help.ts Show resolved Hide resolved

nareddyt commented Dec 2, 2018

View reviewed changes

packages/supi/test/storeUsages.ts Outdated Show resolved Hide resolved

zkochan requested changes Dec 2, 2018

View reviewed changes

style: remove semicolons

e51fd10

Removed semicolons to follow style guide.

nareddyt closed this Dec 3, 2018

nareddyt deleted the pnpm-store-package-info branch December 3, 2018 04:52

nareddyt reopened this Dec 3, 2018

nareddyt restored the pnpm-store-package-info branch December 3, 2018 04:53

nareddyt added 2 commits December 3, 2018 00:00

Merge remote-tracking branch 'remote/master' into pnpm-store-package-…

5d25c42

…info # Conflicts: # packages/pnpm/package.json # packages/pnpm/src/cmd/store.ts # packages/server/src/createServer.ts

refactor(supi): change test after merge of pnpm#1528

26b3968

pnpm#1528 was merged, modified test to use new SUPI API.

nareddyt mentioned this pull request Dec 3, 2018

New pnpm store documentation pnpm/pnpm.io#25

Closed

zkochan reviewed Dec 3, 2018

View reviewed changes

packages/pnpm/src/cmd/store.ts Outdated Show resolved Hide resolved

nareddyt added 2 commits December 3, 2018 12:11

Merge remote-tracking branch 'remote/master' into pnpm-store-package-…

cc15aa0

…info

refactor: rename findPackageUsages return type

37f92fc

Better naming of the types returned in the pnpm store usages feature.

zkochan approved these changes Dec 4, 2018

View reviewed changes

This was referenced Dec 4, 2018

Introduce configs to disable pnpm store usages #1532

Closed

Test pnpm store usages on tarball and file dependencies #1533

Closed

nareddyt added 2 commits December 4, 2018 19:54

Merge branch 'master' of https://github.com/pnpm/pnpm into pnpm-store…

b381d4f

…-package-info

tests: add tests for pnpm store usages

3cbf278

Add tests to `supi` to ensure datamodel returned by `package-store` is correct. Fix test messages in `server`

nareddyt mentioned this pull request Dec 6, 2018

assert-project cannot determine store path if no project is initialized in SUPI unit tests #1535

Closed

zkochan merged commit ef3adc9 into pnpm:master Dec 7, 2018

zkochan added a commit that referenced this pull request Dec 8, 2018

refactor: pnpm store usage

7686d42

ref #1529 ref #1527

zkochan added a commit that referenced this pull request Dec 8, 2018

fix: pnpm store usages

8ff7e3a

ref #1529 ref #1527

zkochan added a commit that referenced this pull request Dec 8, 2018

fix: pnpm store usages

78296df

ref #1529 ref #1527

zkochan added a commit that referenced this pull request Dec 8, 2018

fix: pnpm store usages

7655a48

ref #1529 ref #1527

zkochan mentioned this pull request Dec 8, 2018

fix: pnpm store usages #1544

Merged

zkochan added a commit that referenced this pull request Dec 8, 2018

fix: pnpm store usages

2947a05

ref #1529 ref #1527

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

pnpm store usages <package>... #1529

pnpm store usages <package>... #1529

nareddyt commented Dec 2, 2018

nareddyt commented Dec 3, 2018

zkochan commented Dec 3, 2018

zkochan commented Dec 3, 2018

etamponi commented Dec 4, 2018

nareddyt commented Dec 4, 2018

nareddyt commented Dec 6, 2018

zkochan commented Dec 7, 2018

nareddyt commented Dec 8, 2018

zkochan commented Dec 9, 2018 •

edited

nareddyt commented Dec 10, 2018

pnpm store usages <package>... #1529

pnpm store usages <package>... #1529

Conversation

nareddyt commented Dec 2, 2018

Overview

Implementation Details

Testing Done

Comments

nareddyt commented Dec 3, 2018

zkochan commented Dec 3, 2018

zkochan commented Dec 3, 2018

etamponi commented Dec 4, 2018

nareddyt commented Dec 4, 2018

nareddyt commented Dec 6, 2018

zkochan commented Dec 7, 2018

nareddyt commented Dec 8, 2018

zkochan commented Dec 9, 2018 • edited

nareddyt commented Dec 10, 2018

zkochan commented Dec 9, 2018 •

edited