feat(activation): structured per-component provisioning result

src/models/RCS.Config.ts

@@ -88,11 +88,49 @@ export interface RemoteConfig {
   AMTDomains: AMTDomain[]
 }
 
+/**
+ * Per-component activation outcome. Additive structured detail that rides alongside the
+ * legacy flat status strings in the WebSocket `message` field (see issue #2665). Older
+ * clients that do not understand `Components` simply ignore it.
+ */
+export type ComponentResultStatus = 'Success' | 'Failure' | 'NotApplicable'
+
+/** Clean machine-readable mode enum for a component result. Prose belongs in Details. */
+export type ComponentMode = 'ACM' | 'CCM' | 'LocalProfileSync'
+
+export interface ComponentResult {
+  Result: ComponentResultStatus
+  Mode?: ComponentMode
+  /** Human-readable, sentence-case note (no trailing period). On failure this carries the reason. */
+  Details?: string
+}
+
+export interface ComponentResults {
+  Activation?: ComponentResult
+  WiredNetwork?: ComponentResult
+  WirelessNetwork?: ComponentResult
+  TLS?: ComponentResult
+  CIRAProxy?: ComponentResult
+  CIRAConnection?: ComponentResult
+}
+
+/**
+ * Schema version for the structured `Components` block (issue #2665). Bump when the set of
+ * reported components changes (e.g. when 802.1x reporting lands) so clients can reason about coverage.
+ */
+export const COMPONENTS_VERSION = 1
+
 export interface Status {
   Status?: string
   Network?: string
   CIRAConnection?: string
   TLSConfiguration?: string
+  // Additive structured per-component results (issue #2665). Legacy flat fields above are
+  // always populated for backwards compatibility; the fields below carry the granular breakdown.
+  // Result is the overall roll-up; ComponentsVersion marks the Components schema version.
+  Result?: ComponentResultStatus
+  ComponentsVersion?: number
+  Components?: ComponentResults
 }
 export interface ClientObject {
   ClientId: string

src/stateMachines/activation.test.ts

@@ -36,6 +36,9 @@ vi.mock('./common.js', async () => {
     invokeWsmanCall: invokeWsmanCallSpy,
     invokeEnterpriseAssistantCall: vi.fn(),
     processTLSTunnelResponse: vi.fn(),
+    recordComponentResult: actual.recordComponentResult,
+    deriveControlMode: actual.deriveControlMode,
+    finalizeComponentResults: actual.finalizeComponentResults,
     HttpResponseError,
     isDigestRealmValid,
     coalesceMessage
@@ -828,6 +831,11 @@ describe('Activation State Machine', () => {
       devices[context.clientId].status.Status = 'Admin control mode.'
       activation.setActivationStatus({ context })
       expect(devices[clientId].activationStatus).toBeTruthy()
+      expect(devices[clientId].status.Components?.Activation).toEqual({
+        Result: 'Success',
+        Mode: 'ACM',
+        Details: 'Admin control mode'
+      })
     })
   })
 
@@ -2081,8 +2089,13 @@ describe('Activation State Machine', () => {
       }))
 
     it('should send success message to device', () => {
+      context.status = 'success'
+      devices[clientId].status = { Status: 'Admin control mode.' }
       activation.sendMessageToDevice({ context })
       expect(sendSpy).toHaveBeenCalled()
+      expect(devices[clientId].status.Result).toEqual('Success')
+      expect(devices[clientId].status.ComponentsVersion).toEqual(1)
+      expect(devices[clientId].status.Components?.Activation?.Result).toEqual('Success')
     })
     it('should update Credentials', () => {
       activation.updateCredentials({ context })
@@ -2092,6 +2105,8 @@ describe('Activation State Machine', () => {
     it('should send error message to device', () => {
       context.status = 'error'
       context.message = null
+      // Device never reached an activated control mode, so Activation is recorded as a Failure.
+      devices[clientId].activationStatus = false
       activation.sendMessageToDevice({ context })
       expect(responseMessageSpy).toHaveBeenCalledWith(
         context.clientId,
@@ -2100,6 +2115,7 @@ describe('Activation State Machine', () => {
         'failed',
         JSON.stringify(devices[clientId].status)
       )
+      expect(devices[clientId].status.Components?.Activation?.Result).toEqual('Failure')
       expect(sendSpy).toHaveBeenCalled()
     })
   })

src/stateMachines/activation.ts

@@ -25,7 +25,14 @@ import { DbCreatorFactory } from '../factories/DbCreatorFactory.js'
 import { AMTUserName, GATEWAY_TIMEOUT_ERROR, asArray } from '../utils/constants.js'
 import { CIRAConfiguration } from './ciraConfiguration.js'
 import { TLS } from './tls.js'
-import { type CommonContext, invokeWsmanCall, processTLSTunnelResponse } from './common.js'
+import {
+  type CommonContext,
+  invokeWsmanCall,
+  processTLSTunnelResponse,
+  recordComponentResult,
+  deriveControlMode,
+  finalizeComponentResults
+} from './common.js'
 import ClientResponseMsg from '../utils/ClientResponseMsg.js'
 import { Unconfiguration } from './unconfiguration.js'
 import { type DeviceCredentials } from '../interfaces/ISecretManagerService.js'
@@ -139,7 +146,17 @@ export class Activation {
     } else {
       clientObj.status.Status = context.errorMessage !== '' ? context.errorMessage : 'Failed'
       method = 'failed'
+      // Record the Activation component as a failure when the device never reached an
+      // activated control mode (issue #2665). If it activated but a later component failed,
+      // 'Set activation status' already recorded Activation as a success — don't overwrite it.
+      if (clientObj.activationStatus !== true) {
+        recordComponentResult(clientId, 'Activation', {
+          Result: 'Failure',
+          Details: clientObj.status.Status
+        })
+      }
     }
+    finalizeComponentResults(clientId, status === 'success')
     const responseMessage = ClientResponseMsg.get(clientId, null, status, method, JSON.stringify(clientObj.status))
     this.logger.info(JSON.stringify(responseMessage, null, '\t'))
     devices[clientId].ClientSocket?.send(JSON.stringify(responseMessage))
@@ -426,6 +443,11 @@ export class Activation {
     const clientObj = devices[context.clientId]
     this.logger.debug(`Device ${clientObj.uuid} activated in ${clientObj.status.Status}.`)
     clientObj.activationStatus = true
+    recordComponentResult(context.clientId, 'Activation', {
+      Result: 'Success',
+      Mode: deriveControlMode(clientObj.status.Status),
+      Details: clientObj.status.Status
+    })
     MqttProvider.publishEvent(
       'success',
       ['Activator', 'execute'],

src/stateMachines/ciraConfiguration.test.ts

@@ -29,6 +29,7 @@ vi.mock('./common.js', async () => {
     invokeWsmanCall: invokeWsmanCallSpy,
     invokeEnterpriseAssistantCall: vi.fn(),
     processTLSTunnelResponse: vi.fn(),
+    recordComponentResult: actual.recordComponentResult,
     HttpResponseError,
     isDigestRealmValid,
     coalesceMessage
@@ -183,6 +184,10 @@ describe('CIRA Configuration State Machine', () => {
               if (state.matches('SUCCESS') || state.matches('FAILURE') || currentStateIndex === flowStates.length) {
                 const status = devices[clientId].status.CIRAConnection
                 expect(status).toEqual('Configured')
+                expect(devices[clientId].status.Components?.CIRAConnection).toEqual({
+                  Result: 'Success',
+                  Details: 'Configured'
+                })
                 resolve()
               }
             }
@@ -212,6 +217,7 @@ describe('CIRA Configuration State Machine', () => {
           try {
             if (state.matches('SUCCESS') || state.matches('FAILURE')) {
               expect(state.matches('FAILURE')).toBeTruthy()
+              expect(devices[clientId].status.Components?.CIRAConnection?.Result).toEqual('Failure')
               resolve()
             }
           } catch (err) {

src/stateMachines/ciraConfiguration.ts

@@ -22,7 +22,7 @@ import { type DeviceCredentials } from '../interfaces/ISecretManagerService.js'
 import { type AMTConfiguration } from '../models/index.js'
 import { randomUUID } from 'node:crypto'
 import { Error } from './error.js'
-import { type CommonContext, invokeWsmanCall } from './common.js'
+import { type CommonContext, invokeWsmanCall, recordComponentResult } from './common.js'
 
 export interface CIRAConfigContext extends CommonContext {
   status: 'success' | 'error' | 'wsman' | 'heartbeat_request'
@@ -315,6 +315,11 @@ export class CIRAConfiguration {
     actions: {
       'Update Configuration Status': ({ context, event }) => {
         devices[context.clientId].status.CIRAConnection = context.statusMessage
+        const success = context.statusMessage === 'Configured'
+        recordComponentResult(context.clientId, 'CIRAConnection', {
+          Result: success ? 'Success' : 'Failure',
+          Details: context.statusMessage
+        })
       },
       'Reset Unauth Count': ({ context, event }) => {
         devices[context.clientId].unauthCount = 0