mirror of
https://github.com/usebruno/bruno.git
synced 2026-07-01 16:44:16 +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
@@ -4,7 +4,6 @@ const BRUNO_API_REFERENCE = `## Bruno API Reference
|
||||
\`\`\`js
|
||||
bru.getEnvVar(key)
|
||||
bru.setEnvVar(key, value)
|
||||
bru.setEnvVar(key, value, { persist: true })
|
||||
bru.hasEnvVar(key)
|
||||
bru.deleteEnvVar(key)
|
||||
bru.getEnvName()
|
||||
|
||||
@@ -506,7 +506,10 @@ const registerRendererEventHandlers = (mainWindow, watcher) => {
|
||||
const filename = format === 'yml' ? 'opencollection.yml' : 'collection.bru';
|
||||
const content = await stringifyCollection(collectionRoot, brunoConfig, { format });
|
||||
|
||||
await writeFile(path.join(collectionPathname, filename), content);
|
||||
const filePath = path.join(collectionPathname, filename);
|
||||
const existing = fs.existsSync(filePath) ? fs.readFileSync(filePath, 'utf8') : null;
|
||||
if (content === existing) return; // skip write if content unchanged
|
||||
await writeFile(filePath, content);
|
||||
} catch (error) {
|
||||
console.error('Error in save-collection-root:', error);
|
||||
return Promise.reject(error);
|
||||
@@ -766,6 +769,8 @@ const registerRendererEventHandlers = (mainWindow, watcher) => {
|
||||
}
|
||||
|
||||
const content = await stringifyEnvironment(environment, { format });
|
||||
const existing = fs.readFileSync(envFilePath, 'utf8');
|
||||
if (content === existing) return; // skip write if content unchanged
|
||||
await writeFile(envFilePath, content);
|
||||
} catch (error) {
|
||||
return Promise.reject(error);
|
||||
|
||||
@@ -508,6 +508,41 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
};
|
||||
};
|
||||
|
||||
const sendVariableUpdates = (result, { collectionUid, requestUid, collection }) => {
|
||||
if (result.runtimeVariables) {
|
||||
mainWindow.webContents.send('main:runtime-variables-update', {
|
||||
runtimeVariables: result.runtimeVariables,
|
||||
requestUid,
|
||||
collectionUid
|
||||
});
|
||||
}
|
||||
|
||||
if (result.envVariables) {
|
||||
mainWindow.webContents.send('main:script-environment-update', {
|
||||
envVariables: result.envVariables,
|
||||
requestUid,
|
||||
collectionUid
|
||||
});
|
||||
}
|
||||
|
||||
if (result.globalEnvironmentVariables) {
|
||||
mainWindow.webContents.send('main:global-environment-variables-update', {
|
||||
globalEnvironmentVariables: result.globalEnvironmentVariables,
|
||||
requestUid,
|
||||
collectionUid
|
||||
});
|
||||
collection.globalEnvironmentVariables = result.globalEnvironmentVariables;
|
||||
}
|
||||
|
||||
if (result.collectionVariables) {
|
||||
mainWindow.webContents.send('main:collection-variables-update', {
|
||||
collectionVariables: result.collectionVariables,
|
||||
requestUid,
|
||||
collectionUid
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
const resetOauth2Credentials = ({ oauth2CredentialsToReset, request, collectionUid }) => {
|
||||
if (!oauth2CredentialsToReset?.length) return;
|
||||
for (const credentialId of oauth2CredentialsToReset) {
|
||||
@@ -559,25 +594,7 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
collectionName
|
||||
);
|
||||
|
||||
mainWindow.webContents.send('main:script-environment-update', {
|
||||
envVariables: scriptResult.envVariables,
|
||||
runtimeVariables: scriptResult.runtimeVariables,
|
||||
persistentEnvVariables: scriptResult.persistentEnvVariables,
|
||||
requestUid,
|
||||
collectionUid
|
||||
});
|
||||
|
||||
mainWindow.webContents.send('main:persistent-env-variables-update', {
|
||||
persistentEnvVariables: scriptResult.persistentEnvVariables,
|
||||
collectionUid
|
||||
});
|
||||
|
||||
mainWindow.webContents.send('main:global-environment-variables-update', {
|
||||
globalEnvironmentVariables: scriptResult.globalEnvironmentVariables
|
||||
});
|
||||
|
||||
collection.globalEnvironmentVariables = scriptResult.globalEnvironmentVariables;
|
||||
|
||||
sendVariableUpdates(scriptResult, { collectionUid, requestUid, collection });
|
||||
resetOauth2Credentials({ oauth2CredentialsToReset: scriptResult.oauth2CredentialsToReset, request, collectionUid });
|
||||
|
||||
const domainsWithCookies = await getDomainsWithCookies();
|
||||
@@ -669,24 +686,7 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
);
|
||||
|
||||
if (result) {
|
||||
mainWindow.webContents.send('main:script-environment-update', {
|
||||
envVariables: result.envVariables,
|
||||
runtimeVariables: result.runtimeVariables,
|
||||
persistentEnvVariables: result.persistentEnvVariables,
|
||||
requestUid,
|
||||
collectionUid
|
||||
});
|
||||
|
||||
mainWindow.webContents.send('main:persistent-env-variables-update', {
|
||||
persistentEnvVariables: result.persistentEnvVariables,
|
||||
collectionUid
|
||||
});
|
||||
|
||||
mainWindow.webContents.send('main:global-environment-variables-update', {
|
||||
globalEnvironmentVariables: result.globalEnvironmentVariables
|
||||
});
|
||||
|
||||
collection.globalEnvironmentVariables = result.globalEnvironmentVariables;
|
||||
sendVariableUpdates(result, { collectionUid, requestUid, collection });
|
||||
}
|
||||
|
||||
if (result?.error) {
|
||||
@@ -714,25 +714,7 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
collectionName
|
||||
);
|
||||
|
||||
mainWindow.webContents.send('main:script-environment-update', {
|
||||
envVariables: scriptResult.envVariables,
|
||||
runtimeVariables: scriptResult.runtimeVariables,
|
||||
persistentEnvVariables: scriptResult.persistentEnvVariables,
|
||||
requestUid,
|
||||
collectionUid
|
||||
});
|
||||
|
||||
mainWindow.webContents.send('main:persistent-env-variables-update', {
|
||||
persistentEnvVariables: scriptResult.persistentEnvVariables,
|
||||
collectionUid
|
||||
});
|
||||
|
||||
mainWindow.webContents.send('main:global-environment-variables-update', {
|
||||
globalEnvironmentVariables: scriptResult.globalEnvironmentVariables
|
||||
});
|
||||
|
||||
collection.globalEnvironmentVariables = scriptResult.globalEnvironmentVariables;
|
||||
|
||||
sendVariableUpdates(scriptResult, { collectionUid, requestUid, collection });
|
||||
resetOauth2Credentials({ oauth2CredentialsToReset: scriptResult.oauth2CredentialsToReset, request, collectionUid });
|
||||
|
||||
const domainsWithCookiesPost = await getDomainsWithCookies();
|
||||
@@ -741,12 +723,13 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
return scriptResult;
|
||||
};
|
||||
|
||||
const runRequest = async ({ item, collection, envVars, processEnvVars, runtimeVariables, runInBackground = false, callerBru = null, parentExecutionMode = null, parentRunnerEventData = null }) => {
|
||||
const runRequest = async ({ item, collection, envVars, processEnvVars, runtimeVariables, runInBackground = false, callerBru = null, parentExecutionMode = null, parentRunnerEventData = null, parentRequestUid = null }) => {
|
||||
const collectionUid = collection.uid;
|
||||
const collectionPath = collection.pathname;
|
||||
const cancelTokenUid = uuid();
|
||||
// Nested bru.runRequest() invocations have no item.requestUid; mint one.
|
||||
const requestUid = item.requestUid || uuid();
|
||||
// Nested bru.runRequest() invocations have no item.requestUid; inherit the parent's
|
||||
// so script-driven variable updates aren't dropped by the renderer's requestUid gate.
|
||||
const requestUid = item.requestUid || parentRequestUid || uuid();
|
||||
|
||||
const runRequestByItemPathname = async (relativeItemPathname, callerBru) => {
|
||||
return new Promise(async (resolve, reject) => {
|
||||
@@ -797,7 +780,7 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
const startedAt = Date.now();
|
||||
let res, err;
|
||||
try {
|
||||
res = await runRequest({ item: _item, collection, envVars, processEnvVars, runtimeVariables, runInBackground: true, callerBru, parentExecutionMode, parentRunnerEventData });
|
||||
res = await runRequest({ item: _item, collection, envVars, processEnvVars, runtimeVariables, runInBackground: true, callerBru, parentExecutionMode, parentRunnerEventData, parentRequestUid: requestUid });
|
||||
} catch (e) {
|
||||
err = e;
|
||||
}
|
||||
@@ -929,6 +912,9 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
|
||||
if (preRequestError?.partialResults) {
|
||||
preRequestScriptResult = preRequestError.partialResults;
|
||||
// Forward any variable mutations the script made before throwing so the UI
|
||||
// and disk stay in sync with the partial test results we're about to render.
|
||||
sendVariableUpdates(preRequestScriptResult, { collectionUid, requestUid, collection });
|
||||
}
|
||||
|
||||
emitScriptedRequestEvents('pre-request', preRequestScriptResult);
|
||||
@@ -1127,6 +1113,8 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
// (e.g., if 2 tests pass then script throws, we still want to show those 2 passing tests)
|
||||
if (postResponseError?.partialResults) {
|
||||
postResponseScriptResult = postResponseError.partialResults;
|
||||
// Forward any variable mutations the script made before throwing.
|
||||
sendVariableUpdates(postResponseScriptResult, { collectionUid, requestUid, collection });
|
||||
}
|
||||
|
||||
emitScriptedRequestEvents('post-response', postResponseScriptResult);
|
||||
@@ -1221,24 +1209,7 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
collectionUid
|
||||
});
|
||||
|
||||
mainWindow.webContents.send('main:script-environment-update', {
|
||||
envVariables: testResults.envVariables,
|
||||
runtimeVariables: testResults.runtimeVariables,
|
||||
requestUid,
|
||||
collectionUid
|
||||
});
|
||||
|
||||
mainWindow.webContents.send('main:persistent-env-variables-update', {
|
||||
persistentEnvVariables: testResults.persistentEnvVariables,
|
||||
collectionUid
|
||||
});
|
||||
|
||||
mainWindow.webContents.send('main:global-environment-variables-update', {
|
||||
globalEnvironmentVariables: testResults.globalEnvironmentVariables
|
||||
});
|
||||
|
||||
collection.globalEnvironmentVariables = testResults.globalEnvironmentVariables;
|
||||
|
||||
sendVariableUpdates(testResults, { collectionUid, requestUid, collection });
|
||||
resetOauth2Credentials({ oauth2CredentialsToReset: testResults.oauth2CredentialsToReset, request, collectionUid });
|
||||
|
||||
!runInBackground && notifyScriptExecution({
|
||||
@@ -1643,8 +1614,11 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
let timeStart;
|
||||
let timeEnd;
|
||||
|
||||
const requestUid = uuid();
|
||||
|
||||
mainWindow.webContents.send('main:run-folder-event', {
|
||||
type: 'request-queued',
|
||||
requestUid,
|
||||
...eventData
|
||||
});
|
||||
|
||||
@@ -1669,8 +1643,6 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
const request = await prepareRequest(item, collection, abortController);
|
||||
request.__bruno__executionMode = 'runner';
|
||||
|
||||
const requestUid = uuid();
|
||||
|
||||
const promptVars = await extractPromptVariablesForRequest({ request, collection, envVars, runtimeVariables, processEnvVars });
|
||||
|
||||
if (promptVars.length > 0) {
|
||||
@@ -1729,6 +1701,7 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
|
||||
if (preRequestError?.partialResults) {
|
||||
preRequestScriptResult = preRequestError.partialResults;
|
||||
sendVariableUpdates(preRequestScriptResult, { collectionUid, requestUid, collection });
|
||||
}
|
||||
|
||||
preRequestScriptResult = appendScriptErrorResult('pre-request', preRequestScriptResult, preRequestError);
|
||||
@@ -1987,6 +1960,7 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
// (e.g., if 2 tests pass then script throws, we still want to show those 2 passing tests)
|
||||
if (postResponseError?.partialResults) {
|
||||
postResponseScriptResult = postResponseError.partialResults;
|
||||
sendVariableUpdates(postResponseScriptResult, { collectionUid, requestUid, collection });
|
||||
}
|
||||
|
||||
postResponseScriptResult = appendScriptErrorResult('post-response', postResponseScriptResult, postResponseError);
|
||||
@@ -2094,18 +2068,7 @@ const registerNetworkIpc = (mainWindow) => {
|
||||
...eventData
|
||||
});
|
||||
|
||||
mainWindow.webContents.send('main:script-environment-update', {
|
||||
envVariables: testResults.envVariables,
|
||||
runtimeVariables: testResults.runtimeVariables,
|
||||
collectionUid
|
||||
});
|
||||
|
||||
mainWindow.webContents.send('main:global-environment-variables-update', {
|
||||
globalEnvironmentVariables: testResults.globalEnvironmentVariables
|
||||
});
|
||||
|
||||
collection.globalEnvironmentVariables = testResults.globalEnvironmentVariables;
|
||||
|
||||
sendVariableUpdates(testResults, { collectionUid, requestUid, collection });
|
||||
resetOauth2Credentials({ oauth2CredentialsToReset: testResults.oauth2CredentialsToReset, request, collectionUid });
|
||||
|
||||
notifyScriptExecution({
|
||||
|
||||
Reference in New Issue
Block a user