@opencrvs/toolkit 2.2.0-rc.045257f → 2.2.0-rc.1a111f2

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.
Files changed (54) hide show
  1. package/dist/cli.js +925 -356
  2. package/dist/commons/api/router.d.ts +4 -4
  3. package/dist/commons/events/ActionType.d.ts +2 -0
  4. package/dist/commons/events/AdvancedSearchConfig.d.ts +3 -0
  5. package/dist/commons/events/Draft.d.ts +34 -1
  6. package/dist/commons/events/EventConfig.d.ts +385 -0
  7. package/dist/commons/events/defineConfig.d.ts +7 -2
  8. package/dist/commons/events/event.d.ts +4 -1
  9. package/dist/commons/events/field.d.ts +5 -0
  10. package/dist/commons/events/scopes.d.ts +1 -0
  11. package/dist/commons/events/test.utils.d.ts +57 -5
  12. package/dist/commons/events/utils.d.ts +13 -0
  13. package/dist/environment/custom-types.d.ts +1 -0
  14. package/dist/environment/custom-types.d.ts.map +1 -1
  15. package/dist/environment/derived-variables.d.ts +8 -0
  16. package/dist/environment/derived-variables.d.ts.map +1 -1
  17. package/dist/environment/derived-variables.js +9 -0
  18. package/dist/environment/questions.d.ts +42 -9
  19. package/dist/environment/questions.d.ts.map +1 -1
  20. package/dist/environment/questions.js +70 -47
  21. package/dist/environment/registry.d.ts +15 -0
  22. package/dist/environment/registry.d.ts.map +1 -0
  23. package/dist/environment/registry.js +112 -0
  24. package/dist/environment/setup-environment.d.ts.map +1 -1
  25. package/dist/environment/setup-environment.js +98 -23
  26. package/dist/events/index.js +462 -99
  27. package/dist/migrations/add-notify-config.d.ts +40 -0
  28. package/dist/migrations/add-notify-config.d.ts.map +1 -0
  29. package/dist/migrations/add-notify-config.js +249 -0
  30. package/dist/migrations/index.d.ts.map +1 -1
  31. package/dist/migrations/index.js +602 -143
  32. package/dist/migrations/move-declaration-to-declare-action.d.ts.map +1 -1
  33. package/dist/migrations/move-declaration-to-declare-action.js +27 -144
  34. package/dist/migrations/read-declaration-through-helper.d.ts.map +1 -1
  35. package/dist/migrations/read-declaration-through-helper.js +3 -61
  36. package/dist/migrations/resolve-versioned-event-config.d.ts +56 -0
  37. package/dist/migrations/resolve-versioned-event-config.d.ts.map +1 -0
  38. package/dist/migrations/resolve-versioned-event-config.js +353 -0
  39. package/dist/migrations/utils.d.ts +61 -0
  40. package/dist/migrations/utils.d.ts.map +1 -0
  41. package/dist/migrations/utils.js +218 -0
  42. package/dist/notification/index.js +510 -36
  43. package/dist/templates/charts-values/dependencies/values.yaml +2 -1
  44. package/dist/templates/charts-values/opencrvs-services/values.yaml +2 -2
  45. package/dist/verify/endpoints.d.ts +11 -0
  46. package/dist/verify/endpoints.d.ts.map +1 -1
  47. package/dist/verify/endpoints.js +21 -27
  48. package/opencrvs-toolkit-2.2.0-rc.1a111f2.tgz +0 -0
  49. package/package.json +2 -1
  50. package/tsconfig.build.tsbuildinfo +1 -1
  51. package/dist/environment/dockerhub.d.ts +0 -15
  52. package/dist/environment/dockerhub.d.ts.map +0 -1
  53. package/dist/environment/dockerhub.js +0 -104
  54. package/opencrvs-toolkit-2.2.0-rc.045257f.tgz +0 -0
@@ -65,11 +65,11 @@ const update_workflows_1 = require("./update-workflows");
65
65
  const questions_1 = require("./questions");
66
66
  const editor_questions_1 = require("./editor-questions");
