Class: Daytona::Daytona

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Instrumentation

included

Constructor Details

#initialize(config = Config.new) ⇒ Daytona

Returns a new instance of Daytona.

Parameters:

  • config (Daytona::Config) (defaults to: Config.new) —

    Configuration options. Defaults to Daytona::Config.new



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/daytona/daytona.rb', line 32

def initialize(config = Config.new)
  @config = config
  ensure_access_token_defined

  otel_enabled = config._experimental&.dig('otel_enabled') || ENV['DAYTONA_EXPERIMENTAL_OTEL_ENABLED'] == 'true'
  @otel_state = (::Daytona.init_otel(Sdk::VERSION) if otel_enabled)

  @api_client = build_api_client
  @sandbox_api = DaytonaApiClient::SandboxApi.new(api_client)
  @config_api = DaytonaApiClient::ConfigApi.new(api_client)
  @volume = VolumeService.new(DaytonaApiClient::VolumesApi.new(api_client), otel_state:)
  @object_storage_api = DaytonaApiClient::ObjectStorageApi.new(api_client)
  @snapshots_api = DaytonaApiClient::SnapshotsApi.new(api_client)
  @snapshot = SnapshotService.new(snapshots_api:, object_storage_api:, default_region_id: config.target,
                                  otel_state:)
  # Event subscriber for real-time sandbox updates
  @event_subscriber = nil

  # Create and start WebSocket event subscriber connection in the background (non-blocking).
  token = config.api_key || config.jwt_token
  return unless token

  @event_subscriber = EventSubscriber.new(
    api_url: config.api_url,
    token: token,
    organization_id: config.organization_id
  )
  @event_subscriber.ensure_connected
end

Instance Attribute Details

#api_client ⇒ DaytonaApiClient (readonly)

Returns:

  • (DaytonaApiClient) 


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

def api_client
  @api_client
end

#config ⇒ Daytona::Config (readonly)

Returns:



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

def config
  @config
end

#object_storage_api ⇒ DaytonaApiClient::ObjectStorageApi (readonly)

Returns:

  • (DaytonaApiClient::ObjectStorageApi) 


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

def object_storage_api
  @object_storage_api
end

#sandbox_api ⇒ DaytonaApiClient::SandboxApi (readonly)

Returns:

  • (DaytonaApiClient::SandboxApi) 


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

def sandbox_api
  @sandbox_api
end

#snapshot ⇒ Daytona::SnapshotService (readonly)

Returns:



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

def snapshot
  @snapshot
end

#snapshots_api ⇒ DaytonaApiClient::SnapshotsApi (readonly)

Returns:

  • (DaytonaApiClient::SnapshotsApi) 


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

def snapshots_api
  @snapshots_api
end

#volume ⇒ Daytona::VolumeService (readonly)

Returns:



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

def volume
  @volume
end

Instance Method Details

#close ⇒ void

This method returns an undefined value.

Shuts down OTel providers, flushing any pending telemetry data.



65
66
67
68
69
70
 
# File 'lib/daytona/daytona.rb', line 65

def close
  @event_subscriber&.disconnect
  @event_subscriber = nil
  ::Daytona.shutdown_otel(@otel_state)
  @otel_state = nil
end

#create(params = nil, on_snapshot_create_logs: nil) ⇒ Daytona::Sandbox

Creates a sandbox with the specified parameters

Parameters:

Returns:

Raises:



77
78
79
80
81
82
83
84
85
 
# File 'lib/daytona/daytona.rb', line 77

def create(params = nil, on_snapshot_create_logs: nil)
  if params.nil?
    params = CreateSandboxFromSnapshotParams.new(language: CodeLanguage::PYTHON)
  elsif params.language.nil?
    params.language = CodeLanguage::PYTHON
  end

  _create(params, on_snapshot_create_logs:)
end

#delete(sandbox) ⇒ void

This method returns an undefined value.

Deletes a Sandbox.

Parameters:



91
 
# File 'lib/daytona/daytona.rb', line 91

def delete(sandbox) = sandbox.delete

#find_one(id: nil, labels: nil) ⇒ Daytona::Sandbox

Finds a Sandbox by its ID or labels.

Parameters:

  • id (String, Nil) (defaults to: nil)
  • labels (Hash<String, String>) (defaults to: nil)

Returns:

Raises:



108
109
110
111
112
113
114
115
 
# File 'lib/daytona/daytona.rb', line 108

def find_one(id: nil, labels: nil)
  return get(id) if id

  response = list(labels)
  raise Sdk::Error, "No sandbox found with labels #{labels}" if response.items.empty?

  response.items.first
end

#get(id) ⇒ Daytona::Sandbox

Gets a Sandbox by its ID.

Parameters:

  • id (String)

Returns:



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

def get(id)
  sandbox_dto = sandbox_api.get_sandbox(id)
  to_sandbox(sandbox_dto:, code_toolbox: code_toolbox_from_labels(sandbox_dto.labels))
end

#list(labels = {}, page: nil, limit: nil) ⇒ Daytona::PaginatedResource

Lists Sandboxes filtered by labels.

Parameters:

  • labels (Hash<String, String>) (defaults to: {})
  • page (Integer, Nil) (defaults to: nil)
  • limit (Integer, Nil) (defaults to: nil)

Returns:

Raises:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/daytona/daytona.rb', line 124

def list(labels = {}, page: nil, limit: nil)
  raise Sdk::Error, 'page must be positive integer' if page && page < 1

  raise Sdk::Error, 'limit must be positive integer' if limit && limit < 1

  response = sandbox_api.list_sandboxes_paginated(labels: JSON.dump(labels), page:, limit:)

  PaginatedResource.new(
    total: response.total,
    page: response.page,
    total_pages: response.total_pages,
    items: response
           .items
           .map do |sandbox_dto|
             to_sandbox(sandbox_dto:, code_toolbox: code_toolbox_from_labels(sandbox_dto.labels))
    end
  )
end

#start(sandbox, timeout = Sandbox::DEFAULT_TIMEOUT) ⇒ void

This method returns an undefined value.

Starts a Sandbox and waits for it to be ready.

Parameters:

  • sandbox (Daytona::Sandbox)
  • timeout (Numeric) (defaults to: Sandbox::DEFAULT_TIMEOUT) —

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



148
 
# File 'lib/daytona/daytona.rb', line 148

def start(sandbox, timeout = Sandbox::DEFAULT_TIMEOUT) = sandbox.start(timeout)

#stop(sandbox, timeout = Sandbox::DEFAULT_TIMEOUT) ⇒ void

This method returns an undefined value.

Stops a Sandbox and waits for it to be stopped.

Parameters:

  • sandbox (Daytona::Sandbox)
  • timeout (Numeric) (defaults to: Sandbox::DEFAULT_TIMEOUT) —

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



155
 
# File 'lib/daytona/daytona.rb', line 155

def stop(sandbox, timeout = Sandbox::DEFAULT_TIMEOUT) = sandbox.stop(timeout)