@git.zone/cli 7.4.1 → 8.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/mod_services/classes.dockercontainer.d.ts +13 -2
- package/dist_ts/mod_services/classes.dockercontainer.js +40 -40
- package/dist_ts/mod_services/classes.globalregistry.d.ts +12 -0
- package/dist_ts/mod_services/classes.globalregistry.js +96 -13
- package/dist_ts/mod_services/classes.globalregistrystore.d.ts +7 -1
- package/dist_ts/mod_services/classes.globalregistrystore.js +6 -6
- package/dist_ts/mod_services/classes.legacymongomigration.d.ts +239 -0
- package/dist_ts/mod_services/classes.legacymongomigration.js +970 -0
- package/dist_ts/mod_services/classes.serviceconfiguration.d.ts +112 -15
- package/dist_ts/mod_services/classes.serviceconfiguration.js +274 -62
- package/dist_ts/mod_services/classes.servicedatamarker.d.ts +42 -1
- package/dist_ts/mod_services/classes.servicedatamarker.js +101 -8
- package/dist_ts/mod_services/classes.servicemanager.d.ts +99 -33
- package/dist_ts/mod_services/classes.servicemanager.js +652 -384
- package/dist_ts/mod_services/classes.servicepruner.js +27 -20
- package/dist_ts/mod_services/index.js +62 -13
- package/dist_ts/mod_services/mod.plugins.d.ts +2 -1
- package/dist_ts/mod_services/mod.plugins.js +4 -2
- package/dist_ts_migration/002.runtime-config.d.ts +1 -1
- package/dist_ts_migration/002.runtime-config.js +8 -2
- package/dist_ts_migration/003.service-data-marker.js +125 -30
- package/dist_ts_migration/004.global-registry.js +30 -8
- package/package.json +1 -1
- package/readme.md +197 -32
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/mod_services/classes.dockercontainer.ts +58 -50
- package/ts/mod_services/classes.globalregistry.ts +115 -14
- package/ts/mod_services/classes.globalregistrystore.ts +16 -6
- package/ts/mod_services/classes.legacymongomigration.ts +1308 -0
- package/ts/mod_services/classes.serviceconfiguration.ts +387 -69
- package/ts/mod_services/classes.servicedatamarker.ts +149 -8
- package/ts/mod_services/classes.servicemanager.ts +877 -454
- package/ts/mod_services/classes.servicepruner.ts +27 -19
- package/ts/mod_services/index.ts +81 -12
- package/ts/mod_services/mod.plugins.ts +4 -1
- package/ts_migration/002.runtime-config.ts +8 -1
- package/ts_migration/003.service-data-marker.ts +168 -29
- package/ts_migration/004.global-registry.ts +38 -7
|
@@ -7,7 +7,7 @@ import {
|
|
|
7
7
|
getServiceDataDirectory,
|
|
8
8
|
hasExactServiceContainerLabels,
|
|
9
9
|
isSafeServiceDataPath,
|
|
10
|
-
|
|
10
|
+
isLegacyServiceContainerLabels,
|
|
11
11
|
isServiceOperationHelperLabels,
|
|
12
12
|
markerProvesServiceDataDirectory,
|
|
13
13
|
readServiceDataMarker,
|
|
@@ -120,7 +120,7 @@ const getRegisteredServiceForContainer = (
|
|
|
120
120
|
return undefined;
|
|
121
121
|
}
|
|
122
122
|
const matches: TServiceName[] = [];
|
|
123
|
-
if (projectArg.containers.
|
|
123
|
+
if (projectArg.containers.nosqldb === containerNameArg) matches.push('mongodb');
|
|
124
124
|
if (projectArg.containers.objectstorage === containerNameArg) matches.push('objectstorage');
|
|
125
125
|
if (projectArg.containers.elasticsearch === containerNameArg) matches.push('elasticsearch');
|
|
126
126
|
return matches.length === 1 ? matches[0] : undefined;
|
|
@@ -204,10 +204,13 @@ export class ServicePruner {
|
|
|
204
204
|
claims.push(projectPath);
|
|
205
205
|
nameClaims.set(containerName, claims);
|
|
206
206
|
}
|
|
207
|
-
|
|
208
|
-
|
|
207
|
+
for (const legacyName of [project.legacy?.minioContainer, project.legacy?.mongoContainer]) {
|
|
208
|
+
if (!legacyName) {
|
|
209
|
+
continue;
|
|
210
|
+
}
|
|
211
|
+
const claims = legacyNameClaims.get(legacyName) || [];
|
|
209
212
|
claims.push(projectPath);
|
|
210
|
-
legacyNameClaims.set(
|
|
213
|
+
legacyNameClaims.set(legacyName, claims);
|
|
211
214
|
}
|
|
212
215
|
}
|
|
213
216
|
|
|
@@ -356,16 +359,15 @@ export class ServicePruner {
|
|
|
356
359
|
);
|
|
357
360
|
const registryOwned =
|
|
358
361
|
!hasGitZoneLabels(container.labels) &&
|
|
359
|
-
registeredService
|
|
360
|
-
registeredService !== 'objectstorage' &&
|
|
362
|
+
registeredService === 'elasticsearch' &&
|
|
361
363
|
registryClaims.length === 1 &&
|
|
362
364
|
plugins.path.resolve(registryClaims[0]) === candidate.projectPath;
|
|
363
365
|
const legacyContainer =
|
|
364
|
-
|
|
366
|
+
isLegacyServiceContainerLabels(container.labels) ||
|
|
365
367
|
legacyNameClaims.has(container.name);
|
|
366
368
|
const operationHelper = isServiceOperationHelperLabels(container.labels);
|
|
367
369
|
if (legacyContainer) {
|
|
368
|
-
reason = 'legacy
|
|
370
|
+
reason = 'legacy provider migration resource (MinIO or mongod); preserved and never pruned';
|
|
369
371
|
} else if (operationHelper) {
|
|
370
372
|
reason = 'transient service operation helper; owned only by its invocation';
|
|
371
373
|
} else if (!labelOwned && !registryOwned) {
|
|
@@ -426,11 +428,11 @@ export class ServicePruner {
|
|
|
426
428
|
!isServiceOperationHelperLabels(candidate.containers[indexArg].labels)),
|
|
427
429
|
);
|
|
428
430
|
const ownershipProven =
|
|
429
|
-
service
|
|
431
|
+
service !== 'elasticsearch'
|
|
430
432
|
? markerProvesServiceDataDirectory(marker, candidate.projectPath, service) ||
|
|
431
433
|
candidate.containers.some(
|
|
432
434
|
(containerArg) =>
|
|
433
|
-
containerArg.labels['git.zone.service'] ===
|
|
435
|
+
containerArg.labels['git.zone.service'] === service &&
|
|
434
436
|
hasCanonicalServiceLabels(containerArg, candidate.projectPath),
|
|
435
437
|
)
|
|
436
438
|
: !!marker || !!candidate.registryEntry;
|
|
@@ -595,7 +597,7 @@ export class ServicePruner {
|
|
|
595
597
|
!hasGitZoneLabels(container.labels) &&
|
|
596
598
|
(await this.isClaimedByExactlyOneProject(container.name, planned.projectPath));
|
|
597
599
|
if (
|
|
598
|
-
|
|
600
|
+
isLegacyServiceContainerLabels(container.labels) ||
|
|
599
601
|
isServiceOperationHelperLabels(container.labels) ||
|
|
600
602
|
(await this.isLegacyContainerReference(container.name))
|
|
601
603
|
) {
|
|
@@ -604,14 +606,15 @@ export class ServicePruner {
|
|
|
604
606
|
if (!labelOwned && !registryOwned) {
|
|
605
607
|
throw new Error(`Refusing to remove container with unproven ownership: ${container.name}`);
|
|
606
608
|
}
|
|
609
|
+
const labeledService = container.labels['git.zone.service'];
|
|
607
610
|
if (
|
|
608
611
|
labelOwned &&
|
|
609
|
-
|
|
612
|
+
(labeledService === 'objectstorage' || labeledService === 'mongodb') &&
|
|
610
613
|
(await plugins.smartfs
|
|
611
|
-
.directory(getServiceDataDirectory(planned.projectPath,
|
|
614
|
+
.directory(getServiceDataDirectory(planned.projectPath, labeledService))
|
|
612
615
|
.exists())
|
|
613
616
|
) {
|
|
614
|
-
await recordServiceDataDirectory(planned.projectPath,
|
|
617
|
+
await recordServiceDataDirectory(planned.projectPath, labeledService);
|
|
615
618
|
}
|
|
616
619
|
await this.docker.execArgv(['rm', container.id], { timeoutMs: 60_000 });
|
|
617
620
|
logger.log('ok', `Removed container ${container.name}`);
|
|
@@ -631,7 +634,7 @@ export class ServicePruner {
|
|
|
631
634
|
const marker = await readServiceDataMarker(planned.projectPath);
|
|
632
635
|
const registered = await this.globalRegistry.isRegistered(planned.projectPath);
|
|
633
636
|
const ownershipProven =
|
|
634
|
-
planned.service
|
|
637
|
+
planned.service !== 'elasticsearch'
|
|
635
638
|
? markerProvesServiceDataDirectory(
|
|
636
639
|
marker,
|
|
637
640
|
planned.projectPath,
|
|
@@ -733,7 +736,10 @@ export class ServicePruner {
|
|
|
733
736
|
`Refusing to unregister ${projectPath}: a project-labeled container appeared after planning.`,
|
|
734
737
|
);
|
|
735
738
|
}
|
|
736
|
-
for (const containerName of
|
|
739
|
+
for (const containerName of [
|
|
740
|
+
...Object.values(currentProject.containers),
|
|
741
|
+
currentProject.legacy?.mongoContainer,
|
|
742
|
+
]) {
|
|
737
743
|
if (!containerName) continue;
|
|
738
744
|
const ids = await this.docker.listIds([`name=^/${containerName}$`]);
|
|
739
745
|
if (ids.length > 0) {
|
|
@@ -762,7 +768,7 @@ export class ServicePruner {
|
|
|
762
768
|
}
|
|
763
769
|
return (
|
|
764
770
|
claims.length === 1 &&
|
|
765
|
-
claims[0].service
|
|
771
|
+
claims[0].service === 'elasticsearch' &&
|
|
766
772
|
claims[0].projectPath === plugins.path.resolve(projectPathArg)
|
|
767
773
|
);
|
|
768
774
|
}
|
|
@@ -784,7 +790,9 @@ export class ServicePruner {
|
|
|
784
790
|
private async isLegacyContainerReference(containerNameArg: string): Promise<boolean> {
|
|
785
791
|
const projects = await this.globalRegistry.getAllProjects();
|
|
786
792
|
return Object.values(projects).some(
|
|
787
|
-
(project) =>
|
|
793
|
+
(project) =>
|
|
794
|
+
project.legacy?.minioContainer === containerNameArg ||
|
|
795
|
+
project.legacy?.mongoContainer === containerNameArg,
|
|
788
796
|
);
|
|
789
797
|
}
|
|
790
798
|
}
|
package/ts/mod_services/index.ts
CHANGED
|
@@ -3,6 +3,7 @@ import * as helpers from "./helpers.js";
|
|
|
3
3
|
import { ServiceManager } from "./classes.servicemanager.js";
|
|
4
4
|
import { GlobalRegistry } from "./classes.globalregistry.js";
|
|
5
5
|
import { getServiceDataDirectory } from "./classes.servicedatamarker.js";
|
|
6
|
+
import { serviceSecretEnvironmentNames } from "./classes.serviceconfiguration.js";
|
|
6
7
|
import {
|
|
7
8
|
allowedServiceNames,
|
|
8
9
|
normalizeUserServiceName,
|
|
@@ -102,6 +103,7 @@ export const run = async (argvArg: any) => {
|
|
|
102
103
|
case "status":
|
|
103
104
|
case "compass":
|
|
104
105
|
case "logs":
|
|
106
|
+
case "migrate":
|
|
105
107
|
case "remove":
|
|
106
108
|
case "clean":
|
|
107
109
|
case "reconfigure": {
|
|
@@ -153,6 +155,10 @@ export const run = async (argvArg: any) => {
|
|
|
153
155
|
case "reconfigure":
|
|
154
156
|
await serviceManager.reconfigure();
|
|
155
157
|
break;
|
|
158
|
+
|
|
159
|
+
case "migrate":
|
|
160
|
+
await handleMigrate(serviceManager, argvArg._[2], mode);
|
|
161
|
+
break;
|
|
156
162
|
}
|
|
157
163
|
break;
|
|
158
164
|
}
|
|
@@ -204,17 +210,25 @@ async function updateEnabledServices(services: string[]): Promise<void> {
|
|
|
204
210
|
await writeSmartconfigFile(smartconfigData);
|
|
205
211
|
}
|
|
206
212
|
|
|
213
|
+
/** Replace every secret-bearing runtime field that is present with `***`. */
|
|
214
|
+
function redactServiceEnvironment(
|
|
215
|
+
environmentArg: Record<string, unknown>,
|
|
216
|
+
): Record<string, unknown> {
|
|
217
|
+
const redacted = { ...environmentArg };
|
|
218
|
+
for (const name of serviceSecretEnvironmentNames) {
|
|
219
|
+
if (Object.hasOwn(redacted, name)) {
|
|
220
|
+
redacted[name] = "***";
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
return redacted;
|
|
224
|
+
}
|
|
225
|
+
|
|
207
226
|
async function handleShowConfig(mode: ICliMode) {
|
|
208
227
|
const configData = await readServicesConfig();
|
|
209
228
|
|
|
210
229
|
if (mode.json) {
|
|
211
230
|
const environment = configData.environment
|
|
212
|
-
?
|
|
213
|
-
...configData.environment,
|
|
214
|
-
S3_ACCESSKEY: "***",
|
|
215
|
-
S3_SECRETKEY: "***",
|
|
216
|
-
S3_ADMIN_PASSWORD: "***",
|
|
217
|
-
}
|
|
231
|
+
? redactServiceEnvironment(configData.environment)
|
|
218
232
|
: null;
|
|
219
233
|
printJson({ ...configData, environment });
|
|
220
234
|
return;
|
|
@@ -236,14 +250,14 @@ async function handleShowConfig(mode: ICliMode) {
|
|
|
236
250
|
}
|
|
237
251
|
|
|
238
252
|
const env = configData.environment;
|
|
239
|
-
logger.log("note", "MongoDB:");
|
|
253
|
+
logger.log("note", "MongoDB (NoSQLDB):");
|
|
240
254
|
logger.log("info", ` Host: ${env.MONGODB_HOST}:${env.MONGODB_PORT}`);
|
|
241
255
|
logger.log("info", ` Database: ${env.MONGODB_NAME}`);
|
|
242
256
|
logger.log("info", ` User: ${env.MONGODB_USER}`);
|
|
243
|
-
logger.log("info", ` Container: ${env.PROJECT_NAME}-
|
|
257
|
+
logger.log("info", ` Container: ${env.PROJECT_NAME}-nosqldb`);
|
|
244
258
|
logger.log(
|
|
245
259
|
"info",
|
|
246
|
-
` Auth: ${env.MONGODB_AUTH_ENABLED === false ? "DISABLED
|
|
260
|
+
` Auth: ${env.MONGODB_AUTH_ENABLED === false ? "DISABLED" : "enabled"} (published on loopback only)`,
|
|
247
261
|
);
|
|
248
262
|
logger.log(
|
|
249
263
|
"info",
|
|
@@ -483,6 +497,7 @@ export async function handleRestart(serviceManager: ServiceManager, service: str
|
|
|
483
497
|
switch (service) {
|
|
484
498
|
case "mongo":
|
|
485
499
|
case "mongodb":
|
|
500
|
+
await serviceManager.assertMongoStartupAllowed();
|
|
486
501
|
await serviceManager.stopMongoDB();
|
|
487
502
|
await plugins.smartdelay.delayFor(2000);
|
|
488
503
|
await serviceManager.startMongoDB();
|
|
@@ -508,6 +523,9 @@ export async function handleRestart(serviceManager: ServiceManager, service: str
|
|
|
508
523
|
|
|
509
524
|
case "all":
|
|
510
525
|
case "":
|
|
526
|
+
if (serviceManager.isServiceEnabled("mongodb")) {
|
|
527
|
+
await serviceManager.assertMongoStartupAllowed();
|
|
528
|
+
}
|
|
511
529
|
if (serviceManager.isServiceEnabled("objectstorage")) {
|
|
512
530
|
await serviceManager.assertObjectStorageStartupAllowed();
|
|
513
531
|
}
|
|
@@ -527,6 +545,46 @@ export async function handleRestart(serviceManager: ServiceManager, service: str
|
|
|
527
545
|
}
|
|
528
546
|
}
|
|
529
547
|
|
|
548
|
+
/**
|
|
549
|
+
* Migrate legacy mongod data into the NoSQLDB service explicitly. `start`
|
|
550
|
+
* performs the same migration automatically; this command asks first.
|
|
551
|
+
*/
|
|
552
|
+
async function handleMigrate(
|
|
553
|
+
serviceManager: ServiceManager,
|
|
554
|
+
rawService: string | undefined,
|
|
555
|
+
mode: ICliMode,
|
|
556
|
+
) {
|
|
557
|
+
if (rawService !== "mongodb" && rawService !== "mongo") {
|
|
558
|
+
throw new Error("Usage: gitzone services migrate mongodb [--yes]");
|
|
559
|
+
}
|
|
560
|
+
helpers.printHeader("Migrating MongoDB to NoSQLDB");
|
|
561
|
+
logger.log(
|
|
562
|
+
"note",
|
|
563
|
+
"The legacy mongod container is stopped, dumped, restored into NoSQLDB, verified, and then removed. " +
|
|
564
|
+
".nogit/mongodata and the dump are kept; any failure rolls back.",
|
|
565
|
+
);
|
|
566
|
+
if (!mode.yes) {
|
|
567
|
+
if (!mode.interactive) {
|
|
568
|
+
throw new Error(
|
|
569
|
+
"`services migrate` stops and replaces the legacy database container. Re-run with --yes to confirm non-interactively.",
|
|
570
|
+
);
|
|
571
|
+
}
|
|
572
|
+
const smartinteraction = new plugins.smartinteract.SmartInteract();
|
|
573
|
+
const confirmAnswer = await smartinteraction.askQuestion({
|
|
574
|
+
name: "confirm",
|
|
575
|
+
type: "confirm",
|
|
576
|
+
message: "Migrate now?",
|
|
577
|
+
default: false,
|
|
578
|
+
});
|
|
579
|
+
if (!confirmAnswer.value) {
|
|
580
|
+
logger.log("note", "Cancelled");
|
|
581
|
+
return;
|
|
582
|
+
}
|
|
583
|
+
}
|
|
584
|
+
await serviceManager.startMongoDB();
|
|
585
|
+
await serviceManager.registerWithGlobalRegistry();
|
|
586
|
+
}
|
|
587
|
+
|
|
530
588
|
async function handleRemove(serviceManager: ServiceManager, mode: ICliMode) {
|
|
531
589
|
helpers.printHeader("Removing Containers");
|
|
532
590
|
logger.log("note", "⚠️ This will remove containers but preserve data");
|
|
@@ -829,8 +887,12 @@ export function showHelp(mode?: ICliMode) {
|
|
|
829
887
|
{ name: "status", description: "Show service status" },
|
|
830
888
|
{
|
|
831
889
|
name: "auth mongodb <on|off>",
|
|
890
|
+
description: "Toggle MongoDB (NoSQLDB) authentication",
|
|
891
|
+
},
|
|
892
|
+
{
|
|
893
|
+
name: "migrate mongodb",
|
|
832
894
|
description:
|
|
833
|
-
"
|
|
895
|
+
"Migrate legacy mongod data into NoSQLDB (start does this automatically); --yes skips the prompt",
|
|
834
896
|
},
|
|
835
897
|
{
|
|
836
898
|
name: "prune",
|
|
@@ -892,7 +954,11 @@ export function showHelp(mode?: ICliMode) {
|
|
|
892
954
|
logger.log("info", " reconfigure Reassign ports and restart services");
|
|
893
955
|
logger.log(
|
|
894
956
|
"info",
|
|
895
|
-
" auth mongodb <on|off> Toggle MongoDB
|
|
957
|
+
" auth mongodb <on|off> Toggle MongoDB (NoSQLDB) auth ⚠️",
|
|
958
|
+
);
|
|
959
|
+
logger.log(
|
|
960
|
+
"info",
|
|
961
|
+
" migrate mongodb Migrate legacy mongod data into NoSQLDB [--yes]",
|
|
896
962
|
);
|
|
897
963
|
logger.log(
|
|
898
964
|
"info",
|
|
@@ -917,7 +983,10 @@ export function showHelp(mode?: ICliMode) {
|
|
|
917
983
|
console.log();
|
|
918
984
|
|
|
919
985
|
logger.log("note", "Available Services:");
|
|
920
|
-
logger.log(
|
|
986
|
+
logger.log(
|
|
987
|
+
"info",
|
|
988
|
+
" • MongoDB (mongo) - NoSQLDB document database, MongoDB wire protocol",
|
|
989
|
+
);
|
|
921
990
|
logger.log("info", " • ObjectStorage (s3) - S3-compatible object storage");
|
|
922
991
|
logger.log(
|
|
923
992
|
"info",
|
|
@@ -6,4 +6,7 @@ import * as smartinteract from '@push.rocks/smartinteract';
|
|
|
6
6
|
import * as smartnetwork from '@push.rocks/smartnetwork';
|
|
7
7
|
import * as smartdelay from '@push.rocks/smartdelay';
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
// @lossless.org scope
|
|
10
|
+
import * as nosqldb from '@lossless.org/client/nosqldb';
|
|
11
|
+
|
|
12
|
+
export { smartshell, smartfile, smartinteract, smartnetwork, smartdelay, nosqldb };
|
|
@@ -16,6 +16,7 @@ const stringFields = [
|
|
|
16
16
|
'MONGODB_USER',
|
|
17
17
|
'MONGODB_PASS',
|
|
18
18
|
'MONGODB_URL',
|
|
19
|
+
'MONGODB_ADMIN_PASSWORD',
|
|
19
20
|
'S3_HOST',
|
|
20
21
|
'S3_PORT',
|
|
21
22
|
'S3_UI_PORT',
|
|
@@ -108,7 +109,7 @@ export interface IServiceRuntimeConfigMigrationResult {
|
|
|
108
109
|
migrated: boolean;
|
|
109
110
|
}
|
|
110
111
|
|
|
111
|
-
/** Convert only shipped
|
|
112
|
+
/** Convert only shipped predecessor fields and add generated service secrets. */
|
|
112
113
|
export const migrateLegacyServiceRuntimeConfigValue = (
|
|
113
114
|
configArg: unknown,
|
|
114
115
|
): IServiceRuntimeConfigMigrationResult => {
|
|
@@ -129,6 +130,12 @@ export const migrateLegacyServiceRuntimeConfigValue = (
|
|
|
129
130
|
migrated = true;
|
|
130
131
|
}
|
|
131
132
|
|
|
133
|
+
if (!Object.hasOwn(config, 'MONGODB_ADMIN_PASSWORD')) {
|
|
134
|
+
// Management UI password of the NoSQLDB engine that replaced mongod.
|
|
135
|
+
config.MONGODB_ADMIN_PASSWORD = plugins.crypto.randomBytes(24).toString('base64url');
|
|
136
|
+
migrated = true;
|
|
137
|
+
}
|
|
138
|
+
|
|
132
139
|
if (!Object.hasOwn(config, 'S3_ADMIN_PASSWORD')) {
|
|
133
140
|
config.S3_ADMIN_PASSWORD = plugins.crypto.randomBytes(24).toString('base64url');
|
|
134
141
|
migrated = true;
|
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
import * as plugins from '../ts/plugins.js';
|
|
2
2
|
import {
|
|
3
3
|
getLegacyMinioDataDirectory,
|
|
4
|
+
getLegacyMongoDataDirectory,
|
|
4
5
|
getServiceDataDirectory,
|
|
5
6
|
getServiceDataMarkerLockPath,
|
|
6
7
|
getServiceDataMarkerPath,
|
|
7
8
|
isValidServiceDataMarker,
|
|
8
9
|
serviceDataMarkerSchemaVersion,
|
|
9
10
|
serviceDataOwner,
|
|
11
|
+
type ILegacyServiceDataMarkerEntry,
|
|
10
12
|
type IServiceDataMarker,
|
|
11
13
|
type IServiceDataMarkerEntry,
|
|
12
14
|
type TLegacyServiceName,
|
|
@@ -22,11 +24,23 @@ interface IServiceDataMarkerV1 {
|
|
|
22
24
|
safeToPrune: true;
|
|
23
25
|
createdAt: string;
|
|
24
26
|
dataDirectories: Array<{
|
|
25
|
-
service: TServiceName |
|
|
27
|
+
service: TServiceName | 'minio';
|
|
26
28
|
path: string;
|
|
27
29
|
}>;
|
|
28
30
|
}
|
|
29
31
|
|
|
32
|
+
/** The shipped v2 shape from before NoSQLDB, when `mongodb` owned `.nogit/mongodata`. */
|
|
33
|
+
interface IServiceDataMarkerBeforeNoSqlDb {
|
|
34
|
+
owner: string;
|
|
35
|
+
kind: 'service-data';
|
|
36
|
+
schemaVersion: 2;
|
|
37
|
+
projectPath: string;
|
|
38
|
+
safeToPrune: true;
|
|
39
|
+
createdAt: string;
|
|
40
|
+
dataDirectories: IServiceDataMarkerEntry[];
|
|
41
|
+
legacyDataDirectories?: ILegacyServiceDataMarkerEntry[];
|
|
42
|
+
}
|
|
43
|
+
|
|
30
44
|
const isPlainObject = (valueArg: unknown): valueArg is Record<string, unknown> =>
|
|
31
45
|
typeof valueArg === 'object' && valueArg !== null && !Array.isArray(valueArg);
|
|
32
46
|
|
|
@@ -74,18 +88,136 @@ const isValidServiceDataMarkerV1 = (markerArg: unknown): markerArg is IServiceDa
|
|
|
74
88
|
) {
|
|
75
89
|
return false;
|
|
76
90
|
}
|
|
91
|
+
// v1 predates NoSQLDB: its `mongodb` entry is the legacy mongod directory.
|
|
77
92
|
const expectedPath =
|
|
78
93
|
service === 'minio'
|
|
79
94
|
? getLegacyMinioDataDirectory(projectPath)
|
|
95
|
+
: service === 'mongodb'
|
|
96
|
+
? getLegacyMongoDataDirectory(projectPath)
|
|
97
|
+
: getServiceDataDirectory(projectPath, service as TServiceName);
|
|
98
|
+
if (plugins.path.resolve(entry.path) !== expectedPath) {
|
|
99
|
+
return false;
|
|
100
|
+
}
|
|
101
|
+
seenServices.add(service);
|
|
102
|
+
}
|
|
103
|
+
return true;
|
|
104
|
+
};
|
|
105
|
+
|
|
106
|
+
const markerEnvelopeKeys = [
|
|
107
|
+
'owner',
|
|
108
|
+
'kind',
|
|
109
|
+
'schemaVersion',
|
|
110
|
+
'projectPath',
|
|
111
|
+
'safeToPrune',
|
|
112
|
+
'createdAt',
|
|
113
|
+
'dataDirectories',
|
|
114
|
+
'legacyDataDirectories',
|
|
115
|
+
] as const;
|
|
116
|
+
|
|
117
|
+
const isValidServiceDataMarkerBeforeNoSqlDb = (
|
|
118
|
+
markerArg: unknown,
|
|
119
|
+
): markerArg is IServiceDataMarkerBeforeNoSqlDb => {
|
|
120
|
+
if (
|
|
121
|
+
!isPlainObject(markerArg) ||
|
|
122
|
+
!hasOnlyKeys(markerArg, markerEnvelopeKeys) ||
|
|
123
|
+
markerArg.owner !== serviceDataOwner ||
|
|
124
|
+
markerArg.kind !== 'service-data' ||
|
|
125
|
+
markerArg.schemaVersion !== 2 ||
|
|
126
|
+
markerArg.safeToPrune !== true ||
|
|
127
|
+
typeof markerArg.projectPath !== 'string' ||
|
|
128
|
+
!markerArg.projectPath ||
|
|
129
|
+
typeof markerArg.createdAt !== 'string' ||
|
|
130
|
+
!markerArg.createdAt ||
|
|
131
|
+
!Array.isArray(markerArg.dataDirectories)
|
|
132
|
+
) {
|
|
133
|
+
return false;
|
|
134
|
+
}
|
|
135
|
+
const projectPath = plugins.path.resolve(markerArg.projectPath);
|
|
136
|
+
const seenServices = new Set<string>();
|
|
137
|
+
let hasLegacyMongoEntry = false;
|
|
138
|
+
for (const entry of markerArg.dataDirectories) {
|
|
139
|
+
const service = isPlainObject(entry) ? entry.service : undefined;
|
|
140
|
+
if (
|
|
141
|
+
!isPlainObject(entry) ||
|
|
142
|
+
!hasOnlyKeys(entry, ['service', 'path']) ||
|
|
143
|
+
typeof service !== 'string' ||
|
|
144
|
+
!['mongodb', 'objectstorage', 'elasticsearch'].includes(service) ||
|
|
145
|
+
seenServices.has(service) ||
|
|
146
|
+
typeof entry.path !== 'string'
|
|
147
|
+
) {
|
|
148
|
+
return false;
|
|
149
|
+
}
|
|
150
|
+
const expectedPath =
|
|
151
|
+
service === 'mongodb'
|
|
152
|
+
? getLegacyMongoDataDirectory(projectPath)
|
|
80
153
|
: getServiceDataDirectory(projectPath, service as TServiceName);
|
|
81
154
|
if (plugins.path.resolve(entry.path) !== expectedPath) {
|
|
82
155
|
return false;
|
|
83
156
|
}
|
|
157
|
+
hasLegacyMongoEntry ||= service === 'mongodb';
|
|
84
158
|
seenServices.add(service);
|
|
85
159
|
}
|
|
160
|
+
if (!hasLegacyMongoEntry) {
|
|
161
|
+
return false;
|
|
162
|
+
}
|
|
163
|
+
if (markerArg.legacyDataDirectories !== undefined) {
|
|
164
|
+
if (
|
|
165
|
+
!Array.isArray(markerArg.legacyDataDirectories) ||
|
|
166
|
+
markerArg.legacyDataDirectories.length > 1
|
|
167
|
+
) {
|
|
168
|
+
return false;
|
|
169
|
+
}
|
|
170
|
+
for (const entry of markerArg.legacyDataDirectories) {
|
|
171
|
+
if (
|
|
172
|
+
!isPlainObject(entry) ||
|
|
173
|
+
!hasOnlyKeys(entry, ['service', 'path', 'safeToPrune']) ||
|
|
174
|
+
entry.service !== 'minio' ||
|
|
175
|
+
entry.safeToPrune !== false ||
|
|
176
|
+
typeof entry.path !== 'string' ||
|
|
177
|
+
plugins.path.resolve(entry.path) !== getLegacyMinioDataDirectory(projectPath)
|
|
178
|
+
) {
|
|
179
|
+
return false;
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
}
|
|
86
183
|
return true;
|
|
87
184
|
};
|
|
88
185
|
|
|
186
|
+
const buildMigratedMarker = (
|
|
187
|
+
projectPathArg: string,
|
|
188
|
+
createdAtArg: string,
|
|
189
|
+
dataDirectoriesArg: Array<{ service: string; path: string }>,
|
|
190
|
+
legacyServicesArg: TLegacyServiceName[],
|
|
191
|
+
): IServiceDataMarker => {
|
|
192
|
+
const dataDirectories: IServiceDataMarkerEntry[] = dataDirectoriesArg
|
|
193
|
+
.filter((entry) => entry.service === 'objectstorage' || entry.service === 'elasticsearch')
|
|
194
|
+
.map((entry) => ({
|
|
195
|
+
service: entry.service as TServiceName,
|
|
196
|
+
path: plugins.path.resolve(entry.path),
|
|
197
|
+
}))
|
|
198
|
+
.sort((entryA, entryB) => entryA.service.localeCompare(entryB.service));
|
|
199
|
+
const legacyDataDirectories: ILegacyServiceDataMarkerEntry[] = [...new Set(legacyServicesArg)]
|
|
200
|
+
.sort((serviceA, serviceB) => serviceA.localeCompare(serviceB))
|
|
201
|
+
.map((service) => ({
|
|
202
|
+
service,
|
|
203
|
+
path:
|
|
204
|
+
service === 'minio'
|
|
205
|
+
? getLegacyMinioDataDirectory(projectPathArg)
|
|
206
|
+
: getLegacyMongoDataDirectory(projectPathArg),
|
|
207
|
+
safeToPrune: false as const,
|
|
208
|
+
}));
|
|
209
|
+
return {
|
|
210
|
+
owner: serviceDataOwner,
|
|
211
|
+
kind: 'service-data',
|
|
212
|
+
schemaVersion: serviceDataMarkerSchemaVersion,
|
|
213
|
+
projectPath: projectPathArg,
|
|
214
|
+
safeToPrune: true,
|
|
215
|
+
createdAt: createdAtArg,
|
|
216
|
+
dataDirectories,
|
|
217
|
+
...(legacyDataDirectories.length > 0 ? { legacyDataDirectories } : {}),
|
|
218
|
+
};
|
|
219
|
+
};
|
|
220
|
+
|
|
89
221
|
export interface IServiceDataMarkerMigrationResult {
|
|
90
222
|
marker?: IServiceDataMarker;
|
|
91
223
|
migrated: boolean;
|
|
@@ -104,6 +236,26 @@ export const migrateServiceDataMarkerValue = (
|
|
|
104
236
|
migrated: false,
|
|
105
237
|
};
|
|
106
238
|
}
|
|
239
|
+
if (isValidServiceDataMarkerBeforeNoSqlDb(markerArg)) {
|
|
240
|
+
if (plugins.path.resolve(markerArg.projectPath) !== projectPath) {
|
|
241
|
+
return { migrated: false };
|
|
242
|
+
}
|
|
243
|
+
// The mongod data directory becomes preserved evidence for the NoSQLDB
|
|
244
|
+
// migration; the canonical `mongodb` claim moves to `.nogit/nosqldbdata`
|
|
245
|
+
// only when GitZone creates that directory.
|
|
246
|
+
return {
|
|
247
|
+
marker: buildMigratedMarker(
|
|
248
|
+
projectPath,
|
|
249
|
+
markerArg.createdAt,
|
|
250
|
+
markerArg.dataDirectories,
|
|
251
|
+
[
|
|
252
|
+
...(markerArg.legacyDataDirectories || []).map((entry) => entry.service),
|
|
253
|
+
'mongo',
|
|
254
|
+
],
|
|
255
|
+
),
|
|
256
|
+
migrated: true,
|
|
257
|
+
};
|
|
258
|
+
}
|
|
107
259
|
if (
|
|
108
260
|
!isValidServiceDataMarkerV1(markerArg) ||
|
|
109
261
|
plugins.path.resolve(markerArg.projectPath) !== projectPath
|
|
@@ -111,35 +263,22 @@ export const migrateServiceDataMarkerValue = (
|
|
|
111
263
|
return { migrated: false };
|
|
112
264
|
}
|
|
113
265
|
|
|
114
|
-
const
|
|
115
|
-
|
|
116
|
-
.
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
dataDirectories,
|
|
130
|
-
...(legacyEntry
|
|
131
|
-
? {
|
|
132
|
-
legacyDataDirectories: [
|
|
133
|
-
{
|
|
134
|
-
service: 'minio' as const,
|
|
135
|
-
path: plugins.path.resolve(legacyEntry.path),
|
|
136
|
-
safeToPrune: false as const,
|
|
137
|
-
},
|
|
138
|
-
],
|
|
139
|
-
}
|
|
140
|
-
: {}),
|
|
266
|
+
const legacyServices: TLegacyServiceName[] = [];
|
|
267
|
+
if (markerArg.dataDirectories.some((entry) => entry.service === 'minio')) {
|
|
268
|
+
legacyServices.push('minio');
|
|
269
|
+
}
|
|
270
|
+
if (markerArg.dataDirectories.some((entry) => entry.service === 'mongodb')) {
|
|
271
|
+
legacyServices.push('mongo');
|
|
272
|
+
}
|
|
273
|
+
return {
|
|
274
|
+
marker: buildMigratedMarker(
|
|
275
|
+
projectPath,
|
|
276
|
+
markerArg.createdAt,
|
|
277
|
+
markerArg.dataDirectories,
|
|
278
|
+
legacyServices,
|
|
279
|
+
),
|
|
280
|
+
migrated: true,
|
|
141
281
|
};
|
|
142
|
-
return { marker, migrated: true };
|
|
143
282
|
};
|
|
144
283
|
|
|
145
284
|
const readServiceDataMarkerMigrationInput = async (
|