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.

Sign up for GitHub

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

feat: guarantee fileResponseSuccess has a path #1358

Merged
merged 3 commits into from
Jun 28, 2024
Merged

feat: guarantee fileResponseSuccess has a path #1358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
432f585
feat: guarantee that FileResponseSuccess will always have a filepath
mshanemc Jun 27, 2024
04afb37
test: mocks follow real life
mshanemc Jun 27, 2024
24f4f6f
chore: bump deps for xnuts
mshanemc Jun 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"node": ">=18.0.0"
},
"dependencies": {
"@salesforce/core": "^8.0.3",
"@salesforce/core": "^8.1.0",
"@salesforce/kit": "^3.1.6",
"@salesforce/ts-types": "^2.0.10",
"fast-levenshtein": "^3.0.0",
Expand All @@ -39,7 +39,7 @@
"proxy-agent": "^6.4.0"
},
"devDependencies": {
"@jsforce/jsforce-node": "^3.2.0",
"@jsforce/jsforce-node": "^3.2.1",
"@salesforce/cli-plugins-testkit": "^5.3.16",
"@salesforce/dev-scripts": "^10.2.2",
"@types/deep-equal-in-any-order": "^1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion src/client/deployMessages.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ const shouldWalkContent = (component: SourceComponent): boolean =>
export const createResponses = (component: SourceComponent, responseMessages: DeployMessage[]): FileResponse[] =>
responseMessages.flatMap((message): FileResponse[] => {
const state = getState(message);
const base = { fullName: component.fullName, type: component.type.name };
const base = { fullName: component.fullName, type: component.type.name } as const;

if (state === ComponentStatus.Failed) {
return [{ ...base, state, ...parseDeployDiagnostic(component, message) } satisfies FileResponseFailure];
Expand Down
9 changes: 5 additions & 4 deletions src/client/metadataApiRetrieve.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
AsyncResult,
ComponentStatus,
FileResponse,
FileResponseSuccess,
MetadataApiRetrieveStatus,
MetadataTransferResult,
PackageOptions,
Expand Down Expand Up @@ -88,20 +89,20 @@ export class RetrieveResult implements MetadataTransferResult {
// construct successes
for (const retrievedComponent of this.components.getSourceComponents()) {
const { fullName, type, xml } = retrievedComponent;
const baseResponse: FileResponse = {
const baseResponse = {
fullName,
type: type.name,
state: this.localComponents.has(retrievedComponent) ? ComponentStatus.Changed : ComponentStatus.Created,
};
} as const;

if (!type.children || Object.values(type.children.types).some((t) => t.unaddressableWithoutParent)) {
for (const filePath of retrievedComponent.walkContent()) {
this.fileResponses.push(Object.assign({}, baseResponse, { filePath }));
this.fileResponses.push({ ...baseResponse, filePath } satisfies FileResponseSuccess);
}
}

if (xml) {
this.fileResponses.push(Object.assign({}, baseResponse, { filePath: xml }));
this.fileResponses.push({ ...baseResponse, filePath: xml } satisfies FileResponseSuccess);
}
}

Expand Down
4 changes: 2 additions & 2 deletions src/client/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ type FileResponseBase = {
filePath?: string;
};

export type FileResponseSuccess = {
export type FileResponseSuccess = Required<FileResponseBase> & {
state: Exclude<ComponentStatus, ComponentStatus.Failed>;
} & FileResponseBase;
};

export type FileResponseFailure = {
state: ComponentStatus.Failed;
Expand Down
28 changes: 14 additions & 14 deletions test/client/metadataApiDeploy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import { basename, join, sep } from 'node:path';
import { MockTestOrgData, TestContext } from '@salesforce/core/testSetup';
import chai, { assert, expect } from 'chai';
import { AnyJson, getString } from '@salesforce/ts-types';
import { AnyJson, ensureString, getString } from '@salesforce/ts-types';
import { Lifecycle, Messages, PollingClient, StatusResult } from '@salesforce/core';
import { Duration } from '@salesforce/kit';
import deepEqualInAnyOrder = require('deep-equal-in-any-order');
Expand Down Expand Up @@ -548,13 +548,13 @@ describe('MetadataApiDeploy', () => {
fullName,
type: type.name,
state: ComponentStatus.Changed,
filePath: content,
filePath: ensureString(content),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

there's a bunch of these in the test. The mocks come from SourceComponent, which has xml and content as optional properties.

the tests assert that they're there.

It's harder to work with the SourceComponent class (ex: to make SourceComponentWithXmlAndContent, etc) the way you would a simple object/type or to put a type guard around it
...
so it's probably simpler to do this ensure stuff for UT.

},
{
fullName,
type: type.name,
state: ComponentStatus.Changed,
filePath: xml,
filePath: ensureString(xml),
},
];

Expand Down Expand Up @@ -584,13 +584,13 @@ describe('MetadataApiDeploy', () => {
fullName,
type: type.name,
state: ComponentStatus.Created,
filePath: content,
filePath: ensureString(content),
},
{
fullName,
type: type.name,
state: ComponentStatus.Created,
filePath: xml,
filePath: ensureString(xml),
},
];

Expand Down Expand Up @@ -620,13 +620,13 @@ describe('MetadataApiDeploy', () => {
fullName,
type: type.name,
state: ComponentStatus.Deleted,
filePath: content,
filePath: ensureString(content),
},
{
fullName,
type: type.name,
state: ComponentStatus.Deleted,
filePath: xml,
filePath: ensureString(xml),
},
];

Expand Down Expand Up @@ -695,13 +695,13 @@ describe('MetadataApiDeploy', () => {
fullName,
type: type.name,
state: ComponentStatus.Unchanged,
filePath: content,
filePath: ensureString(content),
},
{
fullName,
type: type.name,
state: ComponentStatus.Unchanged,
filePath: xml,
filePath: ensureString(xml),
},
];

Expand Down Expand Up @@ -1031,19 +1031,19 @@ describe('MetadataApiDeploy', () => {
fullName: DECOMPOSED_CHILD_COMPONENT_1.fullName,
type: DECOMPOSED_CHILD_COMPONENT_1.type.name,
state: ComponentStatus.Changed,
filePath: DECOMPOSED_CHILD_COMPONENT_1.xml,
filePath: ensureString(DECOMPOSED_CHILD_COMPONENT_1.xml),
},
{
fullName: DECOMPOSED_CHILD_COMPONENT_2.fullName,
type: DECOMPOSED_CHILD_COMPONENT_2.type.name,
state: ComponentStatus.Changed,
filePath: DECOMPOSED_CHILD_COMPONENT_2.xml,
filePath: ensureString(DECOMPOSED_CHILD_COMPONENT_2.xml),
},
{
fullName: component.fullName,
type: component.type.name,
state: ComponentStatus.Changed,
filePath: component.xml,
filePath: ensureString(component.xml),
},
];

Expand Down Expand Up @@ -1074,13 +1074,13 @@ describe('MetadataApiDeploy', () => {
fullName: component.fullName,
type: component.type.name,
state: ComponentStatus.Deleted,
filePath: component.content,
filePath: ensureString(component.content),
},
{
fullName: component.fullName,
type: component.type.name,
state: ComponentStatus.Deleted,
filePath: component.xml,
filePath: ensureString(component.xml),
},
];

Expand Down
26 changes: 13 additions & 13 deletions test/client/metadataApiRetrieve.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { assert, expect } from 'chai';
import chai = require('chai');
import deepEqualInAnyOrder = require('deep-equal-in-any-order');
import { SinonStub } from 'sinon';
import { getString } from '@salesforce/ts-types';
import { ensureString, getString } from '@salesforce/ts-types';
import fs from 'graceful-fs';
import { MockTestOrgData, TestContext } from '@salesforce/core/testSetup';
import {
Expand Down Expand Up @@ -549,14 +549,14 @@ hY2thZ2VkL3BhY2thZ2UueG1sUEsFBgAAAAADAAMA7QAAAJoCAAAAAA==`;
const result = new RetrieveResult(apiStatus as MetadataApiRetrieveStatus, retrievedSet, retrievedSet);

const responses = result.getFileResponses();
const baseResponse: FileResponse = {
const baseResponse = {
state: ComponentStatus.Changed,
fullName: component.fullName,
type: component.type.name,
};
} as const;
const expected: FileResponse[] = [
Object.assign({}, baseResponse, { filePath: component.content }),
Object.assign({}, baseResponse, { filePath: component.xml }),
{ ...baseResponse, filePath: ensureString(component.content) },
{ ...baseResponse, filePath: ensureString(component.xml) },
];

expect(responses).to.deep.equal(expected);
Expand All @@ -572,20 +572,20 @@ hY2thZ2VkL3BhY2thZ2UueG1sUEsFBgAAAAADAAMA7QAAAJoCAAAAAA==`;
const result = new RetrieveResult(apiStatus as MetadataApiRetrieveStatus, retrievedSet, localSet);

const responses = result.getFileResponses();
const baseResponse: FileResponse = {
const baseResponse = {
state: ComponentStatus.Changed,
fullName: component.fullName,
type: component.type.name,
};
} as const;
// Since the DECOMPOSED_COMPONENT was in the retrieved ComponentSet but
// not the local source ComponentSet it should have a state of 'Created'
// rather than 'Changed'.
const expected: FileResponse[] = [
Object.assign({}, baseResponse, { filePath: component.content }),
Object.assign({}, baseResponse, { filePath: component.xml }),
{ ...baseResponse, filePath: ensureString(component.content) },
{ ...baseResponse, filePath: ensureString(component.xml) },
{
fullName: DECOMPOSED_COMPONENT.fullName,
filePath: DECOMPOSED_COMPONENT.xml,
filePath: ensureString(DECOMPOSED_COMPONENT.xml),
state: ComponentStatus.Created,
type: DECOMPOSED_COMPONENT.type.name,
},
Expand Down Expand Up @@ -646,7 +646,7 @@ hY2thZ2VkL3BhY2thZ2UueG1sUEsFBgAAAAADAAMA7QAAAJoCAAAAAA==`;
state: ComponentStatus.Changed,
fullName: successComponent.fullName,
type: successComponent.type.name,
filePath: successComponent.xml,
filePath: ensureString(successComponent.xml),
},
];

Expand Down Expand Up @@ -695,7 +695,7 @@ hY2thZ2VkL3BhY2thZ2UueG1sUEsFBgAAAAADAAMA7QAAAJoCAAAAAA==`;
state: ComponentStatus.Changed,
fullName: component.fullName,
type: component.type.name,
filePath: component.xml,
filePath: ensureString(component.xml),
},
];

Expand All @@ -721,7 +721,7 @@ hY2thZ2VkL3BhY2thZ2UueG1sUEsFBgAAAAADAAMA7QAAAJoCAAAAAA==`;
state: ComponentStatus.Changed,
fullName: component.fullName,
type: component.type.name,
filePath: component.content,
filePath: ensureString(component.content),
},
];

Expand Down
18 changes: 9 additions & 9 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,10 +502,10 @@
"@jridgewell/resolve-uri" "3.1.0"
"@jridgewell/sourcemap-codec" "1.4.14"

"@jsforce/jsforce-node@^3.2.0":
version "3.2.0"
resolved "https://registry.yarnpkg.com/@jsforce/jsforce-node/-/jsforce-node-3.2.0.tgz#4b104613fc9bb74e0e38d2c00936ea2b228ba73a"
integrity sha512-3GjWNgWs0HFajVhIhwvBPb0B45o500wTBNEBYxy8XjeeRra+qw8A9xUrfVU7TAGev8kXuKhjJwaTiSzThpEnew==
"@jsforce/jsforce-node@^3.2.1":
version "3.2.1"
resolved "https://registry.yarnpkg.com/@jsforce/jsforce-node/-/jsforce-node-3.2.1.tgz#00fab05919e0cbe91ae4d873377e56cfbc087b98"
integrity sha512-hjmZQbYVikm6ATmaErOp5NaKR2VofNZsrcGGHrdbGA+bAgpfg/+MA/HzRTb8BvYyPDq3RRc5A8Yk8gx9Vtcrxg==
dependencies:
"@sindresorhus/is" "^4"
"@types/node" "^18.15.3"
Expand Down Expand Up @@ -564,12 +564,12 @@
strip-ansi "6.0.1"
ts-retry-promise "^0.8.1"

"@salesforce/core@^8.0.3":
version "8.0.3"
resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-8.0.3.tgz#8b25ce46100baef0a8e731b42d373edf508ab144"
integrity sha512-HirswUFGQIF5Ipaa+5l3kulBOf3L25Z3fzf5QqEI4vOxgBKN2bEdKHCA/PROufi3/ejFstiXcn9/jfgyjDdBqA==
"@salesforce/core@^8.0.3", "@salesforce/core@^8.1.0":
version "8.1.0"
resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-8.1.0.tgz#8ee25acdacf9d70a6249907a2fe3503461f18766"
integrity sha512-oItr8cdeMe67glJN3dP1Gh/kasD0DUT6S6RfcLTH32wwuZNQAwMXNgBOCvlskr8nxPZ+YSSw7CVuqYMUmCtUXA==
dependencies:
"@jsforce/jsforce-node" "^3.2.0"
"@jsforce/jsforce-node" "^3.2.1"
"@salesforce/kit" "^3.1.6"
"@salesforce/schemas" "^1.9.0"
"@salesforce/ts-types" "^2.0.10"
Expand Down
Loading