@usebruno/js 0.36.0 → 0.37.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usebruno/js",
-  "version": "0.36.0",
+  "version": "0.37.0",
   "license": "MIT",
   "main": "src/index.js",
   "files": [
@@ -16,7 +16,7 @@
     "prepack": "npm run test"
   },
   "dependencies": {
-    "@usebruno/common": "0.10.0",
+    "@usebruno/common": "0.11.0",
     "@usebruno/crypto-js": "^3.1.9",
     "@usebruno/query": "0.1.0",
     "ajv": "^8.12.0",
@@ -44,8 +44,6 @@
     "@rollup/plugin-commonjs": "^23.0.2",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "rollup": "3.29.5",
-    "rollup-plugin-terser": "^7.0.2",
-    "stream": "^0.0.2",
-    "util": "^0.12.5"
+    "rollup-plugin-terser": "^7.0.2"
   }
-}
+}

package/src/bru.js

@@ -2,7 +2,7 @@ const { cloneDeep } = require('lodash');
 const { uuid } = require('./utils');
 const { interpolate: _interpolate } = require('@usebruno/common');
 const { sendRequest } = require('@usebruno/requests').scripting;
-const { jar: createCookieJar } = require('@usebruno/common').cookies;
+const { jar: createCookieJar } = require('@usebruno/requests').cookies;
 
 const variableNameRegex = /^[\w-.]*$/;
 
@@ -22,7 +22,6 @@ class Bru {
     this.setVisualizations = setVisualizations;
     this.collectionName = collectionName;
     this.sendRequest = sendRequest;
-
     this.cookies = {
       jar: () => {
         const cookieJar = createCookieJar();
@@ -66,6 +65,8 @@ class Bru {
         };
       }
     };
+    // Holds variables that are marked as persistent by scripts
+    this.persistentEnvVariables = {};
     this.runner = {
       skipRequest: () => {
         this.skipRequest = true;
@@ -128,10 +129,21 @@ class Bru {
     return this.interpolate(this.envVariables[key]);
   }
 
-  setEnvVar(key, value) {
+  setEnvVar(key, value, options = {}) {
     if (!key) {
       throw new Error('Creating a env variable without specifying a name is not allowed.');
     }
+    
+    if (variableNameRegex.test(key) === false) {
+      throw new Error(
+        `Variable name: "${key}" contains invalid characters! Names must only contain alpha-numeric characters, "-", "_", "."`
+      );
+    }
+
+    // When persist is true, only string values are allowed
+    if (options?.persist && typeof value !== 'string') {
+      throw new Error(`Persistent environment variables must be strings. Received ${typeof value} for key "${key}".`);
+    }
 
     if (this.historyLogger) {
       this.historyLogger({
@@ -143,6 +155,14 @@ class Bru {
     }
 
     this.envVariables[key] = value;
+
+    if (options?.persist) {
+      this.persistentEnvVariables[key] = value;
+    } else {
+      if (this.persistentEnvVariables[key]) {
+        delete this.persistentEnvVariables[key];
+      }
+    }
   }
 
   deleteEnvVar(key) {

package/src/runtime/script-runtime.js

@@ -131,6 +131,7 @@ class ScriptRuntime {
         envVariables: cleanJson(envVariables),
         runtimeVariables: cleanJson(runtimeVariables),
         visualizations,
+        persistentEnvVariables: bru.persistentEnvVariables,
         globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
         results: cleanJson(__brunoTestResults.getResults()),
         nextRequestName: bru.nextRequest,
@@ -187,6 +188,7 @@ class ScriptRuntime {
       envVariables: cleanJson(envVariables),
       runtimeVariables: cleanJson(runtimeVariables),
       visualizations,
+      persistentEnvVariables: bru.persistentEnvVariables,
       globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
       results: cleanJson(__brunoTestResults.getResults()),
       nextRequestName: bru.nextRequest,
@@ -285,6 +287,7 @@ class ScriptRuntime {
       return {
         response,
         envVariables: cleanJson(envVariables),
+        persistentEnvVariables: cleanJson(bru.persistentEnvVariables),
         runtimeVariables: cleanJson(runtimeVariables),
         visualizations,
         globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
@@ -341,6 +344,7 @@ class ScriptRuntime {
     return {
       response,
       envVariables: cleanJson(envVariables),
+      persistentEnvVariables: cleanJson(bru.persistentEnvVariables),
       runtimeVariables: cleanJson(runtimeVariables),
       visualizations,
       globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),

package/src/runtime/test-runtime.js

@@ -197,6 +197,7 @@ class TestRuntime {
       envVariables: cleanJson(envVariables),
       runtimeVariables: cleanJson(runtimeVariables),
       globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+      persistentEnvVariables: cleanJson(bru.persistentEnvVariables),
       results: cleanJson(__brunoTestResults.getResults()),
       nextRequestName: bru.nextRequest
     };

package/src/runtime/vars-runtime.js

@@ -76,6 +76,7 @@ class VarsRuntime {
       envVariables,
       runtimeVariables,
       globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+      persistentEnvVariables: cleanJson(bru.persistentEnvVariables),
       error
     };
   }

package/src/sandbox/quickjs/shims/bru.js

@@ -48,8 +48,8 @@ const addBruShimToContext = (vm, bru) => {
   vm.setProp(bruObject, 'getEnvVar', getEnvVar);
   getEnvVar.dispose();
 
-  let setEnvVar = vm.newFunction('setEnvVar', function (key, value) {
-    bru.setEnvVar(vm.dump(key), vm.dump(value));
+  let setEnvVar = vm.newFunction('setEnvVar', function (key, value, options = {}) {
+    bru.setEnvVar(vm.dump(key), vm.dump(value), vm.dump(options));
   });
   vm.setProp(bruObject, 'setEnvVar', setEnvVar);
   setEnvVar.dispose();