Add support for filtering devices on alarms (#1628)

Author: elinol

assets/css/_custom.scss

@@ -13,7 +13,18 @@
   right: 0;
   margin: auto;
   z-index: 999;
-  // text-align: center;
+}
+
+.alarms-banner {
+  display: flex;
+  flex-direction: row;
+  justify-content: right;
+  padding-top: 2px;
+  padding-bottom: 2px;
+}
+
+.alarms-banner a {
+  color: #f78080;
 }
 
 .opacity-1 {
@@ -244,19 +255,28 @@
   }
 }
 
-.device-limit-indicator {
-  background-image: url("/images/icons/device.svg");
-  background-position: right center;
+.navbar-indicator {
+  background-position: left center;
   background-repeat: no-repeat;
   background-size: 1.5rem;
-  padding-right: 2rem;
-  letter-spacing: 4px;
+  padding-left: 1.8rem;
+  letter-spacing: 2px;
 
   @media(max-width: 860px) {
     display: none;
   }
 }
 
+.device-limit-indicator {
+  background-image: url("/images/icons/device.svg");
+}
+
+.alarms-indicator {
+  background-image: url("/images/icons/bell.svg");
+  margin-left: 1.3rem;
+  font-weight: 400;
+}
+
 html {
   .btn-group>form:not(:first-child) .btn {
     margin-left: -1px;
@@ -345,6 +365,7 @@ html {
   cursor: pointer;
   display: flex;
   gap: 4px;
+
   label {
     font-size: 14px;
     border-radius: 3.2px;
@@ -360,6 +381,7 @@ html {
     padding-right: 8px;
     justify-content: center;
     flex-grow: 1;
+
     input[type=radio] {
       appearance: none;
     }

assets/css/_form.scss

@@ -267,7 +267,7 @@ html {
   .filter-form {
     &.device-filters {
       display: grid;
-      grid-template-columns: 3fr 3fr 3fr 2fr 2fr;
+      grid-template-columns: 2fr 2fr 2fr 2fr 3fr;
       grid-column-gap: 1rem;
 
       @media (max-width: 860px) {

assets/static/images/icons/bell.svg

@@ -13,6 +13,7 @@ defmodule NervesHub.Devices do
   alias NervesHub.Deployments.Deployment
   alias NervesHub.Deployments.Orchestrator
   alias NervesHub.Devices.CACertificate
+  alias NervesHub.Devices.Alarms
   alias NervesHub.Devices.Device
   alias NervesHub.Devices.DeviceCertificate
   alias NervesHub.Devices.DeviceHealth
@@ -163,6 +164,15 @@ defmodule NervesHub.Devices do
         {_, ""} ->
           query
 
+        {:alarm_status, "with"} ->
+          where(query, [d], d.id in subquery(Alarms.query_devices_with_alarms()))
+
+        {:alarm_status, "without"} ->
+          where(query, [d], d.id not in subquery(Alarms.query_devices_with_alarms()))
+
+        {:alarm, value} ->
+          where(query, [d], d.id in subquery(Alarms.query_devices_with_alarm(value)))
+
         {:connection, _value} ->
           where(query, [d], d.connection_status == ^String.to_atom(value))
 

lib/nerves_hub/devices.ex

@@ -0,0 +1,90 @@
+defmodule NervesHub.Devices.Alarms do
+  import Ecto.Query
+  alias NervesHub.Repo
+  alias NervesHub.Devices.Device
+  alias NervesHub.Devices.DeviceHealth
+
+  @doc """
+  Selects device id:s for devices that has alarm(s) in it's latest health record.
+  Used when filtering devices.
+  """
+  def query_devices_with_alarms() do
+    (lr in subquery(latest_row_query()))
+    |> from()
+    |> where([lr], lr.rn == 1)
+    |> where([lr], fragment("?->'alarms' != '{}'", lr.data))
+    |> join(:inner, [lr], d in Device, on: lr.device_id == d.id)
+    |> select([lr, o], o.id)
+  end
+
+  @doc """
+  Selects device id:s for devices that has provided alarm in it's latest health record.
+  Used when filtering devices.
+  """
+  def query_devices_with_alarm(alarm) do
+    (lr in subquery(latest_row_query()))
+    |> from()
+    |> where([lr], lr.rn == 1)
+    |> where(
+      [lr],
+      fragment(
+        "EXISTS (SELECT 1 FROM jsonb_each_text(?) WHERE value ILIKE ?)",
+        lr.data,
+        ^"%#{alarm}%"
+      )
+    )
+    |> join(:inner, [lr], d in Device, on: lr.device_id == d.id)
+    |> select([lr, o], o.id)
+  end
+
+  @doc """
+  Creates a list with all current alarm types for a product.
+  """
+  def get_current_alarm_types(product_id) do
+    query_current_alarms(product_id)
+    |> Repo.all()
+    |> Enum.map(fn %{data: data} ->
+      Map.keys(data["alarms"])
+    end)
+    |> List.flatten()
+    |> Enum.uniq()
+    |> Enum.map(&String.trim_leading(&1, "Elixir."))
+  end
+
+  @doc """
+  Counts number of devices currently alarming, within a product.
+  """
+  def current_alarms_count(product_id) do
+    product_id
+    |> query_current_alarms()
+    |> select([a], count(a))
+    |> Repo.one!()
+  end
+
+  @doc """
+  Selects latest health per device if alarms is populated and device belongs to product.
+  """
+  def query_current_alarms(product_id) do
+    (lr in subquery(latest_row_query()))
+    |> from()
+    |> where([lr], lr.rn == 1)
+    |> where([lr], fragment("?->'alarms' != '{}'", lr.data))
+    |> where([lr], lr.device_id in subquery(device_product_query(product_id)))
+  end
+
+  defp latest_row_query() do
+    DeviceHealth
+    |> select([dh], %{
+      device_id: dh.device_id,
+      data: dh.data,
+      inserted_at: dh.inserted_at,
+      rn: row_number() |> over(partition_by: dh.device_id, order_by: [desc: dh.inserted_at])
+    })
+  end
+
+  defp device_product_query(product_id) do
+    Device
+    |> select([:id])
+    |> where(product_id: ^product_id)
+  end
+end

lib/nerves_hub/devices/alarms.ex

@@ -2,6 +2,7 @@ defmodule NervesHubWeb.Components.Navigation do
   use NervesHubWeb, :component
 
   alias NervesHub.Devices
+  alias NervesHub.Devices.Alarms
   alias NervesHub.Products.Product
 
   import NervesHubWeb.Components.SimpleActiveLink
@@ -115,6 +116,7 @@ defmodule NervesHubWeb.Components.Navigation do
 
     if Enum.any?(links) do
       assigns = %{
+        org: assigns.org,
         product: assigns.product,
         links: links
       }
@@ -129,8 +131,19 @@ defmodule NervesHubWeb.Components.Navigation do
               </.link>
             </li>
           </ul>
-          <div :if={device_count = device_count(@product)} class="device-limit-indicator" title="Device total" aria-label="Device total">
-            <%= device_count %>
+          <div class="flex-row align-items-center justify-content-between">
+            <div :if={device_count = device_count(@product)} class="navbar-indicator device-limit-indicator" title="Device total" aria-label="Device total">
+              <%= device_count %>
+            </div>
+            <.link
+              :if={alarms_count = alarms_count(@product)}
+              navigate={~p"/org/#{@org.name}/#{@product.name}/devices?alarm_status=with"}
+              class="navbar-indicator alarms-indicator"
+              title="Devices alarming"
+              aria-label="Devices alarming"
+            >
+              <%= alarms_count %>
+            </.link>
           </div>
         </nav>
       </div>
@@ -308,4 +321,7 @@ defmodule NervesHubWeb.Components.Navigation do
   def device_count(_conn) do
     nil
   end
+
+  def alarms_count(%Product{} = product), do: Alarms.current_alarms_count(product.id)
+  def alarms_count(_conn), do: nil
 end

lib/nerves_hub_web/components/navigation.ex

@@ -5,6 +5,7 @@ defmodule NervesHubWeb.Live.Devices.Index do
 
   alias NervesHub.AuditLogs
   alias NervesHub.Devices
+  alias NervesHub.Devices.Alarms
   alias NervesHub.Firmwares
   alias NervesHub.Products.Product
   alias NervesHub.Tracker
@@ -27,7 +28,9 @@ defmodule NervesHubWeb.Live.Devices.Index do
     device_id: "",
     tag: "",
     updates: "",
-    has_no_tags: false
+    has_no_tags: false,
+    alarm_status: "",
+    alarm: ""
   }
 
   @filter_types %{
@@ -39,7 +42,9 @@ defmodule NervesHubWeb.Live.Devices.Index do
     device_id: :string,
     tag: :string,
     updates: :string,
-    has_no_tags: :boolean
+    has_no_tags: :boolean,
+    alarm_status: :string,
+    alarm: :string
   }
 
   @default_page 1
@@ -77,6 +82,7 @@ defmodule NervesHubWeb.Live.Devices.Index do
     |> assign(:valid_tags, true)
     |> assign(:device_tags, "")
     |> assign(:total_entries, 0)
+    |> assign(:current_alarms, Alarms.get_current_alarm_types(product.id))
     |> subscribe_and_refresh_device_list_timer()
     |> ok()
   end

lib/nerves_hub_web/live/devices/index.ex

@@ -132,6 +132,29 @@
             <div class="select-icon"></div>
           </div>
         </div>
+        <div class="form-group">
+          <label for="alarm_status">Alarm Status</label>
+          <div class="pos-rel">
+            <select name="alarm_status" id="alarm_status" class="form-control">
+              <option {selected?(@current_filters, :alarm_status, "")} value="">All</option>
+              <option {selected?(@current_filters, :alarm_status, "with")} value="with">Has Alarms</option>
+              <option {selected?(@current_filters, :alarm_status, "without")} value="without">No alarms</option>
+            </select>
+            <div class="select-icon"></div>
+          </div>
+        </div>
+        <div class="form-group">
+          <label for="alarm">Alarm</label>
+          <div class="pos-rel">
+            <select name="alarm" id="alarm" class="form-control">
+              <option {selected?(@current_filters, :alarm, "")} value="">All</option>
+              <%= for alarm <- @current_alarms do %>
+                <option {selected?(@current_filters, :alarm, alarm)}><%= alarm %></option>
+              <% end %>
+            </select>
+            <div class="select-icon"></div>
+          </div>
+        </div>
       </form>
       <button class="btn btn-secondary" type="button" phx-click="reset-filters">Reset Filters</button>
     </div>

lib/nerves_hub_web/live/devices/index.html.heex

@@ -131,6 +131,64 @@ defmodule NervesHubWeb.Live.Devices.IndexTest do
       refute change =~ device3.identifier
     end
 
+    test "filters devices with alarms", %{conn: conn, fixture: fixture} do
+      %{device: device, firmware: firmware, org: org, product: product} = fixture
+
+      device2 = Fixtures.device_fixture(org, product, firmware)
+
+      {:ok, view, html} = live(conn, device_index_path(fixture))
+      assert html =~ device.identifier
+      assert html =~ device2.identifier
+      assert html =~ "2 devices found"
+
+      device_health = %{"device_id" => device.id, "data" => %{"alarms" => %{"SomeAlarm" => []}}}
+      assert {:ok, _} = NervesHub.Devices.save_device_health(device_health)
+
+      change = render_change(view, "update-filters", %{"alarm_status" => "with"})
+      assert change =~ device.identifier
+      refute change =~ device2.identifier
+      assert change =~ "1 devices found"
+    end
+
+    test "filters devices without alarms", %{conn: conn, fixture: fixture} do
+      %{device: device, firmware: firmware, org: org, product: product} = fixture
+
+      device2 = Fixtures.device_fixture(org, product, firmware)
+
+      {:ok, view, html} = live(conn, device_index_path(fixture))
+      assert html =~ device.identifier
+      assert html =~ device2.identifier
+      assert html =~ "2 devices found"
+
+      device_health = %{"device_id" => device.id, "data" => %{"alarms" => %{"SomeAlarm" => []}}}
+      assert {:ok, _} = NervesHub.Devices.save_device_health(device_health)
+
+      change = render_change(view, "update-filters", %{"alarm_status" => "without"})
+      refute change =~ device.identifier
+      assert change =~ device2.identifier
+      assert change =~ "1 devices found"
+    end
+
+    test "filters devices with specific alarm", %{conn: conn, fixture: fixture} do
+      %{device: device, firmware: firmware, org: org, product: product} = fixture
+
+      device2 = Fixtures.device_fixture(org, product, firmware)
+
+      {:ok, view, html} = live(conn, device_index_path(fixture))
+      assert html =~ device.identifier
+      assert html =~ device2.identifier
+      assert html =~ "2 devices found"
+
+      alarm = "SomeAlarm"
+      device_health = %{"device_id" => device.id, "data" => %{"alarms" => %{alarm => []}}}
+      assert {:ok, _} = NervesHub.Devices.save_device_health(device_health)
+
+      change = render_change(view, "update-filters", %{"alarm" => alarm})
+      assert change =~ device.identifier
+      refute change =~ device2.identifier
+      assert change =~ "1 devices found"
+    end
+
     test "select device", %{conn: conn, fixture: fixture} do
       %{device: _device, firmware: firmware, org: org, product: product} = fixture