[gp-cli] Add alias for forward and await in ports #10538

CuriousCorrelation · 2022-06-08T17:36:48Z

Description

This PR aliases forward-port and await-port command to ports namespace as ports forward, ports await

Related Issue(s)

How to test

Both commands should be similar except for their Usage message

forward-port

❯ gp forward-port --help
Makes a port available on 0.0.0.0 so that it can be exposed to the internet

Usage:
  gp forward-port <local-port> [target-port] [flags]

Flags:
  -h, --help                  help for forward-port
  -r, --rewrite-host-header   rewrites the host header of passing HTTP requests to localhost

❯ gp ports forward --help
Makes a port available on 0.0.0.0 so that it can be exposed to the internet

Usage:
  gp ports forward <local-port> [target-port] [flags]

Flags:
  -h, --help                  help for forward
  -r, --rewrite-host-header   rewrites the host header of passing HTTP requests to localhost

await-port

❯ gp await-port --help
Waits for a process to listen on a port

Usage:
  gp await-port <port> [flags]

Flags:
  -h, --help   help for await-port

❯ gp ports await --help
Waits for a process to listen on a port

Usage:
  gp ports await <port> [flags]

Flags:
  -h, --help   help for await

Release Notes

Added alias for forward and await in ports CLI namespace

Documentation

Does this PR require updates to the documentation at www.gitpod.io/docs?

Yes

Please create a docs issue: https://github.com/gitpod-io/website/issues/new?labels=documentation&template=DOCS-NEW-FEATURE.yml&title=%5BDocs+-+New+Feature%5D%3A+%3Cyour+feature+name+here%3E
Paste the link to the docs issue below this comment

https://github.com/gitpod-io/website/issues/2173#issue-1260679472

andreafalzetti · 2022-06-08T21:36:50Z

/werft run

👍 started the job as gitpod-build-main-fork.39
(with .werft/ from main)

andreafalzetti · 2022-06-08T21:44:24Z

@CuriousCorrelation The build is failing because of a linting issue with Go. Could you run gofmt -w . from components/gitpod-cli? 🙏

Remember to squash your next commit, you can use: git commit --amend --no-edit and git push origin HEAD -f :)

mustard-mh · 2022-06-09T03:01:40Z

One suggestion is, can we switch the alias order, i.e. await <port> should be real command, await-port should be alias.

iQQBot · 2022-06-09T03:03:41Z

One suggestion is, can we switch the alias order, i.e. await <port> should be real command, await-port should be alias.

I think it's a better solution

akosyakov · 2022-06-09T06:03:56Z

Do we really need ports forward? Don't we proxy all ports by now by default already? I would like to keep forwarding for other means, like remote/local forwarding.

CuriousCorrelation · 2022-06-09T06:36:16Z

@andreafalzetti I bookmarked wrong pipeline and thought "everything looks good 🤓, must be something else...". Really sorry for the confusion! It should be fixed now.

CuriousCorrelation · 2022-06-09T06:39:09Z

I'd be happy to work on changing the ergonomics once there's a consensus.

andreafalzetti · 2022-06-09T20:18:14Z

Do we really need ports forward? Don't we proxy all ports by now by default already? I would like to keep forwarding for other means, like remote/local forwarding.

How can we name it? gp ports bind?

One suggestion is, can we switch the alias order, i.e. await should be real command, await-port should be alias.

Agree - we could always iterate and keep contributions flowing IMHO, but I also appriciate that if we don't track it, we won't do it in the future, so let's do it in this PR 👍

akosyakov · 2022-06-10T07:05:45Z

How can we name it? gp ports bind?

I ten to call it expose. But asked internally https://gitpod.slack.com/archives/C01KGM9DVRC/p1654844724560089

andreafalzetti · 2022-06-10T13:07:54Z

For visibility: Internal consensus was expose

andreafalzetti · 2022-06-10T13:11:50Z

It seems that agreed changes, are:

Move the commands code/logic and semantic closer to the ports file/cmd as suggested by @mustard-mh [1]
Alias the previous cmd instead
The new command will be gp ports expose instead of forward
We also discussed that it would be useful to add a deprecation warning on the old cmd.

What do you think, @CuriousCorrelation? Is this something you feel confortable moving forward?

CuriousCorrelation · 2022-06-10T13:58:30Z

@andreafalzetti These changes do seem better ergonomically and I'd love to work on them. I'll let you know if I have any questions or if there are any major changes.

Just to be extra sure, the new commands will be

gp ports expose <port>

and

gp ports await <port>

each with aliases

gp await-port <port>

and

gp forward-port <port>

respectively (hidden with deprecation warning).

