Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

Improve log handling

Tomas Valenta7c357151f68b
diff --git a/packages/js-sdk/src/api/index.ts b/packages/js-sdk/src/api/index.ts
index 4fef17aa1..769c22088 100644
--- a/packages/js-sdk/src/api/index.ts
+++ b/packages/js-sdk/src/api/index.ts
@@ -3,6 +3,7 @@ import createClient from 'openapi-fetch'
import type { components, paths } from './schema.gen'
import { defaultHeaders } from './metadata'
import { ConnectionConfig, SandboxError } from '../connectionConfig'
+import { createApiLogger } from '../logs'
export class AuthenticationError extends SandboxError {
constructor(message: any) {
@@ -45,6 +46,10 @@ class ApiClient {
...config.accessToken && { Authorization: `Bearer ${config.accessToken}` },
},
})
+
+ if (config.logger) {
+ this.client.use(createApiLogger(config.logger))
+ }
}
get api() {
diff --git a/packages/js-sdk/src/connectionConfig.ts b/packages/js-sdk/src/connectionConfig.ts
index bee5065dd..4be35b513 100644
--- a/packages/js-sdk/src/connectionConfig.ts
+++ b/packages/js-sdk/src/connectionConfig.ts
@@ -1,3 +1,5 @@
+import { Logger } from './logs'
+
export const DOMAIN = process?.env?.E2B_DOMAIN || 'e2b.dev'
const DEBUG = (process?.env?.E2B_DEBUG || 'false').toLowerCase() === 'true'
const API_KEY = process?.env?.E2B_API_KEY
@@ -11,8 +13,30 @@ export interface ConnectionOpts {
domain?: string
debug?: boolean
requestTimeoutMs?: number
+ logger?: Logger
}
+// function handleError(err: Error) {
+// if (err instanceof ConnectError) {
+// switch (err.code) {
+// case Code.InvalidArgument:
+// return new InvalidUserError(err.message)
+// case Code.NotFound:
+// return new InvalidPathError(err.message)
+// case Code.DeadlineExceeded:
+// return new TimeoutError(err.message)
+// case Code.Canceled:
+// return new TimeoutError(err.message)
+// default:
+// return new FilesystemError(err.message)
+// }
+// }
+// throw err
+
+
+// }
+
+
export class SandboxError extends Error {
constructor(message: any) {
super(message)
@@ -20,6 +44,8 @@ export class SandboxError extends Error {
}
}
+// [canceled] is caused by exceeding request timeout
+// [deadline_exceeded] is caused by exceeding the timeout (for process handlers, watch, etc)
export class TimeoutError extends SandboxError {
constructor(message: string) {
super(message)
@@ -38,6 +64,7 @@ export class ConnectionConfig {
readonly debug: boolean
readonly domain: string
readonly apiUrl: string
+ readonly logger?: Logger
readonly requestTimeoutMs: number
@@ -50,6 +77,7 @@ export class ConnectionConfig {
this.domain = opts?.domain || DOMAIN
this.accessToken = opts?.accessToken || ACCESS_TOKEN
this.requestTimeoutMs = opts?.requestTimeoutMs ?? REQUEST_TIMEOUT_MS
+ this.logger = opts?.logger
this.apiUrl = this.debug ? 'http://localhost:3000' : `https://api.${this.domain}`
}
diff --git a/packages/js-sdk/src/envd/api.ts b/packages/js-sdk/src/envd/api.ts
index e2b6c394d..2735c95eb 100644
--- a/packages/js-sdk/src/envd/api.ts
+++ b/packages/js-sdk/src/envd/api.ts
@@ -2,14 +2,19 @@ import createClient from 'openapi-fetch'
import type { components, paths } from './schema.gen'
import { ConnectionConfig } from '../connectionConfig'
+import { createApiLogger } from '../logs'
class EnvdApiClient {
private readonly client: ReturnType<typeof createClient<paths>>
- constructor(config: Pick<ConnectionConfig, 'apiUrl'>) {
+ constructor(config: Pick<ConnectionConfig, 'apiUrl' | 'logger'>) {
this.client = createClient<paths>({
baseUrl: config.apiUrl,
})
+
+ if (config.logger) {
+ this.client.use(createApiLogger(config.logger))
+ }
}
get api() {
diff --git a/packages/js-sdk/src/index.ts b/packages/js-sdk/src/index.ts
index 1ba5167da..e812017e2 100644
--- a/packages/js-sdk/src/index.ts
+++ b/packages/js-sdk/src/index.ts
@@ -5,6 +5,7 @@ export {
export type { components, paths } from './api'
export { ConnectionConfig, SandboxError, DOMAIN, InvalidUserError } from './connectionConfig'
+export type { Logger } from './logs'
export type { ConnectionOpts, Username } from './connectionConfig'
export type { FilesystemEvent, WatchHandle, FilesystemEventType, } from './sandbox/filesystem/watchHandle'
@@ -36,5 +37,5 @@ export type {
} from './sandbox/process'
import { Sandbox } from './sandbox'
-export { Sandbox, }
+export { Sandbox }
export default Sandbox
diff --git a/packages/js-sdk/src/logs.ts b/packages/js-sdk/src/logs.ts
new file mode 100644
index 000000000..3b539e5b7
--- /dev/null
+++ b/packages/js-sdk/src/logs.ts
@@ -0,0 +1,52 @@
+import type { Interceptor } from '@connectrpc/connect'
+import type { Middleware } from 'openapi-fetch'
+
+export interface Logger {
+ debug?: (...args: any[]) => void
+ info?: (...args: any[]) => void
+ error?: (...args: any[]) => void
+}
+
+export function createRpcLogger(logger: Logger): Interceptor {
+ async function* logEach(stream: AsyncIterable<any>) {
+ for await (const m of stream) {
+ logger.debug?.('Response stream:', m)
+ yield m
+ }
+ }
+
+ return (next) => async (req) => {
+ logger.info?.(`Request: POST ${req.url}`)
+
+ const res = await next(req)
+ if (res.stream) {
+ return {
+ ...res,
+ message: logEach(res.message),
+ }
+ } else {
+ logger.info?.('Response:', res.message)
+ }
+
+ return res
+ }
+}
+
+export function createApiLogger(logger: Logger): Middleware {
+ return {
+ async onRequest(req) {
+ logger.info?.(`Request ${req.method} ${req.url}`)
+
+ return req
+ },
+ async onResponse(res) {
+ if (res.status >= 400) {
+ logger.error?.('Response:', res.status, res.statusText)
+ } else {
+ logger.info?.('Response:', res.status, res.statusText)
+ }
+
+ return res
+ },
+ }
+}
diff --git a/packages/js-sdk/src/sandbox/filesystem/index.ts b/packages/js-sdk/src/sandbox/filesystem/index.ts
index f44a929e2..7e1331c51 100644
--- a/packages/js-sdk/src/sandbox/filesystem/index.ts
+++ b/packages/js-sdk/src/sandbox/filesystem/index.ts
@@ -19,6 +19,7 @@ import {
import { EnvdApiClient } from '../../envd/api'
import { Filesystem as FilesystemService } from '../../envd/filesystem/filesystem_connect'
import { FileType as FsFileType, WatchDirResponse } from '../../envd/filesystem/filesystem_pb'
+import { Logger } from '../../logs'
import { WatchHandle, FilesystemEvent } from './watchHandle'
@@ -77,8 +78,9 @@ export class Filesystem {
transport: Transport,
envdApiUrl: string,
private readonly connectionConfig: ConnectionConfig,
+ logger?: Logger,
) {
- this.envdApi = new EnvdApiClient({ apiUrl: envdApiUrl })
+ this.envdApi = new EnvdApiClient({ apiUrl: envdApiUrl, logger })
this.rpc = createPromiseClient(FilesystemService, transport)
}
diff --git a/packages/js-sdk/src/sandbox/filesystem/watchHandle.ts b/packages/js-sdk/src/sandbox/filesystem/watchHandle.ts
index f232551a7..26b7d40a4 100644
--- a/packages/js-sdk/src/sandbox/filesystem/watchHandle.ts
+++ b/packages/js-sdk/src/sandbox/filesystem/watchHandle.ts
@@ -64,8 +64,13 @@ export class WatchHandle {
if (err instanceof ConnectError) {
switch (err.code) {
case Code.Canceled:
+ throw new TimeoutError(
+ `Error watching filesystem: ${err.message}. This is likely due to exceeding 'requestTimeoutMs' — that can be passed as options when watching filesystem. It can `,
+ )
case Code.DeadlineExceeded:
- throw new TimeoutError(err.message)
+ throw new TimeoutError(
+ `Error watching filesystem: ${err.message}. This is likely due to exceeding 'timeoutMs' — the total time the watching can be active. It can be modified by passing 'timeoutMs' to the watch function. Use '0' to disable the timeout.`,
+ )
default:
throw new FilesystemError(err.message)
}
diff --git a/packages/js-sdk/src/sandbox/index.ts b/packages/js-sdk/src/sandbox/index.ts
index fd2078d2e..af0f34b4c 100644
--- a/packages/js-sdk/src/sandbox/index.ts
+++ b/packages/js-sdk/src/sandbox/index.ts
@@ -1,6 +1,7 @@
import { createConnectTransport } from '@connectrpc/connect-web'
import { ConnectionOpts, ConnectionConfig, defaultUsername } from '../connectionConfig'
+import { createRpcLogger } from '../logs'
import { Filesystem } from './filesystem'
import { Process } from './process'
import { Pty } from './pty'
@@ -41,9 +42,13 @@ export class Sandbox extends SandboxApi {
this.connectionConfig = new ConnectionConfig(opts)
this.envdApiUrl = `${this.connectionConfig.debug ? 'http' : 'https'}://${this.getHost(this.envdPort)}`
- const rpcTransport = createConnectTransport({ baseUrl: this.envdApiUrl, useBinaryFormat: true })
+ const rpcTransport = createConnectTransport({
+ baseUrl: this.envdApiUrl,
+ useBinaryFormat: true,
+ interceptors: opts?.logger ? [createRpcLogger(opts.logger)] : undefined,
+ })
- this.files = new Filesystem(rpcTransport, this.envdApiUrl, this.connectionConfig)
+ this.files = new Filesystem(rpcTransport, this.envdApiUrl, this.connectionConfig, opts?.logger)
this.commands = new Process(rpcTransport, this.connectionConfig)
this.pty = new Pty(rpcTransport, this.connectionConfig)
}
diff --git a/packages/js-sdk/src/sandbox/process/index.ts b/packages/js-sdk/src/sandbox/process/index.ts
index eb86ac153..d46a87abd 100644
--- a/packages/js-sdk/src/sandbox/process/index.ts
+++ b/packages/js-sdk/src/sandbox/process/index.ts
@@ -26,10 +26,10 @@ export interface ProcessStartOpts extends ProcessRequestOpts {
envs?: Record<string, string>
onStdout?: ((data: string) => void | Promise<void>)
onStderr?: ((data: string) => void | Promise<void>)
- timeout?: number
+ timeoutMs?: number
}
-export type ProcessConnectOpts = Pick<ProcessStartOpts, 'onStderr' | 'onStdout' | 'timeout'> & ProcessRequestOpts
+export type ProcessConnectOpts = Pick<ProcessStartOpts, 'onStderr' | 'onStdout' | 'timeoutMs'> & ProcessRequestOpts
export class ProcessError extends SandboxError {
constructor(message: string, public readonly pid: number) {
@@ -113,7 +113,7 @@ export class Process {
}, {
headers,
signal: controller.signal,
- timeoutMs: opts?.timeout ?? 60_000,
+ timeoutMs: opts?.timeoutMs ?? 60_000,
})
clearTimeout(reqTimeout)
@@ -171,7 +171,7 @@ export class Process {
}, {
headers,
signal: controller.signal,
- timeoutMs: opts?.timeout ?? 60_000,
+ timeoutMs: opts?.timeoutMs ?? 60_000,
})
const startEvent: StartResponse = (await events[Symbol.asyncIterator]().next()).value
diff --git a/packages/python-sdk/e2b/__init__.py b/packages/python-sdk/e2b/__init__.py
index 83e266d8f..5457a5a84 100644
--- a/packages/python-sdk/e2b/__init__.py
+++ b/packages/python-sdk/e2b/__init__.py
@@ -12,4 +12,4 @@ from .sandbox.process.process_handle import (
Stdout,
)
from .sandbox.filesystem.watch_handle import WatchHandle
-from e2b.envd.filesystem.filesystem_pb2 import FilesystemEvent, FileType, EntryInfo
+from e2b.envd.filesystem.filesystem_pb2 import FileType, EntryInfo
diff --git a/packages/python-sdk/e2b/sandbox/process/process_handle.py b/packages/python-sdk/e2b/sandbox/process/process_handle.py
index d2285b5db..2ae7118e6 100644
--- a/packages/python-sdk/e2b/sandbox/process/process_handle.py
+++ b/packages/python-sdk/e2b/sandbox/process/process_handle.py
@@ -14,7 +14,7 @@ class ProcessResult(BaseModel):
error: Optional[str]
-class ProcessExitException(Exception, ProcessResult):
+class ProcessExitException(Exception):
def __init__(self, result: ProcessResult):
self._result = result
diff --git a/packages/python-sdk/example.py b/packages/python-sdk/example.py
index eb6d82e51..9921f6501 100644
--- a/packages/python-sdk/example.py
+++ b/packages/python-sdk/example.py
@@ -2,9 +2,25 @@ import io
from e2b import Sandbox
-s = Sandbox()
+sbx = Sandbox(debug=True)
-input = io.StringIO("This goes into the read buffer.")
+print(sbx.sandbox_id)
-s.files.write("/tmp/test.txt", input)
+# const res = await sbx.commands.run('while true; do echo -n "Hello World"; sleep 1; done', {
+# // requestTimeoutMs: 1,
+# onStdout: (data) => {
+# // TODO: print also the time elapsed
+# console.log(`${(Date.now() - start) / 1000}s: ${data}`)
+# },
+# })
+
+# input = io.StringIO("This goes into the read buffer.")
+
+# s.files.write("/tmp/test.txt", input)
+
+
+sbx.commands.run(
+ cmd='while true; do echo -n "Hello World"; sleep 1; done',
+ on_stdout=lambda x: print(x),
+)