Merge pull request #387 from vscheuber/main

Improvements in journey and service import
rockcarver · May 2, 2024 · 4e511ec · 4e511ec
2 parents 9fa4856 + 269f53e
commit 4e511ec
Show file tree

Hide file tree

Showing 27 changed files with 6,729 additions and 123 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -119,7 +119,7 @@
     ]
   },
   "dependencies": {
-    "@rockcarver/frodo-lib": "2.0.0-77",
+    "@rockcarver/frodo-lib": "2.0.0-79",
     "chokidar": "^3.5.3",
     "cli-progress": "^3.11.2",
     "cli-table3": "^0.6.3",

diff --git a/src/cli/service/service-import.ts b/src/cli/service/service-import.ts
@@ -25,7 +25,7 @@ interface ServiceImportOptions {
   debug?: boolean;
   curlirize?: boolean;
   global?: boolean;
-  realm?: boolean;
+  currentRealm?: boolean;
 }
 
 program
@@ -53,13 +53,16 @@ program
     )
   )
   .addOption(
-    new Option('-g, --global', 'Import service(s) as global service(s).')
+    new Option(
+      '-g, --global',
+      'Import service(s) as global service(s).'
+    ).default(false)
   )
   .addOption(
     new Option(
       '-r, --current-realm',
-      'Import service(s) into the current realm.'
-    )
+      'Import service(s) into the current realm. Use this flag if you exported a service from one realm and are importing into another realm.'
+    ).default(false)
   )
   .action(
     async (
@@ -81,7 +84,7 @@ program
 
       const clean = options.clean ?? false;
       const globalConfig = options.global ?? false;
-      const realmConfig = options.realm ?? false;
+      const realmConfig = globalConfig ? false : options.currentRealm ?? false;
 
       // import by id
       if (options.serviceId && options.file && (await getTokens())) {

diff --git a/src/ops/AdminOps.ts b/src/ops/AdminOps.ts
@@ -53,7 +53,7 @@ const GENERIC_EXTENSION_ATTRIBUTES = JSON.parse(
   fs.readFileSync(
     path.resolve(
       __dirname,
-      './templates/cloud/GenericExtensionAttributesTemplate.json'
+      './templates/GenericExtensionAttributesTemplate.json'
     ),
     'utf8'
   )
@@ -906,32 +906,33 @@ export async function hideGenericExtensionAttributes(
   try {
     const response = await readConfigEntity('managed');
     const managed = cloneDeep(response);
-    const propertyNames = Object.keys(GENERIC_EXTENSION_ATTRIBUTES);
     const updatedObjects = managed.objects.map((object) => {
       // ignore all other objects
       if (object.name !== getCurrentRealmManagedUser()) {
         return object;
       }
-      propertyNames.forEach((name) => {
+      for (const property of Object.keys(
+        cloneDeep(GENERIC_EXTENSION_ATTRIBUTES)
+      )) {
         if (
           isEqualJson(
-            GENERIC_EXTENSION_ATTRIBUTES[name],
-            object.schema.properties[name],
-            ['viewable', 'usageDescription']
+            GENERIC_EXTENSION_ATTRIBUTES[property],
+            object.schema.properties[property],
+            ['viewable', 'usageDescription', 'searchable']
           ) ||
           includeCustomized
         ) {
-          if (object.schema.properties[name].viewable) {
-            printMessage(`${name}: hide`);
+          if (object.schema.properties[property].viewable) {
+            printMessage(`${property}: hide`);
             // eslint-disable-next-line no-param-reassign
-            object.schema.properties[name].viewable = false;
+            object.schema.properties[property].viewable = false;
           } else {
-            printMessage(`${name}: ignore (already hidden)`);
+            printMessage(`${property}: ignore (already hidden)`);
           }
         } else {
-          printMessage(`${name}: skip (customized)`);
+          printMessage(`${property}: skip (customized)`);
         }
-      });
+      }
       return object;
     });
     managed.objects = updatedObjects;
@@ -955,32 +956,33 @@ export async function showGenericExtensionAttributes(
   try {
     const response = await readConfigEntity('managed');
     const managed = cloneDeep(response);
-    const propertyNames = Object.keys(GENERIC_EXTENSION_ATTRIBUTES);
     const updatedObjects = managed.objects.map((object) => {
       // ignore all other objects
       if (object.name !== getCurrentRealmManagedUser()) {
         return object;
       }
-      propertyNames.forEach((name) => {
+      for (const property of Object.keys(
+        cloneDeep(GENERIC_EXTENSION_ATTRIBUTES)
+      )) {
         if (
           isEqualJson(
-            GENERIC_EXTENSION_ATTRIBUTES[name],
-            object.schema.properties[name],
+            GENERIC_EXTENSION_ATTRIBUTES[property],
+            object.schema.properties[property],
             ['viewable', 'usageDescription']
           ) ||
           includeCustomized
         ) {
-          if (!object.schema.properties[name].viewable) {
-            printMessage(`${name}: show`);
+          if (!object.schema.properties[property].viewable) {
+            printMessage(`${property}: show`);
             // eslint-disable-next-line no-param-reassign
-            object.schema.properties[name].viewable = true;
+            object.schema.properties[property].viewable = true;
           } else {
-            printMessage(`${name}: ignore (already showing)`);
+            printMessage(`${property}: ignore (already showing)`);
           }
         } else {
-          printMessage(`${name}: skip (customized)`);
+          printMessage(`${property}: skip (customized)`);
         }
-      });
+      }
       return object;
     });
     managed.objects = updatedObjects;

diff --git a/src/ops/JourneyOps.ts b/src/ops/JourneyOps.ts
@@ -463,7 +463,12 @@ export async function importFirstJourneyFromFile(
               0,
               `Importing ${journeyId}...`
             );
-          stopProgressIndicator(importSpinnerId, `${importError}`, 'fail');
+          stopProgressIndicator(
+            importSpinnerId,
+            `Error importing ${journeyId}`,
+            'fail'
+          );
+          printError(importError);
         }
       } else {
         stopProgressIndicator(depSpinnerId, `Unresolved dependencies:`, 'fail');

diff --git a/...d/GenericExtensionAttributesTemplate.json → ...s/GenericExtensionAttributesTemplate.json b/...d/GenericExtensionAttributesTemplate.json → ...s/GenericExtensionAttributesTemplate.json
@@ -2,6 +2,7 @@
   "frIndexedDate1": {
     "description": "Generic Indexed Date 1",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed Date 1",
     "type": "string",
     "usageDescription": "",
@@ -11,6 +12,7 @@
   "frIndexedDate2": {
     "description": "Generic Indexed Date 2",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed Date 2",
     "type": "string",
     "usageDescription": "",
@@ -20,6 +22,7 @@
   "frIndexedDate3": {
     "description": "Generic Indexed Date 3",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed Date 3",
     "type": "string",
     "usageDescription": "",
@@ -29,6 +32,7 @@
   "frIndexedDate4": {
     "description": "Generic Indexed Date 4",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed Date 4",
     "type": "string",
     "usageDescription": "",
@@ -38,6 +42,7 @@
   "frIndexedDate5": {
     "description": "Generic Indexed Date 5",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed Date 5",
     "type": "string",
     "usageDescription": "",
@@ -47,6 +52,7 @@
   "frIndexedInteger1": {
     "description": "Generic Indexed Integer 1",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed Integer 1",
     "type": "number",
     "usageDescription": "",
@@ -56,6 +62,7 @@
   "frIndexedInteger2": {
     "description": "Generic Indexed Integer 2",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed Integer 2",
     "type": "number",
     "usageDescription": "",
@@ -65,6 +72,7 @@
   "frIndexedInteger3": {
     "description": "Generic Indexed Integer 3",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed Integer 3",
     "type": "number",
     "usageDescription": "",
@@ -74,6 +82,7 @@
   "frIndexedInteger4": {
     "description": "Generic Indexed Integer 4",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed Integer 4",
     "type": "number",
     "usageDescription": "",
@@ -83,6 +92,7 @@
   "frIndexedInteger5": {
     "description": "Generic Indexed Integer 5",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed Integer 5",
     "type": "number",
     "usageDescription": "",
@@ -95,6 +105,7 @@
     "items": {
       "type": "string"
     },
+    "searchable": true,
     "title": "Generic Indexed Multivalue 1",
     "type": "array",
     "usageDescription": "",
@@ -107,6 +118,7 @@
     "items": {
       "type": "string"
     },
+    "searchable": true,
     "title": "Generic Indexed Multivalue 2",
     "type": "array",
     "usageDescription": "",
@@ -119,6 +131,7 @@
     "items": {
       "type": "string"
     },
+    "searchable": true,
     "title": "Generic Indexed Multivalue 3",
     "type": "array",
     "usageDescription": "",
@@ -131,6 +144,7 @@
     "items": {
       "type": "string"
     },
+    "searchable": true,
     "title": "Generic Indexed Multivalue 4",
     "type": "array",
     "usageDescription": "",
@@ -143,6 +157,7 @@
     "items": {
       "type": "string"
     },
+    "searchable": true,
     "title": "Generic Indexed Multivalue 5",
     "type": "array",
     "usageDescription": "",
@@ -152,6 +167,7 @@
   "frIndexedString1": {
     "description": "Generic Indexed String 1",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed String 1",
     "type": "string",
     "usageDescription": "",
@@ -161,6 +177,7 @@
   "frIndexedString2": {
     "description": "Generic Indexed String 2",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed String 2",
     "type": "string",
     "usageDescription": "",
@@ -170,6 +187,7 @@
   "frIndexedString3": {
     "description": "Generic Indexed String 3",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed String 3",
     "type": "string",
     "usageDescription": "",
@@ -179,6 +197,7 @@
   "frIndexedString4": {
     "description": "Generic Indexed String 4",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed String 4",
     "type": "string",
     "usageDescription": "",
@@ -188,6 +207,7 @@
   "frIndexedString5": {
     "description": "Generic Indexed String 5",
     "isPersonal": false,
+    "searchable": true,
     "title": "Generic Indexed String 5",
     "type": "string",
     "usageDescription": "",

diff --git a/test/client_cli/en/__snapshots__/service-import.test.js.snap b/test/client_cli/en/__snapshots__/service-import.test.js.snap
@@ -33,6 +33,7 @@ Options:
                                  from. Ignored with -A.
   --flush-cache                  Flush token cache.
   -g, --global                   Import service(s) as global service(s).
+                                 (default: false)
   -h, --help                     Help
   -i, --service-id <service-id>  Service id. If specified, -a and -A are
                                  ignored.
@@ -58,7 +59,10 @@ Options:
                                  admin login flow of Identity Cloud and handle
                                  MFA (choices: "classic", "cloud", "forgeops")
   --no-cache                     Disable token cache for this operation.
-  -r, --current-realm            Import service(s) into the current realm.
+  -r, --current-realm            Import service(s) into the current realm. Use
+                                 this flag if you exported a service from one
+                                 realm and are importing into another realm.
+                                 (default: false)
   --sa-id <sa-id>                Service account id.
   --sa-jwk-file <file>           File containing the JSON Web Key (JWK)
                                  associated with the the service account.

diff --git a/test/e2e/mocks/github_584874290/recording.har b/test/e2e/mocks/github_584874290/recording.har
diff --git a/test/e2e/mocks/npmjs_1455397529/recording.har b/test/e2e/mocks/npmjs_1455397529/recording.har