Create ElixirRuntime Prefix To Prevent Name Clashes

Author: BradleyLyman

elixir_runtime/lib/application.ex renamed to elixir_runtime/lib/elixir_runtime/application.ex

@@ -1,7 +1,7 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Runtime.Application do
+defmodule ElixirRuntime.Application do
   @moduledoc """
   The main OTP Application for the Elixir Runtime.
 
@@ -15,8 +15,11 @@ defmodule Runtime.Application do
 
   def start(_type, _args) do
     children = [
-      {Monitor.Server, [name: Monitor, client: LambdaServiceClient]},
-      {Runtime, [client: LambdaServiceClient]}
+      {
+        ElixirRuntime.Monitor.Server,
+        [name: ElixirRuntime.Monitor, client: ElixirRuntime.LambdaServiceClient]
+      },
+      {ElixirRuntime.Loop, [client: ElixirRuntime.LambdaServiceClient]}
     ]
 
     Supervisor.start_link(children, strategy: :one_for_one)

elixir_runtime/lib/service_client.ex renamed to elixir_runtime/lib/elixir_runtime/lambda_service_client.ex

@@ -1,23 +1,23 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule LambdaServiceClient do
+defmodule ElixirRuntime.LambdaServiceClient do
   @moduledoc """
   This module represents an HTTP client for the Lambda Runtime service.
   """
 
   require Logger
-  @behaviour Runtime.Client
-  @behaviour Monitor.Client
+  @behaviour ElixirRuntime.Loop.Client
+  @behaviour ElixirRuntime.Monitor.Client
 
   def service_endpoint do
     System.get_env("AWS_LAMBDA_RUNTIME_API")
   end
 
   @impl true
   @spec invocation_error(
-          Monitor.Client.error(),
-          Monitor.Client.id()
+          ElixirRuntime.Monitor.Client.error(),
+          ElixirRuntime.Monitor.Client.id()
         ) :: no_return
   def invocation_error(err_msg, id) do
     url =

elixir_runtime/lib/runtime.ex renamed to elixir_runtime/lib/elixir_runtime/loop.ex

@@ -1,7 +1,7 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Runtime do
+defmodule ElixirRuntime.Loop do
   @moduledoc """
   The main Runtime loop process.
 
@@ -13,14 +13,15 @@ defmodule Runtime do
   use Task, restart: :permanent
   require Logger
   alias __MODULE__
-  alias Runtime.Handler, as: Handler
+  alias Loop.Handler
+  alias ElixirRuntime.Monitor
 
   @type client :: module()
 
   @doc "spawn a task to run the main loop asynchronously"
   def start_link(args \\ []) do
     client = Keyword.get(args, :client)
-    Task.start_link(Runtime, :main, [client])
+    Task.start_link(Loop, :main, [client])
   end
 
   @doc "the main entrypoint for the runtime"

elixir_runtime/lib/runtime/client.ex renamed to elixir_runtime/lib/elixir_runtime/loop/client.ex

@@ -1,7 +1,7 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Runtime.Client do
+defmodule ElixirRuntime.Loop.Client do
   @moduledoc "The Lambda Runtime Service Client behavior this runtime requires"
 
   @type id :: String.t()

elixir_runtime/lib/runtime/handler.ex renamed to elixir_runtime/lib/elixir_runtime/loop/handler.ex

@@ -1,7 +1,7 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Runtime.Handler do
+defmodule ElixirRuntime.Loop.Handler do
   @moduledoc """
   This module defines the Handler struct which is used to represent the
   module-function atom pair which identifies a client's entrypoint.
@@ -20,8 +20,8 @@ defmodule Runtime.Handler do
   Manually create a handler from two atoms.
   ## Examples
 
-    iex> Runtime.Handler.new(Elixir.Example, :handle)
-    %Runtime.Handler{module: Elixir.Example, function: :handle}
+    iex> ElixirRuntime.Loop.Handler.new(Elixir.Example, :handle)
+    %ElixirRuntime.Loop.Handler{module: Elixir.Example, function: :handle}
   """
   def new(module, function) when is_atom(module) and is_atom(function) do
     %Handler{module: module, function: function}
@@ -32,8 +32,8 @@ defmodule Runtime.Handler do
   ## Examples
 
       iex> System.put_env("_HANDLER", "Elixir.Example:handle")
-      iex> Runtime.Handler.configured()
-      %Runtime.Handler{module: Elixir.Example, function: :handle}
+      iex> ElixirRuntime.Loop.Handler.configured()
+      %ElixirRuntime.Loop.Handler{module: Elixir.Example, function: :handle}
   """
   def configured do
     [module, function] = handler_string() |> String.split(":", trim: true)
@@ -46,8 +46,8 @@ defmodule Runtime.Handler do
 
   Create a handler for String.trim and invoke it to get a result.
       iex> defmodule Example, do: def func(body, _context), do: body
-      iex> handler = Runtime.Handler.new(Example, :func)
-      iex> handler |> Runtime.Handler.invoke(%{msg: "hello"}, %{})
+      iex> handler = ElixirRuntime.Loop.Handler.new(Example, :func)
+      iex> handler |> ElixirRuntime.Loop.Handler.invoke(%{msg: "hello"}, %{})
       %{msg: "hello"}
   """
   def invoke(%Handler{module: module, function: function}, body, context)

