Class: Daytona::Sandbox

Inherits:
Object
  • Object
show all
Defined in:
lib/daytona/sandbox.rb

Overview

rubocop:disable Metrics/ClassLength

Constant Summary collapse

DEFAULT_TIMEOUT = 
60

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(code_toolbox:, sandbox_dto:, config:, sandbox_api:, get_proxy_toolbox_url:) ⇒ Sandbox

Returns a new instance of Sandbox.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/daytona/sandbox.rb', line 119

def initialize(code_toolbox:, sandbox_dto:, config:, sandbox_api:, get_proxy_toolbox_url:) # rubocop:disable Metrics/MethodLength
  process_response(sandbox_dto)
  @code_toolbox = code_toolbox
  @config = config
  @sandbox_api = sandbox_api
  @get_proxy_toolbox_url = get_proxy_toolbox_url

  # Create toolbox API clients with dynamic configuration
  toolbox_api_config = build_toolbox_api_config

  # Helper to create API client with authentication header
  create_authenticated_client = lambda do
    client = DaytonaToolboxApiClient::ApiClient.new(toolbox_api_config)
    client.default_headers['Authorization'] = "Bearer #{config.api_key || config.jwt_token}"
    client.default_headers['X-Daytona-Source'] = 'ruby-sdk'
    client.default_headers['X-Daytona-SDK-Version'] = Sdk::VERSION
    client.default_headers['X-Daytona-Organization-ID'] = config.organization_id if config.jwt_token
    client
  end

  process_api = DaytonaToolboxApiClient::ProcessApi.new(create_authenticated_client.call)
  fs_api = DaytonaToolboxApiClient::FileSystemApi.new(create_authenticated_client.call)
  git_api = DaytonaToolboxApiClient::GitApi.new(create_authenticated_client.call)
  lsp_api = DaytonaToolboxApiClient::LspApi.new(create_authenticated_client.call)
  computer_use_api = DaytonaToolboxApiClient::ComputerUseApi.new(create_authenticated_client.call)
  interpreter_api = DaytonaToolboxApiClient::InterpreterApi.new(create_authenticated_client.call)
  info_api = DaytonaToolboxApiClient::InfoApi.new(create_authenticated_client.call)

  @process = Process.new(
    sandbox_id: id,
    code_toolbox:,
    toolbox_api: process_api,
    get_preview_link: proc { |port| preview_url(port) }
  )
  @fs = FileSystem.new(sandbox_id: id, toolbox_api: fs_api)
  @git = Git.new(sandbox_id: id, toolbox_api: git_api)
  @computer_use = ComputerUse.new(sandbox_id: id, toolbox_api: computer_use_api)
  @code_interpreter = CodeInterpreter.new(
    sandbox_id: id,
    toolbox_api: interpreter_api,
    get_preview_link: proc { |port| preview_url(port) }
  )
  @lsp_api = lsp_api
  @info_api = info_api
end

Instance Attribute Details

#auto_archive_interval ⇒ Float

Returns Auto-archive interval in minutes.

Returns:

  • (Float) —

    Auto-archive interval in minutes



70
71
72
 
# File 'lib/daytona/sandbox.rb', line 70

def auto_archive_interval
  @auto_archive_interval
end

#auto_delete_interval ⇒ Float

(negative value means disabled, 0 means delete immediately upon stopping)

Returns:

  • (Float) —

    Auto-delete interval in minutes



74
75
76
 
# File 'lib/daytona/sandbox.rb', line 74

def auto_delete_interval
  @auto_delete_interval
end

#auto_stop_interval ⇒ Float

Returns Auto-stop interval in minutes (0 means disabled).

Returns:

  • (Float) —

    Auto-stop interval in minutes (0 means disabled)



67
68
69
 
# File 'lib/daytona/sandbox.rb', line 67

def auto_stop_interval
  @auto_stop_interval
end

#backup_created_at ⇒ String (readonly)

Returns The creation timestamp of the last backup.

Returns:

  • (String) —

    The creation timestamp of the last backup



64
65
66
 
# File 'lib/daytona/sandbox.rb', line 64

def backup_created_at
  @backup_created_at
end

#backup_state ⇒ String (readonly)

Returns The state of the backup.

Returns:

  • (String) —

    The state of the backup



61
62
63
 
# File 'lib/daytona/sandbox.rb', line 61

def backup_state
  @backup_state
end

#build_info ⇒ DaytonaApiClient::BuildInfo (readonly)

Returns Build information for the sandbox.

Returns:

  • (DaytonaApiClient::BuildInfo) —

    Build information for the sandbox



80
81
82
 
