TA-3148: Update NodeExportTransport and export/import logic to work with JSON files

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@celonis/content-cli",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "CLI Tool to help manage content in Celonis EMS",
   "main": "content-cli.js",
   "bin": {

src/content/factory/widget-manager.factory.ts

@@ -3,7 +3,7 @@ import * as path from "path";
 import { FatalError, logger } from "../../util/logger";
 import { WidgetManager } from "../manager/widget.manager";
 import * as AdmZip from "adm-zip";
-import {parse} from "../../util/yaml";
+import {parse} from "../../util/json";
 
 interface Manifest {
     key: string;

src/content/manager/analysis.manager.ts

@@ -2,7 +2,7 @@ import { BaseManager } from "./base.manager";
 import { ManagerConfig } from "../../interfaces/manager-config.interface";
 import { AssetManager } from "./asset.manager";
 import * as fs from "fs";
-import {stringify} from "../../util/yaml";
+import {stringify} from "../../util/json";
 import * as FormData from "form-data";
 
 export class AnalysisManager extends BaseManager {

src/content/manager/asset.manager.ts

@@ -1,7 +1,7 @@
 import { BaseManager } from "./base.manager";
 import { ManagerConfig } from "../../interfaces/manager-config.interface";
 import { SaveContentNode } from "../../interfaces/save-content-node.interface";
-import { parse, stringify } from "../../util/yaml";
+import { parse, stringify } from "../../util/json";
 
 export class AssetManager extends BaseManager {
     public static ASSET_FILE_PREFIX = "asset_";

src/interfaces/batch-export-import-constants.ts

@@ -1,11 +1,11 @@
 export enum BatchExportImportConstants {
-    STUDIO_FILE_NAME = "studio.yml",
-    VARIABLES_FILE_NAME = "variables.yml",
-    MANIFEST_FILE_NAME = "manifest.yml",
+    STUDIO_FILE_NAME = "studio.json",
+    VARIABLES_FILE_NAME = "variables.json",
+    MANIFEST_FILE_NAME = "manifest.json",
     STUDIO = "STUDIO",
     APP_MODE_VIEWER = "VIEWER",
     ZIP_EXTENSION = ".zip",
-    YAML_EXTENSION = ".yml",
+    JSON_EXTENSION = ".json",
     NODES_FOLDER_NAME = "nodes/",
     SCENARIO_NODE = "SCENARIO"
 }

src/interfaces/package-export-transport.ts

@@ -51,7 +51,7 @@ export interface NodeExportTransport {
     name: string;
     type: string;
     exportSerializationType: string;
-    configuration: string;
+    configuration: NodeConfiguration;
     schemaVersion: number;
 
     spaceId: string;
@@ -60,8 +60,8 @@ export interface NodeExportTransport {
     serializedDocument?: Buffer;
 }
 
-export interface NodeSerializedContent {
-    variables: VariableDefinition[]
+export interface NodeConfiguration {
+    [key: string]: any;
 }
 
 export interface StudioPackageManifest {

src/services/file-service.ts

@@ -2,7 +2,7 @@ import * as fs from "fs";
 import * as path from "path";
 import { ManifestNodeTransport } from "../interfaces/manifest-transport";
 import { FatalError, logger } from "../util/logger";
-import {parse} from "../util/yaml";
+import {parse} from "../util/json";
 
 export class FileService {
     public static readonly fileDownloadedMessage = "File downloaded successfully. New filename: ";

src/services/package-manager/batch-import-export-service.ts

@@ -10,7 +10,7 @@ import {
 } from "../../interfaces/package-export-transport";
 import {FileService, fileService} from "../file-service";
 import {studioService} from "../studio/studio.service";
-import {parse, stringify} from "../../util/yaml"
+import {parse, stringify} from "../../util/json"
 import * as FormData from "form-data";
 import {BatchExportImportConstants} from "../../interfaces/batch-export-import-constants";
 import {packageApi} from "../../api/package-api";

src/services/package-manager/package-service.ts

@@ -21,7 +21,7 @@ import {SpaceTransport} from "../../interfaces/save-space.interface";
 import {ManifestDependency, ManifestNodeTransport} from "../../interfaces/manifest-transport";
 import {DataPoolInstallVersionReport} from "../../interfaces/data-pool-manager.interfaces";
 import {SemanticVersioning} from "../../util/semantic-versioning"
-import {stringify} from "../../util/yaml";
+import {stringify} from "../../util/json";
 import * as FormData from "form-data";
 
 class PackageService {

src/services/studio/studio.service.ts

@@ -1,11 +1,11 @@
 import {
+    NodeConfiguration,
     NodeExportTransport,
-    NodeSerializedContent,
     PackageExportTransport,
     PackageKeyAndVersionPair,
     StudioPackageManifest,
     VariableExportTransport,
-    VariableManifestTransport
+    VariableManifestTransport,
 } from "../../interfaces/package-export-transport";
 
 import {packageApi} from "../../api/package-api";
@@ -17,7 +17,7 @@ import {
 } from "../../interfaces/package-manager.interfaces";
 import {dataModelService} from "../package-manager/datamodel-service";
 import {IZipEntry} from "adm-zip";
-import {parse, stringify} from "../../util/yaml";
+import {parse, stringify} from "../../util/json";
 import {nodeApi} from "../../api/node-api";
 import {variablesApi} from "../../api/variables-api";
 import {spaceApi} from "../../api/space-api";
@@ -140,7 +140,7 @@ class StudioService {
     }
 
     private deleteScenarioAssets(packageZip: AdmZip): void {
-        packageZip.getEntries().filter(entry => entry.entryName.startsWith(BatchExportImportConstants.NODES_FOLDER_NAME) && entry.entryName.endsWith(BatchExportImportConstants.YAML_EXTENSION))
+        packageZip.getEntries().filter(entry => entry.entryName.startsWith(BatchExportImportConstants.NODES_FOLDER_NAME) && entry.entryName.endsWith(BatchExportImportConstants.JSON_EXTENSION))
             .forEach(entry => {
                 const node: NodeExportTransport = parse(entry.getData().toString());
                 if (node.type === BatchExportImportConstants.SCENARIO_NODE) {
@@ -157,18 +157,18 @@ class StudioService {
             return;
         }
 
-        const packageEntry = packageZip.getEntry("package.yml");
+        const packageEntry = packageZip.getEntry("package.json");
 
         const exportedNode: NodeExportTransport = parse(packageEntry.getData().toString());
-        const nodeContent: NodeSerializedContent = parse(exportedNode.configuration);
+        const nodeContent: NodeConfiguration = exportedNode.configuration;
 
         nodeContent.variables = nodeContent.variables.map(variable => ({
             ...variable,
             metadata: variable.type === PackageManagerVariableType.CONNECTION ?
                 connectionVariablesByKey.get(variable.key).metadata : variable.metadata
         }));
 
-        exportedNode.configuration = stringify(nodeContent);
+        exportedNode.configuration = nodeContent;
         packageZip.updateFile(packageEntry, Buffer.from(stringify(exportedNode)));
     }
 
@@ -212,7 +212,7 @@ class StudioService {
 
                         const packageZip = new AdmZip(file.getData());
                         packageZip.getEntries().forEach(nodeFile => {
-                            if (nodeFile.entryName.endsWith(BatchExportImportConstants.YAML_EXTENSION)) {
+                            if (nodeFile.entryName.endsWith(BatchExportImportConstants.JSON_EXTENSION)) {
                                 const updatedNodeFile = this.updateSpaceIdForNode(nodeFile.getData().toString(), spaceId);
                                 packageZip.updateFile(nodeFile, Buffer.from(updatedNodeFile));
                             }

src/util/json.ts

@@ -0,0 +1,15 @@
+
+export function stringify(data: any): string {
+    return JSON.stringify(data, replacer, 2);
+}
+
+export function parse<T>(data: string): T {
+    return JSON.parse(data);
+}
+
+const replacer = (key, value) => {
+    if (value instanceof Map) {
+        return Object.fromEntries(value);
+    }
+    return value;
+};

tests/config/config-diff.spec.ts

@@ -1,7 +1,6 @@
 import {PackageManifestTransport} from "../../src/interfaces/package-export-transport";
 import {ConfigUtils} from "../utls/config-utils";
 import * as path from "path";
-import {stringify} from "../../src/util/yaml";
 import {mockCreateReadStream, mockExistsSync, mockReadFileSync} from "../utls/fs-mock-utils";
 import {
     PackageDiffMetadata,
@@ -22,7 +21,7 @@ describe("Config diff", () => {
         const manifest: PackageManifestTransport[] = [];
         manifest.push(ConfigUtils.buildManifestForKeyAndFlavor("package-key", "STUDIO"));
 
-        const firstPackageNode = ConfigUtils.buildPackageNode("package-key", stringify({metadata: {description: "test"}, variables: [], dependencies: []}));
+        const firstPackageNode = ConfigUtils.buildPackageNode("package-key", {metadata: {description: "test"}, variables: [], dependencies: []});
         const firstChildNode = ConfigUtils.buildChildNode("key-1", "package-key", "TEST");
         const firstPackageZip = ConfigUtils.buildExportPackageZip(firstPackageNode, [firstChildNode], "1.0.0");
         const exportedPackagesZip = ConfigUtils.buildBatchExportZip(manifest, [firstPackageZip]);
@@ -49,7 +48,7 @@ describe("Config diff", () => {
         const manifest: PackageManifestTransport[] = [];
         manifest.push(ConfigUtils.buildManifestForKeyAndFlavor("package-key", "STUDIO"));
 
-        const firstPackageNode = ConfigUtils.buildPackageNode("package-key", stringify({metadata: {description: "test"}, variables: [], dependencies: []}));
+        const firstPackageNode = ConfigUtils.buildPackageNode("package-key", {metadata: {description: "test"}, variables: [], dependencies: []});
         const firstChildNode = ConfigUtils.buildChildNode("key-1", "package-key", "TEST");
         const firstPackageZip = ConfigUtils.buildExportPackageZip(firstPackageNode, [firstChildNode], "1.0.0");
         const exportedPackagesZip = ConfigUtils.buildBatchExportZip(manifest, [firstPackageZip]);
@@ -91,7 +90,7 @@ describe("Config diff", () => {
         const manifest: PackageManifestTransport[] = [];
         manifest.push(ConfigUtils.buildManifestForKeyAndFlavor("package-key", "STUDIO"));
 
-        const firstPackageNode = ConfigUtils.buildPackageNode("package-key", stringify({metadata: {description: "test"}, variables: [], dependencies: []}));
+        const firstPackageNode = ConfigUtils.buildPackageNode("package-key", {metadata: {description: "test"}, variables: [], dependencies: []});
         const firstChildNode = ConfigUtils.buildChildNode("key-1", "package-key", "TEST");
         const firstPackageZip = ConfigUtils.buildExportPackageZip(firstPackageNode, [firstChildNode], "1.0.0");
         const exportedPackagesZip = ConfigUtils.buildBatchExportZip(manifest, [firstPackageZip]);
@@ -137,7 +136,7 @@ describe("Config diff", () => {
         const manifest: PackageManifestTransport[] = [];
         manifest.push(ConfigUtils.buildManifestForKeyAndFlavor("package-key", "STUDIO"));
 
-        const firstPackageNode = ConfigUtils.buildPackageNode("package-key", stringify({metadata: {description: "test"}, variables: [], dependencies: []}));
+        const firstPackageNode = ConfigUtils.buildPackageNode("package-key", {metadata: {description: "test"}, variables: [], dependencies: []});
         const firstChildNode = ConfigUtils.buildChildNode("key-1", "package-key", "TEST");
         const firstPackageZip = ConfigUtils.buildExportPackageZip(firstPackageNode, [firstChildNode], "1.0.0");
         const exportedPackagesZip = ConfigUtils.buildBatchExportZip(manifest, [firstPackageZip]);