feat(upgrade): implement upgrade onboarding system for Unraid OS

- Added `UpgradeInfo` type to track OS version changes, including current and previous versions.
- Enhanced `InfoVersions` and GraphQL resolvers to expose upgrade information.
- Introduced `upgradeOnboarding` store to manage visibility and steps for users upgrading their OS.
- Updated `ActivationModal` to handle both fresh installs and upgrade onboarding, displaying relevant steps based on the user's upgrade path.
- Created configuration for defining upgrade steps and conditions in `releaseConfigs.ts`.
- Added new components and logic to facilitate the upgrade onboarding experience, improving user guidance during OS upgrades.

This update streamlines the upgrade process, ensuring users receive contextual onboarding steps when upgrading their Unraid OS, enhancing overall user experience.

Author: elibosley

api/dev/configs/api.json

@@ -5,5 +5,6 @@
   "ssoSubIds": [],
   "plugins": [
     "unraid-api-plugin-connect"
-  ]
+  ],
+  "lastSeenOsVersion": "6.11.2"
 }

api/generated-schema.graphql

@@ -1670,6 +1670,17 @@ type PackageVersions {
   docker: String
 }
 
+type UpgradeInfo {
+  """Whether the OS version has changed since last boot"""
+  isUpgrade: Boolean!
+
+  """Previous OS version before upgrade"""
+  previousVersion: String
+
+  """Current OS version"""
+  currentVersion: String
+}
+
 type InfoVersions implements Node {
   id: PrefixedID!
 
@@ -1678,6 +1689,9 @@ type InfoVersions implements Node {
 
   """Software package versions"""
   packages: PackageVersions
+
+  """OS upgrade information"""
+  upgrade: UpgradeInfo!
 }
 
 type Info implements Node {

api/src/unraid-api/cli/generated/graphql.ts

@@ -1086,6 +1086,8 @@ export type InfoVersions = Node & {
   id: Scalars['PrefixedID']['output'];
   /** Software package versions */
   packages?: Maybe<PackageVersions>;
+  /** OS upgrade information */
+  upgrade: UpgradeInfo;
 };
 
 export type InitiateFlashBackupInput = {
@@ -1249,6 +1251,8 @@ export type Mutation = {
   unreadNotification: Notification;
   updateApiSettings: ConnectSettingsValues;
   updateSettings: UpdateSettingsResponse;
+  /** Update system time configuration */
+  updateSystemTime: SystemTime;
   vm: VmMutations;
 };
 
@@ -1362,6 +1366,11 @@ export type MutationUpdateSettingsArgs = {
   input: Scalars['JSON']['input'];
 };
 
+
+export type MutationUpdateSystemTimeArgs = {
+  input: UpdateSystemTimeInput;
+};
+
 export type Network = Node & {
   __typename?: 'Network';
   accessUrls?: Maybe<Array<AccessUrl>>;
@@ -1705,6 +1714,8 @@ export type Query = {
   services: Array<Service>;
   settings: Settings;
   shares: Array<Share>;
+  /** Retrieve current system time configuration */
+  systemTime: SystemTime;
   upsConfiguration: UpsConfiguration;
   upsDeviceById?: Maybe<UpsDevice>;
   upsDevices: Array<UpsDevice>;
@@ -2062,6 +2073,19 @@ export type SubscriptionLogFileArgs = {
   path: Scalars['String']['input'];
 };
 
+/** System time configuration and current status */
+export type SystemTime = {
+  __typename?: 'SystemTime';
+  /** Current server time in ISO-8601 format (UTC) */
+  currentTime: Scalars['String']['output'];
+  /** Configured NTP servers (empty strings indicate unused slots) */
+  ntpServers: Array<Scalars['String']['output']>;
+  /** IANA timezone identifier currently in use */
+  timeZone: Scalars['String']['output'];
+  /** Whether NTP/PTP time synchronization is enabled */
+  useNtp: Scalars['Boolean']['output'];
+};
+
 /** Temperature unit */
 export enum Temperature {
   CELSIUS = 'CELSIUS',
@@ -2282,6 +2306,27 @@ export enum UpdateStatus {
   UP_TO_DATE = 'UP_TO_DATE'
 }
 
+export type UpdateSystemTimeInput = {
+  /** Manual date/time to apply when disabling NTP, expected format YYYY-MM-DD HH:mm:ss */
+  manualDateTime?: InputMaybe<Scalars['String']['input']>;
+  /** Ordered list of up to four NTP servers. Supply empty strings to clear positions. */
+  ntpServers?: InputMaybe<Array<Scalars['String']['input']>>;
+  /** New IANA timezone identifier to apply */
+  timeZone?: InputMaybe<Scalars['String']['input']>;
+  /** Enable or disable NTP-based synchronization */
+  useNtp?: InputMaybe<Scalars['Boolean']['input']>;
+};
+
+export type UpgradeInfo = {
+  __typename?: 'UpgradeInfo';
+  /** Current OS version */
+  currentVersion?: Maybe<Scalars['String']['output']>;
+  /** Whether the OS version has changed since last boot */
+  isUpgrade: Scalars['Boolean']['output'];
+  /** Previous OS version before upgrade */
+  previousVersion?: Maybe<Scalars['String']['output']>;
+};
+
 export type Uptime = {
   __typename?: 'Uptime';
   timestamp?: Maybe<Scalars['String']['output']>;

api/src/unraid-api/config/api-config.module.ts

@@ -16,6 +16,7 @@ const createDefaultConfig = (): ApiConfig => ({
     sandbox: false,
     ssoSubIds: [],
     plugins: [],
+    lastSeenOsVersion: undefined,
 });
 
 /**
@@ -79,6 +80,20 @@ export class ApiConfigPersistence
 
     async onApplicationBootstrap() {
         this.configService.set('api.version', API_VERSION);
+        await this.trackOsVersionUpgrade();
+    }
+
+    private async trackOsVersionUpgrade() {
+        const currentOsVersion = this.configService.get<string>('store.emhttp.var.version');
+        const lastSeenOsVersion = this.configService.get<string>('api.lastSeenOsVersion');
+
+        if (currentOsVersion && currentOsVersion !== lastSeenOsVersion) {
+            this.configService.set('api.lastSeenOsVersion', currentOsVersion);
+            const currentConfig = this.configService.get<ApiConfig>('api');
+            if (currentConfig) {
+                await this.persist(currentConfig);
+            }
+        }
     }
 
     async migrateConfig(): Promise<ApiConfig> {

api/src/unraid-api/graph/resolvers/info/versions/versions.model.ts

@@ -41,11 +41,26 @@ export class PackageVersions {
     docker?: string;
 }
 
+@ObjectType()
+export class UpgradeInfo {
+    @Field(() => Boolean, { description: 'Whether the OS version has changed since last boot' })
+    isUpgrade!: boolean;
+
+    @Field(() => String, { nullable: true, description: 'Previous OS version before upgrade' })
+    previousVersion?: string;
+
+    @Field(() => String, { nullable: true, description: 'Current OS version' })
+    currentVersion?: string;
+}
+
 @ObjectType({ implements: () => Node })
 export class InfoVersions extends Node {
     @Field(() => CoreVersions, { description: 'Core system versions' })
     core!: CoreVersions;
 
     @Field(() => PackageVersions, { nullable: true, description: 'Software package versions' })
     packages?: PackageVersions;
+
+    @Field(() => UpgradeInfo, { description: 'OS upgrade information' })
+    upgrade!: UpgradeInfo;
 }

api/src/unraid-api/graph/resolvers/info/versions/versions.resolver.ts

@@ -7,6 +7,7 @@ import {
     CoreVersions,
     InfoVersions,
     PackageVersions,
+    UpgradeInfo,
 } from '@app/unraid-api/graph/resolvers/info/versions/versions.model.js';
 
 @Resolver(() => InfoVersions)
@@ -45,4 +46,20 @@ export class VersionsResolver {
             return null;
         }
     }
+
+    @ResolveField(() => UpgradeInfo)
+    upgrade(): UpgradeInfo {
+        const currentVersion = this.configService.get<string>('store.emhttp.var.version');
+        const lastSeenVersion = this.configService.get<string>('api.lastSeenOsVersion');
+
+        const isUpgrade = Boolean(
+            lastSeenVersion && currentVersion && lastSeenVersion !== currentVersion
+        );
+
+        return {
+            isUpgrade,
+            previousVersion: isUpgrade ? lastSeenVersion : undefined,
+            currentVersion: currentVersion || undefined,
+        };
+    }
 }

packages/unraid-shared/src/services/api-config.ts

@@ -26,4 +26,9 @@ export class ApiConfig {
   @IsArray()
   @IsString({ each: true })
   plugins!: string[];
+
+  @Field({ nullable: true })
+  @IsOptional()
+  @IsString()
+  lastSeenOsVersion?: string;
 }

web/__test__/components/Activation/ActivationSteps.test.ts

@@ -126,6 +126,7 @@ declare module 'vue' {
     UptimeExpire: typeof import('./src/components/UserProfile/UptimeExpire.vue')['default']
     USelectMenu: typeof import('./../node_modules/.pnpm/@nuxt+ui@4.0.0-alpha.0_@babel+parser@7.28.4_@netlify+blobs@9.1.2_change-case@5.4.4_db0@_655bac6707ae017754653173419b3890/node_modules/@nuxt/ui/dist/runtime/components/SelectMenu.vue')['default']
     'UserProfile.standalone': typeof import('./src/components/UserProfile.standalone.vue')['default']
+    UStepper: typeof import('./../node_modules/.pnpm/@nuxt+ui@4.0.0-alpha.0_@babel+parser@7.28.4_@netlify+blobs@9.1.2_change-case@5.4.4_db0@_655bac6707ae017754653173419b3890/node_modules/@nuxt/ui/dist/runtime/components/Stepper.vue')['default']
     USwitch: typeof import('./../node_modules/.pnpm/@nuxt+ui@4.0.0-alpha.0_@babel+parser@7.28.4_@netlify+blobs@9.1.2_change-case@5.4.4_db0@_655bac6707ae017754653173419b3890/node_modules/@nuxt/ui/dist/runtime/components/Switch.vue')['default']
     UTabs: typeof import('./../node_modules/.pnpm/@nuxt+ui@4.0.0-alpha.0_@babel+parser@7.28.4_@netlify+blobs@9.1.2_change-case@5.4.4_db0@_655bac6707ae017754653173419b3890/node_modules/@nuxt/ui/dist/runtime/components/Tabs.vue')['default']
     'WanIpCheck.standalone': typeof import('./src/components/WanIpCheck.standalone.vue')['default']