Metadata not refreshing when credential is updated (#1493)

* fix: Metadata not refreshing when credential is updated * increase timeout for assert_push_event metadata_ready * use dhis2 schema in tests * increase timeout * increase timeout * set timeout to 60 secs to accomodate CI * format changelog * undo wrongly fixed conflict * New credential doesn't appear in inspector until refresh (#1549) * WIP: update credential block from form * update changelog * update changelog --------- Co-authored-by: Taylor Downs <[email protected]> Co-authored-by: Taylor Downs <[email protected]>
OpenFn · Dec 13, 2023 · 600477f · 600477f
1 parent 7197f65
commit 600477f
Show file tree

Hide file tree

Showing 6 changed files with 128 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -27,6 +27,10 @@ and this project adheres to
 
 ### Fixed
 
+- New credential doesn't appear in inspector until refresh
+  [#1531](https://github.com/OpenFn/Lightning/issues/1531)
+- Metadata not refreshing when credential is updated
+  [#791](https://github.com/OpenFn/Lightning/issues/791)
 - Adjusted z-index for Monaco Editor's sibling element to resolve layout
   conflict [#1329](https://github.com/OpenFn/Lightning/issues/1329)
 - Demo script sets up example Runs with their log lines in a consistant order.

diff --git a/lib/lightning/credentials.ex b/lib/lightning/credentials.ex
@@ -108,6 +108,15 @@ defmodule Lightning.Credentials do
   """
   def get_credential!(id), do: Repo.get!(Credential, id)
 
+  def get_credential_by_project_credential(project_credential_id) do
+    query =
+      from c in Credential,
+        join: pc in assoc(c, :project_credentials),
+        on: pc.id == ^project_credential_id
+
+    Repo.one(query)
+  end
+
   @doc """
   Creates a credential.
 

diff --git a/lib/lightning_web/live/workflow_live/editor_pane.ex b/lib/lightning_web/live/workflow_live/editor_pane.ex
@@ -1,5 +1,6 @@
 defmodule LightningWeb.WorkflowLive.EditorPane do
   use LightningWeb, :live_component
+  alias Lightning.Credentials
   alias LightningWeb.JobLive.JobBuilderComponents
 
   attr :id, :string, required: true
@@ -38,7 +39,7 @@ defmodule LightningWeb.WorkflowLive.EditorPane do
           form[:adaptor].value
           |> Lightning.AdaptorRegistry.resolve_adaptor(),
         source: form[:body].value,
-        credential: form[:credential].value,
+        credential: fetch_credential(form[:project_credential_id].value),
         job_id: form[:id].value
       )
 
@@ -81,4 +82,9 @@ defmodule LightningWeb.WorkflowLive.EditorPane do
 
     {:noreply, socket}
   end
+
+  defp fetch_credential(project_credential_id) do
+    project_credential_id &&
+      Credentials.get_credential_by_project_credential(project_credential_id)
+  end
 end
diff --git a/lib/lightning_web/live/workflow_live/job_view.ex b/lib/lightning_web/live/workflow_live/job_view.ex
@@ -1,5 +1,6 @@
 defmodule LightningWeb.WorkflowLive.JobView do
   use LightningWeb, :component
+  alias Lightning.Credentials
   alias LightningWeb.WorkflowLive.EditorPane
 
   import LightningWeb.WorkflowLive.Components
@@ -73,7 +74,9 @@ defmodule LightningWeb.WorkflowLive.JobView do
         <div class="flex h-14 place-content-stretch">
           <div class="basis-1/3 flex items-center gap-4 pl-4">
             <.adaptor_block adaptor={@job.adaptor} />
-            <.credential_block credential={@job.credential} />
+            <.credential_block credential={
+              fetch_credential(@form[:project_credential_id].value)
+            } />
           </div>
           <div class="basis-1/3 font-semibold flex items-center justify-center">
             <%= @job.name %>
@@ -144,7 +147,10 @@ defmodule LightningWeb.WorkflowLive.JobView do
 
   defp credential_block(assigns) do
     ~H"""
-    <div class="flex items-center gap-2 whitespace-nowrap">
+    <div
+      id="modal-header-credential-block"
+      class="flex items-center gap-2 whitespace-nowrap"
+    >
       <%= if @credential do %>
         <Heroicons.lock_closed class="w-6 h-6 text-gray-500" />
 
@@ -197,4 +203,9 @@ defmodule LightningWeb.WorkflowLive.JobView do
     </div>
     """
   end
+
+  defp fetch_credential(project_credential_id) do
+    project_credential_id &&
+      Credentials.get_credential_by_project_credential(project_credential_id)
+  end
 end
diff --git a/test/lightning/credentials_test.exs b/test/lightning/credentials_test.exs
@@ -256,6 +256,21 @@ defmodule Lightning.CredentialsTest do
     end
   end
 
+  describe "get_credential_by_project_credential/1" do
+    test "sreturns the credential with given project_credential id" do
+      refute Credentials.get_credential_by_project_credential(
+               Ecto.UUID.generate()
+             )
+
+      project_credential = insert(:project_credential)
+
+      credential =
+        Credentials.get_credential_by_project_credential(project_credential.id)
+
+      assert credential.id == project_credential.credential.id
+    end
+  end
+
   describe "create_credential/1" do
     test "suceeds with raw schema" do
       valid_attrs = %{

diff --git a/test/lightning_web/live/workflow_live/editor_test.exs b/test/lightning_web/live/workflow_live/editor_test.exs
@@ -41,6 +41,20 @@ defmodule LightningWeb.WorkflowLive.EditorTest do
     project: project,
     workflow: workflow
   } do
+    project_credential =
+      insert(:project_credential,
+        project: project,
+        credential:
+          build(:credential,
+            name: "dummytestcred",
+            schema: "http",
+            body: %{
+              username: "test",
+              password: "test"
+            }
+          )
+      )
+
     job = workflow.jobs |> hd()
 
     {:ok, view, _html} =
@@ -70,6 +84,32 @@ defmodule LightningWeb.WorkflowLive.EditorTest do
     assert {"phx-hook", "JobEditor"} in actual_attrs
     assert {"phx-target", "1"} in actual_attrs
     assert {"phx-update", "ignore"} in actual_attrs
+
+    # try changing the assigned credential
+
+    credential_block =
+      element(view, "#modal-header-credential-block") |> render()
+
+    assert credential_block =~ "No Credential"
+    refute credential_block =~ project_credential.credential.name
+
+    view
+    |> form("#workflow-form",
+      workflow: %{
+        jobs: %{
+          "0" => %{
+            "project_credential_id" => project_credential.id
+          }
+        }
+      }
+    )
+    |> render_change()
+
+    credential_block =
+      element(view, "#modal-header-credential-block") |> render()
+
+    refute credential_block =~ "No Credential"
+    assert credential_block =~ project_credential.credential.name
   end
 
   describe "manual runs" do
@@ -393,6 +433,20 @@ defmodule LightningWeb.WorkflowLive.EditorTest do
       project: project,
       workflow: workflow
     } do
+      project_credential =
+        insert(:project_credential,
+          project: project,
+          credential:
+            build(:credential,
+              schema: "http",
+              body: %{
+                baseUrl: "http://localhost:4002",
+                username: "test",
+                password: "test"
+              }
+            )
+        )
+
       job = workflow.jobs |> hd()
 
       {:ok, view, _html} =
@@ -408,6 +462,32 @@ defmodule LightningWeb.WorkflowLive.EditorTest do
              |> render_click("request_metadata", %{})
 
       assert_push_event(view, "metadata_ready", %{"error" => "no_credential"})
+
+      view
+      |> form("#workflow-form",
+        workflow: %{
+          jobs: %{
+            "0" => %{
+              "project_credential_id" => project_credential.id
+            }
+          }
+        }
+      )
+      |> render_change()
+
+      assert view
+             |> with_target("#job-editor-pane-#{job.id}")
+             |> render_click("request_metadata", %{})
+
+      # set timeout to 60 secs because of CI
+      assert_push_event(
+        view,
+        "metadata_ready",
+        %{
+          "error" => "no_metadata_function"
+        },
+        60000
+      )
     end
   end
 end