Current section
Files
Jump to
Current section
Files
lib/codex/app_server.ex
defmodule Codex.AppServer do
@moduledoc """
App-server transport for stateful, bidirectional communication with Codex.
"""
alias Codex.AppServer.Connection
alias Codex.AppServer.Params
alias Codex.AppServer.Supervisor, as: ConnectionSupervisor
alias Codex.Config.Defaults
alias Codex.OAuth.AppServerAuth
alias Codex.Options
@type connection :: pid()
@typedoc """
Options for launching and initializing a managed `codex app-server` child process.
`cwd` and `process_env` / `env` apply to the child process itself. Per-thread working
directories still belong on `thread/start`, `thread/resume`, or `Codex.Thread.Options`.
"""
@type connect_opts :: [
init_timeout_ms: pos_integer(),
client_name: String.t(),
client_title: String.t(),
client_version: String.t(),
experimental_api: boolean(),
cwd: String.t(),
process_env: map() | keyword(),
env: map() | keyword(),
oauth: keyword()
]
@default_init_timeout_ms Defaults.app_server_init_timeout_ms()
@doc """
Starts a supervised `codex app-server` subprocess and completes the `initialize` handshake.
Use `cwd` and `process_env` (or the `env` alias) when the app-server child must run with an
isolated working directory or `CODEX_HOME` without mutating the caller's shell environment.
"""
@spec connect(Options.t(), connect_opts()) :: {:ok, connection()} | {:error, term()}
def connect(%Options{} = codex_opts, opts \\ []) do
init_timeout_ms = Keyword.get(opts, :init_timeout_ms, @default_init_timeout_ms)
with {:ok, _pid} <- ensure_connection_supervisor(),
:ok <- AppServerAuth.ensure_before_connect(opts),
{:ok, conn} <- start_connection(codex_opts, opts),
{:ok, ^conn} <- await_connection_ready(conn, init_timeout_ms) do
authenticate_connection(conn, opts)
end
end
defp start_connection(codex_opts, opts) do
child_spec =
{Connection, {codex_opts, opts}}
|> Supervisor.child_spec(restart: :temporary)
DynamicSupervisor.start_child(ConnectionSupervisor, child_spec)
end
defp await_connection_ready(conn, timeout) do
case Connection.await_ready(conn, timeout) do
:ok ->
{:ok, conn}
{:error, _reason} = error ->
_ = DynamicSupervisor.terminate_child(ConnectionSupervisor, conn)
error
end
end
defp ensure_connection_supervisor do
with :ok <- ensure_application_started(),
pid when is_pid(pid) <- Process.whereis(ConnectionSupervisor) do
{:ok, pid}
else
nil -> {:error, :supervisor_unavailable}
{:error, _} = error -> error
end
catch
:exit, reason -> {:error, reason}
end
defp ensure_application_started do
case Application.ensure_all_started(:codex_sdk) do
{:ok, _} -> :ok
{:error, {:already_started, _}} -> :ok
{:error, reason} -> {:error, reason}
end
end
@spec disconnect(connection()) :: :ok
def disconnect(conn) when is_pid(conn) do
_ = safe_terminate_child(conn)
:ok
end
defp safe_terminate_child(conn) do
DynamicSupervisor.terminate_child(ConnectionSupervisor, conn)
catch
:exit, :normal -> :ok
:exit, {:normal, _} -> :ok
:exit, _ -> :ok
end
defp maybe_terminate_connection(conn), do: safe_terminate_child(conn)
defp authenticate_connection(conn, opts) do
case AppServerAuth.authenticate_connection(conn, opts) do
:ok ->
{:ok, conn}
{:error, _reason} = error ->
maybe_terminate_connection(conn)
error
end
end
@spec alive?(connection()) :: boolean()
def alive?(conn) when is_pid(conn), do: Process.alive?(conn)
@spec subscribe(connection(), keyword()) :: :ok | {:error, term()}
def subscribe(conn, opts \\ []) when is_pid(conn) do
Connection.subscribe(conn, opts)
end
@spec unsubscribe(connection()) :: :ok
def unsubscribe(conn) when is_pid(conn) do
Connection.unsubscribe(conn)
end
@spec respond(connection(), String.t() | integer(), map()) :: :ok | {:error, term()}
def respond(conn, id, result) when is_pid(conn) and (is_integer(id) or is_binary(id)) do
Connection.respond(conn, id, result)
end
@spec thread_start(connection(), map() | keyword()) :: {:ok, map()} | {:error, term()}
def thread_start(conn, params \\ %{}) when is_pid(conn) do
params = Params.normalize_map(params)
with {:ok, approval_policy} <-
params
|> fetch_any([:approval_policy, "approval_policy"])
|> Params.ask_for_approval() do
wire_params =
%{}
|> Params.put_optional("model", fetch_any(params, [:model, "model"]))
|> Params.put_optional(
"modelProvider",
fetch_any(params, [:model_provider, "model_provider", :modelProvider, "modelProvider"])
)
|> Params.put_optional(
"cwd",
fetch_any(params, [:cwd, "cwd", :working_directory, "working_directory"])
)
|> Params.put_optional("approvalPolicy", approval_policy)
|> Params.put_optional(
"approvalsReviewer",
params
|> fetch_any([
:approvals_reviewer,
"approvals_reviewer",
:approvalsReviewer,
"approvalsReviewer"
])
|> Params.approvals_reviewer()
)
|> Params.put_optional(
"sandbox",
params
|> fetch_any([:sandbox, "sandbox"])
|> Params.sandbox_mode()
)
|> Params.put_optional("config", fetch_any(params, [:config, "config"]))
|> Params.put_optional(
"baseInstructions",
fetch_any(params, [:base_instructions, "base_instructions"])
)
|> Params.put_optional(
"developerInstructions",
fetch_any(params, [:developer_instructions, "developer_instructions"])
)
|> Params.put_optional(
"personality",
params
|> fetch_any([:personality, "personality"])
|> Params.personality()
)
|> Params.put_optional(
"experimentalRawEvents",
fetch_any(params, [:experimental_raw_events, "experimental_raw_events"])
)
Connection.request(conn, "thread/start", wire_params, timeout_ms: 30_000)
end
end
@spec thread_resume(connection(), String.t(), map() | keyword()) ::
{:ok, map()} | {:error, term()}
def thread_resume(conn, thread_id, params \\ %{}) when is_pid(conn) and is_binary(thread_id) do
params = Params.normalize_map(params)
with {:ok, approval_policy} <-
params
|> fetch_any([:approval_policy, "approval_policy"])
|> Params.ask_for_approval() do
wire_params =
%{"threadId" => thread_id}
|> Params.put_optional("history", fetch_any(params, [:history, "history"]))
|> Params.put_optional("path", fetch_any(params, [:path, "path"]))
|> Params.put_optional("model", fetch_any(params, [:model, "model"]))
|> Params.put_optional(
"modelProvider",
fetch_any(params, [:model_provider, "model_provider", :modelProvider, "modelProvider"])
)
|> Params.put_optional(
"cwd",
fetch_any(params, [:cwd, "cwd", :working_directory, "working_directory"])
)
|> Params.put_optional("approvalPolicy", approval_policy)
|> Params.put_optional(
"approvalsReviewer",
params
|> fetch_any([
:approvals_reviewer,
"approvals_reviewer",
:approvalsReviewer,
"approvalsReviewer"
])
|> Params.approvals_reviewer()
)
|> Params.put_optional(
"sandbox",
params
|> fetch_any([:sandbox, "sandbox"])
|> Params.sandbox_mode()
)
|> Params.put_optional("config", fetch_any(params, [:config, "config"]))
|> Params.put_optional(
"baseInstructions",
fetch_any(params, [:base_instructions, "base_instructions"])
)
|> Params.put_optional(
"developerInstructions",
fetch_any(params, [:developer_instructions, "developer_instructions"])
)
|> Params.put_optional(
"personality",
params
|> fetch_any([:personality, "personality"])
|> Params.personality()
)
|> Params.put_optional(
"experimentalRawEvents",
fetch_any(params, [:experimental_raw_events, "experimental_raw_events"])
)
Connection.request(conn, "thread/resume", wire_params, timeout_ms: 30_000)
end
end
@spec thread_list(connection(), keyword()) :: {:ok, map()} | {:error, term()}
def thread_list(conn, opts \\ []) when is_pid(conn) and is_list(opts) do
wire_params =
%{}
|> Params.put_optional("cursor", Keyword.get(opts, :cursor))
|> Params.put_optional("limit", Keyword.get(opts, :limit))
|> Params.put_optional("sortKey", Params.thread_sort_key(Keyword.get(opts, :sort_key)))
|> Params.put_optional("modelProviders", Keyword.get(opts, :model_providers))
|> Params.put_optional(
"sourceKinds",
normalize_thread_source_kinds(Keyword.get(opts, :source_kinds))
)
|> Params.put_optional("archived", Keyword.get(opts, :archived))
|> Params.put_optional("cwd", Keyword.get(opts, :cwd))
|> Params.put_optional("searchTerm", Keyword.get(opts, :search_term))
Connection.request(conn, "thread/list", wire_params, timeout_ms: 30_000)
end
@spec thread_archive(connection(), String.t()) :: :ok | {:error, term()}
def thread_archive(conn, thread_id) when is_pid(conn) and is_binary(thread_id) do
case Connection.request(conn, "thread/archive", %{"threadId" => thread_id},
timeout_ms: 30_000
) do
{:ok, _} -> :ok
{:error, _} = error -> error
end
end
@spec thread_unsubscribe(connection(), String.t()) :: {:ok, map()} | {:error, term()}
def thread_unsubscribe(conn, thread_id) when is_pid(conn) and is_binary(thread_id) do
Connection.request(conn, "thread/unsubscribe", %{"threadId" => thread_id}, timeout_ms: 30_000)
end
@spec thread_fork(connection(), String.t(), map() | keyword()) ::
{:ok, map()} | {:error, term()}
def thread_fork(conn, thread_id, params \\ %{})
when is_pid(conn) and is_binary(thread_id) do
params = Params.normalize_map(params)
with {:ok, approval_policy} <-
params
|> fetch_any([:approval_policy, "approval_policy"])
|> Params.ask_for_approval() do
wire_params =
%{"threadId" => thread_id}
|> Params.put_optional("path", fetch_any(params, [:path, "path"]))
|> Params.put_optional("model", fetch_any(params, [:model, "model"]))
|> Params.put_optional(
"modelProvider",
fetch_any(params, [:model_provider, "model_provider", :modelProvider, "modelProvider"])
)
|> Params.put_optional(
"cwd",
fetch_any(params, [:cwd, "cwd", :working_directory, "working_directory"])
)
|> Params.put_optional("approvalPolicy", approval_policy)
|> Params.put_optional(
"approvalsReviewer",
params
|> fetch_any([
:approvals_reviewer,
"approvals_reviewer",
:approvalsReviewer,
"approvalsReviewer"
])
|> Params.approvals_reviewer()
)
|> Params.put_optional(
"sandbox",
params
|> fetch_any([:sandbox, "sandbox"])
|> Params.sandbox_mode()
)
|> Params.put_optional("config", fetch_any(params, [:config, "config"]))
|> Params.put_optional(
"baseInstructions",
fetch_any(params, [:base_instructions, "base_instructions"])
)
|> Params.put_optional(
"developerInstructions",
fetch_any(params, [:developer_instructions, "developer_instructions"])
)
Connection.request(conn, "thread/fork", wire_params, timeout_ms: 30_000)
end
end
@spec thread_rollback(connection(), String.t(), pos_integer()) ::
{:ok, map()} | {:error, term()}
def thread_rollback(conn, thread_id, num_turns)
when is_pid(conn) and is_binary(thread_id) and is_integer(num_turns) and num_turns >= 1 do
params = %{"threadId" => thread_id, "numTurns" => num_turns}
Connection.request(conn, "thread/rollback", params, timeout_ms: 30_000)
end
def thread_rollback(_conn, _thread_id, num_turns) do
{:error, {:invalid_num_turns, num_turns}}
end
@spec thread_read(connection(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
def thread_read(conn, thread_id, opts \\ [])
when is_pid(conn) and is_binary(thread_id) and is_list(opts) do
params = %{
"threadId" => thread_id,
"includeTurns" => !!Keyword.get(opts, :include_turns, false)
}
Connection.request(conn, "thread/read", params, timeout_ms: 30_000)
end
@spec thread_loaded_list(connection(), keyword()) :: {:ok, map()} | {:error, term()}
def thread_loaded_list(conn, opts \\ []) when is_pid(conn) and is_list(opts) do
params =
%{}
|> Params.put_optional("cursor", Keyword.get(opts, :cursor))
|> Params.put_optional("limit", Keyword.get(opts, :limit))
Connection.request(conn, "thread/loaded/list", params, timeout_ms: 30_000)
end
@spec thread_name_set(connection(), String.t(), String.t()) :: {:ok, map()} | {:error, term()}
def thread_name_set(conn, thread_id, name)
when is_pid(conn) and is_binary(thread_id) and is_binary(name) do
Connection.request(
conn,
"thread/name/set",
%{"threadId" => thread_id, "name" => name},
timeout_ms: 30_000
)
end
@spec thread_metadata_update(connection(), String.t(), map() | keyword()) ::
{:ok, map()} | {:error, term()}
def thread_metadata_update(conn, thread_id, params)
when is_pid(conn) and is_binary(thread_id) do
params = Params.normalize_map(params)
wire_params =
%{"threadId" => thread_id}
|> Params.put_optional(
"gitInfo",
params
|> fetch_any([:git_info, "git_info", :gitInfo, "gitInfo"])
|> Params.git_info_update()
)
Connection.request(conn, "thread/metadata/update", wire_params, timeout_ms: 30_000)
end
@spec thread_unarchive(connection(), String.t()) :: {:ok, map()} | {:error, term()}
def thread_unarchive(conn, thread_id) when is_pid(conn) and is_binary(thread_id) do
Connection.request(conn, "thread/unarchive", %{"threadId" => thread_id}, timeout_ms: 30_000)
end
@doc """
Writes a skills config entry enabling or disabling a skill by path.
"""
@spec skills_config_write(connection(), String.t(), boolean()) ::
{:ok, map()} | {:error, term()}
def skills_config_write(conn, path, enabled)
when is_pid(conn) and is_binary(path) and is_boolean(enabled) do
params = %{"path" => path, "enabled" => enabled}
Connection.request(conn, "skills/config/write", params, timeout_ms: 30_000)
end
@doc """
Reads config requirements enforced by the server (if any).
"""
@spec config_requirements(connection()) :: {:ok, map()} | {:error, term()}
def config_requirements(conn) when is_pid(conn) do
Connection.request(conn, "configRequirements/read", %{}, timeout_ms: 10_000)
end
@doc """
Lists collaboration mode presets (experimental).
"""
@spec collaboration_mode_list(connection()) :: {:ok, map()} | {:error, term()}
def collaboration_mode_list(conn) when is_pid(conn) do
Connection.request(conn, "collaborationMode/list", %{}, timeout_ms: 30_000)
end
@doc """
Lists available apps/connectors.
"""
@spec apps_list(connection(), keyword()) :: {:ok, map()} | {:error, term()}
def apps_list(conn, opts \\ []) when is_pid(conn) and is_list(opts) do
params =
%{}
|> Params.put_optional("cursor", Keyword.get(opts, :cursor))
|> Params.put_optional("limit", Keyword.get(opts, :limit))
|> Params.put_optional("threadId", Keyword.get(opts, :thread_id))
|> Params.put_optional("forceRefetch", normalize_true(Keyword.get(opts, :force_refetch)))
Connection.request(conn, "app/list", params, timeout_ms: 30_000)
end
@doc """
Starts server-side context compaction for a thread.
"""
@spec thread_compact(connection(), String.t()) :: {:ok, map()} | {:error, term()}
def thread_compact(conn, thread_id) when is_pid(conn) and is_binary(thread_id) do
Connection.request(conn, "thread/compact/start", %{"threadId" => thread_id},
timeout_ms: 30_000
)
end
@doc """
Explicit alias for `thread_compact/2`.
"""
@spec thread_compact_start(connection(), String.t()) :: {:ok, map()} | {:error, term()}
def thread_compact_start(conn, thread_id) when is_pid(conn) and is_binary(thread_id) do
thread_compact(conn, thread_id)
end
@spec turn_start(connection(), String.t(), String.t() | [map()], keyword()) ::
{:ok, map()} | {:error, term()}
def turn_start(conn, thread_id, input, opts \\ [])
when is_pid(conn) and is_binary(thread_id) and is_list(opts) do
with {:ok, approval_policy} <-
opts
|> Keyword.get(:approval_policy)
|> Params.ask_for_approval() do
wire_params =
%{
"threadId" => thread_id,
"input" => Params.user_input(input)
}
|> Params.put_optional("cwd", Keyword.get(opts, :cwd))
|> Params.put_optional("approvalPolicy", approval_policy)
|> Params.put_optional(
"approvalsReviewer",
opts
|> Keyword.get(:approvals_reviewer)
|> Params.approvals_reviewer()
)
|> Params.put_optional(
"sandboxPolicy",
opts |> Keyword.get(:sandbox_policy) |> Params.sandbox_policy()
)
|> Params.put_optional("model", Keyword.get(opts, :model))
|> Params.put_optional(
"effort",
opts |> Keyword.get(:effort) |> Params.reasoning_effort()
)
|> Params.put_optional("summary", Keyword.get(opts, :summary))
|> Params.put_optional(
"personality",
opts |> Keyword.get(:personality) |> Params.personality()
)
|> Params.put_optional("outputSchema", Keyword.get(opts, :output_schema))
|> Params.put_optional(
"collaborationMode",
opts |> Keyword.get(:collaboration_mode) |> Params.collaboration_mode()
)
Connection.request(conn, "turn/start", wire_params, timeout_ms: 300_000)
end
end
@spec turn_steer(connection(), String.t(), String.t() | [map()], keyword()) ::
{:ok, map()} | {:error, term()}
def turn_steer(conn, thread_id, input, opts \\ [])
when is_pid(conn) and is_binary(thread_id) and is_list(opts) do
wire_params = %{
"threadId" => thread_id,
"input" => Params.user_input(input),
"expectedTurnId" => Keyword.fetch!(opts, :expected_turn_id)
}
Connection.request(conn, "turn/steer", wire_params, timeout_ms: 30_000)
end
@spec turn_interrupt(connection(), String.t(), String.t()) :: :ok | {:error, term()}
def turn_interrupt(conn, thread_id, turn_id)
when is_pid(conn) and is_binary(thread_id) and is_binary(turn_id) do
params = %{"threadId" => thread_id, "turnId" => turn_id}
case Connection.request(conn, "turn/interrupt", params, timeout_ms: 30_000) do
{:ok, _} -> :ok
{:error, _} = error -> error
end
end
@spec thread_realtime_start(connection(), String.t(), String.t(), keyword()) ::
{:ok, map()} | {:error, term()}
def thread_realtime_start(conn, thread_id, prompt, opts \\ [])
when is_pid(conn) and is_binary(thread_id) and is_binary(prompt) and is_list(opts) do
params =
%{"threadId" => thread_id, "prompt" => prompt}
|> Params.put_optional("sessionId", Keyword.get(opts, :session_id))
Connection.request(conn, "thread/realtime/start", params, timeout_ms: 30_000)
end
@spec thread_realtime_append_audio(connection(), String.t(), map() | keyword()) ::
{:ok, map()} | {:error, term()}
def thread_realtime_append_audio(conn, thread_id, audio)
when is_pid(conn) and is_binary(thread_id) do
Connection.request(
conn,
"thread/realtime/appendAudio",
%{"threadId" => thread_id, "audio" => Params.thread_realtime_audio_chunk(audio)},
timeout_ms: 30_000
)
end
@spec thread_realtime_append_text(connection(), String.t(), String.t()) ::
{:ok, map()} | {:error, term()}
def thread_realtime_append_text(conn, thread_id, text)
when is_pid(conn) and is_binary(thread_id) and is_binary(text) do
Connection.request(
conn,
"thread/realtime/appendText",
%{"threadId" => thread_id, "text" => text},
timeout_ms: 30_000
)
end
@spec thread_realtime_stop(connection(), String.t()) :: {:ok, map()} | {:error, term()}
def thread_realtime_stop(conn, thread_id) when is_pid(conn) and is_binary(thread_id) do
Connection.request(conn, "thread/realtime/stop", %{"threadId" => thread_id},
timeout_ms: 30_000
)
end
@spec skills_list(connection(), keyword()) :: {:ok, map()} | {:error, term()}
def skills_list(conn, opts \\ []) when is_pid(conn) and is_list(opts) do
cwds = Keyword.get(opts, :cwds, [])
force_reload =
case Keyword.get(opts, :force_reload) do
true -> true
_ -> nil
end
params =
%{}
|> Params.put_optional("cwds", List.wrap(cwds))
|> Params.put_optional("forceReload", force_reload)
|> Params.put_optional(
"perCwdExtraUserRoots",
opts
|> Keyword.get(:per_cwd_extra_user_roots)
|> Params.per_cwd_extra_user_roots()
)
Connection.request(conn, "skills/list", params, timeout_ms: 30_000)
end
@spec skills_remote_list(connection(), keyword()) :: {:ok, map()} | {:error, term()}
def skills_remote_list(conn, opts \\ []) when is_pid(conn) and is_list(opts) do
params =
%{}
|> Params.put_optional(
"hazelnutScope",
opts |> Keyword.get(:hazelnut_scope) |> Params.hazelnut_scope()
)
|> Params.put_optional(
"productSurface",
opts |> Keyword.get(:product_surface) |> Params.product_surface()
)
|> Params.put_optional("enabled", Keyword.get(opts, :enabled))
Connection.request(conn, "skills/remote/list", params, timeout_ms: 30_000)
end
@spec skills_remote_export(connection(), String.t()) :: {:ok, map()} | {:error, term()}
def skills_remote_export(conn, hazelnut_id)
when is_pid(conn) and is_binary(hazelnut_id) do
Connection.request(
conn,
"skills/remote/export",
%{"hazelnutId" => hazelnut_id},
timeout_ms: 30_000
)
end
@spec fuzzy_file_search(connection(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
def fuzzy_file_search(conn, query, opts \\ [])
when is_pid(conn) and is_binary(query) and is_list(opts) do
roots = Keyword.get(opts, :roots, [])
params =
%{"query" => query, "roots" => List.wrap(roots)}
|> Params.put_optional("cancellationToken", Keyword.get(opts, :cancellation_token))
Connection.request(conn, "fuzzyFileSearch", params, timeout_ms: 30_000)
end
@spec fuzzy_file_search_session_start(connection(), String.t(), [String.t()]) ::
{:ok, map()} | {:error, term()}
def fuzzy_file_search_session_start(conn, session_id, roots)
when is_pid(conn) and is_binary(session_id) and is_list(roots) do
Connection.request(
conn,
"fuzzyFileSearch/sessionStart",
%{"sessionId" => session_id, "roots" => roots},
timeout_ms: 30_000
)
end
@spec fuzzy_file_search_session_update(connection(), String.t(), String.t()) ::
{:ok, map()} | {:error, term()}
def fuzzy_file_search_session_update(conn, session_id, query)
when is_pid(conn) and is_binary(session_id) and is_binary(query) do
Connection.request(
conn,
"fuzzyFileSearch/sessionUpdate",
%{"sessionId" => session_id, "query" => query},
timeout_ms: 30_000
)
end
@spec fuzzy_file_search_session_stop(connection(), String.t()) ::
{:ok, map()} | {:error, term()}
def fuzzy_file_search_session_stop(conn, session_id)
when is_pid(conn) and is_binary(session_id) do
Connection.request(
conn,
"fuzzyFileSearch/sessionStop",
%{"sessionId" => session_id},
timeout_ms: 30_000
)
end
@spec model_list(connection(), keyword()) :: {:ok, map()} | {:error, term()}
def model_list(conn, opts \\ []) when is_pid(conn) and is_list(opts) do
params =
%{}
|> Params.put_optional("cursor", Keyword.get(opts, :cursor))
|> Params.put_optional("limit", Keyword.get(opts, :limit))
|> Params.put_optional("includeHidden", normalize_true(Keyword.get(opts, :include_hidden)))
Connection.request(conn, "model/list", params, timeout_ms: 30_000)
end
@doc """
Reads a file via the app-server filesystem API, returning a base64 payload.
"""
@spec fs_read_file(connection(), String.t()) :: {:ok, map()} | {:error, term()}
def fs_read_file(conn, path) when is_pid(conn) and is_binary(path) do
Connection.request(conn, "fs/readFile", %{"path" => path}, timeout_ms: 30_000)
end
@doc """
Writes base64-encoded file contents via the app-server filesystem API.
"""
@spec fs_write_file(connection(), String.t(), String.t()) :: {:ok, map()} | {:error, term()}
def fs_write_file(conn, path, data_base64)
when is_pid(conn) and is_binary(path) and is_binary(data_base64) do
Connection.request(
conn,
"fs/writeFile",
%{"path" => path, "dataBase64" => data_base64},
timeout_ms: 30_000
)
end
@doc """
Creates a directory via the app-server filesystem API.
"""
@spec fs_create_directory(connection(), String.t(), keyword()) ::
{:ok, map()} | {:error, term()}
def fs_create_directory(conn, path, opts \\ [])
when is_pid(conn) and is_binary(path) and is_list(opts) do
params =
%{"path" => path}
|> Params.put_optional("recursive", Keyword.get(opts, :recursive))
Connection.request(conn, "fs/createDirectory", params, timeout_ms: 30_000)
end
@doc """
Fetches file or directory metadata via the app-server filesystem API.
"""
@spec fs_get_metadata(connection(), String.t()) :: {:ok, map()} | {:error, term()}
def fs_get_metadata(conn, path) when is_pid(conn) and is_binary(path) do
Connection.request(conn, "fs/getMetadata", %{"path" => path}, timeout_ms: 30_000)
end
@doc """
Lists directory entries via the app-server filesystem API.
"""
@spec fs_read_directory(connection(), String.t()) :: {:ok, map()} | {:error, term()}
def fs_read_directory(conn, path) when is_pid(conn) and is_binary(path) do
Connection.request(conn, "fs/readDirectory", %{"path" => path}, timeout_ms: 30_000)
end
@doc """
Removes a file or directory via the app-server filesystem API.
"""
@spec fs_remove(connection(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
def fs_remove(conn, path, opts \\ []) when is_pid(conn) and is_binary(path) and is_list(opts) do
params =
%{"path" => path}
|> Params.put_optional("recursive", Keyword.get(opts, :recursive))
|> Params.put_optional("force", Keyword.get(opts, :force))
Connection.request(conn, "fs/remove", params, timeout_ms: 30_000)
end
@doc """
Copies a file or directory via the app-server filesystem API.
"""
@spec fs_copy(connection(), String.t(), String.t(), keyword()) ::
{:ok, map()} | {:error, term()}
def fs_copy(conn, source_path, destination_path, opts \\ [])
when is_pid(conn) and is_binary(source_path) and is_binary(destination_path) and
is_list(opts) do
params =
%{"sourcePath" => source_path, "destinationPath" => destination_path}
|> Params.put_optional("recursive", Keyword.get(opts, :recursive))
Connection.request(conn, "fs/copy", params, timeout_ms: 30_000)
end
@spec plugin_list(connection(), keyword()) :: {:ok, map()} | {:error, term()}
def plugin_list(conn, opts \\ []) when is_pid(conn) and is_list(opts) do
params =
%{}
|> Params.put_optional("cwds", Keyword.get(opts, :cwds))
|> Params.put_optional(
"forceRemoteSync",
normalize_true(Keyword.get(opts, :force_remote_sync))
)
Connection.request(conn, "plugin/list", params, timeout_ms: 30_000)
end
@spec plugin_install(connection(), String.t(), String.t()) :: {:ok, map()} | {:error, term()}
def plugin_install(conn, marketplace_path, plugin_name)
when is_pid(conn) and is_binary(marketplace_path) and is_binary(plugin_name) do
Connection.request(
conn,
"plugin/install",
%{"marketplacePath" => marketplace_path, "pluginName" => plugin_name},
timeout_ms: 30_000
)
end
@doc """
Reads plugin details from a marketplace entry via the app-server plugin API.
"""
@spec plugin_read(connection(), String.t(), String.t()) :: {:ok, map()} | {:error, term()}
def plugin_read(conn, marketplace_path, plugin_name)
when is_pid(conn) and is_binary(marketplace_path) and is_binary(plugin_name) do
Connection.request(
conn,
"plugin/read",
%{"marketplacePath" => marketplace_path, "pluginName" => plugin_name},
timeout_ms: 30_000
)
end
@spec plugin_uninstall(connection(), String.t()) :: {:ok, map()} | {:error, term()}
def plugin_uninstall(conn, plugin_id) when is_pid(conn) and is_binary(plugin_id) do
Connection.request(conn, "plugin/uninstall", %{"pluginId" => plugin_id}, timeout_ms: 30_000)
end
@spec experimental_feature_list(connection(), keyword()) :: {:ok, map()} | {:error, term()}
def experimental_feature_list(conn, opts \\ []) when is_pid(conn) and is_list(opts) do
params =
%{}
|> Params.put_optional("cursor", Keyword.get(opts, :cursor))
|> Params.put_optional("limit", Keyword.get(opts, :limit))
Connection.request(conn, "experimentalFeature/list", params, timeout_ms: 30_000)
end
@spec config_read(connection(), keyword()) :: {:ok, map()} | {:error, term()}
def config_read(conn, opts \\ []) when is_pid(conn) and is_list(opts) do
params =
%{"includeLayers" => !!Keyword.get(opts, :include_layers, false)}
|> Params.put_optional("cwd", Keyword.get(opts, :cwd))
Connection.request(conn, "config/read", params, timeout_ms: 10_000)
end
@spec external_agent_config_detect(connection(), keyword()) :: {:ok, map()} | {:error, term()}
def external_agent_config_detect(conn, opts \\ [])
when is_pid(conn) and is_list(opts) do
params =
%{}
|> Params.put_optional("includeHome", normalize_true(Keyword.get(opts, :include_home)))
|> Params.put_optional("cwds", Keyword.get(opts, :cwds))
Connection.request(conn, "externalAgentConfig/detect", params, timeout_ms: 30_000)
end
@spec external_agent_config_import(connection(), [map()]) :: {:ok, map()} | {:error, term()}
def external_agent_config_import(conn, migration_items)
when is_pid(conn) and is_list(migration_items) do
Connection.request(
conn,
"externalAgentConfig/import",
%{"migrationItems" => migration_items},
timeout_ms: 30_000
)
end
@spec config_write(connection(), String.t(), term(), keyword()) ::
{:ok, map()} | {:error, term()}
def config_write(conn, key_path, value, opts \\ [])
when is_pid(conn) and is_binary(key_path) and is_list(opts) do
merge_strategy = Params.merge_strategy(Keyword.get(opts, :merge_strategy, :replace))
params =
%{
"keyPath" => key_path,
"value" => value,
"mergeStrategy" => merge_strategy
}
|> Params.put_optional("filePath", Keyword.get(opts, :file_path))
|> Params.put_optional("expectedVersion", Keyword.get(opts, :expected_version))
Connection.request(conn, "config/value/write", params, timeout_ms: 10_000)
end
@spec config_batch_write(connection(), [map()], keyword()) :: {:ok, map()} | {:error, term()}
def config_batch_write(conn, edits, opts \\ [])
when is_pid(conn) and is_list(edits) and is_list(opts) do
wire_edits =
Enum.map(edits, fn edit ->
edit = Params.normalize_map(edit)
%{
"keyPath" =>
Map.get(edit, :key_path) || Map.get(edit, "key_path") || Map.get(edit, :keyPath) ||
Map.get(edit, "keyPath"),
"value" => Map.get(edit, :value) || Map.get(edit, "value"),
"mergeStrategy" =>
Params.merge_strategy(
Map.get(edit, :merge_strategy) || Map.get(edit, "merge_strategy") || :replace
)
}
end)
params =
%{"edits" => wire_edits}
|> Params.put_optional("filePath", Keyword.get(opts, :file_path))
|> Params.put_optional("expectedVersion", Keyword.get(opts, :expected_version))
|> Params.put_optional(
"reloadUserConfig",
normalize_true(Keyword.get(opts, :reload_user_config))
)
Connection.request(conn, "config/batchWrite", params, timeout_ms: 10_000)
end
@spec review_start(connection(), String.t(), term(), keyword()) ::
{:ok, map()} | {:error, term()}
def review_start(conn, thread_id, target, opts \\ [])
when is_pid(conn) and is_binary(thread_id) and is_list(opts) do
params =
%{
"threadId" => thread_id,
"target" => review_target(target)
}
|> Params.put_optional("delivery", normalize_review_delivery(Keyword.get(opts, :delivery)))
Connection.request(conn, "review/start", params, timeout_ms: 300_000)
end
@spec command_exec(connection(), [String.t()], keyword()) :: {:ok, map()} | {:error, term()}
def command_exec(conn, command, opts \\ [])
when is_pid(conn) and is_list(command) and is_list(opts) do
timeout_ms = Keyword.get(opts, :timeout_ms)
disable_timeout = normalize_true(Keyword.get(opts, :disable_timeout))
params =
%{"command" => command}
|> Params.put_optional("processId", Keyword.get(opts, :process_id))
|> Params.put_optional("tty", normalize_true(Keyword.get(opts, :tty)))
|> Params.put_optional("streamStdin", normalize_true(Keyword.get(opts, :stream_stdin)))
|> Params.put_optional(
"streamStdoutStderr",
normalize_true(Keyword.get(opts, :stream_stdout_stderr))
)
|> Params.put_optional("outputBytesCap", Keyword.get(opts, :output_bytes_cap))
|> Params.put_optional(
"disableOutputCap",
normalize_true(Keyword.get(opts, :disable_output_cap))
)
|> Params.put_optional("disableTimeout", disable_timeout)
|> Params.put_optional("timeoutMs", timeout_ms)
|> Params.put_optional("cwd", Keyword.get(opts, :cwd))
|> Params.put_optional("env", Keyword.get(opts, :env))
|> Params.put_optional("size", opts |> Keyword.get(:size) |> Params.terminal_size())
|> Params.put_optional(
"sandboxPolicy",
opts |> Keyword.get(:sandbox_policy) |> Params.sandbox_policy()
)
request_timeout_ms =
cond do
disable_timeout ->
Defaults.exec_timeout_ms() + 5_000
is_integer(timeout_ms) and timeout_ms > 0 ->
timeout_ms + 5_000
true ->
30_000
end
Connection.request(conn, "command/exec", params, timeout_ms: request_timeout_ms)
end
@doc """
Writes bytes to a running `command/exec` session.
"""
@spec command_exec_write(connection(), String.t(), keyword()) :: {:ok, map()} | {:error, term()}
def command_exec_write(conn, process_id, opts \\ [])
when is_pid(conn) and is_binary(process_id) and is_list(opts) do
params =
%{"processId" => process_id}
|> Params.put_optional(
"deltaBase64",
opts
|> Keyword.get(:delta)
|> encode_command_exec_delta()
)
|> Params.put_optional("closeStdin", normalize_true(Keyword.get(opts, :close_stdin)))
Connection.request(conn, "command/exec/write", params, timeout_ms: 30_000)
end
@spec command_exec_terminate(connection(), String.t()) :: {:ok, map()} | {:error, term()}
def command_exec_terminate(conn, process_id)
when is_pid(conn) and is_binary(process_id) do
Connection.request(
conn,
"command/exec/terminate",
%{"processId" => process_id},
timeout_ms: 30_000
)
end
@spec command_exec_resize(connection(), String.t(), map() | keyword()) ::
{:ok, map()} | {:error, term()}
def command_exec_resize(conn, process_id, size)
when is_pid(conn) and is_binary(process_id) do
params =
%{"processId" => process_id}
|> Params.put_optional("size", Params.terminal_size(size))
Connection.request(conn, "command/exec/resize", params, timeout_ms: 30_000)
end
@doc """
Backwards-compatible alias for `command_exec_write/3` using raw stdin text.
"""
@spec command_write_stdin(connection(), String.t(), String.t(), keyword()) ::
{:ok, map()} | {:error, term()}
def command_write_stdin(conn, process_id, stdin, opts \\ [])
when is_pid(conn) and is_binary(process_id) and is_binary(stdin) and is_list(opts) do
command_exec_write(conn, process_id,
delta: stdin,
close_stdin: Keyword.get(opts, :close_stdin, false)
)
end
@spec windows_sandbox_setup_start(connection(), atom() | String.t(), keyword()) ::
{:ok, map()} | {:error, term()}
def windows_sandbox_setup_start(conn, mode, opts \\ [])
when is_pid(conn) and is_list(opts) do
params =
%{"mode" => Params.windows_sandbox_setup_mode(mode)}
|> Params.put_optional("cwd", Keyword.get(opts, :cwd))
Connection.request(conn, "windowsSandbox/setupStart", params, timeout_ms: 30_000)
end
@spec feedback_upload(connection(), keyword()) :: {:ok, map()} | {:error, term()}
def feedback_upload(conn, opts) when is_pid(conn) and is_list(opts) do
params =
%{
"classification" => Keyword.fetch!(opts, :classification),
"includeLogs" => !!Keyword.get(opts, :include_logs, false)
}
|> Params.put_optional("reason", Keyword.get(opts, :reason))
|> Params.put_optional("threadId", Keyword.get(opts, :thread_id))
Connection.request(conn, "feedback/upload", params, timeout_ms: 30_000)
end
defp review_target({:uncommitted_changes}), do: %{"type" => "uncommittedChanges"}
defp review_target({:base_branch, branch}) when is_binary(branch),
do: %{"type" => "baseBranch", "branch" => branch}
defp review_target({:commit, sha, title}) when is_binary(sha) do
%{"type" => "commit", "sha" => sha}
|> Params.put_optional("title", title)
end
defp review_target({:custom, instructions}) when is_binary(instructions) do
%{"type" => "custom", "instructions" => instructions}
end
defp review_target(%{} = target), do: target
defp review_target(other), do: %{"type" => "custom", "instructions" => to_string(other)}
defp normalize_review_delivery(nil), do: nil
defp normalize_review_delivery(:inline), do: "inline"
defp normalize_review_delivery(:detached), do: "detached"
defp normalize_review_delivery("inline"), do: "inline"
defp normalize_review_delivery("detached"), do: "detached"
defp normalize_review_delivery(other) when is_binary(other), do: other
defp normalize_review_delivery(_other), do: nil
defp normalize_thread_source_kinds(nil), do: nil
defp normalize_thread_source_kinds(source_kinds) when is_list(source_kinds) do
source_kinds
|> Enum.map(&Params.thread_source_kind/1)
|> Enum.reject(&is_nil/1)
|> case do
[] -> nil
list -> list
end
end
defp normalize_thread_source_kinds(_), do: nil
defp encode_command_exec_delta(nil), do: nil
defp encode_command_exec_delta(delta) when is_binary(delta), do: Base.encode64(delta)
defp encode_command_exec_delta(delta), do: delta
defp normalize_true(true), do: true
defp normalize_true("true"), do: true
defp normalize_true(_), do: nil
defp fetch_any(%{} = map, keys) when is_list(keys) do
Enum.find_value(keys, &Map.get(map, &1))
end
end