@salesforce/packaging 0.0.26 → 0.0.27

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.
 
+### [0.0.27](https://github.com/forcedotcom/packaging/compare/v0.0.26...v0.0.27) (2022-08-26)
+
+### Bug Fixes
+
+- fix validateDependencyValues ([e37ac1e](https://github.com/forcedotcom/packaging/commit/e37ac1e08f5d764aefa8cf04271c6e72a30d78ea))
+
 ### [0.0.26](https://github.com/forcedotcom/packaging/compare/v0.0.25...v0.0.26) (2022-08-25)
 
 ### Bug Fixes

package/lib/package/packageVersionCreate.js

@@ -14,7 +14,6 @@ const core_1 = require("@salesforce/core");
 const source_deploy_retrieve_1 = require("@salesforce/source-deploy-retrieve");
 const scratchOrgSettingsGenerator_1 = require("@salesforce/core/lib/org/scratchOrgSettingsGenerator");
 const xml2js = require("xml2js");
-const scratchOrgInfoGenerator_1 = require("@salesforce/core/lib/org/scratchOrgInfoGenerator");
 const uniqid_1 = require("../utils/uniqid");
 const pkgUtils = require("../utils/packageUtils");
 const versionNumber_1 = require("../utils/versionNumber");
@@ -75,19 +74,22 @@ class PackageVersionCreate {
         // If valid 04t package, just return it to be used straight away.
         if (dependency.subscriberPackageVersionId) {
             pkgUtils.validateId(pkgUtils.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, dependency.subscriberPackageVersionId);
+            return;
         }
         if (dependency.packageId && dependency.package) {
             throw messages.createError('errorPackageAndPackageIdCollision', []);
         }
+        const packageIdFromAlias = pkgUtils.getPackageIdFromAlias(dependency.packageId || dependency.package, this.project);
         // If valid 04t package, just return it to be used straight away.
-        if (pkgUtils.validateIdNoThrow(pkgUtils.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, this.packageId)) {
-            dependency.subscriberPackageVersionId = this.packageId;
+        if (pkgUtils.validateIdNoThrow(pkgUtils.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, packageIdFromAlias)) {
+            dependency.subscriberPackageVersionId = packageIdFromAlias;
+            return;
         }
-        if (!this.packageId || !dependency.versionNumber) {
+        if (!packageIdFromAlias || !dependency.versionNumber) {
             throw messages.createError('errorDependencyPair', [JSON.stringify(dependency)]);
         }
         // Just override dependency.packageId value to the resolved alias.
-        dependency.packageId = this.packageId;
+        dependency.packageId = packageIdFromAlias;
         pkgUtils.validateId(pkgUtils.BY_LABEL.PACKAGE_ID, dependency.packageId);
         pkgUtils.validateVersionNumber(dependency.versionNumber, versionNumber_1.BuildNumberToken.LATEST_BUILD_NUMBER_TOKEN, versionNumber_1.BuildNumberToken.RELEASED_BUILD_NUMBER_TOKEN);
         // Validate that the Package2 id exists on the server
@@ -96,7 +98,6 @@ class PackageVersionCreate {
         if (!result.records || result.records.length !== 1) {
             throw messages.createError('errorNoIdInHub', [dependency.packageId]);
         }
-        return result;
     }
     /**
      * A dependency in the workspace config file may be specified using either a subscriber package version id (04t)
@@ -206,7 +207,12 @@ class PackageVersionCreate {
             SkipValidation: this.options.skipvalidation || false,
         };
         if (preserveFiles) {
-            logger.info(messages.getMessage('tempFileLocation', [packageVersTmpRoot]));
+            const message = messages.getMessage('tempFileLocation', [packageVersTmpRoot]);
+            await core_1.Lifecycle.getInstance().emit('packageVersionCreate:preserveFiles', {
+                location: packageVersTmpRoot,
+                message,
+            });
+            logger.info(message);
             return requestObject;
         }
         else {
@@ -279,9 +285,7 @@ class PackageVersionCreate {
         // branch can be set via options or descriptor; option takes precedence
         this.options.branch = this.options.branch ?? packageDescriptorJson.branch;
         const resultValues = await Promise.all(!dependencies ? [] : dependencies.map((dependency) => this.retrieveSubscriberPackageVersionId(dependency)));
-        const ancestorId = await (0, scratchOrgInfoGenerator_1.getAncestorIds)(
-        // TODO: investigate if it's ok to convert to ScratchOggInfoPayload
-        this.packageObject, this.options.project.getSfProjectJson(), await core_1.Org.create({ aliasOrUsername: this.options.connection.getUsername() }));
+        const ancestorId = await (0, utils_1.getAncestorId)(packageDescriptorJson, this.options.project, this.options.connection, this.options.versionnumber ?? packageDescriptorJson.versionNumber, this.options.skipancestorcheck);
         // If dependencies exist, the resultValues array will contain the dependencies populated with a resolved
         // subscriber pkg version id.
         if (resultValues.length > 0) {

package/lib/utils/packageUtils.d.ts

@@ -2,7 +2,7 @@ import { Connection, NamedPackageDir, PackageDir, SfdcUrl, SfError, SfProject }
 import { Duration } from '@salesforce/kit';
 import { Many, Nullable } from '@salesforce/ts-types';
 import { SaveError } from 'jsforce';
-import { PackageType, PackageVersionCreateRequestResult, PackagingSObjects } from '../interfaces';
+import { PackageDescriptorJson, PackageType, PackageVersionCreateRequestResult, PackagingSObjects } from '../interfaces';
 export declare const VERSION_NUMBER_SEP = ".";
 export declare type IdRegistryValue = {
     prefix: string;
@@ -102,6 +102,7 @@ export declare function queryWithInConditionChunking<T = Record<string, unknown>
  */
 export declare function getInClauseItemsCount(items: string[], startIndex: number, maxLength: number): number;
 export declare function validateAncestorId(ancestorId: string, highestReleasedVersion: PackagingSObjects.Package2Version, explicitUseNoAncestor: boolean, isPatch: boolean, skipAncestorCheck: boolean, origSpecifiedAncestor: string): string;
+export declare function getAncestorId(packageDescriptorJson: PackageDescriptorJson, project: SfProject, connection: Connection, versionNumberString: string, skipAncestorCheck: boolean): Promise<string>;
 export declare function getAncestorIdHighestRelease(connection: Connection, packageId: string, versionNumberString: string, explicitUseHighestRelease: boolean, skipAncestorCheck: boolean): Promise<{
     finalAncestorId: string;
     highestReleasedVersion: PackagingSObjects.Package2Version;

package/lib/utils/packageUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.combineSaveErrors = exports.formatDate = exports.generatePackageAliasEntry = exports.pollForStatusWithInterval = exports.findOrCreatePackage = exports.getPackageAliasesFromId = exports.convertCamelCaseStringToSentence = exports.getPackageIdFromAlias = exports.getConfigPackageDirectory = exports.getConfigPackageDirectories = exports.getPackageVersionNumber = exports.concatVersion = exports.getAncestorIdHighestRelease = exports.validateAncestorId = exports.getInClauseItemsCount = exports.queryWithInConditionChunking = exports.getPackageVersionStrings = exports.getHasMetadataRemoved = exports.getContainerOptions = exports.getSubscriberPackageVersionId = exports.getPackageTypeBy04t = exports.getPackageType = exports.escapeInstallationKey = exports.getPackageVersionId = exports.applyErrorAction = exports.massageErrorMessage = exports.isErrorPackageNotAvailable = exports.isErrorFromSPVQueryRestriction = exports.validatePatchVersion = exports.validateVersionNumber = exports.validateIdNoThrow = exports.validateId = exports.BY_LABEL = exports.BY_PREFIX = exports.DEFAULT_PACKAGE_DIR = exports.POLL_INTERVAL_SECONDS = exports.SOQL_WHERE_CLAUSE_MAX_LENGTH = exports.INSTALL_URL_BASE = exports.VERSION_NUMBER_SEP = void 0;
+exports.combineSaveErrors = exports.formatDate = exports.generatePackageAliasEntry = exports.pollForStatusWithInterval = exports.findOrCreatePackage = exports.getPackageAliasesFromId = exports.convertCamelCaseStringToSentence = exports.getPackageIdFromAlias = exports.getConfigPackageDirectory = exports.getConfigPackageDirectories = exports.getPackageVersionNumber = exports.concatVersion = exports.getAncestorIdHighestRelease = exports.getAncestorId = exports.validateAncestorId = exports.getInClauseItemsCount = exports.queryWithInConditionChunking = exports.getPackageVersionStrings = exports.getHasMetadataRemoved = exports.getContainerOptions = exports.getSubscriberPackageVersionId = exports.getPackageTypeBy04t = exports.getPackageType = exports.escapeInstallationKey = exports.getPackageVersionId = exports.applyErrorAction = exports.massageErrorMessage = exports.isErrorPackageNotAvailable = exports.isErrorFromSPVQueryRestriction = exports.validatePatchVersion = exports.validateVersionNumber = exports.validateIdNoThrow = exports.validateId = exports.BY_LABEL = exports.BY_PREFIX = exports.DEFAULT_PACKAGE_DIR = exports.POLL_INTERVAL_SECONDS = exports.SOQL_WHERE_CLAUSE_MAX_LENGTH = exports.INSTALL_URL_BASE = exports.VERSION_NUMBER_SEP = void 0;
 /*
  * Copyright (c) 2022, salesforce.com, inc.
  * All rights reserved.
@@ -423,6 +423,92 @@ function validateAncestorId(ancestorId, highestReleasedVersion, explicitUseNoAnc
     return ancestorId;
 }
 exports.validateAncestorId = validateAncestorId;
+// eslint-disable-next-line complexity
+async function getAncestorId(packageDescriptorJson, project, connection, versionNumberString, skipAncestorCheck) {
+    // If an id property is present, use it.  Otherwise, look up the package id from the package property.
+    const packageId = packageDescriptorJson.id ?? getPackageIdFromAlias(packageDescriptorJson.package, project);
+    // No need to proceed if Unlocked
+    const packageType = await getPackageType(packageId, connection);
+    if (packageType === 'Unlocked') {
+        return '';
+    }
+    let ancestorId = '';
+    // ancestorID can be alias, 05i, or 04t;
+    // validate and convert to 05i, as needed
+    const versionNumber = versionNumber_1.VersionNumber.from(versionNumberString);
+    let origSpecifiedAncestor = packageDescriptorJson.ancestorId;
+    let highestReleasedVersion = null;
+    const explicitUseHighestRelease = packageDescriptorJson.ancestorId === versionNumber_1.BuildNumberToken.HIGHEST_VERSION_NUMBER_TOKEN ||
+        packageDescriptorJson.ancestorVersion === versionNumber_1.BuildNumberToken.HIGHEST_VERSION_NUMBER_TOKEN;
+    const explicitUseNoAncestor = packageDescriptorJson.ancestorId === versionNumber_1.BuildNumberToken.NONE_VERSION_NUMBER_TOKEN ||
+        packageDescriptorJson.ancestorVersion === versionNumber_1.BuildNumberToken.NONE_VERSION_NUMBER_TOKEN;
+    if ((explicitUseHighestRelease || explicitUseNoAncestor) &&
+        packageDescriptorJson.ancestorId &&
+        packageDescriptorJson.ancestorVersion) {
+        if (packageDescriptorJson.ancestorId !== packageDescriptorJson.ancestorVersion) {
+            // both ancestorId and ancestorVersion specified, HIGHEST and/or NONE are used, the values disagree
+            throw messages.createError('errorAncestorIdVersionHighestOrNoneMismatch', [
+                packageDescriptorJson.ancestorId,
+                packageDescriptorJson.ancestorVersion,
+            ]);
+        }
+    }
+    if (explicitUseNoAncestor && skipAncestorCheck) {
+        return '';
+    }
+    else {
+        const result = await getAncestorIdHighestRelease(connection, packageId, versionNumberString, explicitUseHighestRelease, skipAncestorCheck);
+        if (result.finalAncestorId) {
+            return result.finalAncestorId;
+        }
+        highestReleasedVersion = result.highestReleasedVersion;
+    }
+    // at this point if explicitUseHighestRelease=true, we have returned the ancestorId or thrown an error
+    // highestReleasedVersion should be null only if skipAncestorCheck or if there is no existing released package version
+    if (!explicitUseNoAncestor && packageDescriptorJson.ancestorId) {
+        ancestorId = getPackageIdFromAlias(packageDescriptorJson.ancestorId, project);
+        validateId([exports.BY_LABEL.SUBSCRIBER_PACKAGE_VERSION_ID, exports.BY_LABEL.PACKAGE_VERSION_ID], ancestorId);
+        ancestorId = await getPackageVersionId(ancestorId, connection);
+    }
+    if (!explicitUseNoAncestor && packageDescriptorJson.ancestorVersion) {
+        const regNumbers = new RegExp('^[0-9]+$');
+        const versionNumber = packageDescriptorJson.ancestorVersion.split(exports.VERSION_NUMBER_SEP);
+        if (versionNumber.length < 3 ||
+            versionNumber.length > 4 ||
+            !versionNumber[0].match(regNumbers) ||
+            !versionNumber[1].match(regNumbers) ||
+            !versionNumber[2].match(regNumbers)) {
+            throw new Error(messages.getMessage('errorInvalidAncestorVersionFormat', [packageDescriptorJson.ancestorVersion]));
+        }
+        const query = 'SELECT Id, IsReleased FROM Package2Version ' +
+            `WHERE Package2Id = '${packageId}' AND MajorVersion = ${versionNumber[0]} AND MinorVersion = ${versionNumber[1]} AND PatchVersion = ${versionNumber[2]}`;
+        let queriedAncestorId;
+        const ancestorVersionResult = await connection.tooling.query(query);
+        if (!ancestorVersionResult || !ancestorVersionResult.totalSize) {
+            throw messages.createError('errorNoMatchingAncestor', [packageDescriptorJson.ancestorVersion, packageId]);
+        }
+        else {
+            const releasedAncestor = ancestorVersionResult.records.find((rec) => rec.IsReleased === true);
+            if (!releasedAncestor) {
+                throw messages.createError('errorAncestorNotReleased', [packageDescriptorJson.ancestorVersion]);
+            }
+            else {
+                queriedAncestorId = releasedAncestor.Id;
+            }
+        }
+        // check for discrepancy between queried ancestorId and descriptor's ancestorId
+        if (Object.prototype.hasOwnProperty.call(packageDescriptorJson, 'ancestorId') && ancestorId !== queriedAncestorId) {
+            throw messages.createError('errorAncestorIdVersionMismatch', [
+                packageDescriptorJson.ancestorVersion,
+                packageDescriptorJson.ancestorId,
+            ]);
+        }
+        ancestorId = queriedAncestorId;
+        origSpecifiedAncestor = packageDescriptorJson.ancestorVersion;
+    }
+    return validateAncestorId(ancestorId, highestReleasedVersion, explicitUseNoAncestor, versionNumber.patch !== '0', skipAncestorCheck, origSpecifiedAncestor);
+}
+exports.getAncestorId = getAncestorId;
 async function getAncestorIdHighestRelease(connection, packageId, versionNumberString, explicitUseHighestRelease, skipAncestorCheck) {
     const versionNumber = versionNumberString.split(exports.VERSION_NUMBER_SEP);
     const isPatch = versionNumber[2] !== '0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "0.0.26",
+  "version": "0.0.27",
   "description": "packing libraries to Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",