[cli] implements vc deploy --logs and vc inspect --logs by feugy · Pull Request #11672 · vercel/vercel

feugy · 2024-05-30T12:11:54Z

🧐 What's in there?

This is the first part of distinguishing build logs from runtime logs.
The proposal is to provide:

vc deploy --logs: in addition to deploying the application, it should tail and display the build logs until the build finishes.
vc inspect --logs: instead of retuning a summary of the builds, it reads the build logs
vc inspect --logs --wait: when the build is in progress, tails the build logs until the configured timeout (3m by default), or display all available logs when the build is finished.
vc logs: read the runtime logs (not part of this PR, breaking change)

🧪 How to test?

Given a local application location in xyz folder, already linked to a vercel project:

pnpm -F vercel dev deploy --cwd xyz --logs to deploy and see build logs
pnpm -F vercel dev deploy --cwd xyz to deploy and see spinners instead
pnpm -F vercel dev inspect --cwd xyz dpl_ID/url --logs to see build logs of an existing deployment
pnpm -F vercel dev inspect --cwd xyz dpl_ID/url to see an existing deployment details
pnpm -F vercel dev inspect --cwd xyz dpl_ID/url --logs --wait to see build logs of an existing deployment (better if in progress)
pnpm -F vercel dev inspect --cwd xyz dpl_ID/url --logs --wait --timeout 5s to see build logs of an existing deployment (better if in progress) and bail after 5 seconds

Unit tests added:

inspect command: pnpm -F vercel exec vitest run /inspect.test
deploy command: pnpm -F vercel exec vitest run /deploy.test

❗ Notes to reviewers

It's better to omit whitespace changes when reviewing packages/cli/src/util/events.ts since most of the code was enclosed in a try-catch.

changeset-bot · 2024-05-30T12:11:58Z

🦋 Changeset detected

Latest commit: 3f3b503

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

feugy · 2024-05-30T12:14:27Z

packages/cli/src/util/events.ts

+        const eventsRes = await client.fetch(eventsUrl, {
+          json: false,
+          signal: abortController?.signal,
+        });


client.fetch() supports node-retry options, so this code may be refactored and not being wrapped in a retry call.

feugy · 2024-05-30T12:18:20Z

packages/cli/src/util/deploy/process-deployment.ts

