ECO-444: Add remove subcommand for integrations command by JakeUskoski · Pull Request #12291 · vercel/vercel

JakeUskoski · 2024-10-16T20:20:13Z

Summary

This PR adds a new sub-command to integration: remove (also available as rm) which allows a user to uninstall a marketplace integration from the current team. This PR also adds a new command vc integration-resource with sub-commands disconnect and remove (also available as rm), which allows a user to unlink a project from a (marketplace integration) resource and to delete a (marketplace integration) resource.

Background

This change is related to #12233 and #12251. As we continue to try and improve the developer experience of interacting with the marketplace via the CLI, it's important that we offer the basic general CRUD activities seen in CLI tools of add, list, and remove (as well as open for how users perform update actions on the resources day-to-day). This PR adds the remove functionality to finish off the set of the basic CRUD operations.

Original designs for the CRUD commands lacked detail on a remove command. This PR introduces the idea of removing an integration from a team, removing a resource from a team, and removing resources from projects. Since this is a lot of different destructive actions, we thought it best to break apart into multiple commands instead of overloading a single remove command (as this PR originally proposed). This way the commands have clear, singular uses, and it's more difficult to accidentally make unintended destructive changes.

How to test

Build and run locally (or use pnpm dev instead of vc when in the packages/cli folder). You'll also need marketplace integrations installed on a team, and resources for said integrations.

vc integration remove <integration>
--
vc integration-resource remove <resource> [--disconnect-all]
--
vc integration-resource disconnect <resource>
vc integration-resource disconnect <resource> <project>
vc integration-resource disconnect <resource> --all

changeset-bot · 2024-10-16T20:20:18Z

🦋 Changeset detected

Latest commit: fb7dce0

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

This PR includes changesets to release 1 package

Name	Type
vercel	Minor

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

…mmand-to-cli

packages/cli/src/commands/integration/remove.ts

trek

I meant to request changes in the previous review.

…upted

…mmand-to-cli

EndangeredMassa · 2024-10-29T20:39:04Z

packages/cli/src/commands/index.ts

  ['install', 'install'],
  ['integration', 'integration'],
+  ['integration-resource', 'integration-resource'],
+  ['ir', 'integration-resource'],


note (non-blocking): Calling out that we'd be adding these to the command list:

integration-resource

ir

EndangeredMassa · 2024-10-29T21:02:03Z

packages/cli/src/commands/integration/resource/command.ts

suggestion (blocking): move integration/resource to integration-resource as a sibling to integration

Can we keep the command consistency so that it's obvious where command logic is when we go looking for it?‏

EndangeredMassa · 2024-10-29T21:02:44Z

packages/cli/src/util/telemetry/commands/integration/resource/disconnect.ts

suggestion (blocking): rename this directory to integration-resource‏

EndangeredMassa

meant to request changes

…mmand-to-cli

EndangeredMassa

Thanks for all the work on this!

