mirror of
https://github.com/usebruno/bruno.git
synced 2026-06-11 09:51:30 +00:00
* feat: introduce HeaderList for dynamic header management in BrunoRequest and BrunoResponse - Implemented HeaderList to provide a dynamic API for managing request headers, allowing real-time reflection of changes. - Updated BrunoRequest and BrunoResponse to utilize HeaderList for header access, enhancing consistency and usability. - Added a headers proxy to maintain backward compatibility with existing header access patterns. - Introduced tests for HeaderList to ensure functionality and reliability across various header operations. * refactor: update createHeadersProxy to accept a getter function for raw headers - Modified createHeadersProxy to allow passing a function that retrieves raw headers, enhancing flexibility in header management. - Updated HeaderList to utilize the new getter function, ensuring consistent behavior when headers are modified. - Added a test to verify that bracket access reflects changes made via BrunoRequest.setHeaders. * refactor: enhance headers proxy and syncWriteMethods for improved header management - Updated createHeadersProxy to clarify precedence of PropertyList methods over header names in bracket access. - Expanded syncWriteMethods in bruno-request shim to include additional methods for better header manipulation. - Implemented a custom remove method in property-list-bridge to handle function predicates in-VM, improving the native bridge's functionality. * refactor: update header management in BrunoRequest and BrunoResponse - Renamed `req.headers` to `req.headerList` for improved clarity and consistency in header operations. - Enhanced `HeaderList` to support both dynamic and static modes for header management. - Updated shims for `req` and `res` to reflect the new header access patterns. - Modified tests to validate the new header access methods and ensure backward compatibility with raw headers. * refactor: enhance header translation methods for BrunoRequest and BrunoResponse - Added comprehensive translations for `req.headerList` and `res.headerList` methods to their respective Postman equivalents, improving consistency in header management. - Updated tests to validate the new translation methods, ensuring accurate conversion between Bruno and Postman header operations. - Enhanced existing tests to cover additional header manipulation scenarios, reinforcing the reliability of the header management system. * refactor: streamline headerList implementation in BrunoRequest and BrunoResponse - Replaced lazy initialization of `headerList` with direct instantiation in both classes for improved performance and clarity. - Removed redundant getter methods for `headerList`, simplifying the API. - Updated tests to reflect changes in headerList instantiation and ensure proper functionality. * refactor: remove header proxy * feat: add comprehensive headerList tests for request and response - Introduced multiple test files for `req.headerList` and `res.headerList` methods, covering various operations such as add, remove, clear, populate, and search methods. - Implemented tests for both dynamic and read-only scenarios, ensuring robust validation of header management functionalities. - Enhanced existing headerList methods with detailed assertions to improve reliability and maintainability of the header management system. * feat: expand STATIC_API_HINTS with additional headerList methods for req and res - Added a comprehensive list of methods for `req.headerList` and `res.headerList` to enhance autocomplete functionality. - Included various operations such as get, add, remove, and manipulation methods to improve developer experience and usability. * feat: implement support for disabled headers in headerList - Added functionality to track disabled headers in `req.headerList` and `res.headerList`, allowing for better management of header states. - Updated the `prepareRequest` and `prepareGrpcRequest` functions to include a `disabledHeaders` property. - Enhanced the `HeaderList` class to handle disabled headers, including methods to filter, count, and retrieve them. - Introduced tests to validate the behavior of disabled headers, ensuring they are correctly included in the header list while being excluded from raw headers. * feat: enhance HeaderList with case-insensitive key lookups and improved toObject method - Implemented case-insensitive key lookups for methods such as get, one, has, and indexOf in HeaderList. - Updated toObject method to support options for excluding disabled headers, handling duplicate keys, and skipping headers with falsy keys. - Modified toString method to return headers in HTTP wire format, improving consistency with standard practices. - Added comprehensive tests to validate new functionalities, ensuring robust header management and accurate behavior for both enabled and disabled headers. * feat: add context binding to iteration methods in HeaderList - Enhanced iteration methods (each, filter, find, map, reduce) in HeaderList to accept an optional context parameter, allowing for better control over the `this` binding in callback functions. - Updated the remove method to support context binding for function predicates. - Added comprehensive tests to validate the new context binding functionality across various iteration methods, ensuring robust header management. * feat: enhance HeaderList with new methods for string handling and object support - Added support for accepting an object with a key property in the `has` method, improving header existence checks. - Updated `add` and `populate` methods to accept "Key: Value" strings and multi-line header strings, enhancing flexibility in header management. - Modified `toString` method to ensure a trailing newline in the output, aligning with HTTP wire format standards. - Introduced comprehensive tests to validate new functionalities, ensuring robust header management and accurate behavior for various input types. * feat: enhance header management with support for disabled headers and context binding - Updated `mergeHeaders` function to preserve disabled headers from the request item, improving header state management. - Modified `addBrunoRequestShimToContext` and `addBrunoResponseShimToContext` to wrap eval code in blocks, preventing redeclaration conflicts. - Enhanced iteration methods in `property-list-bridge` to support context binding, allowing for better control over `this` in callbacks. - Added comprehensive tests for `req.headerList` and `res.headerList` to validate new functionalities and ensure robust header management. * feat: improve header merging to preserve disabled headers from request items - Enhanced the `mergeHeaders` function to retain disabled headers from the last entry in the request tree path, ensuring better management of header states. - Updated the logic to include disabled headers while merging, improving the overall functionality of header management. * feat: update header merging logic to consistently handle disabled headers - Refactored the `mergeHeaders` function to utilize a separate array for disabled headers, ensuring they are preserved during the merging process. - Simplified the logic for merging headers by directly combining enabled and disabled headers into the request object, enhancing clarity and maintainability. * refactor: update disabled headers handling in mergeHeaders function - Changed the implementation of disabled headers from an array to a Map for better performance and consistency. - Updated the logic in the `mergeHeaders` function to ensure disabled headers are correctly merged into the request object. - Enhanced tests to validate the handling of disabled headers, including new scenarios for folder-level and request-level overrides. * feat: enhance mergeHeaders function to support optional inclusion of disabled headers - Updated the `mergeHeaders` function to accept an options parameter, allowing for the inclusion of disabled headers in the merged result. - Modified the logic to handle disabled headers more effectively, ensuring they can be returned based on the provided options. - Adjusted calls to `mergeHeaders` in various modules to utilize the new functionality, improving header management consistency across the application. * refactor: remove disabledHeaders from prepareGrpcRequest function - Eliminated the handling of disabledHeaders in the prepareGrpcRequest function to streamline header management. - Updated the headers processing logic to focus solely on enabled headers, enhancing clarity and reducing complexity. * feat: add translations for req.headerList and res.headerList methods - Introduced new tests to translate methods from req.headerList and res.headerList to their corresponding pm.request.headers and pm.response.headers methods. - Added translations for methods: one, find, toObject, and upsert, enhancing the functionality of the header management system. * docs: update HeaderList method aliases and add clarification notes - Enhanced documentation for `prepend`, `append`, `insert`, and `insertAfter` methods to clarify that they are aliases for `add()` and include a note on the lack of support for ordering and duplicates. - Updated method comments to reflect the internal handling of headers as a plain object, ensuring better understanding of header management behavior. * fix: remove duplicate headerList initialization in BrunoRequest class - Eliminated redundant initialization of headerList in the BrunoRequest constructor, ensuring cleaner code and preventing potential issues with header management. - This change simplifies the constructor logic while maintaining the intended functionality of the headerList. * refactor: remove unimplemented headerList methods and update documentation - Removed the unimplemented methods `prepend`, `append`, `insert`, and `insertAfter` from the headerList, ensuring clarity in the API. - Updated documentation to reflect that these methods are not implemented and provide guidance to use `add()` or `upsert()` instead. - Adjusted tests to verify that calls to these methods throw appropriate not-implemented errors, enhancing the robustness of header management. * refactor: remove unused headerList append method from pre-request script - Eliminated the call to `req.headerList.append()` in the pre-request script, streamlining the header management process. - This change aligns with the recent refactor to remove unimplemented methods, ensuring clarity and consistency in the API usage. * test: update error messages for unimplemented headerList methods - Changed error messages in tests for `append`, `prepend`, `insert`, and `insertAfter` methods to indicate they are "not yet implemented" instead of "not implemented". - This update improves clarity in the test outputs, aligning with the current state of the headerList API. * refactor: remove unimplemented headerList methods and update related tests - Eliminated the unimplemented methods `prepend`, `append`, `insert`, and `insertAfter` from the HeaderList class and corresponding tests, clarifying the API usage. - Updated the documentation to guide users towards using `add()` or `upsert()` instead. - Adjusted tests to remove references to these methods, ensuring they accurately reflect the current state of the headerList API. * refactor: update HeaderList to accept raw request and response objects - Modified the HeaderList class to accept the raw request and response objects directly, simplifying the initialization process. - Updated the BrunoRequest and BrunoResponse classes to reflect this change, ensuring consistent handling of headers. - Enhanced internal methods to utilize the new structure, improving clarity and maintainability of the header management system. * refactor: enhance HeaderList header management and update tests - Updated HeaderList to track removed headers for axios interceptor, improving header casing handling. - Added new syncWriteMethods to the BrunoResponse shim for better integration. - Enhanced tests to verify the correct tracking of deleted headers and updated expectations for header management functionality. * refactor: update header translations and improve HeaderList methods - Removed unused 'idx' translations from both bruno-to-postman and postman-to-bruno translators to streamline header management. - Enhanced the HeaderList class to skip existing keys when populating headers, ensuring that current values are preserved. - Updated tests to reflect the new behavior of the populate method, verifying that existing headers are not overwritten and adjusting expectations accordingly. * refactor: update headerList.populate behavior and adjust tests - Modified the req.headerList.populate method to add new headers while preserving existing ones, ensuring that current values are not overwritten. - Updated the associated test to reflect this new behavior, verifying that existing headers remain intact and new headers are correctly added. * refactor: update HeaderList methods and translations for consistency - Renamed `each` method to `forEach` in HeaderList for consistency with standard JavaScript array methods. - Updated header management methods: replaced `add` with `append`, `upsert` with `set`, and `remove` with `delete` to better reflect their functionality. - Enhanced translations in bruno-to-postman and postman-to-bruno converters to align with the new method names. - Adjusted tests to verify the new method names and ensure correct header management behavior. * refactor: remove unused headerList methods and update related shims - Removed the `entries`, `keys`, and `values` methods from the HeaderList class to streamline the API and eliminate unused functionality. - Updated the `bruno-request` and `bruno-response` shims to reflect the removal of these methods, ensuring consistency in header management. - Adjusted tests to remove references to the deleted methods, maintaining alignment with the current state of the headerList API. * fix: ensure re-added headers are removed from __headersToDelete - Updated the HeaderList class to remove headers from the __headersToDelete array when they are re-added, preventing incorrect header deletion behavior. - Added tests to verify that re-added headers do not remain in __headersToDelete and that their values are correctly set in the raw request headers.
205 lines
6.9 KiB
JavaScript
205 lines
6.9 KiB
JavaScript
const { marshallToVm } = require('../utils');
|
|
const { createPropertyListBridge } = require('../utils/property-list-bridge');
|
|
|
|
const addBrunoRequestShimToContext = (vm, req) => {
|
|
const reqObject = vm.newObject();
|
|
|
|
const url = marshallToVm(req.getUrl(), vm);
|
|
const method = marshallToVm(req.getMethod(), vm);
|
|
const body = marshallToVm(req.getBody(), vm);
|
|
const timeout = marshallToVm(req.getTimeout(), vm);
|
|
const name = marshallToVm(req.getName(), vm);
|
|
const pathParams = marshallToVm(req.getPathParams(), vm);
|
|
const tags = marshallToVm(req.getTags(), vm);
|
|
|
|
vm.setProp(reqObject, 'url', url);
|
|
vm.setProp(reqObject, 'method', method);
|
|
vm.setProp(reqObject, 'body', body);
|
|
vm.setProp(reqObject, 'timeout', timeout);
|
|
vm.setProp(reqObject, 'name', name);
|
|
vm.setProp(reqObject, 'pathParams', pathParams);
|
|
vm.setProp(reqObject, 'tags', tags);
|
|
|
|
url.dispose();
|
|
method.dispose();
|
|
body.dispose();
|
|
timeout.dispose();
|
|
name.dispose();
|
|
pathParams.dispose();
|
|
tags.dispose();
|
|
|
|
// req.headers — plain headers object for backward-compatible bracket access
|
|
const headersVal = marshallToVm(req.getHeaders(), vm);
|
|
vm.setProp(reqObject, 'headers', headersVal);
|
|
headersVal.dispose();
|
|
|
|
// req.headerList — PropertyList bridge for structured header operations
|
|
const headerListObj = vm.newObject();
|
|
const { evalCode: headersEvalCode } = createPropertyListBridge(vm, req.headerList, headerListObj, {
|
|
globalPath: 'globalThis.req.headerList',
|
|
syncReadMethods: ['get', 'has', 'count', 'indexOf', 'toObject', 'toString'],
|
|
syncReadObjectMethods: ['one', 'all', 'idx', 'toJSON'],
|
|
syncWriteMethods: ['append', 'set', 'delete', 'clear', 'populate', 'repopulate', 'assimilate'],
|
|
withIterators: true
|
|
});
|
|
vm.setProp(reqObject, 'headerList', headerListObj);
|
|
headerListObj.dispose();
|
|
|
|
let getUrl = vm.newFunction('getUrl', function () {
|
|
return marshallToVm(req.getUrl(), vm);
|
|
});
|
|
vm.setProp(reqObject, 'getUrl', getUrl);
|
|
getUrl.dispose();
|
|
|
|
let setUrl = vm.newFunction('setUrl', function (url) {
|
|
req.setUrl(vm.dump(url));
|
|
});
|
|
vm.setProp(reqObject, 'setUrl', setUrl);
|
|
setUrl.dispose();
|
|
|
|
let getHost = vm.newFunction('getHost', function () {
|
|
return marshallToVm(req.getHost(), vm);
|
|
});
|
|
vm.setProp(reqObject, 'getHost', getHost);
|
|
getHost.dispose();
|
|
|
|
let getPath = vm.newFunction('getPath', function () {
|
|
return marshallToVm(req.getPath(), vm);
|
|
});
|
|
vm.setProp(reqObject, 'getPath', getPath);
|
|
getPath.dispose();
|
|
|
|
let getQueryString = vm.newFunction('getQueryString', function () {
|
|
return marshallToVm(req.getQueryString(), vm);
|
|
});
|
|
vm.setProp(reqObject, 'getQueryString', getQueryString);
|
|
getQueryString.dispose();
|
|
|
|
let getMethod = vm.newFunction('getMethod', function () {
|
|
return marshallToVm(req.getMethod(), vm);
|
|
});
|
|
vm.setProp(reqObject, 'getMethod', getMethod);
|
|
getMethod.dispose();
|
|
|
|
let getAuthMode = vm.newFunction('getAuthMode', function () {
|
|
return marshallToVm(req.getAuthMode(), vm);
|
|
});
|
|
vm.setProp(reqObject, 'getAuthMode', getAuthMode);
|
|
getAuthMode.dispose();
|
|
|
|
let getName = vm.newFunction('getName', function () {
|
|
return marshallToVm(req.getName(), vm);
|
|
});
|
|
vm.setProp(reqObject, 'getName', getName);
|
|
getName.dispose();
|
|
|
|
let getPathParams = vm.newFunction('getPathParams', function () {
|
|
return marshallToVm(req.getPathParams(), vm);
|
|
});
|
|
vm.setProp(reqObject, 'getPathParams', getPathParams);
|
|
getPathParams.dispose();
|
|
|
|
let setMethod = vm.newFunction('setMethod', function (method) {
|
|
req.setMethod(vm.dump(method));
|
|
});
|
|
vm.setProp(reqObject, 'setMethod', setMethod);
|
|
setMethod.dispose();
|
|
|
|
let getHeaders = vm.newFunction('getHeaders', function () {
|
|
return marshallToVm(req.getHeaders(), vm);
|
|
});
|
|
vm.setProp(reqObject, 'getHeaders', getHeaders);
|
|
getHeaders.dispose();
|
|
|
|
let setHeaders = vm.newFunction('setHeaders', function (headers) {
|
|
req.setHeaders(vm.dump(headers));
|
|
});
|
|
vm.setProp(reqObject, 'setHeaders', setHeaders);
|
|
setHeaders.dispose();
|
|
|
|
let deleteHeaders = vm.newFunction('deleteHeaders', function (headers) {
|
|
req.deleteHeaders(vm.dump(headers));
|
|
});
|
|
vm.setProp(reqObject, 'deleteHeaders', deleteHeaders);
|
|
deleteHeaders.dispose();
|
|
|
|
let getHeader = vm.newFunction('getHeader', function (name) {
|
|
return marshallToVm(req.getHeader(vm.dump(name)), vm);
|
|
});
|
|
vm.setProp(reqObject, 'getHeader', getHeader);
|
|
getHeader.dispose();
|
|
|
|
let setHeader = vm.newFunction('setHeader', function (name, value) {
|
|
req.setHeader(vm.dump(name), vm.dump(value));
|
|
});
|
|
vm.setProp(reqObject, 'setHeader', setHeader);
|
|
setHeader.dispose();
|
|
|
|
let deleteHeader = vm.newFunction('deleteHeader', function (header) {
|
|
req.deleteHeader(vm.dump(header));
|
|
});
|
|
vm.setProp(reqObject, 'deleteHeader', deleteHeader);
|
|
deleteHeader.dispose();
|
|
|
|
let getBody = vm.newFunction('getBody', function (options = {}) {
|
|
return marshallToVm(req.getBody(vm.dump(options)), vm);
|
|
});
|
|
|
|
vm.setProp(reqObject, 'getBody', getBody);
|
|
getBody.dispose();
|
|
|
|
let setBody = vm.newFunction('setBody', function (data, options = {}) {
|
|
req.setBody(vm.dump(data), vm.dump(options));
|
|
});
|
|
vm.setProp(reqObject, 'setBody', setBody);
|
|
setBody.dispose();
|
|
|
|
let setMaxRedirects = vm.newFunction('setMaxRedirects', function (maxRedirects) {
|
|
req.setMaxRedirects(vm.dump(maxRedirects));
|
|
});
|
|
vm.setProp(reqObject, 'setMaxRedirects', setMaxRedirects);
|
|
setMaxRedirects.dispose();
|
|
|
|
let getTimeout = vm.newFunction('getTimeout', function () {
|
|
return marshallToVm(req.getTimeout(), vm);
|
|
});
|
|
vm.setProp(reqObject, 'getTimeout', getTimeout);
|
|
getTimeout.dispose();
|
|
|
|
let setTimeout = vm.newFunction('setTimeout', function (timeout) {
|
|
req.setTimeout(vm.dump(timeout));
|
|
});
|
|
vm.setProp(reqObject, 'setTimeout', setTimeout);
|
|
setTimeout.dispose();
|
|
|
|
let disableParsingResponseJson = vm.newFunction('disableParsingResponseJson', function () {
|
|
req.disableParsingResponseJson();
|
|
});
|
|
vm.setProp(reqObject, 'disableParsingResponseJson', disableParsingResponseJson);
|
|
disableParsingResponseJson.dispose();
|
|
|
|
let getExecutionMode = vm.newFunction('getExecutionMode', function () {
|
|
return marshallToVm(req.getExecutionMode(), vm);
|
|
});
|
|
vm.setProp(reqObject, 'getExecutionMode', getExecutionMode);
|
|
getExecutionMode.dispose();
|
|
|
|
let getTags = vm.newFunction('getTags', function () {
|
|
return marshallToVm(req.getTags(), vm);
|
|
});
|
|
vm.setProp(reqObject, 'getTags', getTags);
|
|
getTags.dispose();
|
|
|
|
vm.setProp(vm.global, 'req', reqObject);
|
|
reqObject.dispose();
|
|
|
|
// Evaluate iterator code after req is on global (iterators reference globalThis.req.headerList)
|
|
// Wrapped in a block to avoid const redeclaration conflicts with other evalCode blocks
|
|
// The bridge generates `each` (shared with CookieList); alias `forEach` for HeaderList's MDN-style API
|
|
if (headersEvalCode) {
|
|
vm.evalCode(`{ ${headersEvalCode} globalThis.req.headerList.forEach = globalThis.req.headerList.each; }`);
|
|
}
|
|
};
|
|
|
|
module.exports = addBrunoRequestShimToContext;
|