+    client,
+    deployment.id,
+    {
+      mode: 'logs',


We don't use 'deploy' mode here (which triggers its own polling), because it's actually not working.
The API does not return the special "events" which are meant to controller polling.

I highly doubt it's working, and I would suggest we remove this mode parameter and the related code.

Do we use the deploy anywhere?

Not to my knowledge.

packages/cli/src/commands/inspect/index.ts

.changeset/curly-otters-guess.md

lucleray · 2024-06-28T14:34:30Z

packages/cli/src/util/deploy/process-deployment.ts

+    client,
+    deployment.id,
+    {
+      mode: 'logs',


Do we use the deploy anywhere?

packages/cli/src/util/deploy/process-deployment.ts

packages/cli/src/util/events.ts

packages/cli/test/integration-3.test.ts

lucleray · 2024-07-02T07:44:07Z

packages/cli/src/commands/inspect/index.ts

+function exitCode(state: Deployment['readyState']) {
+  if (state === 'ERROR' || state === 'CANCELED') {
+    return 1;
  }
+  return 0;
 }


Shouldn't this be returning 0 all the time if you don't want to change how status code is returned?

EndangeredMassa · 2024-07-02T20:35:26Z

packages/cli/src/commands/inspect/index.ts

-      return chalk.gray('UNKNOWN');
+function exitCode(state: Deployment['readyState']) {
+  if (state === 'ERROR' || state === 'CANCELED') {
+    return 1;


This is a change, but I think it makes sense.

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 ## @vercel/build-utils@8.3.0 ### Minor Changes - Adds the ability for builders to define a `diagnostics` step that is called after the build operation is done. ([#11653](#11653)) Implements the diagnostics step in the `next` builder. ### Patch Changes - Add resolved node version range to warning message ([#11742](#11742)) ## vercel@34.3.0 ### Minor Changes - introduce --logs flag for deploy and inspect command to display build logs ([#11672](#11672)) - Adds the ability for builders to define a `diagnostics` step that is called after the build operation is done. ([#11653](#11653)) Implements the diagnostics step in the `next` builder. ### Patch Changes - Updated dependencies \[[`394eddb2a`](394eddb), [`b9d18c583`](b9d18c5), [`77836e3c3`](77836e3), [`11d0a32d8`](11d0a32)]: - @vercel/build-utils@8.3.0 - @vercel/next@4.3.0 - @vercel/remix-builder@2.1.9 - @vercel/redwood@2.1.0 - @vercel/node@3.2.1 - @vercel/static-build@2.5.12 ## @vercel/next@4.3.0 ### Minor Changes - Adds the ability for builders to define a `diagnostics` step that is called after the build operation is done. ([#11653](#11653)) Implements the diagnostics step in the `next` builder. ## @vercel/redwood@2.1.0 ### Minor Changes - Add support for API endpoint configuration via `export const config` syntax ([#11776](#11776)) ## @vercel/client@13.2.10 ### Patch Changes - Updated dependencies \[[`394eddb2a`](394eddb), [`b9d18c583`](b9d18c5)]: - @vercel/build-utils@8.3.0 ## @vercel/frameworks@3.0.3 ### Patch Changes - Update SvelteKit v1 devCommand ([#11494](#11494)) ## @vercel/fs-detectors@5.2.5 ### Patch Changes - Updated dependencies \[[`1484df7aa`](1484df7)]: - @vercel/frameworks@3.0.3 ## @vercel/gatsby-plugin-vercel-builder@2.0.34 ### Patch Changes - Updated dependencies \[[`394eddb2a`](394eddb), [`b9d18c583`](b9d18c5)]: - @vercel/build-utils@8.3.0 ## @vercel/node@3.2.1 ### Patch Changes - Updated dependencies \[[`394eddb2a`](394eddb), [`b9d18c583`](b9d18c5)]: - @vercel/build-utils@8.3.0 ## @vercel/remix-builder@2.1.9 ### Patch Changes - Update `@remix-run/dev` fork to v2.10.0 ([#11771](#11771)) ## @vercel/static-build@2.5.12 ### Patch Changes - Updated dependencies \[]: - @vercel/gatsby-plugin-vercel-builder@2.0.34 ## @vercel-internals/types@1.0.39 ### Patch Changes - Updated dependencies \[[`394eddb2a`](394eddb), [`b9d18c583`](b9d18c5)]: - @vercel/build-utils@8.3.0 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

feugy commented Jun 3, 2024

View reviewed changes

feugy force-pushed the damien/log-389-improve-vc-logs-build branch from fbf7f1b to f2687f4 Compare June 3, 2024 14:32

vercel bot deployed to Preview June 3, 2024 14:33 View deployment

feugy force-pushed the damien/log-389-improve-vc-logs-build branch from f2687f4 to b778a32 Compare June 12, 2024 14:02

vercel bot deployed to Preview June 12, 2024 14:03 View deployment

feugy force-pushed the damien/log-389-improve-vc-logs-build branch from b778a32 to b812a90 Compare June 14, 2024 14:49

vercel bot deployed to Preview June 14, 2024 14:51 View deployment

feugy force-pushed the damien/log-389-improve-vc-logs-build branch from b812a90 to 0e6fd6e Compare June 24, 2024 09:11

vercel bot deployed to Preview June 24, 2024 09:11 View deployment

feugy force-pushed the damien/log-389-improve-vc-logs-build branch from 0e6fd6e to a09198b Compare June 26, 2024 15:58

feugy marked this pull request as ready for review June 26, 2024 15:58

feugy requested review from EndangeredMassa, TooTallNate, erikareads, jeffsee55, onsclom and trek as code owners June 26, 2024 15:58

vercel bot deployed to Preview June 26, 2024 15:59 View deployment

feugy added 4 commits June 28, 2024 10:27

[cli] implements vc deploy --logs and vc inspect --logs

7965eaf

chore: add changeset and update help text snapshots

4109cbb

chore: more tests

b260eef

chore: add more tests

912badb

feugy force-pushed the damien/log-389-improve-vc-logs-build branch from a09198b to 912badb Compare June 28, 2024 08:27

vercel bot deployed to Preview June 28, 2024 08:28 View deployment

chore: use APi v3 instead of v1

3effe62

vercel bot deployed to Preview June 28, 2024 09:44 View deployment

lucleray reviewed Jun 28, 2024

View reviewed changes

feugy added 2 commits July 1, 2024 14:13

chore: handles PR remarks

88d2c29

Merge branch 'main' into damien/log-389-improve-vc-logs-build

ad786cb

vercel bot deployed to Preview July 1, 2024 12:15 View deployment

chore: fixes test

edf3ef9

vercel bot deployed to Preview July 1, 2024 13:58 View deployment

feugy commented Jul 1, 2024

View reviewed changes

packages/cli/test/integration-3.test.ts Outdated Show resolved Hide resolved

chore: remove undesired console.log

5a2dfbe

vercel bot deployed to Preview July 1, 2024 14:15 View deployment

Merge branch 'main' into damien/log-389-improve-vc-logs-build

0f29177

vercel bot deployed to Preview July 1, 2024 15:58 View deployment

feugy requested review from huozhi, ijjk, timneutkens and ztanner as code owners July 2, 2024 07:08

vercel bot deployed to Preview July 2, 2024 07:09 View deployment

Merge branch 'main' into damien/log-389-improve-vc-logs-build

e7c4864

feugy force-pushed the damien/log-389-improve-vc-logs-build branch from 0621a61 to 222df32 Compare July 2, 2024 07:11

vercel bot deployed to Preview July 2, 2024 07:12 View deployment

chore: revert exit code and output change

3f3b503

feugy force-pushed the damien/log-389-improve-vc-logs-build branch from 222df32 to 3f3b503 Compare July 2, 2024 07:13

vercel bot deployed to Preview July 2, 2024 07:14 View deployment

lucleray reviewed Jul 2, 2024

View reviewed changes

lucleray approved these changes Jul 2, 2024

View reviewed changes

trek approved these changes Jul 2, 2024

View reviewed changes

EndangeredMassa approved these changes Jul 2, 2024

View reviewed changes

feugy merged commit 06db035 into main Jul 3, 2024

feugy deleted the damien/log-389-improve-vc-logs-build branch July 3, 2024 04:56

vercel-release-bot mentioned this pull request Jul 1, 2024

Version Packages #11772

Merged

Conversation

feugy commented May 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧐 What's in there?

🧪 How to test?

❗ Notes to reviewers

Uh oh!

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

Uh oh!

🦋 Changeset detected

Uh oh!

feugy May 30, 2024

Choose a reason for hiding this comment

Uh oh!

feugy May 30, 2024

Choose a reason for hiding this comment

Uh oh!

lucleray Jun 28, 2024

Choose a reason for hiding this comment

Uh oh!

feugy Jul 1, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lucleray Jun 28, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lucleray Jul 2, 2024

Choose a reason for hiding this comment

Uh oh!

EndangeredMassa Jul 2, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feugy commented May 30, 2024 •

edited

Loading

changeset-bot bot commented May 30, 2024 •

edited

Loading