initial support for an Elixir module. Elixir code now supported in form of modules.

Author: gorenje

priv/testflows/963265474ffd443b/flows.json

@@ -0,0 +1 @@
+[{"disabled":false,"env":[],"id":"963265474ffd443b","info":"","label":"[.elixir] support basic module code","type":"tab"},{"crontab":"","id":"571e4daf846a8006","name":"","once":false,"onceDelay":0.1,"payload":"11","payloadType":"num","props":[{"p":"payload"}],"repeat":"","topic":"","type":"inject","wires":[["34ae86365c57eb65","0aac6be93a243378"]],"x":223,"y":491,"z":"963265474ffd443b"},{"code":"defmodule MyModule do\n  @typedoc \"This type\"\n  @typedoc since: \"1.1.0\"\n  @type t :: term\n\n  @doc \"Hello world\"\n  @doc since: \"1.1.0\"\n  def hello do\n    \"world\"\n  end\n\n  @doc \"\"\"\n  Sums `a` to `b`.\n  \"\"\"\n  def sum(a, b) do\n    a + b\n  end\n\n  def minus( c, d ) do \n    d - c\n  end\nend","id":"ab4986a24e578611","module_name":"MyModule","name":"","type":"elxmodule","wires":[],"x":370,"y":205,"z":"963265474ffd443b"},{"finalize":"","func":"#{ <<\"payload\">> := Payload } = Msg,\nMsg#{ <<\"payload\">> => 'Elixir.MyModule':minus('Elixir.MyModule':sum(123,Payload),1) }\n","id":"34ae86365c57eb65","initialize":"","libs":[],"name":"function 1","noerr":0,"outputs":1,"timeout":0,"type":"function","wires":[["9c1a04aa4e37eb28"]],"x":382,"y":456,"z":"963265474ffd443b"},{"id":"9c1a04aa4e37eb28","ignore_failure_if_succeed":false,"name":"","rules":[{"p":"payload","pt":"msg","t":"eql","to":"-133","tot":"num"}],"type":"ut-assert-values","wires":[[]],"x":641,"y":386,"z":"963265474ffd443b"},{"finalize":"","func":"Msg#{ <<\"payload\">> => 'Elixir.MyModule':hello() }\n","id":"0aac6be93a243378","initialize":"","libs":[],"name":"function 2","noerr":0,"outputs":1,"timeout":0,"type":"function","wires":[["412ccdda2ab5a0db"]],"x":382,"y":526,"z":"963265474ffd443b"},{"id":"412ccdda2ab5a0db","ignore_failure_if_succeed":false,"name":"","rules":[{"p":"payload","pt":"msg","t":"eql","to":"world","tot":"str"}],"type":"ut-assert-values","wires":[[]],"x":611,"y":596,"z":"963265474ffd443b"}]

src/ered_startup.erl

@@ -141,8 +141,8 @@ install_module_node_code([], _WsName) ->
     ok;
 install_module_node_code([NodeDef | ModeNodeDefs], WsName) ->
     case {is_module_node(NodeDef), disabled(NodeDef)} of
-        {true, false} ->
-            ered_node_erlmodule:install(NodeDef, WsName);
+        {{true, ModuleHandler}, false} ->
+            ModuleHandler:install(NodeDef, WsName);
         _ ->
             ignore
     end,
@@ -361,6 +361,7 @@ node_type_to_module(<<"range">>)             -> ered_node_range;
 node_type_to_module(<<"erlprocess">>)        -> ered_node_erlprocess;
 node_type_to_module(<<"erlcaptureio">>)      -> ered_node_erlcaptureio;
 node_type_to_module(<<"amqp-in">>)           -> ered_node_amqp_in;
+node_type_to_module(<<"elxmodule">>)         -> ered_node_elxmodule;
 
 %% TODO: don't do this again! The kafka nodes are based on an existing
 %% TODO: Node-RED node package --> @asinino/node-red-kafkajs that uses
