Class MaintenanceAdminService

Admin-side maintenance toggle: composes the Valkey-only MaintenanceService with a durable Postgres audit write.

MaintenanceService lives in @cfxlabsinc/maintenance-services and is Valkey-only (no db handle). This service wraps it so the admin dashboard can flip a service's maintenance flag while recording a durable audit row in admin.dashboard_user_activity. The audit row is written FIRST inside a transaction — if the Valkey flip fails the toggle is still audited, and a non-durable flag that's out of sync with the audit log is recoverable (re-run the toggle); a missing audit row is not.

Index

Constructors

constructor

Methods

getService isGlobalActive listInstances listServices setGlobalMaintenance setMaintenance

Constructors

constructor

new MaintenanceAdminService(
args: { db: B2bDatabase; valkeyClient: ValkeyClient | null },
): MaintenanceAdminService
Parameters
- args: { db: B2bDatabase; valkeyClient: ValkeyClient | null }
Returns MaintenanceAdminService
- Defined in packages/admin-dashboard-services/src/MaintenanceAdminService.ts:28

Methods

getService

getService(serviceId: string): Promise<{ ok: true; value: ServiceEntry | null }>
Parameters
- serviceId: string
Returns Promise<{ ok: true; value: ServiceEntry | null }>
- Defined in packages/admin-dashboard-services/src/MaintenanceAdminService.ts:43

isGlobalActive

isGlobalActive(): Promise<{ ok: true; value: boolean }>
Global kill-switch state. Distinct from any service's own flag — a service reports on: false from listServices while global is on, because that field is its per-service flag. Effective state is the OR of the two.

Returns Promise<{ ok: true; value: boolean }>
- Defined in packages/admin-dashboard-services/src/MaintenanceAdminService.ts:52

listInstances

listInstances(serviceId: string): Promise<{ ok: true; value: InstanceEntry[] }>
Parameters
- serviceId: string
Returns Promise<{ ok: true; value: InstanceEntry[] }>
- Defined in packages/admin-dashboard-services/src/MaintenanceAdminService.ts:39

listServices

listServices(): Promise<{ ok: true; value: ServiceEntry[] }>
Returns Promise<{ ok: true; value: ServiceEntry[] }>
- Defined in packages/admin-dashboard-services/src/MaintenanceAdminService.ts:35

setGlobalMaintenance

setGlobalMaintenance(
input: { actor: { externalId: string }; on: boolean },
): Promise<{ ok: true; value: void }>
Flips the global kill-switch, gating every process that runs the gate — including services that never registered, which no per-service toggle can reach. The control plane (this dashboard) is exempt by construction.
Parameters
- input: { actor: { externalId: string }; on: boolean }
Returns Promise<{ ok: true; value: void }>
- Defined in packages/admin-dashboard-services/src/MaintenanceAdminService.ts:61

setMaintenance

setMaintenance(
input: { actor: { externalId: string }; on: boolean; serviceId: string },
): Promise<{ ok: true; value: void }>
Parameters
- input: { actor: { externalId: string }; on: boolean; serviceId: string }
Returns Promise<{ ok: true; value: void }>
- Defined in packages/admin-dashboard-services/src/MaintenanceAdminService.ts:83

Class MaintenanceAdminService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MaintenanceAdminService

Methods

getService

Parameters

Returns Promise<{ ok: true; value: ServiceEntry | null }>

isGlobalActive

Returns Promise<{ ok: true; value: boolean }>

listInstances

Parameters

Returns Promise<{ ok: true; value: InstanceEntry[] }>

listServices

Returns Promise<{ ok: true; value: ServiceEntry[] }>

setGlobalMaintenance

Parameters

Returns Promise<{ ok: true; value: void }>

setMaintenance

Parameters

Returns Promise<{ ok: true; value: void }>

Settings

On This Page