Add timeouts to JS SDK (#104)

Co-authored-by: Pavel 'Strajk' Dolecek <strajk@me.com>

.changeset/khaki-wolves-retire.md

@@ -0,0 +1,5 @@
+---
+"@e2b/sdk": patch
+---
+
+Add the possibility to timeout calls

packages/js-sdk/src/constants.ts

@@ -1,6 +1,8 @@
 export const SESSION_REFRESH_PERIOD = 5_000 // 5s
 export const WS_RECONNECT_INTERVAL = 600 // 600ms
 
+export const TIMEOUT = 60_000 // 60s
+
 export const SESSION_DOMAIN = 'ondevbook.com'
 export const WS_PORT = 49982
 export const WS_ROUTE = '/ws'

packages/js-sdk/src/session/error.ts → packages/js-sdk/src/error.ts

@@ -1,3 +1,10 @@
+export class TimeoutError extends Error {
+  constructor(message: any) {
+    super(message)
+    this.name = 'TimeoutError'
+  }
+}
+
 export class AuthenticationError extends Error {
   constructor(message: any) {
     super(message)

packages/js-sdk/src/session/filesystem.ts

@@ -1,4 +1,5 @@
 import FilesystemWatcher from './filesystemWatcher'
+import { CallOpts } from './sessionConnection'
 
 export const filesystemService = 'filesystem'
 
@@ -8,12 +9,12 @@ export interface FileInfo {
 }
 
 export interface FilesystemManager {
-  readonly write: (path: string, content: string) => Promise<void>
+  readonly write: (path: string, content: string, opts?: CallOpts) => Promise<void>
   // readonly writeBytes: (path: string, content: Uint8Array) => Promise<void>
-  readonly read: (path: string) => Promise<string>
+  readonly read: (path: string, opts?: CallOpts) => Promise<string>
   // readonly readBytes: (path: string) => Promise<Uint8Array>
-  readonly remove: (path: string) => Promise<void>
-  readonly list: (path: string) => Promise<FileInfo[]>
-  readonly makeDir: (path: string) => Promise<void>
+  readonly remove: (path: string, opts?: CallOpts) => Promise<void>
+  readonly list: (path: string, opts?: CallOpts) => Promise<FileInfo[]>
+  readonly makeDir: (path: string, opts?: CallOpts) => Promise<void>
   readonly watchDir: (path: string) => FilesystemWatcher
 }

packages/js-sdk/src/session/filesystemWatcher.ts

@@ -1,5 +1,6 @@
+import { withTimeout } from '../utils/promise'
 import { filesystemService } from './filesystem'
-import { SessionConnection } from './sessionConnection'
+import { CallOpts, SessionConnection } from './sessionConnection'
 
 export enum FilesystemOperation {
   Create = 'Create',
@@ -32,18 +33,21 @@ class FilesystemWatcher {
   }
 
   // Starts watching the path that was passed to the contructor
-  async start() {
-    // Already started.
-    if (this.rpcSubscriptionID) return
+  async start(opts: CallOpts) {
+    const start = async () => {
+      // Already started.
+      if (this.rpcSubscriptionID) return
 
-    this.handleFilesystemEvents = this.handleFilesystemEvents.bind(this)
+      this.handleFilesystemEvents = this.handleFilesystemEvents.bind(this)
 
-    this.rpcSubscriptionID = await this.sessConn.subscribe(
-      filesystemService,
-      this.handleFilesystemEvents,
-      'watchDir',
-      this.path,
-    )
+      this.rpcSubscriptionID = await this.sessConn.subscribe(
+        filesystemService,
+        this.handleFilesystemEvents,
+        'watchDir',
+        this.path,
+      )
+    }
+    return await withTimeout(start, opts?.timeout)()
   }
 
   // Stops watching the path and removes all listeners.