elixir_runtime/lib/runtime/monitor.ex renamed to elixir_runtime/lib/elixir_runtime/loop/monitor.ex

@@ -1,7 +1,7 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Runtime.Monitor do
+defmodule ElixirRuntime.Loop.Monitor do
   @moduledoc """
   The Runtime requires a stateful monitor which will observe any
   failures and call the proper backend APIs.

elixir_runtime/lib/monitor.ex renamed to elixir_runtime/lib/elixir_runtime/monitor.ex

@@ -1,30 +1,38 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Monitor do
+defmodule ElixirRuntime.Monitor do
   @moduledoc """
   The monitor is responsible for reporting errors in the Elixir process to
   the AWS Lambda runtime service.
   The monitor is a stateful process which tracks the request ID for the
   currently-executing function.
   """
 
-  @behaviour Runtime.Monitor
-
-  alias __MODULE__
+  @behaviour ElixirRuntime.Loop.Monitor
 
+  @doc """
+  Tell the monitor server to watch the given process.
+  """
   @impl true
-  def watch(monitor \\ Monitor, process) do
+  def watch(monitor \\ ElixirRuntime.Monitor, process) when is_pid(process) do
     GenServer.call(monitor, {:watch, process})
   end
 
+  @doc """
+  Reset the monitor back to it's initial state, forgetting any currently-known
+  ingestor IDs.
+  """
   @impl true
-  def reset(monitor \\ Monitor) do
+  def reset(monitor \\ ElixirRuntime.Monitor) do
     GenServer.call(monitor, :reset)
   end
 
+  @doc """
+  Notify the monitor that the runtime loop has started processing an invocation.
+  """
   @impl true
-  def started(monitor \\ Monitor, id) do
+  def started(monitor \\ ElixirRuntime.Monitor, id) do
     GenServer.call(monitor, {:start_invocation, id})
   end
 end

elixir_runtime/lib/monitor/client.ex renamed to elixir_runtime/lib/elixir_runtime/monitor/client.ex

@@ -1,7 +1,7 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Monitor.Client do
+defmodule ElixirRuntime.Monitor.Client do
   @moduledoc """
   This module defines the client behavior required by the runtime monitor.
   """

elixir_runtime/lib/monitor/error.ex renamed to elixir_runtime/lib/elixir_runtime/monitor/error.ex

@@ -1,7 +1,7 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Monitor.Error do
+defmodule ElixirRuntime.Monitor.Error do
   @moduledoc """
   This module defines the Error struct which is used to communicate runtime
   errors to the Lambda Runtime Service.

elixir_runtime/lib/monitor/server.ex renamed to elixir_runtime/lib/elixir_runtime/monitor/server.ex

@@ -1,11 +1,11 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Monitor.Server do
+defmodule ElixirRuntime.Monitor.Server do
   use GenServer
 
   alias __MODULE__
-  alias Monitor.State, as: State
+  alias ElixirRuntime.Monitor.State, as: State
 
   def start_link(args) do
     client = Keyword.get(args, :client)

elixir_runtime/lib/monitor/state.ex renamed to elixir_runtime/lib/elixir_runtime/monitor/state.ex

@@ -1,7 +1,9 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Monitor.State do
+defmodule ElixirRuntime.Monitor.State do
+  alias ElixirRuntime.Monitor
+
   @type monitor_state ::
           {:not_started, Monitor.Client.t()}
           | {:in_progress, Monitor.Client.id(), Monitor.Client.t()}

elixir_runtime/mix.exs