Does that sound alright?

andreafalzetti · 2022-06-10T20:25:15Z

That sounds right @CuriousCorrelation! 🧡

`await-port` is now deprecated. New command is `gp ports await`. `await-port` is now an alias for backwards compatibility.

`forward-port` is now deprecated. New cmd is `gp ports expose`. `forward-port` is now an alias for `ports expose` for backwards compatibility.

CuriousCorrelation · 2022-06-11T14:38:32Z

Latest commit is up and repo is updated.

These are the changes

Commands

❯ gp --help
Command line interface for Gitpod

Usage:
  gp [command]

Available Commands:
  env                 Controls user-defined, persistent environment variables.
  help                Help about any command
  init                Create a Gitpod configuration for this project.
  open                Opens a file in Gitpod
  ports               Interact with workspace ports.
  preview             Opens a URL in the IDE's preview
  snapshot            Take a snapshot of the current workspace
  stop                Stop current workspace
  sync-await          Awaits an event triggered using gp sync-done
  sync-done           Notifies the corresponding gp sync-await calls that this event has happened
  tasks               Interact with workspace tasks
  url                 Prints the URL of this workspace
  version             Prints the version of the CLI

Flags:
  -h, --help   help for gp

Use "gp [command] --help" for more information about a command.

Ports now mentions `expose` instead of `forward`

❯ gp ports --help
Interact with workspace ports.

Usage:
  gp ports [flags]
  gp ports [command]

Available Commands:
  await       Waits for a process to listen on a port
  expose      Makes a port available on 0.0.0.0 so that it can be exposed to the internet
  list        Lists the workspace ports and their states.

Flags:
  -h, --help   help for ports

Use "gp ports [command] --help" for more information about a command.

`forward-port` now emits a deprecation warning.

❯ gp forward-port --help
Command "forward-port" is deprecated, please use `ports expose` instead.
Makes a port available on 0.0.0.0 so that it can be exposed to the internet

Usage:
  gp forward-port <local-port> [target-port] [flags]

Flags:
  -h, --help                  help for forward-port
  -r, --rewrite-host-header   rewrites the host header of passing HTTP requests to localhost

`forward-port` now moved to `ports expose`

❯ gp ports expose --help
Makes a port available on 0.0.0.0 so that it can be exposed to the internet

Usage:
  gp ports expose <local-port> [target-port] [flags]

Flags:
  -h, --help                  help for expose
  -r, --rewrite-host-header   rewrites the host header of passing HTTP requests to localhost

`await-port` now emits deprecation warning

❯ gp await-port --help
Command "await-port" is deprecated, please use `ports await` instead.
Waits for a process to listen on a port

Usage:
  gp await-port <port> [flags]

Flags:
  -h, --help   help for await-port

`ports await` is now the main command

❯ gp ports await --help
Waits for a process to listen on a port

Usage:
  gp ports await <port> [flags]

Flags:
  -h, --help   help for await

Files

Now that ports is a plural command like tasks

components/gitpod-cli/cmd/forward-port.go and components/gitpod-cli/cmd/await-port.go

are moved to

components/gitpod-cli/cmd/ports-expose.go and components/gitpod-cli/cmd/ports-await.go

respectively, modeled after tasks

components/gitpod-cli/cmd/tasks-list.go and components/gitpod-cli/cmd/tasks-attach.go

Commits

Divided into two commits, one for changes to await and one for forward for easier tracking. Commit message body mentions deprecation.

@andreafalzetti Let me know what you think about this and if I missed something!

loujaybee · 2022-06-13T11:16:57Z

Just dropping by to offer a big thank you for making this contribution @CuriousCorrelation 🙏

It's looking great, and thank you for responding to feedback so quickly! 🚀

CuriousCorrelation · 2022-06-13T14:11:14Z

@loujaybee My pleasure. Thank you and the team for maintaining an excellent service that I love to use daily!

andreafalzetti · 2022-06-13T23:01:13Z

/werft run

👍 started the job as gitpod-build-main-fork.40
(with .werft/ from main)

andreafalzetti

Changes look great, thanks a lot @CuriousCorrelation 🙏

We really appreciate your contribution 🙌

We will deploy this soon (I hope tomorrow) :)

andreafalzetti · 2022-06-14T00:22:53Z

@CuriousCorrelation I've released this PR to prod 🚀

gitpod-io/gitpod#10538 PR moved `await-port` functionality to `ports await` and `forward-port`, now renamed `expose`, moved to `ports expose` Previously: - `gp forward-port <port>` - `gp await-port <port>` Now: - `gp ports expose <port>` - `gp ports await <port>`

