defmodule Yex.Doc do @moduledoc """ Document module. ### Cross-Process Operations When a Doc or SharedType operation is performed from a process different from the process that created the Doc, a message like `{Yex.Doc, :run, fun}` is sent to the creator process via `GenServer.call` and the processing is delegated to that process. If you encounter a `GenServer.call` timeout, this delegation mechanism may be the cause. Make sure the worker process can handle the GenServer call messages properly. It is recommended to start a GenServer process such as `Yex.DocServer` when executing operations from other processes. """ defmodule Options do @moduledoc """ Document options. """ defstruct client_id: 0, guid: nil, collection_id: nil, offset_kind: :bytes, skip_gc: false, auto_load: false, should_load: true @type t :: %__MODULE__{ client_id: integer(), guid: String.t() | nil, collection_id: String.t(), offset_kind: :bytes | :utf16, skip_gc: boolean(), auto_load: boolean(), should_load: boolean() } end defstruct [ :reference, worker_pid: nil ] @type t :: %__MODULE__{ reference: any(), worker_pid: pid() | nil } @doc """ Executes the given block in the document's worker process. If the current process is already the worker process, executes directly. Otherwise, delegates execution to the worker process via GenServer.call. Raises if worker_pid is not set. """ defmacro run_in_worker_process(doc, do: block) do quote do case unquote(doc).worker_pid do pid when pid == self() -> unquote(block) nil -> raise "Document has no worker process assigned" worker_pid -> wrapped_fun = fn -> try do unquote(block) rescue e -> {Yex.Doc, :reraise, e, __STACKTRACE__} end end # When a Doc or SharedType operation is performed from a process different from the # process that created the Doc, a message like {Yex.Doc, :run, fun} is sent to the # creator process via GenServer.call and the processing is delegated to that process. # If you encounter a GenServer.call timeout, this delegation mechanism may be the cause. case GenServer.call( worker_pid, {Yex.Doc, :run, wrapped_fun} ) do {Yex.Doc, :reraise, e, stacktrace} -> reraise e, stacktrace result -> result end end end end @doc """ Create a new document. worker_pid: If there is a possibility of passing the created document to another process, please specify the process responsible for operating the document. This process needs to handle the GenServer handle_call messages as follows: @impl true def handle_call( {Yex.Doc, :run, fun}, _from, state ) do {:reply, fun.(), state} end """ @spec new(pid()) :: Yex.Doc.t() def new(worker_pid \\ self()) do Yex.Nif.doc_new() |> Map.put(:worker_pid, worker_pid) end @doc """ Create a new document with options. """ @spec with_options(Options.t(), pid()) :: Yex.Doc.t() def with_options(%Options{} = option, worker_pid \\ self()) do Yex.Nif.doc_with_options(option) |> Map.put(:worker_pid, worker_pid) end def client_id(%__MODULE__{} = doc) do run_in_worker_process(doc, do: Yex.Nif.doc_client_id(doc)) end def guid(%__MODULE__{} = doc) do run_in_worker_process(doc, do: Yex.Nif.doc_guid(doc)) end def collection_id(%__MODULE__{} = doc) do run_in_worker_process(doc, do: Yex.Nif.doc_collection_id(doc)) end def skip_gc(%__MODULE__{} = doc) do run_in_worker_process(doc, do: Yex.Nif.doc_skip_gc(doc)) end def auto_load(%__MODULE__{} = doc) do run_in_worker_process(doc, do: Yex.Nif.doc_auto_load(doc)) end def should_load(%__MODULE__{} = doc) do run_in_worker_process(doc, do: Yex.Nif.doc_should_load(doc)) end def offset_kind(%__MODULE__{} = doc) do run_in_worker_process(doc, do: Yex.Nif.doc_offset_kind(doc)) end @doc """ Get or insert the text type. """ @spec get_text(t, String.t()) :: Yex.Text.t() def get_text(%__MODULE__{} = doc, name) do run_in_worker_process(doc, do: Yex.Nif.doc_get_or_insert_text(doc, name)) end @doc """ Get or insert the array type. """ @spec get_array(t, String.t()) :: Yex.Array.t() def get_array(%__MODULE__{} = doc, name) do run_in_worker_process(doc, do: Yex.Nif.doc_get_or_insert_array(doc, name)) end @doc """ Get or insert the map type. """ @spec get_map(t, String.t()) :: Yex.Map.t() def get_map(%__MODULE__{} = doc, name) do run_in_worker_process(doc, do: Yex.Nif.doc_get_or_insert_map(doc, name)) end @doc """ Get or insert the xml fragment type. """ def get_xml_fragment(%__MODULE__{} = doc, name) do run_in_worker_process(doc, do: Yex.Nif.doc_get_or_insert_xml_fragment(doc, name)) end @doc """ Start a transaction. ## Examples iex> doc = Doc.new() iex> text = Doc.get_text(doc, "text") iex> Yex.Doc.monitor_update(doc) iex> Doc.transaction(doc, fn -> iex> Text.insert(text, 0, "Hello") iex> Text.insert(text, 0, "Hello", %{"bold" => true}) iex> end) iex> assert_receive {:update_v1, _, nil, _} iex> refute_receive {:update_v1, _, nil, _} # only one update message """ @spec transaction(t, origin :: term(), fun()) :: term() def transaction(%__MODULE__{reference: ref} = doc, origin \\ nil, exec) do run_in_worker_process doc do if cur_txn(doc) do raise "Transaction already in progress" end txn = Yex.Nif.doc_begin_transaction(doc, origin) try do Process.put(ref, txn) result = exec.() Yex.Nif.commit_transaction(txn) result rescue e -> # Consider rolling back the transaction here if possible reraise e, __STACKTRACE__ after Process.delete(ref) end end end @doc """ Monitor document updates. You can pass metadata as an option. This value is passed as the fourth element of the message.If omitted, it will be passed as a structure of Doc itself. """ @spec monitor_update(t, keyword) :: {:ok, reference()} | {:error, term()} def monitor_update(%__MODULE__{} = doc, opt \\ []) do monitor_update_v1(doc, opt) end def monitor_update_v1(%__MODULE__{} = doc, opt \\ []) do notify_pid = self() case run_in_worker_process(doc, do: Yex.Nif.doc_monitor_update_v1(doc, notify_pid, Keyword.get(opt, :metadata, doc)) ) do {:ok, sub} -> {:ok, Yex.Subscription.register(sub)} error -> error end end def monitor_update_v2(%__MODULE__{} = doc, opt \\ []) do notify_pid = self() case run_in_worker_process(doc, do: Yex.Nif.doc_monitor_update_v2(doc, notify_pid, Keyword.get(opt, :metadata, doc)) ) do {:ok, sub} -> {:ok, Yex.Subscription.register(sub)} error -> error end end @doc """ Stop monitoring document updates. """ @spec demonitor_update(reference()) :: :ok | {:error, term()} def demonitor_update(sub) do demonitor_update_v1(sub) end def demonitor_update_v1(sub) do Yex.Subscription.unsubscribe(sub) end def demonitor_update_v2(sub) do Yex.Subscription.unsubscribe(sub) end def monitor_subdocs(%__MODULE__{} = doc, opt \\ []) do notify_pid = self() case run_in_worker_process(doc, do: Yex.Nif.doc_monitor_subdocs(doc, notify_pid, Keyword.get(opt, :metadata, doc)) ) do {:ok, sub} -> {:ok, Yex.Subscription.register(sub)} error -> error end end defp cur_txn(%__MODULE__{reference: ref}) do Process.get(ref, nil) end end