Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature: Dynamic port forwarding allow+deny list #38

Open
gtaylor opened this issue Jul 30, 2024 · 3 comments · May be fixed by #49
Open

Feature: Dynamic port forwarding allow+deny list #38

gtaylor opened this issue Jul 30, 2024 · 3 comments · May be fixed by #49
Assignees
@bcpeinhardt
Labels
enhancement New feature or request

Comments

@gtaylor
Copy link

gtaylor commented Jul 30, 2024

The /proc-based automatic port forwarding is working well for us, but there are cases where the open-ended and unfiltered nature of the forwarding causes user confusion.

For example: we use the sidecar pattern to break language-agnostic platform functionality out of each language framework that we provide. These sidecars often listen on a port over TCP/UDP and are thus auto-forwarded. There are cases where this can cause confusing behavior on the user's laptop, or unexpected reuse of the sidecar outside of the dev environment that it's contained in.

Unexpected forwarding could be solved via allow+deny list settings in the Coder IDE plugins. Here are some starting point requirements to kickstart the discussion:

  1. The Coder IDE plugins should have an allow+deny list construct to allow our users to manage their port forwarding behaviors.
  2. The allow+deny lists should support a list of single ports or port ranges. For example: [8080, 9000-9100]
  3. To allow our users to iterate with their port forwarding allow+deny lists without having to restart their IDEs or their Coder workspaces, we should be able to either push a settings change to the IDE from the Coder workspace, or the Coder IDE plugin should watch an external config file and update its internal IDE settings as it changes. I think we'd also be OK with sending a SIGHUP to reload the file that we write, if that simplifies things.

With these requirements satisfied, we'd envision exposing the allow+deny lists to our users via the repo's devcontainer.json file alongside all of our other dev environment settings. A daemon of our creation would watch the devcontainer.json for changes and create/over-write a file that the Coder IDE plugin would update its settings from. I don't think we are too caught up on these specifics so long as we can signal the IDE to reload its settings from values that we provide.

While I raise this possibility as being useful for port forwarding allow+deny lists, this construct may be useful for other Coder IDE plugin settings in the future.
@coder-labeler coder-labeler bot added the enhancement New feature or request label Jul 30, 2024
@gtaylor gtaylor mentioned this issue Jul 30, 2024
Open
@code-asher code-asher self-assigned this Aug 26, 2024
@code-asher code-asher mentioned this issue Aug 26, 2024
Open
@Kira-Pilot Kira-Pilot assigned bcpeinhardt and unassigned code-asher Aug 26, 2024
@aaronlehmann
Copy link

Hi @bcpeinhardt, I'm interested in working on this. Do you think that creating a file with a list of ports to avoid automatically forwarding would be a good way to pass this info to the backend, or do you have any better ideas for this? If we go with a file, do you have any preferences on the file format (JSON, etc...)? Also, any preferences on file path (maybe under ~/.idea or ~/.config/coder)?

@aaronlehmann
Copy link

Better idea: Add a setting with a path to a devcontainer.json file. Then if the file exists at this location, the backend will parse portAttributes and otherPortAttributes from it and act on those settings.

aaronlehmann added a commit to aaronlehmann/jetbrains-backend-coder that referenced this issue Feb 21, 2025
@aaronlehmann
Control automatic port forwarding with a devcontainer.json file
2b75906 
devcontainer.json has a system for specifying default behavior for
forwarding ports, and also behavior for specific ports and ranges of
ports. Its schema is essentially identical to the settings VS Code uses
to control port forwarding, so supporting this format for port settings
keeps things consistent between VS Code and JetBrains.

See https://containers.dev/implementors/json_reference/ for the spec.
As an example, this will turn off automatic port forwarding except for
ports 7123 and 8100-8150:

    {
      "otherPortsAttributes": {
        "onAutoForward": "ignore"
      },
      "portsAttributes": {
        "7123": {
          "onAutoForward": "notify"
        },
        "8100-8150": {
          "onAutoForward": "notify"
        }
      }
    }

Fixes: coder#38
aaronlehmann added a commit to aaronlehmann/jetbrains-backend-coder that referenced this issue Feb 21, 2025
@aaronlehmann
Control automatic port forwarding with a devcontainer.json file
ad75308 
devcontainer.json has a system for specifying default behavior for
forwarding ports, and also behavior for specific ports and ranges of
ports. Its schema is essentially identical to the settings VS Code uses
to control port forwarding, so supporting this format for port settings
keeps things consistent between VS Code and JetBrains.

See https://containers.dev/implementors/json_reference/ for the spec.
As an example, this will turn off automatic port forwarding except for
ports 7123 and 8100-8150:

    {
      "otherPortsAttributes": {
        "onAutoForward": "ignore"
      },
      "portsAttributes": {
        "7123": {
          "onAutoForward": "notify"
        },
        "8100-8150": {
          "onAutoForward": "notify"
        }
      }
    }

Fixes: coder#38
@aaronlehmann aaronlehmann linked a pull request Feb 21, 2025 that will close this issue
Open
@aaronlehmann
Copy link

Gave this a shot here: #49

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bcpeinhardt bcpeinhardt

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Control automatic port forwarding with a devcontainer.json file aaronlehmann/jetbrains-backend-coder
4 participants
@gtaylor @aaronlehmann @code-asher @bcpeinhardt