feat(agent): agent self update and scheduled updates

Author: pacmancoder

.github/workflows/ci.yml

@@ -815,6 +815,9 @@ jobs:
 
             $DAgentSessionExecutable = Join-Path $TargetOutputPath "DevolutionsSession.exe"
             echo "dagent-session-executable=$DAgentSessionExecutable" >> $Env:GITHUB_OUTPUT
+
+            $DAgentUpdaterExecutable = Join-Path $TargetOutputPath "DevolutionsAgentUpdater.exe"
+            echo "dagent-updater-executable=$DAgentUpdaterExecutable" >> $Env:GITHUB_OUTPUT
           }
 
           $DAgentExecutable = Join-Path $TargetOutputPath $ExecutableFileName
@@ -919,6 +922,7 @@ jobs:
       - name: Build
         run: |
           if ($Env:RUNNER_OS -eq "Windows") {
+            $Env:DAGENT_UPDATER_EXECUTABLE = "${{ steps.load-variables.outputs.dagent-updater-executable }}"
             $Env:DAGENT_PEDM_SHELL_EXT_DLL = "${{ steps.load-variables.outputs.dagent-pedm-shell-ext-dll }}"
             $Env:DAGENT_PEDM_SHELL_EXT_MSIX = "${{ steps.load-variables.outputs.dagent-pedm-shell-ext-msix }}"
             $Env:DAGENT_SESSION_EXECUTABLE = "${{ steps.load-variables.outputs.dagent-session-executable }}"
@@ -951,6 +955,7 @@ jobs:
 
             $Env:DAGENT_PACKAGE = "${{ steps.load-variables.outputs.dagent-package }}"
             $Env:DAGENT_DESKTOP_AGENT_PATH = $DesktopStagingPath
+            $Env:DAGENT_UPDATER_EXECUTABLE = "${{ steps.load-variables.outputs.dagent-updater-executable }}"
             $Env:DAGENT_PEDM_SHELL_EXT_DLL = "${{ steps.load-variables.outputs.dagent-pedm-shell-ext-dll }}"
             $Env:DAGENT_PEDM_SHELL_EXT_MSIX = "${{ steps.load-variables.outputs.dagent-pedm-shell-ext-msix }}"
             $Env:DAGENT_SESSION_EXECUTABLE = "${{ steps.load-variables.outputs.dagent-session-executable }}"

.github/workflows/package.yml

@@ -319,7 +319,7 @@ jobs:
         run: |
           $IncludePattern = @(switch ('${{ matrix.project }}') {
             'devolutions-gateway' { @('DevolutionsGateway_*.exe') }
-            'devolutions-agent' { @('DevolutionsAgent_*.exe', 'DevolutionsPedmShellExt.dll', 'DevolutionsPedmShellExt.msix', 'DevolutionsDesktopAgent.exe') }
+            'devolutions-agent' { @('DevolutionsAgent_*.exe', 'DevolutionsAgentUpdater.exe', 'DevolutionsPedmShellExt.dll', 'DevolutionsPedmShellExt.msix', 'DevolutionsDesktopAgent.exe') }
             'jetsocat' { @('jetsocat_*') }
           })
           $ExcludePattern = "*.pdb"
@@ -473,7 +473,8 @@ jobs:
         run: |
           $PackageRoot = Join-Path ${{ runner.temp }} ${{ matrix.project}}
 
-          $Env:DAGENT_EXECUTABLE = Get-ChildItem -Path $PackageRoot -Recurse -Include '*DevolutionsAgent*.exe' | Select -First 1
+          $Env:DAGENT_EXECUTABLE = Get-ChildItem -Path $PackageRoot -Recurse -Include '*DevolutionsAgent_*.exe' | Select -First 1
+          $Env:DAGENT_UPDATER_EXECUTABLE = Get-ChildItem -Path $PackageRoot -Recurse -Include 'DevolutionsAgentUpdater.exe' | Select -First 1
           $Env:DAGENT_DESKTOP_AGENT_PATH = Resolve-Path -Path "devolutions-pedm-desktop"
           $Env:DAGENT_PEDM_SHELL_EXT_DLL = Get-ChildItem -Path $PackageRoot -Recurse -Include 'DevolutionsPedmShellExt.dll' | Select -First 1
           $Env:DAGENT_PEDM_SHELL_EXT_MSIX = Get-ChildItem -Path $PackageRoot -Recurse -Include 'DevolutionsPedmShellExt.msix' | Select -First 1
@@ -482,6 +483,7 @@ jobs:
           $Env:DAGENT_WINTUN_DLL = Get-ChildItem -Path $PackageRoot -Recurse -Include 'wintun.dll' | Select -First 1
 
           Write-Host "DAGENT_EXECUTABLE = ${Env:DAGENT_EXECUTABLE}"
+          Write-Host "DAGENT_UPDATER_EXECUTABLE = ${Env:DAGENT_UPDATER_EXECUTABLE}"
           Write-Host "DAGENT_DESKTOP_AGENT_PATH = ${Env:DAGENT_DESKTOP_AGENT_PATH}"
           Write-Host "DAGENT_PEDM_SHELL_EXT_DLL = ${Env:DAGENT_PEDM_SHELL_EXT_DLL}"
           Write-Host "DAGENT_PEDM_SHELL_EXT_MSIX = ${Env:DAGENT_PEDM_SHELL_EXT_MSIX}"

Cargo.lock

@@ -3,6 +3,7 @@ resolver = "2"
 members = [
     "crates/*",
     "devolutions-agent",
+    "devolutions-agent-updater",
     "devolutions-gateway",
     "devolutions-session",
     "jetsocat",
@@ -11,6 +12,7 @@ members = [
 ]
 default-members = [
     "devolutions-agent",
+    "devolutions-agent-updater",
     "devolutions-gateway",
     "devolutions-session",
     "jetsocat",

Cargo.toml

@@ -3,6 +3,8 @@ param(
     [parameter(Mandatory = $true)]
     [string] $Exe,
     [parameter(Mandatory = $true)]
+    [string] $UpdaterExe,
+    [parameter(Mandatory = $true)]
     [string] $PedmDll,
     [parameter(Mandatory = $true)]
     [string] $PedmMsix,
@@ -31,7 +33,7 @@ function Set-FileNameAndCopy {
         [string]$Path,
         [string]$NewName
     )
-    
+
     if (-Not (Test-Path $Path)) {
         throw "File not found: $Path"
     }
@@ -84,6 +86,9 @@ function New-AgentMsi() {
         # The path to the devolutions-agent.exe file.
         [string] $Exe,
         [parameter(Mandatory = $true)]
+        # The path to the devolutions-agent-updater.exe file.
+        [string] $UpdaterExe,
+        [parameter(Mandatory = $true)]
         # The path to the devolutions_pedm_shell_ext.dll file.
         [string] $PedmDll,
         [parameter(Mandatory = $true)]
@@ -111,6 +116,7 @@ function New-AgentMsi() {
 
     # Convert slashes. This does not affect function. It's just for display.
     $Exe = Convert-Path -Path $Exe
+    $UpdaterExe = Convert-Path -Path $UpdaterExe
     $PedmDll = Convert-Path -Path $PedmDll
     $PedmMsix = Convert-Path -Path $PedmMsix
     $SessionExe = Convert-Path -Path $SessionExe
@@ -127,20 +133,23 @@ function New-AgentMsi() {
     # These file names don't matter for building, but we will clean them up anyways for consistency. The names can be seen if inspecting the MSI.
     # The Agent exe will get copied to `C:\Program Files\Devolutions\Agent\DevolutionsAgent.exe` after install.
     $myExe = Set-FileNameAndCopy -Path $Exe -NewName 'DevolutionsAgent.exe'
+    # The updater shim is a detached helper for installing MSI updates.
+    $myUpdaterExe = Set-FileNameAndCopy -Path $UpdaterExe -NewName 'DevolutionsAgentUpdater.exe'
     # The session is a service that gets launched on demand.
     $mySessionExe = Set-FileNameAndCopy -Path $SessionExe -NewName 'DevolutionsSession.exe'
 
     Write-Output "$repoDir\dotnet\DesktopAgent\bin\Release\net48\DevolutionsDesktopAgent.exe"
 
     Set-EnvVarPath 'DAGENT_EXECUTABLE' $myExe
+    Set-EnvVarPath 'DAGENT_UPDATER_EXECUTABLE' $myUpdaterExe
     Set-EnvVarPath 'DAGENT_PEDM_SHELL_EXT_DLL' $myPedmDll
     Set-EnvVarPath 'DAGENT_PEDM_SHELL_EXT_MSIX' $myPedmMsix
     Set-EnvVarPath 'DAGENT_SESSION_EXECUTABLE' $mySessionExe
 
     # The actual DevolutionsDesktopAgent.exe will be `\dotnet\DesktopAgent\bin\Release\net48\DevolutionsDesktopAgent.exe`.
-    # After install, the contsnts of `net48` will be copied to `C:\Program Files\Devolutions\Agent\desktop\`. 
+    # After install, the contents of `net48` will be copied to `C:\Program Files\Devolutions\Agent\desktop\`.
     Set-EnvVarPath 'DAGENT_DESKTOP_AGENT_PATH' "$repoDir\dotnet\DesktopAgent\bin\Release\net48"
-  
+
     $version = Get-Version
 
     Push-Location
@@ -152,7 +161,7 @@ function New-AgentMsi() {
     if ($Generate) {
         # This is used by `package/WindowsManaged/Program.cs`.
         $Env:DAGENT_MSI_SOURCE_ONLY_BUILD = '1'
-       
+
         foreach ($lang in Get-PackageLanguages) {
             $Env:DAGENT_MSI_LANG_ID = $lang.Name
             & 'MSBuild.exe' 'DevolutionsAgent.sln' '/t:restore,build' '/p:Configuration=Release' | Out-Host
@@ -175,4 +184,4 @@ function New-AgentMsi() {
     Pop-Location
 }
 
-New-AgentMsi -Generate:($Generate.IsPresent) -Exe $Exe -PedmDll $PedmDll -PedmMsix $PedmMsix -SessionExe $SessionExe -Architecture $Architecture -Outfile $Outfile
+New-AgentMsi -Generate:($Generate.IsPresent) -Exe $Exe -UpdaterExe $UpdaterExe -PedmDll $PedmDll -PedmMsix $PedmMsix -SessionExe $SessionExe -Architecture $Architecture -Outfile $Outfile

ci/package-agent-windows.ps1

@@ -303,6 +303,7 @@ class TlkRecipe
                 $agentPackages = @([TlkPackage]::new("devolutions-agent", "devolutions-agent", $false))
 
                 if ($this.Target.IsWindows()) {
+                    $agentPackages += [TlkPackage]::new("devolutions-agent-updater", "devolutions-agent-updater", $false)
                     $agentPackages += [TlkPackage]::new("devolutions-pedm-shell-ext", "crates/devolutions-pedm-shell-ext", $true)
                     $agentPackages += [TlkPackage]::new("devolutions-session", "devolutions-session", $false)
                 }
@@ -387,6 +388,8 @@ class TlkRecipe
                 "agent" {
                     if ($CargoPackage.Name -Eq "devolutions-agent" -And (Test-Path Env:DAGENT_EXECUTABLE)) {
                         $Env:DAGENT_EXECUTABLE
+                    } elseif ($CargoPackage.Name -Eq "devolutions-agent-updater" -And (Test-Path Env:DAGENT_UPDATER_EXECUTABLE)) {
+                        $Env:DAGENT_UPDATER_EXECUTABLE
                     } elseif ($CargoPackage.Name -Eq "devolutions-pedm-shell-ext" -And (Test-Path Env:DAGENT_PEDM_SHELL_EXT_DLL)) {
                         $Env:DAGENT_PEDM_SHELL_EXT_DLL
                     } elseif ($CargoPackage.Name -Eq "devolutions-session" -And (Test-Path Env:DAGENT_SESSION_EXECUTABLE)) {
@@ -760,7 +763,7 @@ class TlkRecipe
         }
 
         $DebUpstreamChangelogFile = Join-Path $OutputPath "changelog_deb_upstream"
-        
+
         Merge-Tokens -TemplateFile $RulesTemplate -Tokens @{
             dh_shlibdeps = $DhShLibDepsOverride
             upstream_changelog = $DebUpstreamChangelogFile
@@ -799,7 +802,7 @@ class TlkRecipe
 
         # input for debian/changelog is the package-specific CHANGELOG.md
         $PackagingChangelogFile = Join-Path $InputPackagePath "CHANGELOG.md"
-        
+
         $s = New-Changelog `
         -Format 'Deb' `
         -InputFile $UpstreamChangelogFile `

ci/tlk.ps1

@@ -13,6 +13,7 @@ workspace = true
 camino = "1.1"
 cfg-if = "1"
 serde = { version = "1", features = ["derive"] }
+serde_json = "1"
 thiserror = "2"
 
 [target.'cfg(windows)'.dependencies]

crates/devolutions-agent-shared/Cargo.toml

@@ -1,21 +1,21 @@
-#[macro_use]
-extern crate serde;
-
 #[cfg(windows)]
 pub mod windows;
 
 mod date_version;
-mod update_json;
+mod update_manifest;
+mod update_status;
 
 use std::env;
 
 use camino::Utf8PathBuf;
 use cfg_if::cfg_if;
-
-#[rustfmt::skip]
 pub use date_version::{DateVersion, DateVersionError};
-#[rustfmt::skip]
-pub use update_json::{ProductUpdateInfo, UpdateJson, VersionSpecification};
+pub use update_manifest::{
+    ProductUpdateInfo, UPDATE_MANIFEST_V2_MINOR_VERSION, UpdateManifest, UpdateManifestV1, UpdateManifestV2,
+    UpdateProductKey, UpdateSchedule, VersionMajorV2, VersionSpecification, default_schedule_window_start,
+    detect_update_manifest_major_version,
+};
+pub use update_status::{UpdateStatus, UpdateStatusV2};
 
 cfg_if! {
     if #[cfg(target_os = "windows")] {
@@ -77,7 +77,12 @@ pub fn get_data_dir() -> Utf8PathBuf {
     }
 }
 
-/// Returns the path to the `update.json` file
+/// Returns the path to the `update.json` file.
 pub fn get_updater_file_path() -> Utf8PathBuf {
     get_data_dir().join("update.json")
 }
+
+/// Returns the path to the `agent_status.json` file.
+pub fn get_agent_status_file_path() -> Utf8PathBuf {
+    get_data_dir().join("agent_status.json")
+}