@salesforce/core 3.23.6 → 3.23.7

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [3.23.7](https://github.com/forcedotcom/sfdx-core/compare/v3.23.6...v3.23.7) (2022-07-08)
+
+### Bug Fixes
+
+- add structure writer interface and refactor ([daef19c](https://github.com/forcedotcom/sfdx-core/commit/daef19cb3a4d145ebb22c4f721a1bd47ffddce40))
+
 ### [3.23.6](https://github.com/forcedotcom/sfdx-core/compare/v3.23.5...v3.23.6) (2022-07-06)
 
 ### Bug Fixes

package/lib/org/scratchOrgSettingsGenerator.d.ts

@@ -21,16 +21,16 @@ export interface PackageFile {
     types: SettingType[];
     version: string;
 }
-export declare const createObjectFileContent: ({ allRecordTypes, allbusinessProcesses, apiVersion, settingData, objectSettingsData, }: {
+export declare const createObjectFileContent: ({ allRecordTypes, allBusinessProcesses, apiVersion, settingData, objectSettingsData, }: {
     allRecordTypes?: string[] | undefined;
-    allbusinessProcesses?: string[] | undefined;
+    allBusinessProcesses?: string[] | undefined;
     apiVersion: string;
     settingData?: Record<string, unknown> | undefined;
     objectSettingsData?: {
         [objectName: string]: ObjectSetting;
     } | undefined;
 }) => PackageFile;
-export declare const createRecordTypeAndBusinessProcessFileContent: (objectName: string, json: Record<string, unknown>, allRecordTypes: string[], allbusinessProcesses: string[]) => JsonMap;
+export declare const createRecordTypeAndBusinessProcessFileContent: (objectName: string, json: Record<string, unknown>, allRecordTypes: string[], allBusinessProcesses: string[]) => JsonMap;
 /**
  * Helper class for dealing with the settings that are defined in a scratch definition file.  This class knows how to extract the
  * settings from the definition, how to expand them into a MD directory and how to generate a package.xml.
@@ -41,10 +41,14 @@ export default class SettingsGenerator {
     private logger;
     private writer;
     private allRecordTypes;
-    private allbusinessProcesses;
-    private shapeDirName;
-    private packageFilePath;
-    constructor();
+    private allBusinessProcesses;
+    private readonly shapeDirName;
+    private readonly packageFilePath;
+    constructor(options?: {
+        mdApiTmpDir?: string;
+        shapeDirName?: string;
+        asDirectory?: boolean;
+    });
     /** extract the settings from the scratch def file, if they are present. */
     extract(scratchDef: ScratchOrgInfo): Promise<{
         settings: Record<string, unknown> | undefined;
@@ -62,7 +66,13 @@ export default class SettingsGenerator {
      * Deploys the settings to the org.
      */
     deploySettingsViaFolder(scratchOrg: Org, apiVersion: string): Promise<void>;
+    createDeployPackageContents(apiVersion: string): Promise<void>;
     getShapeDirName(): string;
+    /**
+     * Returns the destination where the writer placed the settings content.
+     *
+     */
+    getDestinationPath(): string | undefined;
     private writeObjectSettingsIfNeeded;
     private writeSettingsIfNeeded;
 }

package/lib/org/scratchOrgSettingsGenerator.js

@@ -13,8 +13,9 @@ const ts_types_1 = require("@salesforce/ts-types");
 const js2xmlparser = require("js2xmlparser");
 const logger_1 = require("../logger");
 const sfError_1 = require("../sfError");
-const zipWriter_1 = require("../util/zipWriter");
 const pollingClient_1 = require("../status/pollingClient");
+const zipWriter_1 = require("../util/zipWriter");
+const directoryWriter_1 = require("../util/directoryWriter");
 var RequestStatus;
 (function (RequestStatus) {
     RequestStatus["Pending"] = "Pending";
@@ -26,7 +27,7 @@ var RequestStatus;
     RequestStatus["Canceled"] = "Canceled";
 })(RequestStatus = exports.RequestStatus || (exports.RequestStatus = {}));
 const breakPolling = ['Succeeded', 'SucceededPartial', 'Failed', 'Canceled'];
-const createObjectFileContent = ({ allRecordTypes = [], allbusinessProcesses = [], apiVersion, settingData, objectSettingsData, }) => {
+const createObjectFileContent = ({ allRecordTypes = [], allBusinessProcesses = [], apiVersion, settingData, objectSettingsData, }) => {
     const output = {
         '@': {
             xmlns: 'http://soap.sforce.com/2006/04/metadata',
@@ -43,8 +44,8 @@ const createObjectFileContent = ({ allRecordTypes = [], allbusinessProcesses = [
         if (allRecordTypes.length > 0) {
             output.types.push({ members: allRecordTypes, name: 'RecordType' });
         }
-        if (allbusinessProcesses.length > 0) {
-            output.types.push({ members: allbusinessProcesses, name: 'BusinessProcess' });
+        if (allBusinessProcesses.length > 0) {
+            output.types.push({ members: allBusinessProcesses, name: 'BusinessProcess' });
         }
     }
     return { ...output, ...{ version: apiVersion } };
@@ -73,7 +74,7 @@ const calculateBusinessProcess = (objectName, defaultRecordType) => {
     }
     return [businessProcessName, businessProcessPicklistVal];
 };
-const createRecordTypeAndBusinessProcessFileContent = (objectName, json, allRecordTypes, allbusinessProcesses) => {
+const createRecordTypeAndBusinessProcessFileContent = (objectName, json, allRecordTypes, allBusinessProcesses) => {
     let output = {
         '@': {
             xmlns: 'http://soap.sforce.com/2006/04/metadata',
@@ -112,7 +113,7 @@ const createRecordTypeAndBusinessProcessFileContent = (objectName, json, allReco
             if (name !== 'Opportunity') {
                 values.default = true;
             }
-            allbusinessProcesses.push(`${name}.${businessProcessName}`);
+            allBusinessProcesses.push(`${name}.${businessProcessName}`);
             output = {
                 ...output,
                 recordTypes: {
@@ -135,15 +136,23 @@ exports.createRecordTypeAndBusinessProcessFileContent = createRecordTypeAndBusin
  * settings from the definition, how to expand them into a MD directory and how to generate a package.xml.
  */
 class SettingsGenerator {
-    constructor() {
+    constructor(options) {
         this.allRecordTypes = [];
-        this.allbusinessProcesses = [];
-        this.shapeDirName = `shape_${Date.now()}`;
-        this.packageFilePath = path.join(this.shapeDirName, 'package.xml');
+        this.allBusinessProcesses = [];
         this.logger = logger_1.Logger.childFromRoot('SettingsGenerator');
         // If SFDX_MDAPI_TEMP_DIR is set, copy settings to that dir for people to inspect.
-        const mdapiTmpDir = kit_1.env.getString('SFDX_MDAPI_TEMP_DIR');
-        this.writer = new zipWriter_1.ZipWriter(mdapiTmpDir);
+        const mdApiTmpDir = (options === null || options === void 0 ? void 0 : options.mdApiTmpDir) || kit_1.env.getString('SFDX_MDAPI_TEMP_DIR');
+        this.shapeDirName = (options === null || options === void 0 ? void 0 : options.shapeDirName) || `shape_${Date.now()}`;
+        this.packageFilePath = path.join(this.shapeDirName, 'package.xml');
+        let storePath;
+        if (!(options === null || options === void 0 ? void 0 : options.asDirectory)) {
+            storePath = mdApiTmpDir ? path.join(mdApiTmpDir, `${this.shapeDirName}.zip`) : undefined;
+            this.writer = new zipWriter_1.ZipWriter(storePath);
+        }
+        else {
+            storePath = mdApiTmpDir ? path.join(mdApiTmpDir, this.shapeDirName) : undefined;
+            this.writer = new directoryWriter_1.DirectoryWriter(storePath);
+        }
     }
     /** extract the settings from the scratch def file, if they are present. */
     async extract(scratchDef) {
@@ -165,7 +174,7 @@ class SettingsGenerator {
         const objectsDir = path.join(this.shapeDirName, 'objects');
         await Promise.all([
             this.writeSettingsIfNeeded(settingsDir),
-            this.writeObjectSettingsIfNeeded(objectsDir, this.allRecordTypes, this.allbusinessProcesses),
+            this.writeObjectSettingsIfNeeded(objectsDir, this.allRecordTypes, this.allBusinessProcesses),
         ]);
     }
     /**
@@ -174,16 +183,7 @@ class SettingsGenerator {
     async deploySettingsViaFolder(scratchOrg, apiVersion) {
         const username = scratchOrg.getUsername();
         const logger = await logger_1.Logger.child('deploySettingsViaFolder');
-        const packageObjectProps = (0, exports.createObjectFileContent)({
-            allRecordTypes: this.allRecordTypes,
-            allbusinessProcesses: this.allbusinessProcesses,
-            apiVersion,
-            settingData: this.settingData,
-            objectSettingsData: this.objectSettingsData,
-        });
-        const xml = js2xmlparser.parse('Package', packageObjectProps);
-        this.writer.addToZip(xml, this.packageFilePath);
-        await this.writer.finalize();
+        await this.createDeployPackageContents(apiVersion);
         const connection = scratchOrg.getConnection();
         logger.debug(`deploying to apiVersion: ${apiVersion}`);
         connection.setApiVersion(apiVersion);
@@ -230,15 +230,34 @@ class SettingsGenerator {
             throw error;
         }
     }
+    async createDeployPackageContents(apiVersion) {
+        const packageObjectProps = (0, exports.createObjectFileContent)({
+            allRecordTypes: this.allRecordTypes,
+            allBusinessProcesses: this.allBusinessProcesses,
+            apiVersion,
+            settingData: this.settingData,
+            objectSettingsData: this.objectSettingsData,
+        });
+        const xml = js2xmlparser.parse('Package', packageObjectProps);
+        await this.writer.addToStore(xml, this.packageFilePath);
+        await this.writer.finalize();
+    }
     getShapeDirName() {
         return this.shapeDirName;
     }
+    /**
+     * Returns the destination where the writer placed the settings content.
+     *
+     */
+    getDestinationPath() {
+        return this.writer.getDestinationPath();
+    }
     async writeObjectSettingsIfNeeded(objectsDir, allRecordTypes, allbusinessProcesses) {
         if (this.objectSettingsData) {
             for (const [item, value] of Object.entries(this.objectSettingsData)) {
                 const fileContent = (0, exports.createRecordTypeAndBusinessProcessFileContent)(item, value, allRecordTypes, allbusinessProcesses);
                 const xml = js2xmlparser.parse('CustomObject', fileContent);
-                this.writer.addToZip(xml, path.join(objectsDir, (0, kit_1.upperFirst)(item) + '.object'));
+                await this.writer.addToStore(xml, path.join(objectsDir, (0, kit_1.upperFirst)(item) + '.object'));
             }
         }
     }
@@ -249,7 +268,7 @@ class SettingsGenerator {
                 const typeName = (0, kit_1.upperFirst)(item);
                 const fname = typeName.replace('Settings', '');
                 const fileContent = js2xmlparser.parse(typeName, value);
-                this.writer.addToZip(fileContent, path.join(settingsDir, fname + '.settings'));
+                await this.writer.addToStore(fileContent, path.join(settingsDir, fname + '.settings'));
             }
         }
     }

package/lib/util/directoryWriter.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
+import { StructuredWriter } from './structuredWriter';
+export declare class DirectoryWriter implements StructuredWriter {
+    private readonly rootDestination?;
+    constructor(rootDestination?: string | undefined);
+    addToStore(contents: string | Readable | Buffer, targetPath: string): Promise<void>;
+    finalize(): Promise<void>;
+    getDestinationPath(): string | undefined;
+    get buffer(): Buffer;
+}

package/lib/util/directoryWriter.js

@@ -0,0 +1,52 @@
+"use strict";
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DirectoryWriter = void 0;
+const stream_1 = require("stream");
+const fs = require("fs");
+const os = require("os");
+const path = require("path");
+const util_1 = require("util");
+const pipeline = (0, util_1.promisify)(stream_1.pipeline);
+class DirectoryWriter {
+    constructor(rootDestination) {
+        this.rootDestination = rootDestination;
+        if (!this.rootDestination) {
+            this.rootDestination = fs.mkdtempSync(`${os.tmpdir()}${path.sep}`);
+        }
+        else {
+            fs.mkdirSync(this.rootDestination, { recursive: true });
+        }
+    }
+    async addToStore(contents, targetPath) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const destPath = path.join(this.rootDestination, targetPath);
+        fs.mkdirSync(path.dirname(destPath), { recursive: true });
+        if (contents instanceof stream_1.Readable) {
+            const writeStream = fs.createWriteStream(destPath);
+            await pipeline(contents, writeStream);
+        }
+        else if (typeof contents === 'string') {
+            fs.writeFileSync(destPath, contents);
+        }
+        else if (contents instanceof Buffer) {
+            fs.writeFileSync(destPath, contents);
+        }
+    }
+    finalize() {
+        return Promise.resolve(undefined);
+    }
+    getDestinationPath() {
+        return this.rootDestination;
+    }
+    get buffer() {
+        throw new Error('Not implemented');
+    }
+}
+exports.DirectoryWriter = DirectoryWriter;
+//# sourceMappingURL=directoryWriter.js.map

package/lib/util/structuredWriter.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
+export interface StructuredWriter {
+    addToStore(contents: string | Readable | Buffer, path: string): Promise<void>;
+    finalize(): Promise<void>;
+    getDestinationPath(): string | undefined;
+    get buffer(): Buffer;
+}

package/lib/util/structuredWriter.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=structuredWriter.js.map

package/lib/util/zipWriter.d.ts

@@ -1,13 +1,14 @@
 /// <reference types="node" />
-import { pipeline as cbPipeline, Readable, Writable } from 'stream';
-export declare const pipeline: typeof cbPipeline.__promisify__;
-export declare class ZipWriter extends Writable {
-    private rootDestination?;
+import { Readable, Writable } from 'stream';
+import { StructuredWriter } from './structuredWriter';
+export declare class ZipWriter extends Writable implements StructuredWriter {
+    private readonly rootDestination?;
     private zip;
     private buffers;
     constructor(rootDestination?: string | undefined);
-    addToZip(contents: string | Readable | Buffer, path: string): void;
+    addToStore(contents: string | Readable | Buffer, path: string): Promise<void>;
     finalize(): Promise<void>;
+    getDestinationPath(): string | undefined;
     private getOutputStream;
     private getInputBuffer;
     get buffer(): Buffer;

package/lib/util/zipWriter.js

@@ -6,12 +6,12 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZipWriter = exports.pipeline = void 0;
+exports.ZipWriter = void 0;
 const fs_1 = require("fs");
 const stream_1 = require("stream");
 const util_1 = require("util");
 const archiver_1 = require("archiver");
-exports.pipeline = (0, util_1.promisify)(stream_1.pipeline);
+const pipeline = (0, util_1.promisify)(stream_1.pipeline);
 class ZipWriter extends stream_1.Writable {
     constructor(rootDestination) {
         super({ objectMode: true });
@@ -21,15 +21,19 @@ class ZipWriter extends stream_1.Writable {
         // higher values = diminishing returns on compression and made conversion slower
         this.zip = (0, archiver_1.create)('zip', { zlib: { level: 3 } });
         this.buffers = [];
-        void (0, exports.pipeline)(this.zip, this.getOutputStream());
+        void pipeline(this.zip, this.getOutputStream());
     }
-    addToZip(contents, path) {
+    async addToStore(contents, path) {
         this.zip.append(contents, { name: path });
+        return Promise.resolve();
     }
     async finalize() {
         await this.zip.finalize();
         await this.getInputBuffer();
     }
+    getDestinationPath() {
+        return this.rootDestination;
+    }
     getOutputStream() {
         if (this.rootDestination) {
             return (0, fs_1.createWriteStream)(this.rootDestination);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.23.6",
+  "version": "3.23.7",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -60,6 +60,7 @@
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.3.21",
     "@types/archiver": "^5.3.1",
+    "@types/chai-string": "^1.4.2",
     "@types/debug": "0.0.31",
     "@types/jsen": "0.0.21",
     "@types/jsonwebtoken": "8.5.7",
@@ -68,6 +69,7 @@
     "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@typescript-eslint/parser": "4.33.0",
     "chai": "^4.3.4",
+    "chai-string": "^1.5.0",
     "commitizen": "^3.1.2",
     "eslint": "^7.27.0",
     "eslint-config-prettier": "^6.15.0",