@@ -19,7 +19,8 @@ defmodule Lambda.MixProject do
       source_url: "https://github.com/aws-samples/aws-lambda-elixir-runtime",
       homepage_url: "https://github.com/aws-samples/aws-lambda-elixir-runtime",
       docs: [
-        source_url_pattern: "https://github.com/aws-samples/aws-lambda-elixir-runtime/blob/master/elixir_runtime/%{path}#L%{line}",
+        source_url_pattern:
+          "https://github.com/aws-samples/aws-lambda-elixir-runtime/blob/master/elixir_runtime/%{path}#L%{line}",
         main: "readme",
         extras: [
           "README.md",
@@ -32,7 +33,7 @@ defmodule Lambda.MixProject do
   # Run "mix help compile.app" to learn about applications.
   def application do
     [
-      mod: {Runtime.Application, []},
+      mod: {ElixirRuntime.Application, []},
       extra_applications: [:logger, :inets]
     ]
   end

elixir_runtime/test/application_test.exs renamed to elixir_runtime/test/elixir_runtime/application_test.exs

@@ -1,14 +1,14 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Application.Test do
+defmodule ElixirRuntime.Application.Test do
   use ExUnit.Case
 
   # This test suite is for the end-to-end behavior of the elixir runtime
   # application. The tests leverage an in-memory client which echos requests
   # back to the test process for validation.
 
-  def echo_msg(body = %{"msg" => message}, _context), do: message
+  def echo_msg(_request = %{"msg" => message}, _context), do: message
 
   defmodule MyCustomBug do
     defexception [:message]
@@ -29,7 +29,7 @@ defmodule Application.Test do
     invocation = Support.FakeInvoke.with_message("hello world")
     expected_id = Support.FakeInvoke.id(invocation)
 
-    System.put_env("_HANDLER", "Elixir.Application.Test:echo_msg")
+    System.put_env("_HANDLER", "Elixir.ElixirRuntime.Application.Test:echo_msg")
     start_with_invocations([invocation])
 
     assert_receive {:next, ^invocation}
@@ -40,11 +40,19 @@ defmodule Application.Test do
     invoke = Support.FakeInvoke.with_message("some message")
     expected_id = Support.FakeInvoke.id(invoke)
 
-    System.put_env("_HANDLER", "Elixir.Application.Test:logical_bug_handler")
+    System.put_env(
+      "_HANDLER",
+      "Elixir.ElixirRuntime.Application.Test:logical_bug_handler"
+    )
+
     start_with_invocations([invoke])
 
     assert_receive {:invocation_error, msg, ^expected_id}
-    assert String.contains?(msg, "FunctionElixir.Application.Test.MyCustomBug")
+
+    assert String.contains?(
+             msg,
+             "FunctionElixir.ElixirRuntime.Application.Test.MyCustomBug"
+           )
   end
 
   test "a missing handler string" do
@@ -80,15 +88,16 @@ defmodule Application.Test do
   # This is the same process as starting the application but it's done
   # piece-by-piece here so the InMemoryClient can be passed into the Runtime
   # and monitor.
-  defp start_with_invocations(invocations \\ []) do
+  defp start_with_invocations(invocations) do
     start_supervised!(
       {Support.InMemoryClient, %{pending: invocations, listener: self()}}
     )
 
-    start_supervised!(
-      {Monitor.Server, [client: Support.InMemoryClient, name: Monitor]}
-    )
+    start_supervised!({
+      ElixirRuntime.Monitor.Server,
+      [client: Support.InMemoryClient, name: ElixirRuntime.Monitor]
+    })
 
-    start_supervised!({Runtime, [client: Support.InMemoryClient]})
+    start_supervised!({ElixirRuntime.Loop, [client: Support.InMemoryClient]})
   end
 end

elixir_runtime/test/runtime/handler_test.exs renamed to elixir_runtime/test/elixir_runtime/loop/handler_test.exs

@@ -1,7 +1,7 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Runtime.Handler.Test do
+defmodule ElixirRuntime.Loop.Handler.Test do
   use ExUnit.Case
-  doctest Runtime.Handler
+  doctest ElixirRuntime.Loop.Handler
 end

elixir_runtime/test/monitor/error_test.exs renamed to elixir_runtime/test/elixir_runtime/monitor/error_test.exs

@@ -1,11 +1,11 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Monitor.Error.Test do
+defmodule ElixirRuntime.Monitor.Error.Test do
   use ExUnit.Case, async: true
-  doctest Monitor.Error
+  doctest ElixirRuntime.Monitor.Error
 
-  alias Monitor.Error, as: Error
+  alias ElixirRuntime.Monitor.Error
 
   setup do
     {:current_stacktrace, stacktrace} =

elixir_runtime/test/monitor/state_test.exs renamed to elixir_runtime/test/elixir_runtime/monitor/state_test.exs

@@ -1,14 +1,15 @@
 # Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: MIT-0
 
-defmodule Monitor.State.Test do
+defmodule ElixirRuntime.Monitor.State.Test do
   use ExUnit.Case, async: true
-  doctest Monitor.State
+  doctest ElixirRuntime.Monitor.State
 
-  alias Monitor.State, as: State
+  alias ElixirRuntime.Monitor
+  alias Monitor.State
 
   defmodule FakeClient do
-    @behaviour Monitor.Client
+    @behaviour ElixirRuntime.Monitor.Client
 
     @impl true
     def init_error(err_msg) do

elixir_runtime/test/support/fake_invoke.ex

@@ -16,7 +16,7 @@ defmodule Support.FakeInvoke do
   def body({_id, body, _context}), do: body
 
   defp generated_id do
-    id = Integer.to_string(:random.uniform(100_000_000), 32)
+    id = Integer.to_string(:rand.uniform(100_000_000), 32)
     "TestId-#{id}"
   end
 end