67
67
  const questions_helper_1 = require("./questions-helper");
68
- const dockerhub_1 = require("./dockerhub");
68
+ const registry_1 = require("./registry");
69
69
  const manage_users_1 = require("./manage-users");
70
70
  const paths_1 = require("./paths");
71
71
  function questionToPrompt(_a) {
72
- var { valueType, valueLabel, scope } = _a, promptOptions = __rest(_a, ["valueType", "valueLabel", "scope"]);
72
+ var { valueType, valueLabel, legacyValueLabel, scope } = _a, promptOptions = __rest(_a, ["valueType", "valueLabel", "legacyValueLabel", "scope"]);
73
73
  return promptOptions;
74
74
  }
75
75
  const ALL_QUESTIONS = [];
@@ -113,6 +113,14 @@ function getAnswers(existingValues) {
113
113
  });
114
114
  });
115
115
  }
116
+ // The value of a variable that exists, as the initial value of its question.
117
+ // A select question takes the index of the choice.
118
+ function getInitialValue(question, variable) {
119
+ if (question.type === 'select' && Array.isArray(question.choices)) {
120
+ return (0, questions_helper_1.getIndexFromChoices)(question.choices, variable.value);
121
+ }
122
+ return variable.value;
123
+ }
116
124
  function promptAndStoreAnswer(questions, existingValues) {
117
125
  return __awaiter(this, void 0, void 0, function* () {
118
126
  (0, logger_1.log)('');
@@ -123,13 +131,15 @@ function promptAndStoreAnswer(questions, existingValues) {
123
131
  }
124
132
  if (questionWithVariableLabel.valueType === 'VARIABLE') {
125
133
  const existingVariable = (0, utils_1.findExistingValue)(questionWithVariableLabel.valueLabel, 'VARIABLE', questionWithVariableLabel.scope, existingValues);
134
+ // Unlike a secret, the value of a variable can be read, so one that only exists
135
+ // under its previous name is the default of the question
136
+ const legacyVariable = !existingVariable && questionWithVariableLabel.legacyValueLabel
137
+ ? (0, utils_1.findExistingValue)(questionWithVariableLabel.legacyValueLabel, 'VARIABLE', questionWithVariableLabel.scope, existingValues)
138
+ : undefined;
139
+ if (legacyVariable) {
140
+ return Object.assign(Object.assign({}, questionWithVariableLabel), { message: `${questionWithVariableLabel.message} ${kleur_1.default.gray(`(default taken from ${legacyVariable.name}, the previous name of this variable)`)}`, initial: getInitialValue(questionWithVariableLabel, legacyVariable) });
141
+ }
126
142
  if (existingVariable) {
127
- let initial_value = existingVariable.value;
128
- // Get correct initial value for select questions
129
- if (questionWithVariableLabel.type === 'select' &&
130
- Array.isArray(questionWithVariableLabel.choices)) {
131
- initial_value = (0, questions_helper_1.getIndexFromChoices)(questionWithVariableLabel.choices, existingVariable.value);
132
- }
133
143
  return [
134
144
  {
135
145
  name: 'overWrite' + questionWithVariableLabel.name,
@@ -137,12 +147,30 @@ function promptAndStoreAnswer(questions, existingValues) {
137
147
  scope: questionWithVariableLabel.scope,
138
148
  message: `${kleur_1.default.yellow(`Variable ${kleur_1.default.cyan(existingVariable.name)} already exists in Github. Do you want to update it?`)}`
139
149
  },
140
- Object.assign(Object.assign({}, questionWithVariableLabel), { type: ((prev) => prev ? questionWithVariableLabel.type : null), initial: initial_value })
150
+ Object.assign(Object.assign({}, questionWithVariableLabel), { type: ((prev) => prev ? questionWithVariableLabel.type : null), initial: getInitialValue(questionWithVariableLabel, existingVariable) })
141
151
  ];
142
152
  }
143
153
  }
144
154
  if (questionWithVariableLabel.valueType === 'SECRET') {
145
155
  const existingSecret = (0, utils_1.findExistingValue)(questionWithVariableLabel.valueLabel, 'SECRET', questionWithVariableLabel.scope, existingValues);
156
+ // The value of a secret that only exists under its previous name can't be read, so
157
+ // it is left to the secrets migration workflow, unless a new value is entered here
158
+ const legacySecret = !existingSecret && questionWithVariableLabel.legacyValueLabel
159
+ ? (0, utils_1.findExistingValue)(questionWithVariableLabel.legacyValueLabel, 'SECRET', questionWithVariableLabel.scope, existingValues)
160
+ : undefined;
161
+ if (legacySecret) {
162
+ return [
163
+ {
164
+ name: 'overWrite' + questionWithVariableLabel.name,
165
+ type: 'confirm',
166
+ scope: questionWithVariableLabel.scope,
167
+ message: `${kleur_1.default.yellow(`${legacySecret.scope === 'REPOSITORY'
168
+ ? 'Repository secret'
169
+ : 'Secret'} ${kleur_1.default.cyan(legacySecret.name)} already exists in Github under the previous name of ${kleur_1.default.cyan(questionWithVariableLabel.valueLabel)}. The secrets migration workflow copies it. Do you want to enter a new value instead?`)}`
170
+ },
171
+ Object.assign(Object.assign({}, questionWithVariableLabel), { type: ((prev) => prev ? questionWithVariableLabel.type : null) })
172
+ ];
173
+ }
146
174
  if (existingSecret) {
147
175
  return [
148
176
  {
@@ -176,16 +204,39 @@ function promptAndStoreAnswer(questions, existingValues) {
176
204
  return Object.assign(Object.assign({}, Object.fromEntries(existingValuesForQuestions)), result);
177
205
  });
178
206
  }
179
- function promptAndValidateDockerhub(existingValues) {
207
+ /**
208
+ * The value of a secret or variable that is generated rather than asked for, or
209
+ * null when it exists. One that only exists under its previous name counts as
210
+ * existing: the secrets migration workflow copies it, and a generated value
211
+ * would replace the credential that is in use.
212
+ */
213
+ function defineIfMissing(existingValues, name, type, scope, newValue) {
214
+ var _a;
215
+ if ((0, utils_1.findExistingValue)(name, type, scope, existingValues)) {
216
+ return null;
217
+ }
218
+ const legacyName = (_a = ALL_QUESTIONS.find((question) => question.valueLabel === name &&
219
+ question.valueType === type &&
220
+ question.scope === scope)) === null || _a === void 0 ? void 0 : _a.legacyValueLabel;
221
+ if (legacyName &&
222
+ (0, utils_1.findExistingValue)(legacyName, type, scope, existingValues)) {
223
+ (0, logger_1.log)(kleur_1.default.bold().green('✔'), kleur_1.default
224
+ .bold()
225
+ .yellow(`${legacyName} exists, the secrets migration workflow copies it to ${name}`));
226
+ return null;
227
+ }
228
+ return process.env[name] || newValue;
229
+ }
230
+ function promptAndValidateRegistry(existingValues) {
180
231
  return __awaiter(this, void 0, void 0, function* () {
181
- const answers = yield promptAndStoreAnswer(questions_1.dockerhubQuestions, existingValues);
182
- const result = yield (0, dockerhub_1.validateDockerHubCredentials)(answers.dockerhubOrganisation, answers.dockerhubRepository, answers.dockerhubUsername, answers.dockerhubToken);
232
+ const answers = yield promptAndStoreAnswer(questions_1.registryQuestions, existingValues);
233
+ const result = yield (0, registry_1.validateRegistryCredentials)(answers.registryHost, answers.registryOrganisation, answers.registryRepository, answers.registryUsername, answers.registryToken);
183
234
  if (result.status === 'valid' || result.status === 'skipped') {
184
235
  return;
185
236
  }
186
237
  (0, logger_1.error)(`\n${result.status}: ${result.reason || 'Generic error'}\n`);
187
238
  const continueNotValidated = yield confirm({
188
- message: 'Docker Hub credentials are not validated. Continue anyway?',
239
+ message: 'Container registry credentials are not validated. Continue anyway?',
189
240
  default: false
190
241
  });
191
242
  if (!continueNotValidated) {
@@ -193,7 +244,7 @@ function promptAndValidateDockerhub(existingValues) {
193
244
  }
194
245
  });
195
246
  }
196
- ALL_QUESTIONS.push(...questions_1.githubTokenQuestion, ...questions_1.githubOtherQuestions, ...questions_1.dockerhubQuestions, ...questions_1.diskQuestions, ...questions_1.infrastructureQuestions, ...questions_1.backupQuestions, ...questions_1.countryQuestions, ...questions_1.databaseAndMonitoringQuestions, ...questions_1.emailQuestions, ...questions_1.sentryQuestions, ...derived_variables_1.derivedVariables, ...questions_1.metabaseAdminQuestions);
247
+ ALL_QUESTIONS.push(...questions_1.githubTokenQuestion, ...questions_1.githubOtherQuestions, ...questions_1.registryQuestions, ...questions_1.diskQuestions, ...questions_1.infrastructureQuestions, ...questions_1.backupQuestions, ...questions_1.countryQuestions, ...questions_1.databaseAndMonitoringQuestions, ...questions_1.emailQuestions, ...questions_1.sentryQuestions, ...derived_variables_1.derivedVariables, ...questions_1.metabaseAdminQuestions);
197
248
  function runSetupEnvironment() {
198
249
  return __awaiter(this, void 0, void 0, function* () {
199
250
  var _a, _b, _c, _d;
@@ -283,7 +334,15 @@ function runSetupEnvironment() {
283
334
  (0, logger_1.log)('\n', kleur_1.default
284
335
  .yellow()
285
336
  .bold('WARNING! You are setting up a production environment.\n Make sure you have read the deployment guide carefully before proceeding.\n'));
286
- yield promptAndStoreAnswer(questions_1.githubOtherQuestions, existingValues);
337
+ }
338
+ (0, logger_1.log)('\n', kleur_1.default.bold().underline('Workflow approvals'));
339
+ // The workflows require approval unless APPROVAL_REQUIRED is 'false'
340
+ const { approvalRequired } = yield promptAndStoreAnswer([
341
+ Object.assign(Object.assign({}, questions_1.githubApprovalRequiredQuestion), { initial: (0, questions_helper_1.getIndexFromChoices)(questions_1.githubApprovalRequiredQuestion.choices, process.env.APPROVAL_REQUIRED ||
342
+ (environment_type === 'production' ? 'true' : 'false')) })
343
+ ], existingValues);
344
+ if (approvalRequired !== 'false') {
345
+ yield promptAndStoreAnswer([questions_1.githubApproversQuestion], existingValues);
287
346
  }
288
347
  (0, logger_1.log)('\n', kleur_1.default.bold().underline('Two-factor authentication (2FA)'));
289
348
  const existingTwoFaEnabled = (0, utils_1.findExistingValue)('TWO_FA_ENABLED', 'VARIABLE', 'ENVIRONMENT', existingValues);
@@ -297,8 +356,8 @@ function runSetupEnvironment() {
297
356
  if (!two_fa_enabled && ['production', 'staging'].includes(environment_type)) {
298
357
  (0, logger_1.warn)('2FA is disabled on a production-like environment. Logins will accept the fixed test code 000000, exposing real citizen data. Only do this if you know what you are doing.');
299
358
  }
300
- (0, logger_1.log)('\n', kleur_1.default.bold().underline('Docker Hub'));
301
- yield promptAndValidateDockerhub(existingValues);
359
+ (0, logger_1.log)('\n', kleur_1.default.bold().underline('Container registry'));
360
+ yield promptAndValidateRegistry(existingValues);
302
361
  (0, logger_1.log)('\n', kleur_1.default.bold().underline('Kubernetes & Runtime'));
303
362
  const infrastructure = yield promptAndStoreAnswer(questions_1.infrastructureQuestions, existingValues);
304
363
  const kubeWorkerNodes = infrastructure.kubeWorkerNodes
@@ -360,6 +419,15 @@ function runSetupEnvironment() {
360
419
  .yellow('Variable DISK_SPACE is read-only, allocated space:'), DISK_SPACE === null || DISK_SPACE === void 0 ? void 0 : DISK_SPACE.value);
361
420
  }
362
421
  }
422
+ // Where RustFS keeps its data. A new environment starts on RustFS in
423
+ // /data/rustfs. An environment that already exists ran MinIO, so RustFS takes over
424
+ // /data/minio in place. The directory is not renamed, because the running MinIO
425
+ // would lose it before the deployment replaces it. The value is decided once and
426
+ // read back on the next run, otherwise an environment created on RustFS would
427
+ // look like an existing one from then on.
428
+ const existingRustfsHostDataPath = (0, utils_1.findExistingValue)('RUSTFS_HOST_DATA_PATH', 'VARIABLE', 'ENVIRONMENT', existingValues);
429
+ const rustfs_host_data_path = (existingRustfsHostDataPath === null || existingRustfsHostDataPath === void 0 ? void 0 : existingRustfsHostDataPath.value) ||
430
+ (environment_exists ? '/data/minio' : '/data/rustfs');
363
431
  // Backup and restore configuration
364
432
  let backupHost = ((_a = (0, utils_1.findExistingValue)('BACKUP_HOST', 'VARIABLE', 'ENVIRONMENT', existingValues)) === null || _a === void 0 ? void 0 : _a.value) || '';
365
433
  let backupType = '';
@@ -478,11 +546,7 @@ function runSetupEnvironment() {
478
546
  * Variables the user doesn't need to set manually
479
547
  */
480
548
  const answerOrExisting = (variable, existingValue, fn) => fn(variable || (existingValue === null || existingValue === void 0 ? void 0 : existingValue.value)) || '';
481
- function findExistingOrDefine(name, type, scope, newValue) {
482
- return (0, utils_1.findExistingValue)(name, type, scope, existingValues)
483
- ? null
484
- : process.env[name] || newValue;
485
- }
549
+ const findExistingOrDefine = (name, type, scope, newValue) => defineIfMissing(existingValues, name, type, scope, newValue);
486
550
  const derivedUpdates = [
487
551
  {
488
552
  name: 'GH_ENCRYPTION_PASSWORD',
@@ -516,6 +580,15 @@ function runSetupEnvironment() {
516
580
  value: monitoring_enabled ? 'true' : 'false',
517
581
  scope: 'ENVIRONMENT'
518
582
  });
583
+ // Read back on the next run, to keep the volume of MinIO for an environment
584
+ // that migrated
585
+ derivedUpdates.push({
586
+ name: 'RUSTFS_HOST_DATA_PATH',
587
+ type: 'VARIABLE',
588
+ didExist: existingRustfsHostDataPath,
589
+ value: rustfs_host_data_path,
590
+ scope: 'ENVIRONMENT'
591
+ });
519
592
  derivedUpdates.push(...ssl_answers);
520
593
  if (configureBackup) {
521
594
  derivedUpdates.push({
@@ -681,7 +754,8 @@ function runSetupEnvironment() {
681
754
  const newVariables = updates.filter((update) => update.type === 'VARIABLE' && !update.didExist);
682
755
  const updatedVariables = updates.filter((update) => update.type === 'VARIABLE' && Boolean(update.didExist));
683
756
  const unknownVariables = existingValues.filter((value) => {
684
- return !ALL_QUESTIONS.find((question) => question.valueLabel === value.name &&
757
+ return !ALL_QUESTIONS.find((question) => (question.valueLabel === value.name ||
758
+ question.legacyValueLabel === value.name) &&
685
759
  question.valueType === value.type &&
686
760
  question.scope === value.scope);
687
761
  });
@@ -811,6 +885,7 @@ function runSetupEnvironment() {
811
885
  environment_type: environment_type,
812
886
  two_fa_enabled,
813
887
  monitoring_enabled,
888
+ rustfs_host_data_path,
814
889
  traefik_mode: traefikConfOption,
815
890
  restore_enabled: restoreEnvironmentName ? true : false,
816
891
  restore_environment_name: restoreEnvironmentName || '',