Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 56 additions & 18 deletions lib/nerves_hub/managed_deployments.ex
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ defmodule NervesHub.ManagedDeployments do

require Logger

alias NervesHub.Accounts.User
alias NervesHub.AuditLogs.DeploymentGroupTemplates
alias NervesHub.AuditLogs.DeviceTemplates
alias NervesHub.Devices
Expand All @@ -11,6 +12,7 @@ defmodule NervesHub.ManagedDeployments do
alias NervesHub.Firmwares
alias NervesHub.Firmwares.FirmwareDelta
alias NervesHub.ManagedDeployments.DeploymentGroup
alias NervesHub.ManagedDeployments.DeploymentRelease
alias NervesHub.ManagedDeployments.Distributed.Orchestrator, as: DistributedOrchestrator
alias NervesHub.Products.Product
alias Phoenix.Channel.Server, as: PhoenixChannelServer
Expand Down Expand Up @@ -193,27 +195,31 @@ defmodule NervesHub.ManagedDeployments do
Update a deployment

- Records audit logs depending on changes
- Creates deployment release record if firmware_id or archive_id changed
"""
@spec update_deployment_group(DeploymentGroup.t(), map) ::
@spec update_deployment_group(DeploymentGroup.t(), map, User.t()) ::
{:ok, DeploymentGroup.t()} | {:error, Changeset.t()}
def update_deployment_group(deployment_group, params) do
def update_deployment_group(deployment_group, params, user) do
result =
Repo.transaction(fn ->
Repo.transact(fn ->
changeset =
deployment_group
|> Repo.preload(:firmware)
|> DeploymentGroup.update_changeset(params)

case Repo.update(changeset) do
{:ok, deployment_group} ->
deployment_group = Repo.preload(deployment_group, [:firmware], force: true)

audit_changes!(deployment_group, changeset)

{deployment_group, changeset}

{:error, changeset} ->
Repo.rollback(changeset)
create_deployment_release? =
Map.has_key?(changeset.changes, :firmware_id) or
Map.has_key?(changeset.changes, :archive_id)

with {:ok, deployment_group} <- Repo.update(changeset),
deployment_group = Repo.preload(deployment_group, [:firmware], force: true),
:ok <- create_audit_logs!(deployment_group, changeset),
{:ok, _deployment_group} <-
if(create_deployment_release?,
do: create_deployment_release(deployment_group, user.id),
else: {:ok, nil}
) do
{:ok, {deployment_group, changeset}}
end
end)

Expand All @@ -237,7 +243,18 @@ defmodule NervesHub.ManagedDeployments do
end
end

defp audit_changes!(deployment_group, changeset) do
defp create_deployment_release(deployment_group, user_id) do
%DeploymentRelease{}
|> DeploymentRelease.changeset(%{
deployment_group_id: deployment_group.id,
firmware_id: deployment_group.firmware_id,
archive_id: deployment_group.archive_id,
created_by_id: user_id
})
|> Repo.insert()
end

defp create_audit_logs!(deployment_group, changeset) do
Enum.each(changeset.changes, fn
{:archive_id, archive_id} ->
# Trigger the new archive to get downloaded by devices
Expand Down Expand Up @@ -330,11 +347,17 @@ defmodule NervesHub.ManagedDeployments do
Ecto.Changeset.change(%DeploymentGroup{})
end

@spec create_deployment_group(map(), Product.t()) ::
@spec create_deployment_group(map(), Product.t(), User.t()) ::
{:ok, DeploymentGroup.t()} | {:error, Changeset.t()}
def create_deployment_group(params, %Product{} = product) do
DeploymentGroup.create_changeset(params, product)
|> Repo.insert()
def create_deployment_group(params, %Product{} = product, user) do
Repo.transact(fn ->
changeset = DeploymentGroup.create_changeset(params, product)

with {:ok, deployment_group} <- Repo.insert(changeset),
{:ok, _release} <- create_deployment_release(deployment_group, user.id) do
{:ok, deployment_group}
end
end)
|> case do
{:ok, deployment_group} ->
deployment_created_event(deployment_group)
Expand All @@ -346,6 +369,21 @@ defmodule NervesHub.ManagedDeployments do
end
end

@doc """
List all deployment releases for a deployment group, ordered by most recent first.
"""
@spec list_deployment_releases(DeploymentGroup.t()) :: [DeploymentRelease.t()]
def list_deployment_releases(%DeploymentGroup{id: deployment_group_id}) do
DeploymentRelease
|> where([r], r.deployment_group_id == ^deployment_group_id)
|> join(:inner, [r], f in assoc(r, :firmware))
|> join(:inner, [r], u in assoc(r, :user))
|> join(:left, [r], a in assoc(r, :archive))
|> preload([r, f, u, a], firmware: f, user: u, archive: a)
|> order_by([r], desc: r.inserted_at, desc: r.id)
|> Repo.all()
end

@spec broadcast(DeploymentGroup.t() | atom(), String.t(), map()) :: :ok | {:error, term()}
def broadcast(deployment_group, event, payload \\ %{})

Expand Down
2 changes: 1 addition & 1 deletion lib/nerves_hub/managed_deployments/deployment_group.ex
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ defmodule NervesHub.ManagedDeployments.DeploymentGroup do

has_many(:inflight_updates, InflightUpdate, foreign_key: :deployment_id)
has_many(:devices, Device, foreign_key: :deployment_id, on_delete: :nilify_all)
has_many(:deployment_releases, DeploymentRelease)
has_many(:deployment_releases, DeploymentRelease, on_delete: :delete_all)
has_many(:update_stats, UpdateStat, on_delete: :nilify_all, foreign_key: :deployment_id)

embeds_one :conditions, __MODULE__.Conditions, primary_key: false, on_replace: :update do
Expand Down
4 changes: 1 addition & 3 deletions lib/nerves_hub/managed_deployments/deployment_release.ex
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ defmodule NervesHub.ManagedDeployments.DeploymentRelease do
@required_fields [
:deployment_group_id,
:firmware_id,
:archive_id,
:created_by_id,
:status
:created_by_id
]

@optional_fields [:archive_id]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,61 @@ defmodule NervesHubWeb.Components.DeploymentGroupPage.ReleaseHistory do

def render(assigns) do
~H"""
<div class="h-full flex flex-col items-center justify-center gap-4">
<div class="font-semibold text-xl">
Coming Soon...
<div class="flex flex-col p-6 gap-6">
<div class="w-full">
<div class="flex flex-col bg-zinc-900 border border-zinc-700 rounded">
<div class="flex justify-between items-center h-14 px-4 border-b border-zinc-700">
<div class="text-base text-neutral-50 font-medium">Release History</div>
</div>