# File 'lib/daytona/sandbox.rb', line 80

def build_info
  @build_info
end

#code_interpreter ⇒ Daytona::CodeInterpreter (readonly)

Returns:



113
114
115
 
# File 'lib/daytona/sandbox.rb', line 113

def code_interpreter
  @code_interpreter
end

#code_toolbox ⇒ Daytona::SandboxPythonCodeToolbox, Daytona::SandboxTsCodeToolbox (readonly)

Returns:



92
93
94
 
# File 'lib/daytona/sandbox.rb', line 92

def code_toolbox
  @code_toolbox
end

#computer_use ⇒ Daytona::ComputerUse (readonly)

Returns:



110
111
112
 
# File 'lib/daytona/sandbox.rb', line 110

def computer_use
  @computer_use
end

#config ⇒ Daytona::Config (readonly)

Returns:



95
96
97
 
# File 'lib/daytona/sandbox.rb', line 95

def config
  @config
end

#cpu ⇒ Float (readonly)

Returns The CPU quota for the sandbox.

Returns:

  • (Float) —

    The CPU quota for the sandbox



40
41
42
 
# File 'lib/daytona/sandbox.rb', line 40

def cpu
  @cpu
end

#created_at ⇒ String (readonly)

Returns The creation timestamp of the sandbox.

Returns:

  • (String) —

    The creation timestamp of the sandbox



83
84
85
 
# File 'lib/daytona/sandbox.rb', line 83

def created_at
  @created_at
end

#daemon_version ⇒ String (readonly)

Returns The version of the daemon running in the sandbox.

Returns:

  • (String) —

    The version of the daemon running in the sandbox



89
90
91
 
# File 'lib/daytona/sandbox.rb', line 89

def daemon_version
  @daemon_version
end

#desired_state ⇒ DaytonaApiClient::SandboxDesiredState (readonly)

Returns The desired state of the sandbox.

Returns:

  • (DaytonaApiClient::SandboxDesiredState) —

    The desired state of the sandbox



55
56
57
 
# File 'lib/daytona/sandbox.rb', line 55

def desired_state
  @desired_state
end

#disk ⇒ Float (readonly)

Returns The disk quota for the sandbox.

Returns:

  • (Float) —

    The disk quota for the sandbox



49
50
51
 
# File 'lib/daytona/sandbox.rb', line 49

def disk
  @disk
end

#env ⇒ Hash<String, String> (readonly)

Returns Environment variables for the sandbox.

Returns:

  • (Hash<String, String>) —

    Environment variables for the sandbox



22
23
24
 
# File 'lib/daytona/sandbox.rb', line 22

def env
  @env
end

#error_reason ⇒ String (readonly)

Returns The error reason of the sandbox.

Returns:

  • (String) —

    The error reason of the sandbox



58
59
60
 
# File 'lib/daytona/sandbox.rb', line 58

def error_reason
  @error_reason
end

#fs ⇒ Daytona::FileSystem (readonly)

Returns:



104
105
106
 
# File 'lib/daytona/sandbox.rb', line 104

def fs
  @fs
end

#git ⇒ Daytona::Git (readonly)

Returns:



107
108
109
 
# File 'lib/daytona/sandbox.rb', line 107

def git
  @git
end

#gpu ⇒ Float (readonly)

Returns The GPU quota for the sandbox.

Returns:

  • (Float) —

    The GPU quota for the sandbox



43
44
45
 
# File 'lib/daytona/sandbox.rb', line 43

def gpu
  @gpu
end

#id ⇒ String (readonly)

Returns The ID of the sandbox.

Returns:

  • (String) —

    The ID of the sandbox



10
11
12
 
# File 'lib/daytona/sandbox.rb', line 10

def id
  @id
end

#labels ⇒ Hash<String, String>

Returns Labels for the sandbox.

Returns:

  • (Hash<String, String>) —

    Labels for the sandbox



25
26
27
 
# File 'lib/daytona/sandbox.rb', line 25

def labels
  @labels
end

#memory ⇒ Float (readonly)

Returns The memory quota for the sandbox.

Returns:

  • (Float) —

    The memory quota for the sandbox



46
47
48
 
# File 'lib/daytona/sandbox.rb', line 46

def memory
  @memory
end

#network_allow_list ⇒ String (readonly)

Returns Comma-separated list of allowed CIDR network addresses for the sandbox.

Returns:

  • (String) —

    Comma-separated list of allowed CIDR network addresses for the sandbox



34
35
36
 
# File 'lib/daytona/sandbox.rb', line 34

def network_allow_list
  @network_allow_list
end

#network_block_all ⇒ Boolean (readonly)

