Skip to content

Use unique socket per user for managing editor sessions #6278

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 2 commits into from
Jun 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
4 changes: 3 additions & 1 deletion src/node/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,9 @@ export const runCodeServer = async (

logger.info(`Using config file ${humanPath(os.homedir(), args.config)}`)
logger.info(`${protocol.toUpperCase()} server listening on ${serverAddress.toString()}`)
logger.info(`Session server listening on ${sessionServerAddress?.toString()}`)
if (sessionServerAddress) {
logger.info(`Session server listening on ${sessionServerAddress.toString()}`)
}

if (args.auth === AuthType.Password) {
logger.info(" - Authentication is enabled")
Expand Down
11 changes: 7 additions & 4 deletions src/node/vscodeSocket.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
import { logger } from "@coder/logger"
import express from "express"
import * as http from "http"
import * as os from "os"
import * as path from "path"
import { HttpCode } from "../common/http"
import { listen } from "./app"
import { canConnect } from "./util"
import { canConnect, paths } from "./util"

// Socket path of the daemonized code-server instance.
export const DEFAULT_SOCKET_PATH = path.join(os.tmpdir(), "code-server-ipc.sock")
export const DEFAULT_SOCKET_PATH = path.join(paths.data, `code-server-ipc.sock`)

export interface EditorSessionEntry {
workspace: {
Expand Down Expand Up @@ -78,7 +77,11 @@ export async function makeEditorSessionManagerServer(
})

const server = http.createServer(router)
await listen(server, { socket: codeServerSocketPath })
try {
await listen(server, { socket: codeServerSocketPath })
} catch (e) {
logger.warn(`Could not create socket at ${codeServerSocketPath}`)
}
return server
}

Expand Down
49 changes: 47 additions & 2 deletions test/unit/node/vscodeSocket.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,50 @@
import { EditorSessionManager } from "../../../src/node/vscodeSocket"
import { clean, tmpdir, listenOn } from "../../utils/helpers"
import { logger } from "@coder/logger"
import * as app from "../../../src/node/app"
import { paths } from "../../../src/node/util"
import {
DEFAULT_SOCKET_PATH,
EditorSessionManager,
makeEditorSessionManagerServer,
} from "../../../src/node/vscodeSocket"
import { clean, tmpdir, listenOn, mockLogger } from "../../utils/helpers"

describe("DEFAULT_SOCKET_PATH", () => {
it("should be a unique path per user", () => {
expect(DEFAULT_SOCKET_PATH.startsWith(paths.data)).toBe(true)
})
})

describe("makeEditorSessionManagerServer", () => {
let tmpDirPath: string

const testName = "mesms"

beforeAll(async () => {
jest.clearAllMocks()
mockLogger()
await clean(testName)
})

afterAll(() => {
jest.resetModules()
})

beforeEach(async () => {
tmpDirPath = await tmpdir(testName)
})

it("warns if socket cannot be created", async () => {
jest.spyOn(app, "listen").mockImplementation(() => {
throw new Error()
})
const server = await makeEditorSessionManagerServer(
`${tmpDirPath}/code-server-ipc.sock`,
new EditorSessionManager(),
)
expect(logger.warn).toHaveBeenCalledWith(`Could not create socket at ${tmpDirPath}/code-server-ipc.sock`)
server.close()
})
})

describe("EditorSessionManager", () => {
let tmpDirPath: string
Expand Down