<div :if={@releases == []} class="flex flex-col items-center justify-center p-12 gap-4">
<div class="text-zinc-400">No releases yet</div>
<div class="text-sm text-zinc-500">
Release history will appear here when you change the firmware version in settings.
</div>
</div>

<div :if={@releases != []} class="overflow-x-auto">
<table class="w-full">
<thead class="border-b border-zinc-700">
<tr>
<th class="text-left px-4 py-3 text-sm font-medium text-zinc-400">Released</th>
<th class="text-left px-4 py-3 text-sm font-medium text-zinc-400">Firmware Version</th>
<th class="text-left px-4 py-3 text-sm font-medium text-zinc-400">UUID</th>
<th class="text-left px-4 py-3 text-sm font-medium text-zinc-400">Archive</th>
<th class="text-left px-4 py-3 text-sm font-medium text-zinc-400">Released By</th>
</tr>
</thead>
<tbody>
<tr :for={release <- @releases} class="border-b border-zinc-800 hover:bg-zinc-800/50">
<td class="px-4 py-3 text-sm text-zinc-300">
<div class="flex flex-col">
<span>{Calendar.strftime(release.inserted_at, "%B %d, %Y")}</span>
<span class="text-xs text-zinc-500">{Calendar.strftime(release.inserted_at, "%I:%M %p")}</span>
</div>
</td>
<td class="px-4 py-3 text-sm text-zinc-300 font-medium">
{release.firmware.version}
</td>
<td class="px-4 py-3 text-sm text-zinc-400 font-mono">
{release.firmware.uuid}
</td>
<td class="px-4 py-3 text-sm text-zinc-400">
<span :if={release.archive}>
{release.archive.version} ({String.slice(release.archive.uuid, 0..7)})
</span>
<span :if={!release.archive} class="text-zinc-500 italic">
None
</span>
</td>
<td class="px-4 py-3 text-sm text-zinc-400">
{release.user.name}
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ defmodule NervesHubWeb.Components.DeploymentGroupPage.Settings do

authorized!(:"deployment_group:update", org_user)

case ManagedDeployments.update_deployment_group(deployment_group, params) do
case ManagedDeployments.update_deployment_group(deployment_group, params, user) do
{:ok, updated} ->
# Use original deployment so changes will get
# marked in audit log
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ defmodule NervesHubWeb.API.DeploymentGroupController do
uuid ->
with {:ok, firmware} <- Firmwares.get_firmware_by_product_and_uuid(product, uuid),
params = Map.put(params, "firmware_id", firmware.id),
{:ok, deployment_group} <- ManagedDeployments.create_deployment_group(params, product) do
{:ok, deployment_group} <- ManagedDeployments.create_deployment_group(params, product, user) do
DeploymentGroupTemplates.audit_deployment_created(user, deployment_group)

conn
Expand Down Expand Up @@ -67,7 +67,7 @@ defmodule NervesHubWeb.API.DeploymentGroupController do
ManagedDeployments.get_deployment_group_by_name(product, name),
params = update_params(product, deployment_group_params),
{:ok, updated_deployment_group} <-
ManagedDeployments.update_deployment_group(deployment_group, params) do
ManagedDeployments.update_deployment_group(deployment_group, params, user) do
DeploymentGroupTemplates.audit_deployment_updated(user, deployment_group)