Returns Whether to block all network access for the sandbox.

Returns:

  • (Boolean) —

    Whether to block all network access for the sandbox



31
32
33
 
# File 'lib/daytona/sandbox.rb', line 31

def network_block_all
  @network_block_all
end

#organization_id ⇒ String (readonly)

Returns The organization ID of the sandbox.

Returns:

  • (String) —

    The organization ID of the sandbox



13
14
15
 
# File 'lib/daytona/sandbox.rb', line 13

def organization_id
  @organization_id
end

#process ⇒ Daytona::Process (readonly)

Returns:



101
102
103
 
# File 'lib/daytona/sandbox.rb', line 101

def process
  @process
end

#public ⇒ Boolean (readonly)

Returns Whether the sandbox http preview is public.

Returns:

  • (Boolean) —

    Whether the sandbox http preview is public



28
29
30
 
# File 'lib/daytona/sandbox.rb', line 28

def public
  @public
end

#sandbox_api ⇒ DaytonaApiClient::SandboxApi (readonly)

Returns:

  • (DaytonaApiClient::SandboxApi) 


98
99
100
 
# File 'lib/daytona/sandbox.rb', line 98

def sandbox_api
  @sandbox_api
end

#snapshot ⇒ String (readonly)

Returns The snapshot used for the sandbox.

Returns:

  • (String) —

    The snapshot used for the sandbox



16
17
18
 
# File 'lib/daytona/sandbox.rb', line 16

def snapshot
  @snapshot
end

#state ⇒ DaytonaApiClient::SandboxState (readonly)

Returns The state of the sandbox.

Returns:

  • (DaytonaApiClient::SandboxState) —

    The state of the sandbox



52
53
54
 
# File 'lib/daytona/sandbox.rb', line 52

def state
  @state
end

#target ⇒ String (readonly)

Returns The target environment for the sandbox.

Returns:

  • (String) —

    The target environment for the sandbox



37
38
39
 
# File 'lib/daytona/sandbox.rb', line 37

def target
  @target
end

#updated_at ⇒ String (readonly)

Returns The last update timestamp of the sandbox.

Returns:

  • (String) —

    The last update timestamp of the sandbox



86
87
88
 
# File 'lib/daytona/sandbox.rb', line 86

def updated_at
  @updated_at
end

#user ⇒ String (readonly)

Returns The user associated with the project.

Returns:

  • (String) —

    The user associated with the project



19
20
21
 
# File 'lib/daytona/sandbox.rb', line 19

def user
  @user
end

#volumes ⇒ Array<DaytonaApiClient::SandboxVolume> (readonly)

Returns Array of volumes attached to the sandbox.

Returns:

  • (Array<DaytonaApiClient::SandboxVolume>) —

    Array of volumes attached to the sandbox



77
78
79
 
# File 'lib/daytona/sandbox.rb', line 77

def volumes
  @volumes
end

Instance Method Details

#archive ⇒ void

This method returns an undefined value.

Archives the sandbox, making it inactive and preserving its state. When sandboxes are archived, the entire filesystem state is moved to cost-effective object storage, making it possible to keep sandboxes available for an extended period. The tradeoff between archived and stopped states is that starting an archived sandbox takes more time, depending on its size. Sandbox must be stopped before archiving.



172
173
174
175
 
# File 'lib/daytona/sandbox.rb', line 172

def archive
  sandbox_api.archive_sandbox(id)
  refresh
end

#create_lsp_server(language_id:, path_to_project:) ⇒ Daytona::LspServer

Creates a new Language Server Protocol (LSP) server instance. The LSP server provides language-specific features like code completion, diagnostics, and more.

Parameters:

  • language_id (Symbol) —

    The language server type (e.g., Daytona::LspServer::Language::PYTHON)

  • path_to_project (String) —

    Path to the project root directory. Relative paths are resolved based on the sandbox working directory.

Returns:



384
385
386
 
# File 'lib/daytona/sandbox.rb', line 384

def create_lsp_server(language_id:, path_to_project:)
  LspServer.new(language_id:, path_to_project:, toolbox_api: @lsp_api, sandbox_id: id)
end

#create_signed_preview_url(port, expires_in_seconds = nil) ⇒ DaytonaApiClient::SignedPortPreviewUrl

Creates a signed preview URL for the sandbox at the specified port.

Examples:

signed_url = sandbox.create_signed_preview_url(3000, 120)
puts "Signed URL: #{signed_url.url}"
puts "Token: #{signed_url.token}"

Parameters:

  • port (Integer) —

    The port to open the preview link on

  • expires_in_seconds (Integer, nil) (defaults to: nil) —

    The number of seconds the signed preview URL will be valid for. Defaults to 60 seconds.

