Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Cleanup code and docstrings #3

Merged
merged 4 commits into from
Apr 3, 2024
Merged

Cleanup code and docstrings #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5de2a23
Override methods
ValentaTomas Apr 2, 2024
d3ebaad
Simplify kernel reconnect
ValentaTomas Apr 2, 2024
b25264f
Cleanup ws handling types and docs
ValentaTomas Apr 2, 2024
2f6b31e
Use object keys to prevent accidental iteration over prototype proper…
ValentaTomas Apr 2, 2024
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
176 changes: 23 additions & 153 deletions js/src/code-interpreter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,163 +16,40 @@ export interface CreateKernelProps {
*/
export class CodeInterpreter extends Sandbox {
private static template = 'code-interpreter-stateful'
public notebook: JupyterExtension

readonly notebook = new JupyterExtension(this)

constructor(opts?: SandboxOpts) {
super({ template: opts?.template || CodeInterpreter.template, ...opts })
this.notebook = new JupyterExtension(this)
}

/**
* Creates a new CodeInterpreter sandbox.
* @returns New CodeInterpreter sandbox
*
* @example
* ```ts
* const sandbox = await CodeInterpreter.create()
* ```
* @constructs CodeInterpreter
*/
static async create<S extends typeof CodeInterpreter>(
this: S
): Promise<InstanceType<S>>
/**
* Creates a new CodeInterpreter sandbox from the template with the specified ID.
* @param template Sandbox template ID or name (this extension has some specific requirements for the template, refer to docs for more info)
* @returns New CodeInterpreter sandbox
*
* @example
* ```ts
* const sandbox = await CodeInterpreter.create("sandboxTemplateID")
* ```
*/
static async create<S extends typeof CodeInterpreter>(
this: S,
template: string
): Promise<InstanceType<S>>
/**
* Creates a new CodeInterpreter from the specified options.
* @param opts Sandbox options
* @returns New CodeInterpreter
*
* @example
* ```ts
* const sandbox = await CodeInterpreter.create({
* onStdout: console.log,
* })
* ```
*/
static async create<S extends typeof CodeInterpreter>(
this: S,
opts: SandboxOpts
): Promise<InstanceType<S>>
static async create(optsOrTemplate?: string | SandboxOpts) {
const opts: SandboxOpts | undefined =
typeof optsOrTemplate === 'string'
? { template: optsOrTemplate }
: optsOrTemplate
const sandbox = new this(opts)
await sandbox._open({ timeout: opts?.timeout })

// Connect to the default kernel, do this in the background
sandbox.notebook.connect()

return sandbox
}

/**
* Reconnects to an existing CodeInterpreter.
* @param sandboxID Sandbox ID
* @returns Existing CodeInterpreter
*
* @example
* ```ts
* const sandbox = await CodeInterpreter.create()
* const sandboxID = sandbox.id
*
* await sandbox.keepAlive(300 * 1000)
* await sandbox.close()
*
* const reconnectedSandbox = await CodeInterpreter.reconnect(sandboxID)
* ```
*/
static async reconnect<S extends typeof CodeInterpreter>(
this: S,
sandboxID: string
): Promise<InstanceType<S>>
/**
* Reconnects to an existing CodeInterpreter.
* @param opts Sandbox options
* @returns Existing CodeInterpreter
*
* @example
* ```ts
* const sandbox = await CodeInterpreter.create()
* const sandboxID = sandbox.id
*
* await sandbox.keepAlive(300 * 1000)
* await sandbox.close()
*
* const reconnectedSandbox = await CodeInterpreter.reconnect({
* sandboxID,
* })
* ```
*/
static async reconnect<S extends typeof CodeInterpreter>(
this: S,
opts: Omit<SandboxOpts, 'id' | 'template'> & { sandboxID: string }
): Promise<InstanceType<S>>
static async reconnect<S extends typeof CodeInterpreter>(
this: S,
sandboxIDorOpts:
| string
| (Omit<SandboxOpts, 'id' | 'template'> & { sandboxID: string })
): Promise<InstanceType<S>> {
let id: string
let opts: SandboxOpts
if (typeof sandboxIDorOpts === 'string') {
id = sandboxIDorOpts
opts = {}
} else {
id = sandboxIDorOpts.sandboxID
opts = sandboxIDorOpts
}

const sandboxIDAndClientID = id.split('-')
const sandboxID = sandboxIDAndClientID[0]
const clientID = sandboxIDAndClientID[1]
opts.__sandbox = { sandboxID, clientID, templateID: 'unknown' }
override async _open(opts?: { timeout?: number }) {
await super._open({ timeout: opts?.timeout })
await this.notebook.connect(opts?.timeout)

const sandbox = new this(opts) as InstanceType<S>
await sandbox._open({ timeout: opts?.timeout })

sandbox.notebook.connect()
return sandbox
return this
}

async close() {
override async close() {
await this.notebook.close()
await super.close()
}
}

export class JupyterExtension {
private readonly defaultKernelID: Promise<string>
private readonly setDefaultKernelID: (kernelID: string) => void
private connectedKernels: Kernels = {}
private sandbox: CodeInterpreter

constructor(sandbox: CodeInterpreter) {
this.sandbox = sandbox
const { promise, resolve } = createDeferredPromise<string>()
this.defaultKernelID = promise
this.setDefaultKernelID = resolve
private readonly connectedKernels: Kernels = {}

private readonly kernelIDPromise = createDeferredPromise<string>()
private readonly setDefaultKernelID = this.kernelIDPromise.resolve

private get defaultKernelID() {
return this.kernelIDPromise.promise
}

constructor(private sandbox: CodeInterpreter) { }

async connect(timeout?: number) {
return this.startConnectingToDefaultKernel(this.setDefaultKernelID, {
timeout: timeout
})
return this.startConnectingToDefaultKernel(this.setDefaultKernelID, { timeout })
}

/**
Expand All @@ -192,24 +69,15 @@ export class JupyterExtension {
onStdout?: (msg: ProcessMessage) => any,
onStderr?: (msg: ProcessMessage) => any
): Promise<Result> {
kernelID = kernelID || (await this.defaultKernelID)
let ws = this.connectedKernels[kernelID]

if (!ws) {
const url = `${this.sandbox.getProtocol(
'ws'
)}://${this.sandbox.getHostname(8888)}/api/kernels/${kernelID}/channels`
ws = new JupyterKernelWebSocket(url)
await ws.connect()
this.connectedKernels[kernelID] = ws
}
kernelID = kernelID || await this.defaultKernelID
const ws = this.connectedKernels[kernelID] || await this.connectToKernelWS(kernelID)

return await ws.sendExecutionMessage(code, onStdout, onStderr)
}

private async startConnectingToDefaultKernel(
resolve: (value: string) => void,
opts?: { timeout?: number }
opts?: { timeout?: number },
) {
const kernelID = (
await this.sandbox.filesystem.read('/root/.jupyter/kernel_id', opts)
Expand All @@ -236,6 +104,8 @@ export class JupyterExtension {
const ws = new JupyterKernelWebSocket(url)
await ws.connect()
this.connectedKernels[kernelID] = ws

return ws
}

/**
Expand Down Expand Up @@ -361,7 +231,7 @@ export class JupyterExtension {
* Close all the websocket connections to the kernels. It doesn't shutdown the kernels.
*/
async close() {
for (const kernelID in this.connectedKernels) {
for (const kernelID of Object.keys(this.connectedKernels)) {
this.connectedKernels[kernelID].close()
}
}
Expand Down
Loading
Loading