mirror of
https://github.com/usebruno/bruno.git
synced 2026-06-27 22:54:07 +00:00
feat(variables): persist scripted variable changes by default + re-enable disabled scripting APIs (#8315)
* feat(variables): add variable persistence with scripting feat(collections): implement script-driven update for collection variables, ensuring direct root modification and draft synchronization feat(collections): enhance script variable management with baseline tracking and draft preservation * feat(variables): add runtime variable updates and optimize disk writes by implementing dirty flags fix(collections): handle errors during environment persistence in script execution feat(collections): implement baseline clearing for script execution and optimize variable update handling feat(tests): add default persistence tests for environment variables and update runtime variable handling refactor(collections): streamline variable update handling and improve draft management by removing redundant comments and optimizing code clarity test(collection-vars): add verification for draft edits and script variable visibility in collection settings UI refactor(collection-vars): update header value selection logic for improved clarity and accuracy in draft isolation tests * feat(global-environments): enhance global environment updates to resolve stale active UIDs and improve persistence logic - Updated the `updateGlobalEnvironments` reducer to handle stale active UIDs by matching against environment names. - Improved the logic for setting global environments and active UIDs to ensure consistency after disk reloads. - Removed outdated tests related to persisted values in favor of more relevant assertions for environment variable handling. * feat(variables): enhance typed value handling and persistence in global and collection environments - Added tests to infer data types (number, boolean, object) when setting environment and collection variables. - Updated the logic to preserve existing data types when variables are not modified by scripts. - Implemented dirty flags to track changes in typed variables, ensuring accurate persistence across sessions. - Refactored related tests to verify the correct behavior of typed variables in various scenarios. * refactor(variables): streamline data type inference and enhance deletion methods - Removed redundant data type inference logic from global and collection variable updates to simplify the codebase. - Updated deletion methods in the Bru class to use Object.keys for improved resilience against user-defined properties. - Added tests to ensure deletion methods function correctly even when properties are shadowed. - Enhanced clarity in draft merge tests by standardizing keyboard shortcuts for selecting all text. * fix(tests): correct variable naming and improve environment panel interactions - Updated test cases to reflect the correct variable name 'wasSaved' instead of 'was-saved'. - Modified environment panel interaction to remove forced click, enhancing test reliability. - Added a utility function to close the environment panel in safe mode tests for better readability and maintainability. * feat(runtime): enhance variable management and cleanup logic - Introduced a new method to clear script-driven variable baselines for collections, ensuring no stale data leaks into new requests. - Updated the handling of runtime variables in the Bru class to track changes with a new dirty flag, improving state management. - Refactored the application of script environment variables to prevent direct mutations, ensuring immutability and cleaner state updates. - Enhanced the response handling in the script runtime to conditionally include runtime variables based on their dirty state. * feat(variables): improve request handling and state management for collections and environments - Enhanced event listeners to clear global environment baselines on both 'testrun-started' and 'request-queued' events, preventing stale data issues. - Updated global environment and collection variable update events to ignore stale updates from superseded requests, ensuring accurate state management. - Refactored the Bru class to optimize variable management, including checks for existing keys before updates and deletions, improving performance and reliability. - Introduced request UID tracking to maintain consistency across variable updates during concurrent requests. * refactor(collections): update action to clear script variable baselines - Replaced the dispatch of `_clearScriptGlobalEnvBaseline` with `clearScriptVariableBaselines` to improve clarity and maintainability in the Redux action handling for collections. * feat(environments): introduce getScriptModifiedKeys utility for improved variable management - Added a new utility function, `getScriptModifiedKeys`, to identify keys modified by scripts relative to a baseline, enhancing the handling of data types during variable updates. - Updated the application of script environment variables to prevent overwriting user-defined draft changes during no-op writes. - Refactored related logic in collections and global environments to utilize the new utility, ensuring accurate state management and improved clarity in the Redux slices. * refactor(global-environments): simplify active UID resolution logic in updateGlobalEnvironments reducer - Streamlined the logic for resolving the active global environment UID by consolidating conditions into a more concise format. - Removed outdated comments to enhance code clarity and maintainability. - Updated tests to ensure accurate resolution of active UIDs based on incoming environment data. * refactor(tests): remove outdated comments and streamline environment variable row expectations - Eliminated comments related to state sync and inference issues to enhance code clarity. - Adjusted expectations for environment variable row rendering in tests, focusing on relevant assertions. * feat(tests): add comprehensive tests for secret variable persistence in environments - Introduced new test cases to validate the preservation of secret variables when updated via scripts in both collection and global environments. - Implemented tests to ensure that secret values are encrypted before storage and can be correctly decrypted for subsequent requests. - Added fixtures and environment configurations for testing secret variable behavior in both bru and yml formats. - Enhanced utility functions for managing environment configurations and interactions within the test suite. * feat(tests): enhance environment variable tests and add global variable persistence - Updated MultiLineEditor and SingleLineEditor components to include data-testid for secret reveal toggle buttons, improving testability. - Introduced new tests for global environment variable persistence, ensuring non-secret variables survive app restarts and are correctly interpolated. - Added fixtures for workspace and collections to support the new global variable tests, enhancing the overall test coverage for environment management. - Refactored utility functions to streamline interactions with environment variables in tests. * refactor(collections): optimize environment and collection saving logic - Simplified the persistence logic for active environments by directly constructing the environment copy, reducing unnecessary cloning. - Updated the collection saving process to utilize the fresh collection state, ensuring accurate data is saved without drafts. - Enhanced error handling during the save operations to improve reliability and maintainability. * feat(tests): implement collection variable persistence tests - Added multiple test cases to validate the persistence of collection variables across app restarts, including typed values and multiple variable settings. - Created new fixtures for collection variables to support the tests, ensuring accurate simulation of variable management scenarios. - Enhanced the existing collection management logic to ensure that variables are correctly set and deleted as per the test requirements. * feat(tests): add tests for typed global environment variable persistence - Introduced a new test suite to validate the persistence of typed global environment variables across app restarts, ensuring correct data types are maintained. - Created a fixture for the test collection to simulate setting global variables with various data types, including number, boolean, object, and string. - Enhanced the test logic to verify that the environment file reflects the correct state before and after application restarts. * fix(tests): update request tab close interaction in variable persistence tests * fix(tests): improve hover interaction for collection actions in runner tests - Updated the hover logic for revealing collection actions to handle sidebar re-renders more reliably. - Replaced one-shot hover with a polling mechanism to ensure visibility of actions, enhancing test stability. * refactor(environments): streamline environment variable handling and remove ephemeral metadata logic - Simplified the comparison logic for environment variables by removing unnecessary ephemeral metadata handling. - Updated the saving process to directly use the environment variables without stripping metadata, enhancing clarity and maintainability. - Removed outdated comments and unused utility functions related to ephemeral variables, improving code cleanliness. * fix(ipc): update persistActiveEnvironment to handle requestUid for stale updates - Modified the persistActiveEnvironment function to accept a requestUid parameter, allowing for better management of stale updates. - Enhanced the logic to prevent disk writes for superseded requests, improving data integrity during environment persistence. * refactor(bru): remove unused envName variable in deleteAllEnvVars method - Eliminated the envName variable from the deleteAllEnvVars method, simplifying the logic for deleting environment variables. - Cleaned up the method by removing unnecessary checks related to the envName, enhancing code clarity and maintainability. * fix(bru): prevent deletion of internal __name__ variable in deleteEnvVar method - Added a check in the deleteEnvVar method to silently ignore attempts to delete the internal __name__ variable, preserving its integrity. - Updated tests to verify that the __name__ variable remains unchanged when deleteEnvVar is called with this key. - Enhanced runtime tests to ensure compatibility with QuickJS by confirming that environment variables set with persist options are handled correctly. * feat(tests): add legacy support test for environment variable persistence - Introduced a new test suite to validate that the legacy argument for setting environment variables with persistence is still functional in version 4. - Created a fixture to simulate the legacy syntax, ensuring that the variable is correctly persisted on disk without errors. - Enhanced integration testing to confirm that the legacy behavior aligns with the current implementation, maintaining backward compatibility. * test(tests): enhance legacy environment variable persistence tests for safe and developer modes - Updated the test suite for `bru.setEnvVar` to verify that the legacy persist flag is correctly handled in both safe and developer modes. - Introduced a helper function to streamline the verification process and ensure consistent behavior across different execution contexts. - Adjusted the test logic to reset the environment state between mode switches, maintaining test integrity. - Improved hover interaction in multiple persistent variable tests to ensure reliable visibility of actions during execution. * fix(EnvironmentVariablesTable): correct change detection logic for environment variables - Updated the logic for determining changes in environment variables to compare active current and saved values instead of previously used variablesToSave and savedValues. - This change ensures accurate detection of modifications before saving, improving user feedback when no changes are present. * test(tests): enhance secret variable persistence tests for environment configurations - Updated the test suites for `bru.setEnvVar` and `bru.setGlobalEnvVar` to include interactions with the secrets tab, ensuring visibility of secret variables during various states of the environment. - Added checks to confirm that the eye toggle functionality correctly reveals the values of secret variables after setting and overwriting them. - Improved test coverage for secret variable persistence, validating that the expected values are displayed in both collection and global environment contexts.
This commit is contained in:
sanish chirayath
GitHub
@@ -0,0 +1,86 @@
|
||||
import path from 'path';
|
||||
import fs from 'fs';
|
||||
import { test, expect, closeElectronApp } from '../../../playwright';
|
||||
import {
|
||||
openCollection,
|
||||
openRequest,
|
||||
sendRequest,
|
||||
selectEnvironment,
|
||||
expectResponseContains,
|
||||
waitForReadyPage
|
||||
} from '../../utils/page';
|
||||
import { waitForCollectionMount } from '../../utils/page/mounting';
|
||||
|
||||
const NEW_VALUE = 'VALUE_global_nonsecret_e2e_42';
|
||||
const initUserDataPath = path.join(__dirname, 'init-user-data');
|
||||
const workspaceFixturePath = path.join(__dirname, 'fixtures', 'workspace');
|
||||
|
||||
test.describe('bru.setGlobalEnvVar(name, value) - non-secret variable persistence (workspace mode)', () => {
|
||||
test('persisted non-secret global var survives app restart and interpolates on the next launch', async ({
|
||||
launchElectronApp,
|
||||
createTmpDir
|
||||
}) => {
|
||||
const userDataPath = await createTmpDir('userdata');
|
||||
const workspacePath = await createTmpDir('workspace');
|
||||
await fs.promises.cp(workspaceFixturePath, workspacePath, { recursive: true });
|
||||
|
||||
const envFilePath = path.join(workspacePath, 'environments', 'Local.yml');
|
||||
|
||||
await test.step('Fixture sanity: global env yml declares globalToken (non-secret) with empty value', () => {
|
||||
const initial = fs.readFileSync(envFilePath, 'utf8');
|
||||
expect(initial).toMatch(/name:\s*globalToken/);
|
||||
expect(initial).toMatch(/secret:\s*false/);
|
||||
expect(initial).not.toContain(NEW_VALUE);
|
||||
});
|
||||
|
||||
const firstApp = await launchElectronApp({
|
||||
initUserDataPath,
|
||||
userDataPath,
|
||||
templateVars: { workspacePath }
|
||||
});
|
||||
try {
|
||||
const page = await waitForReadyPage(firstApp);
|
||||
|
||||
await test.step('First launch: run set-global-var; non-secret value is written into the env yml on disk', async () => {
|
||||
await waitForCollectionMount(page, 'Test Collection');
|
||||
await openCollection(page, 'Test Collection');
|
||||
await openRequest(page, 'Test Collection', 'set-global-var', { persist: true });
|
||||
await selectEnvironment(page, 'Local', 'global');
|
||||
await sendRequest(page, 200);
|
||||
|
||||
await expect.poll(() => fs.readFileSync(envFilePath, 'utf8'), { timeout: 5000 })
|
||||
.toContain(NEW_VALUE);
|
||||
const content = fs.readFileSync(envFilePath, 'utf8');
|
||||
expect(content).toMatch(/name:\s*globalToken/);
|
||||
});
|
||||
} finally {
|
||||
await closeElectronApp(firstApp);
|
||||
}
|
||||
|
||||
const contentBeforeRestart = fs.readFileSync(envFilePath, 'utf8');
|
||||
|
||||
const secondApp = await launchElectronApp({
|
||||
initUserDataPath,
|
||||
userDataPath,
|
||||
templateVars: { workspacePath }
|
||||
});
|
||||
try {
|
||||
const page = await waitForReadyPage(secondApp);
|
||||
|
||||
await test.step('Second launch: env yml on disk is byte-identical to pre-restart', () => {
|
||||
expect(fs.readFileSync(envFilePath, 'utf8')).toBe(contentBeforeRestart);
|
||||
});
|
||||
|
||||
await test.step('Interpolation after restart: read-global-var resolves {{globalToken}} to the persisted value', async () => {
|
||||
await waitForCollectionMount(page, 'Test Collection');
|
||||
await openCollection(page, 'Test Collection');
|
||||
await selectEnvironment(page, 'Local', 'global');
|
||||
await openRequest(page, 'Test Collection', 'read-global-var', { persist: true });
|
||||
await sendRequest(page, 200);
|
||||
await expectResponseContains(page, [NEW_VALUE]);
|
||||
});
|
||||
} finally {
|
||||
await closeElectronApp(secondApp);
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,101 @@
|
||||
import path from 'path';
|
||||
import fs from 'fs';
|
||||
import { test, expect, closeElectronApp } from '../../../playwright';
|
||||
import {
|
||||
openCollection,
|
||||
openRequest,
|
||||
sendRequest,
|
||||
selectEnvironment,
|
||||
waitForReadyPage
|
||||
} from '../../utils/page';
|
||||
import { buildCommonLocators } from '../../utils/page/locators';
|
||||
import { waitForCollectionMount } from '../../utils/page/mounting';
|
||||
|
||||
const initUserDataPath = path.join(__dirname, 'init-user-data');
|
||||
const workspaceFixturePath = path.join(__dirname, 'fixtures', 'workspace');
|
||||
|
||||
test.describe('bru.setGlobalEnvVar(name, value) - typed value persistence (workspace mode)', () => {
|
||||
test('persists number/boolean/object/string global vars with correct dataType across restart', async ({
|
||||
launchElectronApp,
|
||||
createTmpDir
|
||||
}) => {
|
||||
const userDataPath = await createTmpDir('userdata');
|
||||
const workspacePath = await createTmpDir('workspace');
|
||||
await fs.promises.cp(workspaceFixturePath, workspacePath, { recursive: true });
|
||||
|
||||
const envFilePath = path.join(workspacePath, 'environments', 'Local.yml');
|
||||
|
||||
const firstApp = await launchElectronApp({
|
||||
initUserDataPath,
|
||||
userDataPath,
|
||||
templateVars: { workspacePath }
|
||||
});
|
||||
try {
|
||||
const page = await waitForReadyPage(firstApp);
|
||||
|
||||
await test.step('First launch: run set-typed-global-vars; Local.yml gains typed entries with `type` annotations', async () => {
|
||||
await waitForCollectionMount(page, 'Test Collection');
|
||||
await openCollection(page, 'Test Collection');
|
||||
await openRequest(page, 'Test Collection', 'set-typed-global-vars', { persist: true });
|
||||
await selectEnvironment(page, 'Local', 'global');
|
||||
await sendRequest(page, 200);
|
||||
|
||||
// The YAML serializer emits typed values as { value: { type, data } } objects —
|
||||
// see packages/bruno-filestore/src/formats/yml/common/datatype.ts:34.
|
||||
await expect.poll(() => fs.readFileSync(envFilePath, 'utf8'), { timeout: 5000 })
|
||||
.toMatch(/name:\s*global_num[\s\S]*?type:\s*number[\s\S]*?data:\s*['"]?42/);
|
||||
const content = fs.readFileSync(envFilePath, 'utf8');
|
||||
|
||||
expect(content).toMatch(/name:\s*global_bool[\s\S]*?type:\s*boolean[\s\S]*?data:\s*['"]?true/);
|
||||
expect(content).toMatch(/name:\s*global_obj[\s\S]*?type:\s*object[\s\S]*?data:[\s\S]*?scope/);
|
||||
// 'string' is the implicit default — the serializer emits a raw string value, no `type:` block.
|
||||
expect(content).toMatch(/name:\s*global_str[\s\S]*?value:\s*hello/);
|
||||
expect(content).not.toMatch(/name:\s*global_str[\s\S]*?type:\s*string/);
|
||||
});
|
||||
} finally {
|
||||
await closeElectronApp(firstApp);
|
||||
}
|
||||
|
||||
const contentBeforeRestart = fs.readFileSync(envFilePath, 'utf8');
|
||||
|
||||
const secondApp = await launchElectronApp({
|
||||
initUserDataPath,
|
||||
userDataPath,
|
||||
templateVars: { workspacePath }
|
||||
});
|
||||
try {
|
||||
const page = await waitForReadyPage(secondApp);
|
||||
|
||||
await test.step('Second launch: Local.yml on disk is byte-identical to pre-restart', () => {
|
||||
expect(fs.readFileSync(envFilePath, 'utf8')).toBe(contentBeforeRestart);
|
||||
});
|
||||
|
||||
await test.step('Second launch: the global env editor reflects the persisted dataTypes', async () => {
|
||||
await waitForCollectionMount(page, 'Test Collection');
|
||||
await openCollection(page, 'Test Collection');
|
||||
await selectEnvironment(page, 'Local', 'global');
|
||||
|
||||
// Open the Global Environments config tab via the env selector → configure button.
|
||||
const locators = buildCommonLocators(page);
|
||||
await locators.environment.selector().click();
|
||||
await locators.environment.globalTab().click();
|
||||
await locators.environment.configureButton().waitFor({ state: 'visible' });
|
||||
await locators.environment.configureButton().dispatchEvent('click');
|
||||
await expect(locators.environment.globalEnvTab()).toBeVisible();
|
||||
|
||||
const numRow = locators.environment.variableRowByName('global_num');
|
||||
const boolRow = locators.environment.variableRowByName('global_bool');
|
||||
const objRow = locators.environment.variableRowByName('global_obj');
|
||||
const strRow = locators.environment.variableRowByName('global_str');
|
||||
|
||||
await expect(numRow).toBeVisible();
|
||||
await expect(locators.dataTypeSelector.typeLabel(numRow)).toHaveText('number', { timeout: 5000 });
|
||||
await expect(locators.dataTypeSelector.typeLabel(boolRow)).toHaveText('boolean');
|
||||
await expect(locators.dataTypeSelector.typeLabel(objRow)).toHaveText('object');
|
||||
await expect(locators.dataTypeSelector.typeLabel(strRow)).toHaveText('string');
|
||||
});
|
||||
} finally {
|
||||
await closeElectronApp(secondApp);
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"version": "1",
|
||||
"name": "Test Collection",
|
||||
"type": "collection",
|
||||
"ignore": [
|
||||
"node_modules",
|
||||
".git"
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
meta {
|
||||
name: read-global-var
|
||||
type: http
|
||||
seq: 2
|
||||
}
|
||||
|
||||
get {
|
||||
url: {{baseUrl}}/query?token={{globalToken}}
|
||||
body: none
|
||||
auth: none
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
meta {
|
||||
name: set-global-var
|
||||
type: http
|
||||
seq: 1
|
||||
}
|
||||
|
||||
get {
|
||||
url: {{baseUrl}}/ping
|
||||
body: none
|
||||
auth: none
|
||||
}
|
||||
|
||||
script:post-response {
|
||||
bru.setGlobalEnvVar("globalToken", "VALUE_global_nonsecret_e2e_42");
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
meta {
|
||||
name: set-typed-global-vars
|
||||
type: http
|
||||
seq: 2
|
||||
}
|
||||
|
||||
get {
|
||||
url: {{baseUrl}}/ping
|
||||
body: none
|
||||
auth: none
|
||||
}
|
||||
|
||||
script:post-response {
|
||||
// Typed values persist with their dataType annotation in Local.yml's variables list.
|
||||
bru.setGlobalEnvVar("global_num", 42);
|
||||
bru.setGlobalEnvVar("global_bool", true);
|
||||
bru.setGlobalEnvVar("global_obj", { scope: "global" });
|
||||
// Plain string — no dataType materialized.
|
||||
bru.setGlobalEnvVar("global_str", "hello");
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
name: Local
|
||||
variables:
|
||||
- name: baseUrl
|
||||
value: http://localhost:8081
|
||||
enabled: true
|
||||
secret: false
|
||||
- name: globalToken
|
||||
value: ""
|
||||
enabled: true
|
||||
secret: false
|
||||
@@ -0,0 +1,12 @@
|
||||
opencollection: 1.0.0
|
||||
info:
|
||||
name: "My Workspace"
|
||||
type: workspace
|
||||
|
||||
collections:
|
||||
- name: "Test Collection"
|
||||
path: "collections/test-collection"
|
||||
|
||||
specs:
|
||||
|
||||
docs: ''
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"collections": [
|
||||
{
|
||||
"path": "{{workspacePath}}/collections/test-collection",
|
||||
"securityConfig": {
|
||||
"jsSandboxMode": "safe"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"preferences": {
|
||||
"general": {
|
||||
"defaultWorkspacePath": "{{workspacePath}}"
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user