Added support for pm.execution.location (#950)

* Add support to get path of current request in sandbox script * Refactor `pm.execution.location` --------- Co-authored-by: Appurva Murawat <[email protected]>
postmanlabs · Nov 18, 2023 · af5c60e · af5c60e
1 parent 61e893f
commit af5c60e
Show file tree

Hide file tree

Showing 6 changed files with 107 additions and 8 deletions.
diff --git a/CHANGELOG.yaml b/CHANGELOG.yaml
@@ -1,3 +1,7 @@
+unreleased:
+    new features:
+     - GH-950 Added support for `pm.execution.location`
+
 4.3.0:
   date: 2023-11-02
   new features:

diff --git a/lib/sandbox/pmapi.js b/lib/sandbox/pmapi.js
@@ -269,7 +269,28 @@ function Postman (execution, onRequest, onSkipRequest, onAssertion, cookieStore,
              * @excludeFromTestScript
              * @instance
              */
-            skipRequest: onSkipRequest
+            skipRequest: onSkipRequest,
+
+            /**
+             * @interface ExecutionLocation
+             * @extends Array<string>
+             */
+
+            /**
+             * The path of the current request.
+             *
+             * @type {ExecutionLocation} - current execution path
+             * @instance
+             */
+            location: _assignDefinedReadonly(execution.legacy._itemPath || [], /** @lends ExecutionLocation */ {
+                /**
+                 * The item name whose script is currently being executed.
+                 *
+                 * @instance
+                 * @type {string}
+                 */
+                current: execution.legacy._eventItemName
+            })
         }
     }, options.disabledAPIs);
 

diff --git a/test/unit/sandbox-libraries/pm.test.js b/test/unit/sandbox-libraries/pm.test.js
@@ -1087,5 +1087,39 @@ describe('sandbox library - pm api', function () {
                 });
             });
         });
+
+        describe('.location', function () {
+            it('should return the correct path of the request', function (done) {
+                context.execute({
+                    script: `
+                        var assert = require('assert');
+                        assert.deepEqual(Array.from(pm.execution.location), ['C1', 'R1']);
+                    ` }, {
+                    legacy: {
+                        _itemName: 'request-name',
+                        _itemId: 'request-id',
+                        _itemPath: ['C1', 'R1'],
+                        _eventItemName: 'R1'
+                    }
+                }, done);
+            });
+
+            describe('.current ', function () {
+                it('should return the correct current item', function (done) {
+                    context.execute({
+                        script: `
+                            var assert = require('assert');
+                            assert.deepEqual(pm.execution.location.current, 'R1');
+                        ` }, {
+                        legacy: {
+                            _itemName: 'request-name',
+                            _itemId: 'request-id',
+                            _itemPath: ['C1', 'R1'],
+                            _eventItemName: 'R1'
+                        }
+                    }, done);
+                });
+            });
+        });
     });
 });
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1,9 +1,16 @@
+// Type definitions for postman-sandbox 4.3.0
+// Project: https://github.com/postmanlabs/postman-sandbox
+// Definitions by: PostmanLabs
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.4
+/// <reference types="node" />
+
 declare const CONSOLE_EVENT = "execution.console";
 
 /**
  * List of functions that we expect and create for console
  */
-declare const logLevels: String[];
+declare const logLevels: string[];
 
 /**
  * Replacer to be used with teleport-javascript to handle cases which are not
@@ -90,7 +97,7 @@ declare type Return = {
  */
 declare class Postman {
     constructor(execution: Execution, onRequest: (...params: any[]) => any, onSkipRequest: (...params: any[]) => any, onAssertion: (...params: any[]) => any, cookieStore: any, options?: {
-        disabledAPIs?: String[];
+        disabledAPIs?: string[];
     });
     /**
      * The pm.info object contains information pertaining to the script being executed.
@@ -183,6 +190,17 @@ declare interface Execution {
      * Stops the current request and its scripts from executing.
      */
     skipRequest(): void;
+    /**
+     * The path of the current request.
+     */
+    location: ExecutionLocation;
+}
+
+declare interface ExecutionLocation extends Array {
+    /**
+     * The item name whose script is currently being executed.
+     */
+    current: string;
 }
 
 /**
@@ -228,19 +246,19 @@ declare var SandboxGlobals: any;
  * The set of timer function names. We use this array to define common behaviour of all setters and clearer timer
  * functions
  */
-declare const timerFunctionNames: String[];
+declare const timerFunctionNames: string[];
 
 /**
  * This object defines a set of timer function names that are trigerred a number of times instead of a single time.
  * Such timers, when placed in generic rules, needs special attention.
  */
-declare const multiFireTimerFunctions: Boolean[];
+declare const multiFireTimerFunctions: boolean[];
 
 /**
  * This object defines a set of function timer names that do not fire based on any pre-set duration or interval.
  * Such timers, when placed in generic rules, needs special attention.
  */
-declare const staticTimerFunctions: Boolean[];
+declare const staticTimerFunctions: boolean[];
 
 /**
  * A local copy of Slice function of Array

diff --git a/types/sandbox/prerequest.d.ts b/types/sandbox/prerequest.d.ts
@@ -1,4 +1,4 @@
-// Type definitions for postman-sandbox 4.2.8
+// Type definitions for postman-sandbox 4.3.0
 // Project: https://github.com/postmanlabs/postman-sandbox
 // Definitions by: PostmanLabs
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -112,6 +112,17 @@ declare interface Execution {
      * @excludeFromTestScript
      */
     skipRequest(): void;
+    /**
+     * The path of the current request.
+     */
+    location: ExecutionLocation;
+}
+
+declare interface ExecutionLocation extends Array {
+    /**
+     * The item name whose script is currently being executed.
+     */
+    current: string;
 }
 
 /**

diff --git a/types/sandbox/test.d.ts b/types/sandbox/test.d.ts
@@ -1,4 +1,4 @@
-// Type definitions for postman-sandbox 4.2.8
+// Type definitions for postman-sandbox 4.3.0
 // Project: https://github.com/postmanlabs/postman-sandbox
 // Definitions by: PostmanLabs
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -113,6 +113,17 @@ declare interface Visualizer {
 }
 
 declare interface Execution {
+    /**
+     * The path of the current request.
+     */
+    location: ExecutionLocation;
+}
+
+declare interface ExecutionLocation extends Array {
+    /**
+     * The item name whose script is currently being executed.
+     */
+    current: string;
 }
 
 /**