…mmand-to-cli

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## [email protected] ### Minor Changes - Strongly type `TelemetryClient` subclasses against command specification ([#12426](#12426)) - Adds `vercel integration remove` to uninstall Marketplace integrations from the current team ([#12291](#12291)) Adds `vercel integration-resource disconnect` to disconnect Marketplace integration resources from projects Adds `vercel integration-resource remove` to delete Marketplace integration resources ### Patch Changes - [cli] Make all metrics tracking methods on the store require arguments ([#12422](#12422)) - Support allowHeader from Next.js for filtering request headers during revalidation ([#12420](#12420)) - [cli] don't track unreachable condition ([#12419](#12419)) - Updated dependencies \[[`5a6605bbd99c3b4c3f06fc315dd3978fe7801d00`](5a6605b)]: - @vercel/[email protected] - @vercel/[email protected] - @vercel/[email protected] - @vercel/[email protected] ## @vercel/functions@1.5.0 ### Minor Changes - ipAddress: accept headers as input ([#12429](#12429)) ## @vercel/[email protected] ### Patch Changes - Support allowHeader from Next.js for filtering request headers during revalidation ([#12420](#12420)) ## @vercel/[email protected] ### Patch Changes - Updated dependencies \[[`5a6605bbd99c3b4c3f06fc315dd3978fe7801d00`](5a6605b)]: - @vercel/[email protected] ## @vercel/[email protected] ### Patch Changes - Updated dependencies \[[`5a6605bbd99c3b4c3f06fc315dd3978fe7801d00`](5a6605b)]: - @vercel/[email protected] ## @vercel/[email protected] ### Patch Changes - Support allowHeader from Next.js for filtering request headers during revalidation ([#12420](#12420)) ## @vercel/[email protected] ### Patch Changes - Updated dependencies \[[`5a6605bbd99c3b4c3f06fc315dd3978fe7801d00`](5a6605b)]: - @vercel/[email protected] ## @vercel/[email protected] ### Patch Changes - Updated dependencies \[]: - @vercel/[email protected] ## @vercel-internals/[email protected] ### Patch Changes - Updated dependencies \[[`5a6605bbd99c3b4c3f06fc315dd3978fe7801d00`](5a6605b)]: - @vercel/[email protected] Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## [email protected] ### Minor Changes - Strongly type `TelemetryClient` subclasses against command specification ([#12426](vercel/vercel#12426)) - Adds `vercel integration remove` to uninstall Marketplace integrations from the current team ([#12291](vercel/vercel#12291)) Adds `vercel integration-resource disconnect` to disconnect Marketplace integration resources from projects Adds `vercel integration-resource remove` to delete Marketplace integration resources ### Patch Changes - [cli] Make all metrics tracking methods on the store require arguments ([#12422](vercel/vercel#12422)) - Support allowHeader from Next.js for filtering request headers during revalidation ([#12420](vercel/vercel#12420)) - [cli] don't track unreachable condition ([#12419](vercel/vercel#12419)) - Updated dependencies \[[`ea72a9f85d9fba806e382ef1a7e52b73f78132d9`](vercel/vercel@ea72a9f)]: - @vercel/[email protected] - @vercel/[email protected] - @vercel/[email protected] - @vercel/[email protected] ## @vercel/[email protected] ### Minor Changes - ipAddress: accept headers as input ([#12429](vercel/vercel#12429)) ## @vercel/[email protected] ### Patch Changes - Support allowHeader from Next.js for filtering request headers during revalidation ([#12420](vercel/vercel#12420)) ## @vercel/[email protected] ### Patch Changes - Updated dependencies \[[`ea72a9f85d9fba806e382ef1a7e52b73f78132d9`](vercel/vercel@ea72a9f)]: - @vercel/[email protected] ## @vercel/[email protected] ### Patch Changes - Updated dependencies \[[`ea72a9f85d9fba806e382ef1a7e52b73f78132d9`](vercel/vercel@ea72a9f)]: - @vercel/[email protected] ## @vercel/[email protected] ### Patch Changes - Support allowHeader from Next.js for filtering request headers during revalidation ([#12420](vercel/vercel#12420)) ## @vercel/[email protected] ### Patch Changes - Updated dependencies \[[`ea72a9f85d9fba806e382ef1a7e52b73f78132d9`](vercel/vercel@ea72a9f)]: - @vercel/[email protected] ## @vercel/[email protected] ### Patch Changes - Updated dependencies \[]: - @vercel/[email protected] ## @vercel-internals/[email protected] ### Patch Changes - Updated dependencies \[[`ea72a9f85d9fba806e382ef1a7e52b73f78132d9`](vercel/vercel@ea72a9f)]: - @vercel/[email protected] Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Add remove subcommand for integrations command

932dd18

Create three-doors-own.md

ae514d7

vercel bot deployed to Preview October 16, 2024 20:23 View deployment

Merge branch 'main' into jakeuskoski/eco-444-add-vc-integration-rm-co…

9f6c00b

…mmand-to-cli

vercel bot deployed to Preview October 16, 2024 20:37 View deployment

JakeUskoski requested a review from a team October 17, 2024 14:22

Add missing empty body to uninstall API call

2ef981a

vercel bot deployed to Preview October 17, 2024 14:40 View deployment

Replace unused error scenario with real resources exist scenario

d467a57

JakeUskoski marked this pull request as ready for review October 17, 2024 14:52

JakeUskoski requested review from EndangeredMassa, TooTallNate, erikareads, jeffsee55, onsclom and trek as code owners October 17, 2024 14:52

vercel bot deployed to Preview October 17, 2024 14:52 View deployment

Properly emulate error response from API

587ac83

vercel bot deployed to Preview October 17, 2024 14:59 View deployment

trek approved these changes Oct 17, 2024

View reviewed changes

packages/cli/src/commands/integration/remove.ts Outdated Show resolved Hide resolved

packages/cli/src/commands/integration/remove.ts Outdated Show resolved Hide resolved

trek suggested changes Oct 17, 2024

View reviewed changes

Use allSettled instead of all to ensure other API calls aren't interr…

5a343d2

…upted

vercel bot deployed to Preview October 17, 2024 17:28 View deployment

Merge branch 'main' into jakeuskoski/eco-444-add-vc-integration-rm-co…