Returns:

  • (DaytonaApiClient::SignedPortPreviewUrl) —

    The signed preview URL response object



282
283
284
 
# File 'lib/daytona/sandbox.rb', line 282

def create_signed_preview_url(port, expires_in_seconds = nil)
  sandbox_api.get_signed_port_preview_url(id, port, { expires_in_seconds: })
end

#create_ssh_access(expires_in_minutes) ⇒ DaytonaApiClient::SshAccessDto

Creates an SSH access token for the sandbox.

Parameters:

  • expires_in_minutes (Integer) —

    TThe number of minutes the SSH access token will be valid for

Returns:

  • (DaytonaApiClient::SshAccessDto) 


220
 
# File 'lib/daytona/sandbox.rb', line 220

def create_ssh_access(expires_in_minutes) = sandbox_api.create_ssh_access(id, { expires_in_minutes: })

#delete ⇒ void

This method returns an undefined value.



223
224
225
226
 
# File 'lib/daytona/sandbox.rb', line 223

def delete
  sandbox_api.delete_sandbox(id)
  refresh
end

#expire_signed_preview_url(port, token) ⇒ void

This method returns an undefined value.

Expires a signed preview URL for the sandbox at the specified port.

Examples:

sandbox.expire_signed_preview_url(3000, "token-value")

Parameters:

  • port (Integer) —

    The port to expire the signed preview URL on

  • token (String) —

    The token to expire



294
295
296
 
# File 'lib/daytona/sandbox.rb', line 294

def expire_signed_preview_url(port, token)
  sandbox_api.expire_signed_port_preview_url(id, port, token)
end

#get_user_home_dir ⇒ String

Gets the user’s home directory path for the logged in user inside the Sandbox.

Examples:

user_home_dir = sandbox.get_user_home_dir
puts "Sandbox user home: #{user_home_dir}"

Returns:

  • (String) —

    The absolute path to the Sandbox user’s home directory for the logged in user



235
236
237
238
239
 
# File 'lib/daytona/sandbox.rb', line 235

def get_user_home_dir
  @info_api.get_user_home_dir.dir
rescue StandardError => e
  raise Sdk::Error, "Failed to get user home directory: #{e.message}"
end

#get_work_dir ⇒ String

Gets the working directory path inside the Sandbox.

Examples:

work_dir = sandbox.get_work_dir
puts "Sandbox working directory: #{work_dir}"

Returns:

  • (String) —

    The absolute path to the Sandbox working directory. Uses the WORKDIR specified in the Dockerfile if present, or falling back to the user’s home directory if not.



249
250
251
252
253
 
# File 'lib/daytona/sandbox.rb', line 249

def get_work_dir
  @info_api.get_work_dir.dir
rescue StandardError => e
  raise Sdk::Error, "Failed to get working directory path: #{e.message}"
end

#preview_url(port) ⇒ DaytonaApiClient::PortPreviewUrl

Retrieves the preview link for the sandbox at the specified port. If the port is closed, it will be opened automatically. For private sandboxes, a token is included to grant access to the URL.

Parameters:

  • port (Integer)

Returns:

  • (DaytonaApiClient::PortPreviewUrl) 


269
 
# File 'lib/daytona/sandbox.rb', line 269

def preview_url(port) = sandbox_api.get_port_preview_url(id, port)

#recover(timeout = DEFAULT_TIMEOUT) ⇒ void

This method returns an undefined value.

Recovers the Sandbox from a recoverable error and waits for it to be ready.

Examples:

sandbox = daytona.get('my-sandbox-id')
sandbox.recover(timeout: 40)  # Wait up to 40 seconds
puts 'Sandbox recovered successfully'

Parameters:

  • timeout (Numeric) (defaults to: DEFAULT_TIMEOUT) —

    Maximum wait time in seconds (defaults to 60 s).



346
347
348
349
350
351
352
353
354
 
# File 'lib/daytona/sandbox.rb', line 346

def recover(timeout = DEFAULT_TIMEOUT)
  with_timeout(
    timeout:,
    message: "Sandbox #{id} failed to recover within the #{timeout} seconds timeout period",
    setup: proc { process_response(sandbox_api.recover_sandbox(id)) }
  ) { wait_for_states(operation: OPERATION_START, target_states: [DaytonaApiClient::SandboxState::STARTED]) }
rescue StandardError => e
  raise Sdk::Error, "Failed to recover sandbox: #{e.message}"
end

#refresh ⇒ void

This method returns an undefined value.

Refresh the Sandbox data from the API.



301
 
