Broadcast that a device has been updated when setting and clearing deployment (#1846)

The device channel needs to be notified when a device's deployment
changes so it can resubscribe to the proper deployment channel and send
an update if available.

Author: nshoes

lib/nerves_hub/devices.ex

@@ -719,20 +719,28 @@ defmodule NervesHub.Devices do
 
   @spec update_deployment(Device.t(), Deployment.t()) :: Device.t()
   def update_deployment(device, deployment) do
-    device
-    |> Ecto.Changeset.change()
-    |> Ecto.Changeset.put_change(:deployment_id, deployment.id)
-    |> Repo.update!()
-    |> Repo.preload(:deployment, force: true)
+    device =
+      device
+      |> Ecto.Changeset.change()
+      |> Ecto.Changeset.put_change(:deployment_id, deployment.id)
+      |> Repo.update!()
+
+    _ = broadcast(device, "devices/updated")
+
+    Map.put(device, :deployment, deployment)
   end
 
   @spec clear_deployment(Device.t()) :: Device.t()
   def clear_deployment(device) do
-    device
-    |> Ecto.Changeset.change()
-    |> Ecto.Changeset.put_change(:deployment_id, nil)
-    |> Repo.update!()
-    |> Repo.preload(:deployment, force: true)
+    device =
+      device
+      |> Ecto.Changeset.change()
+      |> Ecto.Changeset.put_change(:deployment_id, nil)
+      |> Repo.update!()
+
+    _ = broadcast(device, "devices/updated")
+
+    Map.put(device, :deployment, nil)
   end
 
   @spec failure_threshold_met?(Device.t(), Deployment.t()) :: boolean()
@@ -1022,6 +1030,8 @@ defmodule NervesHub.Devices do
       |> where([d], d.firmware_metadata["architecture"] == ^firmware.architecture)
       |> Repo.update_all(set: [deployment_id: deployment_id])
 
+    :ok = Enum.each(device_ids, &broadcast(%Device{id: &1}, "devices/updated"))
+
     {:ok, %{updated: devices_updated_count, ignored: length(device_ids) - devices_updated_count}}
   end
 

test/nerves_hub/devices_test.exs

@@ -785,4 +785,34 @@ defmodule NervesHub.DevicesTest do
       assert 7 = Enum.count(healths)
     end
   end
+
+  describe "update_deployment/2" do
+    test "updates deployment and broadcasts 'devices/updated'", %{
+      device: device,
+      deployment: deployment
+    } do
+      refute device.deployment_id
+
+      NervesHubWeb.Endpoint.subscribe("device:#{device.id}")
+      device = Devices.update_deployment(device, deployment)
+
+      assert device.deployment_id == deployment.id
+      assert_receive %{event: "devices/updated"}
+    end
+  end
+
+  describe "clear_deployment1/2" do
+    test "clears deployment and broadcasts 'devices/updated'", %{
+      device: device,
+      deployment: deployment
+    } do
+      device = Devices.update_deployment(device, deployment)
+
+      NervesHubWeb.Endpoint.subscribe("device:#{device.id}")
+      device = Devices.clear_deployment(device)
+
+      refute device.deployment_id
+      assert_receive %{event: "devices/updated"}
+    end
+  end
 end

test/nerves_hub_web/live/devices/index_test.exs

@@ -294,6 +294,7 @@ defmodule NervesHubWeb.Live.Devices.IndexTest do
       } = fixture
 
       device2 = Fixtures.device_fixture(org, product, firmware)
+      Endpoint.subscribe("device:#{device2.id}")
 
       refute device.deployment_id
       refute device2.deployment_id
@@ -310,6 +311,9 @@ defmodule NervesHubWeb.Live.Devices.IndexTest do
       |> click_button("#move-deployment-submit", "Move")
       |> assert_has("div", text: "2 devices added to deployment")
 
+      assert_receive %{event: "devices/updated"}
+      assert_receive %{event: "devices/updated"}
+
       assert Repo.reload(device) |> Map.get(:deployment_id)
       assert Repo.reload(device2) |> Map.get(:deployment_id)
     end

test/nerves_hub_web/live/devices/show_test.exs

@@ -648,6 +648,23 @@ defmodule NervesHubWeb.Live.Devices.ShowTest do
       |> visit("/org/#{org.name}/#{product.name}/devices/#{device.identifier}")
       |> assert_has("div", text: "No Eligible Deployments")
     end
+
+    test "broadcasts to devices channel", %{
+      conn: conn,
+      org: org,
+      product: product,
+      device: device,
+      deployment: deployment
+    } do
+      conn
+      |> visit("/org/#{org.name}/#{product.name}/devices/#{device.identifier}")
+      |> assert_has("div", text: "Product Deployments")
+      |> unwrap(fn view ->
+        render_change(view, "set-deployment", %{"deployment_id" => deployment.id})
+      end)
+
+      assert_receive %Phoenix.Socket.Broadcast{event: "devices/updated"}
+    end
   end
 
   def device_show_path(%{device: device, org: org, product: product}) do