Open-source, secure environment with real-world tools for enterprise-grade agents.
Python agentaiai-agentai-agentscode-interpretercopilotdevelopmentdevtoolsgptgpt-4javascriptllmnextjsopenaipythonreactsoftwaretypescript
Update JS SDK - make types and parameters correspond to Python SDK; Improve process handling; Update exports
Tomas Valenta372ec8a33efe
diff --git a/packages/js-sdk/README.md b/packages/js-sdk/README.mdindex 74024ae41..5f87eff23 100644--- a/packages/js-sdk/README.md+++ b/packages/js-sdk/README.md@@ -30,7 +30,6 @@ import { Session } from '@e2b/sdk'// 'Nodejs', 'Bash', 'Python3', 'Java', 'Go', 'Rust', 'PHP', 'Perl', 'DotNET'const session = await Session.create({id: 'Nodejs',- onClose: () => console.log('Close'),})// Close the session after you are donediff --git a/packages/js-sdk/package.json b/packages/js-sdk/package.jsonindex 4c70715d0..7d223385c 100644--- a/packages/js-sdk/package.json+++ b/packages/js-sdk/package.json@@ -1,6 +1,6 @@{"name": "@e2b/sdk",- "version": "0.0.2",+ "version": "0.1.0","description": "E2B SDK that give agents cloud environments","homepage": "https://e2b.dev","license": "MIT",diff --git a/packages/js-sdk/src/helpers/createSessionProcess.ts b/packages/js-sdk/src/helpers/createSessionProcess.tsdeleted file mode 100644index 81bf5a3da..000000000--- a/packages/js-sdk/src/helpers/createSessionProcess.ts+++ /dev/null@@ -1,45 +0,0 @@-import { OutStderrResponse, OutStdoutResponse } from '../session/out'-import { ProcessManager } from '../session/process'-import { createDeferredPromise } from '../utils/promise'--export async function createSessionProcess({- cmd,- manager,- onStderr,- onStdout,- processID,- rootdir,-}: {- cmd: string- manager?: ProcessManager- onStdout?: (o: OutStdoutResponse) => void- onStderr?: (o: OutStderrResponse) => void- processID?: string- rootdir?: string-}) {- if (!manager) {- throw new Error('Cannot create process - process manager is not defined')- }-- const { resolve, promise: exited } = createDeferredPromise()-- const onExit = () => {- resolve()- }-- const process = await manager.start({- cmd,- onStdout,- onStderr,- onExit,- rootdir,- processID,- })-- return {- exited,- processID: process.processID,- kill: process.kill,- sendStdin: process.sendStdin,- }-}diff --git a/packages/js-sdk/src/helpers/index.ts b/packages/js-sdk/src/helpers/index.tsdeleted file mode 100644index 4aff2ca3d..000000000--- a/packages/js-sdk/src/helpers/index.ts+++ /dev/null@@ -1 +0,0 @@-export * from './createSessionProcess'diff --git a/packages/js-sdk/src/index.ts b/packages/js-sdk/src/index.tsindex 9b5afe44e..fac5c6808 100644--- a/packages/js-sdk/src/index.ts+++ b/packages/js-sdk/src/index.ts@@ -1,17 +1,7 @@-export { default as Session } from './session'+export { Session } from './session'+export type { Environment } from './session'export type { SessionOpts } from './session'-export { CodeSnippetExecState } from './session/codeSnippet'-export type {- CodeSnippetManager,- CodeSnippetStateHandler,- CodeSnippetStderrHandler,- CodeSnippetStdoutHandler,- CodeSnippetSubscriptionHandler,- CodeSnippetSubscriptionHandlerType,- OpenedPort,-} from './session/codeSnippet'-export type { OutResponse, OutStderrResponse, OutStdoutResponse } from './session/out'-export { OutType } from './session/out'+export type { OpenPort } from './session/codeSnippet'export type { TerminalManager, Terminal as TerminalSession } from './session/terminal'export type { FilesystemManager, FileInfo } from './session/filesystem'export {@@ -23,9 +13,6 @@ export type {FilesystemEventListener,} from './session/filesystemWatcher'-export type { Process, ProcessManager } from './session/process'+export { Process, ProcessMessage, ProcessOutput } from './session/process'+export type { ProcessManager } from './session/process'export type { EnvVars } from './session/envVars'-export { default as api } from './api'-export type { components, paths, ClientType } from './api'--export { createSessionProcess } from './helpers'diff --git a/packages/js-sdk/src/session/codeSnippet.ts b/packages/js-sdk/src/session/codeSnippet.tsindex c370cb72b..07eb7a8be 100644--- a/packages/js-sdk/src/session/codeSnippet.ts+++ b/packages/js-sdk/src/session/codeSnippet.ts@@ -1,38 +1,9 @@-import { EnvVars } from './envVars'-import { OutStderrResponse, OutStdoutResponse } from './out'-export const codeSnippetService = 'codeSnippet'-export enum CodeSnippetExecState {- Running = 'Running',- Stopped = 'Stopped',-}--export interface OpenedPort {- State: string- Ip: string- Port: number-}--export type CodeSnippetStateHandler = (state: CodeSnippetExecState) => void-export type CodeSnippetStderrHandler = (o: OutStderrResponse) => void-export type CodeSnippetStdoutHandler = (o: OutStdoutResponse) => void-export type ScanOpenedPortsHandler = (ports: OpenedPort[]) => void--export type CodeSnippetSubscriptionHandler =- | CodeSnippetStateHandler- | CodeSnippetStderrHandler- | CodeSnippetStdoutHandler- | ScanOpenedPortsHandler--export type CodeSnippetSubscriptionHandlerType = {- state: CodeSnippetStateHandler- stderr: CodeSnippetStderrHandler- stdout: CodeSnippetStdoutHandler- scanOpenedPorts: ScanOpenedPortsHandler+export interface OpenPort {+ state: string+ ip: string+ port: number}-export interface CodeSnippetManager {- readonly run: (code: string, envVars?: EnvVars) => Promise<CodeSnippetExecState>- readonly stop: () => Promise<CodeSnippetExecState>-}+export type ScanOpenedPortsHandler = (ports: OpenPort[]) => voiddiff --git a/packages/js-sdk/src/session/filesystem.ts b/packages/js-sdk/src/session/filesystem.tsindex 5b773415c..3d4f2c28c 100644--- a/packages/js-sdk/src/session/filesystem.ts+++ b/packages/js-sdk/src/session/filesystem.ts@@ -9,9 +9,9 @@ export interface FileInfo {export interface FilesystemManager {readonly write: (path: string, content: string) => Promise<void>- readonly writeBytes: (path: string, content: Uint8Array) => Promise<void>+ // readonly writeBytes: (path: string, content: Uint8Array) => Promise<void>readonly read: (path: string) => Promise<string>- readonly readBytes: (path: string) => Promise<Uint8Array>+ // readonly readBytes: (path: string) => Promise<Uint8Array>readonly remove: (path: string) => Promise<void>readonly list: (path: string) => Promise<FileInfo[]>readonly makeDir: (path: string) => Promise<void>diff --git a/packages/js-sdk/src/session/filesystemWatcher.ts b/packages/js-sdk/src/session/filesystemWatcher.tsindex abc13138f..06049b6e1 100644--- a/packages/js-sdk/src/session/filesystemWatcher.ts+++ b/packages/js-sdk/src/session/filesystemWatcher.ts@@ -1,5 +1,5 @@import { filesystemService } from './filesystem'-import SessionConnection from './sessionConnection'+import { SessionConnection } from './sessionConnection'export enum FilesystemOperation {Create = 'Create',diff --git a/packages/js-sdk/src/session/index.ts b/packages/js-sdk/src/session/index.tsindex a597a1116..71c4bd19a 100644--- a/packages/js-sdk/src/session/index.ts+++ b/packages/js-sdk/src/session/index.ts@@ -1,5 +1,6 @@import normalizePath from 'normalize-path'+import { components } from '../api'import { id } from '../utils/id'import { createDeferredPromise, formatSettledErrors } from '../utils/promise'import {@@ -8,22 +9,30 @@ import {} from './codeSnippet'import { FileInfo, FilesystemManager, filesystemService } from './filesystem'import FilesystemWatcher from './filesystemWatcher'-import { ProcessManager, processService } from './process'-import SessionConnection, { SessionConnectionOpts } from './sessionConnection'+import {+ Process,+ ProcessManager,+ ProcessMessage,+ ProcessOutput,+ processService,+} from './process'+import { SessionConnection, SessionConnectionOpts } from './sessionConnection'import { TerminalManager, terminalService } from './terminal'+export type Environment = components['schemas']['Template']+export interface SessionOpts extends SessionConnectionOpts {onScanPorts?: ScanOpenPortsHandler}-class Session extends SessionConnection {+export class Session extends SessionConnection {readonly terminal: TerminalManagerreadonly filesystem: FilesystemManagerreadonly process: ProcessManagerprivate onScanPorts?: ScanOpenPortsHandler- private constructor(opts: SessionOpts) {+ constructor(opts: SessionOpts) {super(opts)this.onScanPorts = opts.onScanPorts@@ -60,32 +69,32 @@ class Session extends SessionConnection {write: async (path, content) => {await this.call(filesystemService, 'write', [path, content])},- /**- * Write array of bytes to a file.- * This can be used when you cannot represent the data as an UTF-8 string.- *- * @param path path to a file- * @param content byte array representing the content to write- */- writeBytes: async (path, content) => {- // We need to convert the byte array to base64 string without using browser or node specific APIs.- // This should be achieved by the node polyfills.- const base64Content = Buffer.from(content).toString('base64')- await this.call(filesystemService, 'writeBase64', [path, base64Content])- },- /**- * Reads the whole content of a file as an array of bytes.- * @param path path to a file- * @returns byte array representing the content of a file- */- readBytes: async path => {- const base64Content = (await this.call(filesystemService, 'readBase64', [- path,- ])) as string- // We need to convert the byte array to base64 string without using browser or node specific APIs.- // This should be achieved by the node polyfills.- return Buffer.from(base64Content, 'base64')- },+ // /**+ // * Write array of bytes to a file.+ // * This can be used when you cannot represent the data as an UTF-8 string.+ // *+ // * @param path path to a file+ // * @param content byte array representing the content to write+ // */+ // writeBytes: async (path, content) => {+ // // We need to convert the byte array to base64 string without using browser or node specific APIs.+ // // This should be achieved by the node polyfills.+ // const base64Content = Buffer.from(content).toString('base64')+ // await this.call(filesystemService, 'writeBase64', [path, base64Content])+ // },+ // /**+ // * Reads the whole content of a file as an array of bytes.+ // * @param path path to a file+ // * @returns byte array representing the content of a file+ // */+ // readBytes: async path => {+ // const base64Content = (await this.call(filesystemService, 'readBase64', [+ // path,+ // ])) as string+ // // We need to convert the byte array to base64 string without using browser or node specific APIs.+ // // This should be achieved by the node polyfills.+ // return Buffer.from(base64Content, 'base64')+ // },/*** Creates a new directory and all directories along the way if needed on the specified pth.* @param path path to a new directory. For example '/dirA/dirB' when creating 'dirB'.@@ -188,19 +197,29 @@ class Session extends SessionConnection {}) => {const { promise: processExited, resolve: triggerExit } = createDeferredPromise()+ const output = new ProcessOutput()++ function handleStdout(data: { line: string; timestamp: number }) {+ const message = new ProcessMessage(data.line, data.timestamp, false)+ output.addStdout(message)+ onStdout?.(message)+ }++ function handleStderr(data: { line: string; timestamp: number }) {+ const message = new ProcessMessage(data.line, data.timestamp, true)+ output.addStderr(message)+ onStderr?.(message)+ }+const [onExitSubID, onStdoutSubID, onStderrSubID] =await this.handleSubscriptions(this.subscribe(processService, triggerExit, 'onExit', processID),- onStdout- ? this.subscribe(processService, onStdout, 'onStdout', processID)- : undefined,- onStderr- ? this.subscribe(processService, onStderr, 'onStderr', processID)- : undefined,+ this.subscribe(processService, handleStdout, 'onStdout', processID),+ this.subscribe(processService, handleStderr, 'onStderr', processID),)const { promise: unsubscribing, resolve: handleFinishUnsubscribing } =- createDeferredPromise()+ createDeferredPromise<ProcessOutput>()processExited.then(async () => {const results = await Promise.allSettled([@@ -214,8 +233,8 @@ class Session extends SessionConnection {this.logger.error(errMsg)}+ handleFinishUnsubscribing(output)onExit?.()- handleFinishUnsubscribing()})try {@@ -226,21 +245,7 @@ class Session extends SessionConnection {throw err}- return {- finished: unsubscribing,- kill: async () => {- try {- await this.call(processService, 'kill', [processID])- } finally {- triggerExit()- await unsubscribing- }- },- processID,- sendStdin: async data => {- await this.call(processService, 'stdin', [processID, data])- },- }+ return new Process(processID, this, triggerExit, unsubscribing, output)},}}@@ -249,17 +254,20 @@ class Session extends SessionConnection {return await new Session(opts).open()}- protected override async open() {+ override async open() {await super.open()+ const portsHander = this.onScanPorts+ ? (ports: { State: string; Ip: string; Port: number }[]) =>+ this.onScanPorts?.(ports.map(p => ({ ip: p.Ip, port: p.Port, state: p.State })))+ : undefined+await this.handleSubscriptions(- this.onScanPorts- ? this.subscribe(codeSnippetService, this.onScanPorts, 'scanOpenedPorts')+ portsHander+ ? this.subscribe(codeSnippetService, portsHander, 'scanOpenedPorts'): undefined,)return this}}--export default Sessiondiff --git a/packages/js-sdk/src/session/process.ts b/packages/js-sdk/src/session/process.tsindex 7f8f7273d..a47c4952b 100644--- a/packages/js-sdk/src/session/process.ts+++ b/packages/js-sdk/src/session/process.ts@@ -1,20 +1,117 @@import { EnvVars } from './envVars'-import { OutStderrResponse, OutStdoutResponse } from './out'+import { SessionConnection } from './sessionConnection'export const processService = 'process'-export interface Process {- readonly sendStdin: (data: string) => Promise<void>- readonly kill: () => Promise<void>- readonly processID: string- readonly finished: Promise<void>+/**+ * A message from a process.+ */+export class ProcessMessage {+ constructor(+ public readonly line: string,+ /**+ * Unix epoch in nanoseconds+ */+ public readonly timestamp: number,+ public readonly error: boolean,+ ) {+ // eslint-disable-next-line prettier/prettier+ }+}++/**+ * Output from a process.+ */+export class ProcessOutput {+ private readonly delimiter = '\n'+ private readonly messages: ProcessMessage[] = []+ private _error = false++ /**+ * Whether the process has errored.+ */+ get error(): boolean {+ return this._error+ }++ /**+ * The stdout from the process.+ */+ get stdout(): string {+ return this.messages+ .filter(out => !out.error)+ .map(out => out.line)+ .join(this.delimiter)+ }++ /**+ * The stderr from the process.+ */+ get stderr(): string {+ return this.messages+ .filter(out => out.error)+ .map(out => out.line)+ .join(this.delimiter)+ }++ addStdout(message: ProcessMessage) {+ this.insertByTimestamp(message)+ }++ addStderr(message: ProcessMessage) {+ this._error = true+ this.insertByTimestamp(message)+ }++ private insertByTimestamp(message: ProcessMessage) {+ let i = this.messages.length - 1+ while (i >= 0 && this.messages[i].timestamp > message.timestamp) {+ i -= 1+ }+ this.messages.splice(i + 1, 0, message)+ }+}++/**+ * A process running in the environment.+ *+ */+export class Process {+ constructor(+ readonly processID: string,+ private readonly session: SessionConnection,+ private readonly triggerExit: () => void,+ readonly finished: Promise<ProcessOutput>,+ readonly output: ProcessOutput,+ ) {}++ /**+ * Kills the process.+ */+ async kill(): Promise<void> {+ try {+ await this.session.call(processService, 'kill', [this.processID])+ } finally {+ this.triggerExit()+ await this.finished+ }+ }++ /**+ * Sends data to the process stdin.+ *+ * @param data Data to send+ */+ async sendStdin(data: string): Promise<void> {+ await this.session.call(processService, 'stdin', [this.processID, data])+ }}export interface ProcessManager {readonly start: (opts: {cmd: string- onStdout?: (o: OutStdoutResponse) => void- onStderr?: (o: OutStderrResponse) => void+ onStdout?: (out: ProcessMessage) => void+ onStderr?: (out: ProcessMessage) => voidonExit?: () => voidenvVars?: EnvVarsrootdir?: stringdiff --git a/packages/js-sdk/src/session/sessionConnection.ts b/packages/js-sdk/src/session/sessionConnection.tsindex 372bb6abf..5e8e24974 100644--- a/packages/js-sdk/src/session/sessionConnection.ts+++ b/packages/js-sdk/src/session/sessionConnection.ts@@ -31,16 +31,9 @@ interface Subscriber {handler: SubscriptionHandler}-export type CloseHandler = () => void-export type DisconnectHandler = () => void-export type ReconnectHandler = () => void-export interface SessionConnectionOpts {id: stringapiKey?: string- onClose?: CloseHandler- onDisconnect?: DisconnectHandler- onReconnect?: ReconnectHandlerdebug?: booleaneditEnabled?: boolean__debug_hostname?: string@@ -54,7 +47,7 @@ const refreshSession = api.method('post').create({ api_key: true })-class SessionConnection {+export class SessionConnection {protected readonly logger: Loggerprotected session?: components['schemas']['Session']protected isOpen = false@@ -123,7 +116,6 @@ class SessionConnection {this.rpc.ws?.terminate?.()// This is the browser WebSocket way of closing connectionthis.rpc.ws?.close?.()- this.opts?.onClose?.()this.logger.log('Disconected from the session')}}@@ -285,7 +277,6 @@ class SessionConnection {this.rpc.onClose(async e => {this.logger.log('Closing WS connection to session:', this.session, e)if (this.isOpen) {- this.opts.onDisconnect?.()await wait(WS_RECONNECT_INTERVAL)this.logger.log('Reconnecting to session:', this.session)try {@@ -293,7 +284,6 @@ class SessionConnection {// We want to delete the subscriber handlers here so there are no orphans.this.subscribers = []await this.rpc.connect(sessionURL)- this.opts.onReconnect?.()this.logger.log('Reconnected to session:', this.session)// eslint-disable-next-line @typescript-eslint/no-explicit-any} catch (e: any) {@@ -365,5 +355,3 @@ class SessionConnection {}}}--export default SessionConnectiondiff --git a/packages/js-sdk/test/run.mjs b/packages/js-sdk/test/run.mjsindex 34c9b7ee2..fa97c2329 100644--- a/packages/js-sdk/test/run.mjs+++ b/packages/js-sdk/test/run.mjs@@ -1,38 +1,26 @@import { Session } from '../dist/cjs/index.js'async function main() {- const session = new Session({- id: '5udkAFHBVrGz',- debug: true,- retry: true,- // codeSnippet: {- // onStateChange(state) {- // console.log(state)- // },- // onStdout(out) {- // console.log(out)- // },- // onStderr(err) {- // console.log(err)- // },- // },- onDisconnect() {- console.log('disconnect')- },- onReconnect() {- console.log('reconnect')- },- onClose() {- console.log('close')- },- // __debug_port: 49982,- // __debug_hostname: '127.0.0.1',- // __debug_devEnv: 'local',+ const session = await Session.create({+ id: 'Nodejs',})try {- await session.open()+ await session.filesystem.write('/code/file', 'test')+ const content = await session.filesystem.read('/code/file')+ console.log('content', content)++ const process = await session.process.start({+ cmd: 'while true; do echo "Hello, World!"; sleep 1; done',+ onExit: () => console.log('exit'),+ onStdout: data => console.log(data.line),+ })++ const output = await process.finished++ console.log('stdout', output.stdout)+ await session.close()// const cmd = 'npm i'// await session.process.start({