render(conn, :show, deployment_group: updated_deployment_group)
Expand Down
2 changes: 1 addition & 1 deletion lib/nerves_hub_web/live/deployment_groups/new.ex
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ defmodule NervesHubWeb.Live.DeploymentGroups.New do

%{user: user, org: org, product: product} = socket.assigns

ManagedDeployments.create_deployment_group(params, product)
ManagedDeployments.create_deployment_group(params, product, user)
|> case do
{:ok, deployment_group} ->
_ = DeploymentGroupTemplates.audit_deployment_created(user, deployment_group)
Expand Down
4 changes: 3 additions & 1 deletion lib/nerves_hub_web/live/deployment_groups/show.ex
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ defmodule NervesHubWeb.Live.DeploymentGroups.Show do

inflight_updates = Devices.inflight_updates_for(deployment_group)
updating_count = Devices.updating_count(deployment_group)
releases = ManagedDeployments.list_deployment_releases(deployment_group)

:ok = socket.endpoint.subscribe("deployment:#{deployment_group.id}:internal")

Expand All @@ -55,6 +56,7 @@ defmodule NervesHubWeb.Live.DeploymentGroups.Show do
|> assign(:firmware, deployment_group.firmware)
|> assign(:deltas, Firmwares.get_deltas_by_target_firmware(deployment_group.firmware))
|> assign(:update_stats, UpdateStats.stats_by_deployment(deployment_group))
|> assign(:releases, releases)
|> assign_matched_devices_count()
|> schedule_inflight_updates_updater()
|> ok()
Expand Down Expand Up @@ -85,7 +87,7 @@ defmodule NervesHubWeb.Live.DeploymentGroups.Show do
value = !deployment_group.is_active

{:ok, deployment_group} =
ManagedDeployments.update_deployment_group(deployment_group, %{is_active: value})
ManagedDeployments.update_deployment_group(deployment_group, %{is_active: value}, user)

active_str = if value, do: "active", else: "inactive"
DeploymentGroupTemplates.audit_deployment_toggle_active(user, deployment_group, active_str)
Expand Down
2 changes: 1 addition & 1 deletion lib/nerves_hub_web/live/deployment_groups/show.html.heex
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@
update_stats={@update_stats}
/>

<.live_component :if={@tab == :release_history} module={ReleaseHistoryTab} id="deployment_group_release_history" />
<.live_component :if={@tab == :release_history} module={ReleaseHistoryTab} id="deployment_group_release_history" releases={@releases} />

<.live_component :if={@tab == :activity} module={ActivityTab} id="deployment_group_activity" deployment_group={@deployment_group} org={@org} product={@product} user={@user} />

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
defmodule NervesHub.Repo.Migrations.AddCascadeDeleteToDeploymentReleases do
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Foreign key validation does not need to be separated out to a second migration because there are no deployment_release records until after this PR.

use Ecto.Migration

def up do
# Drop the existing foreign key constraint
drop constraint(:deployment_releases, "deployment_releases_deployment_group_id_fkey")

# Add it back with cascade delete
alter table(:deployment_releases) do
modify :deployment_group_id, references(:deployments, on_delete: :delete_all), null: false
end
end

def down do
# Drop the cascade delete foreign key constraint
drop constraint(:deployment_releases, "deployment_releases_deployment_group_id_fkey")

# Add it back without cascade delete (original state)
alter table(:deployment_releases) do
modify :deployment_group_id, references(:deployments), null: false
end
end
end
13 changes: 9 additions & 4 deletions test/nerves_hub/devices/update_stats_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,8 @@ defmodule NervesHub.Devices.UpdateStatsTest do
source_firmware: source_firmware,
target_firmware: target_firmware,
other_firmware: other_firmware,
source_firmware_metadata: source_firmware_metadata
source_firmware_metadata: source_firmware_metadata,
user: user
} do
device = Devices.update_deployment_group(device, deployment_group)
device2 = Devices.update_deployment_group(device2, deployment_group)
Expand All @@ -193,9 +194,13 @@ defmodule NervesHub.Devices.UpdateStatsTest do
:ok = UpdateStats.log_update(device, source_firmware_metadata)

{:ok, deployment_group} =
ManagedDeployments.update_deployment_group(deployment_group, %{
firmware_id: other_firmware.id
})
ManagedDeployments.update_deployment_group(
deployment_group,
%{
firmware_id: other_firmware.id
},
user
)

# deployment group needs to be explicitly passed in because association
# is already preloaded from fixtures, causing the preload in log_update/2
Expand Down
13 changes: 9 additions & 4 deletions test/nerves_hub/devices_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -805,12 +805,17 @@ defmodule NervesHub.DevicesTest do
deployment_group: deployment_group,
device: device1 = %{id: device1_id},
org: org,
product: product
product: product,
user: user
} do
{:ok, deployment_group} =
ManagedDeployments.update_deployment_group(deployment_group, %{
enable_priority_updates: true
})
ManagedDeployments.update_deployment_group(
deployment_group,
%{
enable_priority_updates: true
},
user
)

{:ok, device1} = Devices.update_device(device1, %{first_seen_at: DateTime.utc_now()})

Expand Down
Loading
Loading