gitpod-io/gitpod#10538 Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

CuriousCorrelation requested a review from a team June 8, 2022 17:36

roboquat added release-note size/S labels Jun 8, 2022

CuriousCorrelation mentioned this pull request Jun 8, 2022

[gp-cli] Add alias for forward and await in ports #10463

Closed

2 tasks

iQQBot added the community-contribution label Jun 8, 2022

andreafalzetti added cla: accepted ✔️ team: IDE labels Jun 8, 2022

roboquat added size/M and removed size/S labels Jun 9, 2022

CuriousCorrelation added 2 commits June 11, 2022 19:38

[gp-cli] Add await subcommand to ports

fd6927d

`await-port` is now deprecated. New command is `gp ports await`. `await-port` is now an alias for backwards compatibility.

[gp-cli] Move forward-port subcmd to ports expose

1630a14

`forward-port` is now deprecated. New cmd is `gp ports expose`. `forward-port` is now an alias for `ports expose` for backwards compatibility.

andreafalzetti approved these changes Jun 13, 2022

View reviewed changes

roboquat merged commit 311d13c into gitpod-io:main Jun 13, 2022

roboquat added deployed: IDE IDE change is running in production deployed Change is completely running in production labels Jun 14, 2022

tnir added a commit to tnir/workspace-images that referenced this pull request Jul 22, 2022

Update await-port with ports await in gp-cli

2387ac7

gitpod-io/gitpod#10538 Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

tnir mentioned this pull request Jul 22, 2022

Update await-port with ports await in gp-cli gitpod-io/workspace-images#890

Merged

sagor999 pushed a commit to gitpod-io/workspace-images that referenced this pull request Jul 22, 2022

Update await-port with ports await in gp-cli

3f2c1ec

gitpod-io/gitpod#10538 Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

axonasif pushed a commit to gitpod-io/workspace-images that referenced this pull request Jul 25, 2022

Update await-port with ports await in gp-cli

71cfda7

gitpod-io/gitpod#10538 Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

[gp-cli] Add alias for forward and await in ports #10538

[gp-cli] Add alias for forward and await in ports #10538

Uh oh!

Conversation

CuriousCorrelation commented Jun 8, 2022

Description

Related Issue(s)

How to test

Release Notes

Documentation

Uh oh!

andreafalzetti commented Jun 8, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andreafalzetti commented Jun 8, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mustard-mh commented Jun 9, 2022

Uh oh!

iQQBot commented Jun 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

akosyakov commented Jun 9, 2022

Uh oh!

CuriousCorrelation commented Jun 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CuriousCorrelation commented Jun 9, 2022

Uh oh!

andreafalzetti commented Jun 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

akosyakov commented Jun 10, 2022

Uh oh!

andreafalzetti commented Jun 10, 2022

Uh oh!

andreafalzetti commented Jun 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CuriousCorrelation commented Jun 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andreafalzetti commented Jun 10, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CuriousCorrelation commented Jun 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Commands

Ports now mentions expose instead of forward

forward-port now emits a deprecation warning.

forward-port now moved to ports expose

await-port now emits deprecation warning

ports await is now the main command

Files

Commits

Uh oh!

loujaybee commented Jun 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CuriousCorrelation commented Jun 13, 2022

Uh oh!

andreafalzetti commented Jun 13, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andreafalzetti left a comment

Choose a reason for hiding this comment

Uh oh!

andreafalzetti commented Jun 14, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

andreafalzetti commented Jun 8, 2022 •

edited by werft-gitpod-dev-com bot

Loading

andreafalzetti commented Jun 8, 2022 •

edited

Loading

iQQBot commented Jun 9, 2022 •

edited

Loading

CuriousCorrelation commented Jun 9, 2022 •

edited

Loading

andreafalzetti commented Jun 9, 2022 •

edited

Loading

andreafalzetti commented Jun 10, 2022 •

edited

Loading

CuriousCorrelation commented Jun 10, 2022 •

edited

Loading

andreafalzetti commented Jun 10, 2022 •

edited by werft-gitpod-dev-com bot

Loading

CuriousCorrelation commented Jun 11, 2022 •

edited

Loading

Ports now mentions `expose` instead of `forward`

`forward-port` now emits a deprecation warning.

`forward-port` now moved to `ports expose`

`await-port` now emits deprecation warning

`ports await` is now the main command

loujaybee commented Jun 13, 2022 •

edited

Loading

andreafalzetti commented Jun 13, 2022 •

edited by werft-gitpod-dev-com bot

Loading

andreafalzetti commented Jun 14, 2022 •

edited by werft-gitpod-dev-com bot

Loading