Remote Intellisense #2217

cristineguadelupe · 2023-09-21T08:44:27Z

Initial intellisense support for remote nodes
Remote modules with its docs and its exported functions with its docs

github-actions · 2023-09-21T08:48:44Z

Uffizzi Preview deployment-36494 was deleted.

lib/livebook/intellisense/docs.ex

jonatanklosko · 2023-09-21T09:07:15Z

lib/livebook/intellisense/signature_matcher.ex

@@ -19,11 +19,12 @@ defmodule Livebook.Intellisense.SignatureMatcher do
          {:ok, list(signature_info()), active_argument :: non_neg_integer()} | :error
  def get_matching_signatures(hint, intellisense_context) do
    %{env: env} = intellisense_context
+    node = intellisense_context.node


We need to pass the node as an option here too. intellisense_context comes from the node that does evaluation, and for the remote cell that's not the node we want to use.

jonatanklosko · 2023-09-21T09:12:27Z

test/livebook/intellisense_test.exs

+    File.rm_rf!(@tmp_dir)
+    File.mkdir_p!(@tmp_dir)
+    File.write!("#{@tmp_dir}/Elixir.RemoteModule.beam", bytecode)
+
+    true = :erpc.call(node, :code, :set_path, [:code.get_path() ++ [~c"#{@tmp_dir}"]])
+    {:ok, _} = :erpc.call(node, :application, :ensure_all_started, [:elixir])
+    {:module, RemoteModule} = :erpc.call(node, :code, :load_file, [:"Elixir.RemoteModule"])
+    :loaded = :erpc.call(node, :code, :module_status, [:"Elixir.RemoteModule"])


To simplify we could use Livebook.Runtime.ElixirStandalone. Start a runtime, evaluate code that defines the module, and then use runtime.node.

That's a good idea but we can end-up accidentally polluting the node in tests and not find bugs. So I would try to keep the remote node as "clean" as possible, if that makes any sense.

All the other tests run in the context of Livebook itself, so there is definitely much more polluted in that sense.

What do you mean? To be clear, what I mean is that, if the remote node has Livebook's runtime, then we can accidentally do :erpc.call(node(), SomeLivebookModule) which will not be available in actual remote nodes, only in tests.

What do you mean?

That when testing completion all the livebook modules could be listed, we just have the tests such that this is never the case.

then we can accidentally do :erpc.call(node(), SomeLivebookModule)

I see, we are clearly just fetching docs info so I'm not worried about that, but that's a fair point, we can keep the minimal version.

jonatanklosko · 2023-09-21T09:13:20Z

test/livebook/intellisense_test.exs

      }
    end
  end

+  setup_all do


Let's move this to the describe block.

I don't think we can have a setup_all inside the describe block. Therefore my proposal is to keep these tests in a separate file.

We could do a separate module in the same file just so it's still grouped together.

Separate module or separate file are both fine by me!

I moved it back to a separate file

jonatanklosko · 2023-09-21T09:14:11Z

lib/livebook/intellisense/docs.ex

    members = MapSet.new(members)
    kinds = opts[:kinds] || [:function, :macro, :type]

    specs =
      with true <- :function in kinds or :macro in kinds,
-           {:ok, specs} <- Code.Typespec.fetch_specs(module) do
+           {:ok, specs} <- :erpc.call(node, :"Elixir.Code.Typespec", :fetch_specs, [module]) do


Suggested change

{:ok, specs} <- :erpc.call(node, :"Elixir.Code.Typespec", :fetch_specs, [module]) do

{:ok, specs} <- :erpc.call(node, Code.Typespec, :fetch_specs, [module]) do

josevalim · 2023-09-21T10:37:08Z

lib/livebook/intellisense/docs.ex

-    case Code.fetch_docs(module) do
+  @spec get_module_documentation(module(), node()) :: documentation()
+  def get_module_documentation(module, node) do
+    case :erpc.call(node, :"Elixir.Code", :fetch_docs, [module]) do


Suggested change

case :erpc.call(node, :"Elixir.Code", :fetch_docs, [module]) do

case :erpc.call(node, Code, :fetch_docs, [module]) do

josevalim · 2023-09-21T10:38:00Z

lib/livebook/intellisense/docs.ex

        Map.new(specs)
      else
        _ -> %{}
      end

    type_specs =
      with true <- :type in kinds,
-           {:ok, types} <- Code.Typespec.fetch_types(module) do
+           {:ok, types} <- :erpc.call(node, :"Elixir.Code.Typespec", :fetch_types, [module]) do


Suggested change

{:ok, types} <- :erpc.call(node, :"Elixir.Code.Typespec", :fetch_types, [module]) do

{:ok, types} <- :erpc.call(node, Code.Typespec, :fetch_types, [module]) do

josevalim · 2023-09-21T10:38:10Z

lib/livebook/intellisense/docs.ex

@@ -99,7 +100,7 @@ defmodule Livebook.Intellisense.Docs do
        _ -> %{}
      end

-    case Code.fetch_docs(module) do
+    case :erpc.call(node, :"Elixir.Code", :fetch_docs, [module]) do


Suggested change

case :erpc.call(node, :"Elixir.Code", :fetch_docs, [module]) do

case :erpc.call(node, Code, :fetch_docs, [module]) do

josevalim · 2023-09-21T10:38:50Z

lib/livebook/intellisense/identifier_matcher.ex

-      funs = funs || exports(mod)
+    node = ctx.intellisense_context.node
+
+    if :erpc.call(node, :"Elixir.Code", :ensure_loaded?, [mod]) do


