Files
coreflow/ts/coreflow.classes.backupmanager.ts
2026-05-02 21:59:42 +00:00

273 lines
9.3 KiB
TypeScript

import type { Coreflow } from './coreflow.classes.coreflow.js';
import * as plugins from './coreflow.plugins.js';
import * as crypto from 'node:crypto';
type TBackupSnapshotType = 'volume' | 'database' | 'objectstorage';
type TBackupSnapshot = {
type: TBackupSnapshotType;
snapshotId: string;
snapshotName?: string;
originalSize: number;
storedSize: number;
createdAt: number;
tags?: Record<string, string>;
volumeName?: string;
mountPath?: string;
resourceName?: string;
databaseName?: string;
bucketName?: string;
};
type TServiceVolumeConfig = {
name?: string;
source?: string;
mountPath?: string;
target?: string;
containerFsPath?: string;
driver?: string;
readOnly?: boolean;
backup?: boolean;
options?: Record<string, string>;
};
export class CoreflowBackupManager {
public coreflowRef: Coreflow;
constructor(coreflowRefArg: Coreflow) {
this.coreflowRef = coreflowRefArg;
this.coreflowRef.typedrouter.addTypedHandler(
new plugins.typedrequest.TypedHandler<any>('executeServiceBackup', async (requestArg) => {
return await this.executeServiceBackup(requestArg);
}),
);
this.coreflowRef.typedrouter.addTypedHandler(
new plugins.typedrequest.TypedHandler<any>('executeServiceRestore', async (requestArg) => {
return await this.executeServiceRestore(requestArg);
}),
);
}
public async start() {}
public async stop() {}
public async executeServiceBackup(requestArg: {
backupId: string;
service: plugins.servezoneInterfaces.data.IService;
tags?: Record<string, string>;
}) {
await this.provisionCorestoreBindingsIfAvailable(requestArg.service);
const snapshots: TBackupSnapshot[] = [];
snapshots.push(...await this.snapshotServiceVolumes(requestArg));
snapshots.push(...await this.snapshotServiceResources(requestArg));
return { snapshots };
}
public async executeServiceRestore(requestArg: {
backupId: string;
service: plugins.servezoneInterfaces.data.IService;
snapshots: TBackupSnapshot[];
clear?: boolean;
resourceTypes?: TBackupSnapshotType[];
}) {
await this.provisionCorestoreBindingsIfAvailable(requestArg.service);
const selectedSnapshots = (requestArg.snapshots || []).filter((snapshotArg) => {
return !requestArg.resourceTypes?.length || requestArg.resourceTypes.includes(snapshotArg.type);
});
const restored: TBackupSnapshot[] = [];
for (const snapshot of selectedSnapshots.filter((snapshotArg) => snapshotArg.type === 'volume')) {
await this.createCorestoreVolume(requestArg.service, {
source: snapshot.volumeName,
mountPath: snapshot.mountPath || '/data',
backup: true,
});
await this.postCorestore('/volumes/restore', {
name: snapshot.volumeName,
snapshotId: snapshot.snapshotId,
clear: requestArg.clear,
});
restored.push(snapshot);
}
const resourceSnapshots = selectedSnapshots.filter((snapshotArg) => {
return snapshotArg.type === 'database' || snapshotArg.type === 'objectstorage';
});
if (resourceSnapshots.length > 0) {
await this.postCorestore('/resources/restore', {
serviceId: requestArg.service.id,
snapshots: resourceSnapshots.map((snapshotArg) => ({
capability: snapshotArg.type,
resourceName: snapshotArg.resourceName || '',
snapshotId: snapshotArg.snapshotId,
snapshotName: snapshotArg.snapshotName,
originalSize: snapshotArg.originalSize,
storedSize: snapshotArg.storedSize,
createdAt: snapshotArg.createdAt,
tags: snapshotArg.tags || {},
databaseName: snapshotArg.databaseName,
bucketName: snapshotArg.bucketName,
})),
});
restored.push(...resourceSnapshots);
}
return { restored };
}
private async provisionCorestoreBindingsIfAvailable(
serviceArg: plugins.servezoneInterfaces.data.IService,
) {
if (!(this.coreflowRef.cloudlyConnector as any).cloudlyApiClient) {
return;
}
await this.coreflowRef.platformManager.provisionBindingsForService(serviceArg);
}
private getCoreStoreControlUrl() {
return (process.env.CORESTORE_CONTROL_URL || 'http://corestore:3000').replace(/\/+$/, '');
}
private getCoreStoreApiToken() {
return process.env.CORESTORE_API_TOKEN;
}
private async postCorestore<T = any>(pathArg: string, bodyArg: unknown): Promise<T> {
const token = this.getCoreStoreApiToken();
const response = await fetch(`${this.getCoreStoreControlUrl()}${pathArg}`, {
method: 'POST',
headers: {
'content-type': 'application/json',
...(token ? { authorization: `Bearer ${token}` } : {}),
},
body: JSON.stringify(bodyArg),
});
const responseText = await response.text();
if (!response.ok) {
throw new Error(`CoreStore request failed ${response.status}: ${responseText}`);
}
return responseText ? JSON.parse(responseText) as T : ({} as T);
}
private getDockerSafeName(valueArg: string, maxLengthArg = 64) {
const safeName = valueArg
.replace(/[^a-zA-Z0-9_.-]+/g, '-')
.replace(/^[^a-zA-Z0-9]+|[^a-zA-Z0-9]+$/g, '')
.slice(0, maxLengthArg)
.replace(/[^a-zA-Z0-9]+$/g, '');
return safeName || 'resource';
}
private getServiceVolumeConfigs(serviceArg: plugins.servezoneInterfaces.data.IService) {
const serviceData = serviceArg.data as plugins.servezoneInterfaces.data.IService['data'] & {
volumes?: TServiceVolumeConfig[];
};
return (serviceData.volumes || []).filter((volumeArg) => {
return Boolean(volumeArg.mountPath || volumeArg.target || volumeArg.containerFsPath);
});
}
private getCoreStoreVolumeName(
serviceArg: plugins.servezoneInterfaces.data.IService,
volumeArg: TServiceVolumeConfig,
) {
const requestedName = volumeArg.source || volumeArg.name;
if (requestedName) {
return this.getDockerSafeName(requestedName, 120);
}
const mountPath = volumeArg.mountPath || volumeArg.target || volumeArg.containerFsPath || 'data';
const serviceName = this.getDockerSafeName(serviceArg.data.name, 36);
const mountName = this.getDockerSafeName(mountPath.replace(/^\/+/, '').replace(/\/+$/g, ''), 28);
const hash = crypto.createHash('sha1').update(`${serviceArg.id}:${mountPath}`).digest('hex').slice(0, 12);
return this.getDockerSafeName(`sz-${serviceName}-${mountName}-${hash}`, 120);
}
private async createCorestoreVolume(
serviceArg: plugins.servezoneInterfaces.data.IService,
volumeArg: TServiceVolumeConfig,
) {
const mountPath = volumeArg.mountPath || volumeArg.target || volumeArg.containerFsPath || '/data';
const volumeName = this.getCoreStoreVolumeName(serviceArg, volumeArg);
await this.postCorestore('/volumes/create', {
name: volumeName,
serviceId: serviceArg.id,
serviceName: serviceArg.data.name,
mountPath,
backup: volumeArg.backup !== false,
options: volumeArg.options,
});
return { volumeName, mountPath };
}
private async snapshotServiceVolumes(requestArg: {
backupId: string;
service: plugins.servezoneInterfaces.data.IService;
tags?: Record<string, string>;
}) {
const snapshots: TBackupSnapshot[] = [];
const volumes = this.getServiceVolumeConfigs(requestArg.service).filter((volumeArg) => {
return volumeArg.driver === undefined || volumeArg.driver === 'corestore';
}).filter((volumeArg) => volumeArg.backup !== false);
for (const volume of volumes) {
const { volumeName, mountPath } = await this.createCorestoreVolume(requestArg.service, volume);
const response = await this.postCorestore<any>('/volumes/snapshot', {
name: volumeName,
snapshotName: requestArg.backupId,
tags: {
backupId: requestArg.backupId,
serviceId: requestArg.service.id,
serviceName: requestArg.service.data.name,
mountPath,
...(requestArg.tags || {}),
},
});
snapshots.push({
type: 'volume',
volumeName,
mountPath,
snapshotId: response.snapshot.id,
snapshotName: requestArg.backupId,
originalSize: response.snapshot.originalSize,
storedSize: response.snapshot.storedSize,
createdAt: Date.now(),
tags: response.snapshot.tags,
});
}
return snapshots;
}
private async snapshotServiceResources(requestArg: {
backupId: string;
service: plugins.servezoneInterfaces.data.IService;
tags?: Record<string, string>;
}) {
const response = await this.postCorestore<any>('/resources/snapshot', {
serviceId: requestArg.service.id,
snapshotName: requestArg.backupId,
tags: {
backupId: requestArg.backupId,
serviceId: requestArg.service.id,
serviceName: requestArg.service.data.name,
...(requestArg.tags || {}),
},
});
return (response.snapshots || []).map((snapshotArg: any) => ({
type: snapshotArg.capability,
resourceName: snapshotArg.resourceName,
databaseName: snapshotArg.databaseName,
bucketName: snapshotArg.bucketName,
snapshotId: snapshotArg.snapshotId,
snapshotName: snapshotArg.snapshotName,
originalSize: snapshotArg.originalSize,
storedSize: snapshotArg.storedSize,
createdAt: snapshotArg.createdAt,
tags: snapshotArg.tags,
})) as TBackupSnapshot[];
}
}