- Notifications
You must be signed in to change notification settings - Fork1.1k
feat: add WorkspaceUpdates tailnet RPC#14847
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
+2,220 −271
Merged
Changes fromall commits
Commits
Show all changes
7 commits Select commitHold shift + click to select a range
6de5ce2 feat: add WorkspaceUpdates rpc
ethanndickson341c688 review p1
ethanndickson8cff11b review p2
ethanndicksoneafee6b remove mutex on sub close
ethanndickson8195b93 remove sql no rows
ethanndickson4ef174a rbac filter
ethanndicksonb509099 review
ethanndicksonFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
19 changes: 19 additions & 0 deletionscoderd/apidoc/docs.go
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
17 changes: 17 additions & 0 deletionscoderd/apidoc/swagger.json
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
23 changes: 17 additions & 6 deletionscoderd/coderd.go
This file contains hidden or 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
8 changes: 8 additions & 0 deletionscoderd/database/dbfake/dbfake.go
This file contains hidden or 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
140 changes: 114 additions & 26 deletionscoderd/workspaceagents.go
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -33,6 +33,7 @@ import ( | ||
| "github.com/coder/coder/v2/coderd/httpapi" | ||
| "github.com/coder/coder/v2/coderd/httpmw" | ||
| "github.com/coder/coder/v2/coderd/jwtutils" | ||
| "github.com/coder/coder/v2/coderd/rbac" | ||
| "github.com/coder/coder/v2/coderd/rbac/policy" | ||
| "github.com/coder/coder/v2/coderd/wspubsub" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| @@ -844,31 +845,10 @@ func (api *API) workspaceAgentClientCoordinate(rw http.ResponseWriter, r *http.R | ||
| return | ||
| } | ||
| peerID, err := api.handleResumeToken(ctx, rw, r) | ||
| if err != nil { | ||
| // handleResumeToken has already written the response. | ||
| return | ||
| } | ||
| api.WebsocketWaitMutex.Lock() | ||
| @@ -891,13 +871,47 @@ func (api *API) workspaceAgentClientCoordinate(rw http.ResponseWriter, r *http.R | ||
| go httpapi.Heartbeat(ctx, conn) | ||
| defer conn.Close(websocket.StatusNormalClosure, "") | ||
| err = api.TailnetClientService.ServeClient(ctx, version, wsNetConn, tailnet.StreamID{ | ||
| Name: "client", | ||
| ID: peerID, | ||
| Auth: tailnet.ClientCoordinateeAuth{ | ||
| AgentID: workspaceAgent.ID, | ||
| }, | ||
| }) | ||
| if err != nil && !xerrors.Is(err, io.EOF) && !xerrors.Is(err, context.Canceled) { | ||
| _ = conn.Close(websocket.StatusInternalError, err.Error()) | ||
| return | ||
| } | ||
| } | ||
| // handleResumeToken accepts a resume_token query parameter to use the same peer ID | ||
| func (api *API) handleResumeToken(ctx context.Context, rw http.ResponseWriter, r *http.Request) (peerID uuid.UUID, err error) { | ||
| peerID = uuid.New() | ||
| resumeToken := r.URL.Query().Get("resume_token") | ||
| if resumeToken != "" { | ||
| peerID, err = api.Options.CoordinatorResumeTokenProvider.VerifyResumeToken(ctx, resumeToken) | ||
| // If the token is missing the key ID, it's probably an old token in which | ||
| // case we just want to generate a new peer ID. | ||
| if xerrors.Is(err, jwtutils.ErrMissingKeyID) { | ||
| peerID = uuid.New() | ||
| err = nil | ||
| } else if err != nil { | ||
| httpapi.Write(ctx, rw, http.StatusUnauthorized, codersdk.Response{ | ||
| Message: workspacesdk.CoordinateAPIInvalidResumeToken, | ||
| Detail: err.Error(), | ||
| Validations: []codersdk.ValidationError{ | ||
| {Field: "resume_token", Detail: workspacesdk.CoordinateAPIInvalidResumeToken}, | ||
| }, | ||
| }) | ||
| return peerID, err | ||
| } else { | ||
| api.Logger.Debug(ctx, "accepted coordinate resume token for peer", | ||
| slog.F("peer_id", peerID.String())) | ||
| } | ||
| } | ||
| return peerID, err | ||
| } | ||
| // @Summary Post workspace agent log source | ||
| // @ID post-workspace-agent-log-source | ||
| // @Security CoderSessionToken | ||
| @@ -1469,6 +1483,80 @@ func (api *API) workspaceAgentsExternalAuthListen(ctx context.Context, rw http.R | ||
| } | ||
| } | ||
| // @Summary User-scoped tailnet RPC connection | ||
| // @ID user-scoped-tailnet-rpc-connection | ||
| // @Security CoderSessionToken | ||
| // @Tags Agents | ||
Contributor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. drop this tag --- it's not specifically related to agents, unlike the existing RPC which targets a specific agent. MemberAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. The swagger parser requires a tag, so it'd be between | ||
| // @Success 101 | ||
| // @Router /tailnet [get] | ||
| func (api *API) tailnetRPCConn(rw http.ResponseWriter, r *http.Request) { | ||
| ctx := r.Context() | ||
| version := "2.0" | ||
| qv := r.URL.Query().Get("version") | ||
| if qv != "" { | ||
| version = qv | ||
| } | ||
| if err := proto.CurrentVersion.Validate(version); err != nil { | ||
| httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{ | ||
| Message: "Unknown or unsupported API version", | ||
| Validations: []codersdk.ValidationError{ | ||
| {Field: "version", Detail: err.Error()}, | ||
| }, | ||
| }) | ||
| return | ||
| } | ||
| peerID, err := api.handleResumeToken(ctx, rw, r) | ||
ethanndickson marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| if err != nil { | ||
| // handleResumeToken has already written the response. | ||
| return | ||
| } | ||
| // Used to authorize tunnel request | ||
| sshPrep, err := api.HTTPAuth.AuthorizeSQLFilter(r, policy.ActionSSH, rbac.ResourceWorkspace.Type) | ||
| if err != nil { | ||
| httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{ | ||
| Message: "Internal error preparing sql filter.", | ||
| Detail: err.Error(), | ||
| }) | ||
| return | ||
| } | ||
| api.WebsocketWaitMutex.Lock() | ||
| api.WebsocketWaitGroup.Add(1) | ||
| api.WebsocketWaitMutex.Unlock() | ||
| defer api.WebsocketWaitGroup.Done() | ||
| conn, err := websocket.Accept(rw, r, nil) | ||
| if err != nil { | ||
| httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{ | ||
| Message: "Failed to accept websocket.", | ||
| Detail: err.Error(), | ||
| }) | ||
| return | ||
| } | ||
| ctx, wsNetConn := codersdk.WebsocketNetConn(ctx, conn, websocket.MessageBinary) | ||
| defer wsNetConn.Close() | ||
| defer conn.Close(websocket.StatusNormalClosure, "") | ||
| go httpapi.Heartbeat(ctx, conn) | ||
| err = api.TailnetClientService.ServeClient(ctx, version, wsNetConn, tailnet.StreamID{ | ||
| Name: "client", | ||
| ID: peerID, | ||
| Auth: tailnet.ClientUserCoordinateeAuth{ | ||
| Auth: &rbacAuthorizer{ | ||
| sshPrep: sshPrep, | ||
| db: api.Database, | ||
| }, | ||
| }, | ||
| }) | ||
| if err != nil && !xerrors.Is(err, io.EOF) && !xerrors.Is(err, context.Canceled) { | ||
| _ = conn.Close(websocket.StatusInternalError, err.Error()) | ||
| return | ||
| } | ||
| } | ||
| // createExternalAuthResponse creates an ExternalAuthResponse based on the | ||
| // provider type. This is to support legacy `/workspaceagents/me/gitauth` | ||
| // which uses `Username` and `Password`. | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.