@@ -431,6 +432,8 @@ is_supervisor(_) ->
 is_module_node(NodeDef) when is_map(NodeDef) ->
     is_module_node(maps:get(<<"type">>, NodeDef));
 is_module_node(<<"erlmodule">>) ->
-    true;
+    {true, ered_node_erlmodule};
+is_module_node(<<"elxmodule">>) ->
+    {true, ered_node_elxmodule};
 is_module_node(_) ->
-    false.
+    {false, undefined}.

src/nodes/ered_node_elxmodule.erl

@@ -0,0 +1,118 @@
+-module(ered_node_elxmodule).
+
+-behaviour(ered_node).
+
+-include("ered_nodes.hrl").
+
+-export([start/2]).
+-export([handle_msg/2]).
+-export([handle_event/2]).
+
+-export([install/2]).
+
+%%
+%% Erlang-Red Elixir module node for defining modules in Elixir
+%%
+%% This does not nothing except for install code into the BEAM.
+%%
+%% The install process isn't managed by the node, instead the startup
+%% procedure does the installation. That is because there has to be an
+%% order maintained in how things happen. Another node wanting to use this
+%% code must have that code already installed.
+%%
+
+-import(ered_nodered_comm, [
+    node_status/5,
+    node_status_clear/2,
+    post_exception_or_debug/3,
+    send_out_debug_warning/2
+]).
+
+-import(ered_erlmodule_exchange, [
+    remove_module_for_nodeid/1,
+    add_module/2
+]).
+
+%%
+%%
+start(
+    #{<<"module_name">> := ModuleName} = NodeDef,
+    WsName
+) when ModuleName =:= <<>>; ModuleName =:= "" ->
+    node_status(
+        WsName,
+        NodeDef,
+        "module name not defined",
+        "red",
+        "dot"
+    ),
+    ered_node:start(NodeDef, ered_node_ignore);
+start(NodeDef, _WsName) ->
+    ered_node:start(NodeDef, ?MODULE).
+
+%%
+%%
+handle_event(?StopEvent, #{<<"id">> := NodeId} = NodeDef) ->
+    remove_module_for_nodeid(NodeId),
+    NodeDef;
+handle_event(_, NodeDef) ->
+    NodeDef.
+
+%%
+%%
+handle_msg(_, NodeDef) ->
+    {unhandled, NodeDef}.
+
+%%
+%%
+install(
+    #{
+        <<"module_name">> := ModBinaryName,
+        <<"code">> := ModuleCode,
+        <<"id">> := NodeId
+    } = NodeDef,
+    WsName
+) when ModBinaryName =/= <<>>, ModBinaryName =/= "" ->
+    ModuleName = binary_to_atom(ModBinaryName),
+
+    FileName = binary_to_list(
+        list_to_binary(
+            io_lib:format("/tmp/~s.ex", [ModuleName])
+        )
+    ),
+
+    file:write_file(FileName, ModuleCode),
+
+    try
+        case 'Elixir.Code':compile_file(list_to_binary(FileName), nil) of
+            [] ->
+                node_status(WsName, NodeDef, "no code found", "blue", "dot");
+            [{FullModuleName, _Binary}] ->
+                add_module(NodeId, FullModuleName),
+                node_status(WsName, NodeDef, "installed", "green", "dot"),
+                spawn(fun() -> clear_status_after_one_sec(WsName, NodeDef) end);
+            R ->
+                post_exception_or_debug(
+                    NodeDef,
+                    ?AddWsName(#{somethingelse => R}),
+                    "something else"
+                ),
+                node_status(WsName, NodeDef, "something else", "blue", "ring")
+        end
+    catch
+        E:F:S ->
+            node_status(WsName, NodeDef, "compile failed", "red", "dot"),
+            post_exception_or_debug(
+                NodeDef,
+                ?AddWsName(#{exception => E, error => F, stacktrace => S}),
+                "compile failed"
+            )
+    end;
+install(_NodeDef, _WsName) ->
+    ignore.
+
+%%
+%%
+clear_status_after_one_sec(WsName, NodeDef) ->
+    timer:sleep(1000),
+    node_status_clear(WsName, NodeDef).