feat(pmapi): add support to get path of current request in sandbox sc…

…ript
postmanlabs · Nov 10, 2023 · 533abb7 · 533abb7
1 parent 61e893f
commit 533abb7
Show file tree

Hide file tree

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

diff --git a/lib/sandbox/pmapi.js b/lib/sandbox/pmapi.js
@@ -269,7 +269,26 @@ function Postman (execution, onRequest, onSkipRequest, onAssertion, cookieStore,
              * @excludeFromTestScript
              * @instance
              */
-            skipRequest: onSkipRequest
+            skipRequest: onSkipRequest,
+
+            /**
+             * @typedef {Object} Item
+             * @property {String} id - id of the item
+             * @property {String} name - name of the item
+             */
+
+            /**
+             * Exposes properties related to location of current execution
+             *
+             * @instance
+             * @type {Object}
+             * @property {Item} current - the current item being executed.
+             * @property {Array.<Item>} path - complete path of the current request being executed.
+             */
+            location: {
+                path: execution.legacy.requestPath,
+                current: execution.legacy.currentItem
+            }
         }
     }, options.disabledAPIs);
 

diff --git a/test/unit/sandbox-libraries/pm.test.js b/test/unit/sandbox-libraries/pm.test.js
@@ -1087,5 +1087,41 @@ describe('sandbox library - pm api', function () {
                 });
             });
         });
+        describe('.location', function () {
+            describe('.path', function () {
+                it('should return the correct path of the request', function (done) {
+                    context.execute({
+                        script: `
+                            var assert = require('assert');
+                            assert.deepEqual(pm.execution.location.path,
+                                [{ id: 'R1-id', name: 'R1' }, { id: 'C1-id', name: 'C1' }]);
+                        ` }, {
+                        legacy: {
+                            _itemName: 'request-name',
+                            _itemId: 'request-id',
+                            requestPath: [{ id: 'R1-id', name: 'R1' }, { id: 'C1-id', name: 'C1' }],
+                            currentItem: { id: 'R1-id', name: '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, { id: 'R1-id', name: 'R1' });
+                        ` }, {
+                        legacy: {
+                            _itemName: 'request-name',
+                            _itemId: 'request-id',
+                            requestPath: [{ id: 'R1-id', name: 'R1' }, { id: 'C1-id', name: 'C1' }],
+                            currentItem: { id: 'R1-id', name: 'R1' }
+                        }
+                    }, done);
+                });
+            });
+        });
     });
 });
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,8 +112,26 @@ declare interface Execution {
      * @excludeFromTestScript
      */
     skipRequest(): void;
+    /**
+     * Exposes properties related to location of current execution
+     * @property current - the current item being executed.
+     * @property path - complete path of the current request being executed.
+     */
+    location: {
+        current: Item;
+        path: Item[];
+    };
 }
 
+/**
+ * @property id - id of the item
+ * @property name - name of the item
+ */
+declare type Item = {
+    id: string;
+    name: string;
+};
+
 /**
  * The pm object encloses all information pertaining to the script being executed and
  * allows one to access a copy of the request being sent or the response received.

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,8 +113,26 @@ declare interface Visualizer {
 }
 
 declare interface Execution {
+    /**
+     * Exposes properties related to location of current execution
+     * @property current - the current item being executed.
+     * @property path - complete path of the current request being executed.
+     */
+    location: {
+        current: Item;
+        path: Item[];
+    };
 }
 
+/**
+ * @property id - id of the item
+ * @property name - name of the item
+ */
+declare type Item = {
+    id: string;
+    name: string;
+};
+
 /**
  * The pm object encloses all information pertaining to the script being executed and
  * allows one to access a copy of the request being sent or the response received.