Skip to content

Commit fb7f83c

Browse files
antfubotantfubot
committed
refactor(code-server): rename backend id to ms-code-serve-web
1 parent 7f68bea commit fb7f83c

10 files changed

Lines changed: 19 additions & 19 deletions

File tree

‎docs/plugins/code-server.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The editor iframe points at the server's own origin, so its WebSocket traffic fl
2323
| `backend` | Binary | Auth handoff |
2424
|-----------|--------|--------------|
2525
| `'code-server'` | Coder's [`code-server`](https://github.com/coder/code-server) | password + session cookie |
26-
| `'code-serve-web'` | Microsoft's [`code serve-web`](https://code.visualstudio.com/docs/remote/vscode-server) | connection token (`?tkn=`) |
26+
| `'ms-code-serve-web'` | Microsoft's [`code serve-web`](https://code.visualstudio.com/docs/remote/vscode-server) | connection token (`?tkn=`) |
2727

2828
## Tunnel mode
2929

@@ -55,7 +55,7 @@ export default defineConfig({
5555
import { createCodeServerDevframe } from '@devframes/plugin-code-server'
5656

5757
export default createCodeServerDevframe({
58-
// backend: 'code-server', // 'code-server' | 'code-serve-web' (default: auto-detect)
58+
// backend: 'code-server', // 'code-server' | 'ms-code-serve-web' (default: auto-detect)
5959
// mode: 'local', // 'local' | 'tunnel'
6060
// serverPort: 8080, // force a port (default: free port near 8080)
6161
// startOnBoot: true, // launch during setup instead of on demand

‎plugins/code-server/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ or leave it unset to auto-detect (prefers `code-server`, then `code serve-web`).
3030
| `backend` | Binary | Auth |
3131
|-----------|--------|------|
3232
| `'code-server'` | Coder [`code-server`](https://github.com/coder/code-server) | password + session cookie |
33-
| `'code-serve-web'` | Microsoft [`code serve-web`](https://code.visualstudio.com/docs/remote/vscode-server) | connection token (`?tkn=`) |
33+
| `'ms-code-serve-web'` | Microsoft [`code serve-web`](https://code.visualstudio.com/docs/remote/vscode-server) | connection token (`?tkn=`) |
3434

3535
`mode: 'tunnel'` runs Microsoft's `code tunnel` and embeds the hosted
3636
`vscode.dev` editor. The first launch surfaces a device-login prompt in the
@@ -50,7 +50,7 @@ npx @devframes/plugin-code-server # dev server + launcher
5050
import { createCodeServerDevframe } from '@devframes/plugin-code-server'
5151

5252
export default createCodeServerDevframe({
53-
// backend: 'code-server', // 'code-server' | 'code-serve-web' (default: auto)
53+
// backend: 'code-server', // 'code-server' | 'ms-code-serve-web' (default: auto)
5454
// mode: 'local', // 'local' | 'tunnel'
5555
// serverPort: 8080, // force a port (default: free port near 8080)
5656
// startOnBoot: true, // launch during setup instead of on demand

‎plugins/code-server/src/node/backends.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface ProfileContext {
2828

2929
export interface CodeServerProfile {
3030
kind: CodeServerProfileKind
31-
/** Public backend id (tunnel reports `code-serve-web`'s sibling `code` binary). */
31+
/** Public backend id (tunnel reports `ms-code-serve-web`'s sibling `code` binary). */
3232
backend: CodeServerBackend
3333
/** Default binary when the caller doesn't override `bin`. */
3434
defaultBin: string
@@ -87,7 +87,7 @@ const codeServerProfile: CodeServerProfile = {
8787
/** Microsoft's `code serve-web`, with a connection token passed via `?tkn=`. */
8888
const serveWebProfile: CodeServerProfile = {
8989
kind: 'serve-web',
90-
backend: 'code-serve-web',
90+
backend: 'ms-code-serve-web',
9191
defaultBin: 'code',
9292
buildArgs: c => [
9393
'serve-web',
@@ -117,7 +117,7 @@ const DEVICE_LOGIN_RE = /log in(?:to)? (https?:\/\/\S+) and use code ([A-Z0-9-]+
117117
/** Microsoft's `code tunnel`, embedding the hosted `vscode.dev` editor. */
118118
const tunnelProfile: CodeServerProfile = {
119119
kind: 'tunnel',
120-
backend: 'code-serve-web',
120+
backend: 'ms-code-serve-web',
121121
defaultBin: 'code',
122122
buildArgs: c => [
123123
'tunnel',
@@ -142,11 +142,11 @@ const tunnelProfile: CodeServerProfile = {
142142

143143
const LOCAL_PROFILES: Record<CodeServerBackend, CodeServerProfile> = {
144144
'code-server': codeServerProfile,
145-
'code-serve-web': serveWebProfile,
145+
'ms-code-serve-web': serveWebProfile,
146146
}
147147

148148
/** The ordered auto-detection candidates for `mode: 'local'` with no explicit backend. */
149-
export const AUTO_DETECT_ORDER: CodeServerBackend[] = ['code-server', 'code-serve-web']
149+
export const AUTO_DETECT_ORDER: CodeServerBackend[] = ['code-server', 'ms-code-serve-web']
150150

151151
/** Resolve the launch profile for a mode + backend. */
152152
export function resolveProfile(mode: CodeServerMode, backend: CodeServerBackend): CodeServerProfile {

‎plugins/code-server/src/spa/components/LauncherView.stories.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export const Launch: Story = {
6060
export const LaunchServeWeb: Story = {
6161
args: {
6262
phase: 'launch',
63-
detection: { ...localCodeServer, backend: 'code-serve-web', bin: 'code', version: '1.99.0' },
63+
detection: { ...localCodeServer, backend: 'ms-code-serve-web', bin: 'code', version: '1.99.0' },
6464
server: { status: 'stopped' },
6565
busy: false,
6666
},
@@ -90,7 +90,7 @@ export const Starting: Story = {
9090
export const TunnelLogin: Story = {
9191
args: {
9292
phase: 'starting',
93-
detection: { checked: true, installed: true, version: '1.99.0', bin: 'code', backend: 'code-serve-web', mode: 'tunnel' },
93+
detection: { checked: true, installed: true, version: '1.99.0', bin: 'code', backend: 'ms-code-serve-web', mode: 'tunnel' },
9494
server: {
9595
status: 'starting',
9696
login: { url: 'https://github.com/login/device', code: 'ABCD-1234' },

‎plugins/code-server/src/spa/components/LauncherView.vue‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ function copy(command: string): void {
4040
const backendLabel = computed(() =>
4141
props.detection.mode === 'tunnel'
4242
? 'tunnel'
43-
: props.detection.backend === 'code-serve-web' ? 'code serve-web' : 'code-server',
43+
: props.detection.backend === 'ms-code-serve-web' ? 'code serve-web' : 'code-server',
4444
)
4545
const errorText = computed(() => (props.server.status === 'error' ? props.server.error : undefined))
4646
</script>

‎plugins/code-server/src/types.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ export type CodeServerStatus = 'stopped' | 'starting' | 'running' | 'error'
88
* [code-server](https://github.com/coder/code-server) (`code-server …`). The
99
* plugin runs it with password auth and hands the client a session cookie, so
1010
* the embedded editor opens already signed in.
11-
* - `'code-serve-web'` — Microsoft's official
11+
* - `'ms-code-serve-web'` — Microsoft's official
1212
* [`code serve-web`](https://code.visualstudio.com/docs/remote/vscode-server)
1313
* (ships with the `code` CLI). The plugin generates a connection token and
1414
* hands it to the client as a `?tkn=` query parameter.
1515
*/
16-
export type CodeServerBackend = 'code-server' | 'code-serve-web'
16+
export type CodeServerBackend = 'code-server' | 'ms-code-serve-web'
1717

1818
/**
1919
* How the editor is served:

‎plugins/code-server/test/code-server.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,12 +136,12 @@ describe('@devframes/plugin-code-server', () => {
136136
const dumpTokenTo = join(mkdtempSync(join(tmpdir(), 'dcs-tkn-')), 'token')
137137
const bin = writeFakeServeWeb({ version: '1.99.0', dumpTokenTo })
138138
const ctx = await createTestContext()
139-
const supervisor = await setupCodeServer(ctx, { backend: 'code-serve-web', bin, serverPort: 0 })
139+
const supervisor = await setupCodeServer(ctx, { backend: 'ms-code-serve-web', bin, serverPort: 0 })
140140
supervisors.push(supervisor)
141141

142142
const result = await supervisor.start()
143143
expect(result.server.status).toBe('running')
144-
expect(result.detection.backend).toBe('code-serve-web')
144+
expect(result.detection.backend).toBe('ms-code-serve-web')
145145
// No cookie for serve-web; the token rides on the URL query.
146146
expect(result.connect?.cookie).toBeUndefined()
147147
const token = readFileSync(dumpTokenTo, 'utf8')

‎tests/__snapshots__/tsnapi/@devframes/plugin-code-server/node.snapshot.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export declare class CodeServerSupervisor {
5252
private adopted;
5353
private readyUrl?;
5454
private logBuffer;
55-
private cleanupRegistered;
55+
private exitHandler?;
5656
private readonly sessionId;
5757
private session?;
5858
constructor(_: DevframeNodeContext, _?: CodeServerOptions);

‎tests/__snapshots__/tsnapi/@devframes/plugin-code-server/node.snapshot.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export class CodeServerSupervisor {
2828
adopted
2929
readyUrl
3030
logBuffer
31-
cleanupRegistered
31+
exitHandler
3232
sessionId
3333
session
3434
constructor(_, _) {}

‎tests/__snapshots__/tsnapi/@devframes/plugin-code-server/types.snapshot.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ export interface CodeServerTunnelOptions {
6767
// #endregion
6868

6969
// #region Types
70-
export type CodeServerBackend = 'code-server' | 'code-serve-web';
70+
export type CodeServerBackend = 'code-server' | 'ms-code-serve-web';
7171
export type CodeServerMode = 'local' | 'tunnel';
7272
export type CodeServerStartResult = CodeServerStatusResult;
7373
export type CodeServerStatus = 'stopped' | 'starting' | 'running' | 'error';

0 commit comments

Comments
 (0)