@salesforce/core 3.23.5 → 3.23.6

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.6](https://github.com/forcedotcom/sfdx-core/compare/v3.23.5...v3.23.6) (2022-07-06)
+
+### Bug Fixes
+
+- workaround for jsforce update bug ([1776f50](https://github.com/forcedotcom/sfdx-core/commit/1776f505671a5a764c4e966736c2981df2b178a4))
+
 ### [3.23.5](https://github.com/forcedotcom/sfdx-core/compare/v3.23.4...v3.23.5) (2022-07-06)
 
 ### Bug Fixes

package/lib/org/scratchOrgInfoApi.js

@@ -392,12 +392,22 @@ const updateRevisionCounterToZero = async (scratchOrg) => {
         return;
     }
     try {
-        await conn.tooling
-            .sobject('SourceMember')
-            .update(queryResult.map((record) => ({ Id: record.Id, RevisionCounter: 0 })));
+        // jsforce has a bug in its `update` code such that tooling#update doesn't work right
+        // https://github.com/jsforce/jsforce/blob/265eba5c734439dd7b77610c05b63bde7d4b1e83/src/connection.ts#L1082
+        // will result in `this._ensureVersion is not a function`
+        // so until that is resolved, we hit the API with singular records
+        // once that's fixed, you can use the following code for a single API call
+        // await conn.tooling
+        //   .sobject('SourceMember')
+        //   .update(queryResult.map((record) => ({ Id: record.Id, RevisionCounter: 0 })));
+        await Promise.all(queryResult.map((record) => conn.tooling.sobject('SourceMember').update({ Id: record.Id, RevisionCounter: 0 })));
     }
     catch (err) {
-        await lifecycleEvents_1.Lifecycle.getInstance().emitWarning(messages.getMessage('SourceStatusResetFailureError', [scratchOrg.getOrgId(), scratchOrg.getUsername()]));
+        await lifecycleEvents_1.Lifecycle.getInstance().emitWarning(messages.getMessage('SourceStatusResetFailureError', [
+            scratchOrg.getOrgId(),
+            scratchOrg.getUsername(),
+            err instanceof Error ? err.message : '',
+        ]));
     }
 };
 exports.updateRevisionCounterToZero = updateRevisionCounterToZero;

package/lib/org/scratchOrgSettingsGenerator.d.ts

@@ -10,16 +10,27 @@ export declare enum RequestStatus {
     Canceling = "Canceling",
     Canceled = "Canceled"
 }
-export interface BusinessProcessFileContent extends JsonMap {
-    fullName: string;
-    isActive: boolean;
-    values: [
-        {
-            fullName: string;
-            default?: boolean;
-        }
-    ];
+export interface SettingType {
+    members: string[];
+    name: 'CustomObject' | 'RecordType' | 'BusinessProcess' | 'Settings';
 }
+export interface PackageFile {
+    '@': {
+        xmlns: string;
+    };
+    types: SettingType[];
+    version: string;
+}
+export declare const createObjectFileContent: ({ allRecordTypes, allbusinessProcesses, apiVersion, settingData, objectSettingsData, }: {
+    allRecordTypes?: 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;
 /**
  * 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.
@@ -29,7 +40,10 @@ export default class SettingsGenerator {
     private objectSettingsData?;
     private logger;
     private writer;
+    private allRecordTypes;
+    private allbusinessProcesses;
     private shapeDirName;
+    private packageFilePath;
     constructor();
     /** extract the settings from the scratch def file, if they are present. */
     extract(scratchDef: ScratchOrgInfo): Promise<{
@@ -51,8 +65,4 @@ export default class SettingsGenerator {
     getShapeDirName(): string;
     private writeObjectSettingsIfNeeded;
     private writeSettingsIfNeeded;
-    private createPackageXml;
-    private createObjectFileContent;
-    private createRecordTypeFileContent;
-    private createBusinessProcessFileContent;
 }

package/lib/org/scratchOrgSettingsGenerator.js

@@ -6,14 +6,13 @@
  * 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.RequestStatus = void 0;
+exports.createRecordTypeAndBusinessProcessFileContent = exports.createObjectFileContent = exports.RequestStatus = void 0;
 const path = require("path");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const js2xmlparser = require("js2xmlparser");
 const logger_1 = require("../logger");
 const sfError_1 = require("../sfError");
-const jsonXmlTools_1 = require("../util/jsonXmlTools");
 const zipWriter_1 = require("../util/zipWriter");
 const pollingClient_1 = require("../status/pollingClient");
 var RequestStatus;
@@ -27,13 +26,120 @@ var RequestStatus;
     RequestStatus["Canceled"] = "Canceled";
 })(RequestStatus = exports.RequestStatus || (exports.RequestStatus = {}));
 const breakPolling = ['Succeeded', 'SucceededPartial', 'Failed', 'Canceled'];
+const createObjectFileContent = ({ allRecordTypes = [], allbusinessProcesses = [], apiVersion, settingData, objectSettingsData, }) => {
+    const output = {
+        '@': {
+            xmlns: 'http://soap.sforce.com/2006/04/metadata',
+        },
+        types: [],
+    };
+    if (settingData) {
+        const strings = Object.keys(settingData).map((item) => (0, kit_1.upperFirst)(item).replace('Settings', ''));
+        output.types.push({ members: strings, name: 'Settings' });
+    }
+    if (objectSettingsData) {
+        const strings = Object.keys(objectSettingsData).map((item) => (0, kit_1.upperFirst)(item));
+        output.types.push({ members: strings, name: 'CustomObject' });
+        if (allRecordTypes.length > 0) {
+            output.types.push({ members: allRecordTypes, name: 'RecordType' });
+        }
+        if (allbusinessProcesses.length > 0) {
+            output.types.push({ members: allbusinessProcesses, name: 'BusinessProcess' });
+        }
+    }
+    return { ...output, ...{ version: apiVersion } };
+};
+exports.createObjectFileContent = createObjectFileContent;
+const calculateBusinessProcess = (objectName, defaultRecordType) => {
+    let businessProcessName = null;
+    let businessProcessPicklistVal = null;
+    // These four objects require any record type to specify a "business process"--
+    // a restricted set of items from a standard picklist on the object.
+    if (['Case', 'Lead', 'Opportunity', 'Solution'].includes(objectName)) {
+        businessProcessName = (0, kit_1.upperFirst)(defaultRecordType) + 'Process';
+        switch (objectName) {
+            case 'Case':
+                businessProcessPicklistVal = 'New';
+                break;
+            case 'Lead':
+                businessProcessPicklistVal = 'New - Not Contacted';
+                break;
+            case 'Opportunity':
+                businessProcessPicklistVal = 'Prospecting';
+                break;
+            case 'Solution':
+                businessProcessPicklistVal = 'Draft';
+        }
+    }
+    return [businessProcessName, businessProcessPicklistVal];
+};
+const createRecordTypeAndBusinessProcessFileContent = (objectName, json, allRecordTypes, allbusinessProcesses) => {
+    let output = {
+        '@': {
+            xmlns: 'http://soap.sforce.com/2006/04/metadata',
+        },
+    };
+    const name = (0, kit_1.upperFirst)(objectName);
+    const sharingModel = json.sharingModel;
+    if (sharingModel) {
+        output = {
+            ...output,
+            sharingModel: (0, kit_1.upperFirst)(sharingModel),
+        };
+    }
+    const defaultRecordType = json.defaultRecordType;
+    if (typeof defaultRecordType === 'string') {
+        // We need to keep track of these globally for when we generate the package XML.
+        allRecordTypes.push(`${name}.${(0, kit_1.upperFirst)(defaultRecordType)}`);
+        const [businessProcessName, businessProcessPicklistVal] = calculateBusinessProcess(name, defaultRecordType);
+        // Create the record type
+        const recordTypes = {
+            fullName: (0, kit_1.upperFirst)(defaultRecordType),
+            label: (0, kit_1.upperFirst)(defaultRecordType),
+            active: true,
+        };
+        output = {
+            ...output,
+            recordTypes: {
+                ...recordTypes,
+            },
+        };
+        if (businessProcessName) {
+            // We need to keep track of these globally for the package.xml
+            const values = {
+                fullName: businessProcessPicklistVal,
+            };
+            if (name !== 'Opportunity') {
+                values.default = true;
+            }
+            allbusinessProcesses.push(`${name}.${businessProcessName}`);
+            output = {
+                ...output,
+                recordTypes: {
+                    ...recordTypes,
+                    businessProcess: businessProcessName,
+                },
+                businessProcesses: {
+                    fullName: businessProcessName,
+                    isActive: true,
+                    values,
+                },
+            };
+        }
+    }
+    return output;
+};
+exports.createRecordTypeAndBusinessProcessFileContent = createRecordTypeAndBusinessProcessFileContent;
 /**
  * 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.
  */
 class SettingsGenerator {
     constructor() {
+        this.allRecordTypes = [];
+        this.allbusinessProcesses = [];
         this.shapeDirName = `shape_${Date.now()}`;
+        this.packageFilePath = path.join(this.shapeDirName, 'package.xml');
         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');
@@ -57,7 +163,10 @@ class SettingsGenerator {
     async createDeploy() {
         const settingsDir = path.join(this.shapeDirName, 'settings');
         const objectsDir = path.join(this.shapeDirName, 'objects');
-        await Promise.all([this.writeSettingsIfNeeded(settingsDir), this.writeObjectSettingsIfNeeded(objectsDir)]);
+        await Promise.all([
+            this.writeSettingsIfNeeded(settingsDir),
+            this.writeObjectSettingsIfNeeded(objectsDir, this.allRecordTypes, this.allbusinessProcesses),
+        ]);
     }
     /**
      * Deploys the settings to the org.
@@ -65,7 +174,15 @@ class SettingsGenerator {
     async deploySettingsViaFolder(scratchOrg, apiVersion) {
         const username = scratchOrg.getUsername();
         const logger = await logger_1.Logger.child('deploySettingsViaFolder');
-        this.createPackageXml(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);
+        this.writer.addToZip(xml, this.packageFilePath);
         await this.writer.finalize();
         const connection = scratchOrg.getConnection();
         logger.debug(`deploying to apiVersion: ${apiVersion}`);
@@ -116,37 +233,12 @@ class SettingsGenerator {
     getShapeDirName() {
         return this.shapeDirName;
     }
-    async writeObjectSettingsIfNeeded(objectsDir) {
-        if (!this.objectSettingsData || !Object.keys(this.objectSettingsData).length) {
-            return;
-        }
-        for (const objectName of Object.keys(this.objectSettingsData)) {
-            const value = this.objectSettingsData[objectName];
-            // writes the object file in source format
-            const objectDir = path.join(objectsDir, (0, kit_1.upperFirst)(objectName));
-            const customObjectDir = path.join(objectDir, `${(0, kit_1.upperFirst)(objectName)}.object`);
-            const customObjectXml = (0, jsonXmlTools_1.JsonAsXml)({
-                json: this.createObjectFileContent(value),
-                type: 'RecordType',
-            });
-            this.writer.addToZip(customObjectXml, customObjectDir);
-            if (value.defaultRecordType) {
-                const recordTypesDir = path.join(objectDir, 'recordTypes', `${(0, kit_1.upperFirst)(value.defaultRecordType)}.recordType`);
-                const recordTypesFileContent = this.createRecordTypeFileContent(objectName, value);
-                const recordTypesXml = (0, jsonXmlTools_1.JsonAsXml)({
-                    json: recordTypesFileContent,
-                    type: 'RecordType',
-                });
-                this.writer.addToZip(recordTypesXml, recordTypesDir);
-                // for things that required a businessProcess
-                if (recordTypesFileContent.businessProcess) {
-                    const businessProcessesDir = path.join(objectDir, 'businessProcesses', `${recordTypesFileContent.businessProcess}.businessProcess`);
-                    const businessProcessesXml = (0, jsonXmlTools_1.JsonAsXml)({
-                        json: this.createBusinessProcessFileContent(objectName, recordTypesFileContent.businessProcess),
-                        type: 'BusinessProcess',
-                    });
-                    this.writer.addToZip(businessProcessesXml, businessProcessesDir);
-                }
+    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'));
             }
         }
     }
@@ -161,54 +253,6 @@ class SettingsGenerator {
             }
         }
     }
-    createPackageXml(apiVersion) {
-        const pkg = `<?xml version="1.0" encoding="UTF-8"?>
-<Package xmlns="http://soap.sforce.com/2006/04/metadata">
-    <types>
-        <members>*</members>
-        <name>Settings</name>
-    </types>
-    <types>
-        <members>*</members>
-        <name>CustomObject</name>
-    </types>
-    <version>${apiVersion}</version>
-</Package>`;
-        this.writer.addToZip(pkg, path.join(this.shapeDirName, 'package.xml'));
-    }
-    createObjectFileContent(json) {
-        const output = {};
-        if (json.sharingModel) {
-            output.sharingModel = (0, kit_1.upperFirst)(json.sharingModel);
-        }
-        return output;
-    }
-    createRecordTypeFileContent(objectName, setting) {
-        const defaultRecordType = (0, kit_1.upperFirst)(setting.defaultRecordType);
-        const output = {
-            fullName: defaultRecordType,
-            label: defaultRecordType,
-            active: true,
-        };
-        // all the edge cases
-        if (['Case', 'Lead', 'Opportunity', 'Solution'].includes((0, kit_1.upperFirst)(objectName))) {
-            return { ...output, businessProcess: `${defaultRecordType}Process` };
-        }
-        return output;
-    }
-    createBusinessProcessFileContent(objectName, businessProcessName) {
-        const objectToBusinessProcessPicklist = {
-            Opportunity: { fullName: 'Prospecting' },
-            Case: { fullName: 'New', default: true },
-            Lead: { fullName: 'New - Not Contacted', default: true },
-            Solution: { fullName: 'Draft', default: true },
-        };
-        return {
-            fullName: businessProcessName,
-            isActive: true,
-            values: [objectToBusinessProcessPicklist[(0, kit_1.upperFirst)(objectName)]],
-        };
-    }
 }
 exports.default = SettingsGenerator;
 //# sourceMappingURL=scratchOrgSettingsGenerator.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.23.5",
+  "version": "3.23.6",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",