Refactor pm.execution.location

postmanlabs · Nov 18, 2023 · aad1b76 · aad1b76
1 parent f962496
commit aad1b76
Show file tree

Hide file tree

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

diff --git a/lib/sandbox/execution-location.js b/lib/sandbox/execution-location.js
diff --git a/lib/sandbox/pmapi.js b/lib/sandbox/pmapi.js
@@ -6,7 +6,6 @@ const _ = require('lodash'),
     PostmanResponse = sdk.Response,
     PostmanCookieList = sdk.CookieList,
     chai = require('chai'),
-    ExecutionLocation = require('./execution-location'),
 
     /**
      * Use this function to assign readonly properties to an object
@@ -273,23 +272,25 @@ function Postman (execution, onRequest, onSkipRequest, onAssertion, cookieStore,
             skipRequest: onSkipRequest,
 
             /**
-             * @interface ExecutionLocationInterface
+             * @interface ExecutionLocation
              * @extends Array<string>
              */
-            /**
-             * The element name whose script is currently being executed.
-             *
-             * @name ExecutionLocationInterface#current
-             * @type {string}
-             */
+
             /**
              * The path of the current request.
              *
-             * @type {ExecutionLocationInterface} - current execution path
+             * @type {ExecutionLocation} - current execution path
              * @instance
              */
-            location: new ExecutionLocation(execution.legacy._eventItemName,
-                ...(execution.legacy._itemPath || []))
+            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/types/sandbox/prerequest.d.ts b/types/sandbox/prerequest.d.ts
@@ -115,10 +115,10 @@ declare interface Execution {
     /**
      * The path of the current request.
      */
-    location: ExecutionLocationInterface;
+    location: ExecutionLocation;
 }
 
-declare interface ExecutionLocationInterface extends Array {
+declare interface ExecutionLocation extends Array {
     /**
      * The element name whose script is currently being executed.
      */

diff --git a/types/sandbox/test.d.ts b/types/sandbox/test.d.ts
@@ -116,10 +116,10 @@ declare interface Execution {
     /**
      * The path of the current request.
      */
-    location: ExecutionLocationInterface;
+    location: ExecutionLocation;
 }
 
-declare interface ExecutionLocationInterface extends Array {
+declare interface ExecutionLocation extends Array {
     /**
      * The element name whose script is currently being executed.
      */