7418fa3

…mmand-to-cli

vercel bot deployed to Preview October 17, 2024 18:03 View deployment

Switch to using new delete endpoint for --unlink-all

95d2fa7

vercel bot deployed to Preview October 18, 2024 20:21 View deployment

JakeUskoski requested a review from trek October 18, 2024 20:25

Merge branch 'main' into jakeuskoski/eco-444-add-vc-integration-rm-co…

8abb1fa

…mmand-to-cli

JakeUskoski dismissed trek’s stale review via d8714b6 October 29, 2024 18:14

vercel bot deployed to Preview October 29, 2024 18:15 View deployment

Merge branch 'main' into jakeuskoski/eco-444-add-vc-integration-rm-co…

680f3f8

…mmand-to-cli

vercel bot deployed to Preview October 29, 2024 19:31 View deployment

Add telemetry to new remove commands

cd4878a

vercel bot deployed to Preview October 29, 2024 20:23 View deployment

JakeUskoski requested a review from EndangeredMassa October 29, 2024 20:28

Update three-doors-own.md

e77055d

vercel bot deployed to Preview October 29, 2024 20:34 View deployment

Merge branch 'main' into jakeuskoski/eco-444-add-vc-integration-rm-co…

8d80302

…mmand-to-cli

vercel bot deployed to Preview October 29, 2024 20:56 View deployment

EndangeredMassa approved these changes Oct 29, 2024

View reviewed changes

EndangeredMassa suggested changes Oct 29, 2024

View reviewed changes

Move resource folders to integration-resource folders

8710016

vercel bot deployed to Preview October 30, 2024 15:13 View deployment

JakeUskoski requested a review from EndangeredMassa October 30, 2024 15:26

Merge branch 'main' into jakeuskoski/eco-444-add-vc-integration-rm-co…

4ec4361

…mmand-to-cli

vercel bot deployed to Preview October 30, 2024 15:33 View deployment

EndangeredMassa previously approved these changes Oct 30, 2024

View reviewed changes

Correct command description of integration-resource

fb7dce0

JakeUskoski dismissed EndangeredMassa’s stale review via fb7dce0 October 30, 2024 16:32

Merge branch 'main' into jakeuskoski/eco-444-add-vc-integration-rm-co…

776133c

…mmand-to-cli

JakeUskoski added the pr: automerge label Oct 30, 2024

EndangeredMassa approved these changes Oct 30, 2024

View reviewed changes

vercel bot deployed to Preview October 30, 2024 16:33 View deployment

kodiakhq bot merged commit 99cac1c into main Oct 30, 2024

kodiakhq bot deleted the jakeuskoski/eco-444-add-vc-integration-rm-command-to-cli branch October 30, 2024 17:05

vercel-release-bot mentioned this pull request Oct 30, 2024

Version Packages #12424

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ECO-444: Add remove subcommand for integrations command#12291

ECO-444: Add remove subcommand for integrations command#12291
kodiakhq[bot] merged 34 commits intomainfrom
jakeuskoski/eco-444-add-vc-integration-rm-command-to-cli

JakeUskoski commented Oct 16, 2024 •

edited

Loading

Uh oh!

changeset-bot bot commented Oct 16, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

trek left a comment

Uh oh!

EndangeredMassa Oct 29, 2024

Uh oh!

EndangeredMassa Oct 29, 2024

Uh oh!

JakeUskoski Oct 30, 2024

Uh oh!

EndangeredMassa Oct 29, 2024

Uh oh!

JakeUskoski Oct 30, 2024

Uh oh!

EndangeredMassa left a comment

Uh oh!

EndangeredMassa left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

JakeUskoski commented Oct 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Background

How to test

Uh oh!

changeset-bot bot commented Oct 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

Uh oh!

trek left a comment

Choose a reason for hiding this comment

Uh oh!

EndangeredMassa Oct 29, 2024

Choose a reason for hiding this comment

Uh oh!

EndangeredMassa Oct 29, 2024

Choose a reason for hiding this comment

Uh oh!

JakeUskoski Oct 30, 2024

Choose a reason for hiding this comment

Uh oh!

EndangeredMassa Oct 29, 2024

Choose a reason for hiding this comment

Uh oh!

JakeUskoski Oct 30, 2024

Choose a reason for hiding this comment

Uh oh!

EndangeredMassa left a comment

Choose a reason for hiding this comment

Uh oh!

EndangeredMassa left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

JakeUskoski commented Oct 16, 2024 •

edited

Loading

changeset-bot bot commented Oct 16, 2024 •

edited

Loading