Skip to content

Commit df204e5

Browse files
renonick87renonick87
committed
Update references to lifecycleManager's sendRpcMessage method
1 parent 0894721 commit df204e5

8 files changed

Lines changed: 70 additions & 28 deletions

File tree

‎lib/js/src/manager/SystemCapabilityManager.js‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -471,6 +471,7 @@ class SystemCapabilityManager extends _SubManagerBase {
471471

472472
/**
473473
* Sends a request to core for the capability, instead of checking cached capabilities
474+
* @deprecated since version 1.1. Use sendRpcResolve instead
474475
* @param {SystemCapabilityType} systemCapabilityType - A SystemCapabilityType enum value.
475476
* @returns {Promise} - Promise returning either the capability Object or null if not found
476477
*/
@@ -510,6 +511,47 @@ class SystemCapabilityManager extends _SubManagerBase {
510511
return this.getCapability(systemCapabilityType, retrievedCapability);
511512
}
512513

514+
/**
515+
* Sends a request to core for the capability, instead of checking cached capabilities
516+
* @param {SystemCapabilityType} systemCapabilityType - A SystemCapabilityType enum value.
517+
* @returns {Promise} - Promise returning either the capability Object or null if not found
518+
*/
519+
async updateCapabilityResolve (systemCapabilityType) {
520+
// don't bother getting a capability if it isn't queryable
521+
const getCapabilityMethodName = this._getCapabilityMethodForType(systemCapabilityType);
522+
if (getCapabilityMethodName === null) {
523+
console.error(`The systemCapabilityType ${systemCapabilityType} cannot be queried for`);
524+
return null;
525+
}
526+
527+
const request = new GetSystemCapability()
528+
.setSystemCapabilityType(systemCapabilityType);
529+
530+
if (this._lifecycleManager === null) {
531+
return null;
532+
}
533+
534+
const response = await this._lifecycleManager.sendRpcResolve(request)
535+
.catch(err => {
536+
if (err instanceof RpcResponse) {
537+
console.error(`GetSystemCapability for type ${systemCapabilityType} returned with response code ${err.getResultCode()}`);
538+
} else {
539+
console.error(new Error(err));
540+
}
541+
return null;
542+
});
543+
544+
if (response === null) {
545+
return null;
546+
}
547+
548+
// invoke the correct get capability method
549+
const retrievedCapability = response.getSystemCapability()[getCapabilityMethodName]();
550+
this._setCapability(systemCapabilityType, retrievedCapability);
551+
// get the capability back through this method, because it may have changed the output
552+
return this.getCapability(systemCapabilityType, retrievedCapability);
553+
}
554+
513555
/**
514556
* Add an OnSystemCapabilityListener function.
515557
* @param {SystemCapabilityType} systemCapabilityType - A SystemCapabilityType enum value.

‎lib/js/src/manager/file/_FileManagerBase.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ class _FileManagerBase extends _SubManagerBase {
8989

9090
const listFiles = new ListFiles();
9191

92-
const rpcResponse = await this._lifecycleManager.sendRpcMessage(listFiles);
92+
const rpcResponse = await this._lifecycleManager.sendRpcResolve(listFiles);
9393
if (rpcResponse.getSuccess()) {
9494
this._bytesAvailable = rpcResponse.getSpaceAvailable() ? rpcResponse.getSpaceAvailable() : SPACE_AVAILABLE_MAX_VALUE;
9595
const filenames = rpcResponse.getFilenames();
@@ -113,7 +113,7 @@ class _FileManagerBase extends _SubManagerBase {
113113
const deleteFile = new DeleteFile()
114114
.setSdlFileName(fileName);
115115

116-
const rpcResponse = await this._lifecycleManager.sendRpcMessage(deleteFile);
116+
const rpcResponse = await this._lifecycleManager.sendRpcResolve(deleteFile);
117117
const isSuccess = rpcResponse.getSuccess();
118118
if (isSuccess) {
119119
this._bytesAvailable = rpcResponse.getSpaceAvailable() ? rpcResponse.getSpaceAvailable() : SPACE_AVAILABLE_MAX_VALUE;
@@ -164,7 +164,7 @@ class _FileManagerBase extends _SubManagerBase {
164164
}
165165
const putFile = await this._createPutFile(sdlFile);
166166

167-
const putFileResponse = await this._lifecycleManager.sendRpcMessage(putFile);
167+
const putFileResponse = await this._lifecycleManager.sendRpcResolve(putFile);
168168
if (putFileResponse.getSuccess()) {
169169
this._bytesAvailable = putFileResponse.getSpaceAvailable() !== null ? putFileResponse.getSpaceAvailable() : SPACE_AVAILABLE_MAX_VALUE;
170170
this._remoteFiles.push(sdlFile.getName());

‎lib/js/src/manager/lifecycle/_LifecycleManager.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ class _LifecycleManager {
109109

110110
if (serviceType === _ServiceType.RPC) {
111111
if (this._lifecycleConfig !== null && this._lifecycleConfig !== undefined) {
112-
this.sendRpcMessage(this._createRegisterAppInterface())
112+
this.sendRpcResolve(this._createRegisterAppInterface())
113113
.catch(() => {
114114
// avoids uncaught error
115115
});
@@ -483,7 +483,7 @@ class _LifecycleManager {
483483

484484
if (this._minimumRpcVersion !== null && this._minimumRpcVersion.isNewerThan(this._rpcSpecVersion) === 1) {
485485
console.warn(`Disconnecting from head unit, the configured minimum RPC version ${this._minimumRpcVersion} is greater than the supported RPC version ${this._rpcSpecVersion}`);
486-
this.sendRpcMessage(new UnregisterAppInterface());
486+
this.sendRpcResolve(new UnregisterAppInterface());
487487
this._cleanProxy();
488488
}
489489

‎lib/js/src/manager/screen/_SoftButtonManagerBase.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ class _SoftButtonManagerBase extends _SubManagerBase {
318318
show.setSoftButtons(this._createSoftButtonsForCurrentState());
319319
}
320320

321-
const response = await this._lifecycleManager.sendRpcMessage(show)
321+
const response = await this._lifecycleManager.sendRpcResolve(show)
322322
.catch(err => err);
323323

324324
if (!response.getSuccess()) {

‎lib/js/src/manager/screen/_TextAndGraphicManagerBase.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ class _TextAndGraphicManagerBase extends _SubManagerBase {
172172
this._softButtonManager.setCurrentMainField1(show.getMainField1());
173173
}
174174

175-
const response = await this._lifecycleManager.sendRpcMessage(show);
175+
const response = await this._lifecycleManager.sendRpcResolve(show);
176176

177177
if (response.getSuccess()) {
178178
this._updateCurrentScreenDataState(show);

‎lib/js/src/manager/screen/_VoiceCommandManagerBase.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ class _VoiceCommandManagerBase extends _SubManagerBase {
139139
const deleteCommandPromises = voiceCommands.map(voiceCommand => {
140140
const deleteCommand = new DeleteCommand()
141141
.setCmdID(voiceCommand._getCommandId());
142-
return this._lifecycleManager.sendRpcMessage(deleteCommand);
142+
return this._lifecycleManager.sendRpcResolve(deleteCommand);
143143
});
144144

145145
return Promise.all(deleteCommandPromises);
@@ -161,7 +161,7 @@ class _VoiceCommandManagerBase extends _SubManagerBase {
161161
const addCommand = new AddCommand()
162162
.setCmdID(voiceCommand._getCommandId())
163163
.setVrCommands(voiceCommand.getVoiceCommands());
164-
return this._lifecycleManager.sendRpcMessage(addCommand);
164+
return this._lifecycleManager.sendRpcResolve(addCommand);
165165
});
166166

167167
return Promise.all(addCommandPromises);

‎tests/managers/file/FileManagerTests.js‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -175,12 +175,12 @@ module.exports = function (appClient) {
175175
// add a listener to verify success
176176
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.ListFiles, expectSuccess);
177177

178-
// "stubs" the sendRpcMessage so that any calls to it will instead go to onListFilesSuccess
179-
const stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
178+
// "stubs" the sendRpcResolve so that any calls to it will instead go to onListFilesSuccess
179+
const stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
180180
.callsFake(onListFilesSuccess);
181181
await fileManager._retrieveRemoteFiles();
182182

183-
// remove the stub on sendRpcMessage
183+
// remove the stub on sendRpcResolve
184184
stub.restore();
185185

186186
Validator.assertEquals(fileManager.getRemoteFileNames(), Test.GENERAL_STRING_LIST);
@@ -196,7 +196,7 @@ module.exports = function (appClient) {
196196
};
197197

198198
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.ListFiles, expectFailure);
199-
const stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
199+
const stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
200200
.callsFake(onListFilesFailure);
201201

202202
await fileManager._retrieveRemoteFiles();
@@ -216,12 +216,12 @@ module.exports = function (appClient) {
216216
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.ListFiles, expectSuccess);
217217
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.PutFile, expectFailure);
218218

219-
let stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
219+
let stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
220220
.callsFake(onListFilesSuccess);
221221
await fileManager._retrieveRemoteFiles();
222222
stub.restore();
223223

224-
stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
224+
stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
225225
.callsFake(onPutFileFailure);
226226
await fileManager.uploadFile(validFile);
227227
stub.restore();
@@ -241,12 +241,12 @@ module.exports = function (appClient) {
241241
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.ListFiles, expectSuccess);
242242
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.PutFile, expectSuccess);
243243

244-
let stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
244+
let stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
245245
.callsFake(onListFilesSuccess);
246246
await fileManager._retrieveRemoteFiles();
247247
stub.restore();
248248

249-
stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
249+
stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
250250
.callsFake(onPutFileSuccess);
251251
await fileManager.uploadFile(validFile);
252252
stub.restore();
@@ -266,7 +266,7 @@ module.exports = function (appClient) {
266266

267267
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.ListFiles, expectSuccess);
268268

269-
const stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
269+
const stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
270270
.callsFake(onListFilesSuccess);
271271
await fileManager._retrieveRemoteFiles();
272272
stub.restore();
@@ -316,7 +316,7 @@ module.exports = function (appClient) {
316316
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.PutFile, expectSuccess);
317317
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.DeleteFile, expectSuccess);
318318

319-
let stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
319+
let stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
320320
.callsFake(onListFilesSuccess);
321321
await fileManager._retrieveRemoteFiles();
322322
stub.restore();
@@ -336,7 +336,7 @@ module.exports = function (appClient) {
336336
sdlFile.setType(SDL.rpc.enums.FileType.BINARY);
337337
filesToUpload.push(sdlFile);
338338

339-
stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
339+
stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
340340
.callsFake(onPutFileSuccess);
341341
await fileManager.uploadFiles(filesToUpload);
342342
stub.restore();
@@ -345,7 +345,7 @@ module.exports = function (appClient) {
345345
Validator.assertTrue(uploadedFileNames.includes(filesToUpload[0].getName()));
346346
Validator.assertTrue(uploadedFileNames.includes(filesToUpload[1].getName()));
347347

348-
stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
348+
stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
349349
.callsFake(onDeleteFileSuccess);
350350
await fileManager.deleteRemoteFilesWithNames(uploadedFileNames);
351351
stub.restore();
@@ -375,7 +375,7 @@ module.exports = function (appClient) {
375375
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.ListFiles, expectSuccess);
376376
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.PutFile, expectSuccessThenFail);
377377

378-
let stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
378+
let stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
379379
.callsFake(onListFilesSuccess);
380380
await fileManager._retrieveRemoteFiles();
381381
stub.restore();
@@ -396,7 +396,7 @@ module.exports = function (appClient) {
396396
filesToUpload.push(sdlFile);
397397
let uploadedFileNames = fileManager.getRemoteFileNames();
398398

399-
stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
399+
stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
400400
.callsFake(onMultiplePutFileSuccess);
401401
await fileManager.uploadFiles(filesToUpload);
402402
stub.restore();
@@ -417,7 +417,7 @@ module.exports = function (appClient) {
417417
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.ListFiles, expectSuccess);
418418
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.PutFile, expectSuccess);
419419

420-
let stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
420+
let stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
421421
.callsFake(onMultipleListFilesSuccess);
422422
await fileManager._retrieveRemoteFiles();
423423
stub.restore();
@@ -436,7 +436,7 @@ module.exports = function (appClient) {
436436
.setType(SDL.rpc.enums.FileType.GRAPHIC_PNG);
437437
artworkToUpload.push(sdlArtwork);
438438

439-
stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
439+
stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
440440
.callsFake(onPutFileSuccess);
441441
await fileManager.uploadFiles(artworkToUpload);
442442
stub.restore();
@@ -457,7 +457,7 @@ module.exports = function (appClient) {
457457

458458
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.ListFiles, expectSuccess);
459459

460-
const stub = sinon.stub(lifecycleManager, 'sendRpcMessage')
460+
const stub = sinon.stub(lifecycleManager, 'sendRpcResolve')
461461
.callsFake(onListFilesSuccess);
462462
await fileManager._retrieveRemoteFiles();
463463
stub.restore();

‎tests/managers/lifecycle/LifecycleManagerTests.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ module.exports = function (appClient) {
3838
}
3939
it('testRpcListener', function (done) {
4040
sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.ListFiles, validateRpcResponse);
41-
const stub = sinon.stub(sdlManager.getFileManager()._lifecycleManager, 'sendRpcMessage')
41+
const stub = sinon.stub(sdlManager.getFileManager()._lifecycleManager, 'sendRpcResolve')
4242
.callsFake(handleRpcStub);
43-
sdlManager._lifecycleManager.sendRpcMessage(new SDL.rpc.messages.ListFiles());
43+
sdlManager._lifecycleManager.sendRpcResolve(new SDL.rpc.messages.ListFiles());
4444
stub.restore();
4545
sdlManager.removeRpcListener(SDL.rpc.enums.FunctionID.ListFiles, validateRpcResponse);
4646
done();

0 commit comments

Comments
 (0)