[public-api] Validate Workspace IDs #15423
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
team: webapp
easyCZ
commented
Dec 19, 2022
| }, | ||
| }, | ||
| } | ||
| t.Run("invalid argument when workspace ID is missing", func(t *testing.T) { |
There was a problem hiding this comment.
Changing the tests into individual sub-tests made it much easier to follow the test and debug.
easyCZ
commented
Dec 19, 2022
Comment on lines
+147
to
164
| switch req.Msg.GetPort().GetPolicy() { | ||
| case v1.PortPolicy_PORT_POLICY_PRIVATE: | ||
| _, err = conn.OpenPort(ctx, workspaceID, &protocol.WorkspaceInstancePort{ | ||
| Port: float64(req.Msg.Port.Port), | ||
| Visibility: protocol.PortVisibilityPrivate, | ||
| }) | ||
| } else if req.Msg.Port.Policy == v1.PortPolicy_PORT_POLICY_PUBLIC { | ||
| _, err = conn.OpenPort(ctx, req.Msg.GetWorkspaceId(), &protocol.WorkspaceInstancePort{ | ||
| case v1.PortPolicy_PORT_POLICY_PUBLIC: | ||
| _, err = conn.OpenPort(ctx, workspaceID, &protocol.WorkspaceInstancePort{ | ||
| Port: float64(req.Msg.Port.Port), | ||
| Visibility: protocol.PortVisibilityPublic, | ||
| }) | ||
| default: | ||
| return nil, connect.NewError(connect.CodeInvalidArgument, fmt.Errorf("Unknown port policy specified.")) | ||
| } | ||
| if err != nil { | ||
| log.WithField("workspace_id", workspaceID).Error("Failed to update port") | ||
| return nil, proxy.ConvertError(err) | ||
| } |
There was a problem hiding this comment.
Drive-by cleanup: this ensures that an unknown port policy fails on the API layer. Previously, it would skip both branches and return OK, without actually doing anything.
utam0k
reviewed
Dec 19, 2022
|
|
||
| func ValidateWorkspaceID(id string) error { | ||
| if !WorkspaceIDPattern.MatchString(id) { | ||
| return fmt.Errorf("id '%s' does not match workspace ID regex '%s': %w", id, WorkspaceIDPattern.String(), InvalidWorkspaceID) |
There was a problem hiding this comment.
Suggested change
| return fmt.Errorf("id '%s' does not match workspace ID regex '%s': %w", id, WorkspaceIDPattern.String(), InvalidWorkspaceID) | |
| return xerrors.Errorf("id '%s' does not match workspace ID regex '%s': %w", id, WorkspaceIDPattern.String(), InvalidWorkspaceID) |
easyCZ
force-pushed
the
mp/papi-validate-workspace-id
branch
from
3e53270 to
fca202c
Compare
|
/werft run 👍 started the job as gitpod-build-mp-papi-validate-workspace-id.4 |
|
/hold this appears to be blocking tide |
|
/unhold tide is no longer blocked, see https://prow.gitpod-dev.com/tide |
|
/werft run 👍 started the job as gitpod-build-mp-papi-validate-workspace-id.5 |
|
Thanks @kylos101, there are some flaky supervisor tests which caused the build to fail |
roboquat
added
the
deployed: workspace
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds validation to Workspace IDs on the API level
Related Issue(s)
Fixes #
How to test
Unit tests
Release Notes
Documentation
Werft options:
If enabled this will build
install/previewValid options are
all,workspace,webapp,ide,jetbrains,vscode,ssh