Skip to content

fix: Use WebSockets to stream workspace build logs #2569

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 22, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Merge branch 'main' into wslogs
  • Loading branch information
kylecarbs committed Jun 22, 2022
commit 67a06649a797db002a5524374b780283844a256c
13 changes: 5 additions & 8 deletions scripts/develop.sh
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,15 @@ echo '== Without these binaries, workspaces will fail to start!'
CODERV2_HOST=http://127.0.0.1:3000 INSPECT_XSTATE=true yarn --cwd=./site dev || kill -INT -${SCRIPT_PID} &
go run -tags embed cmd/coder/main.go server --address 127.0.0.1:3000 --in-memory --tunnel || kill -INT -${SCRIPT_PID} &

trap 'kill 0' SIGINT
CODER_HOST=http://127.0.0.1:3000 INSPECT_XSTATE=true yarn --cwd=./site dev &
go run -tags embed cmd/coder/main.go server --in-memory --tunnel &

# Just a minor sleep to ensure the first user was created to make the member.
sleep 5
echo '== Waiting for Coder to become ready'
timeout 60s bash -c 'until curl -s --fail http://localhost:3000 > /dev/null 2>&1; do sleep 0.5; done'

# create the first user, the admin
go run cmd/coder/main.go login http://127.0.0.1:3000 --username=admin --email=admin@coder.com --password="${CODER_DEV_ADMIN_PASSWORD}" ||
echo 'Failed to create admin user. To troubleshoot, try running this command manually.'

# || yes to always exit code 0. If this fails, whelp.
go run cmd/coder/main.go users create --email=member@coder.com --username=member --password=password || true
# || true to always exit code 0. If this fails, whelp.
go run cmd/coder/main.go users create --email=member@coder.com --username=member --password="${CODER_DEV_ADMIN_PASSWORD}" ||
echo 'Failed to create regular user. To troubleshoot, try running this command manually.'
wait
)
4 changes: 3 additions & 1 deletion site/src/api/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,9 @@ export const getWorkspaceBuildByNumber = async (
}

export const getWorkspaceBuildLogs = async (buildname: string, before: Date): Promise<TypesGen.ProvisionerJobLog[]> => {
const response = await axios.get<TypesGen.ProvisionerJobLog[]>(`/api/v2/workspacebuilds/${buildname}/logs?before=${before.getTime()}`)
const response = await axios.get<TypesGen.ProvisionerJobLog[]>(
`/api/v2/workspacebuilds/${buildname}/logs?before=${before.getTime()}`,
)
return response.data
}

Expand Down
12 changes: 6 additions & 6 deletions site/src/api/typesGenerated.ts
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ export interface ParameterSchema {
readonly validation_contains?: string[]
}

// From codersdk/provisionerdaemons.go:33:6
// From codersdk/provisionerdaemons.go:38:6
export interface ProvisionerDaemon {
readonly id: string
readonly created_at: string
Expand All @@ -210,7 +210,7 @@ export interface ProvisionerDaemon {
readonly provisioners: ProvisionerType[]
}

// From codersdk/provisionerdaemons.go:62:6
// From codersdk/provisionerdaemons.go:67:6
export interface ProvisionerJob {
readonly id: string
readonly created_at: string
Expand All @@ -222,7 +222,7 @@ export interface ProvisionerJob {
readonly storage_source: string
}

// From codersdk/provisionerdaemons.go:73:6
// From codersdk/provisionerdaemons.go:78:6
export interface ProvisionerJobLog {
readonly id: string
readonly created_at: string
Expand Down Expand Up @@ -485,10 +485,10 @@ export interface WorkspaceResource {
// From codersdk/workspacebuilds.go:22:6
export type BuildReason = "autostart" | "autostop" | "initiator"

// From codersdk/provisionerdaemons.go:23:6
// From codersdk/provisionerdaemons.go:28:6
export type LogLevel = "debug" | "error" | "info" | "trace" | "warn"

// From codersdk/provisionerdaemons.go:16:6
// From codersdk/provisionerdaemons.go:21:6
export type LogSource = "provisioner" | "provisioner_daemon"

// From codersdk/parameters.go:29:6
Expand All @@ -503,7 +503,7 @@ export type ParameterSourceScheme = "data" | "none"
// From codersdk/parameters.go:37:6
export type ParameterTypeSystem = "hcl" | "none"

// From codersdk/provisionerdaemons.go:42:6
// From codersdk/provisionerdaemons.go:47:6
export type ProvisionerJobStatus = "canceled" | "canceling" | "failed" | "pending" | "running" | "succeeded"

// From codersdk/organizations.go:14:6
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
import { screen } from "@testing-library/react"
import WS from "jest-websocket-mock"
import {
MockWorkspace,
MockWorkspaceBuild,
renderWithAuth,
} from "../../testHelpers/renderHelpers"
import { MockWorkspace, MockWorkspaceBuild, renderWithAuth } from "../../testHelpers/renderHelpers"
import { WorkspaceBuildPage } from "./WorkspaceBuildPage"

describe("WorkspaceBuildPage", () => {
Expand Down
13 changes: 7 additions & 6 deletions site/src/xServices/workspaceBuild/workspaceBuildXService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,10 @@ type LogsContext = {
logs?: ProvisionerJobLog[]
}

type LogsEvent =
| {
type: "ADD_LOG"
log: ProvisionerJobLog
}
type LogsEvent = {
type: "ADD_LOG"
log: ProvisionerJobLog
}

export const workspaceBuildMachine = createMachine(
{
Expand Down Expand Up @@ -121,7 +120,9 @@ export const workspaceBuildMachine = createMachine(
return new Promise<void>((resolve, reject) => {
const proto = location.protocol === "https:" ? "wss:" : "ws:"
const socket = new WebSocket(
`${proto}//${location.host}/api/v2/workspacebuilds/${ctx.buildId}/logs?follow=true&after=${ctx.timeCursor.getTime()}`,
`${proto}//${location.host}/api/v2/workspacebuilds/${
ctx.buildId
}/logs?follow=true&after=${ctx.timeCursor.getTime()}`,
)
socket.binaryType = "blob"
socket.addEventListener("message", (event) => {
Expand Down
You are viewing a condensed version of this merge commit. You can view the full changes here.