Skip to content

Commit 40328f4

Browse files
authored
fix: Incorrect name for runRequest's getProtocolMetadata accessor (#1102)
* fix: Incorrect name for runRequest's getProtocolMetadata accessor * fix: Silently failing test suite for response casting validation * Refactor multi-protocol response casting test
1 parent e359733 commit 40328f4

File tree

2 files changed

+23
-16
lines changed

2 files changed

+23
-16
lines changed

lib/sandbox/pmapi.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -388,8 +388,8 @@ function Postman (execution,
388388
* @instance
389389
* @param {String} requestId - The UUID of the request to execute.
390390
* This can be found in the request's metadata or corresponding collection JSON.
391-
* @param {Object} [options] - Configuration options for the request execution
392-
* @param {Object} [options.variables] - Key-value pairs of variables to override during
391+
* @param {Object} [runRequestOptions] - Configuration options for the request execution
392+
* @param {Object} [runRequestOptions.variables] - Key-value pairs of variables to override during
393393
* request execution. These will act as temporary
394394
* overrides for the this specific request run.
395395
* @returns {Promise<Response | null>} A Promise that resolves to:
@@ -412,15 +412,15 @@ function Postman (execution,
412412
* console.error('Request failed:', error);
413413
* }
414414
*/
415-
runRequest: function (requestId, options) {
415+
runRequest: function (requestId, runRequestOptions) {
416416
return new Promise(function (resolve, reject) {
417417
if (!requestId) {
418418
reject(new Error('runRequest: collection request id not provided'));
419419

420420
return;
421421
}
422422

423-
onRunRequest(requestId, options || {},
423+
onRunRequest(requestId, runRequestOptions || {},
424424
function (err, resp, context) {
425425
if (err) {
426426
return reject(err);

test/unit/sandbox-libraries/pm.test.js

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1487,6 +1487,10 @@ describe('sandbox library - pm api', function () {
14871487
this.responseTime = response.responseTime;
14881488
this.isCustomGRPCResponseClass = true;
14891489
}
1490+
1491+
static isResponse (obj) {
1492+
return obj instanceof Response;
1493+
}
14901494
}
14911495
14921496
module.exports = { Response };
@@ -1497,6 +1501,19 @@ describe('sandbox library - pm api', function () {
14971501
}, (errorInitializingSandbox, sandboxContext) => {
14981502
if (errorInitializingSandbox) { return done(errorInitializingSandbox); }
14991503

1504+
sandboxContext.on(`execution.error.${executionId}`, (_exec, err) => {
1505+
done(new Error(err.message));
1506+
});
1507+
1508+
sandboxContext.on('console', (_cursor, _level, grpcRequestResponse) => {
1509+
expect(grpcRequestResponse).to.have.property('statusCode', 0);
1510+
expect(grpcRequestResponse).to.have.property('responseTime', 100);
1511+
// Custom class property
1512+
expect(grpcRequestResponse).to.have.property('isCustomGRPCResponseClass', true);
1513+
1514+
done();
1515+
});
1516+
15001517
sandboxContext.on('execution.run_collection_request.' + executionId,
15011518
function (_cursor, id, reqId) {
15021519
sandboxContext.dispatch(`execution.run_collection_request_response.${id}`,
@@ -1506,24 +1523,14 @@ describe('sandbox library - pm api', function () {
15061523
{ responseType: 'grpc' });
15071524
});
15081525

1509-
let consoleMessage = '';
1510-
1511-
sandboxContext.on('console', (_cursor, _level, message) => {
1512-
consoleMessage = message;
1513-
expect(consoleMessage).to.eql({
1514-
statusCode: 0,
1515-
responseTime: 100,
1516-
isCustomGRPCResponseClass: true
1517-
});
1518-
});
1519-
15201526
sandboxContext.execute(`
15211527
const grpcRequestResponse = await pm.execution.runRequest('sample-request-id');
1528+
15221529
console.log(grpcRequestResponse);`,
15231530
{ id: executionId, templateName: 'grpc' },
15241531
function (err) {
1525-
done(err);
15261532
sandboxContext.dispose();
1533+
if (err) { done(err); }
15271534
});
15281535
});
15291536
});

0 commit comments

Comments
 (0)