Skip to content

Commit 0fcd4af

Browse files
abdulsattarabdulsattar
committed
fix: remove deprecated ensureMatchingAPIVersion
1 parent fc024f4 commit 0fcd4af

3 files changed

Lines changed: 23 additions & 35 deletions

File tree

‎src/shared/orgUtils.ts‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -173,16 +173,4 @@ export class OrgUtils {
173173
);
174174
}
175175
}
176-
177-
/**
178-
* Given a connection to an Org, it ensures that org API version matches what the local dev server expects.
179-
* To do this, it compares the org API version with the meta data stored in package.json under apiVersionMetadata.
180-
* If the API versions do not match then this method will throw an exception.
181-
*
182-
* @param connection the connection to the org
183-
* @deprecated Use getVersionChannel instead
184-
*/
185-
public static ensureMatchingAPIVersion(connection: Connection): void {
186-
this.getVersionChannel(connection);
187-
}
188176
}

‎test/commands/lightning/dev/app.test.ts‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,15 @@ describe('lightning dev app', () => {
6262
'iPhone 15 Pro Max',
6363
DeviceType.mobile,
6464
AppleOSType.iOS,
65-
new Version(17, 5, 0)
65+
new Version(17, 5, 0),
6666
);
6767
const testAndroidDevice = new AndroidDevice(
6868
'Pixel_5_API_34',
6969
'Pixel 5 API 34',
7070
DeviceType.mobile,
7171
AndroidOSType.googleAPIs,
7272
new Version(34, 0, 0),
73-
false
73+
false,
7474
);
7575
const certData: SSLCertificateData = {
7676
derCertificate: Buffer.from('A', 'utf-8'),
@@ -103,7 +103,7 @@ describe('lightning dev app', () => {
103103
$$.SANDBOX.stub(Connection.prototype, 'getUsername').returns(testUsername);
104104
$$.SANDBOX.stub(PreviewUtils, 'getOrCreateAppServerIdentity').resolves(testIdentityData);
105105
$$.SANDBOX.stub(OrgUtils, 'isLocalDevEnabled').resolves(true);
106-
$$.SANDBOX.stub(OrgUtils, 'ensureMatchingAPIVersion').returns();
106+
$$.SANDBOX.stub(OrgUtils, 'getVersionChannel').returns('latest');
107107

108108
MockedLightningPreviewApp = await esmock<typeof LightningDevApp>('../../../../src/commands/lightning/dev/app.js', {
109109
'../../../../src/lwc-dev-server/index.js': {
@@ -153,7 +153,7 @@ describe('lightning dev app', () => {
153153
try {
154154
$$.SANDBOX.stub(OrgUtils, 'getAppDefinitionDurableId').resolves(testAppDefinition.DurableId);
155155
$$.SANDBOX.stub(PreviewUtils, 'generateWebSocketUrlForLocalDevServer').throws(
156-
new Error('Cannot determine LDP url.')
156+
new Error('Cannot determine LDP url.'),
157157
);
158158
await MockedLightningPreviewApp.run(['--name', 'Sales', '-o', testOrgData.username, '-t', Platform.desktop]);
159159
} catch (err) {
@@ -175,7 +175,7 @@ describe('lightning dev app', () => {
175175

176176
it('prompts user to select lightning app when not provided', async () => {
177177
const promptStub = $$.SANDBOX.stub(PromptUtils, 'promptUserToSelectLightningExperienceApp').resolves(
178-
testAppDefinition
178+
testAppDefinition,
179179
);
180180
await verifyOrgOpen(`lightning/app/${testAppDefinition.DurableId}`, Platform.desktop);
181181
expect(promptStub.calledOnce);
@@ -245,7 +245,7 @@ describe('lightning dev app', () => {
245245
$$.SANDBOX.stub(LwcDevMobileCoreSetup.prototype, 'run').resolves();
246246

247247
$$.SANDBOX.stub(PreviewUtils, 'getMobileDevice').callsFake((platform) =>
248-
Promise.resolve(platform === Platform.ios ? testIOSDevice : testAndroidDevice)
248+
Promise.resolve(platform === Platform.ios ? testIOSDevice : testAndroidDevice),
249249
);
250250

251251
await verifyMobileThrowsWhenDeviceFailsToBoot(Platform.ios);
@@ -260,7 +260,7 @@ describe('lightning dev app', () => {
260260
$$.SANDBOX.stub(LwcDevMobileCoreSetup.prototype, 'run').resolves();
261261

262262
$$.SANDBOX.stub(PreviewUtils, 'getMobileDevice').callsFake((platform) =>
263-
Promise.resolve(platform === Platform.ios ? testIOSDevice : testAndroidDevice)
263+
Promise.resolve(platform === Platform.ios ? testIOSDevice : testAndroidDevice),
264264
);
265265

266266
$$.SANDBOX.stub(AppleDevice.prototype, 'boot').resolves();
@@ -280,7 +280,7 @@ describe('lightning dev app', () => {
280280
$$.SANDBOX.stub(LwcDevMobileCoreSetup.prototype, 'run').resolves();
281281

282282
$$.SANDBOX.stub(PreviewUtils, 'getMobileDevice').callsFake((platform) =>
283-
Promise.resolve(platform === Platform.ios ? testIOSDevice : testAndroidDevice)
283+
Promise.resolve(platform === Platform.ios ? testIOSDevice : testAndroidDevice),
284284
);
285285

286286
$$.SANDBOX.stub(PreviewUtils, 'generateSelfSignedCert').resolves(certData);
@@ -315,7 +315,7 @@ describe('lightning dev app', () => {
315315
$$.SANDBOX.stub(LwcDevMobileCoreSetup.prototype, 'run').resolves();
316316

317317
$$.SANDBOX.stub(PreviewUtils, 'getMobileDevice').callsFake((platform) =>
318-
Promise.resolve(platform === Platform.ios ? testIOSDevice : testAndroidDevice)
318+
Promise.resolve(platform === Platform.ios ? testIOSDevice : testAndroidDevice),
319319
);
320320

321321
$$.SANDBOX.stub(PreviewUtils, 'generateSelfSignedCert').resolves(certData);
@@ -416,11 +416,11 @@ describe('lightning dev app', () => {
416416
expectedLdpServerUrl,
417417
testLdpServerId,
418418
'Sales',
419-
testAppDefinition.DurableId
419+
testAppDefinition.DurableId,
420420
);
421421

422422
const downloadStub = $$.SANDBOX.stub(PreviewUtils, 'downloadSalesforceMobileAppBundle').resolves(
423-
testBundleArchive
423+
testBundleArchive,
424424
);
425425
const extractStub = $$.SANDBOX.stub(CommonUtils, 'extractZIPArchive').resolves();
426426
const installStub =

‎test/shared/previewUtils.test.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ describe('previewUtils', () => {
4949
'iPhone 15 Pro Max',
5050
DeviceType.mobile,
5151
AppleOSType.iOS,
52-
new Version(17, 5, 0)
52+
new Version(17, 5, 0),
5353
);
5454
const testAndroidDevice = new AndroidDevice(
5555
'Pixel_5_API_34',
5656
'Pixel 5 API 34',
5757
DeviceType.mobile,
5858
AndroidOSType.googleAPIs,
5959
new Version(34, 0, 0),
60-
false
60+
false,
6161
);
6262

6363
const testUsername = 'SalesforceDeveloper';
@@ -126,8 +126,8 @@ describe('previewUtils', () => {
126126
testLdpServerId,
127127
'MyAppId',
128128
'MyTargetOrg',
129-
'MyAuraMode'
130-
)
129+
'MyAuraMode',
130+
),
131131
).to.deep.equal([
132132
'--path',
133133
`lightning/app/MyAppId?0.aura.ldpServerUrl=MyLdpServerUrl&0.aura.ldpServerId=${testLdpServerId}&0.aura.mode=MyAuraMode`,
@@ -148,8 +148,8 @@ describe('previewUtils', () => {
148148
testLdpServerId,
149149
'MyAppName',
150150
'MyAppId',
151-
'MyAuraMode'
152-
)
151+
'MyAuraMode',
152+
),
153153
).to.deep.equal([
154154
{ name: 'LightningExperienceAppName', value: 'MyAppName' },
155155
{ name: 'LightningExperienceAppID', value: 'MyAppId' },
@@ -210,7 +210,7 @@ describe('previewUtils', () => {
210210
'https://localhost:3333',
211211
testLdpServerId,
212212
'myTestComponent',
213-
'myTargetOrg'
213+
'myTargetOrg',
214214
);
215215

216216
const parsed = parseArgs({
@@ -232,7 +232,7 @@ describe('previewUtils', () => {
232232
'https://localhost:3333',
233233
testLdpServerId,
234234
undefined,
235-
'myTargetOrg'
235+
'myTargetOrg',
236236
);
237237

238238
const parsed = parseArgs({
@@ -253,7 +253,7 @@ describe('previewUtils', () => {
253253
const result = PreviewUtils.generateComponentPreviewLaunchArguments(
254254
'https://localhost:3333',
255255
testLdpServerId,
256-
'myTestComponent'
256+
'myTestComponent',
257257
);
258258

259259
const parsed = parseArgs({
@@ -324,7 +324,7 @@ describe('previewUtils', () => {
324324

325325
const generateWebSocketUrlStub = $$.SANDBOX.stub(
326326
LwcDevMobileCorePreviewUtils,
327-
'generateWebSocketUrlForLocalDevServer'
327+
'generateWebSocketUrlForLocalDevServer',
328328
).returns(mockUrl);
329329

330330
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
@@ -343,7 +343,7 @@ describe('previewUtils', () => {
343343
} as Org;
344344

345345
$$.SANDBOX.stub(OrgUtils, 'isLocalDevEnabled').resolves(true);
346-
$$.SANDBOX.stub(OrgUtils, 'ensureMatchingAPIVersion').returns();
346+
$$.SANDBOX.stub(OrgUtils, 'getVersionChannel').returns('latest');
347347
$$.SANDBOX.stub(PreviewUtils, 'getOrCreateAppServerIdentity').resolves(testIdentityData);
348348

349349
const result = await PreviewUtils.initializePreviewConnection(mockOrg);
@@ -398,7 +398,7 @@ describe('previewUtils', () => {
398398
};
399399

400400
$$.SANDBOX.stub(OrgUtils, 'isLocalDevEnabled').resolves(true);
401-
$$.SANDBOX.stub(OrgUtils, 'ensureMatchingAPIVersion').returns();
401+
$$.SANDBOX.stub(OrgUtils, 'getVersionChannel').returns('latest');
402402
$$.SANDBOX.stub(PreviewUtils, 'getOrCreateAppServerIdentity').resolves(identityDataWithoutEntityId);
403403

404404
try {

0 commit comments

Comments
 (0)