Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

W-17599215: add totalnumberofmetadatafiles field #719

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
1 change: 1 addition & 0 deletions src/interfaces/packagingInterfacesAndType.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ export type PackageVersionCreateRequestResult = {
VersionNumber: string | null;
CreatedBy: string;
ConvertedFromVersionId: string | null;
TotalNumberOfMetadataFiles: number | null;
};

export const PackageVersionCreateRequestResultInProgressStatuses = Object.values(Package2VersionStatus).filter(
Expand Down
1 change: 1 addition & 0 deletions src/interfaces/packagingSObjects.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ export namespace PackagingSObjects {
HasMetadataRemoved: boolean;
Language: string;
EndToEndBuildDurationInSeconds?: number;
TotalNumberOfMetadataFiles: number;
};

export enum Package2VersionStatus {
Expand Down
4 changes: 4 additions & 0 deletions src/package/packageVersionCreateRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ export function getQuery(connection: Connection): string {
'Package2Version.MajorVersion, Package2Version.MinorVersion, Package2Version.PatchVersion, Package2Version.BuildNumber, ' +
'CreatedDate, Package2Version.HasMetadataRemoved, CreatedById, IsConversionRequest, Package2Version.ConvertedFromVersionId ' +
(Number(connection.version) > 60.0 ? ', AsyncValidation ' : '') +
(Number(connection.version) > 63.0 ? ', Package2Version.TotalNumberOfMetadataFiles ' : '') +
'FROM Package2VersionCreateRequest ' +
'%s' + // WHERE, if applicable
'ORDER BY CreatedDate desc';
Expand Down Expand Up @@ -84,6 +85,7 @@ async function query(query: string, connection: Connection): Promise<PackageVers
| 'MinorVersion'
| 'PatchVersion'
| 'BuildNumber'
| 'TotalNumberOfMetadataFiles'
>;
} & {
Package2: Pick<PackagingSObjects.Package2, 'Name'>;
Expand Down Expand Up @@ -114,6 +116,8 @@ async function query(query: string, connection: Connection): Promise<PackageVers
record.Package2Version != null ? record.Package2Version.HasPassedCodeCoverageCheck : null,
CreatedBy: record.CreatedById,
ConvertedFromVersionId: convertedFromVersionMessage(record.Status, record.Package2Version?.ConvertedFromVersionId),
TotalNumberOfMetadataFiles:
record.Package2Version != null ? record.Package2Version.TotalNumberOfMetadataFiles : null,
}));
}

Expand Down
11 changes: 10 additions & 1 deletion src/package/packageVersionReport.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ let verboseFields = ['SubscriberPackageVersion.Dependencies', 'CodeCoveragePerce
// Ensure we only include the async validation property for api version of v60.0 or higher.
const default61Fields = ['ValidatedAsync'];

// Add fields here that are available only api version of v64.0 or higher.
const deafult64Fields = ['TotalNumberOfMetadataFiles'];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const deafult64Fields = ['TotalNumberOfMetadataFiles'];
const default64Fields = ['TotalNumberOfMetadataFiles'];


const verbose61Fields = ['EndToEndBuildDurationInSeconds'];

const DEFAULT_ORDER_BY_FIELDS = 'Package2Id, Branch, MajorVersion, MinorVersion, PatchVersion, BuildNumber';
Expand All @@ -57,7 +60,13 @@ const getLogger = (): Logger => {

function constructQuery(connectionVersion: number, verbose: boolean): string {
// Ensure we only include the async validation property for api version of v60.0 or higher.
let queryFields = connectionVersion > 60 ? [...defaultFields, ...default61Fields] : defaultFields;
// TotalNumberOfMetadataFiles is included as query field for api version of v64.0 or higher.
let queryFields =
connectionVersion > 63
? [...defaultFields, ...default61Fields, ...deafult64Fields]
: connectionVersion > 60
? [...defaultFields, ...default61Fields]
: defaultFields;
verboseFields = connectionVersion > 60 ? [...verboseFields, ...verbose61Fields] : verboseFields;
if (verbose) {
queryFields = [...queryFields, ...verboseFields];
Expand Down
2 changes: 2 additions & 0 deletions test/package/packageConvert.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,7 @@ describe('packageConvert', () => {
Status: 'Success',
SubscriberPackageVersionId: null,
Tag: 'tag',
TotalNumberOfMetadataFiles: null,
};

Lifecycle.getInstance().on(PackageEvents.convert.progress, async (data) => {
Expand All @@ -272,6 +273,7 @@ describe('packageConvert', () => {
Status: 'inProgress',
SubscriberPackageVersionId: null,
Tag: undefined,
TotalNumberOfMetadataFiles: null,
},
timeRemaining: {
quantity: 2,
Expand Down
1 change: 1 addition & 0 deletions test/package/packageTest.nut.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ const VERSION_CREATE_RESPONSE_KEYS = [
'VersionNumber',
'CreatedBy',
'ConvertedFromVersionId',
'TotalNumberOfMetadataFiles',
];

// version
Expand Down
1 change: 1 addition & 0 deletions test/package/packageVersionCreate.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ describe('Package Version Create', () => {
'SubscriberPackageVersionId',
'Tag',
'VersionNumber',
'TotalNumberOfMetadataFiles',
];

const $$ = instantiateContext();
Expand Down
2 changes: 1 addition & 1 deletion test/package/packageVersionMetadataRetrieve.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/
import path from 'node:path';
import fs from 'node:fs';
import sinon = require('sinon');
import * as sinon from 'sinon';
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix for - x TypeScript import equals declaration is not supported in strip-only mode

import { instantiateContext, MockTestOrgData, restoreContext, stubContext } from '@salesforce/core/testSetup';
import { assert, expect } from 'chai';
import { Connection, SfProject, SfError } from '@salesforce/core';
Expand Down
10 changes: 3 additions & 7 deletions test/package/subscriberPackageVersionInstall.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,11 @@ import {
isErrorPackageNotAvailable,
waitForPublish,
} from '../../src/package/packageInstall';
import {
PackageEvents,
PackageInstallCreateRequest,
PackageInstallOptions,
PackagingSObjects,
} from '../../src/interfaces';
import { PackageEvents, PackageInstallCreateRequest, PackageInstallOptions } from '../../src/interfaces';
import { SubscriberPackageVersion } from '../../src/package';
import PackageInstallRequest = PackagingSObjects.PackageInstallRequest;
import * as PackagingSObjects from '../../src/interfaces/packagingSObjects';
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix for - x TypeScript import equals declaration is not supported in strip-only mode


type PackageInstallRequest = PackagingSObjects.PackagingSObjects.PackageInstallRequest;
const myPackageVersion04t = '04t6A0000000X0UQAU';

describe('Package Install', () => {
Expand Down
Loading