Suggested change

if :erpc.call(node, :"Elixir.Code", :ensure_loaded?, [mod]) do

if :erpc.call(node, Code, :ensure_loaded?, [mod]) do

josevalim · 2023-09-21T10:39:36Z

lib/livebook/intellisense/identifier_matcher.ex

+    loaded = :erpc.call(node, :"Elixir.Code", :ensure_loaded?, [mod])
+    exported = :erpc.call(node, :"Elixir.Kernel", :function_exported?, [mod, :__info__, 1])


Suggested change

loaded = :erpc.call(node, :"Elixir.Code", :ensure_loaded?, [mod])

exported = :erpc.call(node, :"Elixir.Kernel", :function_exported?, [mod, :__info__, 1])

loaded = :erpc.call(node, Code, :ensure_loaded?, [mod])

exported = :erpc.call(node, :erlang, :function_exported, [mod, :__info__, 1])

josevalim · 2023-09-21T10:41:05Z

test/livebook/intellisense_test.exs

+    File.mkdir_p!(@tmp_dir)
+    File.write!("#{@tmp_dir}/Elixir.RemoteModule.beam", bytecode)
+
+    true = :erpc.call(node, :code, :set_path, [:code.get_path() ++ [~c"#{@tmp_dir}"]])


Suggested change

true = :erpc.call(node, :code, :set_path, [:code.get_path() ++ [~c"#{@tmp_dir}"]])

true = :erpc.call(node, :code, :set_path, [[~c"#{@tmp_dir}" | :code.get_path()]])

Actually, let's prune this path a bit:

Suggested change

true = :erpc.call(node, :code, :set_path, [:code.get_path() ++ [~c"#{@tmp_dir}"]])

build_path = Mix.Project.build_path() |> String.to_charlist()

paths = Enum.reject(:code.get_path, &List.starts_with?(&1, build_path))

true = :erpc.call(node, :code, :set_path, [[~c"#{@tmp_dir}" | paths]])

This will make sure the node does not have any of our deps either!

cristineguadelupe added 3 commits September 20, 2023 20:44

Remote Intellisense - modules and its docs

462f723

Remote Intellisense - functions

a48642d

Move tests

c4a2455

jonatanklosko reviewed Sep 21, 2023

View reviewed changes

lib/livebook/intellisense/docs.ex Show resolved Hide resolved

jonatanklosko reviewed Sep 21, 2023

View reviewed changes

josevalim reviewed Sep 21, 2023

View reviewed changes

Applying suggestions

11fc472

josevalim approved these changes Sep 21, 2023

View reviewed changes

jonatanklosko approved these changes Sep 21, 2023

View reviewed changes

cristineguadelupe merged commit 76139d7 into livebook-dev:main Sep 21, 2023
7 checks passed

cristineguadelupe deleted the cg-remote-intellisense branch September 21, 2023 17:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remote Intellisense #2217

Remote Intellisense #2217

cristineguadelupe commented Sep 21, 2023

github-actions bot commented Sep 21, 2023 •

edited

Loading

jonatanklosko Sep 21, 2023

jonatanklosko Sep 21, 2023

josevalim Sep 21, 2023

jonatanklosko Sep 21, 2023

josevalim Sep 21, 2023

jonatanklosko Sep 21, 2023

jonatanklosko Sep 21, 2023

josevalim Sep 21, 2023

jonatanklosko Sep 21, 2023

josevalim Sep 21, 2023

cristineguadelupe Sep 21, 2023

jonatanklosko Sep 21, 2023

josevalim Sep 21, 2023

josevalim Sep 21, 2023

josevalim Sep 21, 2023

josevalim Sep 21, 2023

josevalim Sep 21, 2023

josevalim Sep 21, 2023

josevalim Sep 21, 2023

	{:ok, specs} <- :erpc.call(node, :"Elixir.Code.Typespec", :fetch_specs, [module]) do
	{:ok, specs} <- :erpc.call(node, Code.Typespec, :fetch_specs, [module]) do

	case :erpc.call(node, :"Elixir.Code", :fetch_docs, [module]) do
	case :erpc.call(node, Code, :fetch_docs, [module]) do

	{:ok, types} <- :erpc.call(node, :"Elixir.Code.Typespec", :fetch_types, [module]) do
	{:ok, types} <- :erpc.call(node, Code.Typespec, :fetch_types, [module]) do

	if :erpc.call(node, :"Elixir.Code", :ensure_loaded?, [mod]) do
	if :erpc.call(node, Code, :ensure_loaded?, [mod]) do

		loaded = :erpc.call(node, :"Elixir.Code", :ensure_loaded?, [mod])
		exported = :erpc.call(node, :"Elixir.Kernel", :function_exported?, [mod, :__info__, 1])

	true = :erpc.call(node, :code, :set_path, [:code.get_path() ++ [~c"#{@tmp_dir}"]])
	true = :erpc.call(node, :code, :set_path, [[~c"#{@tmp_dir}" \| :code.get_path()]])

-    true = :erpc.call(node, :code, :set_path, [:code.get_path() ++ [~c"#{@tmp_dir}"]])
+    build_path = Mix.Project.build_path() |> String.to_charlist()
+    paths = Enum.reject(:code.get_path, &List.starts_with?(&1, build_path))
+    true = :erpc.call(node, :code, :set_path, [[~c"#{@tmp_dir}" | paths]])

Remote Intellisense #2217

Remote Intellisense #2217

Conversation

cristineguadelupe commented Sep 21, 2023

github-actions bot commented Sep 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 21, 2023 •

edited

Loading