@salesforce/sobject-metadata
Version:
Retrieve Salesforce object metadata from connected org
234 lines • 9.74 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
/*
* Copyright (c) 2020, 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
*/
const core_1 = require("@salesforce/core");
const testSetup_1 = require("@salesforce/core/lib/testSetup");
const sinon_1 = require("sinon");
const sobjectApi_1 = require("./sobjectApi");
const testData_1 = require("./testData");
const $$ = testSetup_1.testSetup();
// wrap protected functions as public for testing
class SObjectDescribeAPITestWrap extends sobjectApi_1.SObjectDescribeAPI {
doBuildSObjectDescribeURL(sObjectName, fullUrl) {
return this.buildSObjectDescribeURL(sObjectName, fullUrl);
}
doBuildBatchRequestURL() {
return this.buildBatchRequestURL();
}
doBuildBatchRequestBody(types, nextToProcess) {
return this.buildBatchRequestBody(types, nextToProcess);
}
doBuildSingleXHROptions(sObjectName, lastRefreshDate) {
return this.buildSingleXHROptions(sObjectName, lastRefreshDate);
}
doBuildBatchXHROptions(types, nextToProcess) {
return this.buildBatchXHROptions(types, nextToProcess);
}
doGetVersion() {
return this.getVersion();
}
}
describe('SObjectDescribeAPI', () => {
let mockConnection;
let sObjectAPI;
let sandboxStub;
const testData = new testSetup_1.MockTestOrgData();
beforeEach(async () => {
sandboxStub = sinon_1.createSandbox();
$$.setConfigStubContents('AuthInfoConfig', {
contents: await testData.getConfig(),
});
mockConnection = await core_1.Connection.create({
authInfo: await core_1.AuthInfo.create({
username: testData.username,
}),
});
sObjectAPI = new SObjectDescribeAPITestWrap(mockConnection);
});
afterEach(() => {
sandboxStub.restore();
});
it('should return correct api version', () => {
const expectedValue = 'v49.0';
const actualValue = sObjectAPI.doGetVersion();
expect(actualValue).toBe(expectedValue);
});
it('should create the correct partial URL for an sobject', () => {
const sObjectName = 'Paul';
const expectedValue = `${sObjectAPI.doGetVersion()}/sobjects/${sObjectName}/describe`;
const actualValue = sObjectAPI.doBuildSObjectDescribeURL(sObjectName);
expect(actualValue).toBe(expectedValue);
});
it('should create the correct full URL for an sobject', () => {
const sObjectName = 'John';
const expectedValue = `${mockConnection.instanceUrl}/services/data/${sObjectAPI.doGetVersion()}/sobjects/${sObjectName}/describe`;
const actualValue = sObjectAPI.doBuildSObjectDescribeURL(sObjectName, true);
expect(actualValue).toBe(expectedValue);
});
it('should create the correct batch URL', () => {
const expectedValue = `${mockConnection.instanceUrl}/services/data/${sObjectAPI.doGetVersion()}/composite/batch`;
const actualValue = sObjectAPI.doBuildBatchRequestURL();
expect(actualValue).toBe(expectedValue);
});
it('should create the correct sobject describe request (when last refresh date not specified)', () => {
const sObjectName = 'George';
const expectedValue = {
method: 'GET',
url: sObjectAPI.doBuildSObjectDescribeURL(sObjectName, true),
headers: {
'Sforce-Call-Options': `client=sfdx-vscode`,
'User-Agent': 'salesforcedx-extension',
},
};
const actualValue = sObjectAPI.doBuildSingleXHROptions(sObjectName);
expect(actualValue).toEqual(expectedValue);
});
it('should create the correct sobject describe request (when last refresh date specified)', () => {
const sObjectName = 'Ringo';
const timestamp = 'Fri, 07 Aug 2020 12:00:00 GMT';
const expectedValue = {
method: 'GET',
url: sObjectAPI.doBuildSObjectDescribeURL(sObjectName, true),
headers: {
'If-Modified-Since': timestamp,
'Sforce-Call-Options': `client=sfdx-vscode`,
'User-Agent': 'salesforcedx-extension',
},
};
const actualValue = sObjectAPI.doBuildSingleXHROptions(sObjectName, timestamp);
expect(actualValue).toEqual(expectedValue);
});
it('should craete the correct batch request body', () => {
const sObjectNames = ['Paul', 'John', 'George', 'Ringo'];
const expectedValue = {
batchRequests: [
{ method: 'GET', url: sObjectAPI.doBuildSObjectDescribeURL('Paul') },
{ method: 'GET', url: sObjectAPI.doBuildSObjectDescribeURL('John') },
{ method: 'GET', url: sObjectAPI.doBuildSObjectDescribeURL('George') },
{ method: 'GET', url: sObjectAPI.doBuildSObjectDescribeURL('Ringo') },
],
};
const actualValue = sObjectAPI.doBuildBatchRequestBody(sObjectNames, 0);
expect(actualValue).toEqual(expectedValue);
});
it('should create the correct batch request', () => {
const sObjectNames = ['Paul', 'John', 'George', 'Ringo'];
const expectedValue = {
method: 'POST',
url: sObjectAPI.doBuildBatchRequestURL(),
headers: {
'Sforce-Call-Options': `client=sfdx-vscode`,
'User-Agent': 'salesforcedx-extension',
},
body: JSON.stringify(sObjectAPI.doBuildBatchRequestBody(sObjectNames, 0)),
};
const actualValue = sObjectAPI.doBuildBatchXHROptions(sObjectNames, 0);
expect(actualValue).toEqual(expectedValue);
});
it('should return sobject description array when batch request is successful', async () => {
const sObjectName = testData_1.SObjectTestData.customSObject.name;
const timestamp = 'Fri, 07 Aug 2020 12:00:00 GMT';
const batchResp = {
hasErrors: false,
results: [
{
statusCode: 200,
result: testData_1.SObjectTestData.customSObject,
},
],
};
const resp = {
status: 200,
body: JSON.stringify(batchResp),
headers: {
date: timestamp,
},
};
sandboxStub
.stub(mockConnection, 'requestRaw')
.returns(Promise.resolve(resp));
const expectedValue = [
{ sObjectName, result: testData_1.SObjectTestData.customSObject, timestamp },
];
const actualValue = await sObjectAPI.describeSObjectBatch([sObjectName], 0);
expect(actualValue).toEqual(expectedValue);
});
it('should return sobject description when request is successful', async () => {
const sObjectName = testData_1.SObjectTestData.customSObject.name;
const timestamp = 'Fri, 07 Aug 2020 12:00:00 GMT';
const resp = {
status: 200,
body: JSON.stringify(testData_1.SObjectTestData.customSObject),
headers: {
date: timestamp,
},
};
sandboxStub
.stub(mockConnection, 'requestRaw')
.returns(Promise.resolve(resp));
const expectedValue = {
sObjectName,
result: testData_1.SObjectTestData.customSObject,
timestamp,
};
const actualValue = await sObjectAPI.describeSObject(sObjectName);
expect(actualValue).toEqual(expectedValue);
});
it('should return empty sobject description when refresh unneeded and request is successful', async () => {
const sObjectName = testData_1.SObjectTestData.customSObject.name;
const timestamp = 'Fri, 07 Aug 2020 12:00:00 GMT';
const resp = {
status: 304,
responseText: '',
headers: {
date: timestamp,
},
};
sandboxStub
.stub(mockConnection, 'requestRaw')
.returns(Promise.resolve(resp));
const expectedValue = {
sObjectName,
result: undefined,
timestamp,
};
const actualValue = await sObjectAPI.describeSObject(sObjectName, timestamp);
expect(actualValue).toEqual(expectedValue);
});
it('should reject when batch request fails', async () => {
const sObjectName = testData_1.SObjectTestData.customSObject.name;
const timestamp = 'Fri, 07 Aug 2020 12:00:00 GMT';
const resp500 = {
status: 500,
responseText: 'ERROR',
headers: {
date: timestamp,
},
};
sandboxStub
.stub(mockConnection, 'requestRaw')
.returns(Promise.reject(resp500));
await expect(sObjectAPI.describeSObjectBatch([sObjectName], 0)).rejects.toBe(resp500.responseText);
});
it('should reject when request fails', async () => {
const sObjectName = testData_1.SObjectTestData.customSObject.name;
const timestamp = 'Fri, 07 Aug 2020 12:00:00 GMT';
const resp500 = {
status: 500,
responseText: 'ERROR',
headers: {
date: timestamp,
},
};
sandboxStub
.stub(mockConnection, 'requestRaw')
.returns(Promise.reject(resp500));
await expect(sObjectAPI.describeSObject(sObjectName)).rejects.toBe(resp500.responseText);
});
});
//# sourceMappingURL=sobjectApi.test.js.map