mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-08-16 13:38:33 +00:00
feat(auto-update): per-stack auto-update enable/disable toggle (#771)
* feat(auto-update): add per-stack auto-update enable/disable toggle Paid users (Skipper and Admiral) can now opt individual stacks out of scheduled auto-updates from the stack context menu without disabling the global feature. - Add stack_auto_update_settings table (node_id, stack_name) with default enabled=true; four typed DatabaseService accessors with parameterized queries. - Add GET /stacks/auto-update-settings, GET /stacks/:name/auto-update, and PUT /stacks/:name/auto-update (requirePaid + requireAdmin). PUT broadcasts state-invalidate with action auto-update-settings-changed so all open tabs refresh immediately. - Stack DELETE clears the auto-update setting row alongside stack_update_status. - autoUpdateRouter /execute skips disabled stacks before any registry call; skip is recorded in the results array. Manual Update actions are not affected. - Add Auto-update: Enabled/Disabled toggle in the stack inspect group (paid tiers only, hidden for Community, consistent with Auto-Heal). Toggle uses optimistic update with revert-on-error toast. - AutoUpdateReadinessView shows an Auto: Off pill and disables the Apply now button for stacks with auto-updates off. Detection still runs so the readiness card remains visible. - Add 21 backend Vitest tests covering DB round-trips, endpoint auth and tier gates, execute skip for both wildcard and named targets. Add 3 frontend hook tests for toggle visibility and callback behavior. * docs(auto-update): document per-stack auto-update control Add a Per-stack control section to the auto-update readiness page explaining how to disable and re-enable auto-updates for individual stacks, what disabling means (scheduled apply skipped; detection still runs; manual update unaffected), and a troubleshooting entry for scheduled runs not applying to a specific stack.
This commit is contained in:
Anso
@@ -0,0 +1,250 @@
|
||||
/**
|
||||
* Tests for per-stack auto-update settings:
|
||||
* - DatabaseService accessors (round-trip, defaults)
|
||||
* - GET/PUT /api/stacks/auto-update-settings and /api/stacks/:name/auto-update
|
||||
* - /api/auto-update/execute skips disabled stacks
|
||||
*/
|
||||
import { describe, it, expect, beforeAll, afterAll, vi } from 'vitest';
|
||||
import request from 'supertest';
|
||||
import bcrypt from 'bcrypt';
|
||||
import { setupTestDb, cleanupTestDb, loginAsTestAdmin } from './helpers/setupTestDb';
|
||||
|
||||
let tmpDir: string;
|
||||
let app: import('express').Express;
|
||||
let DatabaseService: typeof import('../services/DatabaseService').DatabaseService;
|
||||
let adminCookie: string;
|
||||
let viewerCookie: string;
|
||||
|
||||
beforeAll(async () => {
|
||||
tmpDir = await setupTestDb();
|
||||
({ DatabaseService } = await import('../services/DatabaseService'));
|
||||
|
||||
const { LicenseService } = await import('../services/LicenseService');
|
||||
vi.spyOn(LicenseService.getInstance(), 'getTier').mockReturnValue('paid');
|
||||
vi.spyOn(LicenseService.getInstance(), 'getVariant').mockReturnValue('admiral');
|
||||
vi.spyOn(LicenseService.getInstance(), 'getSeatLimits').mockReturnValue({ maxAdmins: null, maxViewers: null });
|
||||
|
||||
({ app } = await import('../index'));
|
||||
adminCookie = await loginAsTestAdmin(app);
|
||||
|
||||
const viewerHash = await bcrypt.hash('viewerpass2', 1);
|
||||
DatabaseService.getInstance().addUser({ username: 'aus-viewer', password_hash: viewerHash, role: 'viewer' });
|
||||
const viewerRes = await request(app).post('/api/auth/login').send({ username: 'aus-viewer', password: 'viewerpass2' });
|
||||
const cookies = viewerRes.headers['set-cookie'] as string | string[];
|
||||
viewerCookie = Array.isArray(cookies) ? cookies[0] : cookies;
|
||||
});
|
||||
|
||||
afterAll(() => cleanupTestDb(tmpDir));
|
||||
|
||||
describe('DatabaseService - stack auto-update settings', () => {
|
||||
it('returns true by default when no row exists', () => {
|
||||
const db = DatabaseService.getInstance();
|
||||
const result = db.getStackAutoUpdateEnabled(0, 'no-such-stack');
|
||||
expect(result).toBe(true);
|
||||
});
|
||||
|
||||
it('upsert → get round-trip (disable)', () => {
|
||||
const db = DatabaseService.getInstance();
|
||||
db.upsertStackAutoUpdateEnabled(0, 'test-stack', false);
|
||||
expect(db.getStackAutoUpdateEnabled(0, 'test-stack')).toBe(false);
|
||||
});
|
||||
|
||||
it('upsert → get round-trip (re-enable)', () => {
|
||||
const db = DatabaseService.getInstance();
|
||||
db.upsertStackAutoUpdateEnabled(0, 'test-stack', true);
|
||||
expect(db.getStackAutoUpdateEnabled(0, 'test-stack')).toBe(true);
|
||||
});
|
||||
|
||||
it('getStackAutoUpdateSettingsForNode only returns stacks with explicit rows', () => {
|
||||
const db = DatabaseService.getInstance();
|
||||
db.upsertStackAutoUpdateEnabled(0, 'explicit-stack', false);
|
||||
const settings = db.getStackAutoUpdateSettingsForNode(0);
|
||||
expect('explicit-stack' in settings).toBe(true);
|
||||
expect(settings['explicit-stack']).toBe(false);
|
||||
});
|
||||
|
||||
it('clearStackAutoUpdateSetting removes the row (reverts to default true)', () => {
|
||||
const db = DatabaseService.getInstance();
|
||||
db.upsertStackAutoUpdateEnabled(0, 'to-clear', false);
|
||||
db.clearStackAutoUpdateSetting(0, 'to-clear');
|
||||
expect(db.getStackAutoUpdateEnabled(0, 'to-clear')).toBe(true);
|
||||
const settings = db.getStackAutoUpdateSettingsForNode(0);
|
||||
expect('to-clear' in settings).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('GET /api/stacks/auto-update-settings', () => {
|
||||
it('rejects unauthenticated requests with 401', async () => {
|
||||
const res = await request(app).get('/api/stacks/auto-update-settings');
|
||||
expect(res.status).toBe(401);
|
||||
});
|
||||
|
||||
it('returns an object for authenticated admin', async () => {
|
||||
const res = await request(app).get('/api/stacks/auto-update-settings').set('Cookie', adminCookie);
|
||||
expect(res.status).toBe(200);
|
||||
expect(typeof res.body).toBe('object');
|
||||
});
|
||||
|
||||
it('returns an object for authenticated viewer (read-only)', async () => {
|
||||
const res = await request(app).get('/api/stacks/auto-update-settings').set('Cookie', viewerCookie);
|
||||
expect(res.status).toBe(200);
|
||||
});
|
||||
});
|
||||
|
||||
describe('GET /api/stacks/:stackName/auto-update', () => {
|
||||
it('rejects unauthenticated requests with 401', async () => {
|
||||
const res = await request(app).get('/api/stacks/mystack/auto-update');
|
||||
expect(res.status).toBe(401);
|
||||
});
|
||||
|
||||
it('returns enabled:true by default', async () => {
|
||||
const res = await request(app).get('/api/stacks/nonexistent/auto-update').set('Cookie', adminCookie);
|
||||
expect(res.status).toBe(200);
|
||||
expect(res.body.enabled).toBe(true);
|
||||
});
|
||||
|
||||
it('rejects invalid stack names with 400', async () => {
|
||||
// Dots are rejected by isValidStackName; unlike path-traversal sequences
|
||||
// they are not normalised away by Express routing.
|
||||
const res = await request(app).get('/api/stacks/my.stack/auto-update').set('Cookie', adminCookie);
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
});
|
||||
|
||||
describe('PUT /api/stacks/:stackName/auto-update', () => {
|
||||
it('rejects unauthenticated requests with 401', async () => {
|
||||
const res = await request(app)
|
||||
.put('/api/stacks/mystack/auto-update')
|
||||
.send({ enabled: false });
|
||||
expect(res.status).toBe(401);
|
||||
});
|
||||
|
||||
it('rejects viewer with 403', async () => {
|
||||
const res = await request(app)
|
||||
.put('/api/stacks/mystack/auto-update')
|
||||
.set('Cookie', viewerCookie)
|
||||
.send({ enabled: false });
|
||||
expect(res.status).toBe(403);
|
||||
});
|
||||
|
||||
it('rejects Community tier with 403', async () => {
|
||||
const { LicenseService } = await import('../services/LicenseService');
|
||||
const spy = vi.spyOn(LicenseService.getInstance(), 'getTier').mockReturnValue('community');
|
||||
try {
|
||||
const res = await request(app)
|
||||
.put('/api/stacks/mystack/auto-update')
|
||||
.set('Cookie', adminCookie)
|
||||
.send({ enabled: false });
|
||||
expect(res.status).toBe(403);
|
||||
} finally {
|
||||
// Use mockReturnValue rather than mockRestore: restoring would bypass the
|
||||
// beforeAll spy that sets the tier to 'paid' for the rest of the suite.
|
||||
spy.mockReturnValue('paid');
|
||||
}
|
||||
});
|
||||
|
||||
it('rejects non-boolean enabled with 400', async () => {
|
||||
const res = await request(app)
|
||||
.put('/api/stacks/mystack/auto-update')
|
||||
.set('Cookie', adminCookie)
|
||||
.send({ enabled: 'yes' });
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
|
||||
it('rejects invalid stack names with 400', async () => {
|
||||
// Dots are rejected by isValidStackName; unlike path-traversal sequences
|
||||
// they are not normalised away by Express routing.
|
||||
const res = await request(app)
|
||||
.put('/api/stacks/my.stack/auto-update')
|
||||
.set('Cookie', adminCookie)
|
||||
.send({ enabled: false });
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
|
||||
it('accepts Skipper/Admiral admin and persists the setting', async () => {
|
||||
const res = await request(app)
|
||||
.put('/api/stacks/my-app/auto-update')
|
||||
.set('Cookie', adminCookie)
|
||||
.send({ enabled: false });
|
||||
expect(res.status).toBe(200);
|
||||
expect(res.body.enabled).toBe(false);
|
||||
|
||||
const db = DatabaseService.getInstance();
|
||||
const node = db.getNodes().find(n => n.type === 'local');
|
||||
expect(db.getStackAutoUpdateEnabled(node!.id, 'my-app')).toBe(false);
|
||||
});
|
||||
|
||||
it('can re-enable a disabled stack', async () => {
|
||||
await request(app)
|
||||
.put('/api/stacks/my-app/auto-update')
|
||||
.set('Cookie', adminCookie)
|
||||
.send({ enabled: false });
|
||||
const res = await request(app)
|
||||
.put('/api/stacks/my-app/auto-update')
|
||||
.set('Cookie', adminCookie)
|
||||
.send({ enabled: true });
|
||||
expect(res.status).toBe(200);
|
||||
expect(res.body.enabled).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('POST /api/auto-update/execute - per-stack disable gate', () => {
|
||||
it('skips stacks with auto-updates disabled', async () => {
|
||||
const db = DatabaseService.getInstance();
|
||||
const node = db.getNodes().find(n => n.type === 'local')!;
|
||||
|
||||
db.upsertStackAutoUpdateEnabled(node.id, 'disabled-stack', false);
|
||||
|
||||
// Mock FileSystemService so target='*' returns our test stack
|
||||
const fsMod = await import('../services/FileSystemService');
|
||||
const getStacksSpy = vi.spyOn(fsMod.FileSystemService.prototype, 'getStacks')
|
||||
.mockResolvedValue(['disabled-stack']);
|
||||
|
||||
try {
|
||||
const res = await request(app)
|
||||
.post('/api/auto-update/execute')
|
||||
.set('Cookie', adminCookie)
|
||||
.send({ target: '*' });
|
||||
expect(res.status).toBe(200);
|
||||
expect(res.body.result).toContain('auto-updates disabled; skipped');
|
||||
} finally {
|
||||
getStacksSpy.mockRestore();
|
||||
db.clearStackAutoUpdateSetting(node.id, 'disabled-stack');
|
||||
}
|
||||
});
|
||||
|
||||
it('skips a named disabled stack', async () => {
|
||||
const db = DatabaseService.getInstance();
|
||||
const node = db.getNodes().find(n => n.type === 'local')!;
|
||||
db.upsertStackAutoUpdateEnabled(node.id, 'named-disabled', false);
|
||||
|
||||
try {
|
||||
const res = await request(app)
|
||||
.post('/api/auto-update/execute')
|
||||
.set('Cookie', adminCookie)
|
||||
.send({ target: 'named-disabled' });
|
||||
expect(res.status).toBe(200);
|
||||
expect(res.body.result).toContain('auto-updates disabled; skipped');
|
||||
} finally {
|
||||
db.clearStackAutoUpdateSetting(node.id, 'named-disabled');
|
||||
}
|
||||
});
|
||||
|
||||
it('allows enabled stacks to proceed (may fail at image check, but not at disable gate)', async () => {
|
||||
const db = DatabaseService.getInstance();
|
||||
const node = db.getNodes().find(n => n.type === 'local')!;
|
||||
db.upsertStackAutoUpdateEnabled(node.id, 'enabled-stack', true);
|
||||
|
||||
try {
|
||||
const res = await request(app)
|
||||
.post('/api/auto-update/execute')
|
||||
.set('Cookie', adminCookie)
|
||||
.send({ target: 'enabled-stack' });
|
||||
expect(res.status).toBe(200);
|
||||
// Should NOT contain "auto-updates disabled" in result
|
||||
expect(res.body.result).not.toContain('auto-updates disabled; skipped');
|
||||
} finally {
|
||||
db.clearStackAutoUpdateSetting(node.id, 'enabled-stack');
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -219,6 +219,11 @@ autoUpdateRouter.post('/execute', authMiddleware, async (req: Request, res: Resp
|
||||
|
||||
for (const stackName of stackNames) {
|
||||
try {
|
||||
if (!db.getStackAutoUpdateEnabled(req.nodeId, stackName)) {
|
||||
results.push(`Stack "${stackName}": auto-updates disabled; skipped.`);
|
||||
continue;
|
||||
}
|
||||
|
||||
const containers = await docker.getContainersByStack(stackName);
|
||||
if (!containers || containers.length === 0) {
|
||||
results.push(`Stack "${stackName}": no containers found; skipped.`);
|
||||
|
||||
@@ -11,7 +11,8 @@ import { UpdatePreviewService } from '../services/UpdatePreviewService';
|
||||
import { GitSourceService, GitSourceError, repoHost as gitRepoHost } from '../services/GitSourceService';
|
||||
import { enforcePolicyPreDeploy } from '../services/PolicyEnforcement';
|
||||
import { requirePermission } from '../middleware/permissions';
|
||||
import { requirePaid } from '../middleware/tierGates';
|
||||
import { requirePaid, requireAdmin } from '../middleware/tierGates';
|
||||
import { NotificationService } from '../services/NotificationService';
|
||||
import { isValidStackName, isPathWithinBase } from '../utils/validation';
|
||||
import { getErrorMessage } from '../utils/errors';
|
||||
import { isDebugEnabled } from '../utils/debug';
|
||||
@@ -128,6 +129,61 @@ stacksRouter.get('/statuses', async (req: Request, res: Response) => {
|
||||
}
|
||||
});
|
||||
|
||||
stacksRouter.get('/auto-update-settings', (req: Request, res: Response): void => {
|
||||
try {
|
||||
const settings = DatabaseService.getInstance().getStackAutoUpdateSettingsForNode(req.nodeId);
|
||||
res.json(settings);
|
||||
} catch (error) {
|
||||
console.error('[Stacks] Failed to fetch auto-update settings:', error);
|
||||
res.status(500).json({ error: 'Failed to fetch auto-update settings' });
|
||||
}
|
||||
});
|
||||
|
||||
stacksRouter.get('/:stackName/auto-update', (req: Request, res: Response): void => {
|
||||
try {
|
||||
const stackName = req.params.stackName as string;
|
||||
if (!isValidStackName(stackName)) {
|
||||
res.status(400).json({ error: 'Invalid stack name' });
|
||||
return;
|
||||
}
|
||||
const enabled = DatabaseService.getInstance().getStackAutoUpdateEnabled(req.nodeId, stackName);
|
||||
res.json({ enabled });
|
||||
} catch (error) {
|
||||
console.error('[Stacks] Failed to fetch auto-update setting:', error);
|
||||
res.status(500).json({ error: 'Failed to fetch auto-update setting' });
|
||||
}
|
||||
});
|
||||
|
||||
stacksRouter.put('/:stackName/auto-update', (req: Request, res: Response): void => {
|
||||
if (!requirePaid(req, res)) return;
|
||||
if (!requireAdmin(req, res)) return;
|
||||
try {
|
||||
const stackName = req.params.stackName as string;
|
||||
if (!isValidStackName(stackName)) {
|
||||
res.status(400).json({ error: 'Invalid stack name' });
|
||||
return;
|
||||
}
|
||||
const { enabled } = req.body as { enabled?: unknown };
|
||||
if (typeof enabled !== 'boolean') {
|
||||
res.status(400).json({ error: '"enabled" must be a boolean' });
|
||||
return;
|
||||
}
|
||||
DatabaseService.getInstance().upsertStackAutoUpdateEnabled(req.nodeId, stackName, enabled);
|
||||
NotificationService.getInstance().broadcastEvent({
|
||||
type: 'state-invalidate',
|
||||
scope: 'stack',
|
||||
nodeId: req.nodeId,
|
||||
stackName,
|
||||
action: 'auto-update-settings-changed',
|
||||
ts: Date.now(),
|
||||
});
|
||||
res.json({ enabled });
|
||||
} catch (error) {
|
||||
console.error('[Stacks] Failed to update auto-update setting:', error);
|
||||
res.status(500).json({ error: 'Failed to update auto-update setting' });
|
||||
}
|
||||
});
|
||||
|
||||
stacksRouter.get('/:stackName', async (req: Request, res: Response) => {
|
||||
try {
|
||||
const stackName = req.params.stackName as string;
|
||||
@@ -469,6 +525,7 @@ stacksRouter.delete('/:stackName', async (req: Request, res: Response) => {
|
||||
}
|
||||
|
||||
DatabaseService.getInstance().clearStackUpdateStatus(req.nodeId, stackName);
|
||||
DatabaseService.getInstance().clearStackAutoUpdateSetting(req.nodeId, stackName);
|
||||
DatabaseService.getInstance().deleteRoleAssignmentsByResource('stack', stackName);
|
||||
DatabaseService.getInstance().deleteGitSource(stackName);
|
||||
|
||||
|
||||
@@ -559,6 +559,14 @@ export class DatabaseService {
|
||||
PRIMARY KEY (node_id, stack_name)
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS stack_auto_update_settings (
|
||||
node_id INTEGER NOT NULL DEFAULT 0,
|
||||
stack_name TEXT NOT NULL,
|
||||
auto_update_enabled INTEGER NOT NULL DEFAULT 1,
|
||||
updated_at INTEGER NOT NULL,
|
||||
PRIMARY KEY (node_id, stack_name)
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS nodes (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
name TEXT NOT NULL UNIQUE,
|
||||
@@ -1722,6 +1730,40 @@ export class DatabaseService {
|
||||
this.db.prepare('DELETE FROM stack_update_status WHERE node_id = ? AND stack_name = ?').run(nodeId, stackName);
|
||||
}
|
||||
|
||||
// --- Stack Auto-Update Settings ---
|
||||
|
||||
public getStackAutoUpdateEnabled(nodeId: number, stackName: string): boolean {
|
||||
const row = this.db.prepare(
|
||||
'SELECT auto_update_enabled FROM stack_auto_update_settings WHERE node_id = ? AND stack_name = ?'
|
||||
).get(nodeId, stackName) as { auto_update_enabled: number } | undefined;
|
||||
return row === undefined ? true : row.auto_update_enabled === 1;
|
||||
}
|
||||
|
||||
// Returns only stacks with an explicit row. Missing keys default to true
|
||||
// (auto-update enabled); callers must not treat absence as false.
|
||||
public getStackAutoUpdateSettingsForNode(nodeId: number): Record<string, boolean> {
|
||||
const rows = this.db.prepare(
|
||||
'SELECT stack_name, auto_update_enabled FROM stack_auto_update_settings WHERE node_id = ?'
|
||||
).all(nodeId) as Array<{ stack_name: string; auto_update_enabled: number }>;
|
||||
const result: Record<string, boolean> = {};
|
||||
for (const row of rows) {
|
||||
result[row.stack_name] = row.auto_update_enabled === 1;
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
public upsertStackAutoUpdateEnabled(nodeId: number, stackName: string, enabled: boolean): void {
|
||||
this.db.prepare(
|
||||
`INSERT INTO stack_auto_update_settings (node_id, stack_name, auto_update_enabled, updated_at)
|
||||
VALUES (?, ?, ?, ?)
|
||||
ON CONFLICT(node_id, stack_name) DO UPDATE SET auto_update_enabled = excluded.auto_update_enabled, updated_at = excluded.updated_at`
|
||||
).run(nodeId, stackName, enabled ? 1 : 0, Date.now());
|
||||
}
|
||||
|
||||
public clearStackAutoUpdateSetting(nodeId: number, stackName: string): void {
|
||||
this.db.prepare('DELETE FROM stack_auto_update_settings WHERE node_id = ? AND stack_name = ?').run(nodeId, stackName);
|
||||
}
|
||||
|
||||
public getNodeUpdateSummary(): Array<{ node_id: number; stacks_with_updates: number }> {
|
||||
return this.db.prepare(
|
||||
'SELECT node_id, SUM(has_update) as stacks_with_updates FROM stack_update_status WHERE has_update = 1 GROUP BY node_id'
|
||||
|
||||
Reference in New Issue
Block a user