Improve the usage of app deployments within the UI (#3151)

Author: aleDsz

lib/livebook/hubs/team_client.ex

@@ -104,6 +104,14 @@ defmodule Livebook.Hubs.TeamClient do
     GenServer.call(registry_name(id), :get_app_deployments)
   end
 
+  @doc """
+  Returns an app deployment from given data.
+  """
+  @spec get_app_deployment(String.t(), String.t(), String.t()) :: Teams.AppDeployment.t() | nil
+  def get_app_deployment(id, slug, deployment_group_id) do
+    GenServer.call(registry_name(id), {:get_app_deployment, slug, deployment_group_id})
+  end
+
   @doc """
   Returns a list of cached app deployments that should be deployed on
   this instance.
@@ -279,6 +287,13 @@ defmodule Livebook.Hubs.TeamClient do
     {:reply, state.app_deployments, state}
   end
 
+  def handle_call({:get_app_deployment, slug, deployment_group_id}, _caller, state) do
+    case fetch_app_deployment_from_slug(slug, deployment_group_id, state) do
+      {:ok, app_deployment} -> {:reply, app_deployment, state}
+      state -> {:reply, nil, state}
+    end
+  end
+
   def handle_call(:get_agent_app_deployments, _caller, state) do
     if state.deployment_group_id do
       app_deployments =
@@ -341,7 +356,8 @@ defmodule Livebook.Hubs.TeamClient do
   def handle_call({:check_app_access, groups, slug}, _caller, state) do
     if id = state.deployment_group_id do
       with {:ok, deployment_group} <- fetch_deployment_group(id, state),
-           {:ok, app_deployment} <- fetch_app_deployment_from_slug(slug, state) do
+           {:ok, app_deployment} <-
+             fetch_app_deployment_from_slug(slug, deployment_group.id, state) do
         app_access? =
           not deployment_group.teams_auth or
             not deployment_group.groups_auth or
@@ -568,7 +584,8 @@ defmodule Livebook.Hubs.TeamClient do
       groups_auth: deployment_group.groups_auth,
       deploy_auth: deployment_group.deploy_auth,
       authorization_groups: authorization_groups,
-      deployment_users: deployment_users
+      deployment_users: deployment_users,
+      deployed_apps_counter: deployment_group.deployed_apps_counter
     }
   end
 
@@ -587,7 +604,8 @@ defmodule Livebook.Hubs.TeamClient do
       url: nullify(deployment_group_created.url),
       teams_auth: deployment_group_created.teams_auth,
       authorization_groups: [],
-      deployment_users: []
+      deployment_users: [],
+      deployed_apps_counter: 0
     }
   end
 
@@ -966,6 +984,15 @@ defmodule Livebook.Hubs.TeamClient do
     end
   end
 
+  defp handle_event(:deployment_status_updated, %{id: id, deployed_apps_counter: counter}, state) do
+    with {:ok, deployment_group} <- fetch_deployment_group(id, state) do
+      deployment_group = %{deployment_group | deployed_apps_counter: counter}
+
+      Teams.Broadcasts.deployment_group_updated(deployment_group)
+      put_deployment_group(state, deployment_group)
+    end
+  end
+
   defp dispatch_secrets(state, %{secrets: secrets}) do
     decrypted_secrets = Enum.map(secrets, &build_secret(state, &1))
 
@@ -1167,8 +1194,13 @@ defmodule Livebook.Hubs.TeamClient do
   defp fetch_app_deployment(id, state),
     do: fetch_entry(state.app_deployments, &(&1.id == id), state)
 
-  defp fetch_app_deployment_from_slug(slug, state),
-    do: fetch_entry(state.app_deployments, &(&1.slug == slug), state)
+  defp fetch_app_deployment_from_slug(slug, deployment_group_id, state) do
+    fetch_entry(
+      state.app_deployments,
+      &(&1.slug == slug && &1.deployment_group_id == deployment_group_id),
+      state
+    )
+  end
 
   defp fetch_app_folder(id, state), do: fetch_entry(state.app_folders, &(&1.id == id), state)
 

lib/livebook/teams.ex

@@ -219,6 +219,14 @@ defmodule Livebook.Teams do
     TeamClient.get_app_deployments(team.id)
   end
 
+  @doc """
+  Gets an app deployment for a given Hub.
+  """
+  @spec get_app_deployment(Team.t(), String.t(), String.t()) :: Teams.AppDeployment.t() | nil
+  def get_app_deployment(team, slug, deployment_group_id) do
+    TeamClient.get_app_deployment(team.id, slug, deployment_group_id)
+  end
+
   @doc """
   Gets a list of agents for a given Hub.
   """
@@ -230,7 +238,7 @@ defmodule Livebook.Teams do
   @doc """
   Gets a list of environment variables for a given Hub.
   """
-  @spec get_environment_variables(Team.t()) :: list(Teams.Agent.t())
+  @spec get_environment_variables(Team.t()) :: list(Teams.EnvironmentVariable.t())
   def get_environment_variables(team) do
     TeamClient.get_environment_variables(team.id)
   end

lib/livebook/teams/deployment_group.ex

@@ -14,6 +14,7 @@ defmodule Livebook.Teams.DeploymentGroup do
           hub_id: String.t() | nil,
           teams_auth: boolean(),
           groups_auth: boolean(),
+          deployed_apps_counter: non_neg_integer(),
           authorization_groups: Ecto.Schema.embeds_many(Teams.AuthorizationGroup.t()),
           deployment_users: Ecto.Schema.embeds_many(Teams.DeploymentUser.t()),
           secrets: Ecto.Schema.has_many(Secrets.Secret.t()),
@@ -31,6 +32,7 @@ defmodule Livebook.Teams.DeploymentGroup do
     field :teams_auth, :boolean, default: true
     field :groups_auth, :boolean, default: false
     field :deploy_auth, :boolean, default: false
+    field :deployed_apps_counter, :integer, default: 0
 
     has_many :secrets, Secrets.Secret
     has_many :agent_keys, Teams.AgentKey

lib/livebook_web/live/hub/edit/team_component.ex

@@ -15,7 +15,6 @@ defmodule LivebookWeb.Hub.Edit.TeamComponent do
     secrets = Hubs.get_secrets(assigns.hub)
     file_systems = Hubs.get_file_systems(assigns.hub, hub_only: true)
     deployment_groups = Teams.get_deployment_groups(assigns.hub)
-    app_deployments = Teams.get_app_deployments(assigns.hub)
     agents = Teams.get_agents(assigns.hub)
     environment_variables = Teams.get_environment_variables(assigns.hub)
     secret_name = assigns.params["secret_name"]
@@ -42,7 +41,6 @@ defmodule LivebookWeb.Hub.Edit.TeamComponent do
        file_system_id: file_system_id,
        file_systems: file_systems,
        deployment_groups: Enum.sort_by(deployment_groups, & &1.name),
-       app_deployments: Enum.frequencies_by(app_deployments, & &1.deployment_group_id),
        agents: Enum.frequencies_by(agents, & &1.deployment_group_id),
        environment_variables:
          Enum.frequencies_by(environment_variables, & &1.deployment_group_id),
@@ -250,7 +248,7 @@ defmodule LivebookWeb.Hub.Edit.TeamComponent do
                   id={"hub-deployment-group-#{deployment_group.id}"}
                   hub={@hub}
                   deployment_group={deployment_group}
-                  app_deployments_count={Map.get(@app_deployments, deployment_group.id, 0)}
+                  app_deployments_count={deployment_group.deployed_apps_counter}
                   environment_variables_count={
                     Map.get(@environment_variables, deployment_group.id, 0)
                   }

lib/livebook_web/live/hub/edit_live.ex

@@ -11,8 +11,7 @@ defmodule LivebookWeb.Hub.EditLive do
   def mount(_params, _session, socket) do
     if connected?(socket) do
       Hubs.Broadcasts.subscribe([:connection])
-
-      Livebook.Teams.Broadcasts.subscribe([:deployment_groups, :app_deployments, :agents])
+      Livebook.Teams.Broadcasts.subscribe([:deployment_groups, :agents])
     end
 
     {:ok,

lib/livebook_web/live/session_live/app_teams_live.ex

@@ -42,7 +42,6 @@ defmodule LivebookWeb.SessionLive.AppTeamsLive do
         action: :deployment_groups
       )
       |> assign_deployment_groups()
-      |> assign_app_deployments()
       |> assign_agents()
       |> assign_deployment_group(deployment_group_id)
       |> assign_app_deployment()
@@ -75,7 +74,6 @@ defmodule LivebookWeb.SessionLive.AppTeamsLive do
         app_deployment={@app_deployment}
         deployment_groups={@deployment_groups}
         num_agents={@num_agents}
-        num_app_deployments={@num_app_deployments}
         deployment_group={@deployment_group}
         session={@session}
         messages={@messages}
@@ -203,7 +201,6 @@ defmodule LivebookWeb.SessionLive.AppTeamsLive do
             <.deployment_group_entry
               deployment_group={@deployment_group}
               num_agents={@num_agents}
-              num_app_deployments={@num_app_deployments}
               authorized={@authorized[@deployment_group.id]}
               active
             />
@@ -265,7 +262,6 @@ defmodule LivebookWeb.SessionLive.AppTeamsLive do
               :for={deployment_group <- @deployment_groups}
               deployment_group={deployment_group}
               num_agents={@num_agents}
-              num_app_deployments={@num_app_deployments}
               authorized={@authorized[deployment_group.id]}
               selectable
             />
@@ -322,7 +318,6 @@ defmodule LivebookWeb.SessionLive.AppTeamsLive do
   attr :authorized, :boolean, default: true
   attr :deployment_group, :map, required: true
   attr :num_agents, :map, required: true
-  attr :num_app_deployments, :map, required: true
   attr :rest, :global
 
   defp deployment_group_entry(assigns) do
@@ -368,7 +363,7 @@ defmodule LivebookWeb.SessionLive.AppTeamsLive do
               else: "border-gray-300 text-gray-500"
             )
           ]}>
-            Apps deployed: {@num_app_deployments[@deployment_group.id] || 0}
+            Apps deployed: {@deployment_group.deployed_apps_counter}
           </div>
         </div>
       </div>
@@ -472,10 +467,10 @@ defmodule LivebookWeb.SessionLive.AppTeamsLive do
     {:noreply, assign_agents(socket)}
   end
 
-  def handle_info({event, app_deployment}, socket)
+  def handle_info({event, %{slug: slug, hub_id: hub_id}}, socket)
       when event in [:app_deployment_started, :app_deployment_stopped] and
-             app_deployment.hub_id == socket.assigns.hub.id do
-    {:noreply, socket |> assign_app_deployments() |> assign_app_deployment()}
+             slug == socket.assigns.slug and hub_id == socket.assigns.hub.id do
+    {:noreply, assign_app_deployment(socket)}
   end
 
   def handle_info({:deployment_users_updated, deployment_group}, socket)
@@ -512,12 +507,6 @@ defmodule LivebookWeb.SessionLive.AppTeamsLive do
     assign(socket, deployment_groups: deployment_groups, authorized: authorized)
   end
 
-  defp assign_app_deployments(socket) do
-    app_deployments = Teams.get_app_deployments(socket.assigns.hub)
-    num_app_deployments = Enum.frequencies_by(app_deployments, & &1.deployment_group_id)
-    assign(socket, app_deployments: app_deployments, num_app_deployments: num_app_deployments)
-  end
-
   defp assign_agents(socket) do
     agents = Teams.get_agents(socket.assigns.hub)
     num_agents = Enum.frequencies_by(agents, & &1.deployment_group_id)
@@ -536,10 +525,7 @@ defmodule LivebookWeb.SessionLive.AppTeamsLive do
   defp assign_app_deployment(socket) do
     app_deployment =
       if deployment_group = socket.assigns.deployment_group do
-        Enum.find(
-          socket.assigns.app_deployments,
-          &(&1.slug == socket.assigns.slug and &1.deployment_group_id == deployment_group.id)
-        )
+        Teams.get_app_deployment(socket.assigns.hub, socket.assigns.slug, deployment_group.id)
       end
 
     assign(socket, app_deployment: app_deployment)

proto/lib/livebook_proto/deployment_group.pb.ex

@@ -30,4 +30,6 @@ defmodule LivebookProto.DeploymentGroup do
     repeated: true,
     type: LivebookProto.DeploymentUser,
     json_name: "deploymentUsers"
+
+  field :deployed_apps_counter, 16, type: :int32, json_name: "deployedAppsCounter"
 end

proto/lib/livebook_proto/deployment_status_updated.pb.ex

@@ -0,0 +1,9 @@
+defmodule LivebookProto.DeploymentStatusUpdated do
+  use Protobuf,
+    full_name: "DeploymentStatusUpdated",
+    protoc_gen_elixir_version: "0.16.0",
+    syntax: :proto3
+
+  field :id, 1, type: :string
+  field :deployed_apps_counter, 2, type: :int32, json_name: "deployedAppsCounter"
+end

proto/lib/livebook_proto/event.pb.ex

@@ -93,4 +93,9 @@ defmodule LivebookProto.Event do
     type: LivebookProto.AppFolderDeleted,
     json_name: "appFolderDeleted",
     oneof: 0
+
+  field :deployment_status_updated, 22,
+    type: LivebookProto.DeploymentStatusUpdated,
+    json_name: "deploymentStatusUpdated",
+    oneof: 0
 end

proto/messages.proto

@@ -70,6 +70,7 @@ message DeploymentGroup {
   bool groups_auth = 13;
   bool deploy_auth = 14;
   repeated DeploymentUser deployment_users = 15;
+  int32 deployed_apps_counter = 16;
 }
 
 message DeploymentGroupCreated {
@@ -105,6 +106,11 @@ message DeploymentGroupDeleted {
   string id = 1;
 }
 
+message DeploymentStatusUpdated {
+  string id = 1;
+  int32 deployed_apps_counter = 2;
+}
+
 message AgentKey {
   string id = 1;
   string key = 2;
@@ -266,6 +272,7 @@ message Event {
     AppFolderCreated app_folder_created = 19;
     AppFolderUpdated app_folder_updated = 20;
     AppFolderDeleted app_folder_deleted = 21;
+    DeploymentStatusUpdated deployment_status_updated = 22;
   }
 }