# File 'lib/daytona/sandbox.rb', line 301

def refresh = process_response(sandbox_api.get_sandbox(id))

#refresh_activity ⇒ void

This method returns an undefined value.

Refreshes the sandbox activity to reset the timer for automated lifecycle management actions.

This method updates the sandbox’s last activity timestamp without changing its state. It is useful for keeping long-running sessions alive while there is still user activity.

Examples:

sandbox.refresh_activity


312
313
314
315
316
317
 
# File 'lib/daytona/sandbox.rb', line 312

def refresh_activity
  sandbox_api.update_last_activity(id)
  nil
rescue StandardError => e
  raise Sdk::Error, "Failed to refresh sandbox activity: #{e.message}"
end

#revoke_ssh_access(token) ⇒ void

This method returns an undefined value.

Revokes an SSH access token for the sandbox.

Parameters:

  • token (String) 


323
 
# File 'lib/daytona/sandbox.rb', line 323

def revoke_ssh_access(token) = sandbox_api.revoke_ssh_access(id, token:)

#start(timeout = DEFAULT_TIMEOUT) ⇒ void

This method returns an undefined value.

Starts the Sandbox and waits for it to be ready.

Parameters:

  • timeout (Numeric) (defaults to: DEFAULT_TIMEOUT) —

    Maximum wait time in seconds (defaults to 60 s).



329
330
331
332
333
334
335
 
# File 'lib/daytona/sandbox.rb', line 329

def start(timeout = DEFAULT_TIMEOUT)
  with_timeout(
    timeout:,
    message: "Sandbox #{id} failed to become ready within the #{timeout} seconds timeout period",
    setup: proc { process_response(sandbox_api.start_sandbox(id)) }
  ) { wait_for_states(operation: OPERATION_START, target_states: [DaytonaApiClient::SandboxState::STARTED]) }
end

#stop(timeout = DEFAULT_TIMEOUT) ⇒ void

This method returns an undefined value.

Stops the Sandbox and waits for it to be stopped.

Parameters:

  • timeout (Numeric) (defaults to: DEFAULT_TIMEOUT) —

    Maximum wait time in seconds (defaults to 60 s).



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/daytona/sandbox.rb', line 360

def stop(timeout = DEFAULT_TIMEOUT) # rubocop:disable Metrics/MethodLength
  with_timeout(
    timeout:,
    message: "Sandbox #{id} failed to become stopped within the #{timeout} seconds timeout period",
    setup: proc {
      sandbox_api.stop_sandbox(id)
      refresh
    }
  ) do
    wait_for_states(
      operation: OPERATION_STOP,
      target_states: [DaytonaApiClient::SandboxState::STOPPED, DaytonaApiClient::SandboxState::DESTROYED]
    )
  end
end

#validate_ssh_access(token) ⇒ DaytonaApiClient::SshAccessValidationDto

Validates an SSH access token for the sandbox.

Parameters:

  • token (String)

Returns:

  • (DaytonaApiClient::SshAccessValidationDto) 


392
 
# File 'lib/daytona/sandbox.rb', line 392

def validate_ssh_access(token) = sandbox_api.validate_ssh_access(token)

#wait_for_sandbox_start(_timeout = DEFAULT_TIMEOUT) ⇒ void

This method returns an undefined value.

Waits for the Sandbox to reach the ‘started’ state. Polls the Sandbox status until it reaches the ‘started’ state or encounters an error.

Parameters:

  • timeout (Numeric) —

    Maximum wait time in seconds (defaults to 60 s).



399
400
401
 
# File 'lib/daytona/sandbox.rb', line 399

def wait_for_sandbox_start(_timeout = DEFAULT_TIMEOUT)
  wait_for_states(operation: OPERATION_START, target_states: [DaytonaApiClient::SandboxState::STARTED])
end

#wait_for_sandbox_stop(_timeout = DEFAULT_TIMEOUT) ⇒ void

This method returns an undefined value.

Waits for the Sandbox to reach the ‘stopped’ state. Polls the Sandbox status until it reaches the ‘stopped’ state or encounters an error. Treats destroyed as stopped to cover ephemeral sandboxes that are automatically deleted after stopping.

Parameters:

  • timeout (Numeric) —

    Maximum wait time in seconds (defaults to 60 s).



409
410
411
412
 
# File 'lib/daytona/sandbox.rb', line 409

def wait_for_sandbox_stop(_timeout = DEFAULT_TIMEOUT)
  wait_for_states(operation: OPERATION_STOP, target_states: [DaytonaApiClient::SandboxState::STOPPED,
                                                             DaytonaApiClient::SandboxState::DESTROYED])
end