+
{
collection={collection}
isSecret={true}
/>
+ {showWarning &&
);
diff --git a/packages/bruno-app/src/components/CollectionSettings/Auth/NTLMAuth/index.js b/packages/bruno-app/src/components/CollectionSettings/Auth/NTLMAuth/index.js
index 341c805dc..38a9c18f0 100644
--- a/packages/bruno-app/src/components/CollectionSettings/Auth/NTLMAuth/index.js
+++ b/packages/bruno-app/src/components/CollectionSettings/Auth/NTLMAuth/index.js
@@ -1,4 +1,6 @@
import React from 'react';
+import SensitiveFieldWarning from 'components/SensitiveFieldWarning';
+import { useDetectSensitiveField } from 'hooks/useDetectSensitiveField';
import get from 'lodash/get';
import { useTheme } from 'providers/Theme';
import { useDispatch } from 'react-redux';
@@ -18,6 +20,8 @@ const NTLMAuth = ({ collection }) => {
const { storedTheme } = useTheme();
const ntlmAuth = get(collection, 'root.request.auth.ntlm', {});
+ const { isSensitive } = useDetectSensitiveField(collection);
+ const { showWarning, warningMessage } = isSensitive(ntlmAuth?.password);
const handleSave = () => dispatch(saveCollectionRoot(collection.uid));
@@ -28,9 +32,9 @@ const NTLMAuth = ({ collection }) => {
mode: 'ntlm',
collectionUid: collection.uid,
content: {
- username: username,
- password: ntlmAuth.password,
- domain: ntlmAuth.domain
+ username: username || '',
+ password: ntlmAuth.password || '',
+ domain: ntlmAuth.domain || ''
}
})
@@ -43,9 +47,9 @@ const NTLMAuth = ({ collection }) => {
mode: 'ntlm',
collectionUid: collection.uid,
content: {
- username: ntlmAuth.username,
- password: password,
- domain: ntlmAuth.domain
+ username: ntlmAuth.username || '',
+ password: password || '',
+ domain: ntlmAuth.domain || ''
}
})
);
@@ -57,9 +61,9 @@ const NTLMAuth = ({ collection }) => {
mode: 'ntlm',
collectionUid: collection.uid,
content: {
- username: ntlmAuth.username,
- password: ntlmAuth.password,
- domain: domain
+ username: ntlmAuth.username || '',
+ password: ntlmAuth.password || '',
+ domain: domain || ''
}
})
);
@@ -82,7 +86,7 @@ const NTLMAuth = ({ collection }) => {
+
{
collection={collection}
isSecret={true}
/>
+ {showWarning &&
Domain
diff --git a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/AuthorizationCode/index.js b/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/AuthorizationCode/index.js
deleted file mode 100644
index 8f3dc1601..000000000
--- a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/AuthorizationCode/index.js
+++ /dev/null
@@ -1,120 +0,0 @@
-import React from 'react';
-import get from 'lodash/get';
-import { useTheme } from 'providers/Theme';
-import { useDispatch } from 'react-redux';
-import SingleLineEditor from 'components/SingleLineEditor';
-import { saveCollectionRoot, sendCollectionOauth2Request } from 'providers/ReduxStore/slices/collections/actions';
-import StyledWrapper from './StyledWrapper';
-import { inputsConfig } from './inputsConfig';
-import { updateCollectionAuth } from 'providers/ReduxStore/slices/collections/index';
-import { clearOauth2Cache } from 'utils/network/index';
-import toast from 'react-hot-toast';
-
-const OAuth2AuthorizationCode = ({ collection }) => {
- const dispatch = useDispatch();
- const { storedTheme } = useTheme();
-
- const oAuth = get(collection, 'root.request.auth.oauth2', {});
-
- const handleRun = async () => {
- dispatch(sendCollectionOauth2Request(collection.uid));
- };
-
- const handleSave = () => dispatch(saveCollectionRoot(collection.uid));
-
- const { callbackUrl, authorizationUrl, accessTokenUrl, clientId, clientSecret, scope, state, pkce } = oAuth;
-
- const handleChange = (key, value) => {
- dispatch(
- updateCollectionAuth({
- mode: 'oauth2',
- collectionUid: collection.uid,
- content: {
- grantType: 'authorization_code',
- callbackUrl,
- authorizationUrl,
- accessTokenUrl,
- clientId,
- clientSecret,
- scope,
- state,
- pkce,
- [key]: value
- }
- })
- );
- };
-
- const handlePKCEToggle = (e) => {
- dispatch(
- updateCollectionAuth({
- mode: 'oauth2',
- collectionUid: collection.uid,
- content: {
- grantType: 'authorization_code',
- callbackUrl,
- authorizationUrl,
- accessTokenUrl,
- clientId,
- clientSecret,
- scope,
- state,
- pkce: !Boolean(oAuth?.['pkce'])
- }
- })
- );
- };
-
- const handleClearCache = (e) => {
- clearOauth2Cache(collection?.uid)
- .then(() => {
- toast.success('cleared cache successfully');
- })
- .catch((err) => {
- toast.error(err.message);
- });
- };
-
- return (
-
- {inputsConfig.map((input) => {
- const { key, label, isSecret } = input;
- return (
-
-
{label}
-
- handleChange(key, val)}
- onRun={handleRun}
- collection={collection}
- isSecret={isSecret}
- />
-
-
- Use PKCE
-
-
-
- Get Access Token
-
-
- Clear Cache
-
-
-
- );
-};
-
-export default OAuth2AuthorizationCode;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/ClientCredentials/StyledWrapper.js b/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/ClientCredentials/StyledWrapper.js
deleted file mode 100644
index 856f35b9b..000000000
--- a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/ClientCredentials/StyledWrapper.js
+++ /dev/null
@@ -1,16 +0,0 @@
-import styled from 'styled-components';
-
-const Wrapper = styled.div`
- label {
- font-size: 0.8125rem;
- }
- .single-line-editor-wrapper {
- max-width: 400px;
- padding: 0.15rem 0.4rem;
- border-radius: 3px;
- border: solid 1px ${(props) => props.theme.input.border};
- background-color: ${(props) => props.theme.input.bg};
- }
-`;
-
-export default Wrapper;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/ClientCredentials/index.js b/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/ClientCredentials/index.js
deleted file mode 100644
index d69122b48..000000000
--- a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/ClientCredentials/index.js
+++ /dev/null
@@ -1,70 +0,0 @@
-import React from 'react';
-import get from 'lodash/get';
-import { useTheme } from 'providers/Theme';
-import { useDispatch } from 'react-redux';
-import SingleLineEditor from 'components/SingleLineEditor';
-import { saveCollectionRoot, sendCollectionOauth2Request } from 'providers/ReduxStore/slices/collections/actions';
-import StyledWrapper from './StyledWrapper';
-import { inputsConfig } from './inputsConfig';
-import { updateCollectionAuth } from 'providers/ReduxStore/slices/collections/index';
-
-const OAuth2ClientCredentials = ({ collection }) => {
- const dispatch = useDispatch();
- const { storedTheme } = useTheme();
-
- const oAuth = get(collection, 'root.request.auth.oauth2', {});
-
- const handleRun = async () => {
- dispatch(sendCollectionOauth2Request(collection.uid));
- };
-
- const handleSave = () => dispatch(saveCollectionRoot(collection.uid));
-
- const { accessTokenUrl, clientId, clientSecret, scope } = oAuth;
-
- const handleChange = (key, value) => {
- dispatch(
- updateCollectionAuth({
- mode: 'oauth2',
- collectionUid: collection.uid,
- content: {
- grantType: 'client_credentials',
- accessTokenUrl,
- clientId,
- clientSecret,
- scope,
- [key]: value
- }
- })
- );
- };
-
- return (
-
- {inputsConfig.map((input) => {
- const { key, label, isSecret } = input;
- return (
-
-
{label}
-
- handleChange(key, val)}
- onRun={handleRun}
- collection={collection}
- isSecret={isSecret}
- />
-
-
- Get Access Token
-
-
- );
-};
-
-export default OAuth2ClientCredentials;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/ClientCredentials/inputsConfig.js b/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/ClientCredentials/inputsConfig.js
deleted file mode 100644
index f2cd88ae3..000000000
--- a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/ClientCredentials/inputsConfig.js
+++ /dev/null
@@ -1,21 +0,0 @@
-const inputsConfig = [
- {
- key: 'accessTokenUrl',
- label: 'Access Token URL'
- },
- {
- key: 'clientId',
- label: 'Client ID'
- },
- {
- key: 'clientSecret',
- label: 'Client Secret',
- isSecret: true
- },
- {
- key: 'scope',
- label: 'Scope'
- }
-];
-
-export { inputsConfig };
diff --git a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/GrantTypeSelector/index.js b/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/GrantTypeSelector/index.js
deleted file mode 100644
index 5d9289382..000000000
--- a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/GrantTypeSelector/index.js
+++ /dev/null
@@ -1,98 +0,0 @@
-import React, { useRef, forwardRef } from 'react';
-import get from 'lodash/get';
-import Dropdown from 'components/Dropdown';
-import { useDispatch } from 'react-redux';
-import StyledWrapper from './StyledWrapper';
-import { IconCaretDown } from '@tabler/icons';
-import { updateAuth } from 'providers/ReduxStore/slices/collections';
-import { humanizeGrantType } from 'utils/collections';
-import { useEffect } from 'react';
-import { updateCollectionAuth, updateCollectionAuthMode } from 'providers/ReduxStore/slices/collections/index';
-
-const GrantTypeSelector = ({ collection }) => {
- const dispatch = useDispatch();
- const dropdownTippyRef = useRef();
- const onDropdownCreate = (ref) => (dropdownTippyRef.current = ref);
-
- const oAuth = get(collection, 'root.request.auth.oauth2', {});
-
- const Icon = forwardRef((props, ref) => {
- return (
-
- {humanizeGrantType(oAuth?.grantType)}
- );
- });
-
- const onGrantTypeChange = (grantType) => {
- dispatch(
- updateCollectionAuth({
- mode: 'oauth2',
- collectionUid: collection.uid,
- content: {
- grantType
- }
- })
- );
- };
-
- useEffect(() => {
- // initialize redux state with a default oauth2 grant type
- // authorization_code - default option
- !oAuth?.grantType &&
- dispatch(
- updateCollectionAuthMode({
- mode: 'oauth2',
- collectionUid: collection.uid
- })
- );
- !oAuth?.grantType &&
- dispatch(
- updateCollectionAuth({
- mode: 'oauth2',
- collectionUid: collection.uid,
- content: {
- grantType: 'authorization_code'
- }
- })
- );
- }, [oAuth]);
-
- return (
-
- Grant Type
-
-
} placement="bottom-end">
-
{
- dropdownTippyRef.current.hide();
- onGrantTypeChange('password');
- }}
- >
- Password Credentials
-
-
{
- dropdownTippyRef.current.hide();
- onGrantTypeChange('authorization_code');
- }}
- >
- Authorization Code
-
-
{
- dropdownTippyRef.current.hide();
- onGrantTypeChange('client_credentials');
- }}
- >
- Client Credentials
-
-
-
- );
-};
-export default GrantTypeSelector;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/PasswordCredentials/StyledWrapper.js b/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/PasswordCredentials/StyledWrapper.js
deleted file mode 100644
index 856f35b9b..000000000
--- a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/PasswordCredentials/StyledWrapper.js
+++ /dev/null
@@ -1,16 +0,0 @@
-import styled from 'styled-components';
-
-const Wrapper = styled.div`
- label {
- font-size: 0.8125rem;
- }
- .single-line-editor-wrapper {
- max-width: 400px;
- padding: 0.15rem 0.4rem;
- border-radius: 3px;
- border: solid 1px ${(props) => props.theme.input.border};
- background-color: ${(props) => props.theme.input.bg};
- }
-`;
-
-export default Wrapper;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/PasswordCredentials/index.js b/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/PasswordCredentials/index.js
deleted file mode 100644
index d2d9eed1f..000000000
--- a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/PasswordCredentials/index.js
+++ /dev/null
@@ -1,72 +0,0 @@
-import React from 'react';
-import get from 'lodash/get';
-import { useTheme } from 'providers/Theme';
-import { useDispatch } from 'react-redux';
-import SingleLineEditor from 'components/SingleLineEditor';
-import { saveCollectionRoot, sendCollectionOauth2Request } from 'providers/ReduxStore/slices/collections/actions';
-import StyledWrapper from './StyledWrapper';
-import { inputsConfig } from './inputsConfig';
-import { updateCollectionAuth } from 'providers/ReduxStore/slices/collections/index';
-
-const OAuth2AuthorizationCode = ({ item, collection }) => {
- const dispatch = useDispatch();
- const { storedTheme } = useTheme();
-
- const oAuth = get(collection, 'root.request.auth.oauth2', {});
-
- const handleRun = async () => {
- dispatch(sendCollectionOauth2Request(collection.uid));
- };
-
- const handleSave = () => dispatch(saveCollectionRoot(collection.uid));
-
- const { accessTokenUrl, username, password, clientId, clientSecret, scope } = oAuth;
-
- const handleChange = (key, value) => {
- dispatch(
- updateCollectionAuth({
- mode: 'oauth2',
- collectionUid: collection.uid,
- content: {
- grantType: 'password',
- accessTokenUrl,
- username,
- password,
- clientId,
- clientSecret,
- scope,
- [key]: value
- }
- })
- );
- };
-
- return (
-
- {inputsConfig.map((input) => {
- const { key, label, isSecret } = input;
- return (
-
-
{label}
-
- handleChange(key, val)}
- onRun={handleRun}
- collection={collection}
- isSecret={isSecret}
- />
-
-
- Get Access Token
-
-
- );
-};
-
-export default OAuth2AuthorizationCode;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/PasswordCredentials/inputsConfig.js b/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/PasswordCredentials/inputsConfig.js
deleted file mode 100644
index ec9efb1a8..000000000
--- a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/PasswordCredentials/inputsConfig.js
+++ /dev/null
@@ -1,29 +0,0 @@
-const inputsConfig = [
- {
- key: 'accessTokenUrl',
- label: 'Access Token URL'
- },
- {
- key: 'username',
- label: 'Username'
- },
- {
- key: 'password',
- label: 'Password'
- },
- {
- key: 'clientId',
- label: 'Client ID'
- },
- {
- key: 'clientSecret',
- label: 'Client Secret',
- isSecret: true
- },
- {
- key: 'scope',
- label: 'Scope'
- }
-];
-
-export { inputsConfig };
diff --git a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/index.js b/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/index.js
index 1aa674ab9..e8d20f25c 100644
--- a/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/index.js
+++ b/packages/bruno-app/src/components/CollectionSettings/Auth/OAuth2/index.js
@@ -1,21 +1,37 @@
import React from 'react';
import get from 'lodash/get';
import StyledWrapper from './StyledWrapper';
-import GrantTypeSelector from './GrantTypeSelector/index';
-import OAuth2PasswordCredentials from './PasswordCredentials/index';
-import OAuth2AuthorizationCode from './AuthorizationCode/index';
-import OAuth2ClientCredentials from './ClientCredentials/index';
+import { saveCollectionRoot } from 'providers/ReduxStore/slices/collections/actions';
+import OAuth2AuthorizationCode from 'components/RequestPane/Auth/OAuth2/AuthorizationCode/index';
+import { updateCollectionAuth } from 'providers/ReduxStore/slices/collections/index';
+import { useDispatch } from 'react-redux';
+import OAuth2PasswordCredentials from 'components/RequestPane/Auth/OAuth2/PasswordCredentials/index';
+import OAuth2ClientCredentials from 'components/RequestPane/Auth/OAuth2/ClientCredentials/index';
+import OAuth2Implicit from 'components/RequestPane/Auth/OAuth2/Implicit/index';
+import GrantTypeSelector from 'components/RequestPane/Auth/OAuth2/GrantTypeSelector/index';
+
+const GrantTypeComponentMap = ({collection }) => {
+ const dispatch = useDispatch();
+
+ const save = () => {
+ dispatch(saveCollectionRoot(collection.uid));
+ };
+
+ let request = collection.draft ? get(collection, 'draft.request', {}) : get(collection, 'root.request', {});
+ const grantType = get(request, 'auth.oauth2.grantType', {});
-const grantTypeComponentMap = (grantType, collection) => {
switch (grantType) {
case 'password':
- return
;
+ return
;
break;
case 'authorization_code':
- return
;
+ return
;
break;
case 'client_credentials':
- return
;
+ return
;
+ break;
+ case 'implicit':
+ return
;
break;
default:
return
TBD
;
@@ -24,12 +40,12 @@ const grantTypeComponentMap = (grantType, collection) => {
};
const OAuth2 = ({ collection }) => {
- const oAuth = get(collection, 'root.request.auth.oauth2', {});
+ let request = collection.draft ? get(collection, 'draft.request', {}) : get(collection, 'root.request', {});
return (
-
);
};
diff --git a/packages/bruno-app/src/components/CollectionSettings/Auth/StyledWrapper.js b/packages/bruno-app/src/components/CollectionSettings/Auth/StyledWrapper.js
index e49220854..b7e4b56c7 100644
--- a/packages/bruno-app/src/components/CollectionSettings/Auth/StyledWrapper.js
+++ b/packages/bruno-app/src/components/CollectionSettings/Auth/StyledWrapper.js
@@ -1,5 +1,7 @@
import styled from 'styled-components';
-const Wrapper = styled.div``;
+const Wrapper = styled.div`
+ max-width: 800px;
+`;
export default Wrapper;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Auth/WsseAuth/index.js b/packages/bruno-app/src/components/CollectionSettings/Auth/WsseAuth/index.js
index 45efc7b1e..226cedd7b 100644
--- a/packages/bruno-app/src/components/CollectionSettings/Auth/WsseAuth/index.js
+++ b/packages/bruno-app/src/components/CollectionSettings/Auth/WsseAuth/index.js
@@ -1,4 +1,6 @@
import React from 'react';
+import SensitiveFieldWarning from 'components/SensitiveFieldWarning';
+import { useDetectSensitiveField } from 'hooks/useDetectSensitiveField';
import get from 'lodash/get';
import { useTheme } from 'providers/Theme';
import { useDispatch } from 'react-redux';
@@ -12,6 +14,8 @@ const WsseAuth = ({ collection }) => {
const { storedTheme } = useTheme();
const wsseAuth = get(collection, 'root.request.auth.wsse', {});
+ const { isSensitive } = useDetectSensitiveField(collection);
+ const { showWarning, warningMessage } = isSensitive(wsseAuth?.password);
const handleSave = () => dispatch(saveCollectionRoot(collection.uid));
@@ -21,8 +25,8 @@ const WsseAuth = ({ collection }) => {
mode: 'wsse',
collectionUid: collection.uid,
content: {
- username,
- password: wsseAuth.password
+ username: username || '',
+ password: wsseAuth.password || ''
}
})
);
@@ -34,8 +38,8 @@ const WsseAuth = ({ collection }) => {
mode: 'wsse',
collectionUid: collection.uid,
content: {
- username: wsseAuth.username,
- password
+ username: wsseAuth.username || '',
+ password: password || ''
}
})
);
@@ -55,14 +59,16 @@ const WsseAuth = ({ collection }) => {
+
handlePasswordChange(val)}
collection={collection}
+ isSecret={true}
/>
+ {showWarning &&
);
diff --git a/packages/bruno-app/src/components/CollectionSettings/ClientCertSettings/StyledWrapper.js b/packages/bruno-app/src/components/CollectionSettings/ClientCertSettings/StyledWrapper.js
index 621b2b86b..affe1f7db 100644
--- a/packages/bruno-app/src/components/CollectionSettings/ClientCertSettings/StyledWrapper.js
+++ b/packages/bruno-app/src/components/CollectionSettings/ClientCertSettings/StyledWrapper.js
@@ -38,6 +38,48 @@ const StyledWrapper = styled.div`
outline: none !important;
}
}
+
+ .protocol-placeholder {
+ height: 100%;
+ position: relative;
+ display: inline-block;
+ width: 60px;
+ overflow: hidden;
+ }
+
+ .protocol-https,
+ .protocol-grpcs {
+ position: absolute;
+ right: 8px;
+ top: 0;
+ bottom: 0;
+ transition: transform 0.3s ease-in-out;
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ }
+
+ .protocol-https {
+ animation: slideUpDown 6s infinite;
+ transform: translateY(0);
+ }
+
+ .protocol-grpcs {
+ animation: slideUpDown 6s infinite 3s;
+ transform: translateY(100%);
+ }
+
+ @keyframes slideUpDown {
+ 0%, 45% {
+ transform: translateY(0);
+ }
+ 50%, 95% {
+ transform: translateY(100%);
+ }
+ 100% {
+ transform: translateY(0);
+ }
+ }
`;
export default StyledWrapper;
diff --git a/packages/bruno-app/src/components/CollectionSettings/ClientCertSettings/index.js b/packages/bruno-app/src/components/CollectionSettings/ClientCertSettings/index.js
index ccfac9046..3f62fc23e 100644
--- a/packages/bruno-app/src/components/CollectionSettings/ClientCertSettings/index.js
+++ b/packages/bruno-app/src/components/CollectionSettings/ClientCertSettings/index.js
@@ -8,9 +8,7 @@ import { useState } from 'react';
import StyledWrapper from './StyledWrapper';
import { useRef } from 'react';
-import path from 'path';
-import slash from 'utils/common/slash';
-import { isWindowsOS } from 'utils/common/platform';
+import path from 'utils/common/path';
const ClientCertSettings = ({ root, clientCertConfig, onUpdate, onRemove }) => {
const certFilePathInputRef = useRef();
@@ -27,7 +25,10 @@ const ClientCertSettings = ({ root, clientCertConfig, onUpdate, onRemove }) => {
passphrase: ''
},
validationSchema: Yup.object({
- domain: Yup.string().required(),
+ domain: Yup.string()
+ .required()
+ .trim()
+ .test('not-empty-after-trim', 'Domain is required', value => value && value.trim().length > 0),
type: Yup.string().required().oneOf(['cert', 'pfx']),
certFilePath: Yup.string().when('type', {
is: (type) => type == 'cert',
@@ -47,7 +48,7 @@ const ClientCertSettings = ({ root, clientCertConfig, onUpdate, onRemove }) => {
let relevantValues = {};
if (values.type === 'cert') {
relevantValues = {
- domain: values.domain,
+ domain: values.domain?.trim(),
type: values.type,
certFilePath: values.certFilePath,
keyFilePath: values.keyFilePath,
@@ -55,7 +56,7 @@ const ClientCertSettings = ({ root, clientCertConfig, onUpdate, onRemove }) => {
};
} else {
relevantValues = {
- domain: values.domain,
+ domain: values.domain?.trim(),
type: values.type,
pfxFilePath: values.pfxFilePath,
passphrase: values.passphrase
@@ -70,12 +71,7 @@ const ClientCertSettings = ({ root, clientCertConfig, onUpdate, onRemove }) => {
const getFile = (e) => {
const filePath = window?.ipcRenderer?.getFilePath(e?.files?.[0]);
if (filePath) {
- let relativePath;
- if (isWindowsOS()) {
- relativePath = slash(path.win32.relative(root, filePath));
- } else {
- relativePath = path.posix.relative(root, filePath);
- }
+ let relativePath = path.relative(root, filePath);
formik.setFieldValue(e.name, relativePath);
}
};
@@ -109,23 +105,23 @@ const ClientCertSettings = ({ root, clientCertConfig, onUpdate, onRemove }) => {
{!clientCertConfig.length
? 'No client certificates added'
- : clientCertConfig.map((clientCert) => (
-
-
-
-
-
-
-
onRemove(clientCert)} className="remove-certificate ml-2">
-
+ : clientCertConfig.map((clientCert, index) => (
+
+
+
+
-
- ))}
+
+
+
onRemove(clientCert)} className="remove-certificate ml-2">
+
+
+ ))}
Add Client Certificate
@@ -134,15 +130,23 @@ const ClientCertSettings = ({ root, clientCertConfig, onUpdate, onRemove }) => {
Domain
-
+
+
+
+ https://
+ grpcs://
+
+
+
+
{formik.touched.domain && formik.errors.domain ? (
{formik.errors.domain}
) : null}
@@ -198,9 +202,9 @@ const ClientCertSettings = ({ root, clientCertConfig, onUpdate, onRemove }) => {
- {path.basename(slash(formik.values.certFilePath))}
+ {path.basename(formik.values.certFilePath)}
{
- {path.basename(slash(formik.values.keyFilePath))}
+ {path.basename(formik.values.keyFilePath)}
{
- {path.basename(slash(formik.values.pfxFilePath))}
+ {path.basename(formik.values.pfxFilePath)}
props.theme.colors.text.yellow};
}
`;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Docs/index.js b/packages/bruno-app/src/components/CollectionSettings/Docs/index.js
index 23dbe9e70..3289e099c 100644
--- a/packages/bruno-app/src/components/CollectionSettings/Docs/index.js
+++ b/packages/bruno-app/src/components/CollectionSettings/Docs/index.js
@@ -8,6 +8,7 @@ import { saveCollectionRoot } from 'providers/ReduxStore/slices/collections/acti
import Markdown from 'components/MarkDown';
import CodeEditor from 'components/CodeEditor';
import StyledWrapper from './StyledWrapper';
+import { IconEdit, IconX, IconFileText } from '@tabler/icons';
const Docs = ({ collection }) => {
const dispatch = useDispatch();
@@ -29,35 +30,95 @@ const Docs = ({ collection }) => {
);
};
- const onSave = () => dispatch(saveCollectionRoot(collection.uid));
+ const handleDiscardChanges = () => {
+ dispatch(
+ updateCollectionDocs({
+ collectionUid: collection.uid,
+ docs: docs
+ })
+ );
+ toggleViewMode();
+ }
+
+ const onSave = () => {
+ dispatch(saveCollectionRoot(collection.uid));
+ toggleViewMode();
+ }
return (
-
-
- {isEditing ? 'Preview' : 'Edit'}
-
-
- {isEditing ? (
-
-
-
- Save
-
+
+
+
+
+
+ {isEditing ? (
+ <>
+
+
+
+ Save
+
+
+ ) : (
+
+
+ )}
+
+
+
+ {
+ docs?.length > 0 ?
+
+
);
};
export default Docs;
+
+
+const documentationPlaceholder = `
+Welcome to your collection documentation! This space is designed to help you document your API collection effectively.
+
+## Overview
+Use this section to provide a high-level overview of your collection. You can describe:
+- The purpose of these API endpoints
+- Key features and functionalities
+- Target audience or users
+
+## Best Practices
+- Keep documentation up to date
+- Include request/response examples
+- Document error scenarios
+- Add relevant links and references
+
+## Markdown Support
+This documentation supports Markdown formatting! You can use:
+- **Bold** and *italic* text
+- \`code blocks\` and syntax highlighting
+- Tables and lists
+- [Links](https://usebruno.com)
+- And more!
+`;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Grpc/StyledWrapper.js b/packages/bruno-app/src/components/CollectionSettings/Grpc/StyledWrapper.js
new file mode 100644
index 000000000..21adc36e1
--- /dev/null
+++ b/packages/bruno-app/src/components/CollectionSettings/Grpc/StyledWrapper.js
@@ -0,0 +1,13 @@
+import styled from 'styled-components';
+
+const StyledWrapper = styled.div`
+ .available-certificates {
+ background-color: ${(props) => props.theme.requestTabPanel.url.bg};
+
+ button.remove-certificate {
+ color: ${(props) => props.theme.colors.text.danger};
+ }
+ }
+`;
+
+export default StyledWrapper;
\ No newline at end of file
diff --git a/packages/bruno-app/src/components/CollectionSettings/Grpc/index.js b/packages/bruno-app/src/components/CollectionSettings/Grpc/index.js
new file mode 100644
index 000000000..db2313efd
--- /dev/null
+++ b/packages/bruno-app/src/components/CollectionSettings/Grpc/index.js
@@ -0,0 +1,263 @@
+import React, { useState, useRef, useEffect } from 'react';
+import { useFormik } from 'formik';
+import { useDispatch } from 'react-redux';
+import StyledWrapper from './StyledWrapper';
+import toast from 'react-hot-toast';
+import { updateBrunoConfig } from 'providers/ReduxStore/slices/collections/actions';
+import cloneDeep from 'lodash/cloneDeep';
+import { IconTrash, IconFile, IconFileImport, IconAlertCircle } from '@tabler/icons';
+import { getRelativePath, getBasename, getDirPath } from 'utils/common/path';
+import { Tooltip } from 'react-tooltip';
+import { existsSync, resolvePath } from '../../../utils/filesystem';
+
+const GrpcSettings = ({ collection }) => {
+ const dispatch = useDispatch();
+ const {
+ brunoConfig: { grpc: grpcConfig = {} }
+ } = collection;
+
+ const fileInputRef = useRef(null);
+ const [protoFileValidity, setProtoFileValidity] = useState({});
+
+ const formik = useFormik({
+ enableReinitialize: true,
+ initialValues: {
+ protoFiles: grpcConfig.protoFiles || []
+ },
+ onSubmit: (newGrpcConfig) => {
+ const brunoConfig = cloneDeep(collection.brunoConfig);
+ brunoConfig.grpc = newGrpcConfig;
+ dispatch(updateBrunoConfig(brunoConfig, collection.uid));
+ toast.success('gRPC settings updated');
+ }
+ });
+
+ // Get file path using the ipcRenderer
+ const getProtoFile = (event) => {
+ const files = event?.files;
+ if (files && files.length > 0) {
+ const newProtoFiles = [...formik.values.protoFiles];
+
+ for (let i = 0; i < files.length; i++) {
+ const filePath = window?.ipcRenderer?.getFilePath(files[i]);
+ if (filePath) {
+ const relativePath = getRelativePath(filePath, collection.pathname);
+ const protoFileObj = {
+ path: relativePath,
+ type: 'file'
+ };
+
+ // Check if this path already exists
+ const exists = newProtoFiles.some(pf => pf.path === protoFileObj.path);
+ if (!exists) {
+ newProtoFiles.push(protoFileObj);
+ }
+ }
+ }
+
+ formik.setFieldValue('protoFiles', newProtoFiles);
+ // Reset the file input
+ if (fileInputRef.current) {
+ fileInputRef.current.value = '';
+ }
+ }
+ };
+
+ // Handler for removing a proto file
+ const handleRemoveProtoFile = (index) => {
+ const updatedProtoFiles = [...formik.values.protoFiles];
+ updatedProtoFiles.splice(index, 1);
+ formik.setFieldValue('protoFiles', updatedProtoFiles);
+ };
+
+ // Handle the browse button click
+ const handleBrowseClick = () => {
+ if (fileInputRef.current) {
+ fileInputRef.current.click();
+ }
+ };
+
+ // Check if a proto file path is valid
+ const isProtoFileValid = async (protoFile) => {
+ try {
+ const absolutePath = await resolvePath(protoFile.path, collection.pathname);
+ return await existsSync(absolutePath);
+ } catch (error) {
+ return false;
+ }
+ };
+
+ // Validate all proto files and update state
+ useEffect(() => {
+ const validateProtoFiles = async () => {
+ const validityMap = {};
+ for (const file of formik.values.protoFiles) {
+ validityMap[file.path] = await isProtoFileValid(file);
+ }
+ setProtoFileValidity(validityMap);
+ };
+
+ validateProtoFiles();
+ }, [formik.values.protoFiles, collection.pathname]);
+
+ // Handle replacing an invalid proto file
+ const handleReplaceProtoFile = (index) => {
+ if (fileInputRef.current) {
+ fileInputRef.current.click();
+ // Store the index to replace after file selection
+ fileInputRef.current.dataset.replaceIndex = index;
+ }
+ };
+
+ // Handle file input change
+ const handleFileInputChange = (e) => {
+ const replaceIndex = e.target.dataset.replaceIndex;
+ if (replaceIndex !== undefined) {
+ // Handle replacement
+ const files = e.target.files;
+ if (files && files.length > 0) {
+ const filePath = window?.ipcRenderer?.getFilePath(files[0]);
+ if (filePath) {
+ const relativePath = getRelativePath(filePath, collection.pathname);
+ const updatedProtoFiles = [...formik.values.protoFiles];
+ updatedProtoFiles[replaceIndex] = {
+ path: relativePath,
+ type: 'file'
+ };
+ formik.setFieldValue('protoFiles', updatedProtoFiles);
+ }
+ }
+ delete e.target.dataset.replaceIndex;
+ } else {
+ getProtoFile(e.target);
+ }
+ };
+
+ return (
+
+
+
+ );
+};
+
+export default GrpcSettings;
\ No newline at end of file
diff --git a/packages/bruno-app/src/components/CollectionSettings/Headers/StyledWrapper.js b/packages/bruno-app/src/components/CollectionSettings/Headers/StyledWrapper.js
index 9f723cb81..c4d03c5ed 100644
--- a/packages/bruno-app/src/components/CollectionSettings/Headers/StyledWrapper.js
+++ b/packages/bruno-app/src/components/CollectionSettings/Headers/StyledWrapper.js
@@ -1,6 +1,8 @@
import styled from 'styled-components';
const Wrapper = styled.div`
+ max-width: 800px;
+
table {
width: 100%;
border-collapse: collapse;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Headers/index.js b/packages/bruno-app/src/components/CollectionSettings/Headers/index.js
index 9ae6e1e07..d0968c425 100644
--- a/packages/bruno-app/src/components/CollectionSettings/Headers/index.js
+++ b/packages/bruno-app/src/components/CollectionSettings/Headers/index.js
@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { useState } from 'react';
import get from 'lodash/get';
import cloneDeep from 'lodash/cloneDeep';
import { IconTrash } from '@tabler/icons';
@@ -7,19 +7,30 @@ import { useTheme } from 'providers/Theme';
import {
addCollectionHeader,
updateCollectionHeader,
- deleteCollectionHeader
+ deleteCollectionHeader,
+ setCollectionHeaders
} from 'providers/ReduxStore/slices/collections';
import { saveCollectionRoot } from 'providers/ReduxStore/slices/collections/actions';
import SingleLineEditor from 'components/SingleLineEditor';
import StyledWrapper from './StyledWrapper';
import { headers as StandardHTTPHeaders } from 'know-your-http-well';
import { MimeTypes } from 'utils/codemirror/autocompleteConstants';
+import BulkEditor from 'components/BulkEditor/index';
const headerAutoCompleteList = StandardHTTPHeaders.map((e) => e.header);
const Headers = ({ collection }) => {
const dispatch = useDispatch();
const { storedTheme } = useTheme();
const headers = get(collection, 'root.request.headers', []);
+ const [isBulkEditMode, setIsBulkEditMode] = useState(false);
+
+ const toggleBulkEditMode = () => {
+ setIsBulkEditMode(!isBulkEditMode);
+ };
+
+ const handleBulkHeadersChange = (newHeaders) => {
+ dispatch(setCollectionHeaders({ collectionUid: collection.uid, headers: newHeaders }));
+ };
const addHeader = () => {
dispatch(
@@ -63,6 +74,22 @@ const Headers = ({ collection }) => {
);
};
+ if (isBulkEditMode) {
+ return (
+
+
+ Add request headers that will be sent with every request in this collection.
+
+
+ );
+ }
+
return (
@@ -141,9 +168,14 @@ const Headers = ({ collection }) => {
: null}
-
- + Add Header
-
+
+
+ + Add Header
+
+
+ Bulk Edit
+
+
diff --git a/packages/bruno-app/src/components/CollectionSettings/Info/index.js b/packages/bruno-app/src/components/CollectionSettings/Info/index.js
deleted file mode 100644
index 3b0a1297b..000000000
--- a/packages/bruno-app/src/components/CollectionSettings/Info/index.js
+++ /dev/null
@@ -1,39 +0,0 @@
-import React from 'react';
-import StyledWrapper from './StyledWrapper';
-import { getTotalRequestCountInCollection } from 'utils/collections/';
-
-const Info = ({ collection }) => {
- const totalRequestsInCollection = getTotalRequestCountInCollection(collection);
-
- return (
-
- General information about the collection.
-
-
-
- Name :
- {collection.name}
-
-
- Location :
- {collection.pathname}
-
-
- Ignored files :
- {collection.brunoConfig?.ignore?.map((x) => `'${x}'`).join(', ')}
-
-
- Environments :
- {collection.environments?.length || 0}
-
-
- Requests :
- {totalRequestsInCollection}
-
-
-
-
- );
-};
-
-export default Info;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Overview/Info/index.js b/packages/bruno-app/src/components/CollectionSettings/Overview/Info/index.js
new file mode 100644
index 000000000..eb42be7cb
--- /dev/null
+++ b/packages/bruno-app/src/components/CollectionSettings/Overview/Info/index.js
@@ -0,0 +1,82 @@
+import React from "react";
+import { getTotalRequestCountInCollection } from 'utils/collections/';
+import { IconFolder, IconWorld, IconApi, IconShare } from '@tabler/icons';
+import { areItemsLoading, getItemsLoadStats } from "utils/collections/index";
+import { useState } from "react";
+import ShareCollection from "components/ShareCollection/index";
+
+const Info = ({ collection }) => {
+ const totalRequestsInCollection = getTotalRequestCountInCollection(collection);
+
+ const isCollectionLoading = areItemsLoading(collection);
+ const { loading: itemsLoadingCount, total: totalItems } = getItemsLoadStats(collection);
+ const [showShareCollectionModal, toggleShowShareCollectionModal] = useState(false);
+
+ const handleToggleShowShareCollectionModal = (value) => (e) => {
+ toggleShowShareCollectionModal(value);
+ }
+
+ return (
+
+
+
+ {/* Location Row */}
+
+
+
+
+
Location
+
+ {collection.pathname}
+
+
+
+
+ {/* Environments Row */}
+
+
+
+
+
Environments
+
+ {collection.environments?.length || 0} environment{collection.environments?.length !== 1 ? 's' : ''} configured
+
+
+
+
+ {/* Requests Row */}
+
+
+
+
+
Requests
+
+ {
+ isCollectionLoading? `${totalItems - itemsLoadingCount} out of ${totalItems} requests in the collection loaded` : `${totalRequestsInCollection} request${totalRequestsInCollection !== 1 ? 's' : ''} in collection`
+ }
+
+
+
+
+
+
+
+
+
Share
+
+ Share Collection
+
+
+
+ {showShareCollectionModal &&
}
+
+
+
+
+ Following requests were not loaded
+
+
+
+
+
+ Pathname
+
+
+ Size
+
+
+
+
+ {flattenedItems?.map((item, index) => (
+ item?.partial && !item?.loading ? (
+
+
+ {item?.pathname?.split(`${collection?.pathname}/`)?.[1]}
+
+
+ {item?.size?.toFixed?.(2)} MB
+
+
+ ) : null
+ ))}
+
+
+
+ );
+};
+
+export default RequestsNotLoaded;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Overview/StyledWrapper.js b/packages/bruno-app/src/components/CollectionSettings/Overview/StyledWrapper.js
new file mode 100644
index 000000000..4d77f2600
--- /dev/null
+++ b/packages/bruno-app/src/components/CollectionSettings/Overview/StyledWrapper.js
@@ -0,0 +1,25 @@
+import styled from 'styled-components';
+
+const StyledWrapper = styled.div`
+ .partial {
+ color: ${(props) => props.theme.colors.text.yellow};
+ opacity: 0.8;
+ }
+
+ .loading {
+ color: ${(props) => props.theme.colors.text.muted};
+ opacity: 0.8;
+ }
+
+ .completed {
+ color: ${(props) => props.theme.colors.text.green};
+ opacity: 0.8;
+ }
+
+ .failed {
+ color: ${(props) => props.theme.colors.text.danger};
+ opacity: 0.8;
+ }
+`;
+
+export default StyledWrapper;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Overview/index.js b/packages/bruno-app/src/components/CollectionSettings/Overview/index.js
new file mode 100644
index 000000000..87b461e9c
--- /dev/null
+++ b/packages/bruno-app/src/components/CollectionSettings/Overview/index.js
@@ -0,0 +1,27 @@
+import StyledWrapper from "./StyledWrapper";
+import Docs from "../Docs";
+import Info from "./Info";
+import { IconBox } from '@tabler/icons';
+import RequestsNotLoaded from "./RequestsNotLoaded";
+
+const Overview = ({ collection }) => {
+ return (
+
+
+
+
+
+
+
+
+
+
+
+
GraphQL
+
+ {isGrpcEnabled && (
+ <>
+
+ gRPC
+
+
+ )}
@@ -74,7 +98,7 @@ const PresetsSettings = ({ collection }) => {
id="request-url"
type="text"
name="requestUrl"
- placeholder='Request URL'
+ placeholder="Request URL"
className="block textbox"
autoComplete="off"
autoCorrect="off"
@@ -87,6 +111,7 @@ const PresetsSettings = ({ collection }) => {
+
Save
diff --git a/packages/bruno-app/src/components/CollectionSettings/ProxySettings/index.js b/packages/bruno-app/src/components/CollectionSettings/ProxySettings/index.js
index 105a92642..bb48cbdc0 100644
--- a/packages/bruno-app/src/components/CollectionSettings/ProxySettings/index.js
+++ b/packages/bruno-app/src/components/CollectionSettings/ProxySettings/index.js
@@ -104,18 +104,15 @@ const ProxySettings = ({ proxyConfig, onUpdate }) => {
Config
-
- global - use global proxy configenabled - use collection proxy configdisable - disable proxyglobal - use global proxy configenabled - use collection proxy configdisable - disable proxy
- `}
- infotipId="request-var"
- />
+
diff --git a/packages/bruno-app/src/components/CollectionSettings/Script/StyledWrapper.js b/packages/bruno-app/src/components/CollectionSettings/Script/StyledWrapper.js
index 66ba1ed3d..03aed74aa 100644
--- a/packages/bruno-app/src/components/CollectionSettings/Script/StyledWrapper.js
+++ b/packages/bruno-app/src/components/CollectionSettings/Script/StyledWrapper.js
@@ -1,6 +1,8 @@
import styled from 'styled-components';
const StyledWrapper = styled.div`
+ max-width: 800px;
+
div.CodeMirror {
height: inherit;
}
diff --git a/packages/bruno-app/src/components/CollectionSettings/Script/index.js b/packages/bruno-app/src/components/CollectionSettings/Script/index.js
index 6fe979cbf..625df1ff7 100644
--- a/packages/bruno-app/src/components/CollectionSettings/Script/index.js
+++ b/packages/bruno-app/src/components/CollectionSettings/Script/index.js
@@ -53,6 +53,7 @@ const Script = ({ collection }) => {
onSave={handleSave}
font={get(preferences, 'font.codeFont', 'default')}
fontSize={get(preferences, 'font.codeFontSize')}
+ showHintsFor={['req', 'bru']}
/>
@@ -66,6 +67,7 @@ const Script = ({ collection }) => {
onSave={handleSave}
font={get(preferences, 'font.codeFont', 'default')}
fontSize={get(preferences, 'font.codeFontSize')}
+ showHintsFor={['req', 'res', 'bru']}
/>
diff --git a/packages/bruno-app/src/components/CollectionSettings/StyledWrapper.js b/packages/bruno-app/src/components/CollectionSettings/StyledWrapper.js
index b88a31e0d..90ab7fee5 100644
--- a/packages/bruno-app/src/components/CollectionSettings/StyledWrapper.js
+++ b/packages/bruno-app/src/components/CollectionSettings/StyledWrapper.js
@@ -1,8 +1,6 @@
import styled from 'styled-components';
const StyledWrapper = styled.div`
- max-width: 800px;
-
div.tabs {
div.tab {
padding: 6px 0px;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Tests/StyledWrapper.js b/packages/bruno-app/src/components/CollectionSettings/Tests/StyledWrapper.js
index ec278887d..b9014ebd5 100644
--- a/packages/bruno-app/src/components/CollectionSettings/Tests/StyledWrapper.js
+++ b/packages/bruno-app/src/components/CollectionSettings/Tests/StyledWrapper.js
@@ -1,5 +1,7 @@
import styled from 'styled-components';
-const StyledWrapper = styled.div``;
+const StyledWrapper = styled.div`
+ max-width: 800px;
+`;
export default StyledWrapper;
diff --git a/packages/bruno-app/src/components/CollectionSettings/Tests/index.js b/packages/bruno-app/src/components/CollectionSettings/Tests/index.js
index d87a1dea4..975758ee1 100644
--- a/packages/bruno-app/src/components/CollectionSettings/Tests/index.js
+++ b/packages/bruno-app/src/components/CollectionSettings/Tests/index.js
@@ -37,6 +37,7 @@ const Tests = ({ collection }) => {
onSave={handleSave}
font={get(preferences, 'font.codeFont', 'default')}
fontSize={get(preferences, 'font.codeFontSize')}
+ showHintsFor={['req', 'res', 'bru']}
/>
diff --git a/packages/bruno-app/src/components/CollectionSettings/Vars/StyledWrapper.js b/packages/bruno-app/src/components/CollectionSettings/Vars/StyledWrapper.js
index 44b01b464..26459a3c6 100644
--- a/packages/bruno-app/src/components/CollectionSettings/Vars/StyledWrapper.js
+++ b/packages/bruno-app/src/components/CollectionSettings/Vars/StyledWrapper.js
@@ -1,6 +1,8 @@
import styled from 'styled-components';
const StyledWrapper = styled.div`
+ max-width: 800px;
+
div.title {
color: var(--color-tab-inactive);
}
diff --git a/packages/bruno-app/src/components/CollectionSettings/Vars/VarsTable/index.js b/packages/bruno-app/src/components/CollectionSettings/Vars/VarsTable/index.js
index ebc6a2fe7..0341c6ecd 100644
--- a/packages/bruno-app/src/components/CollectionSettings/Vars/VarsTable/index.js
+++ b/packages/bruno-app/src/components/CollectionSettings/Vars/VarsTable/index.js
@@ -89,7 +89,7 @@ const VarsTable = ({ collection, vars, varType }) => {
Expr
-
)}
diff --git a/packages/bruno-app/src/components/CollectionSettings/index.js b/packages/bruno-app/src/components/CollectionSettings/index.js
index b849d6b18..8a27d6ce4 100644
--- a/packages/bruno-app/src/components/CollectionSettings/index.js
+++ b/packages/bruno-app/src/components/CollectionSettings/index.js
@@ -12,23 +12,17 @@ import Headers from './Headers';
import Auth from './Auth';
import Script from './Script';
import Test from './Tests';
-import Docs from './Docs';
import Presets from './Presets';
-import Info from './Info';
+import Grpc from './Grpc';
import StyledWrapper from './StyledWrapper';
import Vars from './Vars/index';
-import DotIcon from 'components/Icons/Dot';
-
-const ContentIndicator = () => {
- return (
-
-
- );
-};
+import StatusDot from 'components/StatusDot';
+import Overview from './Overview/index';
+import { useBetaFeature, BETA_FEATURES } from 'utils/beta-features';
const CollectionSettings = ({ collection }) => {
const dispatch = useDispatch();
+ const isGrpcEnabled = useBetaFeature(BETA_FEATURES.GRPC);
const tab = collection.settingsSelectedTab;
const setTab = (tab) => {
dispatch(
@@ -50,11 +44,11 @@ const CollectionSettings = ({ collection }) => {
const requestVars = get(collection, 'root.request.vars.req', []);
const responseVars = get(collection, 'root.request.vars.res', []);
const activeVarsCount = requestVars.filter((v) => v.enabled).length + responseVars.filter((v) => v.enabled).length;
- const auth = get(collection, 'root.request.auth', {}).mode;
+ const authMode = get(collection, 'root.request.auth', {}).mode || 'none';
const proxyConfig = get(collection, 'brunoConfig.proxy', {});
const clientCertConfig = get(collection, 'brunoConfig.clientCertificates.certs', []);
-
+ const grpcConfig = get(collection, 'brunoConfig.grpc', {});
const onProxySettingsUpdate = (config) => {
const brunoConfig = cloneDeep(collection.brunoConfig);
@@ -97,6 +91,9 @@ const CollectionSettings = ({ collection }) => {
const getTabPanel = (tab) => {
switch (tab) {
+ case 'overview': {
+ return
;
+ }
case 'headers': {
return
;
}
@@ -128,11 +125,8 @@ const CollectionSettings = ({ collection }) => {
/>
);
}
- case 'docs': {
- return
;
- }
- case 'info': {
- return
;
+ case 'grpc': {
+ return
;
}
}
};
@@ -144,8 +138,11 @@ const CollectionSettings = ({ collection }) => {
};
return (
-
+
+
setTab('overview')}>
+ Overview
+
setTab('headers')}>
Headers
{activeHeadersCount > 0 && {activeHeadersCount} }
@@ -156,36 +153,35 @@ const CollectionSettings = ({ collection }) => {
setTab('auth')}>
Auth
- {auth !== 'none' &&
setTab('script')}>
Script
- {hasScripts &&
setTab('tests')}>
Tests
- {hasTests &&
setTab('presets')}>
Presets
setTab('proxy')}>
Proxy
- {Object.keys(proxyConfig).length > 0 &&
setTab('clientCert')}>
Client Certificates
- {clientCertConfig.length > 0 &&
-
setTab('docs')}>
- Docs
- {hasDocs &&
-
setTab('info')}>
- Info
+ {clientCertConfig.length > 0 &&
+ {isGrpcEnabled && (
+
setTab('grpc')}>
+ gRPC
+ {grpcConfig.protoFiles && grpcConfig.protoFiles.length > 0 &&
+ )}
);
};
diff --git a/packages/bruno-app/src/components/Cookies/ModifyCookieModal/StyledWrapper.js b/packages/bruno-app/src/components/Cookies/ModifyCookieModal/StyledWrapper.js
new file mode 100644
index 000000000..ec278887d
--- /dev/null
+++ b/packages/bruno-app/src/components/Cookies/ModifyCookieModal/StyledWrapper.js
@@ -0,0 +1,5 @@
+import styled from 'styled-components';
+
+const StyledWrapper = styled.div``;
+
+export default StyledWrapper;
diff --git a/packages/bruno-app/src/components/Cookies/ModifyCookieModal/index.js b/packages/bruno-app/src/components/Cookies/ModifyCookieModal/index.js
new file mode 100644
index 000000000..5f7f66867
--- /dev/null
+++ b/packages/bruno-app/src/components/Cookies/ModifyCookieModal/index.js
@@ -0,0 +1,371 @@
+import React, { useState, useRef, useEffect } from 'react';
+import { useFormik } from 'formik';
+import * as Yup from 'yup';
+import Modal from 'components/Modal/index';
+import { modifyCookie, addCookie, getParsedCookie, createCookieString } from 'providers/ReduxStore/slices/app';
+import { useDispatch } from 'react-redux';
+import toast from 'react-hot-toast';
+import ToggleSwitch from 'components/ToggleSwitch/index';
+import { IconInfoCircle } from '@tabler/icons';
+import moment from 'moment';
+import 'moment-timezone';
+import { Tooltip } from 'react-tooltip';
+import { isEmpty } from 'lodash';
+
+const removeEmptyValues = (obj) => {
+ return Object.fromEntries(Object.entries(obj).filter(([_, value]) => value !== null && value !== undefined));
+};
+
+const ModifyCookieModal = ({ onClose, domain, cookie }) => {
+ const dispatch = useDispatch();
+ const [isRawMode, setIsRawMode] = useState(false);
+ const [cookieString, setCookieString] = useState('');
+ const initialParseRef = useRef(false);
+
+ const formik = useFormik({
+ enableReinitialize: true,
+ initialValues: {
+ ...(cookie ? cookie : {}),
+ key: cookie?.key || '',
+ value: cookie?.value || '',
+ path: cookie?.path || '/',
+ domain: cookie?.domain || domain || '',
+ expires: cookie?.expires ? moment(cookie.expires).format(moment.HTML5_FMT.DATETIME_LOCAL) : '',
+ secure: cookie?.secure || false,
+ httpOnly: cookie?.httpOnly || false
+ },
+ validationSchema: Yup.object({
+ key: Yup.string().required('Key is required'),
+ value: Yup.string().required('Value is required'),
+ domain: Yup.string().required('Domain is required'),
+ secure: Yup.boolean(),
+ httpOnly: Yup.boolean(),
+ expires: Yup.mixed()
+ .nullable()
+ .transform((value) => {
+ if (!value || value === '') return null;
+ return moment(value).isValid() ? moment(value).toDate() : null;
+ })
+ .test('future-date', 'Expiration date must be in the future', (value) => {
+ if (!value) return true;
+ return moment(value).isAfter(moment());
+ })
+ }),
+ onSubmit: (values) => {
+ const modValues = removeEmptyValues({
+ ...(cookie ? cookie : {}),
+ ...values,
+ expires: values.expires
+ ? moment(values.expires).isValid()
+ ? moment(values.expires).toDate()
+ : Infinity
+ : Infinity
+ });
+
+ handleCookieDispatch(cookie, domain, modValues, onClose);
+ }
+ });
+
+ const title = cookie ? 'Modify Cookie' : 'Add Cookie';
+
+ const handleCookieDispatch = (cookie, domain, modValues, onClose) => {
+ if (cookie) {
+ dispatch(modifyCookie(domain, cookie, modValues))
+ .then(() => {
+ toast.success('Cookie modified successfully');
+ onClose();
+ })
+ .catch((err) => {
+ toast.error('An error occurred while modifying cookie');
+ console.error(err);
+ });
+ } else {
+ dispatch(addCookie(domain, modValues))
+ .then(() => {
+ toast.success('Cookie added successfully');
+ onClose();
+ })
+ .catch((err) => {
+ toast.error('An error occurred while adding cookie');
+ console.error(err);
+ });
+ }
+ };
+
+ const onSubmit = async () => {
+ try {
+ if (isRawMode) {
+ const cookieObj = await dispatch(getParsedCookie(cookieString));
+
+ const modifiedCookie = removeEmptyValues({
+ ...formik.values,
+ ...cookieObj,
+ expires: cookieObj?.expires
+ ? moment(cookieObj.expires).isValid()
+ ? moment(cookieObj.expires).toDate()
+ : Infinity
+ : Infinity
+ });
+
+ if (!cookieObj) {
+ toast.error('Please enter a valid cookie string');
+ return;
+ }
+
+ const validationErrors = await formik.setValues(
+ (values) => ({
+ ...values,
+ ...modifiedCookie,
+ expires:
+ modifiedCookie?.expires && moment(modifiedCookie.expires).isValid()
+ ? moment(new Date(modifiedCookie.expires)).format(moment.HTML5_FMT.DATETIME_LOCAL)
+ : ''
+ }),
+ true
+ );
+
+ if (!isEmpty(validationErrors)) {
+ toast.error(Object.values(validationErrors).join("\n"));
+ return;
+ }
+
+ handleCookieDispatch(cookie, domain, modifiedCookie, onClose);
+ } else {
+ formik.handleSubmit();
+ }
+ } catch (error) {
+ const errMsg = error.message || 'An error occurred while parsing cookie string';
+ toast.error(errMsg);
+ }
+ };
+
+ useEffect(() => {
+ if (!isRawMode) return;
+ const loadCookieString = async () => {
+ if (cookie) {
+ const str = await dispatch(createCookieString(cookie));
+ setCookieString(str);
+ }
+ return '';
+ };
+
+ loadCookieString();
+ }, [cookie, isRawMode]);
+
+ // create the cookieString when raw mode is enabled
+ useEffect(() => {
+ if (isRawMode) {
+ const createCookieStr = async () => {
+ const str = await dispatch(createCookieString(formik.values));
+ setCookieString(str);
+ };
+
+ createCookieStr();
+ }
+ }, [isRawMode, formik.values]);
+
+ useEffect(() => {
+ // Reset the ref when raw mode changes
+ if (isRawMode) {
+ initialParseRef.current = false;
+ return;
+ }
+
+ const setParsedCookie = async () => {
+ if (!isRawMode && cookieString && !initialParseRef.current) {
+ initialParseRef.current = true;
+
+ try {
+ const cookieObj = await dispatch(getParsedCookie(cookieString));
+
+ if (!cookieObj) return;
+
+ formik.setValues(
+ (values) => ({
+ ...values,
+ ...removeEmptyValues(cookieObj),
+ expires:
+ cookieObj?.expires && moment(cookieObj.expires).isValid()
+ ? moment(new Date(cookieObj.expires)).format(moment.HTML5_FMT.DATETIME_LOCAL)
+ : ''
+ }),
+ true
+ );
+ } catch (error) {
+ const errMsg = error.message || 'An error occurred while parsing cookie string';
+ toast.error(errMsg);
+ }
+ }
+ };
+
+ setParsedCookie();
+ }, [isRawMode, cookieString, dispatch, formik]);
+
+ return (
+
+ {title}
+
+ {
+ setIsRawMode(e.target.checked);
+ }}
+ />
+ Edit Raw
+
+
+ }
+ >
+
-
-
+
+
+
+
);
};
diff --git a/packages/bruno-app/src/components/Sidebar/StyledWrapper.js b/packages/bruno-app/src/components/Sidebar/StyledWrapper.js
index e64c7a3f4..8bbe696fe 100644
--- a/packages/bruno-app/src/components/Sidebar/StyledWrapper.js
+++ b/packages/bruno-app/src/components/Sidebar/StyledWrapper.js
@@ -5,6 +5,7 @@ const Wrapper = styled.div`
aside {
background-color: ${(props) => props.theme.sidebar.bg};
+ overflow: hidden;
.collection-title {
line-height: 1.5;
@@ -50,6 +51,7 @@ const Wrapper = styled.div`
background-color: transparent;
width: 6px;
right: -3px;
+ transition: opacity 0.2s ease;
&:hover div.drag-request-border {
width: 2px;
diff --git a/packages/bruno-app/src/components/Sidebar/TitleBar/index.js b/packages/bruno-app/src/components/Sidebar/TitleBar/index.js
index bbd88fbcf..65badf3aa 100644
--- a/packages/bruno-app/src/components/Sidebar/TitleBar/index.js
+++ b/packages/bruno-app/src/components/Sidebar/TitleBar/index.js
@@ -11,21 +11,19 @@ import { useDispatch } from 'react-redux';
import { showHomePage } from 'providers/ReduxStore/slices/app';
import { openCollection, importCollection } from 'providers/ReduxStore/slices/collections/actions';
import StyledWrapper from './StyledWrapper';
+import { multiLineMsg } from "utils/common";
+import { formatIpcError } from "utils/common/error";
const TitleBar = () => {
const [importedCollection, setImportedCollection] = useState(null);
- const [importedTranslationLog, setImportedTranslationLog] = useState({});
const [createCollectionModalOpen, setCreateCollectionModalOpen] = useState(false);
const [importCollectionModalOpen, setImportCollectionModalOpen] = useState(false);
const [importCollectionLocationModalOpen, setImportCollectionLocationModalOpen] = useState(false);
const dispatch = useDispatch();
const { ipcRenderer } = window;
- const handleImportCollection = ({ collection, translationLog }) => {
+ const handleImportCollection = ({ collection }) => {
setImportedCollection(collection);
- if (translationLog) {
- setImportedTranslationLog(translationLog);
- }
setImportCollectionModalOpen(false);
setImportCollectionLocationModalOpen(true);
};
@@ -38,9 +36,8 @@ const TitleBar = () => {
toast.success('Collection imported successfully');
})
.catch((err) => {
- setImportCollectionLocationModalOpen(false);
console.error(err);
- toast.error('An error occurred while importing the collection. Check the logs for more information.');
+ toast.error(multiLineMsg('An error occurred while importing the collection.', formatIpcError(err)));
});
};
@@ -75,7 +72,6 @@ const TitleBar = () => {
{importCollectionLocationModalOpen ? (
setImportCollectionLocationModalOpen(false)}
handleSubmit={handleImportCollectionLocation}
/>
diff --git a/packages/bruno-app/src/components/Sidebar/index.js b/packages/bruno-app/src/components/Sidebar/index.js
index 4163ffc37..fd0423bcd 100644
--- a/packages/bruno-app/src/components/Sidebar/index.js
+++ b/packages/bruno-app/src/components/Sidebar/index.js
@@ -1,44 +1,37 @@
import TitleBar from './TitleBar';
import Collections from './Collections';
import StyledWrapper from './StyledWrapper';
-import Preferences from 'components/Preferences';
-import Cookies from 'components/Cookies';
-import ToolHint from 'components/ToolHint';
-import GoldenEdition from './GoldenEdition';
-import { useState, useEffect } from 'react';
+import { useState, useEffect, useRef } from 'react';
import { useSelector, useDispatch } from 'react-redux';
-import { IconSettings, IconCookie, IconHeart } from '@tabler/icons';
-import { updateLeftSidebarWidth, updateIsDragging, showPreferences } from 'providers/ReduxStore/slices/app';
-import { useTheme } from 'providers/Theme';
-import Notifications from 'components/Notifications';
+import { updateLeftSidebarWidth, updateIsDragging } from 'providers/ReduxStore/slices/app';
const MIN_LEFT_SIDEBAR_WIDTH = 221;
const MAX_LEFT_SIDEBAR_WIDTH = 600;
const Sidebar = () => {
const leftSidebarWidth = useSelector((state) => state.app.leftSidebarWidth);
- const preferencesOpen = useSelector((state) => state.app.showPreferences);
- const [goldenEditionOpen, setGoldenEditionOpen] = useState(false);
-
+ const sidebarCollapsed = useSelector((state) => state.app.sidebarCollapsed);
const [asideWidth, setAsideWidth] = useState(leftSidebarWidth);
- const [cookiesOpen, setCookiesOpen] = useState(false);
-
- const { storedTheme } = useTheme();
+ const lastWidthRef = useRef(leftSidebarWidth);
const dispatch = useDispatch();
const [dragging, setDragging] = useState(false);
+ const currentWidth = sidebarCollapsed ? 0 : asideWidth;
+
+ // Clamp helper keeps width in allowed range
+ const clamp = (value, min, max) => Math.min(max, Math.max(min, value));
+
const handleMouseMove = (e) => {
- if (dragging) {
- e.preventDefault();
- let width = e.clientX + 2;
- if (width < MIN_LEFT_SIDEBAR_WIDTH || width > MAX_LEFT_SIDEBAR_WIDTH) {
- return;
- }
- setAsideWidth(width);
- }
+ if (!dragging || sidebarCollapsed) return;
+ e.preventDefault();
+ const nextWidth = clamp(e.clientX + 2, MIN_LEFT_SIDEBAR_WIDTH, MAX_LEFT_SIDEBAR_WIDTH);
+ if (Math.abs(nextWidth - lastWidthRef.current) < 3) return;
+ lastWidthRef.current = nextWidth;
+ setAsideWidth(nextWidth);
};
+
const handleMouseUp = (e) => {
if (dragging) {
e.preventDefault();
@@ -57,6 +50,9 @@ const Sidebar = () => {
};
const handleDragbarMouseDown = (e) => {
e.preventDefault();
+ if (sidebarCollapsed) {
+ return;
+ }
setDragging(true);
dispatch(
updateIsDragging({
@@ -80,119 +76,23 @@ const Sidebar = () => {
}, [leftSidebarWidth]);
return (
-
-
- {goldenEditionOpen && (
- {
- setGoldenEditionOpen(false);
- document.querySelector('[data-trigger="golden-edition"]').focus();
- }}
- aria-modal="true"
- role="dialog"
- aria-labelledby="golden-edition-title"
- aria-describedby="golden-edition-description"
- />
- )}
-
- {preferencesOpen && (
-
{
- dispatch(showPreferences(false));
- document.querySelector('[data-trigger="preferences"]').focus();
- }}
- aria-modal="true"
- role="dialog"
- aria-labelledby="preferences-title"
- aria-describedby="preferences-description"
- />
- )}
- {cookiesOpen && (
- {
- setCookiesOpen(false);
- document.querySelector('[data-trigger="cookies"]').focus();
- }}
- aria-modal="true"
- role="dialog"
- aria-labelledby="cookies-title"
- aria-describedby="cookies-description"
- />
- )}
-
+
+
+
-
-
-
-
- {/* This will get moved to home page */}
- {/*
- Star
- */}
-
-
v1.36.0
-
-
+ {!sidebarCollapsed && (
+
+ )}
);
};
diff --git a/packages/bruno-app/src/components/SingleLineEditor/StyledWrapper.js b/packages/bruno-app/src/components/SingleLineEditor/StyledWrapper.js
index 592a75b28..3398cb5ff 100644
--- a/packages/bruno-app/src/components/SingleLineEditor/StyledWrapper.js
+++ b/packages/bruno-app/src/components/SingleLineEditor/StyledWrapper.js
@@ -26,6 +26,11 @@ const StyledWrapper = styled.div`
.CodeMirror-lines {
padding: 0;
+
+ .CodeMirror-placeholder {
+ color: ${(props) => props.theme.codemirror.placeholder.color} !important;
+ opacity: ${(props) => props.theme.codemirror.placeholder.opacity} !important
+ }
}
.CodeMirror-cursor {
diff --git a/packages/bruno-app/src/components/SingleLineEditor/index.js b/packages/bruno-app/src/components/SingleLineEditor/index.js
index 16413bdf3..c29558df5 100644
--- a/packages/bruno-app/src/components/SingleLineEditor/index.js
+++ b/packages/bruno-app/src/components/SingleLineEditor/index.js
@@ -2,15 +2,11 @@ import React, { Component } from 'react';
import isEqual from 'lodash/isEqual';
import { getAllVariables } from 'utils/collections';
import { defineCodeMirrorBrunoVariablesMode, MaskedEditor } from 'utils/common/codemirror';
+import { setupAutoComplete } from 'utils/codemirror/autocomplete';
import StyledWrapper from './StyledWrapper';
import { IconEye, IconEyeOff } from '@tabler/icons';
-let CodeMirror;
-const SERVER_RENDERED = typeof window === 'undefined' || global['PREVENT_CODEMIRROR_RENDER'] === true;
-
-if (!SERVER_RENDERED) {
- CodeMirror = require('codemirror');
-}
+const CodeMirror = require('codemirror');
class SingleLineEditor extends Component {
constructor(props) {
@@ -26,6 +22,7 @@ class SingleLineEditor extends Component {
maskInput: props.isSecret || false // Always mask the input by default (if it's a secret)
};
}
+
componentDidMount() {
// Initialize CodeMirror as a single line editor
/** @type {import("codemirror").Editor} */
@@ -44,6 +41,7 @@ class SingleLineEditor extends Component {
const noopHandler = () => {};
this.editor = CodeMirror(this.editorRef.current, {
+ placeholder: this.props.placeholder ?? '',
lineWrapping: false,
lineNumbers: false,
theme: this.props.theme === 'dark' ? 'monokai' : 'default',
@@ -75,16 +73,26 @@ class SingleLineEditor extends Component {
'Shift-Tab': false
}
});
- if (this.props.autocomplete) {
- this.editor.on('keyup', (cm, event) => {
- if (!cm.state.completionActive /*Enables keyboard navigation in autocomplete list*/ && event.key !== 'Enter') {
- /*Enter - do not open autocomplete list just after item has been selected in it*/
- CodeMirror.commands.autocomplete(cm, CodeMirror.hint.anyword, { autocomplete: this.props.autocomplete });
- }
- });
- }
- this.editor.setValue(String(this.props.value) || '');
+
+ const getAllVariablesHandler = () => getAllVariables(this.props.collection, this.props.item);
+ const getAnywordAutocompleteHints = () => this.props.autocomplete || [];
+
+ // Setup AutoComplete Helper
+ const autoCompleteOptions = {
+ getAllVariables: getAllVariablesHandler,
+ getAnywordAutocompleteHints,
+ showHintsFor: this.props.showHintsFor || ['variables'],
+ showHintsOnClick: this.props.showHintsOnClick
+ };
+
+ this.brunoAutoCompleteCleanup = setupAutoComplete(
+ this.editor,
+ autoCompleteOptions
+ );
+
+ this.editor.setValue(String(this.props.value ?? ''));
this.editor.on('change', this._onEdit);
+ this.editor.on('paste', this._onPaste);
this.addOverlay(variables);
this._enableMaskedEditor(this.props.isSecret);
this.setState({ maskInput: this.props.isSecret });
@@ -94,7 +102,6 @@ class SingleLineEditor extends Component {
_enableMaskedEditor = (enabled) => {
if (typeof enabled !== 'boolean') return;
- console.log('Enabling masked editor: ' + enabled);
if (enabled == true) {
if (!this.maskedEditor) this.maskedEditor = new MaskedEditor(this.editor, '*');
this.maskedEditor.enable();
@@ -107,12 +114,14 @@ class SingleLineEditor extends Component {
_onEdit = () => {
if (!this.ignoreChangeEvent && this.editor) {
this.cachedValue = this.editor.getValue();
- if (this.props.onChange) {
+ if (this.props.onChange && (this.props.value !== this.cachedValue)) {
this.props.onChange(this.cachedValue);
}
}
};
+ _onPaste = (_, event) => this.props.onPaste?.(event);
+
componentDidUpdate(prevProps) {
// Ensure the changes caused by this update are not interpreted as
// user-input changes which could otherwise result in an infinite
@@ -129,7 +138,7 @@ class SingleLineEditor extends Component {
}
if (this.props.value !== prevProps.value && this.props.value !== this.cachedValue && this.editor) {
this.cachedValue = String(this.props.value);
- this.editor.setValue(String(this.props.value) || '');
+ this.editor.setValue(String(this.props.value ?? ''));
}
if (!isEqual(this.props.isSecret, prevProps.isSecret)) {
// If the secret flag has changed, update the editor to reflect the change
@@ -141,12 +150,20 @@ class SingleLineEditor extends Component {
}
componentWillUnmount() {
- this.editor.getWrapperElement().remove();
+ if (this.editor) {
+ this.editor.off('change', this._onEdit);
+ this.editor.off('paste', this._onPaste);
+ this.editor.getWrapperElement().remove();
+ this.editor = null;
+ }
+ if (this.brunoAutoCompleteCleanup) {
+ this.brunoAutoCompleteCleanup();
+ }
}
addOverlay = (variables) => {
this.variables = variables;
- defineCodeMirrorBrunoVariablesMode(variables, 'text/plain', this.props.highlightPathParams);
+ defineCodeMirrorBrunoVariablesMode(variables, 'text/plain', this.props.highlightPathParams, true);
this.editor.setOption('mode', 'brunovariables');
};
@@ -174,7 +191,7 @@ class SingleLineEditor extends Component {
render() {
return (
-
+
diff --git a/packages/bruno-app/src/components/StatusBar/StyledWrapper.js b/packages/bruno-app/src/components/StatusBar/StyledWrapper.js
new file mode 100644
index 000000000..4304f37dc
--- /dev/null
+++ b/packages/bruno-app/src/components/StatusBar/StyledWrapper.js
@@ -0,0 +1,75 @@
+import styled from 'styled-components';
+
+const StyledWrapper = styled.div`
+ .status-bar {
+ display: flex;
+ align-items: center;
+ justify-content: space-between;
+ padding: 0 1rem;
+ height: 1.5rem;
+ background: ${(props) => props.theme.sidebar.bg};
+ border-top: 1px solid ${(props) => props.theme.statusBar.border};
+ color: ${(props) => props.theme.statusBar.color};
+ font-size: 0.75rem;
+ user-select: none;
+ position: relative;
+ }
+
+ .status-bar-section {
+ display: flex;
+ align-items: center;
+ position: relative;
+ }
+
+ .status-bar-group {
+ display: flex;
+ align-items: center;
+ gap: 2px;
+ }
+
+ .status-bar-button {
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ padding: 0 4px;
+ cursor: pointer;
+ position: relative;
+ outline: none;
+ }
+
+ .console-button-content {
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ gap: 0.25rem;
+ position: relative;
+ }
+
+ .console-label {
+ white-space: nowrap;
+ }
+
+ .error-count-inline {
+ font-size: 10px;
+ font-weight: 600;
+ color: ${(props) => props.theme.colors.text.danger};
+ background: ${(props) => props.theme.colors.bg.danger}20;
+ padding: 1px 4px;
+ border-radius: 4px;
+ }
+
+ .status-bar-divider {
+ width: 1px;
+ height: 16px;
+ background: ${(props) => props.theme.sidebar.dragbar};
+ opacity: 0.4;
+ }
+
+ .status-bar-version {
+ display: flex;
+ align-items: center;
+ padding: 2px 6px;
+ }
+`;
+
+export default StyledWrapper;
\ No newline at end of file
diff --git a/packages/bruno-app/src/components/StatusBar/index.js b/packages/bruno-app/src/components/StatusBar/index.js
new file mode 100644
index 000000000..a98db747b
--- /dev/null
+++ b/packages/bruno-app/src/components/StatusBar/index.js
@@ -0,0 +1,137 @@
+import React, { useState } from 'react';
+import { useSelector, useDispatch } from 'react-redux';
+import { IconSettings, IconCookie, IconTool } from '@tabler/icons';
+import IconSidebarToggle from 'components/Icons/IconSidebarToggle';
+import ToolHint from 'components/ToolHint';
+import Preferences from 'components/Preferences';
+import Cookies from 'components/Cookies';
+import Notifications from 'components/Notifications';
+import Portal from 'components/Portal';
+import { showPreferences, toggleSidebarCollapse } from 'providers/ReduxStore/slices/app';
+import { openConsole } from 'providers/ReduxStore/slices/logs';
+import { useApp } from 'providers/App';
+import StyledWrapper from './StyledWrapper';
+
+const StatusBar = () => {
+ const dispatch = useDispatch();
+ const preferencesOpen = useSelector((state) => state.app.showPreferences);
+ const logs = useSelector((state) => state.logs.logs);
+ const sidebarCollapsed = useSelector((state) => state.app.sidebarCollapsed);
+ const [cookiesOpen, setCookiesOpen] = useState(false);
+ const { version } = useApp();
+
+ const errorCount = logs.filter(log => log.type === 'error').length;
+
+ const handleConsoleClick = () => {
+ dispatch(openConsole());
+ };
+
+ return (
+
+ {preferencesOpen && (
+
+ {
+ dispatch(showPreferences(false));
+ document.querySelector('[data-trigger="preferences"]').focus();
+ }}
+ aria-modal="true"
+ role="dialog"
+ aria-labelledby="preferences-title"
+ aria-describedby="preferences-description"
+ />
+
+ )}
+
+ {cookiesOpen && (
+
+ {
+ setCookiesOpen(false);
+ document.querySelector('[data-trigger="cookies"]').focus();
+ }}
+ aria-modal="true"
+ role="dialog"
+ aria-labelledby="cookies-title"
+ aria-describedby="cookies-description"
+ />
+
+ )}
+
+
+
+
+
+ dispatch(toggleSidebarCollapse())}
+ >
+
+
+
+
+ dispatch(showPreferences(true))}
+ tabIndex={0}
+ aria-label="Open Preferences"
+ >
+
+
+
+
+
+
+
+
+
+
+
+
+
setCookiesOpen(true)}
+ tabIndex={0}
+ aria-label="Open Cookies"
+ >
+
+ Cookies
+
+
+
+
0 ? 'has-errors' : ''}`}
+ data-trigger="dev-tools"
+ onClick={handleConsoleClick}
+ tabIndex={0}
+ aria-label={`Open Dev Tools${errorCount > 0 ? ` (${errorCount} errors)` : ''}`}
+ >
+
+ Dev Tools
+ {errorCount > 0 && (
+ {errorCount}
+ )}
+
+
+
+
+
+
+ v{version}
+
+
+
+
+ );
+};
+
+export default StatusBar;
\ No newline at end of file
diff --git a/packages/bruno-app/src/components/StatusDot/index.js b/packages/bruno-app/src/components/StatusDot/index.js
new file mode 100644
index 000000000..d5c090efe
--- /dev/null
+++ b/packages/bruno-app/src/components/StatusDot/index.js
@@ -0,0 +1,15 @@
+import React from 'react';
+import DotIcon from 'components/Icons/Dot';
+
+const StatusDot = ({ type = 'default' }) => (
+
+
+);
+
+
+export default StatusDot;
\ No newline at end of file
diff --git a/packages/bruno-app/src/components/StopWatch/index.js b/packages/bruno-app/src/components/StopWatch/index.js
index debba9cd8..5954106d3 100644
--- a/packages/bruno-app/src/components/StopWatch/index.js
+++ b/packages/bruno-app/src/components/StopWatch/index.js
@@ -1,27 +1,24 @@
import React, { useState, useEffect } from 'react';
-const StopWatch = () => {
- const [milliseconds, setMilliseconds] = useState(0);
-
- const tickInterval = 100;
- const tick = () => {
- setMilliseconds(_milliseconds => _milliseconds + tickInterval);
- };
-
+const StopWatch = ({ startTime }) => {
+ const [currentTime, setCurrentTime] = useState(Date.now());
+
useEffect(() => {
- let timerID = setInterval(() => {
- tick()
- }, tickInterval);
- return () => {
- clearTimeout(timerID);
- };
- }, []);
-
- if (milliseconds < 250) {
- return 'Loading...';
- }
-
- let seconds = milliseconds / 1000;
+ if (!startTime) return;
+
+ const intervalId = setInterval(() => {
+ setCurrentTime(Date.now());
+ }, 100);
+
+ return () => clearInterval(intervalId);
+ }, [startTime]);
+
+ if (!startTime) return
Loading... ;
+
+ const elapsedTime = currentTime - startTime;
+ if (elapsedTime < 250) return
Loading... ;
+
+ const seconds = elapsedTime / 1000;
return
{seconds.toFixed(1)}s ;
};
diff --git a/packages/bruno-app/src/components/Tab/index.js b/packages/bruno-app/src/components/Tab/index.js
new file mode 100644
index 000000000..dd74c9261
--- /dev/null
+++ b/packages/bruno-app/src/components/Tab/index.js
@@ -0,0 +1,22 @@
+import React from 'react';
+import classnames from 'classnames';
+
+const Tab = ({ name, label, isActive, onClick, count = 0, className = '', ...props }) => {
+ const tabClassName = classnames("tab select-none", {
+ active: isActive
+ }, className);
+
+ return (
+
onClick(name)}
+ {...props}
+ >
+ {label}
+ {count > 0 && {count} }
+
+ );
+};
+
+export default Tab;
\ No newline at end of file
diff --git a/packages/bruno-app/src/components/Table/StyledWrapper.js b/packages/bruno-app/src/components/Table/StyledWrapper.js
index eeead4ed2..5e7132c16 100644
--- a/packages/bruno-app/src/components/Table/StyledWrapper.js
+++ b/packages/bruno-app/src/components/Table/StyledWrapper.js
@@ -6,12 +6,10 @@ const StyledWrapper = styled.div`
display: grid;
overflow-y: hidden;
overflow-x: auto;
+ padding: 0 1.5px;
// for icon hover
position: inherit;
- left: -4px;
- padding-left: 4px;
- padding-right: 4px;
grid-template-columns: ${({ columns }) =>
columns?.[0]?.width
diff --git a/packages/bruno-app/src/components/Table/index.js b/packages/bruno-app/src/components/Table/index.js
index 7c9b48d7d..4944276c6 100644
--- a/packages/bruno-app/src/components/Table/index.js
+++ b/packages/bruno-app/src/components/Table/index.js
@@ -86,7 +86,7 @@ const Table = ({ minColumnWidth = 1, headers = [], children }) => {
return (
-
+
{columns.map(({ ref, name }, i) => (
diff --git a/packages/bruno-app/src/components/TagList/StyledWrapper.js b/packages/bruno-app/src/components/TagList/StyledWrapper.js
new file mode 100644
index 000000000..c81897a27
--- /dev/null
+++ b/packages/bruno-app/src/components/TagList/StyledWrapper.js
@@ -0,0 +1,132 @@
+import styled from 'styled-components';
+
+const StyledWrapper = styled.div`
+ .tags-container {
+ display: flex;
+ flex-wrap: wrap;
+ gap: 8px;
+ min-height: 40px;
+ padding: 8px 0;
+ }
+
+ .tag-item {
+ display: inline-flex;
+ align-items: center;
+ gap: 6px;
+ padding: 3px 7px;
+ background-color: ${(props) => props.theme.sidebar.bg};
+ border: 1px solid ${(props) => props.theme.requestTabs.bottomBorder};
+ border-radius: 3px;
+ font-size: 12px;
+ font-weight: 500;
+ color: ${(props) => props.theme.text};
+ max-width: 200px;
+ transition: all 0.2s ease;
+ box-shadow: 0 1px 2px rgba(0, 0, 0, 0.05);
+
+ &:hover {
+ background-color: ${(props) => props.theme.requestTabs.active.bg};
+ border-color: ${(props) => props.theme.requestTabs.active.border || props.theme.requestTabs.bottomBorder};
+ box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+ transform: translateY(-1px);
+ }
+ }
+
+ .tag-icon {
+ color: ${(props) => props.theme.textSecondary || props.theme.text};
+ opacity: 0.7;
+ flex-shrink: 0;
+ }
+
+ .tag-text {
+ flex: 1;
+ overflow: hidden;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+ min-width: 0;
+ }
+
+ .tag-remove {
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ background: none;
+ border: none;
+ cursor: pointer;
+ padding: 2px;
+ border-radius: 3px;
+ color: ${(props) => props.theme.textSecondary || props.theme.text};
+ transition: all 0.2s ease;
+ flex-shrink: 0;
+ opacity: 0.7;
+
+ &:hover {
+ background-color: ${(props) => props.theme.danger};
+ color: white;
+ opacity: 1;
+ transform: scale(1.1);
+ }
+
+ &:focus-visible {
+ outline: 2px solid ${(props) => props.theme.danger};
+ outline-offset: 1px;
+ }
+ }
+
+ .empty-state {
+ display: flex;
+ align-items: center;
+ gap: 12px;
+ padding: 24px 16px;
+ background-color: ${(props) => props.theme.sidebar.bg};
+ border: 2px dashed ${(props) => props.theme.requestTabs.bottomBorder};
+ border-radius: 3px;
+ color: ${(props) => props.theme.textSecondary || props.theme.text};
+ text-align: left;
+ }
+
+ .empty-icon {
+ opacity: 0.5;
+ flex-shrink: 0;
+ }
+
+ .empty-text {
+ flex: 1;
+ min-width: 0;
+ }
+
+ .empty-title {
+ font-weight: 600;
+ margin: 0 0 4px 0;
+ font-size: 14px;
+ color: ${(props) => props.theme.text};
+ }
+
+ .empty-subtitle {
+ margin: 0;
+ font-size: 12px;
+ opacity: 0.8;
+ line-height: 1.5;
+ color: ${(props) => props.theme.textSecondary || props.theme.text};
+ }
+
+ /* Responsive design */
+ @media (max-width: 480px) {
+ .tags-container {
+ gap: 6px;
+ }
+
+ .tag-item {
+ padding: 4px 8px;
+ font-size: 11px;
+ }
+
+ .empty-state {
+ padding: 16px 12px;
+ flex-direction: column;
+ text-align: center;
+ }
+ }
+`;
+
+export default StyledWrapper;
\ No newline at end of file
diff --git a/packages/bruno-app/src/components/TagList/index.js b/packages/bruno-app/src/components/TagList/index.js
new file mode 100644
index 000000000..e683a0a41
--- /dev/null
+++ b/packages/bruno-app/src/components/TagList/index.js
@@ -0,0 +1,77 @@
+import { useState } from 'react';
+import { IconX, IconTag } from '@tabler/icons';
+import StyledWrapper from './StyledWrapper';
+import SingleLineEditor from 'components/SingleLineEditor/index';
+import { useTheme } from 'providers/Theme/index';
+
+const TagList = ({ tagsHintList = [], handleAddTag, tags, handleRemoveTag, onSave, handleValidation }) => {
+ const { displayedTheme } = useTheme();
+ const tagNameRegex = /^[\w-]+$/;
+ const [text, setText] = useState('');
+ const [error, setError] = useState('');
+
+ const handleInputChange = (value) => {
+ setError('');
+ setText(value);
+ };
+
+ const handleKeyDown = (e) => {
+ if (!tagNameRegex.test(text)) {
+ setError('Tags must only contain alpha-numeric characters, "-", "_"');
+ return;
+ }
+ if (tags.includes(text)) {
+ setError(`Tag "${text}" already exists`);
+ return;
+ }
+ if (handleValidation) {
+ const error = handleValidation(text);
+ if (error) {
+ setError(error);
+ setText('');
+ return;
+ }
+ }
+ handleAddTag(text);
+ setText('');
+ };
+
+ return (
+
+ {error} }
+
+ {tags && tags.length
+ ? tags.map((_tag) => (
+
+ handleRemoveTag(_tag)}
+ type="button"
+ >
+
+ {_tag}
+
+
+
+ ))
+ : null}
+
+
+ );
+};
+
+export default TagList;
diff --git a/packages/bruno-app/src/components/ToggleSwitch/StyledWrapper.js b/packages/bruno-app/src/components/ToggleSwitch/StyledWrapper.js
new file mode 100644
index 000000000..d4216860a
--- /dev/null
+++ b/packages/bruno-app/src/components/ToggleSwitch/StyledWrapper.js
@@ -0,0 +1,91 @@
+import styled from 'styled-components';
+
+const switchSizes = {
+ '2xs': { width: 32, height: 16, buttonSize: 14 },
+ xs: { width: 40, height: 20, buttonSize: 18 },
+ s: { width: 44, height: 22, buttonSize: 20 },
+ m: { width: 50, height: 24, buttonSize: 22 }, // default size
+ l: { width: 56, height: 28, buttonSize: 26 },
+ xl: { width: 64, height: 32, buttonSize: 30 },
+ '2xl': { width: 72, height: 36, buttonSize: 34 }
+};
+
+const getSizeValues = (size = 'm') => switchSizes[size] || switchSizes.m;
+
+export const Switch = styled.div`
+ position: relative;
+ display: inline-block;
+ width: ${(props) => getSizeValues(props.size).width}px;
+ height: ${(props) => getSizeValues(props.size).height}px;
+ border-radius: ${(props) => getSizeValues(props.size).height}px;
+`;
+
+export const Checkbox = styled.input`
+ opacity: 0;
+ width: 0;
+ height: 0;
+
+ &:checked + label div {
+ background-color: ${(props) => props.theme.textLink};
+ }
+
+ &:checked + label div:before {
+ transform: translateX(${(props) => getSizeValues(props.size).width - getSizeValues(props.size).buttonSize - 2}px);
+ }
+`;
+
+export const Label = styled.label`
+ position: absolute;
+ top: 0;
+ left: 0;
+ width: 100%;
+ height: 100%;
+ cursor: pointer;
+ background-color: ${(props) => props.theme.input.bg};
+ border-radius: 24px;
+
+ div {
+ position: absolute;
+ top: 0;
+ left: 0;
+ width: 100%;
+ height: 100%;
+ background-color: ${(props) => props.theme.colors.text.muted};
+ border-radius: 24px;
+ transition: transform 0.2s;
+ }
+`;
+
+export const Inner = styled.div`
+ position: absolute;
+ top: 2px;
+ left: 2px;
+ right: 2px;
+ bottom: 2px;
+ background-color: #fafafa;
+ transition: 0.4s;
+ border-radius: ${(props) => getSizeValues(props.size).height - 2}px;
+`;
+
+export const SwitchButton = styled.div`
+ position: absolute;
+ height: ${(props) => getSizeValues(props.size).buttonSize}px;
+ width: ${(props) => getSizeValues(props.size).buttonSize}px;
+ left: 2px;
+ bottom: 2px;
+ background-color: white;
+ transition: 0.4s;
+ border-radius: 50%;
+
+ &:before {
+ content: '';
+ position: absolute;
+ height: ${(props) => getSizeValues(props.size).buttonSize - 2}px;
+ width: ${(props) => getSizeValues(props.size).buttonSize - 2}px;
+ background-color: white;
+ top: 2px;
+ left: 2px;
+ transition: 0.4s;
+ border-radius: 50%;
+ }
+`;
diff --git a/packages/bruno-app/src/components/ToggleSwitch/index.js b/packages/bruno-app/src/components/ToggleSwitch/index.js
new file mode 100644
index 000000000..bb3679038
--- /dev/null
+++ b/packages/bruno-app/src/components/ToggleSwitch/index.js
@@ -0,0 +1,15 @@
+import { Checkbox, Inner, Label, Switch, SwitchButton } from './StyledWrapper';
+
+const ToggleSwitch = ({ isOn, handleToggle, size = 'm', ...props }) => {
+ return (
+
+ {}} />
+
+
+
+ );
+};
+
+export default ToggleSwitch;
diff --git a/packages/bruno-app/src/components/ToolHint/index.js b/packages/bruno-app/src/components/ToolHint/index.js
index b8799dd69..3d559625e 100644
--- a/packages/bruno-app/src/components/ToolHint/index.js
+++ b/packages/bruno-app/src/components/ToolHint/index.js
@@ -34,7 +34,7 @@ const ToolHint = ({
{
const reactInspectorTheme = storedTheme === 'light' ? 'chromeLight' : 'chromeDark';
return (
-
+
Note: As of today, runtime variables can only be set via the API - getVar() {' '}
and setVar() .
);
diff --git a/packages/bruno-app/src/components/Welcome/index.js b/packages/bruno-app/src/components/Welcome/index.js
index 64100224c..fd8cbd756 100644
--- a/packages/bruno-app/src/components/Welcome/index.js
+++ b/packages/bruno-app/src/components/Welcome/index.js
@@ -1,8 +1,9 @@
import { useState } from 'react';
import toast from 'react-hot-toast';
-import { useDispatch } from 'react-redux';
+import { useDispatch, useSelector } from 'react-redux';
import { useTranslation } from 'react-i18next';
import { openCollection, importCollection } from 'providers/ReduxStore/slices/collections/actions';
+
import { IconBrandGithub, IconPlus, IconDownload, IconFolders, IconSpeakerphone, IconBook } from '@tabler/icons';
import Bruno from 'components/Bruno';
@@ -14,21 +15,23 @@ import StyledWrapper from './StyledWrapper';
const Welcome = () => {
const dispatch = useDispatch();
const { t } = useTranslation();
+ const sidebarCollapsed = useSelector((state) => state.app.sidebarCollapsed);
+ const collections = useSelector((state) => state.collections.collections);
const [importedCollection, setImportedCollection] = useState(null);
- const [importedTranslationLog, setImportedTranslationLog] = useState({});
const [createCollectionModalOpen, setCreateCollectionModalOpen] = useState(false);
const [importCollectionModalOpen, setImportCollectionModalOpen] = useState(false);
const [importCollectionLocationModalOpen, setImportCollectionLocationModalOpen] = useState(false);
const handleOpenCollection = () => {
- dispatch(openCollection()).catch((err) => console.log(err) && toast.error(t('WELCOME.COLLECTION_OPEN_ERROR')));
+ dispatch(openCollection())
+ .catch((err) => {
+ console.error(err);
+ toast.error(t('WELCOME.COLLECTION_OPEN_ERROR'));
+ });
};
- const handleImportCollection = ({ collection, translationLog }) => {
+ const handleImportCollection = ({ collection }) => {
setImportedCollection(collection);
- if (translationLog) {
- setImportedTranslationLog(translationLog);
- }
setImportCollectionModalOpen(false);
setImportCollectionLocationModalOpen(true);
};
@@ -55,7 +58,6 @@ const Welcome = () => {
) : null}
{importCollectionLocationModalOpen ? (
setImportCollectionLocationModalOpen(false)}
handleSubmit={handleImportCollectionLocation}
diff --git a/packages/bruno-app/src/hooks/useDetectSensitiveField/index.js b/packages/bruno-app/src/hooks/useDetectSensitiveField/index.js
new file mode 100644
index 000000000..257b116e9
--- /dev/null
+++ b/packages/bruno-app/src/hooks/useDetectSensitiveField/index.js
@@ -0,0 +1,67 @@
+import { useMemo } from 'react';
+
+const VARIABLE_NAME_REGEX = /\{\{([^}]+)\}\}/g;
+const ENV_VAR_REFERENCE_REGEX = /^\s*\{\{.*\}\}\s*$/;
+
+export const useDetectSensitiveField = (collection) => {
+ const envVars = useMemo(() => {
+ if (!collection) {
+ return [];
+ }
+ const activeEnv = collection?.environments?.find((env) => env.uid === collection.activeEnvironmentUid);
+ if (!activeEnv || !Array.isArray(activeEnv.variables)) {
+ return [];
+ }
+ return activeEnv.variables;
+ }, [collection]);
+
+ // Checks if the value is a single environment variable reference (e.g., {{API_KEY}})
+ const isEnvVarReference = (value) => {
+ return typeof value === 'string' && ENV_VAR_REFERENCE_REGEX.test(value);
+ };
+
+ // Extracts all variable names from a string (e.g., "Bearer {{TOKEN}}-{{SUFFIX}}" → ["TOKEN", "SUFFIX"])
+ const extractVarNames = (value) => {
+ if (!value || typeof value !== 'string') {
+ return [];
+ }
+ const matches = [];
+ let match;
+ while ((match = VARIABLE_NAME_REGEX.exec(value)) !== null) {
+ matches.push(match[1].trim());
+ }
+ return matches;
+ };
+
+ // Checks if a variable is present and not marked as secret in the environment
+ const isVarNotSecret = (varName, envVars = []) => {
+ const found = envVars.find((v) => v.name === varName);
+ return found && !found.secret;
+ };
+
+ const isSensitive = (value) => {
+ if (value && !isEnvVarReference(value)) {
+ return {
+ showWarning: true,
+ warningMessage: 'Store sensitive info as a secret variable or in a .env file'
+ };
+ }
+
+ if (value && typeof value === 'string') {
+ const varNames = extractVarNames(value);
+ if (varNames.some((varName) => isVarNotSecret(varName, envVars))) {
+ return {
+ showWarning: true,
+ warningMessage: 'Mark the environment variable as secret for better security.'
+ };
+ }
+ }
+
+ // No warning needed
+ return { showWarning: false };
+ };
+
+ return {
+ isSensitive
+ };
+};
diff --git a/packages/bruno-app/src/hooks/useOnClickOutside/index.js b/packages/bruno-app/src/hooks/useOnClickOutside/index.js
index 25cd5b426..2dbef75f2 100644
--- a/packages/bruno-app/src/hooks/useOnClickOutside/index.js
+++ b/packages/bruno-app/src/hooks/useOnClickOutside/index.js
@@ -5,7 +5,7 @@ const useOnClickOutside = (ref, handler) => {
useEffect(
() => {
const listener = (event) => {
- // Do nothing if clicking ref's element or descendent elements
+ // Do nothing if clicking ref's element or descendant elements
if (!ref.current || ref.current.contains(event.target)) {
return;
}
diff --git a/packages/bruno-app/src/index.js b/packages/bruno-app/src/index.js
index 0e5187ebe..36b1d0bc6 100644
--- a/packages/bruno-app/src/index.js
+++ b/packages/bruno-app/src/index.js
@@ -1,6 +1,8 @@
import React from 'react';
import ReactDOM from 'react-dom/client';
import App from './pages/index';
+import { DndProvider } from 'react-dnd';
+import { HTML5Backend } from 'react-dnd-html5-backend';
const rootElement = document.getElementById('root');
@@ -8,7 +10,9 @@ if (rootElement) {
const root = ReactDOM.createRoot(rootElement);
root.render(
-
+
);
}
diff --git a/packages/bruno-app/src/pages/Bruno/StyledWrapper.js b/packages/bruno-app/src/pages/Bruno/StyledWrapper.js
index 741978cdf..c570cbf0b 100644
--- a/packages/bruno-app/src/pages/Bruno/StyledWrapper.js
+++ b/packages/bruno-app/src/pages/Bruno/StyledWrapper.js
@@ -4,8 +4,7 @@ const Wrapper = styled.div`
display: flex;
width: 100%;
height: 100%;
- min-height: 100vh;
- max-height: 100vh;
+ flex: 1;
&.is-dragging {
cursor: col-resize !important;
diff --git a/packages/bruno-app/src/pages/Bruno/index.js b/packages/bruno-app/src/pages/Bruno/index.js
index ed5539dbb..b42462547 100644
--- a/packages/bruno-app/src/pages/Bruno/index.js
+++ b/packages/bruno-app/src/pages/Bruno/index.js
@@ -1,78 +1,89 @@
-import React from 'react';
+import React, { useState, useCallback, useRef, useEffect } from 'react';
import classnames from 'classnames';
import Welcome from 'components/Welcome';
import RequestTabs from 'components/RequestTabs';
import RequestTabPanel from 'components/RequestTabPanel';
import Sidebar from 'components/Sidebar';
+import StatusBar from 'components/StatusBar';
+// import ErrorCapture from 'components/ErrorCapture';
import { useSelector } from 'react-redux';
import StyledWrapper from './StyledWrapper';
import 'codemirror/theme/material.css';
import 'codemirror/theme/monokai.css';
import 'codemirror/addon/scroll/simplescrollbars.css';
+import Devtools from 'components/Devtools';
-const SERVER_RENDERED = typeof window === 'undefined' || global['PREVENT_CODEMIRROR_RENDER'] === true;
-if (!SERVER_RENDERED) {
- require('codemirror/mode/javascript/javascript');
- require('codemirror/mode/xml/xml');
- require('codemirror/mode/sparql/sparql');
- require('codemirror/addon/comment/comment');
- require('codemirror/addon/dialog/dialog');
- require('codemirror/addon/edit/closebrackets');
- require('codemirror/addon/edit/matchbrackets');
- require('codemirror/addon/fold/brace-fold');
- require('codemirror/addon/fold/foldgutter');
- require('codemirror/addon/fold/xml-fold');
- require('codemirror/addon/hint/javascript-hint');
- require('codemirror/addon/hint/show-hint');
- require('codemirror/addon/lint/lint');
- require('codemirror/addon/lint/json-lint');
- require('codemirror/addon/mode/overlay');
- require('codemirror/addon/scroll/simplescrollbars');
- require('codemirror/addon/search/jump-to-line');
- require('codemirror/addon/search/search');
- require('codemirror/addon/search/searchcursor');
- require('codemirror/addon/display/placeholder');
- require('codemirror/keymap/sublime');
+require('codemirror/mode/javascript/javascript');
+require('codemirror/mode/xml/xml');
+require('codemirror/mode/sparql/sparql');
+require('codemirror/addon/comment/comment');
+require('codemirror/addon/dialog/dialog');
+require('codemirror/addon/edit/closebrackets');
+require('codemirror/addon/edit/matchbrackets');
+require('codemirror/addon/fold/brace-fold');
+require('codemirror/addon/fold/foldgutter');
+require('codemirror/addon/fold/xml-fold');
+require('codemirror/addon/hint/javascript-hint');
+require('codemirror/addon/hint/show-hint');
+require('codemirror/addon/lint/lint');
+require('codemirror/addon/lint/json-lint');
+require('codemirror/addon/mode/overlay');
+require('codemirror/addon/scroll/simplescrollbars');
+require('codemirror/addon/search/jump-to-line');
+require('codemirror/addon/search/search');
+require('codemirror/addon/search/searchcursor');
+require('codemirror/addon/display/placeholder');
+require('codemirror/keymap/sublime');
- require('codemirror-graphql/hint');
- require('codemirror-graphql/info');
- require('codemirror-graphql/jump');
- require('codemirror-graphql/lint');
- require('codemirror-graphql/mode');
+require('codemirror-graphql/hint');
+require('codemirror-graphql/info');
+require('codemirror-graphql/jump');
+require('codemirror-graphql/lint');
+require('codemirror-graphql/mode');
- require('utils/codemirror/brunoVarInfo');
- require('utils/codemirror/javascript-lint');
- require('utils/codemirror/autocomplete');
-}
+require('utils/codemirror/brunoVarInfo');
+require('utils/codemirror/javascript-lint');
+require('utils/codemirror/autocomplete');
export default function Main() {
const activeTabUid = useSelector((state) => state.tabs.activeTabUid);
const isDragging = useSelector((state) => state.app.isDragging);
const showHomePage = useSelector((state) => state.app.showHomePage);
-
- // Todo: write a better logging flow that can be used to log by turning on debug flag
- // Enable for debugging.
- // console.log(useSelector((state) => state.collections.collections));
+ const isConsoleOpen = useSelector((state) => state.logs.isConsoleOpen);
+ const mainSectionRef = useRef(null);
const className = classnames({
'is-dragging': isDragging
});
return (
-
-
-
- {showHomePage ? (
-
-
-
+ //
+
+
+
+
+ {showHomePage ? (
+
+
+
+
+
+
+
);
}
diff --git a/packages/bruno-app/src/providers/App/index.js b/packages/bruno-app/src/providers/App/index.js
index 7664ae03e..e16f7d4c7 100644
--- a/packages/bruno-app/src/providers/App/index.js
+++ b/packages/bruno-app/src/providers/App/index.js
@@ -5,14 +5,16 @@ import { refreshScreenWidth } from 'providers/ReduxStore/slices/app';
import ConfirmAppClose from './ConfirmAppClose';
import useIpcEvents from './useIpcEvents';
import useTelemetry from './useTelemetry';
+import useGrpcEventListeners from 'utils/network/grpc-event-listeners';
import StyledWrapper from './StyledWrapper';
+import { version } from '../../../package.json';
export const AppContext = React.createContext();
export const AppProvider = (props) => {
- useTelemetry();
+ useTelemetry({ version });
useIpcEvents();
-
+ useGrpcEventListeners();
const dispatch = useDispatch();
useEffect(() => {
@@ -37,7 +39,7 @@ export const AppProvider = (props) => {
}, []);
return (
-
+
toast.dismiss(t.id)} />, {
duration: 5000
@@ -211,13 +225,27 @@ export const HotkeysProvider = (props) => {
};
}, [activeTabUid, tabs, collections, dispatch]);
+ // Collapse sidebar (ctrl/cmd + \)
+ useEffect(() => {
+ Mousetrap.bind([...getKeyBindingsForActionAllOS('collapseSidebar')], (e) => {
+ dispatch(toggleSidebarCollapse());
+ return false;
+ });
+
+ return () => {
+ Mousetrap.unbind([...getKeyBindingsForActionAllOS('collapseSidebar')]);
+ };
+ }, [dispatch]);
+
+ const currentCollection = getCurrentCollection();
+
return (
{showEnvSettingsModal && (
- setShowEnvSettingsModal(false)} />
+ setShowEnvSettingsModal(false)} />
)}
{showNewRequestModal && (
- setShowNewRequestModal(false)} />
+ setShowNewRequestModal(false)} />
)}
{props.children}
diff --git a/packages/bruno-app/src/providers/Hotkeys/keyMappings.js b/packages/bruno-app/src/providers/Hotkeys/keyMappings.js
index 05ad4531b..0fd9bf1bc 100644
--- a/packages/bruno-app/src/providers/Hotkeys/keyMappings.js
+++ b/packages/bruno-app/src/providers/Hotkeys/keyMappings.js
@@ -5,10 +5,10 @@ const KeyMapping = {
newRequest: { mac: 'command+b', windows: 'ctrl+b', name: 'New Request' },
closeTab: { mac: 'command+w', windows: 'ctrl+w', name: 'Close Tab' },
openPreferences: { mac: 'command+,', windows: 'ctrl+,', name: 'Open Preferences' },
- minimizeWindow: {
- mac: 'command+Shift+Q',
- windows: 'control+Shift+Q',
- name: 'Minimize Window'
+ closeBruno: {
+ mac: 'command+Q',
+ windows: 'ctrl+shift+q',
+ name: 'Close Bruno'
},
switchToPreviousTab: {
mac: 'command+pageup',
@@ -20,7 +20,8 @@ const KeyMapping = {
windows: 'ctrl+pagedown',
name: 'Switch to Next Tab'
},
- closeAllTabs: { mac: 'command+shift+w', windows: 'ctrl+shift+w', name: 'Close All Tabs' }
+ closeAllTabs: { mac: 'command+shift+w', windows: 'ctrl+shift+w', name: 'Close All Tabs' },
+ collapseSidebar: { mac: 'command+\\', windows: 'ctrl+\\', name: 'Collapse Sidebar' }
};
/**
diff --git a/packages/bruno-app/src/providers/ReduxStore/index.js b/packages/bruno-app/src/providers/ReduxStore/index.js
index fbfe473e8..8ed528073 100644
--- a/packages/bruno-app/src/providers/ReduxStore/index.js
+++ b/packages/bruno-app/src/providers/ReduxStore/index.js
@@ -6,12 +6,14 @@ import collectionsReducer from './slices/collections';
import tabsReducer from './slices/tabs';
import notificationsReducer from './slices/notifications';
import globalEnvironmentsReducer from './slices/global-environments';
+import logsReducer from './slices/logs';
+import { draftDetectMiddleware } from './middlewares/draft/middleware';
const isDevEnv = () => {
return import.meta.env.MODE === 'development';
};
-let middleware = [tasksMiddleware.middleware];
+let middleware = [tasksMiddleware.middleware, draftDetectMiddleware];
if (isDevEnv()) {
middleware = [...middleware, debugMiddleware.middleware];
}
@@ -22,7 +24,8 @@ export const store = configureStore({
collections: collectionsReducer,
tabs: tabsReducer,
notifications: notificationsReducer,
- globalEnvironments: globalEnvironmentsReducer
+ globalEnvironments: globalEnvironmentsReducer,
+ logs: logsReducer
},
middleware: (getDefaultMiddleware) => getDefaultMiddleware().concat(middleware)
});
diff --git a/packages/bruno-app/src/providers/ReduxStore/middlewares/draft/middleware.js b/packages/bruno-app/src/providers/ReduxStore/middlewares/draft/middleware.js
new file mode 100644
index 000000000..4b8f39443
--- /dev/null
+++ b/packages/bruno-app/src/providers/ReduxStore/middlewares/draft/middleware.js
@@ -0,0 +1,56 @@
+import { handleMakeTabParmanent } from "./utils";
+
+const actionsToIntercept = [
+ 'collections/requestUrlChanged',
+ 'collections/updateAuth',
+ 'collections/addQueryParam',
+ 'collections/moveQueryParam',
+ 'collections/updateQueryParam',
+ 'collections/deleteQueryParam',
+ 'collections/updatePathParam',
+ 'collections/addRequestHeader',
+ 'collections/updateRequestHeader',
+ 'collections/deleteRequestHeader',
+ 'collections/moveRequestHeader',
+ 'collections/addFormUrlEncodedParam',
+ 'collections/updateFormUrlEncodedParam',
+ 'collections/deleteFormUrlEncodedParam',
+ 'collections/moveFormUrlEncodedParam',
+ 'collections/addMultipartFormParam',
+ 'collections/updateMultipartFormParam',
+ 'collections/deleteMultipartFormParam',
+ 'collections/moveMultipartFormParam',
+ 'collections/updateRequestAuthMode',
+ 'collections/updateRequestBodyMode',
+ 'collections/updateRequestBody',
+ 'collections/updateRequestGraphqlQuery',
+ 'collections/updateRequestGraphqlVariables',
+ 'collections/updateRequestScript',
+ 'collections/updateResponseScript',
+ 'collections/updateRequestTests',
+ 'collections/updateRequestMethod',
+ 'collections/addAssertion',
+ 'collections/updateAssertion',
+ 'collections/deleteAssertion',
+ 'collections/moveAssertion',
+ 'collections/addVar',
+ 'collections/updateVar',
+ 'collections/deleteVar',
+ 'collections/moveVar',
+ 'collections/addFolderHeader',
+ 'collections/updateFolderHeader',
+ 'collections/deleteFolderHeader',
+ 'collections/addFolderVar',
+ 'collections/updateFolderVar',
+ 'collections/deleteFolderVar',
+ 'collections/updateRequestDocs',
+ 'collections/runRequestEvent', // TODO: This doesn't necessarily related to a draft state, need to rethink.
+];
+
+export const draftDetectMiddleware = ({ dispatch, getState }) => (next) => (action) => {
+ if (actionsToIntercept.includes(action.type)) {
+ const state = getState();
+ handleMakeTabParmanent(state, action, dispatch);
+ }
+ return next(action);
+};
diff --git a/packages/bruno-app/src/providers/ReduxStore/middlewares/draft/utils.js b/packages/bruno-app/src/providers/ReduxStore/middlewares/draft/utils.js
new file mode 100644
index 000000000..ab84ccaf4
--- /dev/null
+++ b/packages/bruno-app/src/providers/ReduxStore/middlewares/draft/utils.js
@@ -0,0 +1,21 @@
+import { makeTabPermanent } from "providers/ReduxStore/slices/tabs";
+import { findCollectionByUid, findItemInCollection } from "utils/collections/index";
+import find from 'lodash/find';
+
+function handleMakeTabParmanent(state, action, dispatch) {
+ const tabs = state.tabs.tabs;
+ const activeTabUid = state.tabs.activeTabUid;
+ const focusedTab = find(tabs, (t) => t.uid === activeTabUid);
+ const itemUid = action.payload.itemUid || action.payload.folderUid
+ const collection = findCollectionByUid(state.collections.collections, action.payload.collectionUid);
+ if (collection) {
+ const item = findItemInCollection(collection, itemUid);
+ if (item && focusedTab.preview == true) {
+ dispatch(makeTabPermanent({ uid: itemUid }));
+ }
+ }
+}
+
+export {
+ handleMakeTabParmanent
+}
\ No newline at end of file
diff --git a/packages/bruno-app/src/providers/ReduxStore/middlewares/tasks/middleware.js b/packages/bruno-app/src/providers/ReduxStore/middlewares/tasks/middleware.js
index 056136a1c..ad106cde5 100644
--- a/packages/bruno-app/src/providers/ReduxStore/middlewares/tasks/middleware.js
+++ b/packages/bruno-app/src/providers/ReduxStore/middlewares/tasks/middleware.js
@@ -27,22 +27,25 @@ taskMiddleware.startListening({
each(openRequestTasks, (task) => {
if (collectionUid === task.collectionUid) {
const collection = findCollectionByUid(state.collections.collections, collectionUid);
- const item = findItemInCollectionByPathname(collection, task.itemPathname);
- if (item) {
- listenerApi.dispatch(
- addTab({
- uid: item.uid,
- collectionUid: collection.uid,
- requestPaneTab: getDefaultRequestPaneTab(item)
- })
- );
- listenerApi.dispatch(hideHomePage());
- listenerApi.dispatch(
- removeTaskFromQueue({
- taskUid: task.uid
- })
- );
+ if (collection && collection.mountStatus === 'mounted' && !collection.isLoading) {
+ const item = findItemInCollectionByPathname(collection, task.itemPathname);
+ if (item) {
+ listenerApi.dispatch(
+ addTab({
+ uid: item.uid,
+ collectionUid: collection.uid,
+ requestPaneTab: getDefaultRequestPaneTab(item)
+ })
+ );
+ listenerApi.dispatch(hideHomePage());
+ }
}
+
+ listenerApi.dispatch(
+ removeTaskFromQueue({
+ taskUid: task.uid
+ })
+ );
}
});
}
diff --git a/packages/bruno-app/src/providers/ReduxStore/slices/app.js b/packages/bruno-app/src/providers/ReduxStore/slices/app.js
index f5034b5d5..59495aec8 100644
--- a/packages/bruno-app/src/providers/ReduxStore/slices/app.js
+++ b/packages/bruno-app/src/providers/ReduxStore/slices/app.js
@@ -1,11 +1,11 @@
import { createSlice } from '@reduxjs/toolkit';
import filter from 'lodash/filter';
-import toast from 'react-hot-toast';
const initialState = {
isDragging: false,
idbConnectionReady: false,
leftSidebarWidth: 222,
+ sidebarCollapsed: false,
screenWidth: 500,
showHomePage: false,
showPreferences: false,
@@ -24,8 +24,16 @@ const initialState = {
},
font: {
codeFont: 'default'
+ },
+ beta: {
+ grpc: false
}
},
+ generateCode: {
+ mainLanguage: 'Shell',
+ library: 'curl',
+ shouldInterpolate: true
+ },
cookies: [],
taskQueue: [],
systemProxyEnvVariables: {}
@@ -76,6 +84,15 @@ export const appSlice = createSlice({
},
updateSystemProxyEnvVariables: (state, action) => {
state.systemProxyEnvVariables = action.payload;
+ },
+ updateGenerateCode: (state, action) => {
+ state.generateCode = {
+ ...state.generateCode,
+ ...action.payload
+ };
+ },
+ toggleSidebarCollapse: (state) => {
+ state.sidebarCollapsed = !state.sidebarCollapsed;
}
}
});
@@ -94,7 +111,9 @@ export const {
insertTaskIntoQueue,
removeTaskFromQueue,
removeAllTasksFromQueue,
- updateSystemProxyEnvVariables
+ updateSystemProxyEnvVariables,
+ updateGenerateCode,
+ toggleSidebarCollapse
} = appSlice.actions;
export const savePreferences = (preferences) => (dispatch, getState) => {
@@ -103,14 +122,9 @@ export const savePreferences = (preferences) => (dispatch, getState) => {
ipcRenderer
.invoke('renderer:save-preferences', preferences)
- .then(() => toast.success('Preferences saved successfully'))
.then(() => dispatch(updatePreferences(preferences)))
.then(resolve)
- .catch((err) => {
- toast.error('An error occurred while saving preferences');
- console.error(err);
- reject(err);
- });
+ .catch(reject);
});
};
@@ -122,6 +136,44 @@ export const deleteCookiesForDomain = (domain) => (dispatch, getState) => {
});
};
+export const deleteCookie = (domain, path, cookieKey) => (dispatch, getState) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+
+ ipcRenderer.invoke('renderer:delete-cookie', domain, path, cookieKey).then(resolve).catch(reject);
+ });
+};
+
+export const addCookie = (domain, cookie) => (dispatch, getState) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+
+ ipcRenderer.invoke('renderer:add-cookie', domain, cookie).then(resolve).catch(reject);
+ });
+};
+
+export const modifyCookie = (domain, oldCookie, cookie) => (dispatch, getState) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+
+ ipcRenderer.invoke('renderer:modify-cookie', domain, oldCookie, cookie).then(resolve).catch(reject);
+ });
+};
+
+export const getParsedCookie = (cookieStr) => () => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('renderer:get-parsed-cookie', cookieStr).then(resolve).catch(reject);
+ });
+};
+
+export const createCookieString = (cookieObj) => () => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('renderer:create-cookie-string', cookieObj).then(resolve).catch(reject);
+ });
+};
+
export const completeQuitFlow = () => (dispatch, getState) => {
const { ipcRenderer } = window;
return ipcRenderer.invoke('main:complete-quit-flow');
diff --git a/packages/bruno-app/src/providers/ReduxStore/slices/collections/actions.js b/packages/bruno-app/src/providers/ReduxStore/slices/collections/actions.js
index 75c6f2cb9..2787016c4 100644
--- a/packages/bruno-app/src/providers/ReduxStore/slices/collections/actions.js
+++ b/packages/bruno-app/src/providers/ReduxStore/slices/collections/actions.js
@@ -1,28 +1,27 @@
import { collectionSchema, environmentSchema, itemSchema } from '@usebruno/schema';
+import { parseQueryParams } from '@usebruno/common/utils';
import cloneDeep from 'lodash/cloneDeep';
import filter from 'lodash/filter';
import find from 'lodash/find';
import get from 'lodash/get';
+import set from 'lodash/set';
import trim from 'lodash/trim';
-import path from 'path';
-import { insertTaskIntoQueue } from 'providers/ReduxStore/slices/app';
+import path from 'utils/common/path';
+import { insertTaskIntoQueue, toggleSidebarCollapse } from 'providers/ReduxStore/slices/app';
import toast from 'react-hot-toast';
import {
findCollectionByUid,
findEnvironmentInCollection,
findItemInCollection,
findParentItemInCollection,
- getItemsToResequence,
isItemAFolder,
refreshUidsInItem,
isItemARequest,
- moveCollectionItem,
- moveCollectionItemToRootOfCollection,
transformRequestToSaveToFilesystem
} from 'utils/collections';
import { uuid, waitForNextTick } from 'utils/common';
-import { PATH_SEPARATOR, getDirectoryName } from 'utils/common/platform';
-import { cancelNetworkRequest, sendNetworkRequest } from 'utils/network';
+import { cancelNetworkRequest, sendGrpcRequest, sendNetworkRequest } from 'utils/network/index';
+import { callIpc } from 'utils/common/ipc';
import {
collectionAddEnvFileEvent as _collectionAddEnvFileEvent,
@@ -30,22 +29,41 @@ import {
removeCollection as _removeCollection,
selectEnvironment as _selectEnvironment,
sortCollections as _sortCollections,
+ updateCollectionMountStatus,
+ moveCollection,
requestCancelled,
resetRunResults,
responseReceived,
updateLastAction,
- setCollectionSecurityConfig
+ setCollectionSecurityConfig,
+ collectionAddOauth2CredentialsByUrl,
+ collectionClearOauth2CredentialsByUrl,
+ initRunRequestEvent,
+ updateRunnerConfiguration as _updateRunnerConfiguration,
+ updateActiveConnections,
+ saveRequest as _saveRequest,
+ saveEnvironment as _saveEnvironment
} from './index';
import { each } from 'lodash';
-import { closeAllCollectionTabs } from 'providers/ReduxStore/slices/tabs';
+import { closeAllCollectionTabs, updateResponsePaneScrollPosition } from 'providers/ReduxStore/slices/tabs';
import { resolveRequestFilename } from 'utils/common/platform';
-import { parsePathParams, parseQueryParams, splitOnFirst } from 'utils/url/index';
+import { parsePathParams, splitOnFirst } from 'utils/url/index';
import { sendCollectionOauth2Request as _sendCollectionOauth2Request } from 'utils/network/index';
-import { name } from 'file-loader';
-import slash from 'utils/common/slash';
-import { getGlobalEnvironmentVariables } from 'utils/collections/index';
-import { findCollectionByPathname, findEnvironmentInCollectionByName } from 'utils/collections/index';
+import {
+ getGlobalEnvironmentVariables,
+ findCollectionByPathname,
+ findEnvironmentInCollectionByName,
+ getReorderedItemsInTargetDirectory,
+ resetSequencesInFolder,
+ getReorderedItemsInSourceDirectory,
+ calculateDraggedItemNewPathname
+} from 'utils/collections/index';
+import { sanitizeName } from 'utils/common/regex';
+import { buildPersistedEnvVariables } from 'utils/environments';
+import { safeParseJSON, safeStringifyJSON } from 'utils/common/index';
+import { addTab } from 'providers/ReduxStore/slices/tabs';
+import { updateSettingsSelectedTab } from './index';
export const renameCollection = (newName, collectionUid) => (dispatch, getState) => {
const state = getState();
@@ -55,7 +73,7 @@ export const renameCollection = (newName, collectionUid) => (dispatch, getState)
if (!collection) {
return reject(new Error('Collection not found'));
}
-
+ const { ipcRenderer } = window;
ipcRenderer.invoke('renderer:rename-collection', newName, collection.pathname).then(resolve).catch(reject);
});
};
@@ -85,10 +103,16 @@ export const saveRequest = (itemUid, collectionUid, saveSilently) => (dispatch,
if (!saveSilently) {
toast.success('Request saved successfully');
}
+ dispatch(
+ _saveRequest({
+ itemUid,
+ collectionUid
+ })
+ );
})
.then(resolve)
.catch((err) => {
- toast.error('Failed to save request!');
+ toast.error(err.message || 'Failed to save request!');
reject(err);
});
});
@@ -161,7 +185,6 @@ export const saveFolderRoot = (collectionUid, folderUid) => (dispatch, getState)
if (!folder) {
return reject(new Error('Folder not found'));
}
- console.log(collection);
const { ipcRenderer } = window;
@@ -170,7 +193,6 @@ export const saveFolderRoot = (collectionUid, folderUid) => (dispatch, getState)
pathname: folder.pathname,
root: folder.root
};
- console.log(folderData);
ipcRenderer
.invoke('renderer:save-folder-root', folderData)
@@ -185,7 +207,7 @@ export const saveFolderRoot = (collectionUid, folderUid) => (dispatch, getState)
export const sendCollectionOauth2Request = (collectionUid, itemUid) => (dispatch, getState) => {
const state = getState();
- const { globalEnvironments, activeGlobalEnvironmentUid } = state.globalEnvironments;
+ const { globalEnvironments, activeGlobalEnvironmentUid } = state.globalEnvironments;
const collection = findCollectionByUid(state.collections.collections, collectionUid);
return new Promise((resolve, reject) => {
@@ -196,7 +218,10 @@ export const sendCollectionOauth2Request = (collectionUid, itemUid) => (dispatch
let collectionCopy = cloneDeep(collection);
// add selected global env variables to the collection object
- const globalEnvironmentVariables = getGlobalEnvironmentVariables({ globalEnvironments, activeGlobalEnvironmentUid });
+ const globalEnvironmentVariables = getGlobalEnvironmentVariables({
+ globalEnvironments,
+ activeGlobalEnvironmentUid
+ });
collectionCopy.globalEnvironmentVariables = globalEnvironmentVariables;
const environment = findEnvironmentInCollection(collectionCopy, collection.activeEnvironmentUid);
@@ -219,62 +244,102 @@ export const sendCollectionOauth2Request = (collectionUid, itemUid) => (dispatch
export const sendRequest = (item, collectionUid) => (dispatch, getState) => {
const state = getState();
- const { globalEnvironments, activeGlobalEnvironmentUid } = state.globalEnvironments;
+ const { globalEnvironments, activeGlobalEnvironmentUid } = state.globalEnvironments;
const collection = findCollectionByUid(state.collections.collections, collectionUid);
+ const itemUid = item?.uid;
- return new Promise((resolve, reject) => {
+ return new Promise(async (resolve, reject) => {
if (!collection) {
return reject(new Error('Collection not found'));
}
- const itemCopy = cloneDeep(item || {});
let collectionCopy = cloneDeep(collection);
+ const itemCopy = cloneDeep(item);
+
+ const requestUid = uuid();
+ itemCopy.requestUid = requestUid;
+
+ await dispatch(
+ updateResponsePaneScrollPosition({
+ uid: state.tabs.activeTabUid,
+ scrollY: 0
+ })
+ );
+
+ await dispatch(
+ initRunRequestEvent({
+ requestUid,
+ itemUid,
+ collectionUid
+ })
+ );
+
// add selected global env variables to the collection object
- const globalEnvironmentVariables = getGlobalEnvironmentVariables({ globalEnvironments, activeGlobalEnvironmentUid });
+ const globalEnvironmentVariables = getGlobalEnvironmentVariables({
+ globalEnvironments,
+ activeGlobalEnvironmentUid
+ });
collectionCopy.globalEnvironmentVariables = globalEnvironmentVariables;
const environment = findEnvironmentInCollection(collectionCopy, collectionCopy.activeEnvironmentUid);
- sendNetworkRequest(itemCopy, collectionCopy, environment, collectionCopy.runtimeVariables)
- .then((response) => {
- return dispatch(
- responseReceived({
- itemUid: item.uid,
- collectionUid: collectionUid,
- response: response
- })
- );
- })
- .then(resolve)
- .catch((err) => {
- if (err && err.message === "Error invoking remote method 'send-http-request': Error: Request cancelled") {
- console.log('>> request cancelled');
- dispatch(
+ const isGrpcRequest = itemCopy.type === 'grpc-request';
+ if (isGrpcRequest) {
+ sendGrpcRequest(itemCopy, collectionCopy, environment, collectionCopy.runtimeVariables)
+ .then(resolve)
+ .catch((err) => {
+ toast.error(err.message);
+ });
+ } else {
+ sendNetworkRequest(itemCopy, collectionCopy, environment, collectionCopy.runtimeVariables)
+ .then((response) => {
+ // Ensure any timestamps in the response are converted to numbers
+ const serializedResponse = {
+ ...response,
+ timeline: response.timeline?.map((entry) => ({
+ ...entry,
+ timestamp: entry.timestamp instanceof Date ? entry.timestamp.getTime() : entry.timestamp
+ }))
+ };
+
+ return dispatch(
responseReceived({
- itemUid: item.uid,
- collectionUid: collectionUid,
- response: null
+ itemUid,
+ collectionUid,
+ response: serializedResponse
})
);
- return;
- }
+ })
+ .then(resolve)
+ .catch((err) => {
+ if (err && err.message === "Error invoking remote method 'send-http-request': Error: Request cancelled") {
+ dispatch(
+ responseReceived({
+ itemUid,
+ collectionUid,
+ response: null
+ })
+ );
+ return;
+ }
- const errorResponse = {
- status: 'Error',
- isError: true,
- error: err.message ?? 'Something went wrong',
- size: 0,
- duration: 0
- };
+ const errorResponse = {
+ status: 'Error',
+ isError: true,
+ error: err.message ?? 'Something went wrong',
+ size: 0,
+ duration: 0
+ };
- dispatch(
- responseReceived({
- itemUid: item.uid,
- collectionUid: collectionUid,
- response: errorResponse
- })
- );
- });
+ dispatch(
+ responseReceived({
+ itemUid,
+ collectionUid,
+ response: errorResponse
+ })
+ );
+ });
+ }
});
};
@@ -295,57 +360,85 @@ export const cancelRunnerExecution = (cancelTokenUid) => (dispatch) => {
cancelNetworkRequest(cancelTokenUid).catch((err) => console.log(err));
};
-export const runCollectionFolder = (collectionUid, folderUid, recursive, delay) => (dispatch, getState) => {
- const state = getState();
- const { globalEnvironments, activeGlobalEnvironmentUid } = state.globalEnvironments;
- const collection = findCollectionByUid(state.collections.collections, collectionUid);
+export const runCollectionFolder =
+ (collectionUid, folderUid, recursive, delay, tags, selectedRequestUids) => (dispatch, getState) => {
+ const state = getState();
+ const { globalEnvironments, activeGlobalEnvironmentUid } = state.globalEnvironments;
+ const collection = findCollectionByUid(state.collections.collections, collectionUid);
- return new Promise((resolve, reject) => {
- if (!collection) {
- return reject(new Error('Collection not found'));
- }
+ return new Promise((resolve, reject) => {
+ if (!collection) {
+ return reject(new Error('Collection not found'));
+ }
- let collectionCopy = cloneDeep(collection);
+ let collectionCopy = cloneDeep(collection);
- // add selected global env variables to the collection object
- const globalEnvironmentVariables = getGlobalEnvironmentVariables({ globalEnvironments, activeGlobalEnvironmentUid });
- collectionCopy.globalEnvironmentVariables = globalEnvironmentVariables;
-
- const folder = findItemInCollection(collectionCopy, folderUid);
-
- if (folderUid && !folder) {
- return reject(new Error('Folder not found'));
- }
-
- const environment = findEnvironmentInCollection(collectionCopy, collection.activeEnvironmentUid);
-
- dispatch(
- resetRunResults({
- collectionUid: collection.uid
- })
- );
-
- ipcRenderer
- .invoke(
- 'renderer:run-collection-folder',
- folder,
- collectionCopy,
- environment,
- collectionCopy.runtimeVariables,
- recursive,
- delay
- )
- .then(resolve)
- .catch((err) => {
- toast.error(get(err, 'error.message') || 'Something went wrong!');
- reject(err);
+ // add selected global env variables to the collection object
+ const globalEnvironmentVariables = getGlobalEnvironmentVariables({
+ globalEnvironments,
+ activeGlobalEnvironmentUid
});
- });
-};
+ collectionCopy.globalEnvironmentVariables = globalEnvironmentVariables;
-export const newFolder = (folderName, collectionUid, itemUid) => (dispatch, getState) => {
+ const folder = findItemInCollection(collectionCopy, folderUid);
+
+ if (folderUid && !folder) {
+ return reject(new Error('Folder not found'));
+ }
+
+ const environment = findEnvironmentInCollection(collectionCopy, collection.activeEnvironmentUid);
+
+ dispatch(
+ resetRunResults({
+ collectionUid: collection.uid
+ })
+ );
+
+ // to only include those requests in the specified order while preserving folder data
+ if (selectedRequestUids && selectedRequestUids.length > 0) {
+ const newItems = [];
+
+ selectedRequestUids.forEach((uid, index) => {
+ const requestItem = findItemInCollection(collectionCopy, uid);
+ if (requestItem) {
+ const clonedRequest = cloneDeep(requestItem);
+ clonedRequest.seq = index + 1;
+ newItems.push(clonedRequest);
+ }
+ });
+
+ if (folder) {
+ folder.items = newItems;
+ } else {
+ collectionCopy.items = newItems;
+ }
+ }
+
+ const { ipcRenderer } = window;
+ ipcRenderer
+ .invoke(
+ 'renderer:run-collection-folder',
+ folder,
+ collectionCopy,
+ environment,
+ collectionCopy.runtimeVariables,
+ recursive,
+ delay,
+ tags
+ )
+ .then(resolve)
+ .catch((err) => {
+ toast.error(get(err, 'error.message') || 'Something went wrong!');
+ reject(err);
+ });
+ });
+ };
+
+export const newFolder = (folderName, directoryName, collectionUid, itemUid) => (dispatch, getState) => {
const state = getState();
const collection = findCollectionByUid(state.collections.collections, collectionUid);
+ const parentItem = itemUid ? findItemInCollection(collection, itemUid) : collection;
+ const items = filter(parentItem.items, (i) => isItemAFolder(i) || isItemARequest(i));
return new Promise((resolve, reject) => {
if (!collection) {
@@ -355,16 +448,31 @@ export const newFolder = (folderName, collectionUid, itemUid) => (dispatch, getS
if (!itemUid) {
const folderWithSameNameExists = find(
collection.items,
- (i) => i.type === 'folder' && trim(i.name) === trim(folderName)
+ (i) => i.type === 'folder' && trim(i.filename) === trim(directoryName)
);
if (!folderWithSameNameExists) {
- const fullName = `${collection.pathname}${PATH_SEPARATOR}${folderName}`;
+ const fullName = path.join(collection.pathname, directoryName);
const { ipcRenderer } = window;
+ const folderBruJsonData = {
+ meta: {
+ name: folderName,
+ seq: items?.length + 1
+ },
+ request: {
+ auth: {
+ mode: 'inherit'
+ }
+ }
+ };
+
ipcRenderer
- .invoke('renderer:new-folder', fullName)
- .then(() => resolve())
- .catch((error) => reject(error));
+ .invoke('renderer:new-folder', { pathname: fullName, folderBruJsonData })
+ .then(resolve)
+ .catch((error) => {
+ toast.error('Failed to create a new folder!');
+ reject(error);
+ });
} else {
return reject(new Error('Duplicate folder names under same parent folder are not allowed'));
}
@@ -373,16 +481,31 @@ export const newFolder = (folderName, collectionUid, itemUid) => (dispatch, getS
if (currentItem) {
const folderWithSameNameExists = find(
currentItem.items,
- (i) => i.type === 'folder' && trim(i.name) === trim(folderName)
+ (i) => i.type === 'folder' && trim(i.filename) === trim(directoryName)
);
if (!folderWithSameNameExists) {
- const fullName = `${currentItem.pathname}${PATH_SEPARATOR}${folderName}`;
+ const fullName = path.join(currentItem.pathname, directoryName);
const { ipcRenderer } = window;
+ const folderBruJsonData = {
+ meta: {
+ name: folderName,
+ seq: items?.length + 1
+ },
+ request: {
+ auth: {
+ mode: 'inherit'
+ }
+ }
+ };
+
ipcRenderer
- .invoke('renderer:new-folder', fullName)
- .then(() => resolve())
- .catch((error) => reject(error));
+ .invoke('renderer:new-folder', { pathname: fullName, folderBruJsonData })
+ .then(resolve)
+ .catch((error) => {
+ toast.error('Failed to create a new folder!');
+ reject(error);
+ });
} else {
return reject(new Error('Duplicate folder names under same parent folder are not allowed'));
}
@@ -393,38 +516,70 @@ export const newFolder = (folderName, collectionUid, itemUid) => (dispatch, getS
});
};
-// rename item
-export const renameItem = (newName, itemUid, collectionUid) => (dispatch, getState) => {
- const state = getState();
- const collection = findCollectionByUid(state.collections.collections, collectionUid);
+export const renameItem =
+ ({ newName, newFilename, itemUid, collectionUid }) =>
+ (dispatch, getState) => {
+ const state = getState();
+ const collection = findCollectionByUid(state.collections.collections, collectionUid);
- return new Promise((resolve, reject) => {
- if (!collection) {
- return reject(new Error('Collection not found'));
- }
+ return new Promise((resolve, reject) => {
+ if (!collection) {
+ return reject(new Error('Collection not found'));
+ }
- const collectionCopy = cloneDeep(collection);
- const item = findItemInCollection(collectionCopy, itemUid);
- if (!item) {
- return reject(new Error('Unable to locate item'));
- }
+ const collectionCopy = cloneDeep(collection);
+ const item = findItemInCollection(collectionCopy, itemUid);
+ if (!item) {
+ return reject(new Error('Unable to locate item'));
+ }
- const dirname = getDirectoryName(item.pathname);
+ const { ipcRenderer } = window;
- let newPathname = '';
- if (item.type === 'folder') {
- newPathname = path.join(dirname, trim(newName));
- } else {
- const filename = resolveRequestFilename(newName);
- newPathname = path.join(dirname, filename);
- }
- const { ipcRenderer } = window;
+ const renameName = async () => {
+ return ipcRenderer.invoke('renderer:rename-item-name', { itemPath: item.pathname, newName }).catch((err) => {
+ toast.error('Failed to rename the item name');
+ console.error(err);
+ throw new Error('Failed to rename the item name');
+ });
+ };
- ipcRenderer.invoke('renderer:rename-item', slash(item.pathname), newPathname, newName).then(resolve).catch(reject);
- });
-};
+ const renameFile = async () => {
+ const dirname = path.dirname(item.pathname);
+ let newPath = '';
+ if (item.type === 'folder') {
+ newPath = path.join(dirname, trim(newFilename));
+ } else {
+ const filename = resolveRequestFilename(newFilename);
+ newPath = path.join(dirname, filename);
+ }
-export const cloneItem = (newName, itemUid, collectionUid) => (dispatch, getState) => {
+ return ipcRenderer
+ .invoke('renderer:rename-item-filename', { oldPath: item.pathname, newPath, newName, newFilename })
+ .catch((err) => {
+ toast.error('Failed to rename the file');
+ console.error(err);
+ throw new Error('Failed to rename the file');
+ });
+ };
+
+ let renameOperation = null;
+ if (newName) renameOperation = renameName;
+ if (newFilename) renameOperation = renameFile;
+
+ if (!renameOperation) {
+ resolve();
+ }
+
+ renameOperation()
+ .then(() => {
+ toast.success('Item renamed successfully');
+ resolve();
+ })
+ .catch((err) => reject(err));
+ });
+ };
+
+export const cloneItem = (newName, newFilename, itemUid, collectionUid) => (dispatch, getState) => {
const state = getState();
const collection = findCollectionByUid(state.collections.collections, collectionUid);
@@ -443,36 +598,44 @@ export const cloneItem = (newName, itemUid, collectionUid) => (dispatch, getStat
const folderWithSameNameExists = find(
parentFolder.items,
- (i) => i.type === 'folder' && trim(i.name) === trim(newName)
+ (i) => i.type === 'folder' && trim(i?.filename) === trim(newFilename)
);
if (folderWithSameNameExists) {
return reject(new Error('Duplicate folder names under same parent folder are not allowed'));
}
- const collectionPath = `${parentFolder.pathname}${PATH_SEPARATOR}${newName}`;
+ set(item, 'name', newName);
+ set(item, 'filename', newFilename);
+ set(item, 'root.meta.name', newName);
+ set(item, 'root.meta.seq', parentFolder?.items?.length + 1);
+
+ const collectionPath = path.join(parentFolder.pathname, newFilename);
+
+ const { ipcRenderer } = window;
ipcRenderer.invoke('renderer:clone-folder', item, collectionPath).then(resolve).catch(reject);
return;
}
const parentItem = findParentItemInCollection(collectionCopy, itemUid);
- const filename = resolveRequestFilename(newName);
+ const filename = resolveRequestFilename(newFilename);
const itemToSave = refreshUidsInItem(transformRequestToSaveToFilesystem(item));
- itemToSave.name = trim(newName);
+ set(itemToSave, 'name', trim(newName));
+ set(itemToSave, 'filename', trim(filename));
if (!parentItem) {
const reqWithSameNameExists = find(
collection.items,
(i) => i.type !== 'folder' && trim(i.filename) === trim(filename)
);
if (!reqWithSameNameExists) {
- const fullName = `${collection.pathname}${PATH_SEPARATOR}${filename}`;
+ const fullPathname = path.join(collection.pathname, filename);
const { ipcRenderer } = window;
const requestItems = filter(collection.items, (i) => i.type !== 'folder');
itemToSave.seq = requestItems ? requestItems.length + 1 : 1;
itemSchema
.validate(itemToSave)
- .then(() => ipcRenderer.invoke('renderer:new-request', fullName, itemToSave))
+ .then(() => ipcRenderer.invoke('renderer:new-request', fullPathname, itemToSave))
.then(resolve)
.catch(reject);
@@ -481,7 +644,7 @@ export const cloneItem = (newName, itemUid, collectionUid) => (dispatch, getStat
uid: uuid(),
type: 'OPEN_REQUEST',
collectionUid,
- itemPathname: fullName
+ itemPathname: fullPathname
})
);
} else {
@@ -493,7 +656,7 @@ export const cloneItem = (newName, itemUid, collectionUid) => (dispatch, getStat
(i) => i.type !== 'folder' && trim(i.filename) === trim(filename)
);
if (!reqWithSameNameExists) {
- const dirname = getDirectoryName(item.pathname);
+ const dirname = path.dirname(item.pathname);
const fullName = path.join(dirname, filename);
const { ipcRenderer } = window;
const requestItems = filter(parentItem.items, (i) => i.type !== 'folder');
@@ -547,179 +710,156 @@ export const deleteItem = (itemUid, collectionUid) => (dispatch, getState) => {
export const sortCollections = (payload) => (dispatch) => {
dispatch(_sortCollections(payload));
};
-export const moveItem = (collectionUid, draggedItemUid, targetItemUid) => (dispatch, getState) => {
- const state = getState();
- const collection = findCollectionByUid(state.collections.collections, collectionUid);
- return new Promise((resolve, reject) => {
- if (!collection) {
- return reject(new Error('Collection not found'));
- }
+export const moveItem =
+ ({ targetDirname, sourcePathname }) =>
+ (dispatch, getState) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
- const collectionCopy = cloneDeep(collection);
- const draggedItem = findItemInCollection(collectionCopy, draggedItemUid);
- const targetItem = findItemInCollection(collectionCopy, targetItemUid);
+ ipcRenderer.invoke('renderer:move-item', { targetDirname, sourcePathname }).then(resolve).catch(reject);
+ });
+ };
- if (!draggedItem) {
- return reject(new Error('Dragged item not found'));
- }
+export const handleCollectionItemDrop =
+ ({ targetItem, draggedItem, dropType, collectionUid }) =>
+ (dispatch, getState) => {
+ const state = getState();
+ const collection = findCollectionByUid(state.collections.collections, collectionUid);
+ const { uid: draggedItemUid, pathname: draggedItemPathname } = draggedItem;
+ const { uid: targetItemUid, pathname: targetItemPathname } = targetItem;
+ const targetItemDirectory = findParentItemInCollection(collection, targetItemUid) || collection;
+ const targetItemDirectoryItems = cloneDeep(targetItemDirectory.items);
+ const draggedItemDirectory = findParentItemInCollection(collection, draggedItemUid) || collection;
+ const draggedItemDirectoryItems = cloneDeep(draggedItemDirectory.items);
- if (!targetItem) {
- return reject(new Error('Target item not found'));
- }
+ const handleMoveToNewLocation = async ({
+ draggedItem,
+ draggedItemDirectoryItems,
+ targetItem,
+ targetItemDirectoryItems,
+ newPathname,
+ dropType
+ }) => {
+ const { uid: targetItemUid } = targetItem;
+ const { pathname: draggedItemPathname, uid: draggedItemUid } = draggedItem;
- const draggedItemParent = findParentItemInCollection(collectionCopy, draggedItemUid);
- const targetItemParent = findParentItemInCollection(collectionCopy, targetItemUid);
- const sameParent = draggedItemParent === targetItemParent;
+ const newDirname = path.dirname(newPathname);
+ await dispatch(
+ moveItem({
+ targetDirname: newDirname,
+ sourcePathname: draggedItemPathname
+ })
+ );
- // file item dragged onto another file item and both are in the same folder
- // this is also true when both items are at the root level
- if (isItemARequest(draggedItem) && isItemARequest(targetItem) && sameParent) {
- moveCollectionItem(collectionCopy, draggedItem, targetItem);
- const itemsToResequence = getItemsToResequence(draggedItemParent, collectionCopy);
+ // Update sequences in the source directory
+ if (draggedItemDirectoryItems?.length) {
+ // reorder items in the source directory
+ const draggedItemDirectoryItemsWithoutDraggedItem = draggedItemDirectoryItems.filter(
+ (i) => i.uid !== draggedItemUid
+ );
+ const reorderedSourceItems = getReorderedItemsInSourceDirectory({
+ items: draggedItemDirectoryItemsWithoutDraggedItem
+ });
+ if (reorderedSourceItems?.length) {
+ await dispatch(updateItemsSequences({ itemsToResequence: reorderedSourceItems }));
+ }
+ }
- return ipcRenderer
- .invoke('renderer:resequence-items', itemsToResequence)
- .then(resolve)
- .catch((error) => reject(error));
- }
+ // Update sequences in the target directory (if dropping adjacent)
+ if (dropType === 'adjacent') {
+ const targetItemSequence = targetItemDirectoryItems.findIndex((i) => i.uid === targetItemUid)?.seq;
- // file item dragged onto another file item which is at the root level
- if (isItemARequest(draggedItem) && isItemARequest(targetItem) && !targetItemParent) {
- const draggedItemPathname = draggedItem.pathname;
- moveCollectionItem(collectionCopy, draggedItem, targetItem);
- const itemsToResequence = getItemsToResequence(draggedItemParent, collectionCopy);
- const itemsToResequence2 = getItemsToResequence(targetItemParent, collectionCopy);
+ const draggedItemWithNewPathAndSequence = {
+ ...draggedItem,
+ pathname: newPathname,
+ seq: targetItemSequence
+ };
- return ipcRenderer
- .invoke('renderer:move-file-item', draggedItemPathname, collectionCopy.pathname)
- .then(() => ipcRenderer.invoke('renderer:resequence-items', itemsToResequence))
- .then(() => ipcRenderer.invoke('renderer:resequence-items', itemsToResequence2))
- .then(resolve)
- .catch((error) => reject(error));
- }
+ // draggedItem is added to the targetItem's directory
+ const reorderedTargetItems = getReorderedItemsInTargetDirectory({
+ items: [...targetItemDirectoryItems, draggedItemWithNewPathAndSequence],
+ targetItemUid,
+ draggedItemUid
+ });
- // file item dragged onto another file item and both are in different folders
- if (isItemARequest(draggedItem) && isItemARequest(targetItem) && !sameParent) {
- const draggedItemPathname = draggedItem.pathname;
- moveCollectionItem(collectionCopy, draggedItem, targetItem);
- const itemsToResequence = getItemsToResequence(draggedItemParent, collectionCopy);
- const itemsToResequence2 = getItemsToResequence(targetItemParent, collectionCopy);
+ if (reorderedTargetItems?.length) {
+ await dispatch(updateItemsSequences({ itemsToResequence: reorderedTargetItems }));
+ }
+ }
+ };
- return ipcRenderer
- .invoke('renderer:move-file-item', draggedItemPathname, targetItemParent.pathname)
- .then(() => ipcRenderer.invoke('renderer:resequence-items', itemsToResequence))
- .then(() => ipcRenderer.invoke('renderer:resequence-items', itemsToResequence2))
- .then(resolve)
- .catch((error) => reject(error));
- }
+ const handleReorderInSameLocation = async ({ draggedItem, targetItem, targetItemDirectoryItems }) => {
+ const { uid: targetItemUid } = targetItem;
+ const { uid: draggedItemUid } = draggedItem;
- // file item dragged into its own folder
- if (isItemARequest(draggedItem) && isItemAFolder(targetItem) && draggedItemParent === targetItem) {
- return resolve();
- }
+ // reorder items in the targetItem's directory
+ const reorderedItems = getReorderedItemsInTargetDirectory({
+ items: targetItemDirectoryItems,
+ targetItemUid,
+ draggedItemUid
+ });
- // file item dragged into another folder
- if (isItemARequest(draggedItem) && isItemAFolder(targetItem) && draggedItemParent !== targetItem) {
- const draggedItemPathname = draggedItem.pathname;
- moveCollectionItem(collectionCopy, draggedItem, targetItem);
- const itemsToResequence = getItemsToResequence(draggedItemParent, collectionCopy);
- const itemsToResequence2 = getItemsToResequence(targetItem, collectionCopy);
+ if (reorderedItems?.length) {
+ await dispatch(updateItemsSequences({ itemsToResequence: reorderedItems }));
+ }
+ };
- return ipcRenderer
- .invoke('renderer:move-file-item', draggedItemPathname, targetItem.pathname)
- .then(() => ipcRenderer.invoke('renderer:resequence-items', itemsToResequence))
- .then(() => ipcRenderer.invoke('renderer:resequence-items', itemsToResequence2))
- .then(resolve)
- .catch((error) => reject(error));
- }
+ return new Promise(async (resolve, reject) => {
+ try {
+ const newPathname = calculateDraggedItemNewPathname({
+ draggedItem,
+ targetItem,
+ dropType,
+ collectionPathname: collection.pathname
+ });
+ if (!newPathname) return;
+ if (targetItemPathname?.startsWith(draggedItemPathname)) return;
+ if (newPathname !== draggedItemPathname) {
+ await handleMoveToNewLocation({
+ targetItem,
+ targetItemDirectoryItems,
+ draggedItem,
+ draggedItemDirectoryItems,
+ newPathname,
+ dropType
+ });
+ } else {
+ await handleReorderInSameLocation({ draggedItem, targetItemDirectoryItems, targetItem });
+ }
+ resolve();
+ } catch (error) {
+ console.error(error);
+ toast.error(error?.message);
+ reject(error);
+ }
+ });
+ };
- // end of the file drags, now let's handle folder drags
- // folder drags are simpler since we don't allow ordering of folders
+export const updateItemsSequences =
+ ({ itemsToResequence }) =>
+ (dispatch, getState) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
- // folder dragged into its own folder
- if (isItemAFolder(draggedItem) && isItemAFolder(targetItem) && draggedItemParent === targetItem) {
- return resolve();
- }
-
- // folder dragged into a file which is at the same level
- // this is also true when both items are at the root level
- if (isItemAFolder(draggedItem) && isItemARequest(targetItem) && sameParent) {
- return resolve();
- }
-
- // folder dragged into a file which is a child of the folder
- if (isItemAFolder(draggedItem) && isItemARequest(targetItem) && draggedItem === targetItemParent) {
- return resolve();
- }
-
- // folder dragged into a file which is at the root level
- if (isItemAFolder(draggedItem) && isItemARequest(targetItem) && !targetItemParent) {
- const draggedItemPathname = draggedItem.pathname;
-
- return ipcRenderer
- .invoke('renderer:move-folder-item', draggedItemPathname, collectionCopy.pathname)
- .then(resolve)
- .catch((error) => reject(error));
- }
-
- // folder dragged into another folder
- if (isItemAFolder(draggedItem) && isItemAFolder(targetItem) && draggedItemParent !== targetItem) {
- const draggedItemPathname = draggedItem.pathname;
-
- return ipcRenderer
- .invoke('renderer:move-folder-item', draggedItemPathname, targetItem.pathname)
- .then(resolve)
- .catch((error) => reject(error));
- }
- });
-};
-
-export const moveItemToRootOfCollection = (collectionUid, draggedItemUid) => (dispatch, getState) => {
- const state = getState();
- const collection = findCollectionByUid(state.collections.collections, collectionUid);
-
- return new Promise((resolve, reject) => {
- if (!collection) {
- return reject(new Error('Collection not found'));
- }
-
- const collectionCopy = cloneDeep(collection);
- const draggedItem = findItemInCollection(collectionCopy, draggedItemUid);
- if (!draggedItem) {
- return reject(new Error('Dragged item not found'));
- }
-
- const draggedItemParent = findParentItemInCollection(collectionCopy, draggedItemUid);
- // file item is already at the root level
- if (!draggedItemParent) {
- return resolve();
- }
-
- const draggedItemPathname = draggedItem.pathname;
- moveCollectionItemToRootOfCollection(collectionCopy, draggedItem);
-
- if (isItemAFolder(draggedItem)) {
- return ipcRenderer
- .invoke('renderer:move-folder-item', draggedItemPathname, collectionCopy.pathname)
- .then(resolve)
- .catch((error) => reject(error));
- } else {
- const itemsToResequence = getItemsToResequence(draggedItemParent, collectionCopy);
- const itemsToResequence2 = getItemsToResequence(collectionCopy, collectionCopy);
-
- return ipcRenderer
- .invoke('renderer:move-file-item', draggedItemPathname, collectionCopy.pathname)
- .then(() => ipcRenderer.invoke('renderer:resequence-items', itemsToResequence))
- .then(() => ipcRenderer.invoke('renderer:resequence-items', itemsToResequence2))
- .then(resolve)
- .catch((error) => reject(error));
- }
- });
-};
+ ipcRenderer.invoke('renderer:resequence-items', itemsToResequence).then(resolve).catch(reject);
+ });
+ };
export const newHttpRequest = (params) => (dispatch, getState) => {
- const { requestName, requestType, requestUrl, requestMethod, collectionUid, itemUid, headers, body, auth } = params;
+ const {
+ requestName,
+ filename,
+ requestType,
+ requestUrl,
+ requestMethod,
+ collectionUid,
+ itemUid,
+ headers,
+ body,
+ auth,
+ settings
+ } = params;
return new Promise((resolve, reject) => {
const state = getState();
@@ -747,6 +887,7 @@ export const newHttpRequest = (params) => (dispatch, getState) => {
uid: uuid(),
type: requestType,
name: requestName,
+ filename,
request: {
method: requestMethod,
url: requestUrl,
@@ -759,29 +900,131 @@ export const newHttpRequest = (params) => (dispatch, getState) => {
xml: null,
sparql: null,
multipartForm: null,
- formUrlEncoded: null
+ formUrlEncoded: null,
+ file: null
},
auth: auth ?? {
- mode: 'none'
+ mode: 'inherit'
}
+ },
+ settings: settings ?? {
+ encodeUrl: true
}
};
// itemUid is null when we are creating a new request at the root level
- const filename = resolveRequestFilename(requestName);
+ const resolvedFilename = resolveRequestFilename(filename);
if (!itemUid) {
const reqWithSameNameExists = find(
collection.items,
- (i) => i.type !== 'folder' && trim(i.filename) === trim(filename)
+ (i) => i.type !== 'folder' && trim(i.filename) === trim(resolvedFilename)
);
- const requestItems = filter(collection.items, (i) => i.type !== 'folder');
- item.seq = requestItems.length + 1;
+ const items = filter(collection.items, (i) => isItemAFolder(i) || isItemARequest(i));
+ item.seq = items.length + 1;
if (!reqWithSameNameExists) {
- const fullName = `${collection.pathname}${PATH_SEPARATOR}${filename}`;
+ const fullName = path.join(collection.pathname, resolvedFilename);
const { ipcRenderer } = window;
- ipcRenderer.invoke('renderer:new-request', fullName, item).then(resolve).catch(reject);
+ ipcRenderer
+ .invoke('renderer:new-request', fullName, item)
+ .then(() => {
+ // task middleware will track this and open the new request in a new tab once request is created
+ dispatch(
+ insertTaskIntoQueue({
+ uid: uuid(),
+ type: 'OPEN_REQUEST',
+ collectionUid,
+ itemPathname: fullName
+ })
+ );
+ resolve();
+ })
+ .catch(reject);
+ } else {
+ return reject(new Error('Duplicate request names are not allowed under the same folder'));
+ }
+ } else {
+ const currentItem = findItemInCollection(collection, itemUid);
+ if (currentItem) {
+ const reqWithSameNameExists = find(
+ currentItem.items,
+ (i) => i.type !== 'folder' && trim(i.filename) === trim(resolvedFilename)
+ );
+ const items = filter(currentItem.items, (i) => isItemAFolder(i) || isItemARequest(i));
+ item.seq = items.length + 1;
+ if (!reqWithSameNameExists) {
+ const fullName = path.join(currentItem.pathname, resolvedFilename);
+ const { ipcRenderer } = window;
+ ipcRenderer
+ .invoke('renderer:new-request', fullName, item)
+ .then(() => {
+ // task middleware will track this and open the new request in a new tab once request is created
+ dispatch(
+ insertTaskIntoQueue({
+ uid: uuid(),
+ type: 'OPEN_REQUEST',
+ collectionUid,
+ itemPathname: fullName
+ })
+ );
+ resolve();
+ })
+ .catch(reject);
+ } else {
+ return reject(new Error('Duplicate request names are not allowed under the same folder'));
+ }
+ }
+ }
+ });
+};
+
+export const newGrpcRequest = (params) => (dispatch, getState) => {
+ const { requestName, filename, requestUrl, collectionUid, body, auth, headers, itemUid } = params;
+
+ return new Promise((resolve, reject) => {
+ const state = getState();
+ const collection = findCollectionByUid(state.collections.collections, collectionUid);
+ if (!collection) {
+ return reject(new Error('Collection not found'));
+ }
+ // do we need to handle query, path params for grpc requests?
+ // skipping for now
+
+ const item = {
+ uid: uuid(),
+ name: requestName,
+ filename,
+ type: 'grpc-request',
+ headers: headers ?? [],
+ request: {
+ url: requestUrl,
+ body: body ?? {
+ mode: 'grpc',
+ grpc: [
+ {
+ name: 'message 1',
+ content: '{}'
+ }
+ ]
+ },
+ auth: auth ?? {
+ mode: 'inherit'
+ }
+ }
+ };
+
+ const resolvedFilename = resolveRequestFilename(filename);
+ const fullName = path.join(collection.pathname, resolvedFilename);
+ const { ipcRenderer } = window;
+
+ // Set the seq field for gRPC requests
+ const items = filter(collection.items, (i) => isItemAFolder(i) || isItemARequest(i));
+ item.seq = items.length + 1;
+
+ ipcRenderer
+ .invoke('renderer:new-request', fullName, item)
+ .then(() => {
// task middleware will track this and open the new request in a new tab once request is created
dispatch(
insertTaskIntoQueue({
@@ -791,37 +1034,73 @@ export const newHttpRequest = (params) => (dispatch, getState) => {
itemPathname: fullName
})
);
- } else {
- return reject(new Error('Duplicate request names are not allowed under the same folder'));
- }
- } else {
- const currentItem = findItemInCollection(collection, itemUid);
- if (currentItem) {
- const reqWithSameNameExists = find(
- currentItem.items,
- (i) => i.type !== 'folder' && trim(i.filename) === trim(filename)
- );
- const requestItems = filter(currentItem.items, (i) => i.type !== 'folder');
- item.seq = requestItems.length + 1;
- if (!reqWithSameNameExists) {
- const fullName = `${currentItem.pathname}${PATH_SEPARATOR}${filename}`;
- const { ipcRenderer } = window;
+ resolve();
+ })
+ .catch(reject);
+ });
+};
- ipcRenderer.invoke('renderer:new-request', fullName, item).then(resolve).catch(reject);
- // task middleware will track this and open the new request in a new tab once request is created
- dispatch(
- insertTaskIntoQueue({
- uid: uuid(),
- type: 'OPEN_REQUEST',
- collectionUid,
- itemPathname: fullName
- })
- );
- } else {
- return reject(new Error('Duplicate request names are not allowed under the same folder'));
- }
- }
+export const loadGrpcMethodsFromReflection = (item, collectionUid, url) => async (dispatch, getState) => {
+ const state = getState();
+ const collection = findCollectionByUid(state.collections.collections, collectionUid);
+ const { globalEnvironments, activeGlobalEnvironmentUid } = state.globalEnvironments;
+
+ return new Promise((resolve, reject) => {
+ if (!collection) {
+ return reject(new Error('Collection not found'));
}
+
+ const itemCopy = cloneDeep(item);
+ const requestItem = itemCopy.draft ? itemCopy.draft : itemCopy;
+ requestItem.request.url = url;
+ const collectionCopy = cloneDeep(collection);
+ const globalEnvironmentVariables = getGlobalEnvironmentVariables({
+ globalEnvironments,
+ activeGlobalEnvironmentUid
+ });
+ collectionCopy.globalEnvironmentVariables = globalEnvironmentVariables;
+ const environment = findEnvironmentInCollection(collectionCopy, collectionCopy.activeEnvironmentUid);
+ const runtimeVariables = collectionCopy.runtimeVariables;
+
+ const { ipcRenderer } = window;
+ ipcRenderer
+ .invoke('grpc:load-methods-reflection', {
+ request: requestItem,
+ collection: collectionCopy,
+ environment,
+ runtimeVariables
+ })
+ .then(resolve)
+ .catch(reject);
+ });
+};
+
+export const generateGrpcurlCommand = (item, collectionUid) => async (dispatch, getState) => {
+ const state = getState();
+ const collection = findCollectionByUid(state.collections.collections, collectionUid);
+ const { globalEnvironments, activeGlobalEnvironmentUid } = state.globalEnvironments;
+
+ return new Promise((resolve, reject) => {
+ if (!collection) {
+ return reject(new Error('Collection not found'));
+ }
+
+ const itemCopy = cloneDeep(item);
+ const collectionCopy = cloneDeep(collection);
+
+ const globalEnvironmentVariables = getGlobalEnvironmentVariables({
+ globalEnvironments,
+ activeGlobalEnvironmentUid
+ });
+ collectionCopy.globalEnvironmentVariables = globalEnvironmentVariables;
+ const environment = findEnvironmentInCollection(collectionCopy, collectionCopy.activeEnvironmentUid);
+ const runtimeVariables = collectionCopy.runtimeVariables;
+
+ const { ipcRenderer } = window;
+ ipcRenderer
+ .invoke('grpc:generate-grpcurl', { request: itemCopy, collection: collectionCopy, environment, runtimeVariables })
+ .then(resolve)
+ .catch(reject);
});
};
@@ -833,6 +1112,7 @@ export const addEnvironment = (name, collectionUid) => (dispatch, getState) => {
return reject(new Error('Collection not found'));
}
+ const { ipcRenderer } = window;
ipcRenderer
.invoke('renderer:create-environment', collection.pathname, name)
.then(
@@ -859,15 +1139,18 @@ export const importEnvironment = (name, variables, collectionUid) => (dispatch,
return reject(new Error('Collection not found'));
}
+ const sanitizedName = sanitizeName(name);
+
+ const { ipcRenderer } = window;
ipcRenderer
- .invoke('renderer:create-environment', collection.pathname, name, variables)
+ .invoke('renderer:create-environment', collection.pathname, sanitizedName, variables)
.then(
dispatch(
updateLastAction({
collectionUid,
lastAction: {
type: 'ADD_ENVIRONMENT',
- payload: name
+ payload: sanitizedName
}
})
)
@@ -887,18 +1170,29 @@ export const copyEnvironment = (name, baseEnvUid, collectionUid) => (dispatch, g
const baseEnv = findEnvironmentInCollection(collection, baseEnvUid);
if (!collection) {
- return reject(new Error('Environmnent not found'));
+ return reject(new Error('Environment not found'));
}
+ const sanitizedName = sanitizeName(name);
+
+ const { ipcRenderer } = window;
+
+ // strip "ephemeral" metadata
+ const variablesToCopy = (baseEnv.variables || [])
+ .filter((v) => !v.ephemeral)
+ .map(({ ephemeral, ...rest }) => {
+ return rest;
+ });
+
ipcRenderer
- .invoke('renderer:create-environment', collection.pathname, name, baseEnv.variables)
+ .invoke('renderer:create-environment', collection.pathname, sanitizedName, variablesToCopy)
.then(
dispatch(
updateLastAction({
collectionUid,
lastAction: {
type: 'ADD_ENVIRONMENT',
- payload: name
+ payload: sanitizedName
}
})
)
@@ -922,12 +1216,14 @@ export const renameEnvironment = (newName, environmentUid, collectionUid) => (di
return reject(new Error('Environment not found'));
}
+ const sanitizedName = sanitizeName(newName);
const oldName = environment.name;
- environment.name = newName;
+ environment.name = sanitizedName;
+ const { ipcRenderer } = window;
environmentSchema
.validate(environment)
- .then(() => ipcRenderer.invoke('renderer:rename-environment', collection.pathname, oldName, newName))
+ .then(() => ipcRenderer.invoke('renderer:rename-environment', collection.pathname, oldName, sanitizedName))
.then(resolve)
.catch(reject);
});
@@ -948,6 +1244,7 @@ export const deleteEnvironment = (environmentUid, collectionUid) => (dispatch, g
return reject(new Error('Environment not found'));
}
+ const { ipcRenderer } = window;
ipcRenderer
.invoke('renderer:delete-environment', collection.pathname, environment.name)
.then(resolve)
@@ -969,16 +1266,97 @@ export const saveEnvironment = (variables, environmentUid, collectionUid) => (di
return reject(new Error('Environment not found'));
}
- environment.variables = variables;
+ /*
+ Modal Save writes what the user sees:
+ - Non-ephemeral vars are saved as-is (without metadata)
+ - Ephemeral vars:
+ - if persistedValue exists, save that (explicit persisted case)
+ - otherwise save the current UI value (treat as user-authored)
+ */
+ const persisted = buildPersistedEnvVariables(variables, { mode: 'save' });
+ environment.variables = persisted;
+
+ const { ipcRenderer } = window;
+ const envForValidation = cloneDeep(environment);
environmentSchema
.validate(environment)
- .then(() => ipcRenderer.invoke('renderer:save-environment', collection.pathname, environment))
+ .then(() => ipcRenderer.invoke('renderer:save-environment', collection.pathname, envForValidation))
+ .then(() => {
+ // Immediately sync Redux to the saved (persisted) set so old ephemerals
+ // aren’t around when the watcher event arrives.
+ dispatch(_saveEnvironment({ variables: persisted, environmentUid, collectionUid }));
+ })
.then(resolve)
.catch(reject);
});
};
+export const mergeAndPersistEnvironment =
+ ({ persistentEnvVariables, collectionUid }) =>
+ (_dispatch, getState) => {
+ return new Promise((resolve, reject) => {
+ const state = getState();
+ const collection = findCollectionByUid(state.collections.collections, collectionUid);
+
+ if (!collection) {
+ return reject(new Error('Collection not found'));
+ }
+
+ const environmentUid = collection.activeEnvironmentUid;
+ if (!environmentUid) {
+ return reject(new Error('No active environment found'));
+ }
+
+ const collectionCopy = cloneDeep(collection);
+ const environment = findEnvironmentInCollection(collectionCopy, environmentUid);
+ if (!environment) {
+ return reject(new Error('Environment not found'));
+ }
+
+ // Only proceed if there are persistent variables to save
+ if (!persistentEnvVariables || Object.keys(persistentEnvVariables).length === 0) {
+ return resolve();
+ }
+
+ let existingVars = environment.variables || [];
+
+ let normalizedNewVars = Object.entries(persistentEnvVariables).map(([name, value]) => ({
+ uid: uuid(),
+ name,
+ value,
+ type: 'text',
+ enabled: true,
+ secret: false
+ }));
+
+ const merged = existingVars.map((v) => {
+ const found = normalizedNewVars.find((nv) => nv.name === v.name);
+ if (found) {
+ return { ...v, value: found.value };
+ }
+ return v;
+ });
+ normalizedNewVars.forEach((nv) => {
+ if (!merged.some((v) => v.name === nv.name)) {
+ merged.push(nv);
+ }
+ });
+
+ // Save only non-ephemeral vars, or ephemerals explicitly persisted this run
+ const persistedNames = new Set(Object.keys(persistentEnvVariables));
+ const environmentToSave = cloneDeep(environment);
+ environmentToSave.variables = buildPersistedEnvVariables(merged, { mode: 'merge', persistedNames });
+
+ const { ipcRenderer } = window;
+ environmentSchema
+ .validate(environmentToSave)
+ .then(() => ipcRenderer.invoke('renderer:save-environment', collection.pathname, environmentToSave))
+ .then(resolve)
+ .catch(reject);
+ });
+ };
+
export const selectEnvironment = (environmentUid, collectionUid) => (dispatch, getState) => {
return new Promise((resolve, reject) => {
const state = getState();
@@ -989,15 +1367,17 @@ export const selectEnvironment = (environmentUid, collectionUid) => (dispatch, g
const collectionCopy = cloneDeep(collection);
- const environmentName = environmentUid
- ? findEnvironmentInCollection(collectionCopy, environmentUid)?.name
- : null;
+ const environmentName = environmentUid ? findEnvironmentInCollection(collectionCopy, environmentUid)?.name : null;
if (environmentUid && !environmentName) {
return reject(new Error('Environment not found'));
- }
-
- ipcRenderer.invoke('renderer:update-ui-state-snapshot', { type: 'COLLECTION_ENVIRONMENT', data: { collectionPath: collection?.pathname, environmentName }});
+ }
+
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('renderer:update-ui-state-snapshot', {
+ type: 'COLLECTION_ENVIRONMENT',
+ data: { collectionPath: collection?.pathname, environmentName }
+ });
dispatch(_selectEnvironment({ environmentUid, collectionUid }));
resolve();
@@ -1013,7 +1393,7 @@ export const removeCollection = (collectionUid) => (dispatch, getState) => {
}
const { ipcRenderer } = window;
ipcRenderer
- .invoke('renderer:remove-collection', collection.pathname)
+ .invoke('renderer:remove-collection', collection.pathname, collectionUid)
.then(() => {
dispatch(closeAllCollectionTabs({ collectionUid }));
})
@@ -1038,25 +1418,25 @@ export const browseDirectory = () => (dispatch, getState) => {
});
};
-export const browseFiles =
- (filters = []) =>
- (dispatch, getState) => {
- const { ipcRenderer } = window;
+export const browseFiles = (filters, properties) => (_dispatch, _getState) => {
+ const { ipcRenderer } = window;
- return new Promise((resolve, reject) => {
- ipcRenderer.invoke('renderer:browse-files', filters).then(resolve).catch(reject);
- });
- };
+ return new Promise((resolve, reject) => {
+ ipcRenderer.invoke('renderer:browse-files', filters, properties).then(resolve).catch(reject);
+ });
+};
export const updateBrunoConfig = (brunoConfig, collectionUid) => (dispatch, getState) => {
const state = getState();
const collection = findCollectionByUid(state.collections.collections, collectionUid);
- if (!collection) {
- return reject(new Error('Collection not found'));
- }
return new Promise((resolve, reject) => {
+ if (!collection) {
+ return reject(new Error('Collection not found'));
+ }
+
+ const { ipcRenderer } = window;
ipcRenderer
.invoke('renderer:update-bruno-config', brunoConfig, collection.pathname, collectionUid)
.then(resolve)
@@ -1075,12 +1455,21 @@ export const openCollectionEvent = (uid, pathname, brunoConfig) => (dispatch, ge
brunoConfig: brunoConfig
};
+ const { ipcRenderer } = window;
+
return new Promise((resolve, reject) => {
ipcRenderer.invoke('renderer:get-collection-security-config', pathname).then((securityConfig) => {
collectionSchema
.validate(collection)
.then(() => dispatch(_createCollection({ ...collection, securityConfig })))
- .then(resolve)
+ .then(() => {
+ // Expand sidebar if it's collapsed after collection is successfully opened
+ const state = getState();
+ if (state.app.sidebarCollapsed) {
+ dispatch(toggleSidebarCollapse());
+ }
+ resolve();
+ })
.catch(reject);
});
});
@@ -1096,7 +1485,7 @@ export const createCollection = (collectionName, collectionFolderName, collectio
.catch(reject);
});
};
-export const cloneCollection = (collectionName, collectionFolderName, collectionLocation, perviousPath) => () => {
+export const cloneCollection = (collectionName, collectionFolderName, collectionLocation, previousPath) => () => {
const { ipcRenderer } = window;
return ipcRenderer.invoke(
@@ -1104,7 +1493,7 @@ export const cloneCollection = (collectionName, collectionFolderName, collection
collectionName,
collectionFolderName,
collectionLocation,
- perviousPath
+ previousPath
);
};
export const openCollection = () => () => {
@@ -1148,6 +1537,21 @@ export const importCollection = (collection, collectionLocation) => (dispatch, g
});
};
+export const moveCollectionAndPersist =
+ ({ draggedItem, targetItem }) =>
+ (dispatch, getState) => {
+ dispatch(moveCollection({ draggedItem, targetItem }));
+
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+ const state = getState();
+
+ const collectionPaths = state.collections.collections.map((collection) => collection.pathname);
+
+ ipcRenderer.invoke('renderer:update-collection-paths', collectionPaths).then(resolve).catch(reject);
+ });
+ };
+
export const saveCollectionSecurityConfig = (collectionUid, securityConfig) => (dispatch, getState) => {
return new Promise((resolve, reject) => {
const { ipcRenderer } = window;
@@ -1164,32 +1568,199 @@ export const saveCollectionSecurityConfig = (collectionUid, securityConfig) => (
});
};
-
export const hydrateCollectionWithUiStateSnapshot = (payload) => (dispatch, getState) => {
- const collectionSnapshotData = payload;
- return new Promise((resolve, reject) => {
- const state = getState();
- try {
- if(!collectionSnapshotData) resolve();
- const { pathname, selectedEnvironment } = collectionSnapshotData;
- const collection = findCollectionByPathname(state.collections.collections, pathname);
- const collectionCopy = cloneDeep(collection);
- const collectionUid = collectionCopy?.uid;
+ const collectionSnapshotData = payload;
+ return new Promise((resolve, reject) => {
+ const state = getState();
+ try {
+ if (!collectionSnapshotData) resolve();
+ const { pathname, selectedEnvironment } = collectionSnapshotData;
+ const collection = findCollectionByPathname(state.collections.collections, pathname);
+ const collectionCopy = cloneDeep(collection);
+ const collectionUid = collectionCopy?.uid;
- // update selected environment
- if (selectedEnvironment) {
- const environment = findEnvironmentInCollectionByName(collectionCopy, selectedEnvironment);
- if (environment) {
- dispatch(_selectEnvironment({ environmentUid: environment?.uid, collectionUid }));
- }
+ // update selected environment
+ if (selectedEnvironment) {
+ const environment = findEnvironmentInCollectionByName(collectionCopy, selectedEnvironment);
+ if (environment) {
+ dispatch(_selectEnvironment({ environmentUid: environment?.uid, collectionUid }));
}
+ }
- // todo: add any other redux state that you want to save
-
+ // todo: add any other redux state that you want to save
+
+ resolve();
+ } catch (error) {
+ reject(error);
+ }
+ });
+};
+
+export const fetchOauth2Credentials = (payload) => async (dispatch, getState) => {
+ const { request, collection, itemUid, folderUid } = payload;
+ const state = getState();
+ const { globalEnvironments, activeGlobalEnvironmentUid } = state.globalEnvironments;
+ const globalEnvironmentVariables = getGlobalEnvironmentVariables({ globalEnvironments, activeGlobalEnvironmentUid });
+ request.globalEnvironmentVariables = globalEnvironmentVariables;
+ return new Promise((resolve, reject) => {
+ window.ipcRenderer
+ .invoke('renderer:fetch-oauth2-credentials', { itemUid, request, collection })
+ .then(({ credentials, url, collectionUid, credentialsId, debugInfo }) => {
+ dispatch(
+ collectionAddOauth2CredentialsByUrl({
+ credentials,
+ url,
+ collectionUid,
+ credentialsId,
+ debugInfo: safeParseJSON(safeStringifyJSON(debugInfo)),
+ folderUid: folderUid || null,
+ itemUid: !folderUid ? itemUid : null
+ })
+ );
+ resolve(credentials);
+ })
+ .catch(reject);
+ });
+};
+
+export const refreshOauth2Credentials = (payload) => async (dispatch, getState) => {
+ const { request, collection, folderUid, itemUid } = payload;
+ const state = getState();
+ const { globalEnvironments, activeGlobalEnvironmentUid } = state.globalEnvironments;
+ const globalEnvironmentVariables = getGlobalEnvironmentVariables({ globalEnvironments, activeGlobalEnvironmentUid });
+ request.globalEnvironmentVariables = globalEnvironmentVariables;
+ return new Promise((resolve, reject) => {
+ window.ipcRenderer
+ .invoke('renderer:refresh-oauth2-credentials', { itemUid, request, collection })
+ .then(({ credentials, url, collectionUid, debugInfo, credentialsId }) => {
+ dispatch(
+ collectionAddOauth2CredentialsByUrl({
+ credentials,
+ url,
+ collectionUid,
+ credentialsId,
+ debugInfo: safeParseJSON(safeStringifyJSON(debugInfo)),
+ folderUid: folderUid || null,
+ itemUid: !folderUid ? itemUid : null
+ })
+ );
+ resolve(credentials);
+ })
+ .catch(reject);
+ });
+};
+
+export const clearOauth2Cache = (payload) => async (dispatch, getState) => {
+ const { collectionUid, url, credentialsId } = payload;
+ return new Promise((resolve, reject) => {
+ window.ipcRenderer
+ .invoke('clear-oauth2-cache', collectionUid, url, credentialsId)
+ .then(() => {
+ dispatch(
+ collectionClearOauth2CredentialsByUrl({
+ url,
+ collectionUid
+ })
+ );
resolve();
- }
- catch(error) {
- reject(error);
- }
+ })
+ .catch(reject);
+ });
+};
+
+// todo: could be removed
+export const loadRequestViaWorker =
+ ({ collectionUid, pathname }) =>
+ (dispatch, getState) => {
+ return new Promise(async (resolve, reject) => {
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('renderer:load-request-via-worker', { collectionUid, pathname }).then(resolve).catch(reject);
});
- };
\ No newline at end of file
+ };
+
+// todo: could be removed
+export const loadRequest =
+ ({ collectionUid, pathname }) =>
+ (dispatch, getState) => {
+ return new Promise(async (resolve, reject) => {
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('renderer:load-request', { collectionUid, pathname }).then(resolve).catch(reject);
+ });
+ };
+
+export const loadLargeRequest =
+ ({ collectionUid, pathname }) =>
+ (dispatch, getState) => {
+ return new Promise(async (resolve, reject) => {
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('renderer:load-large-request', { collectionUid, pathname }).then(resolve).catch(reject);
+ });
+ };
+
+export const mountCollection =
+ ({ collectionUid, collectionPathname, brunoConfig }) =>
+ (dispatch, getState) => {
+ dispatch(updateCollectionMountStatus({ collectionUid, mountStatus: 'mounting' }));
+ return new Promise(async (resolve, reject) => {
+ callIpc('renderer:mount-collection', { collectionUid, collectionPathname, brunoConfig })
+ .then(() => dispatch(updateCollectionMountStatus({ collectionUid, mountStatus: 'mounted' })))
+ .then(resolve)
+ .catch(() => {
+ dispatch(updateCollectionMountStatus({ collectionUid, mountStatus: 'unmounted' }));
+ reject();
+ });
+ });
+ };
+
+export const showInFolder = (collectionPath) => () => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('renderer:show-in-folder', collectionPath).then(resolve).catch(reject);
+ });
+};
+
+export const updateRunnerConfiguration =
+ (collectionUid, selectedRequestItems, requestItemsOrder, delay) => (dispatch) => {
+ dispatch(
+ _updateRunnerConfiguration({
+ collectionUid,
+ selectedRequestItems,
+ requestItemsOrder,
+ delay
+ })
+ );
+ };
+
+export const updateActiveConnectionsInStore = (activeConnectionIds) => (dispatch, getState) => {
+ dispatch(updateActiveConnections(activeConnectionIds));
+};
+
+export const openCollectionSettings =
+ (collectionUid, tabName = 'overview') =>
+ (dispatch, getState) => {
+ const state = getState();
+ const collection = findCollectionByUid(state.collections.collections, collectionUid);
+
+ return new Promise((resolve, reject) => {
+ if (!collection) {
+ return reject(new Error('Collection not found'));
+ }
+
+ dispatch(
+ updateSettingsSelectedTab({
+ collectionUid: collection.uid,
+ tab: tabName
+ })
+ );
+
+ dispatch(
+ addTab({
+ uid: collection.uid,
+ collectionUid: collection.uid,
+ type: 'collection-settings'
+ })
+ );
+
+ resolve();
+ });
+ };
diff --git a/packages/bruno-app/src/providers/ReduxStore/slices/collections/index.js b/packages/bruno-app/src/providers/ReduxStore/slices/collections/index.js
index 11f12026f..2d6df3ec6 100644
--- a/packages/bruno-app/src/providers/ReduxStore/slices/collections/index.js
+++ b/packages/bruno-app/src/providers/ReduxStore/slices/collections/index.js
@@ -1,10 +1,11 @@
+import { parseQueryParams, buildQueryString as stringifyQueryParams } from '@usebruno/common/utils';
import { uuid } from 'utils/common';
-import { find, map, forOwn, concat, filter, each, cloneDeep, get, set } from 'lodash';
+import { find, map, forOwn, concat, filter, each, cloneDeep, get, set, findIndex } from 'lodash';
import { createSlice } from '@reduxjs/toolkit';
import {
addDepth,
areItemsTheSameExceptSeqUpdate,
- collapseCollection,
+ collapseAllItemsInCollection,
deleteItemInCollection,
deleteItemInCollectionByPathname,
findCollectionByPathname,
@@ -15,15 +16,55 @@ import {
isItemAFolder,
isItemARequest
} from 'utils/collections';
-import { parsePathParams, parseQueryParams, splitOnFirst, stringifyQueryParams } from 'utils/url';
-import { getDirectoryName, getSubdirectoriesFromRoot, PATH_SEPARATOR } from 'utils/common/platform';
+import { parsePathParams, splitOnFirst } from 'utils/url';
+import { getSubdirectoriesFromRoot } from 'utils/common/platform';
import toast from 'react-hot-toast';
+import mime from 'mime-types';
+import path from 'utils/common/path';
+import { getUniqueTagsFromItems } from 'utils/collections/index';
+
+// gRPC status code meanings
+const grpcStatusCodes = {
+ 0: 'OK',
+ 1: 'CANCELLED',
+ 2: 'UNKNOWN',
+ 3: 'INVALID_ARGUMENT',
+ 4: 'DEADLINE_EXCEEDED',
+ 5: 'NOT_FOUND',
+ 6: 'ALREADY_EXISTS',
+ 7: 'PERMISSION_DENIED',
+ 8: 'RESOURCE_EXHAUSTED',
+ 9: 'FAILED_PRECONDITION',
+ 10: 'ABORTED',
+ 11: 'OUT_OF_RANGE',
+ 12: 'UNIMPLEMENTED',
+ 13: 'INTERNAL',
+ 14: 'UNAVAILABLE',
+ 15: 'DATA_LOSS',
+ 16: 'UNAUTHENTICATED'
+};
const initialState = {
collections: [],
- collectionSortOrder: 'default'
+ collectionSortOrder: 'default',
+ activeConnections: []
};
+const initiatedGrpcResponse = {
+ statusCode: null,
+ statusText: 'STREAMING',
+ statusDescription: null,
+ headers: [],
+ metadata: null,
+ trailers: null,
+ statusDetails: null,
+ error: null,
+ isError: false,
+ duration: 0,
+ responses: [],
+ timestamp: Date.now(),
+}
+
export const collectionsSlice = createSlice({
name: 'collections',
initialState,
@@ -32,8 +73,13 @@ export const collectionsSlice = createSlice({
const collectionUids = map(state.collections, (c) => c.uid);
const collection = action.payload;
- collection.settingsSelectedTab = 'headers';
+ collection.settingsSelectedTab = 'overview';
collection.folderLevelSettingsSelectedTab = {};
+ collection.allTags = []; // Initialize collection-level tags
+
+ // Collection mount status is used to track the mount status of the collection
+ // values can be 'unmounted', 'mounting', 'mounted'
+ collection.mountStatus = 'unmounted';
// TODO: move this to use the nextAction approach
// last action is used to track the last action performed on the collection
@@ -44,12 +90,26 @@ export const collectionsSlice = createSlice({
collection.importedAt = new Date().getTime();
collection.lastAction = null;
- collapseCollection(collection);
+ collapseAllItemsInCollection(collection);
addDepth(collection.items);
if (!collectionUids.includes(collection.uid)) {
state.collections.push(collection);
}
},
+ updateCollectionMountStatus: (state, action) => {
+ const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
+ if (collection) {
+ if (action.payload.mountStatus) {
+ collection.mountStatus = action.payload.mountStatus;
+ }
+ }
+ },
+ updateCollectionLoadingState: (state, action) => {
+ const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
+ if (collection) {
+ collection.isLoading = action.payload.isLoading;
+ }
+ },
setCollectionSecurityConfig: (state, action) => {
const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
if (collection) {
@@ -76,18 +136,25 @@ export const collectionsSlice = createSlice({
},
sortCollections: (state, action) => {
state.collectionSortOrder = action.payload.order;
+ const collator = new Intl.Collator(undefined, {numeric: true, sensitivity: 'base'});
switch (action.payload.order) {
case 'default':
state.collections = state.collections.sort((a, b) => a.importedAt - b.importedAt);
break;
case 'alphabetical':
- state.collections = state.collections.sort((a, b) => a.name.localeCompare(b.name));
+ state.collections = state.collections.sort((a, b) => collator.compare(a.name, b.name));
break;
case 'reverseAlphabetical':
- state.collections = state.collections.sort((a, b) => b.name.localeCompare(a.name));
+ state.collections = state.collections.sort((a, b) => -collator.compare(a.name, b.name));
break;
}
},
+ moveCollection: (state, action) => {
+ const { draggedItem, targetItem } = action.payload;
+ state.collections = state.collections.filter((i) => i.uid !== draggedItem.uid); // Remove dragged item
+ const targetItemIndex = state.collections.findIndex((i) => i.uid === targetItem.uid); // Find target item
+ state.collections.splice(targetItemIndex, 0, draggedItem); // Insert dragged-item above target-item
+ },
updateLastAction: (state, action) => {
const { collectionUid, lastAction } = action.payload;
const collection = findCollectionByUid(state.collections, collectionUid);
@@ -217,7 +284,20 @@ export const collectionsSlice = createSlice({
const variable = find(activeEnvironment.variables, (v) => v.name === key);
if (variable) {
- variable.value = value;
+ // For updates coming from scripts, treat them as ephemeral overlays.
+ if (variable.value !== value) {
+ /*
+ Overlay (persist: false): keep new value in Redux for UI and mark ephemeral
+ so it isn't written to disk. persistedValue stores the previous on-disk value;
+ save/persist uses that base unless the key is explicitly persisted.
+ */
+ const previousValue = variable.value;
+ variable.value = value;
+ variable.ephemeral = true;
+ if (variable.persistedValue === undefined) {
+ variable.persistedValue = previousValue;
+ }
+ }
} else {
// __name__ is a private variable used to store the name of the environment
// this is not a user defined variable and hence should not be updated
@@ -228,7 +308,8 @@ export const collectionsSlice = createSlice({
secret: false,
enabled: true,
type: 'text',
- uid: uuid()
+ uid: uuid(),
+ ephemeral: true,
});
}
}
@@ -255,21 +336,208 @@ export const collectionsSlice = createSlice({
if (item) {
item.response = null;
item.cancelTokenUid = null;
+ item.requestUid = null;
+ item.requestStartTime = null;
}
}
},
responseReceived: (state, action) => {
const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
-
+
if (collection) {
const item = findItemInCollection(collection, action.payload.itemUid);
if (item) {
item.requestState = 'received';
item.response = action.payload.response;
item.cancelTokenUid = null;
+ item.requestStartTime = null;
+
+ if (!collection.timeline) {
+ collection.timeline = [];
+ }
+
+ // Ensure timestamp is a number (milliseconds since epoch)
+ const timestamp = item?.requestSent?.timestamp instanceof Date
+ ? item.requestSent.timestamp.getTime()
+ : item?.requestSent?.timestamp || Date.now();
+
+ // Append the new timeline entry with numeric timestamp
+ collection.timeline.push({
+ type: "request",
+ collectionUid: collection.uid,
+ folderUid: null,
+ itemUid: item.uid,
+ timestamp: timestamp,
+ data: {
+ request: item.requestSent || item.request,
+ response: action.payload.response,
+ timestamp: timestamp,
+ }
+ });
}
}
},
+ runGrpcRequestEvent: (state, action) => {
+ const { itemUid, collectionUid, eventType, eventData } = action.payload;
+ const collection = findCollectionByUid(state.collections, collectionUid);
+ if (!collection) return;
+
+ const item = findItemInCollection(collection, itemUid);
+ if (!item) return;
+ const request = item.draft ? item.draft.request : item.request;
+ const isUnary = request.methodType === 'unary';
+
+ if (eventType === 'request') {
+ item.requestSent = eventData;
+ item.requestSent.timestamp = Date.now();
+ item.response = {
+ initiatedGrpcResponse,
+ statusText: isUnary ? 'PENDING' : 'STREAMING'
+ };
+ }
+
+ if (!collection.timeline) {
+ collection.timeline = [];
+ }
+
+ collection.timeline.push({
+ type: "request",
+ eventType: eventType, // Add the specific gRPC event type
+ collectionUid: collection.uid,
+ folderUid: null,
+ itemUid: item.uid,
+ timestamp: Date.now(),
+ data: {
+ request: eventData || item.requestSent || item.request,
+ timestamp: Date.now(),
+ eventData: eventData,
+ }
+ });
+
+ },
+ grpcResponseReceived: (state, action) => {
+ const { itemUid, collectionUid, eventType, eventData } = action.payload;
+ const collection = findCollectionByUid(state.collections, collectionUid);
+
+ if (!collection) return;
+
+ const item = findItemInCollection(collection, itemUid);
+
+ if (!item) return;
+
+ // Get current response state or create initial state
+ const currentResponse = item.response || initiatedGrpcResponse
+ const timestamp = item?.requestSent?.timestamp;
+ let updatedResponse = { ...currentResponse, duration: Date.now() - (timestamp || Date.now()) };
+
+
+ // Process based on event type
+ switch (eventType) {
+ case 'response':
+ const { error, res } = eventData;
+
+ // Handle error if present
+ if (error) {
+ const errorCode = error.code || 2; // Default to UNKNOWN if no code
+
+ updatedResponse.error = error.details || 'gRPC error occurred';
+ updatedResponse.statusCode = errorCode;
+ updatedResponse.statusText = grpcStatusCodes[errorCode] || 'UNKNOWN';
+ updatedResponse.errorDetails = error;
+ updatedResponse.isError = true;
+ }
+
+ // Add response to list
+ updatedResponse.responses = res
+ ? [...(currentResponse?.responses || []), res]
+ : [...(currentResponse?.responses || [])];
+ break;
+
+ case 'metadata':
+ updatedResponse.headers = eventData.metadata;
+ updatedResponse.metadata = eventData.metadata;
+ break;
+
+ case 'status':
+ // Extract status info
+ const statusCode = eventData.status?.code;
+ const statusDetails = eventData.status?.details;
+ const statusMetadata = eventData.status?.metadata;
+
+ // Set status based on actual code and details
+ updatedResponse.statusCode = statusCode;
+ updatedResponse.statusText = grpcStatusCodes[statusCode] || 'UNKNOWN';
+ updatedResponse.statusDescription = statusDetails;
+ updatedResponse.statusDetails = eventData.status;
+
+ // Store trailers (status metadata)
+ if (statusMetadata) {
+ updatedResponse.trailers = statusMetadata;
+ }
+
+ // Handle error status (non-zero code)
+ if (statusCode !== 0) {
+ updatedResponse.isError = true;
+ updatedResponse.error = statusDetails || `gRPC error with code ${statusCode} (${updatedResponse.statusText})`;
+ }
+
+ break;
+
+ case 'error':
+ // Extract error details
+ const errorCode = eventData.error?.code || 2; // Default to UNKNOWN if no code
+ const errorDetails = eventData.error?.details || eventData.error?.message;
+ const errorMetadata = eventData.error?.metadata;
+
+ updatedResponse.isError = true;
+ updatedResponse.error = errorDetails || 'Unknown gRPC error';
+ updatedResponse.statusCode = errorCode;
+ updatedResponse.statusText = grpcStatusCodes[errorCode] || 'UNKNOWN';
+ updatedResponse.statusDescription = errorDetails;
+
+ // Store error metadata as trailers if present
+ if (errorMetadata) {
+ updatedResponse.trailers = errorMetadata;
+ }
+
+ break;
+
+ case 'end':
+ state.activeConnections = state.activeConnections.filter(id => id !== itemUid);
+ break;
+
+ case 'cancel':
+ updatedResponse.statusCode = 1; // CANCELLED
+ updatedResponse.statusText = 'CANCELLED';
+ updatedResponse.statusDescription = 'Stream cancelled by client or server';
+ state.activeConnections = state.activeConnections.filter(id => id !== itemUid);
+ break;
+ }
+
+ item.requestState = 'received';
+ item.response = updatedResponse;
+
+ // Update the timeline
+ if (!collection?.timeline) {
+ collection.timeline = [];
+ }
+
+ // Append the new timeline entry with specific gRPC event type
+ collection.timeline.push({
+ type: "request",
+ eventType: eventType, // Add the specific gRPC event type
+ collectionUid: collection.uid,
+ folderUid: null,
+ itemUid: item.uid,
+ timestamp: Date.now(),
+ data: {
+ request: item.requestSent || item.request,
+ response: updatedResponse,
+ eventData: eventData, // Store the original event data
+ timestamp: Date.now(),
+ }
+ });
+ },
responseCleared: (state, action) => {
const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
@@ -280,6 +548,23 @@ export const collectionsSlice = createSlice({
}
}
},
+ clearTimeline: (state, action) => {
+ const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
+
+ if (collection) {
+ collection.timeline = [];
+ }
+ },
+ clearRequestTimeline: (state, action) => {
+ const { collectionUid, itemUid } = action.payload || {};
+ const collection = findCollectionByUid(state.collections, collectionUid);
+
+ if (collection) {
+ if (itemUid) {
+ collection.timeline = collection?.timeline?.filter(t => t?.itemUid !== itemUid);
+ }
+ }
+ },
saveRequest: (state, action) => {
const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
@@ -358,14 +643,14 @@ export const collectionsSlice = createSlice({
collection.items.push(item);
}
},
- collectionClicked: (state, action) => {
+ toggleCollection: (state, action) => {
const collection = findCollectionByUid(state.collections, action.payload);
if (collection) {
collection.collapsed = !collection.collapsed;
}
},
- collectionFolderClicked: (state, action) => {
+ toggleCollectionItem: (state, action) => {
const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
if (collection) {
@@ -444,6 +729,20 @@ export const collectionsSlice = createSlice({
}
}
},
+ updateItemSettings: (state, action) => {
+ const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
+
+ if (collection) {
+ const item = findItemInCollection(collection, action.payload.itemUid);
+
+ if (item && isItemARequest(item)) {
+ if (!item.draft) {
+ item.draft = cloneDeep(item);
+ }
+ item.draft.settings = { ...item.draft.settings, ...action.payload.settings };
+ }
+ }
+ },
updateAuth: (state, action) => {
const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
@@ -515,7 +814,48 @@ export const collectionsSlice = createSlice({
}
}
},
+ setQueryParams: (state, action) => {
+ const { collectionUid, itemUid, params } = action.payload;
+ const collection = findCollectionByUid(state.collections, collectionUid);
+ if (!collection) {
+ return;
+ }
+
+ const item = findItemInCollection(collection, itemUid);
+ if (!item || !isItemARequest(item)) {
+ return;
+ }
+
+ if (!item.draft) {
+ item.draft = cloneDeep(item);
+ }
+ const existingOtherParams = item.draft.request.params?.filter(p => p.type !== 'query') || [];
+ const newQueryParams = map(params, ({ name = '', value = '', enabled = true }) => ({
+ uid: uuid(),
+ name,
+ value,
+ description: '',
+ type: 'query',
+ enabled
+ }));
+
+ item.draft.request.params = [...newQueryParams, ...existingOtherParams];
+
+ // Update the request URL to reflect the new query params
+ const parts = splitOnFirst(item.draft.request.url, '?');
+ const query = stringifyQueryParams(
+ filter(item.draft.request.params, (p) => p.enabled && p.type === 'query')
+ );
+
+ // If there are enabled query params, append them to the URL
+ if (query && query.length) {
+ item.draft.request.url = parts[0] + '?' + query;
+ } else {
+ // If no enabled query params, remove the query part from URL
+ item.draft.request.url = parts[0];
+ }
+ },
moveQueryParam: (state, action) => {
const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
@@ -721,6 +1061,67 @@ export const collectionsSlice = createSlice({
}
}
},
+ setRequestHeaders: (state, action) => {
+ const { collectionUid, itemUid, headers } = action.payload;
+
+ const collection = findCollectionByUid(state.collections, collectionUid);
+ if (!collection) {
+ return;
+ }
+
+ const item = findItemInCollection(collection, itemUid);
+ if (!item || !isItemARequest(item)) {
+ return;
+ }
+
+ if (!item.draft) {
+ item.draft = cloneDeep(item);
+ }
+ item.draft.request.headers = map(action.payload.headers, ({name = '', value = '', enabled = true}) => ({
+ uid: uuid(),
+ name: name,
+ value: value,
+ description: '',
+ enabled: enabled
+ }));
+ },
+ setCollectionHeaders: (state, action) => {
+ const { collectionUid, headers } = action.payload;
+
+ const collection = findCollectionByUid(state.collections, collectionUid);
+ if (!collection) {
+ return;
+ }
+
+ collection.root.request.headers = map(headers, ({name = '', value = '', enabled = true}) => ({
+ uid: uuid(),
+ name: name,
+ value: value,
+ description: '',
+ enabled: enabled
+ }));
+ },
+ setFolderHeaders: (state, action) => {
+ const { collectionUid, folderUid, headers } = action.payload;
+
+ const collection = findCollectionByUid(state.collections, collectionUid);
+ if (!collection) {
+ return;
+ }
+
+ const folder = findItemInCollection(collection, folderUid);
+ if (!folder || !isItemAFolder(folder)) {
+ return;
+ }
+
+ folder.root.request.headers = map(headers, ({name = '', value = '', enabled = true}) => ({
+ uid: uuid(),
+ name: name,
+ value: value,
+ description: '',
+ enabled: enabled
+ }));
+ },
addFormUrlEncodedParam: (state, action) => {
const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
@@ -885,6 +1286,76 @@ export const collectionsSlice = createSlice({
}
}
},
+ addFile: (state, action) => {
+ const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
+
+ if (collection) {
+ const item = findItemInCollection(collection, action.payload.itemUid);
+
+ if (item && isItemARequest(item)) {
+ if (!item.draft) {
+ item.draft = cloneDeep(item);
+ }
+ item.draft.request.body.file = item.draft.request.body.file || [];
+
+ item.draft.request.body.file.push({
+ uid: uuid(),
+ filePath: '',
+ contentType: '',
+ selected: false
+ });
+ }
+ }
+ },
+ updateFile: (state, action) => {
+ const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
+
+ if (collection) {
+ const item = findItemInCollection(collection, action.payload.itemUid);
+
+ if (item && isItemARequest(item)) {
+ if (!item.draft) {
+ item.draft = cloneDeep(item);
+ }
+
+ const param = find(item.draft.request.body.file, (p) => p.uid === action.payload.param.uid);
+
+ if (param) {
+ const contentType = mime.contentType(path.extname(action.payload.param.filePath));
+ param.filePath = action.payload.param.filePath;
+ param.contentType = action.payload.param.contentType || contentType || '';
+ param.selected = action.payload.param.selected;
+
+ item.draft.request.body.file = item.draft.request.body.file.map((p) => {
+ p.selected = p.uid === param.uid;
+ return p;
+ });
+ }
+ }
+ }
+ },
+ deleteFile: (state, action) => {
+ const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
+
+ if (collection) {
+ const item = findItemInCollection(collection, action.payload.itemUid);
+
+ if (item && isItemARequest(item)) {
+ if (!item.draft) {
+ item.draft = cloneDeep(item);
+ }
+
+ item.draft.request.body.file = filter(
+ item.draft.request.body.file,
+ (p) => p.uid !== action.payload.paramUid
+ );
+
+ if (item.draft.request.body.file.length > 0) {
+ item.draft.request.body.file[0].selected = true;
+ }
+ }
+ }
+ },
updateRequestAuthMode: (state, action) => {
const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
@@ -924,6 +1395,7 @@ export const collectionsSlice = createSlice({
if (!item.draft) {
item.draft = cloneDeep(item);
}
+
switch (item.draft.request.body.mode) {
case 'json': {
item.draft.request.body.json = action.payload.content;
@@ -941,6 +1413,10 @@ export const collectionsSlice = createSlice({
item.draft.request.body.sparql = action.payload.content;
break;
}
+ case 'file': {
+ item.draft.request.body.file = action.payload.content;
+ break;
+ }
case 'formUrlEncoded': {
item.draft.request.body.formUrlEncoded = action.payload.content;
break;
@@ -949,6 +1425,10 @@ export const collectionsSlice = createSlice({
item.draft.request.body.multipartForm = action.payload.content;
break;
}
+ case 'grpc': {
+ item.draft.request.body.grpc = action.payload.content;
+ break;
+ }
}
}
}
@@ -1040,6 +1520,21 @@ export const collectionsSlice = createSlice({
item.draft = cloneDeep(item);
}
item.draft.request.method = action.payload.method;
+ item.draft.request.methodType = action.payload.methodType;
+ }
+ }
+ },
+ updateRequestProtoPath: (state, action) => {
+ const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
+
+ if (collection) {
+ const item = findItemInCollection(collection, action.payload.itemUid);
+
+ if (item && isItemARequest(item)) {
+ if (!item.draft) {
+ item.draft = cloneDeep(item);
+ }
+ item.draft.request.protoPath = action.payload.protoPath;
}
}
},
@@ -1444,6 +1939,44 @@ export const collectionsSlice = createSlice({
set(folder, 'root.request.tests', action.payload.tests);
}
},
+ updateFolderAuth: (state, action) => {
+ const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
+ if (!collection) return;
+
+ const folder = collection ? findItemInCollection(collection, action.payload.itemUid) : null;
+ if (!folder) return;
+
+ if (folder) {
+ set(folder, 'root.request.auth', {});
+ set(folder, 'root.request.auth.mode', action.payload.mode);
+ switch (action.payload.mode) {
+ case 'oauth2':
+ set(folder, 'root.request.auth.oauth2', action.payload.content);
+ break;
+ case 'basic':
+ set(folder, 'root.request.auth.basic', action.payload.content);
+ break;
+ case 'bearer':
+ set(folder, 'root.request.auth.bearer', action.payload.content);
+ break;
+ case 'digest':
+ set(folder, 'root.request.auth.digest', action.payload.content);
+ break;
+ case 'ntlm':
+ set(folder, 'root.request.auth.ntlm', action.payload.content);
+ break;
+ case 'apikey':
+ set(folder, 'root.request.auth.apikey', action.payload.content);
+ break;
+ case 'awsv4':
+ set(folder, 'root.request.auth.awsv4', action.payload.content);
+ break;
+ case 'wsse':
+ set(folder, 'root.request.auth.wsse', action.payload.content);
+ break;
+ }
+ }
+ },
addCollectionHeader: (state, action) => {
const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
@@ -1560,34 +2093,39 @@ export const collectionsSlice = createSlice({
}
if (isFolderRoot) {
- const folderPath = getDirectoryName(file.meta.pathname);
+ const folderPath = path.dirname(file.meta.pathname);
const folderItem = findItemInCollectionByPathname(collection, folderPath);
if (folderItem) {
+ if (file?.data?.meta?.name) {
+ folderItem.name = file?.data?.meta?.name;
+ }
folderItem.root = file.data;
+ if (file?.data?.meta?.seq) {
+ folderItem.seq = file.data?.meta?.seq;
+ }
}
return;
}
if (collection) {
- const dirname = getDirectoryName(file.meta.pathname);
+ const dirname = path.dirname(file.meta.pathname);
const subDirectories = getSubdirectoriesFromRoot(collection.pathname, dirname);
let currentPath = collection.pathname;
let currentSubItems = collection.items;
for (const directoryName of subDirectories) {
- let childItem = currentSubItems.find((f) => f.type === 'folder' && f.name === directoryName);
+ let childItem = currentSubItems.find((f) => f.type === 'folder' && f.filename === directoryName);
+ currentPath = path.join(currentPath, directoryName);
if (!childItem) {
childItem = {
uid: uuid(),
- pathname: `${currentPath}${PATH_SEPARATOR}${directoryName}`,
+ pathname: currentPath,
name: directoryName,
collapsed: true,
type: 'folder',
- items: []
+ items: [],
};
currentSubItems.push(childItem);
}
-
- currentPath = `${currentPath}${PATH_SEPARATOR}${directoryName}`;
currentSubItems = childItem.items;
}
@@ -1600,20 +2138,32 @@ export const collectionsSlice = createSlice({
currentItem.name = file.data.name;
currentItem.type = file.data.type;
currentItem.seq = file.data.seq;
+ currentItem.tags = file.data.tags;
currentItem.request = file.data.request;
currentItem.filename = file.meta.name;
currentItem.pathname = file.meta.pathname;
+ currentItem.settings = file.data.settings;
currentItem.draft = null;
+ currentItem.partial = file.partial;
+ currentItem.loading = file.loading;
+ currentItem.size = file.size;
+ currentItem.error = file.error;
} else {
currentSubItems.push({
uid: file.data.uid,
name: file.data.name,
type: file.data.type,
seq: file.data.seq,
+ tags: file.data.tags,
request: file.data.request,
+ settings: file.data.settings,
filename: file.meta.name,
pathname: file.meta.pathname,
- draft: null
+ draft: null,
+ partial: file.partial,
+ loading: file.loading,
+ size: file.size,
+ error: file.error
});
}
}
@@ -1629,20 +2179,21 @@ export const collectionsSlice = createSlice({
let currentPath = collection.pathname;
let currentSubItems = collection.items;
for (const directoryName of subDirectories) {
- let childItem = currentSubItems.find((f) => f.type === 'folder' && f.name === directoryName);
+ let childItem = currentSubItems.find((f) => f.type === 'folder' && f.filename === directoryName);
+ currentPath = path.join(currentPath, directoryName);
if (!childItem) {
childItem = {
- uid: uuid(),
- pathname: `${currentPath}${PATH_SEPARATOR}${directoryName}`,
- name: directoryName,
+ uid: dir?.meta?.uid || uuid(),
+ pathname: currentPath,
+ name: dir?.meta?.name || directoryName,
+ seq: dir?.meta?.seq,
+ filename: directoryName,
collapsed: true,
type: 'folder',
items: []
};
currentSubItems.push(childItem);
}
-
- currentPath = `${currentPath}${PATH_SEPARATOR}${directoryName}`;
currentSubItems = childItem.items;
}
addDepth(collection.items);
@@ -1650,11 +2201,28 @@ export const collectionsSlice = createSlice({
},
collectionChangeFileEvent: (state, action) => {
const { file } = action.payload;
+ const isCollectionRoot = file.meta.collectionRoot ? true : false;
+ const isFolderRoot = file.meta.folderRoot ? true : false;
const collection = findCollectionByUid(state.collections, file.meta.collectionUid);
+ if (isCollectionRoot) {
+ if (collection) {
+ collection.root = file.data;
+ }
+ return;
+ }
- // check and update collection root
- if (collection && file.meta.collectionRoot) {
- collection.root = file.data;
+ if (isFolderRoot) {
+ const folderPath = path.dirname(file.meta.pathname);
+ const folderItem = findItemInCollectionByPathname(collection, folderPath);
+ if (folderItem) {
+ if (file?.data?.meta?.name) {
+ folderItem.name = file?.data?.meta?.name;
+ }
+ if (file?.data?.meta?.seq) {
+ folderItem.seq = file?.data?.meta?.seq;
+ }
+ folderItem.root = file.data;
+ }
return;
}
@@ -1667,11 +2235,19 @@ export const collectionsSlice = createSlice({
// we don't want to lose the draft in this case
if (areItemsTheSameExceptSeqUpdate(item, file.data)) {
item.seq = file.data.seq;
+ if (item?.draft) {
+ item.draft.seq = file.data.seq;
+ }
+ if (item?.draft && areItemsTheSameExceptSeqUpdate(item?.draft, file.data)) {
+ item.draft = null;
+ }
} else {
item.name = file.data.name;
item.type = file.data.type;
item.seq = file.data.seq;
+ item.tags = file.data.tags;
item.request = file.data.request;
+ item.settings = file.data.settings;
item.filename = file.meta.name;
item.pathname = file.meta.pathname;
item.draft = null;
@@ -1713,7 +2289,21 @@ export const collectionsSlice = createSlice({
const existingEnv = collection.environments.find((e) => e.uid === environment.uid);
if (existingEnv) {
+ const prevEphemerals = (existingEnv.variables || []).filter((v) => v.ephemeral);
existingEnv.variables = environment.variables;
+ /*
+ Apply temporary (ephemeral) values only to variables that actually exist in the file. This prevents deleted temporaries from “popping back” after a save. If a variable is present in the file, we temporarily override the UI value while also remembering the on-disk value in persistedValue for future saves.
+ */
+ prevEphemerals.forEach((ev) => {
+ const target = existingEnv.variables?.find((v) => v.name === ev.name);
+ if (target) {
+ if (target.value !== ev.value) {
+ if (target.persistedValue === undefined) target.persistedValue = target.value;
+ target.value = ev.value;
+ }
+ target.ephemeral = true;
+ }
+ });
} else {
collection.environments.push(environment);
collection.environments.sort((a, b) => a.name.localeCompare(b.name));
@@ -1744,6 +2334,25 @@ export const collectionsSlice = createSlice({
collection.runnerResult = null;
}
},
+ initRunRequestEvent: (state, action) => {
+ const { requestUid, itemUid, collectionUid } = action.payload;
+ const collection = findCollectionByUid(state.collections, collectionUid);
+ if (!collection) return;
+
+ const item = findItemInCollection(collection, itemUid);
+ if (!item) return;
+
+ item.requestState = null;
+ item.requestUid = requestUid;
+ item.requestStartTime = Date.now();
+ item.testResults = [];
+ item.preRequestTestResults = [];
+ item.postResponseTestResults = [];
+ item.assertionResults = [];
+ item.preRequestScriptErrorMessage = null;
+ item.postResponseScriptErrorMessage = null;
+ item.testScriptErrorMessage = null;
+ },
runRequestEvent: (state, action) => {
const { itemUid, collectionUid, type, requestUid } = action.payload;
const collection = findCollectionByUid(state.collections, collectionUid);
@@ -1751,9 +2360,25 @@ export const collectionsSlice = createSlice({
if (collection) {
const item = findItemInCollection(collection, itemUid);
if (item) {
+ // ignore outdated updates in case multiple requests are fired rapidly to avoid state inconsistency
+ if (item.requestUid !== requestUid) return;
+
+ if (type === 'pre-request-script-execution') {
+ item.preRequestScriptErrorMessage = action.payload.errorMessage;
+ }
+
+ if(type === 'post-response-script-execution') {
+ item.postResponseScriptErrorMessage = action.payload.errorMessage;
+ }
+
+ if(type === 'test-script-execution') {
+ item.testScriptErrorMessage = action.payload.errorMessage;
+ }
+
if (type === 'request-queued') {
const { cancelTokenUid } = action.payload;
- item.requestUid = requestUid;
+ // ignore if request is already in progress or completed
+ if (['sending', 'received'].includes(item.requestState)) return;
item.requestState = 'queued';
item.cancelTokenUid = cancelTokenUid;
}
@@ -1761,10 +2386,9 @@ export const collectionsSlice = createSlice({
if (type === 'request-sent') {
const { cancelTokenUid, requestSent } = action.payload;
item.requestSent = requestSent;
-
+
// sometimes the response is received before the request-sent event arrives
- if (item.requestUid === requestUid && item.requestState === 'queued') {
- item.requestUid = requestUid;
+ if (item.requestState === 'queued') {
item.requestState = 'sending';
item.cancelTokenUid = cancelTokenUid;
}
@@ -1779,6 +2403,16 @@ export const collectionsSlice = createSlice({
const { results } = action.payload;
item.testResults = results;
}
+
+ if (type === 'test-results-pre-request') {
+ const { results } = action.payload;
+ item.preRequestTestResults = results;
+ }
+
+ if (type === 'test-results-post-response') {
+ const { results } = action.payload;
+ item.postResponseTestResults = results;
+ }
}
}
},
@@ -1835,6 +2469,16 @@ export const collectionsSlice = createSlice({
item.testResults = action.payload.testResults;
}
+ if (type === 'test-results-pre-request') {
+ const item = collection.runnerResult.items.findLast((i) => i.uid === request.uid);
+ item.preRequestTestResults = action.payload.preRequestTestResults;
+ }
+
+ if (type === 'test-results-post-response') {
+ const item = collection.runnerResult.items.findLast((i) => i.uid === request.uid);
+ item.postResponseTestResults = action.payload.postResponseTestResults;
+ }
+
if (type === 'assertion-results') {
const item = collection.runnerResult.items.findLast((i) => i.uid === request.uid);
item.assertionResults = action.payload.assertionResults;
@@ -1852,6 +2496,21 @@ export const collectionsSlice = createSlice({
item.status = 'skipped';
item.responseReceived = action.payload.responseReceived;
}
+
+ if (type === 'post-response-script-execution') {
+ const item = collection.runnerResult.items.findLast((i) => i.uid === request.uid);
+ item.postResponseScriptErrorMessage = action.payload.errorMessage;
+ }
+
+ if (type === 'test-script-execution') {
+ const item = collection.runnerResult.items.findLast((i) => i.uid === request.uid);
+ item.testScriptErrorMessage = action.payload.errorMessage;
+ }
+
+ if (type === 'pre-request-script-execution') {
+ const item = collection.runnerResult.items.findLast((i) => i.uid === request.uid);
+ item.preRequestScriptErrorMessage = action.payload.errorMessage;
+ }
}
},
resetCollectionRunner: (state, action) => {
@@ -1860,6 +2519,32 @@ export const collectionsSlice = createSlice({
if (collection) {
collection.runnerResult = null;
+ collection.runnerTags = { include: [], exclude: [] }
+ collection.runnerTagsEnabled = false;
+ collection.runnerConfiguration = null;
+ }
+ },
+ updateRunnerTagsDetails: (state, action) => {
+ const { collectionUid, tags, tagsEnabled } = action.payload;
+ const collection = findCollectionByUid(state.collections, collectionUid);
+ if (collection) {
+ if (tags) {
+ collection.runnerTags = tags;
+ }
+ if (typeof tagsEnabled === 'boolean') {
+ collection.runnerTagsEnabled = tagsEnabled;
+ }
+ }
+ },
+ updateRunnerConfiguration: (state, action) => {
+ const { collectionUid, selectedRequestItems, requestItemsOrder, delay } = action.payload;
+ const collection = findCollectionByUid(state.collections, collectionUid);
+ if (collection) {
+ collection.runnerConfiguration = {
+ selectedRequestItems: selectedRequestItems || [],
+ requestItemsOrder: requestItemsOrder || [],
+ delay: delay
+ };
}
},
updateRequestDocs: (state, action) => {
@@ -1884,12 +2569,155 @@ export const collectionsSlice = createSlice({
set(folder, 'root.docs', action.payload.docs);
}
}
- }
+ },
+ collectionAddOauth2CredentialsByUrl: (state, action) => {
+ const { collectionUid, folderUid, itemUid, url, credentials, credentialsId, debugInfo } = action.payload;
+ const collection = findCollectionByUid(state.collections, collectionUid);
+ if (!collection) return;
+
+ // Update oauth2Credentials (latest token)
+ if (!collection.oauth2Credentials) {
+ collection.oauth2Credentials = [];
+ }
+ let collectionOauth2Credentials = cloneDeep(collection.oauth2Credentials);
+
+ // Remove existing credentials for the same combination
+ const filteredOauth2Credentials = filter(
+ collectionOauth2Credentials,
+ (creds) =>
+ !(creds.url === url && creds.collectionUid === collectionUid && creds.credentialsId === credentialsId)
+ );
+
+ // Add the new credential with folderUid and itemUid
+ filteredOauth2Credentials.push({
+ collectionUid,
+ folderUid,
+ itemUid,
+ url,
+ credentials,
+ credentialsId,
+ debugInfo
+ });
+
+ collection.oauth2Credentials = filteredOauth2Credentials;
+
+ if (!collection.timeline) {
+ collection.timeline = [];
+ }
+
+ if(debugInfo) {
+ collection.timeline.push({
+ type: "oauth2",
+ collectionUid,
+ folderUid,
+ itemUid,
+ timestamp: Date.now(),
+ data: {
+ collectionUid,
+ folderUid,
+ itemUid,
+ url,
+ credentials,
+ credentialsId,
+ debugInfo: debugInfo.data,
+ }
+ });
+ }
+ },
+
+ collectionClearOauth2CredentialsByUrl: (state, action) => {
+ const { collectionUid, url, credentialsId } = action.payload;
+ const collection = findCollectionByUid(state.collections, collectionUid);
+ if (!collection) return;
+
+ if (collection.oauth2Credentials) {
+ let collectionOauth2Credentials = cloneDeep(collection.oauth2Credentials);
+ const filteredOauth2Credentials = filter(
+ collectionOauth2Credentials,
+ (creds) =>
+ !(creds.url === url && creds.collectionUid === collectionUid)
+ );
+ collection.oauth2Credentials = filteredOauth2Credentials;
+ }
+ },
+
+ collectionGetOauth2CredentialsByUrl: (state, action) => {
+ const { collectionUid, url, credentialsId } = action.payload;
+ const collection = findCollectionByUid(state.collections, collectionUid);
+ const oauth2Credential = find(
+ collection?.oauth2Credentials || [],
+ (creds) =>
+ creds.url === url && creds.collectionUid === collectionUid && creds.credentialsId === credentialsId
+ );
+ return oauth2Credential;
+ },
+
+ updateFolderAuthMode: (state, action) => {
+ const collection = findCollectionByUid(state.collections, action.payload.collectionUid);
+ const folder = collection ? findItemInCollection(collection, action.payload.folderUid) : null;
+
+ if (folder) {
+ set(folder, 'root.request.auth', {});
+ set(folder, 'root.request.auth.mode', action.payload.mode);
+ }
+ },
+
+ addRequestTag: (state, action) => {
+ const { tag, collectionUid, itemUid } = action.payload;
+ const collection = findCollectionByUid(state.collections, collectionUid);
+
+ if (collection) {
+ const item = findItemInCollection(collection, itemUid);
+
+ if (item && isItemARequest(item)) {
+ if (!item.draft) {
+ item.draft = cloneDeep(item);
+ }
+ item.draft.tags = item.draft.tags || [];
+ if (!item.draft.tags.includes(tag.trim())) {
+ item.draft.tags.push(tag.trim());
+ }
+
+ collection.allTags = getUniqueTagsFromItems(collection.items);
+ }
+ }
+ },
+ deleteRequestTag: (state, action) => {
+ const { tag, collectionUid, itemUid } = action.payload;
+ const collection = findCollectionByUid(state.collections, collectionUid);
+
+ if (collection) {
+ const item = findItemInCollection(collection, itemUid);
+
+ if (item && isItemARequest(item)) {
+ if (!item.draft) {
+ item.draft = cloneDeep(item);
+ }
+ item.draft.tags = item.draft.tags || [];
+ item.draft.tags = item.draft.tags.filter((t) => t !== tag.trim());
+
+ collection.allTags = getUniqueTagsFromItems(collection.items);
+ }
+ }
+ },
+ updateCollectionTagsList: (state, action) => {
+ const { collectionUid } = action.payload;
+ const collection = findCollectionByUid(state.collections, collectionUid);
+
+ if (collection) {
+ collection.allTags = getUniqueTagsFromItems(collection.items);
+ }
+ },
+ updateActiveConnections: (state, action) => {
+ state.activeConnections = [...action.payload.activeConnectionIds];
+ },
}
});
export const {
createCollection,
+ updateCollectionMountStatus,
+ updateCollectionLoadingState,
setCollectionSecurityConfig,
brunoConfigUpdateEvent,
renameCollection,
@@ -1909,15 +2737,21 @@ export const {
processEnvUpdateEvent,
requestCancelled,
responseReceived,
+ runGrpcRequestEvent,
+ grpcResponseReceived,
responseCleared,
+ clearTimeline,
+ clearRequestTimeline,
saveRequest,
deleteRequestDraft,
newEphemeralHttpRequest,
- collectionClicked,
- collectionFolderClicked,
+ toggleCollection,
+ toggleCollectionItem,
requestUrlChanged,
+ updateItemSettings,
updateAuth,
addQueryParam,
+ setQueryParams,
moveQueryParam,
updateQueryParam,
deleteQueryParam,
@@ -1926,6 +2760,9 @@ export const {
updateRequestHeader,
deleteRequestHeader,
moveRequestHeader,
+ setRequestHeaders,
+ setCollectionHeaders,
+ setFolderHeaders,
addFormUrlEncodedParam,
updateFormUrlEncodedParam,
deleteFormUrlEncodedParam,
@@ -1933,6 +2770,9 @@ export const {
addMultipartFormParam,
updateMultipartFormParam,
deleteMultipartFormParam,
+ addFile,
+ updateFile,
+ deleteFile,
moveMultipartFormParam,
updateRequestAuthMode,
updateRequestBodyMode,
@@ -1943,6 +2783,7 @@ export const {
updateResponseScript,
updateRequestTests,
updateRequestMethod,
+ updateRequestProtoPath,
addAssertion,
updateAssertion,
deleteAssertion,
@@ -1980,11 +2821,24 @@ export const {
collectionAddEnvFileEvent,
collectionRenamedEvent,
resetRunResults,
+ initRunRequestEvent,
runRequestEvent,
runFolderEvent,
resetCollectionRunner,
+ updateRunnerTagsDetails,
+ updateRunnerConfiguration,
updateRequestDocs,
- updateFolderDocs
+ updateFolderDocs,
+ moveCollection,
+ collectionAddOauth2CredentialsByUrl,
+ collectionClearOauth2CredentialsByUrl,
+ collectionGetOauth2CredentialsByUrl,
+ updateFolderAuth,
+ updateFolderAuthMode,
+ addRequestTag,
+ deleteRequestTag,
+ updateCollectionTagsList,
+ updateActiveConnections
} = collectionsSlice.actions;
export default collectionsSlice.reducer;
diff --git a/packages/bruno-app/src/providers/ReduxStore/slices/global-environments.js b/packages/bruno-app/src/providers/ReduxStore/slices/global-environments.js
index def88f2b6..b208f14fd 100644
--- a/packages/bruno-app/src/providers/ReduxStore/slices/global-environments.js
+++ b/packages/bruno-app/src/providers/ReduxStore/slices/global-environments.js
@@ -1,5 +1,5 @@
import { createSlice } from '@reduxjs/toolkit';
-import { stringifyIfNot, uuid } from 'utils/common/index';
+import { uuid } from 'utils/common/index';
import { environmentSchema } from '@usebruno/schema';
import { cloneDeep } from 'lodash';
@@ -90,6 +90,7 @@ export const {
export const addGlobalEnvironment = ({ name, variables = [] }) => (dispatch, getState) => {
return new Promise((resolve, reject) => {
const uid = uuid();
+ const { ipcRenderer } = window;
ipcRenderer
.invoke('renderer:create-global-environment', { name, uid, variables })
.then(() => dispatch(_addGlobalEnvironment({ name, uid, variables })))
@@ -104,6 +105,7 @@ export const copyGlobalEnvironment = ({ name, environmentUid: baseEnvUid }) => (
const globalEnvironments = state.globalEnvironments.globalEnvironments;
const baseEnv = globalEnvironments?.find(env => env?.uid == baseEnvUid)
const uid = uuid();
+ const { ipcRenderer } = window;
ipcRenderer
.invoke('renderer:create-global-environment', { uid, name, variables: baseEnv.variables })
.then(() => dispatch(_copyGlobalEnvironment({ name, uid, variables: baseEnv.variables })))
@@ -114,6 +116,7 @@ export const copyGlobalEnvironment = ({ name, environmentUid: baseEnvUid }) => (
export const renameGlobalEnvironment = ({ name: newName, environmentUid }) => (dispatch, getState) => {
return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
const state = getState();
const globalEnvironments = state.globalEnvironments.globalEnvironments;
const environment = globalEnvironments?.find(env => env?.uid == environmentUid)
@@ -139,6 +142,7 @@ export const saveGlobalEnvironment = ({ variables, environmentUid }) => (dispatc
return reject(new Error('Environment not found'));
}
+ const { ipcRenderer } = window;
environmentSchema
.validate(environment)
.then(() => ipcRenderer.invoke('renderer:save-global-environment', {
@@ -155,6 +159,7 @@ export const saveGlobalEnvironment = ({ variables, environmentUid }) => (dispatc
export const selectGlobalEnvironment = ({ environmentUid }) => (dispatch, getState) => {
return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
ipcRenderer
.invoke('renderer:select-global-environment', { environmentUid })
.then(() => dispatch(_selectGlobalEnvironment({ environmentUid })))
@@ -165,6 +170,7 @@ export const selectGlobalEnvironment = ({ environmentUid }) => (dispatch, getSta
export const deleteGlobalEnvironment = ({ environmentUid }) => (dispatch, getState) => {
return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
ipcRenderer
.invoke('renderer:delete-global-environment', { environmentUid })
.then(() => dispatch(_deleteGlobalEnvironment({ environmentUid })))
@@ -175,6 +181,7 @@ export const deleteGlobalEnvironment = ({ environmentUid }) => (dispatch, getSta
export const globalEnvironmentsUpdateEvent = ({ globalEnvironmentVariables }) => (dispatch, getState) => {
return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
if (!globalEnvironmentVariables) resolve();
const state = getState();
diff --git a/packages/bruno-app/src/providers/ReduxStore/slices/logs.js b/packages/bruno-app/src/providers/ReduxStore/slices/logs.js
new file mode 100644
index 000000000..a96f1ec90
--- /dev/null
+++ b/packages/bruno-app/src/providers/ReduxStore/slices/logs.js
@@ -0,0 +1,143 @@
+import { createSlice } from '@reduxjs/toolkit';
+
+const initialState = {
+ logs: [],
+ debugErrors: [],
+ isConsoleOpen: false,
+ activeTab: 'console',
+ filters: {
+ info: true,
+ warn: true,
+ error: true,
+ debug: true,
+ log: true
+ },
+ networkFilters: {
+ GET: true,
+ POST: true,
+ PUT: true,
+ DELETE: true,
+ PATCH: true,
+ HEAD: true,
+ OPTIONS: true
+ },
+ selectedRequest: null,
+ selectedError: null,
+ maxLogs: 1000,
+ maxDebugErrors: 500
+};
+
+export const logsSlice = createSlice({
+ name: 'logs',
+ initialState,
+ reducers: {
+ addLog: (state, action) => {
+ const { type, args, timestamp } = action.payload;
+ const newLog = {
+ id: Date.now() + Math.random(),
+ type: type || 'log',
+ message: args ? args.join(' ') : '',
+ args: args || [],
+ timestamp: timestamp || new Date().toISOString()
+ };
+
+ state.logs.push(newLog);
+
+ if (state.logs.length > state.maxLogs) {
+ state.logs = state.logs.slice(-state.maxLogs);
+ }
+ },
+ addDebugError: (state, action) => {
+ const { message, stack, filename, lineno, colno, args, timestamp } = action.payload;
+ const newError = {
+ id: Date.now() + Math.random(),
+ message: message || 'Unknown error',
+ stack: stack,
+ filename: filename,
+ lineno: lineno,
+ colno: colno,
+ args: args || [],
+ timestamp: timestamp || new Date().toISOString()
+ };
+
+ state.debugErrors.push(newError);
+
+ if (state.debugErrors.length > state.maxDebugErrors) {
+ state.debugErrors = state.debugErrors.slice(-state.maxDebugErrors);
+ }
+ },
+ clearLogs: (state) => {
+ state.logs = [];
+ },
+ clearDebugErrors: (state) => {
+ state.debugErrors = [];
+ },
+ openConsole: (state) => {
+ state.isConsoleOpen = true;
+ },
+ closeConsole: (state) => {
+ state.isConsoleOpen = false;
+ },
+ setActiveTab: (state, action) => {
+ state.activeTab = action.payload;
+ if (action.payload !== 'network') {
+ state.selectedRequest = null;
+ }
+ if (action.payload !== 'debug') {
+ state.selectedError = null;
+ }
+ },
+ updateFilter: (state, action) => {
+ const { filterType, enabled } = action.payload;
+ state.filters[filterType] = enabled;
+ },
+ toggleAllFilters: (state, action) => {
+ const enabled = action.payload;
+ Object.keys(state.filters).forEach(key => {
+ state.filters[key] = enabled;
+ });
+ },
+ updateNetworkFilter: (state, action) => {
+ const { method, enabled } = action.payload;
+ state.networkFilters[method] = enabled;
+ },
+ toggleAllNetworkFilters: (state, action) => {
+ const enabled = action.payload;
+ Object.keys(state.networkFilters).forEach(key => {
+ state.networkFilters[key] = enabled;
+ });
+ },
+ setSelectedRequest: (state, action) => {
+ state.selectedRequest = action.payload;
+ },
+ clearSelectedRequest: (state) => {
+ state.selectedRequest = null;
+ },
+ setSelectedError: (state, action) => {
+ state.selectedError = action.payload;
+ },
+ clearSelectedError: (state) => {
+ state.selectedError = null;
+ }
+ }
+});
+
+export const {
+ addLog,
+ addDebugError,
+ clearLogs,
+ clearDebugErrors,
+ openConsole,
+ closeConsole,
+ setActiveTab,
+ updateFilter,
+ toggleAllFilters,
+ updateNetworkFilter,
+ toggleAllNetworkFilters,
+ setSelectedRequest,
+ clearSelectedRequest,
+ setSelectedError,
+ clearSelectedError
+} = logsSlice.actions;
+
+export default logsSlice.reducer;
\ No newline at end of file
diff --git a/packages/bruno-app/src/providers/ReduxStore/slices/notifications.js b/packages/bruno-app/src/providers/ReduxStore/slices/notifications.js
index ca6c232d8..062f367ca 100644
--- a/packages/bruno-app/src/providers/ReduxStore/slices/notifications.js
+++ b/packages/bruno-app/src/providers/ReduxStore/slices/notifications.js
@@ -1,7 +1,7 @@
import toast from 'react-hot-toast';
import { createSlice } from '@reduxjs/toolkit';
import { getAppInstallDate } from 'utils/common/platform';
-
+import semver from 'semver';
const getReadNotificationIds = () => {
try {
let readNotificationIdsString = window.localStorage.getItem('bruno.notifications.read');
@@ -27,6 +27,26 @@ const initialState = {
readNotificationIds: getReadNotificationIds() || []
};
+export const filterNotificationsByVersion = (notifications, currentVersion) => {
+ try {
+ if (!notifications) return [];
+
+ if (!currentVersion) return notifications;
+
+ return notifications.filter(notification => {
+ const { minVersion, maxVersion } = notification;
+ if (!minVersion && !maxVersion) return true;
+ if (!minVersion) return semver.lte(currentVersion, maxVersion);
+ if (!maxVersion) return semver.gte(currentVersion, minVersion);
+
+ return semver.gte(currentVersion, minVersion) && semver.lte(currentVersion, maxVersion);
+ });
+ } catch (error) {
+ console.error(error);
+ return [];
+ }
+};
+
export const notificationSlice = createSlice({
name: 'notifications',
initialState,
@@ -86,13 +106,14 @@ export const notificationSlice = createSlice({
export const { setNotifications, setFetchingStatus, markNotificationAsRead, markAllNotificationsAsRead } =
notificationSlice.actions;
-export const fetchNotifications = () => (dispatch, getState) => {
+export const fetchNotifications = ({currentVersion}) => (dispatch, getState) => {
return new Promise((resolve) => {
const { ipcRenderer } = window;
dispatch(setFetchingStatus(true));
ipcRenderer
.invoke('renderer:fetch-notifications')
.then((notifications) => {
+ notifications = filterNotificationsByVersion(notifications, currentVersion);
dispatch(setNotifications({ notifications }));
dispatch(setFetchingStatus(false));
resolve(notifications);
diff --git a/packages/bruno-app/src/providers/ReduxStore/slices/notifications.spec.js b/packages/bruno-app/src/providers/ReduxStore/slices/notifications.spec.js
new file mode 100644
index 000000000..80e84d9bd
--- /dev/null
+++ b/packages/bruno-app/src/providers/ReduxStore/slices/notifications.spec.js
@@ -0,0 +1,133 @@
+const { filterNotificationsByVersion } = require('./notifications');
+
+describe('filterNotificationsByVersion - basic', () => {
+ it('should filter notifications by version', () => {
+ const notifications = [{ minVersion: '1.0.0', maxVersion: '1.1.0' }];
+ const currentVersion = '1.0.5';
+ const filteredNotifications = filterNotificationsByVersion(notifications, currentVersion);
+ expect(filteredNotifications).toEqual([{ minVersion: '1.0.0', maxVersion: '1.1.0' }]);
+ });
+
+ it('should gracefully handle no notifications', () => {
+ const notifications = [];
+ const currentVersion = '1.0.5';
+ const filteredNotifications = filterNotificationsByVersion(notifications, currentVersion);
+ expect(filteredNotifications).toEqual([]);
+ });
+
+ it('should gracefully handle notifications are undefined', () => {
+ const notifications = undefined;
+ const currentVersion = '1.0.5';
+ const filteredNotifications = filterNotificationsByVersion(notifications, currentVersion);
+ expect(filteredNotifications).toEqual([]);
+ });
+
+ it('should gracefully handle scenario when no current version is provided', () => {
+ const notifications = [{ minVersion: '1.0.0', maxVersion: '1.1.0' }];
+ const filteredNotifications = filterNotificationsByVersion(notifications);
+ expect(filteredNotifications).toEqual(notifications);
+ });
+
+ it('should gracefully handle scenario minVersion is undefined', () => {
+ const notifications = [{ minVersion: undefined, maxVersion: '1.1.0' }];
+ const currentVersion = '1.0.5';
+ const filteredNotifications = filterNotificationsByVersion(notifications, currentVersion);
+ expect(filteredNotifications).toEqual(notifications);
+ });
+
+ it('should gracefully handle scenario maxVersion is undefined', () => {
+ const notifications = [{ minVersion: '1.0.0', maxVersion: undefined }];
+ const currentVersion = '1.0.5';
+ const filteredNotifications = filterNotificationsByVersion(notifications, currentVersion);
+ expect(filteredNotifications).toEqual(notifications);
+ });
+
+ it('should gracefully handle scenario minVersion and maxVersion are undefined', () => {
+ const notifications = [{ minVersion: undefined, maxVersion: undefined }];
+ const currentVersion = '1.0.5';
+ const filteredNotifications = filterNotificationsByVersion(notifications, currentVersion);
+ expect(filteredNotifications).toEqual(notifications);
+ });
+});
+
+describe('filterNotificationsByVersion - semver', () => {
+ it('should filter out notifications outside version range', () => {
+ const notifications = [
+ { minVersion: '1.0.0', maxVersion: '1.1.0' }, // should be included
+ { minVersion: '2.0.0', maxVersion: '2.1.0' }, // should be filtered out
+ { minVersion: '0.5.0', maxVersion: '0.9.0' } // should be filtered out
+ ];
+ const currentVersion = '1.0.5';
+ const filteredNotifications = filterNotificationsByVersion(notifications, currentVersion);
+ expect(filteredNotifications).toEqual([
+ { minVersion: '1.0.0', maxVersion: '1.1.0' }
+ ]);
+ });
+
+ it('should handle mixed valid and invalid version ranges', () => {
+ const notifications = [
+ { minVersion: '1.0.0', maxVersion: '2.0.0' }, // should be included
+ { minVersion: '3.0.0', maxVersion: '4.0.0' }, // should be filtered out
+ { minVersion: '1.5.0', maxVersion: '1.8.0' }, // should be included
+ { minVersion: '0.1.0', maxVersion: '0.5.0' } // should be filtered out
+ ];
+ const currentVersion = '1.6.0';
+ const filteredNotifications = filterNotificationsByVersion(notifications, currentVersion);
+ expect(filteredNotifications).toEqual([
+ { minVersion: '1.0.0', maxVersion: '2.0.0' },
+ { minVersion: '1.5.0', maxVersion: '1.8.0' }
+ ]);
+ });
+
+ it('should handle edge cases of version ranges', () => {
+ const notifications = [
+ { minVersion: '1.0.0', maxVersion: '1.0.0' }, // should be included
+ { minVersion: '1.0.1', maxVersion: '2.0.0' }, // should be filtered out
+ { minVersion: '0.9.9', maxVersion: '1.0.0' } // should be included
+ ];
+ const currentVersion = '1.0.0';
+ const filteredNotifications = filterNotificationsByVersion(notifications, currentVersion);
+ expect(filteredNotifications).toEqual([
+ { minVersion: '1.0.0', maxVersion: '1.0.0' },
+ { minVersion: '0.9.9', maxVersion: '1.0.0' }
+ ]);
+ });
+});
+
+describe('filterNotificationsByVersion - undefined version bounds', () => {
+ it('should include notifications when minVersion is undefined and current version is below maxVersion', () => {
+ const notifications = [
+ { minVersion: undefined, maxVersion: '2.0.0' }
+ ];
+ const currentVersion = '1.5.0';
+ const filteredNotifications = filterNotificationsByVersion(notifications, currentVersion);
+ expect(filteredNotifications).toEqual(notifications);
+ });
+
+ it('should exclude notifications when minVersion is undefined and current version is above maxVersion', () => {
+ const notifications = [
+ { minVersion: undefined, maxVersion: '2.0.0' }
+ ];
+ const currentVersion = '2.1.0';
+ const filteredNotifications = filterNotificationsByVersion(notifications, currentVersion);
+ expect(filteredNotifications).toEqual([]);
+ });
+
+ it('should include notifications when maxVersion is undefined and current version is above minVersion', () => {
+ const notifications = [
+ { minVersion: '1.0.0', maxVersion: undefined }
+ ];
+ const currentVersion = '2.0.0';
+ const filteredNotifications = filterNotificationsByVersion(notifications, currentVersion);
+ expect(filteredNotifications).toEqual(notifications);
+ });
+
+ it('should exclude notifications when maxVersion is undefined and current version is below minVersion', () => {
+ const notifications = [
+ { minVersion: '1.0.0', maxVersion: undefined }
+ ];
+ const currentVersion = '0.9.0';
+ const filteredNotifications = filterNotificationsByVersion(notifications, currentVersion);
+ expect(filteredNotifications).toEqual([]);
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-app/src/providers/ReduxStore/slices/tabs.js b/packages/bruno-app/src/providers/ReduxStore/slices/tabs.js
index 935be6075..694239da6 100644
--- a/packages/bruno-app/src/providers/ReduxStore/slices/tabs.js
+++ b/packages/bruno-app/src/providers/ReduxStore/slices/tabs.js
@@ -1,4 +1,5 @@
import { createSlice } from '@reduxjs/toolkit';
+import { findIndex } from 'lodash';
import filter from 'lodash/filter';
import find from 'lodash/find';
import last from 'lodash/last';
@@ -19,31 +20,68 @@ export const tabsSlice = createSlice({
initialState,
reducers: {
addTab: (state, action) => {
- const alreadyExists = find(state.tabs, (tab) => tab.uid === action.payload.uid);
- if (alreadyExists) {
+ const { uid, collectionUid, type, requestPaneTab, preview } = action.payload;
+ const nonReplaceableTabTypes = [
+ "variables",
+ "collection-runner",
+ "security-settings",
+ ];
+
+ const existingTab = find(state.tabs, (tab) => tab.uid === uid);
+ if (existingTab) {
+ state.activeTabUid = existingTab.uid;
return;
}
- if (
- ['variables', 'collection-settings', 'collection-runner', 'security-settings'].includes(action.payload.type)
- ) {
- const tab = tabTypeAlreadyExists(state.tabs, action.payload.collectionUid, action.payload.type);
- if (tab) {
- state.activeTabUid = tab.uid;
+ if (nonReplaceableTabTypes.includes(type)) {
+ const existingTab = tabTypeAlreadyExists(state.tabs, collectionUid, type);
+ if (existingTab) {
+ state.activeTabUid = existingTab.uid;
return;
}
}
+ // Determine the default requestPaneTab based on request type
+ let defaultRequestPaneTab = 'params';
+ if (type === 'grpc-request') {
+ defaultRequestPaneTab = 'body';
+ } else if (type === 'graphql-request') {
+ defaultRequestPaneTab = 'query';
+ }
+
+ const lastTab = state.tabs[state.tabs.length - 1];
+ if (state.tabs.length > 0 && lastTab.preview) {
+ state.tabs[state.tabs.length - 1] = {
+ uid,
+ collectionUid,
+ requestPaneWidth: null,
+ requestPaneTab: requestPaneTab || defaultRequestPaneTab,
+ responsePaneTab: 'response',
+ type: type || 'request',
+ preview: preview !== undefined
+ ? preview
+ : !nonReplaceableTabTypes.includes(type),
+ ...(uid ? { folderUid: uid } : {})
+ };
+
+ state.activeTabUid = uid;
+ return;
+ }
+
state.tabs.push({
- uid: action.payload.uid,
- collectionUid: action.payload.collectionUid,
+ uid,
+ collectionUid,
requestPaneWidth: null,
- requestPaneTab: action.payload.requestPaneTab || 'params',
+ requestPaneTab: requestPaneTab || defaultRequestPaneTab,
responsePaneTab: 'response',
- type: action.payload.type || 'request',
- ...(action.payload.uid ? { folderUid: action.payload.uid } : {})
+ responsePaneScrollPosition: null,
+ type: type || 'request',
+ ...(uid ? { folderUid: uid } : {}),
+ preview: preview !== undefined
+ ? preview
+ : !nonReplaceableTabTypes.includes(type)
});
- state.activeTabUid = action.payload.uid;
+ state.activeTabUid = uid;
},
focusTab: (state, action) => {
state.activeTabUid = action.payload.uid;
@@ -89,6 +127,13 @@ export const tabsSlice = createSlice({
tab.responsePaneTab = action.payload.responsePaneTab;
}
},
+ updateResponsePaneScrollPosition: (state, action) => {
+ const tab = find(state.tabs, (t) => t.uid === action.payload.uid);
+
+ if (tab) {
+ tab.responsePaneScrollPosition = action.payload.scrollY;
+ }
+ },
closeTabs: (state, action) => {
const activeTab = find(state.tabs, (t) => t.uid === state.activeTabUid);
const tabUids = action.payload.tabUids || [];
@@ -124,6 +169,15 @@ export const tabsSlice = createSlice({
const collectionUid = action.payload.collectionUid;
state.tabs = filter(state.tabs, (t) => t.collectionUid !== collectionUid);
state.activeTabUid = null;
+ },
+ makeTabPermanent: (state, action) => {
+ const { uid } = action.payload;
+ const tab = find(state.tabs, (t) => t.uid === uid);
+ if (tab) {
+ tab.preview = false;
+ } else {
+ console.error('Tab not found!');
+ }
}
}
});
@@ -135,8 +189,10 @@ export const {
updateRequestPaneTabWidth,
updateRequestPaneTab,
updateResponsePaneTab,
+ updateResponsePaneScrollPosition,
closeTabs,
- closeAllCollectionTabs
+ closeAllCollectionTabs,
+ makeTabPermanent
} = tabsSlice.actions;
-export default tabsSlice.reducer;
+export default tabsSlice.reducer;
\ No newline at end of file
diff --git a/packages/bruno-app/src/providers/Theme/index.js b/packages/bruno-app/src/providers/Theme/index.js
index 44025197a..9b741872b 100644
--- a/packages/bruno-app/src/providers/Theme/index.js
+++ b/packages/bruno-app/src/providers/Theme/index.js
@@ -1,3 +1,4 @@
+import React from 'react';
import themes from 'themes/index';
import useLocalStorage from 'hooks/useLocalStorage/index';
diff --git a/packages/bruno-app/src/providers/Toaster/index.js b/packages/bruno-app/src/providers/Toaster/index.js
index 1ae25764c..10dab3297 100644
--- a/packages/bruno-app/src/providers/Toaster/index.js
+++ b/packages/bruno-app/src/providers/Toaster/index.js
@@ -7,9 +7,17 @@ export const ToastContext = React.createContext();
export const ToastProvider = (props) => {
const { storedTheme } = useTheme();
- const toastOptions = { duration: 2000 };
+ const toastOptions = {
+ duration: 2000,
+ style: {
+ // Break long word like file-path, URL etc. to prevent overflow
+ overflowWrap: 'anywhere'
+ }
+ };
+
if (storedTheme === 'dark') {
toastOptions.style = {
+ ...toastOptions.style,
borderRadius: '10px',
background: '#3d3d3d',
color: '#fff'
diff --git a/packages/bruno-app/src/selectors/tab.js b/packages/bruno-app/src/selectors/tab.js
new file mode 100644
index 000000000..76aa67365
--- /dev/null
+++ b/packages/bruno-app/src/selectors/tab.js
@@ -0,0 +1,9 @@
+import { createSelector } from '@reduxjs/toolkit';
+
+export const isTabForItemActive = ({ itemUid }) => createSelector([
+ (state) => state.tabs?.activeTabUid
+], (activeTabUid) => activeTabUid === itemUid);
+
+export const isTabForItemPresent = ({ itemUid }) => createSelector([
+ (state) => state.tabs.tabs,
+], (tabs) => tabs.some((tab) => tab.uid === itemUid));
\ No newline at end of file
diff --git a/packages/bruno-app/src/styles/globals.css b/packages/bruno-app/src/styles/globals.css
index f81023479..ef2de6bbe 100644
--- a/packages/bruno-app/src/styles/globals.css
+++ b/packages/bruno-app/src/styles/globals.css
@@ -145,7 +145,7 @@ body {
font-kerning: none;
text-rendering: optimizeSpeed;
letter-spacing: normal;
- font-family: Inter, sans-serif !important;
+ font-family: Inter, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif !important;
overflow-x: hidden;
}
diff --git a/packages/bruno-app/src/test-utils/mocks/codemirror.js b/packages/bruno-app/src/test-utils/mocks/codemirror.js
new file mode 100644
index 000000000..03ee94c3b
--- /dev/null
+++ b/packages/bruno-app/src/test-utils/mocks/codemirror.js
@@ -0,0 +1,45 @@
+const CodeMirror = jest.fn((node, options) => {
+ const editor = {
+ options,
+ _currentValue: '',
+ _onKeyUpMockDataHints: null,
+ getCursor: jest.fn(() => ({ line: 0, ch: editor._currentValue?.length || 0 })),
+ getRange: jest.fn((from, to) => editor._currentValue?.slice(0, to.ch) || ''),
+ getValue: jest.fn(() => editor._currentValue),
+ setValue: jest.fn(function (val) {
+ editor._currentValue = val;
+ }),
+ getLine: jest.fn(() => editor._currentValue || ''),
+ setOption: jest.fn(),
+ refresh: jest.fn(),
+ off: jest.fn(),
+ showHint: jest.fn(),
+ on: jest.fn(function (event, handler) {
+ if (event === 'keyup') {
+ if (handler && handler.name === '_onKeyUpMockDataHints') {
+ this._onKeyUpMockDataHints = handler;
+ }
+ }
+ })
+ };
+ return editor;
+});
+
+CodeMirror.commands = {
+ autocomplete: jest.fn()
+};
+
+CodeMirror.hint = {};
+
+CodeMirror.registerHelper = jest.fn((type, name, value) => {
+ if (!CodeMirror[type]) {
+ CodeMirror[type] = {};
+ }
+
+ CodeMirror[type][name] = value;
+});
+
+CodeMirror.fromTextArea = jest.fn();
+CodeMirror.defineMode = jest.fn();
+
+module.exports = CodeMirror;
diff --git a/packages/bruno-app/src/themes/dark.js b/packages/bruno-app/src/themes/dark.js
index 9e8e923aa..7e3136715 100644
--- a/packages/bruno-app/src/themes/dark.js
+++ b/packages/bruno-app/src/themes/dark.js
@@ -94,8 +94,9 @@ const darkTheme = {
// customize these colors if needed
patch: '#d69956',
options: '#d69956',
- head: '#d69956'
- }
+ head: '#d69956',
+ },
+ grpc: '#6366f1'
},
requestTabPanel: {
@@ -114,7 +115,26 @@ const darkTheme = {
responseStatus: '#ccc',
responseOk: '#8cd656',
responseError: '#f06f57',
- responseOverlayBg: 'rgba(30, 30, 30, 0.6)'
+ responsePending: '#569cd6',
+ responseOverlayBg: 'rgba(30, 30, 30, 0.6)',
+
+ card: {
+ bg: '#252526',
+ border: 'transparent',
+ borderDark: '#8cd656',
+ hr: '#424242'
+ },
+
+ cardTable: {
+ border: '#333',
+ bg: '#252526',
+ table: {
+ thead: {
+ bg: '#3D3D3D',
+ color: '#ccc'
+ }
+ }
+ }
},
collection: {
@@ -230,6 +250,10 @@ const darkTheme = {
codemirror: {
bg: '#1e1e1e',
border: '#373737',
+ placeholder: {
+ color: '#a2a2a2',
+ opacity: 0.50
+ },
gutter: {
bg: '#262626'
},
@@ -261,6 +285,49 @@ const darkTheme = {
scrollbar: {
color: 'rgb(52 51 49)'
+ },
+
+ dragAndDrop: {
+ border: '#666666',
+ borderStyle: '2px solid',
+ hoverBg: 'rgba(102, 102, 102, 0.08)',
+ transition: 'all 0.1s ease'
+ },
+ infoTip: {
+ bg: '#1f1f1f',
+ border: '#333333',
+ boxShadow: '0 4px 12px rgba(0, 0, 0, 0.5)'
+ },
+
+ statusBar: {
+ border: '#323233',
+ color: 'rgb(169, 169, 169)'
+ },
+ console: {
+ bg: '#1e1e1e',
+ headerBg: '#2d2d30',
+ contentBg: '#1e1e1e',
+ border: '#3c3c3c',
+ titleColor: '#cccccc',
+ countColor: '#858585',
+ buttonColor: '#cccccc',
+ buttonHoverBg: 'rgba(255, 255, 255, 0.1)',
+ buttonHoverColor: '#ffffff',
+ messageColor: '#cccccc',
+ timestampColor: '#858585',
+ emptyColor: '#858585',
+ logHoverBg: 'rgba(255, 255, 255, 0.05)',
+ resizeHandleHover: '#0078d4',
+ resizeHandleActive: '#0078d4',
+ dropdownBg: '#2d2d30',
+ dropdownHeaderBg: '#3c3c3c',
+ optionHoverBg: 'rgba(255, 255, 255, 0.05)',
+ optionLabelColor: '#cccccc',
+ optionCountColor: '#858585',
+ checkboxColor: '#0078d4',
+ scrollbarTrack: '#2d2d30',
+ scrollbarThumb: '#5a5a5a',
+ scrollbarThumbHover: '#6a6a6a'
}
};
diff --git a/packages/bruno-app/src/themes/light.js b/packages/bruno-app/src/themes/light.js
index a25583136..715d468d6 100644
--- a/packages/bruno-app/src/themes/light.js
+++ b/packages/bruno-app/src/themes/light.js
@@ -7,7 +7,7 @@ const lightTheme = {
colors: {
text: {
green: '#047857',
- danger: 'rgb(185, 28, 28)',
+ danger: '#B91C1C',
muted: '#838383',
purple: '#8e44ad',
yellow: '#d97706'
@@ -95,7 +95,8 @@ const lightTheme = {
patch: '#ca7811',
options: '#ca7811',
head: '#ca7811'
- }
+ },
+ grpc: '#6366f1'
},
requestTabPanel: {
@@ -114,7 +115,23 @@ const lightTheme = {
responseStatus: 'rgb(117 117 117)',
responseOk: '#047857',
responseError: 'rgb(185, 28, 28)',
- responseOverlayBg: 'rgba(255, 255, 255, 0.6)'
+ responsePending: '#1663bb',
+ responseOverlayBg: 'rgba(255, 255, 255, 0.6)',
+ card: {
+ bg: '#fff',
+ border: '#f4f4f4',
+ hr: '#f4f4f4'
+ },
+ cardTable: {
+ border: '#efefef',
+ bg: '#fff',
+ table: {
+ thead: {
+ bg: 'rgb(249, 250, 251)',
+ color: 'rgb(75 85 99)'
+ }
+ }
+ }
},
collection: {
@@ -234,6 +251,10 @@ const lightTheme = {
codemirror: {
bg: 'white',
border: '#efefef',
+ placeholder: {
+ color: '#a2a2a2',
+ opacity: 0.75
+ },
gutter: {
bg: '#f3f3f3'
},
@@ -265,6 +286,49 @@ const lightTheme = {
scrollbar: {
color: 'rgb(152 151 149)'
+ },
+
+ dragAndDrop: {
+ border: '#8b8b8b', // Using the same gray as focusBorder from input
+ borderStyle: '2px solid',
+ hoverBg: 'rgba(139, 139, 139, 0.05)', // Matching the border color with reduced opacity
+ transition: 'all 0.1s ease'
+ },
+ infoTip: {
+ bg: 'white',
+ border: '#e0e0e0',
+ boxShadow: '0 4px 12px rgba(0, 0, 0, 0.15)'
+ },
+
+ statusBar: {
+ border: '#E9E9E9',
+ color: 'rgb(100, 100, 100)'
+ },
+ console: {
+ bg: '#f8f9fa',
+ headerBg: '#f8f9fa',
+ contentBg: '#ffffff',
+ border: '#dee2e6',
+ titleColor: '#212529',
+ countColor: '#6c757d',
+ buttonColor: '#495057',
+ buttonHoverBg: '#e9ecef',
+ buttonHoverColor: '#212529',
+ messageColor: '#212529',
+ timestampColor: '#6c757d',
+ emptyColor: '#6c757d',
+ logHoverBg: 'rgba(0, 0, 0, 0.03)',
+ resizeHandleHover: '#0d6efd',
+ resizeHandleActive: '#0d6efd',
+ dropdownBg: '#ffffff',
+ dropdownHeaderBg: '#f8f9fa',
+ optionHoverBg: '#f8f9fa',
+ optionLabelColor: '#212529',
+ optionCountColor: '#6c757d',
+ checkboxColor: '#0d6efd',
+ scrollbarTrack: '#f8f9fa',
+ scrollbarThumb: '#ced4da',
+ scrollbarThumbHover: '#adb5bd'
}
};
diff --git a/packages/bruno-app/src/ui/HeightBoundContainer/StyledWrapper.js b/packages/bruno-app/src/ui/HeightBoundContainer/StyledWrapper.js
new file mode 100644
index 000000000..6d261b9bf
--- /dev/null
+++ b/packages/bruno-app/src/ui/HeightBoundContainer/StyledWrapper.js
@@ -0,0 +1,25 @@
+import styled from 'styled-components';
+
+const StyledWrapper = styled.div`
+ /* Primary container - establishes flex context */
+ display: flex;
+ flex-direction: column;
+ width: 100%;
+ height: 100%;
+
+ /* Flex shrink container - allows content to be constrained */
+ .height-constraint {
+ display: flex;
+ flex: 1 1 0;
+ min-height: 0;
+ }
+
+ /* flex container - enforces boundaries */
+ .flex-boundary {
+ width: 100%;
+ display: flex;
+ overflow-y: auto;
+ }
+`;
+
+export default StyledWrapper;
diff --git a/packages/bruno-app/src/ui/HeightBoundContainer/index.js b/packages/bruno-app/src/ui/HeightBoundContainer/index.js
new file mode 100644
index 000000000..149c02da1
--- /dev/null
+++ b/packages/bruno-app/src/ui/HeightBoundContainer/index.js
@@ -0,0 +1,16 @@
+import React from 'react';
+import StyledWrapper from './StyledWrapper';
+
+const HeightBoundContainer = ({children}) => {
+ return (
+
+
+
+ );
+};
+
+export default HeightBoundContainer;
diff --git a/packages/bruno-app/src/utils/beta-features.js b/packages/bruno-app/src/utils/beta-features.js
new file mode 100644
index 000000000..40c7635d6
--- /dev/null
+++ b/packages/bruno-app/src/utils/beta-features.js
@@ -0,0 +1,19 @@
+import { useSelector } from 'react-redux';
+
+/**
+ * Beta features configuration object
+ * Contains all available beta feature keys
+ */
+export const BETA_FEATURES = Object.freeze({
+ GRPC: 'grpc'
+});
+
+/**
+ * Hook to check if a beta feature is enabled
+ * @param {string} featureName - The name of the beta feature
+ * @returns {boolean} - Whether the feature is enabled
+ */
+export const useBetaFeature = (featureName) => {
+ const preferences = useSelector((state) => state.app.preferences);
+ return preferences?.beta?.[featureName] || false;
+};
diff --git a/packages/bruno-app/src/utils/codegenerator/auth.js b/packages/bruno-app/src/utils/codegenerator/auth.js
index 981d6cec2..d5ecb4cc5 100644
--- a/packages/bruno-app/src/utils/codegenerator/auth.js
+++ b/packages/bruno-app/src/utils/codegenerator/auth.js
@@ -1,6 +1,15 @@
import get from 'lodash/get';
export const getAuthHeaders = (collectionRootAuth, requestAuth) => {
+
+ // Discovered edge case where code generation fails when you create a collection which has not been saved yet:
+ // Collection auth therefore null, and request inherits from collection, therefore it is also null
+ // TypeError: Cannot read properties of undefined (reading 'mode')
+ // at getAuthHeaders
+ if (!collectionRootAuth && !requestAuth) {
+ return [];
+ }
+
const auth = collectionRootAuth && ['inherit'].includes(requestAuth?.mode) ? collectionRootAuth : requestAuth;
switch (auth.mode) {
diff --git a/packages/bruno-app/src/utils/codegenerator/har.js b/packages/bruno-app/src/utils/codegenerator/har.js
index 479fcd67a..dbe1d1349 100644
--- a/packages/bruno-app/src/utils/codegenerator/har.js
+++ b/packages/bruno-app/src/utils/codegenerator/har.js
@@ -14,6 +14,8 @@ const createContentType = (mode) => {
return 'application/json';
case 'multipartForm':
return 'multipart/form-data';
+ case 'file':
+ return 'application/octet-stream';
default:
return '';
}
@@ -51,35 +53,72 @@ const createQuery = (queryParams = []) => {
}));
};
-const createPostData = (body, type) => {
- if (type === 'graphql-request') {
- return {
- mimeType: 'application/json',
- text: JSON.stringify(body[body.mode])
- };
- }
-
+const createPostData = (body) => {
const contentType = createContentType(body.mode);
- if (body.mode === 'formUrlEncoded' || body.mode === 'multipartForm') {
- return {
- mimeType: contentType,
- params: body[body.mode]
- .filter((param) => param.enabled)
- .map((param) => ({
- name: param.name,
- value: param.value,
- ...(param.type === 'file' && { fileName: param.value })
- }))
- };
- } else {
- return {
- mimeType: contentType,
- text: body[body.mode]
- };
+
+ switch (body.mode) {
+ case 'formUrlEncoded':
+ return {
+ mimeType: contentType,
+ text: new URLSearchParams(
+ (Array.isArray(body[body.mode]) ? body[body.mode] : [])
+ .filter((param) => param?.enabled)
+ .reduce((acc, param) => {
+ acc[param.name] = param.value;
+ return acc;
+ }, {})
+ ).toString(),
+ params: (Array.isArray(body[body.mode]) ? body[body.mode] : [])
+ .filter((param) => param?.enabled)
+ .map((param) => ({
+ name: param.name,
+ value: param.value
+ }))
+ };
+ case 'multipartForm':
+ return {
+ mimeType: contentType,
+ params: (Array.isArray(body[body.mode]) ? body[body.mode] : [])
+ .filter((param) => param?.enabled)
+ .map((param) => ({
+ name: param.name,
+ value: param.value,
+ ...(param.type === 'file' && { fileName: param.value })
+ }))
+ };
+ case 'file': {
+ const files = Array.isArray(body[body.mode]) ? body[body.mode] : [];
+ const selectedFile = files.find((param) => param.selected) || files[0];
+ const filePath = selectedFile?.filePath || '';
+ return {
+ mimeType: selectedFile?.contentType || 'application/octet-stream',
+ text: filePath,
+ params: filePath
+ ? [
+ {
+ name: selectedFile?.name || 'file',
+ value: filePath,
+ fileName: filePath,
+ contentType: selectedFile?.contentType || 'application/octet-stream'
+ }
+ ]
+ : []
+ };
+ }
+ case 'graphql':
+ return {
+ mimeType: contentType,
+ text: JSON.stringify(body[body.mode])
+ };
+ default:
+ return {
+ mimeType: contentType,
+ text: body[body.mode]
+ };
}
};
-export const buildHarRequest = ({ request, headers, type }) => {
+export const buildHarRequest = ({ request, headers }) => {
return {
method: request.method,
url: encodeURI(request.url),
@@ -87,8 +126,9 @@ export const buildHarRequest = ({ request, headers, type }) => {
cookies: [],
headers: createHeaders(request, headers),
queryString: createQuery(request.params),
- postData: createPostData(request.body, type),
+ postData: createPostData(request.body),
headersSize: 0,
- bodySize: 0
+ bodySize: 0,
+ binary: true
};
};
diff --git a/packages/bruno-app/src/utils/codemirror/autocomplete.js b/packages/bruno-app/src/utils/codemirror/autocomplete.js
index 9c068f20e..c105caa63 100644
--- a/packages/bruno-app/src/utils/codemirror/autocomplete.js
+++ b/packages/bruno-app/src/utils/codemirror/autocomplete.js
@@ -1,40 +1,677 @@
-let CodeMirror;
-const SERVER_RENDERED = typeof window === 'undefined' || global['PREVENT_CODEMIRROR_RENDER'] === true;
+import { mockDataFunctions } from '@usebruno/common';
-if (!SERVER_RENDERED) {
- CodeMirror = require('codemirror');
- CodeMirror.registerHelper('hint', 'anyword', (editor, options) => {
- const word = /[\w$-]+/;
- const wordlist = (options && options.autocomplete) || [];
- let cur = editor.getCursor(),
- curLine = editor.getLine(cur.line);
- let end = cur.ch,
- start = end;
- while (start && word.test(curLine.charAt(start - 1))) --start;
- let curWord = start != end && curLine.slice(start, end);
+const CodeMirror = require('codemirror');
- // Check if curWord is a valid string before proceeding
- if (typeof curWord !== 'string' || curWord.length < 3) {
- return null; // Abort the hint
+// Static API hints - Bruno JavaScript API (subgrouped by category)
+const STATIC_API_HINTS = {
+ req: [
+ 'req',
+ 'req.url',
+ 'req.method',
+ 'req.headers',
+ 'req.body',
+ 'req.timeout',
+ 'req.getUrl()',
+ 'req.setUrl(url)',
+ 'req.getMethod()',
+ 'req.getAuthMode()',
+ 'req.setMethod(method)',
+ 'req.getHeader(name)',
+ 'req.getHeaders()',
+ 'req.setHeader(name, value)',
+ 'req.setHeaders(data)',
+ 'req.getBody()',
+ 'req.setBody(data)',
+ 'req.setMaxRedirects(maxRedirects)',
+ 'req.getTimeout()',
+ 'req.setTimeout(timeout)',
+ 'req.getExecutionMode()',
+ 'req.getName()',
+ 'req.disableParsingResponseJson()',
+ 'req.onFail(function(err) {})',
+ ],
+ res: [
+ 'res',
+ 'res.status',
+ 'res.statusText',
+ 'res.headers',
+ 'res.body',
+ 'res.responseTime',
+ 'res.url',
+ 'res.getStatus()',
+ 'res.getStatusText()',
+ 'res.getHeader(name)',
+ 'res.getHeaders()',
+ 'res.getBody()',
+ 'res.setBody(data)',
+ 'res.getResponseTime()',
+ 'res.getSize()',
+ 'res.getSize().header',
+ 'res.getSize().body',
+ 'res.getSize().total',
+ 'res.getUrl()'
+ ],
+ bru: [
+ 'bru',
+ 'bru.cwd()',
+ 'bru.getEnvName()',
+ 'bru.getProcessEnv(key)',
+ 'bru.hasEnvVar(key)',
+ 'bru.getEnvVar(key)',
+ 'bru.getFolderVar(key)',
+ 'bru.getCollectionVar(key)',
+ 'bru.setEnvVar(key, value)',
+ 'bru.setEnvVar(key, value, options)',
+ 'bru.deleteEnvVar(key)',
+ 'bru.hasVar(key)',
+ 'bru.getVar(key)',
+ 'bru.setVar(key,value)',
+ 'bru.deleteVar(key)',
+ 'bru.deleteAllVars()',
+ 'bru.setNextRequest(requestName)',
+ 'bru.getRequestVar(key)',
+ 'bru.runRequest(requestPathName)',
+ 'bru.getAssertionResults()',
+ 'bru.getTestResults()',
+ 'bru.sleep(ms)',
+ 'bru.getCollectionName()',
+ 'bru.getGlobalEnvVar(key)',
+ 'bru.setGlobalEnvVar(key, value)',
+ 'bru.runner',
+ 'bru.runner.setNextRequest(requestName)',
+ 'bru.runner.skipRequest()',
+ 'bru.runner.stopExecution()',
+ 'bru.interpolate(str)',
+ 'bru.cookies',
+ 'bru.cookies.jar()',
+ 'bru.cookies.jar().getCookie(url, name, callback)',
+ 'bru.cookies.jar().getCookies(url, callback)',
+ 'bru.cookies.jar().setCookie(url, name, value, callback)',
+ 'bru.cookies.jar().setCookie(url, cookieObject, callback)',
+ 'bru.cookies.jar().setCookies(url, cookiesArray, callback)',
+ 'bru.cookies.jar().clear(callback)',
+ 'bru.cookies.jar().deleteCookies(url, callback)',
+ 'bru.cookies.jar().deleteCookie(url, name, callback)',
+ ]
+};
+
+// Mock data functions - prefixed with $
+const MOCK_DATA_HINTS = Object.keys(mockDataFunctions).map(key => `$${key}`);
+
+// Constants for word pattern matching
+const WORD_PATTERN = /[\w.$-/]/;
+const VARIABLE_PATTERN = /\{\{([\w$.-]*)$/;
+const NON_CHARACTER_KEYS = /^(?!Shift|Tab|Enter|Escape|ArrowUp|ArrowDown|ArrowLeft|ArrowRight|Meta|Alt|Home|End\s)\w*/;
+
+/**
+ * Generate progressive hints for a given full hint
+ * @param {string} fullHint - The complete hint string
+ * @returns {string[]} Array of progressive hints
+ */
+const generateProgressiveHints = (fullHint) => {
+ const parts = fullHint.split('.');
+ const progressiveHints = [];
+
+ for (let i = 1; i <= parts.length; i++) {
+ progressiveHints.push(parts.slice(0, i).join('.'));
+ }
+
+ return progressiveHints;
+};
+
+/**
+ * Check if a variable key should be skipped
+ * @param {string} key - The variable key to check
+ * @returns {boolean} True if the key should be skipped
+ */
+const shouldSkipVariableKey = (key) => {
+ return key === 'pathParams' || key === 'maskedEnvVariables' || key === 'process';
+};
+
+/**
+ * Transform variables object into flat hint list
+ * @param {Object} allVariables - All available variables
+ * @returns {string[]} Array of variable hints
+ */
+const transformVariablesToHints = (allVariables = {}) => {
+ const hints = [];
+
+ // Process all variables without type-specific handling
+ Object.keys(allVariables).forEach(key => {
+ if (!shouldSkipVariableKey(key)) {
+ hints.push(key);
}
-
- const list = (options && options.list) || [];
- const re = new RegExp(word.source, 'g');
- for (let dir = -1; dir <= 1; dir += 2) {
- let line = cur.line,
- endLine = Math.min(Math.max(line + dir * 500, editor.firstLine()), editor.lastLine()) + dir;
- for (; line != endLine; line += dir) {
- let text = editor.getLine(line),
- m;
- while ((m = re.exec(text))) {
- if (line == cur.line && curWord.length < 3) continue;
- list.push(...wordlist.filter((el) => el.toLowerCase().startsWith(curWord.toLowerCase())));
- }
- }
- }
- return { list: [...new Set(list)], from: CodeMirror.Pos(cur.line, start), to: CodeMirror.Pos(cur.line, end) };
});
+
+ // Handle process environment variables
+ if (allVariables.process && allVariables.process.env) {
+ Object.keys(allVariables.process.env).forEach(key => {
+ hints.push(`process.env.${key}`);
+ });
+ }
+
+ return hints;
+};
+
+/**
+ * Add API hints to categorized hints based on showHintsFor configuration
+ * @param {Set} apiHints - Set to add API hints to
+ * @param {string[]} showHintsFor - Array of hint types to show
+ */
+const addApiHintsToSet = (apiHints, showHintsFor) => {
+ const apiTypes = ['req', 'res', 'bru'];
+
+ apiTypes.forEach(apiType => {
+ if (showHintsFor.includes(apiType)) {
+ STATIC_API_HINTS[apiType].forEach(hint => {
+ generateProgressiveHints(hint).forEach(h => apiHints.add(h));
+ });
+ }
+ });
+};
+
+/**
+ * Add variable hints to categorized hints
+ * @param {Set} variableHints - Set to add variable hints to
+ * @param {Object} allVariables - All available variables
+ */
+const addVariableHintsToSet = (variableHints, allVariables) => {
+ // Add mock data hints
+ MOCK_DATA_HINTS.forEach(hint => {
+ generateProgressiveHints(hint).forEach(h => variableHints.add(h));
+ });
+
+ // Add variable hints with progressive hints
+ const variableHintsList = transformVariablesToHints(allVariables);
+ variableHintsList.forEach(hint => {
+ generateProgressiveHints(hint).forEach(h => variableHints.add(h));
+ });
+};
+
+/**
+ * Add custom hints to categorized hints
+ * @param {Set} anywordHints - Set to add custom hints to
+ * @param {string[]} customHints - Array of custom hints
+ */
+const addCustomHintsToSet = (anywordHints, customHints) => {
+ if (customHints && Array.isArray(customHints)) {
+ customHints.forEach(hint => {
+ generateProgressiveHints(hint).forEach(h => anywordHints.add(h));
+ });
+ }
+};
+
+/**
+ * Build categorized hints list from all sources
+ * @param {Object} allVariables - All available variables
+ * @param {string[]} anywordAutocompleteHints - Custom autocomplete hints
+ * @param {Object} options - Configuration options
+ * @returns {Object} Categorized hints object
+ */
+const buildCategorizedHintsList = (allVariables = {}, anywordAutocompleteHints = [], options = {}) => {
+ const categorizedHints = {
+ api: new Set(),
+ variables: new Set(),
+ anyword: new Set()
+ };
+
+ const showHintsFor = options.showHintsFor || [];
+
+ // Add different types of hints
+ addApiHintsToSet(categorizedHints.api, showHintsFor);
+ addVariableHintsToSet(categorizedHints.variables, allVariables);
+ addCustomHintsToSet(categorizedHints.anyword, anywordAutocompleteHints);
+
+ return {
+ api: Array.from(categorizedHints.api).sort(),
+ variables: Array.from(categorizedHints.variables).sort(),
+ anyword: Array.from(categorizedHints.anyword).sort()
+ };
+};
+
+/**
+ * Calculate replacement positions for variable context
+ * @param {Object} cursor - Current cursor position
+ * @param {Object} startPos - Start position of variable
+ * @param {string} wordMatch - The matched word
+ * @returns {Object} From and to positions for replacement
+ */
+const calculateVariableReplacementPositions = (cursor, startPos, wordMatch) => {
+ let replaceFrom, replaceTo;
+
+ if (wordMatch.endsWith('.')) {
+ replaceFrom = cursor;
+ replaceTo = cursor;
+ } else {
+ const lastDotIndex = wordMatch.lastIndexOf('.');
+ if (lastDotIndex !== -1) {
+ replaceFrom = { line: cursor.line, ch: startPos.ch + lastDotIndex + 1 };
+ replaceTo = cursor;
+ } else {
+ replaceFrom = startPos;
+ replaceTo = cursor;
+ }
+ }
+
+ return { replaceFrom, replaceTo };
+};
+
+/**
+ * Calculate replacement positions for regular word context
+ * @param {Object} cursor - Current cursor position
+ * @param {number} start - Start position of word
+ * @param {number} end - End position of word
+ * @param {string} word - The matched word
+ * @returns {Object} From and to positions for replacement
+ */
+const calculateWordReplacementPositions = (cursor, start, end, word) => {
+ let replaceFrom, replaceTo;
+
+ if (word.endsWith('.')) {
+ replaceFrom = { line: cursor.line, ch: end };
+ replaceTo = cursor;
+ } else {
+ const lastDotIndex = word.lastIndexOf('.');
+ if (lastDotIndex !== -1) {
+ replaceFrom = { line: cursor.line, ch: start + lastDotIndex + 1 };
+ replaceTo = { line: cursor.line, ch: end };
+ } else {
+ replaceFrom = { line: cursor.line, ch: start };
+ replaceTo = { line: cursor.line, ch: end };
+ }
+ }
+
+ return { replaceFrom, replaceTo };
+};
+
+/**
+ * Determine context based on word prefix
+ * @param {string} word - The word to analyze
+ * @returns {string} The determined context
+ */
+const determineWordContext = (word) => {
+ if (word.startsWith('req') || word.startsWith('res') || word.startsWith('bru')) {
+ return 'api';
+ }
+ return 'anyword';
+};
+
+/**
+ * Extract word from current line with boundaries
+ * @param {string} currentLine - The current line content
+ * @param {number} cursorPosition - Current cursor position
+ * @returns {Object|null} Word information or null if no word found
+ */
+const extractWordFromLine = (currentLine, cursorPosition) => {
+ let start = cursorPosition;
+ let end = start;
+
+ while (end < currentLine.length && WORD_PATTERN.test(currentLine.charAt(end))) {
+ ++end;
+ }
+ while (start && WORD_PATTERN.test(currentLine.charAt(start - 1))) {
+ --start;
+ }
+
+ if (start === end) {
+ return null;
+ }
+
+ return {
+ word: currentLine.slice(start, end),
+ start,
+ end
+ };
+};
+
+/**
+ * Get current word being typed at cursor position with context information
+ * @param {Object} cm - CodeMirror instance
+ * @returns {Object|null} Word information with context or null
+ */
+const getCurrentWordWithContext = (cm) => {
+ const cursor = cm.getCursor();
+ const currentLine = cm.getLine(cursor.line);
+ const currentString = cm.getRange({ line: cursor.line, ch: 0 }, cursor);
+
+ // Check for variable pattern {{word
+ const variableMatch = currentString.match(VARIABLE_PATTERN);
+ if (variableMatch) {
+ const wordMatch = variableMatch[1];
+ const startPos = { line: cursor.line, ch: currentString.lastIndexOf('{{') + 2 };
+ const { replaceFrom, replaceTo } = calculateVariableReplacementPositions(cursor, startPos, wordMatch);
+
+ return {
+ word: wordMatch,
+ from: replaceFrom,
+ to: replaceTo,
+ context: 'variables',
+ requiresBraces: true
+ };
+ }
+
+ // Check for regular word
+ const wordInfo = extractWordFromLine(currentLine, cursor.ch);
+ if (!wordInfo) {
+ return null;
+ }
+
+ const { word, start, end } = wordInfo;
+ const { replaceFrom, replaceTo } = calculateWordReplacementPositions(cursor, start, end, word);
+ const context = determineWordContext(word);
+
+ return {
+ word,
+ from: replaceFrom,
+ to: replaceTo,
+ context,
+ requiresBraces: false
+ };
+};
+
+/**
+ * Extract next segment suggestions from filtered hints
+ * @param {string[]} filteredHints - Pre-filtered hints
+ * @param {string} currentInput - Current user input
+ * @returns {string[]} Array of suggestion segments
+ */
+const extractNextSegmentSuggestions = (filteredHints, currentInput) => {
+ const suggestions = new Set();
+
+ filteredHints.forEach(hint => {
+ if (!hint.toLowerCase().startsWith(currentInput.toLowerCase())) {
+ return;
+ }
+
+ // Handle exact match case
+ if (hint.toLowerCase() === currentInput.toLowerCase()) {
+ suggestions.add(hint.substring(hint.lastIndexOf('.') + 1));
+ return;
+ }
+
+ const inputLength = currentInput.length;
+
+ if (currentInput.endsWith('.')) {
+ // Show next segment after the dot
+ const afterDot = hint.substring(inputLength);
+ const nextDot = afterDot.indexOf('.');
+ const segment = nextDot === -1 ? afterDot : afterDot.substring(0, nextDot);
+ suggestions.add(segment);
+ } else {
+ // Show complete current segment
+ const lastDotInInput = currentInput.lastIndexOf('.');
+ const currentSegmentStart = lastDotInInput + 1;
+ const nextDotAfterInput = hint.indexOf('.', currentSegmentStart);
+ const segment = nextDotAfterInput === -1
+ ? hint.substring(currentSegmentStart)
+ : hint.substring(currentSegmentStart, nextDotAfterInput);
+ suggestions.add(segment);
+ }
+ });
+
+ return Array.from(suggestions).sort();
+};
+
+/**
+ * Extract the relevant part of hints based on user input
+ * @param {string[]} filteredHints - Pre-filtered hints
+ * @param {string} currentInput - Current user input
+ * @returns {string[]} Array of hint parts
+ */
+const getHintParts = (filteredHints, currentInput) => {
+ if (!filteredHints || filteredHints.length === 0) {
+ return [];
+ }
+
+ return extractNextSegmentSuggestions(filteredHints, currentInput);
+};
+
+/**
+ * Get allowed hints based on context and configuration
+ * @param {Object} categorizedHints - All categorized hints
+ * @param {string} context - Current context
+ * @param {string[]} showHintsFor - Allowed hint types
+ * @returns {string[]} Array of allowed hints
+ */
+const getAllowedHintsByContext = (categorizedHints, context, showHintsFor) => {
+ let allowedHints = [];
+
+ if (context === 'variables' && showHintsFor.includes('variables')) {
+ allowedHints = [...categorizedHints.variables];
+ } else if (context === 'api') {
+ const hasApiHints = showHintsFor.some(hint => ['req', 'res', 'bru'].includes(hint));
+ if (hasApiHints) {
+ allowedHints = [...categorizedHints.api];
+ }
+ } else if (context === 'anyword') {
+ allowedHints = [...categorizedHints.anyword];
+ }
+
+ return allowedHints;
+};
+
+/**
+ * Filter hints based on current word and allowed hint types
+ * @param {Object} categorizedHints - All categorized hints
+ * @param {string} currentWord - Current word being typed
+ * @param {string} context - Current context
+ * @param {string[]} showHintsFor - Allowed hint types
+ * @returns {string[]} Filtered hints
+ */
+const filterHintsByContext = (categorizedHints, currentWord, context, showHintsFor = []) => {
+ if (!currentWord) {
+ return [];
+ }
+
+ const allowedHints = getAllowedHintsByContext(categorizedHints, context, showHintsFor);
+
+ const filtered = allowedHints.filter(hint => {
+ return hint.toLowerCase().startsWith(currentWord.toLowerCase());
+ });
+
+ const hintParts = getHintParts(filtered, currentWord);
+
+ return hintParts.slice(0, 50);
+};
+
+/**
+ * Create hint list for variables context
+ * @param {string[]} filteredHints - Filtered hints
+ * @param {Object} from - Start position
+ * @param {Object} to - End position
+ * @returns {Object} Hint object with list and positions
+ */
+const createVariableHintList = (filteredHints, from, to) => {
+ const hintList = filteredHints.map(hint => ({
+ text: hint,
+ displayText: hint
+ }));
+
+ return {
+ list: hintList,
+ from,
+ to
+ };
+};
+
+/**
+ * Create hint list for non-variable contexts
+ * @param {string[]} filteredHints - Filtered hints
+ * @param {Object} from - Start position
+ * @param {Object} to - End position
+ * @returns {Object} Hint object with list and positions
+ */
+const createStandardHintList = (filteredHints, from, to) => {
+ return {
+ list: filteredHints,
+ from,
+ to
+ };
+};
+
+/**
+ * Bruno AutoComplete Helper - Main function with context awareness
+ * @param {Object} cm - CodeMirror instance
+ * @param {Object} allVariables - All available variables
+ * @param {string[]} anywordAutocompleteHints - Custom autocomplete hints
+ * @param {Object} options - Configuration options
+ * @returns {Object|null} Hint object or null
+ */
+export const getAutoCompleteHints = (cm, allVariables = {}, anywordAutocompleteHints = [], options = {}) => {
+ if (!allVariables) {
+ return null;
+ }
+
+ const wordInfo = getCurrentWordWithContext(cm);
+ if (!wordInfo) {
+ return null;
+ }
+
+ const { word, from, to, context, requiresBraces } = wordInfo;
+ const showHintsFor = options.showHintsFor || [];
+
+ // Check if this context requires braces but we're not in a brace context
+ if (context === 'variables' && !requiresBraces) {
+ return null;
+ }
+
+ const categorizedHints = buildCategorizedHintsList(allVariables, anywordAutocompleteHints, options);
+ const filteredHints = filterHintsByContext(categorizedHints, word, context, showHintsFor);
+
+ if (filteredHints.length === 0) {
+ return null;
+ }
+
+ if (context === 'variables') {
+ return createVariableHintList(filteredHints, from, to);
+ }
+
+ return createStandardHintList(filteredHints, from, to);
+};
+
+/**
+ * Handle click events for autocomplete
+ * @param {Object} cm - CodeMirror instance
+ * @param {Object} options - Configuration options
+ */
+const handleClickForAutocomplete = (cm, options) => {
+ const allVariables = options.getAllVariables?.() || {};
+ const anywordAutocompleteHints = options.getAnywordAutocompleteHints?.() || [];
+ const showHintsFor = options.showHintsFor || [];
+
+ // Build all available hints
+ const categorizedHints = buildCategorizedHintsList(allVariables, anywordAutocompleteHints, options);
+
+ // Combine all hints based on showHintsFor configuration
+ let allHints = [];
+
+ // Add API hints if enabled
+ const hasApiHints = showHintsFor.some(hint => ['req', 'res', 'bru'].includes(hint));
+ if (hasApiHints) {
+ allHints = [...allHints, ...categorizedHints.api];
+ }
+
+ // Add variable hints if enabled
+ if (showHintsFor.includes('variables')) {
+ allHints = [...allHints, ...categorizedHints.variables];
+ }
+
+ // Add anyword hints (always included)
+ allHints = [...allHints, ...categorizedHints.anyword];
+
+ // Remove duplicates and sort
+ allHints = [...new Set(allHints)].sort();
+
+ if (allHints.length === 0) {
+ return;
+ }
+
+ const cursor = cm.getCursor();
+
+ if (cursor.ch > 0) return;
+
+ // Defer showHint to ensure editor is focused
+ setTimeout(() => {
+ cm.showHint({
+ hint: () => ({
+ list: allHints,
+ from: cursor,
+ to: cursor
+ }),
+ completeSingle: false
+ });
+ }, 0);
+};
+
+/**
+ * Handle keyup events for autocomplete
+ * @param {Object} cm - CodeMirror instance
+ * @param {Event} event - The keyup event
+ * @param {Object} options - Configuration options
+ */
+const handleKeyupForAutocomplete = (cm, event, options) => {
+ // Skip non-character keys
+ if (!NON_CHARACTER_KEYS.test(event?.key)) {
+ return;
+ }
+
+ const allVariables = options.getAllVariables?.() || {};
+ const anywordAutocompleteHints = options.getAnywordAutocompleteHints?.() || [];
+ const hints = getAutoCompleteHints(cm, allVariables, anywordAutocompleteHints, options);
+
+ if (!hints) {
+ if (cm.state.completionActive) {
+ cm.state.completionActive.close();
+ }
+ return;
+ }
+
+ cm.showHint({
+ hint: () => hints,
+ completeSingle: false
+ });
+};
+
+/**
+ * Setup Bruno AutoComplete Helper on a CodeMirror editor
+ * @param {Object} editor - CodeMirror editor instance
+ * @param {Object} options - Configuration options
+ * @returns {Function} Cleanup function
+ */
+export const setupAutoComplete = (editor, options = {}) => {
+ if (!editor) {
+ return;
+ }
+
+ const keyupHandler = (cm, event) => {
+ handleKeyupForAutocomplete(cm, event, options);
+ };
+
+ editor.on('keyup', keyupHandler);
+
+ const clickHandler = (cm) => {
+ // Only show hints on click if the option is enabled and there's no active completion
+ if (options.showHintsOnClick) {
+ handleClickForAutocomplete(cm, options);
+ }
+ };
+
+ // Add click handler if showHintsOnClick is enabled
+ if (options.showHintsOnClick) {
+ editor.on('mousedown', clickHandler);
+ }
+
+ return () => {
+ editor.off('keyup', keyupHandler);
+ if (options.showHintsOnClick) {
+ editor.off('mousedown', clickHandler);
+ }
+ };
+};
+
+// Initialize autocomplete command if not already present
+if (!CodeMirror.commands.autocomplete) {
CodeMirror.commands.autocomplete = (cm, hint, options) => {
cm.showHint({ hint, ...options });
};
-}
+}
\ No newline at end of file
diff --git a/packages/bruno-app/src/utils/codemirror/autocomplete.spec.js b/packages/bruno-app/src/utils/codemirror/autocomplete.spec.js
new file mode 100644
index 000000000..5a8d984c1
--- /dev/null
+++ b/packages/bruno-app/src/utils/codemirror/autocomplete.spec.js
@@ -0,0 +1,707 @@
+const { describe, it, expect, jest, beforeEach, afterEach } = require('@jest/globals');
+
+const _mockedCodemirror = {
+ commands: {},
+ getCursor: jest.fn(),
+ getLine: jest.fn(),
+ getRange: jest.fn(),
+ showHint: jest.fn(),
+ on: jest.fn(),
+ off: jest.fn(),
+ state: {}
+};
+
+jest.mock('codemirror', () => {
+ return _mockedCodemirror;
+});
+
+// Import the functions to test
+import {
+ getAutoCompleteHints,
+ setupAutoComplete
+} from './autocomplete';
+
+describe('Bruno Autocomplete', () => {
+ let mockedCodemirror;
+
+ beforeEach(() => {
+ mockedCodemirror = _mockedCodemirror;
+ });
+
+ afterEach(() => {
+ jest.clearAllMocks();
+ });
+
+ describe('getAutoCompleteHints', () => {
+ describe('Variable autocomplete', () => {
+ it('should provide variable hints when typing inside double curly braces', () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 9 });
+ mockedCodemirror.getLine.mockReturnValue('{{envVar}}');
+ mockedCodemirror.getRange.mockReturnValue('{{envVar');
+ const allVariables = {
+ envVar1: 'value1',
+ envVar2: 'value2',
+ };
+
+ const result = getAutoCompleteHints(mockedCodemirror, allVariables, [], {
+ showHintsFor: ['variables']
+ });
+
+ expect(result).toBeTruthy();
+ expect(result.list).toEqual(
+ expect.arrayContaining([
+ expect.objectContaining({ text: 'envVar1', displayText: 'envVar1' }),
+ expect.objectContaining({ text: 'envVar2', displayText: 'envVar2' })
+ ])
+ );
+ });
+
+ it('should include mock data functions with $ prefix', () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 9 });
+ mockedCodemirror.getRange.mockReturnValue('{{$randomI');
+
+ const result = getAutoCompleteHints(mockedCodemirror, {}, [], {
+ showHintsFor: ['variables']
+ });
+
+ expect(result.list).toEqual(
+ expect.arrayContaining([
+ expect.objectContaining({ displayText: '$randomInt' })
+ ])
+ );
+ });
+
+ it('should handle process environment variables', () => {
+ const allVariables = {
+ process: {
+ env: {
+ NODE_ENV: 'development',
+ API_URL: 'https://api.example.com'
+ }
+ }
+ };
+
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 14 });
+ mockedCodemirror.getRange.mockReturnValue('{{process.env.N');
+
+ const result = getAutoCompleteHints(mockedCodemirror, allVariables, [], {
+ showHintsFor: ['variables']
+ });
+
+ expect(result).toBeTruthy();
+ expect(result.list).toEqual(
+ expect.arrayContaining([
+ expect.objectContaining({ displayText: 'NODE_ENV' })
+ ])
+ );
+ });
+
+ it('should skip special internal keys', () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 10 });
+ mockedCodemirror.getRange.mockReturnValue('{{path');
+
+ const allVariables = {
+ pathParams: { id: '123' },
+ maskedEnvVariables: { secret: '***' },
+ path: 'value'
+ };
+
+ const result = getAutoCompleteHints(mockedCodemirror, allVariables, [], {
+ showHintsFor: ['variables']
+ });
+
+ expect(result).toBeTruthy();
+ expect(result.list).toEqual(
+ expect.arrayContaining([
+ expect.objectContaining({ displayText: 'path' })
+ ])
+ );
+ expect(result.list).not.toEqual(
+ expect.arrayContaining([
+ expect.objectContaining({ displayText: 'pathParams' })
+ ])
+ );
+ });
+
+ it('should handle nested object variables', () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 12 });
+ mockedCodemirror.getRange.mockReturnValue('{{config.api.');
+
+ const allVariables = {
+ 'config.api.url': 'https://echo.usebruno.com',
+ 'config.api.client_id': 'client_id',
+ 'config.api.client_secret': 'client_secret',
+ 'config.app.name': 'bruno'
+ };
+
+ const result = getAutoCompleteHints(mockedCodemirror, allVariables, [], {
+ showHintsFor: ['variables']
+ });
+
+ expect(result).toBeTruthy();
+ expect(result.list).toEqual(
+ expect.arrayContaining([
+ expect.objectContaining({ displayText: 'url' }),
+ expect.objectContaining({ displayText: 'client_id' }),
+ expect.objectContaining({ displayText: 'client_secret' })
+ ])
+ );
+ });
+ });
+
+ describe('API object context (req, res, bru)', () => {
+ const testCases = [
+ {
+ name: 'req object',
+ input: 'req.',
+ expected: ['url', 'method', 'headers', 'body', 'timeout']
+ },
+ {
+ name: 'res object',
+ input: 'res.',
+ expected: ['status', 'statusText', 'headers', 'body', 'responseTime']
+ },
+ {
+ name: 'bru object',
+ input: 'bru.',
+ expected: ['cwd()', 'getEnvName()', 'getProcessEnv(key)', 'hasEnvVar(key)', 'getEnvVar(key)']
+ }
+ ];
+
+ testCases.forEach(({ name, input, expected }) => {
+ it(`should provide ${name} hints`, () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: input.length });
+ mockedCodemirror.getLine.mockReturnValue(input);
+ mockedCodemirror.getRange.mockReturnValue(input);
+
+ const result = getAutoCompleteHints(mockedCodemirror, {}, [], {
+ showHintsFor: ['req', 'res', 'bru']
+ });
+
+ expect(result).toBeTruthy();
+ expect(result.list).toEqual(expect.arrayContaining(expected));
+ });
+ });
+
+ it('should provide method hints for nested req objects', () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 7 });
+ mockedCodemirror.getLine.mockReturnValue('req.get');
+ mockedCodemirror.getRange.mockReturnValue('req.get');
+
+ const result = getAutoCompleteHints(mockedCodemirror, {}, [], {
+ showHintsFor: ['req']
+ });
+
+ expect(result).toBeTruthy();
+ expect(result.list).toEqual(
+ expect.arrayContaining([
+ 'getUrl()',
+ 'getMethod()',
+ 'getAuthMode()',
+ 'getHeader(name)',
+ 'getHeaders()',
+ 'getBody()',
+ 'getTimeout()',
+ 'getExecutionMode()',
+ 'getName()'
+ ])
+ );
+ });
+
+ it('should handle bru.runner sub-object', () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 11 });
+ mockedCodemirror.getLine.mockReturnValue('bru.runner.');
+ mockedCodemirror.getRange.mockReturnValue('bru.runner.');
+
+ const result = getAutoCompleteHints(mockedCodemirror, {}, [], {
+ showHintsFor: ['bru']
+ });
+
+ expect(result).toBeTruthy();
+ expect(result.list).toEqual(
+ expect.arrayContaining([
+ 'setNextRequest(requestName)',
+ 'skipRequest()',
+ 'stopExecution()'
+ ])
+ );
+ });
+ });
+
+ describe('Custom hints and anyword context', () => {
+ it('should provide custom anyword hints', () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 7 });
+ mockedCodemirror.getLine.mockReturnValue('Content-');
+ mockedCodemirror.getRange.mockReturnValue('Content-');
+
+ const customHints = ['Content-Type', 'Content-Encoding', 'Content-Length'];
+
+ const result = getAutoCompleteHints(mockedCodemirror, {}, customHints, {
+ showHintsFor: ['variables']
+ });
+
+ expect(result).toBeTruthy();
+ expect(result.list).toEqual(
+ expect.arrayContaining(['Content-Type', 'Content-Encoding', 'Content-Length'])
+ );
+ });
+
+ it('should handle progressive hints for custom hints', () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 6 });
+ mockedCodemirror.getLine.mockReturnValue('utils.');
+ mockedCodemirror.getRange.mockReturnValue('utils.');
+
+ const customHints = ['utils.string.trim', 'utils.string.capitalize', 'utils.array.map'];
+
+ const result = getAutoCompleteHints(mockedCodemirror, {}, customHints, {
+ showHintsFor: ['variables']
+ });
+
+ expect(result).toBeTruthy();
+ expect(result.list).toEqual(
+ expect.arrayContaining(['string', 'array'])
+ );
+ });
+ });
+
+ describe('Filtering and options', () => {
+ beforeEach(() => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 4 });
+ mockedCodemirror.getLine.mockReturnValue('req.');
+ mockedCodemirror.getRange.mockReturnValue('req.');
+ });
+
+ it('should respect showHintsFor option for excluding hints', () => {
+ const options = { showHintsFor: ['res', 'bru'] };
+ const result = getAutoCompleteHints(mockedCodemirror, {}, [], options);
+
+ expect(result).toBeNull();
+ });
+
+ it('should show hints when included in showHintsFor', () => {
+ const options = { showHintsFor: ['req'] };
+ const result = getAutoCompleteHints(mockedCodemirror, {}, [], options);
+
+ expect(result).toBeTruthy();
+ expect(result.list).toEqual(
+ expect.arrayContaining(['url', 'method'])
+ );
+ });
+
+ it('should filter variables based on showHintsFor', () => {
+ mockedCodemirror.getLine.mockReturnValue('{{varNa}}');
+ mockedCodemirror.getRange.mockReturnValue('{{varNa');
+
+ const allVariables = { envVar1: 'value1' };
+ const options = { showHintsFor: ['req', 'res', 'bru'] };
+
+ const result = getAutoCompleteHints(mockedCodemirror, allVariables, [], options);
+
+ expect(result).toBeNull();
+ });
+
+ it('should limit results to 50 hints', () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 10 });
+ mockedCodemirror.getLine.mockReturnValue('{{varName}}');
+ mockedCodemirror.getRange.mockReturnValue('{{v');
+
+ const allVariables = {};
+ for (let i = 0; i < 100; i++) {
+ allVariables[`var${i}`] = `value${i}`;
+ }
+
+ const result = getAutoCompleteHints(mockedCodemirror, allVariables, [], {
+ showHintsFor: ['variables']
+ });
+
+ expect(result).toBeTruthy();
+ expect(result.list.length).toBeLessThanOrEqual(50);
+ });
+
+ it('should sort hints alphabetically', () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 10 });
+ mockedCodemirror.getLine.mockReturnValue('{{v.');
+ mockedCodemirror.getRange.mockReturnValue('{{v.');
+
+ const allVariables = {
+ 'v.zebra': 'value1',
+ 'v.apple': 'value2',
+ 'v.banana': 'value3'
+ };
+
+ const result = getAutoCompleteHints(mockedCodemirror, allVariables, [], {
+ showHintsFor: ['variables']
+ });
+
+ expect(result).toBeTruthy();
+ const displayTexts = result.list.map(item =>
+ typeof item === 'object' ? item.displayText : item
+ );
+
+ const userVars = displayTexts.filter(text => !text.startsWith('$'));
+ expect(userVars).toEqual(['apple', 'banana', 'zebra']);
+ });
+ });
+
+ describe('Edge cases', () => {
+ it('should return null when no word is found at cursor', () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 0 });
+ mockedCodemirror.getLine.mockReturnValue(' ');
+ mockedCodemirror.getRange.mockReturnValue('');
+
+ const result = getAutoCompleteHints(mockedCodemirror, {}, []);
+
+ expect(result).toBeNull();
+ });
+
+ it('should handle empty or null variables', () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 10 });
+ mockedCodemirror.getLine.mockReturnValue('{{varName}}');
+ mockedCodemirror.getRange.mockReturnValue('{{varName');
+
+ const emptyResult = getAutoCompleteHints(mockedCodemirror, {}, []);
+ const nullResult = getAutoCompleteHints(mockedCodemirror, null, []);
+
+ expect(emptyResult).toBeNull();
+ expect(nullResult).toBeNull();
+ });
+
+ it('should handle cursor at end of line', () => {
+ const line = 'req.getHea';
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: line.length });
+ mockedCodemirror.getLine.mockReturnValue(line);
+ mockedCodemirror.getRange.mockReturnValue(line);
+
+ const result = getAutoCompleteHints(mockedCodemirror, {}, [], {
+ showHintsFor: ['req']
+ });
+
+ expect(result).toBeTruthy();
+ expect(result.list).toEqual(
+ expect.arrayContaining(['getHeader(name)', 'getHeaders()'])
+ );
+ });
+
+ it('should handle case-insensitive matching', () => {
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 10 });
+ mockedCodemirror.getLine.mockReturnValue('{{varName}}');
+ mockedCodemirror.getRange.mockReturnValue('{{var');
+
+ const allVariables = {
+ variable1: 'value1',
+ Variable2: 'value2',
+ VARIABLE3: 'value3'
+ };
+
+ const result = getAutoCompleteHints(mockedCodemirror, allVariables, [], {
+ showHintsFor: ['variables']
+ });
+
+ expect(result).toBeTruthy();
+ expect(result.list.length).toBe(3);
+ });
+ });
+ });
+
+ describe('setupAutoComplete', () => {
+ let mockGetAllVariables;
+ let cleanupFn;
+
+ beforeEach(() => {
+ mockGetAllVariables = jest.fn(() => ({ }));
+ mockedCodemirror.state = {};
+ });
+
+ afterEach(() => {
+ if (cleanupFn) {
+ cleanupFn();
+ }
+ });
+
+ describe('Setup and cleanup', () => {
+ it('should setup keyup event listener and return cleanup function', () => {
+ const options = { getAllVariables: mockGetAllVariables };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+
+ expect(mockedCodemirror.on).toHaveBeenCalledWith('keyup', expect.any(Function));
+ expect(cleanupFn).toBeInstanceOf(Function);
+
+ cleanupFn();
+ expect(mockedCodemirror.off).toHaveBeenCalledWith('keyup', expect.any(Function));
+ });
+
+ it('should not setup if editor is null', () => {
+ const result = setupAutoComplete(null, { getAllVariables: mockGetAllVariables });
+
+ expect(result).toBeUndefined();
+ expect(mockedCodemirror.on).not.toHaveBeenCalled();
+ });
+ });
+
+ describe('Event handling', () => {
+ it('should trigger hints on character key press', () => {
+ const options = {
+ getAllVariables: mockGetAllVariables,
+ showHintsFor: ['req']
+ };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+ const keyupHandler = mockedCodemirror.on.mock.calls[0][1];
+
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 4 });
+ mockedCodemirror.getLine.mockReturnValue('req.');
+ mockedCodemirror.getRange.mockReturnValue('req.');
+
+ const mockEvent = { key: 'a' };
+ keyupHandler(mockedCodemirror, mockEvent);
+
+ expect(mockGetAllVariables).toHaveBeenCalled();
+ expect(mockedCodemirror.showHint).toHaveBeenCalled();
+ });
+
+ it('should not trigger hints on non-character keys', () => {
+ const options = { getAllVariables: mockGetAllVariables };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+ const keyupHandler = mockedCodemirror.on.mock.calls[0][1];
+
+ const nonCharacterKeys = ['Shift', 'Tab', 'Enter', 'Escape', 'ArrowUp', 'ArrowDown', 'Meta'];
+
+ nonCharacterKeys.forEach(key => {
+ const mockEvent = { key };
+ keyupHandler(mockedCodemirror, mockEvent);
+ });
+
+ expect(mockedCodemirror.showHint).not.toHaveBeenCalled();
+ });
+
+ it('should close existing completion when no hints available', () => {
+ const options = { getAllVariables: mockGetAllVariables };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+ const keyupHandler = mockedCodemirror.on.mock.calls[0][1];
+
+ const mockCompletion = { close: jest.fn() };
+ mockedCodemirror.state.completionActive = mockCompletion;
+
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 0 });
+ mockedCodemirror.getLine.mockReturnValue(' ');
+ mockedCodemirror.getRange.mockReturnValue('');
+
+ const mockEvent = { key: 'a' };
+ keyupHandler(mockedCodemirror, mockEvent);
+
+ expect(mockCompletion.close).toHaveBeenCalled();
+ });
+
+ it('should pass options to getAutoCompleteHints', () => {
+ const options = {
+ getAllVariables: mockGetAllVariables,
+ showHintsFor: ['req']
+ };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+ const keyupHandler = mockedCodemirror.on.mock.calls[0][1];
+
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 4 });
+ mockedCodemirror.getLine.mockReturnValue('req.');
+ mockedCodemirror.getRange.mockReturnValue('req.');
+
+ const mockEvent = { key: 'a' };
+ keyupHandler(mockedCodemirror, mockEvent);
+
+ expect(mockedCodemirror.showHint).toHaveBeenCalledWith({
+ hint: expect.any(Function),
+ completeSingle: false
+ });
+ });
+ });
+
+ describe('Click event handling (showHintsOnClick)', () => {
+ it('should setup mousedown event listener when showHintsOnClick is enabled', () => {
+ const options = {
+ getAllVariables: mockGetAllVariables,
+ showHintsOnClick: true
+ };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+
+ expect(mockedCodemirror.on).toHaveBeenCalledWith('keyup', expect.any(Function));
+ expect(mockedCodemirror.on).toHaveBeenCalledWith('mousedown', expect.any(Function));
+ expect(mockedCodemirror.on).toHaveBeenCalledTimes(2);
+ });
+
+ it('should not setup mousedown event listener when showHintsOnClick is disabled', () => {
+ const options = {
+ getAllVariables: mockGetAllVariables,
+ showHintsOnClick: false
+ };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+
+ expect(mockedCodemirror.on).toHaveBeenCalledWith('keyup', expect.any(Function));
+ expect(mockedCodemirror.on).toHaveBeenCalledTimes(1);
+ });
+
+ it('should not setup mousedown event listener when showHintsOnClick is undefined', () => {
+ const options = {
+ getAllVariables: mockGetAllVariables
+ };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+
+ expect(mockedCodemirror.on).toHaveBeenCalledWith('keyup', expect.any(Function));
+ expect(mockedCodemirror.on).toHaveBeenCalledTimes(1);
+ });
+
+ it('should show hints on click when showHintsOnClick is enabled', () => {
+ jest.useFakeTimers();
+
+ const mockGetAnywordAutocompleteHints = jest.fn(() => ['Content-Type', 'Accept']);
+ const options = {
+ getAllVariables: mockGetAllVariables,
+ getAnywordAutocompleteHints: mockGetAnywordAutocompleteHints,
+ showHintsOnClick: true,
+ showHintsFor: ['req', 'variables']
+ };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+
+ // Find the click handler (mousedown event)
+ const clickHandler = mockedCodemirror.on.mock.calls.find(call => call[0] === 'mousedown')[1];
+
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 0 });
+
+ clickHandler(mockedCodemirror);
+
+ // Run all timers to execute the setTimeout
+ jest.runAllTimers();
+
+ expect(mockGetAllVariables).toHaveBeenCalled();
+ expect(mockGetAnywordAutocompleteHints).toHaveBeenCalled();
+ expect(mockedCodemirror.showHint).toHaveBeenCalled();
+
+ jest.useRealTimers();
+ });
+
+ it('should not show hints on click when showHintsOnClick is disabled', () => {
+ const options = {
+ getAllVariables: mockGetAllVariables,
+ showHintsOnClick: false
+ };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+
+ // There should be no mousedown handler
+ const mousedownCalls = mockedCodemirror.on.mock.calls.filter(call => call[0] === 'mousedown');
+ expect(mousedownCalls).toHaveLength(0);
+ });
+
+ it('should cleanup mousedown event listener when showHintsOnClick was enabled', () => {
+ const options = {
+ getAllVariables: mockGetAllVariables,
+ showHintsOnClick: true
+ };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+
+ cleanupFn();
+
+ expect(mockedCodemirror.off).toHaveBeenCalledWith('keyup', expect.any(Function));
+ expect(mockedCodemirror.off).toHaveBeenCalledWith('mousedown', expect.any(Function));
+ expect(mockedCodemirror.off).toHaveBeenCalledTimes(2);
+ });
+
+ it('should only cleanup keyup event listener when showHintsOnClick was disabled', () => {
+ const options = {
+ getAllVariables: mockGetAllVariables,
+ showHintsOnClick: false
+ };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+
+ cleanupFn();
+
+ expect(mockedCodemirror.off).toHaveBeenCalledWith('keyup', expect.any(Function));
+ expect(mockedCodemirror.off).toHaveBeenCalledTimes(1);
+ });
+
+ it('should show all available hints on click based on showHintsFor configuration', () => {
+ jest.useFakeTimers();
+
+ const mockGetAnywordAutocompleteHints = jest.fn(() => ['Content-Type', 'Accept']);
+ const options = {
+ getAllVariables: mockGetAllVariables.mockReturnValue({
+ envVar1: 'value1',
+ envVar2: 'value2'
+ }),
+ getAnywordAutocompleteHints: mockGetAnywordAutocompleteHints,
+ showHintsOnClick: true,
+ showHintsFor: ['req', 'variables']
+ };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+
+ // Find the click handler (mousedown event)
+ const clickHandler = mockedCodemirror.on.mock.calls.find(call => call[0] === 'mousedown')[1];
+
+ const mockCursor = { line: 0, ch: 0 };
+ mockedCodemirror.getCursor.mockReturnValue(mockCursor);
+
+ clickHandler(mockedCodemirror);
+
+ // Run all timers to execute the setTimeout
+ jest.runAllTimers();
+
+ expect(mockedCodemirror.showHint).toHaveBeenCalledWith({
+ hint: expect.any(Function),
+ completeSingle: false
+ });
+
+ // Verify the hint function returns the expected structure
+ const hintCall = mockedCodemirror.showHint.mock.calls[0][0];
+ const hintResult = hintCall.hint();
+
+ expect(hintResult).toEqual({
+ list: expect.any(Array),
+ from: mockCursor,
+ to: mockCursor
+ });
+ expect(hintResult.list.length).toBeGreaterThan(0);
+
+ jest.useRealTimers();
+ });
+
+ it('should not show hints on click when no hints are available', () => {
+ const options = {
+ getAllVariables: mockGetAllVariables.mockReturnValue({}),
+ getAnywordAutocompleteHints: jest.fn(() => []),
+ showHintsOnClick: true,
+ showHintsFor: []
+ };
+ cleanupFn = setupAutoComplete(mockedCodemirror, options);
+
+ // Find the click handler (mousedown event)
+ const clickHandler = mockedCodemirror.on.mock.calls.find(call => call[0] === 'mousedown')[1];
+
+ mockedCodemirror.getCursor.mockReturnValue({ line: 0, ch: 0 });
+
+ clickHandler(mockedCodemirror);
+
+ expect(mockedCodemirror.showHint).not.toHaveBeenCalled();
+ });
+ });
+ });
+
+ describe('CodeMirror integration', () => {
+ it('should define autocomplete command if not exists', () => {
+ delete mockedCodemirror.commands.autocomplete;
+
+ jest.isolateModules(() => {
+ require('./autocomplete');
+ });
+
+ expect(mockedCodemirror.commands.autocomplete).toBeDefined();
+ expect(typeof mockedCodemirror.commands.autocomplete).toBe('function');
+ });
+
+ it('should not override existing autocomplete command', () => {
+ const existingCommand = jest.fn();
+ mockedCodemirror.commands.autocomplete = existingCommand;
+
+ jest.isolateModules(() => {
+ require('./autocomplete');
+ });
+
+ expect(mockedCodemirror.commands.autocomplete).toBe(existingCommand);
+ });
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-app/src/utils/codemirror/brunoVarInfo.js b/packages/bruno-app/src/utils/codemirror/brunoVarInfo.js
index c5cf174ea..52614703f 100644
--- a/packages/bruno-app/src/utils/codemirror/brunoVarInfo.js
+++ b/packages/bruno-app/src/utils/codemirror/brunoVarInfo.js
@@ -6,10 +6,7 @@
* LICENSE file at https://github.com/graphql/codemirror-graphql/tree/v0.8.3
*/
-// Todo: Fix this
-// import { interpolate } from '@usebruno/common';
-import brunoCommon from '@usebruno/common';
-const { interpolate } = brunoCommon;
+import { interpolate } from '@usebruno/common';
let CodeMirror;
const SERVER_RENDERED = typeof window === 'undefined' || global['PREVENT_CODEMIRROR_RENDER'] === true;
@@ -19,23 +16,8 @@ if (!SERVER_RENDERED) {
CodeMirror = require('codemirror');
const renderVarInfo = (token, options, cm, pos) => {
- const str = token.string || '';
- if (!str || !str.length || typeof str !== 'string') {
- return;
- }
-
- // str is of format {{variableName}} or :variableName, extract variableName
- let variableName;
- let variableValue;
-
- if (str.startsWith('{{')) {
- variableName = str.replace('{{', '').replace('}}', '').trim();
- variableValue = interpolate(get(options.variables, variableName), options.variables);
- } else if (str.startsWith('/:')) {
- variableName = str.replace('/:', '').trim();
- variableValue =
- options.variables && options.variables.pathParams ? options.variables.pathParams[variableName] : undefined;
- }
+ // Extract variable name and value based on token
+ const { variableName, variableValue } = extractVariableInfo(token.string, options.variables);
if (variableValue === undefined) {
return;
@@ -44,11 +26,13 @@ if (!SERVER_RENDERED) {
const into = document.createElement('div');
const descriptionDiv = document.createElement('div');
descriptionDiv.className = 'info-description';
+
if (options?.variables?.maskedEnvVariables?.includes(variableName)) {
descriptionDiv.appendChild(document.createTextNode('*****'));
} else {
descriptionDiv.appendChild(document.createTextNode(variableValue));
}
+
into.appendChild(descriptionDiv);
return into;
@@ -205,3 +189,29 @@ if (!SERVER_RENDERED) {
CodeMirror.on(cm.getWrapperElement(), 'mouseout', onMouseOut);
}
}
+
+export const extractVariableInfo = (str, variables) => {
+ let variableName;
+ let variableValue;
+
+ if (!str || !str.length || typeof str !== 'string') {
+ return { variableName, variableValue };
+ }
+
+ // Regex to match double brace variable syntax: {{variableName}}
+ const DOUBLE_BRACE_PATTERN = /\{\{([^}]+)\}\}/;
+
+ if (DOUBLE_BRACE_PATTERN.test(str)) {
+ variableName = str.replace('{{', '').replace('}}', '').trim();
+ variableValue = interpolate(get(variables, variableName), variables);
+ } else if (str.startsWith('/:')) {
+ variableName = str.replace('/:', '').trim();
+ variableValue = variables?.pathParams?.[variableName];
+ } else {
+ // direct variable reference (e.g., for numeric values in JSON mode or plain variable names)
+ variableName = str;
+ variableValue = interpolate(get(variables, variableName), variables);
+ }
+
+ return { variableName, variableValue };
+};
\ No newline at end of file
diff --git a/packages/bruno-app/src/utils/codemirror/brunoVarInfo.spec.js b/packages/bruno-app/src/utils/codemirror/brunoVarInfo.spec.js
new file mode 100644
index 000000000..5002097c2
--- /dev/null
+++ b/packages/bruno-app/src/utils/codemirror/brunoVarInfo.spec.js
@@ -0,0 +1,227 @@
+import { interpolate } from '@usebruno/common';
+import { extractVariableInfo } from './brunoVarInfo';
+
+// Mock the dependencies
+jest.mock('@usebruno/common', () => ({
+ interpolate: jest.fn()
+}));
+
+describe('extractVariableInfo', () => {
+ let mockVariables;
+
+ beforeEach(() => {
+ jest.clearAllMocks();
+
+ // Setup mock variables
+ mockVariables = {
+ apiKey: 'test-api-key-123',
+ baseUrl: 'https://api.example.com',
+ userId: 12345,
+ pathParams: {
+ id: 'user-123',
+ slug: 'test-post'
+ }
+ };
+
+ // Setup interpolate mock
+ interpolate.mockImplementation((value, variables) => {
+ if (typeof value === 'string' && value.includes('{{')) {
+ return value.replace(/\{\{(\w+)\}\}/g, (match, key) => variables[key] || match);
+ }
+ return value;
+ });
+ });
+
+ describe('input validation', () => {
+ it('should return undefined for null input', () => {
+ const result = extractVariableInfo(null, mockVariables);
+ expect(result.variableName).toBeUndefined();
+ expect(result.variableValue).toBeUndefined();
+ });
+
+ it('should return undefined for undefined input', () => {
+ const result = extractVariableInfo(undefined, mockVariables);
+ expect(result.variableName).toBeUndefined();
+ expect(result.variableValue).toBeUndefined();
+ });
+
+ it('should return undefined for empty string', () => {
+ const result = extractVariableInfo('', mockVariables);
+ expect(result.variableName).toBeUndefined();
+ expect(result.variableValue).toBeUndefined();
+ });
+
+ it('should return undefined for non-string input', () => {
+ const result = extractVariableInfo(123, mockVariables);
+ expect(result.variableName).toBeUndefined();
+ expect(result.variableValue).toBeUndefined();
+ });
+
+ it('should return undefined for object input', () => {
+ const result = extractVariableInfo({}, mockVariables);
+ expect(result.variableName).toBeUndefined();
+ expect(result.variableValue).toBeUndefined();
+ });
+ });
+
+ describe('double brace format ({{variableName}})', () => {
+ it('should parse double brace variables correctly', () => {
+ const result = extractVariableInfo('{{apiKey}}', mockVariables);
+
+ expect(result).toEqual({
+ variableName: 'apiKey',
+ variableValue: 'test-api-key-123'
+ });
+
+ expect(interpolate).toHaveBeenCalledWith('test-api-key-123', mockVariables);
+ });
+
+ it('should handle whitespace in double brace variables', () => {
+ const result = extractVariableInfo('{{ apiKey }}', mockVariables);
+
+ expect(result).toEqual({
+ variableName: 'apiKey',
+ variableValue: 'test-api-key-123'
+ });
+ });
+
+ it('should return undefined variableValue for non-existent double brace variable', () => {
+ const result = extractVariableInfo('{{nonExistent}}', mockVariables);
+
+ expect(result).toEqual({
+ variableName: 'nonExistent',
+ variableValue: undefined
+ });
+ });
+ });
+
+ describe('path parameter format (/:variableName)', () => {
+ it('should parse path parameter variables correctly', () => {
+ const result = extractVariableInfo('/:id', mockVariables);
+
+ expect(result).toEqual({
+ variableName: 'id',
+ variableValue: 'user-123'
+ });
+ });
+
+ it('should return undefined for non-existent path parameter', () => {
+ const result = extractVariableInfo('/:nonExistent', mockVariables);
+
+ expect(result).toEqual({
+ variableName: 'nonExistent',
+ variableValue: undefined
+ });
+ });
+
+ it('should handle missing pathParams object', () => {
+ const variablesWithoutPathParams = { ...mockVariables };
+ delete variablesWithoutPathParams.pathParams;
+
+ const result = extractVariableInfo('/:id', variablesWithoutPathParams);
+
+ expect(result).toEqual({
+ variableName: 'id',
+ variableValue: undefined
+ });
+ });
+
+ it('should handle null pathParams', () => {
+ const variablesWithNullPathParams = { ...mockVariables, pathParams: null };
+
+ const result = extractVariableInfo('/:id', variablesWithNullPathParams);
+
+ expect(result).toEqual({
+ variableName: 'id',
+ variableValue: undefined
+ });
+ });
+ });
+
+ describe('direct variable format', () => {
+ it('should parse direct variable names correctly', () => {
+ const result = extractVariableInfo('baseUrl', mockVariables);
+
+ expect(result).toEqual({
+ variableName: 'baseUrl',
+ variableValue: 'https://api.example.com'
+ });
+
+ expect(interpolate).toHaveBeenCalledWith('https://api.example.com', mockVariables);
+ });
+
+ it('should handle numeric variable values', () => {
+ const result = extractVariableInfo('userId', mockVariables);
+
+ expect(result).toEqual({
+ variableName: 'userId',
+ variableValue: 12345
+ });
+ });
+
+ it('should return undefined for non-existent direct variable', () => {
+ const result = extractVariableInfo('nonExistent', mockVariables);
+
+ expect(result).toEqual({
+ variableName: 'nonExistent',
+ variableValue: undefined
+ });
+ });
+
+ it('should handle variables with special characters', () => {
+ mockVariables['special-var_name'] = 'special-var_value';
+
+ const result = extractVariableInfo('special-var_name', mockVariables);
+
+ expect(result).toEqual({
+ variableName: 'special-var_name',
+ variableValue: 'special-var_value'
+ });
+ });
+ });
+
+ describe('edge cases', () => {
+ it('should handle empty variables object', () => {
+ const result = extractVariableInfo('{{apiKey}}', {});
+
+ expect(result).toEqual({
+ variableName: 'apiKey',
+ variableValue: undefined
+ });
+ });
+
+ it('should handle null variables object', () => {
+ const result = extractVariableInfo('{{apiKey}}', null);
+
+ expect(result).toEqual({
+ variableName: 'apiKey',
+ variableValue: undefined
+ });
+ });
+
+ it('should handle undefined variables object', () => {
+ const result = extractVariableInfo('{{apiKey}}', undefined);
+
+ expect(result).toEqual({
+ variableName: 'apiKey',
+ variableValue: undefined
+ });
+ });
+ });
+
+ describe('return value structure', () => {
+ it('should always return an object with variableName and variableValue properties', () => {
+ const result = extractVariableInfo('{{apiKey}}', mockVariables);
+
+ expect(result).toHaveProperty('variableName');
+ expect(result).toHaveProperty('variableValue');
+ expect(typeof result.variableName).toBe('string');
+ });
+
+ it('should return variableValue as the interpolated value', () => {
+ const result = extractVariableInfo('{{apiKey}}', mockVariables);
+
+ expect(result.variableValue).toBe('test-api-key-123');
+ });
+ });
+});
diff --git a/packages/bruno-app/src/utils/codemirror/javascript-lint.js b/packages/bruno-app/src/utils/codemirror/javascript-lint.js
index 475686f5d..0038406aa 100644
--- a/packages/bruno-app/src/utils/codemirror/javascript-lint.js
+++ b/packages/bruno-app/src/utils/codemirror/javascript-lint.js
@@ -5,6 +5,8 @@
* Copyright (C) 2017 by Marijn Haverbeke and others
*/
+import { JSHINT } from 'jshint';
+
let CodeMirror;
const SERVER_RENDERED = typeof window === 'undefined' || global['PREVENT_CODEMIRROR_RENDER'] === true;
@@ -19,6 +21,31 @@ if (!SERVER_RENDERED) {
}
return [];
}
+
+ // Set default options for Bruno
+ const defaultOptions = {
+ esversion: 11,
+ expr: true,
+ asi: true,
+ undef: true,
+ browser: true,
+ devel: true,
+ module: true,
+ node: true,
+ predef: {
+ 'bru': false,
+ 'req': false,
+ 'res': false,
+ 'test': false,
+ 'expect': false,
+ 'require': false,
+ 'module': false
+ }
+ };
+
+ // Merge provided options with defaults
+ options = Object.assign({}, defaultOptions, options);
+
if (!options.indent)
// JSHint error.character actually is a column index, this fixes underlining on lines using tabs for indentation
options.indent = 1; // JSHint default value is 4
@@ -30,15 +57,19 @@ if (!SERVER_RENDERED) {
* Filter out errors due to top level awaits
* See https://github.com/usebruno/bruno/issues/1214
*
+ * - E058: Missing semicolon at top level await
+ * codemirror error: "Missing semicolon."
+ * - W024: 'await' used as identifier (JSHint doesn't recognize top-level await syntax)
+ * codemirror error: "Expected an identifier and instead saw 'await' (a reserved word)."
+ *
* Once JSHINT top level await support is added, this file can be removed
* and we can use the default javascript-lint addon from codemirror
*/
errors = filter(errors, (error) => {
- if (error.code === 'E058') {
+ if (error.code === 'E058' || error.code === 'W024') {
if (
error.evidence &&
error.evidence.includes('await') &&
- error.reason === 'Missing semicolon.' &&
error.scope === '(main)'
) {
return false;
@@ -47,6 +78,18 @@ if (!SERVER_RENDERED) {
return true;
}
+ /*
+ * Filter out errors due to atob/btoa redefinition
+ *
+ * - W079: Redefinition of '{a}'
+ * This JSHint warning triggers when a variable name conflicts with a built-in global.
+ * We filter this for atob/btoa to allow explicit requires in Node.js environments
+ * where these browser functions might not be available.
+ */
+ if (error.code === 'W079' && (error.a === 'atob' || error.a === 'btoa')) {
+ return false;
+ }
+
return true;
});
diff --git a/packages/bruno-app/src/utils/codemirror/mock-data-hints.js b/packages/bruno-app/src/utils/codemirror/mock-data-hints.js
new file mode 100644
index 000000000..fb03e9f11
--- /dev/null
+++ b/packages/bruno-app/src/utils/codemirror/mock-data-hints.js
@@ -0,0 +1,25 @@
+import { mockDataFunctions } from '@usebruno/common';
+
+const MOCK_FUNCTION_SUGGESTIONS = Object.keys(mockDataFunctions).map(key => `$${key}`);
+
+export const getMockDataHints = (cm) => {
+ const cursor = cm.getCursor();
+ const currentString = cm.getRange({ line: cursor.line, ch: 0 }, cursor);
+
+ const match = currentString.match(/\{\{\$(\w*)$/);
+ if (!match) return null;
+
+ const wordMatch = match[1];
+ if (!wordMatch) return null;
+
+ const suggestions = MOCK_FUNCTION_SUGGESTIONS.filter(name => name.startsWith(`$${wordMatch}`));
+ if (!suggestions.length) return null;
+
+ const startPos = { line: cursor.line, ch: currentString.lastIndexOf('{{$') + 2 }; // +2 accounts for `{{`
+
+ return {
+ list: suggestions,
+ from: startPos,
+ to: cm.getCursor(),
+ };
+};
\ No newline at end of file
diff --git a/packages/bruno-app/src/utils/collections/export.js b/packages/bruno-app/src/utils/collections/export.js
index 5ef7b1b49..185c31acc 100644
--- a/packages/bruno-app/src/utils/collections/export.js
+++ b/packages/bruno-app/src/utils/collections/export.js
@@ -6,7 +6,7 @@ export const deleteUidsInItems = (items) => {
each(items, (item) => {
delete item.uid;
- if (['http-request', 'graphql-request'].includes(item.type)) {
+ if (['http-request', 'graphql-request', 'grpc-request'].includes(item.type)) {
each(get(item, 'request.headers'), (header) => delete header.uid);
each(get(item, 'request.params'), (param) => delete param.uid);
each(get(item, 'request.vars.req'), (v) => delete v.uid);
@@ -14,6 +14,7 @@ export const deleteUidsInItems = (items) => {
each(get(item, 'request.vars.assertions'), (a) => delete a.uid);
each(get(item, 'request.body.multipartForm'), (param) => delete param.uid);
each(get(item, 'request.body.formUrlEncoded'), (param) => delete param.uid);
+ each(get(item, 'request.body.file'), (param) => delete param.uid);
}
if (item.items && item.items.length) {
@@ -28,7 +29,7 @@ export const deleteUidsInItems = (items) => {
*/
export const transformItem = (items = []) => {
each(items, (item) => {
- if (['http-request', 'graphql-request'].includes(item.type)) {
+ if (['http-request', 'graphql-request', 'grpc-request'].includes(item.type)) {
if (item.type === 'graphql-request') {
item.type = 'graphql';
}
@@ -36,6 +37,10 @@ export const transformItem = (items = []) => {
if (item.type === 'http-request') {
item.type = 'http';
}
+
+ if (item.type === 'grpc-request') {
+ item.type = 'grpc';
+ }
}
if (item.items && item.items.length) {
diff --git a/packages/bruno-app/src/utils/collections/index.js b/packages/bruno-app/src/utils/collections/index.js
index bc6c731f4..b8b4651a1 100644
--- a/packages/bruno-app/src/utils/collections/index.js
+++ b/packages/bruno-app/src/utils/collections/index.js
@@ -1,16 +1,9 @@
-import get from 'lodash/get';
-import each from 'lodash/each';
-import find from 'lodash/find';
-import findIndex from 'lodash/findIndex';
-import isString from 'lodash/isString';
-import map from 'lodash/map';
-import filter from 'lodash/filter';
-import sortBy from 'lodash/sortBy';
-import isEqual from 'lodash/isEqual';
-import cloneDeep from 'lodash/cloneDeep';
+import {cloneDeep, isEqual, sortBy, filter, map, isString, findIndex, find, each, get } from 'lodash';
import { uuid } from 'utils/common';
-import path from 'path';
-import slash from 'utils/common/slash';
+import { buildPersistedEnvVariables } from 'utils/environments';
+import { sortByNameThenSequence } from 'utils/common/index';
+import path from 'utils/common/path';
+import { isRequestTagsIncluded } from '@usebruno/common';
const replaceTabsWithSpaces = (str, numSpaces = 2) => {
if (!str || !str.length || !isString(str)) {
@@ -34,7 +27,7 @@ export const addDepth = (items = []) => {
depth(items, 1);
};
-export const collapseCollection = (collection) => {
+export const collapseAllItemsInCollection = (collection) => {
collection.collapsed = true;
const collapseItem = (items) => {
@@ -47,7 +40,7 @@ export const collapseCollection = (collection) => {
});
};
- collapseItem(collection.items, 1);
+ collapseItem(collection.items);
};
export const sortItems = (collection) => {
@@ -99,7 +92,7 @@ export const findCollectionByItemUid = (collections, itemUid) => {
};
export const findItemByPathname = (items = [], pathname) => {
- return find(items, (i) => slash(i.pathname) === slash(pathname));
+ return find(items, (i) => i.pathname === pathname);
};
export const findItemInCollectionByPathname = (collection, pathname) => {
@@ -108,6 +101,14 @@ export const findItemInCollectionByPathname = (collection, pathname) => {
return findItemByPathname(flattenedItems, pathname);
};
+export const findParentItemInCollectionByPathname = (collection, pathname) => {
+ let flattenedItems = flattenItems(collection.items);
+
+ return find(flattenedItems, (item) => {
+ return item.items && find(item.items, (i) => i.pathname === pathname);
+ });
+};
+
export const findItemInCollection = (collection, itemUid) => {
let flattenedItems = flattenItems(collection.items);
@@ -136,89 +137,33 @@ export const findEnvironmentInCollectionByName = (collection, name) => {
return find(collection.environments, (e) => e.name === name);
};
-export const moveCollectionItem = (collection, draggedItem, targetItem) => {
- let draggedItemParent = findParentItemInCollection(collection, draggedItem.uid);
-
- if (draggedItemParent) {
- draggedItemParent.items = sortBy(draggedItemParent.items, (item) => item.seq);
- draggedItemParent.items = filter(draggedItemParent.items, (i) => i.uid !== draggedItem.uid);
- draggedItem.pathname = path.join(draggedItemParent.pathname, draggedItem.filename);
- } else {
- collection.items = sortBy(collection.items, (item) => item.seq);
- collection.items = filter(collection.items, (i) => i.uid !== draggedItem.uid);
+export const areItemsLoading = (folder) => {
+ if (!folder || folder.isLoading) {
+ return true;
}
-
- if (targetItem.type === 'folder') {
- targetItem.items = sortBy(targetItem.items || [], (item) => item.seq);
- targetItem.items.push(draggedItem);
- draggedItem.pathname = path.join(targetItem.pathname, draggedItem.filename);
- } else {
- let targetItemParent = findParentItemInCollection(collection, targetItem.uid);
-
- if (targetItemParent) {
- targetItemParent.items = sortBy(targetItemParent.items, (item) => item.seq);
- let targetItemIndex = findIndex(targetItemParent.items, (i) => i.uid === targetItem.uid);
- targetItemParent.items.splice(targetItemIndex + 1, 0, draggedItem);
- draggedItem.pathname = path.join(targetItemParent.pathname, draggedItem.filename);
- } else {
- collection.items = sortBy(collection.items, (item) => item.seq);
- let targetItemIndex = findIndex(collection.items, (i) => i.uid === targetItem.uid);
- collection.items.splice(targetItemIndex + 1, 0, draggedItem);
- draggedItem.pathname = path.join(collection.pathname, draggedItem.filename);
+
+ let flattenedItems = flattenItems(folder.items);
+ return flattenedItems?.reduce((isLoading, i) => {
+ if (i?.loading) {
+ isLoading = true;
}
- }
-};
+ return isLoading;
+ }, false);
+}
-export const moveCollectionItemToRootOfCollection = (collection, draggedItem) => {
- let draggedItemParent = findParentItemInCollection(collection, draggedItem.uid);
-
- // If the dragged item is already at the root of the collection, do nothing
- if (!draggedItemParent) {
- return;
- }
-
- draggedItemParent.items = sortBy(draggedItemParent.items, (item) => item.seq);
- draggedItemParent.items = filter(draggedItemParent.items, (i) => i.uid !== draggedItem.uid);
- collection.items = sortBy(collection.items, (item) => item.seq);
- collection.items.push(draggedItem);
- if (draggedItem.type == 'folder') {
- draggedItem.pathname = path.join(collection.pathname, draggedItem.name);
- } else {
- draggedItem.pathname = path.join(collection.pathname, draggedItem.filename);
- }
-};
-
-export const getItemsToResequence = (parent, collection) => {
- let itemsToResequence = [];
-
- if (!parent) {
- let index = 1;
- each(collection.items, (item) => {
- if (isItemARequest(item)) {
- itemsToResequence.push({
- pathname: item.pathname,
- seq: index++
- });
- }
- });
- return itemsToResequence;
- }
-
- if (parent.items && parent.items.length) {
- let index = 1;
- each(parent.items, (item) => {
- if (isItemARequest(item)) {
- itemsToResequence.push({
- pathname: item.pathname,
- seq: index++
- });
- }
- });
- return itemsToResequence;
- }
-
- return itemsToResequence;
-};
+export const getItemsLoadStats = (folder) => {
+ let loadingCount = 0;
+ let flattenedItems = flattenItems(folder.items);
+ flattenedItems?.forEach(i => {
+ if(i?.loading) {
+ loadingCount += 1;
+ }
+ });
+ return {
+ loading: loadingCount,
+ total: flattenedItems?.length
+ };
+}
export const transformCollectionToSaveToExportAsFile = (collection, options = {}) => {
const copyHeaders = (headers) => {
@@ -271,17 +216,33 @@ export const transformCollectionToSaveToExportAsFile = (collection, options = {}
});
};
+ const copyFileParams = (params = []) => {
+ return map(params, (param) => {
+ return {
+ uid: param.uid,
+ filePath: param.filePath,
+ contentType: param.contentType,
+ selected: param.selected
+ }
+ });
+ }
+
const copyItems = (sourceItems, destItems) => {
each(sourceItems, (si) => {
if (!isItemAFolder(si) && !isItemARequest(si) && si.type !== 'js') {
return;
}
+ const isGrpcRequest = si.type === 'grpc-request'
+
const di = {
uid: si.uid,
type: si.type,
name: si.name,
- seq: si.seq
+ filename: si.filename,
+ seq: si.seq,
+ settings: si.settings,
+ tags: si.tags
};
if (si.request) {
@@ -298,7 +259,9 @@ export const transformCollectionToSaveToExportAsFile = (collection, options = {}
graphql: si.request.body.graphql,
sparql: si.request.body.sparql,
formUrlEncoded: copyFormUrlEncodedParams(si.request.body.formUrlEncoded),
- multipartForm: copyMultipartFormParams(si.request.body.multipartForm)
+ multipartForm: copyMultipartFormParams(si.request.body.multipartForm),
+ file: copyFileParams(si.request.body.file),
+ grpc: si.request.body.grpc
},
script: si.request.script,
vars: si.request.vars,
@@ -307,6 +270,13 @@ export const transformCollectionToSaveToExportAsFile = (collection, options = {}
docs: si.request.docs
};
+ if (isGrpcRequest) {
+ di.request.methodType = si.request.methodType;
+ di.request.protoPath = si.request.protoPath;
+ delete di.request.params;
+ }
+
+
// Handle auth object dynamically
di.request.auth = {
mode: get(si.request, 'auth.mode', 'none')
@@ -354,11 +324,20 @@ export const transformCollectionToSaveToExportAsFile = (collection, options = {}
di.request.auth.oauth2 = {
grantType: grantType,
accessTokenUrl: get(si.request, 'auth.oauth2.accessTokenUrl', ''),
+ refreshTokenUrl: get(si.request, 'auth.oauth2.refreshTokenUrl', ''),
username: get(si.request, 'auth.oauth2.username', ''),
password: get(si.request, 'auth.oauth2.password', ''),
clientId: get(si.request, 'auth.oauth2.clientId', ''),
clientSecret: get(si.request, 'auth.oauth2.clientSecret', ''),
- scope: get(si.request, 'auth.oauth2.scope', '')
+ scope: get(si.request, 'auth.oauth2.scope', ''),
+ credentialsPlacement: get(si.request, 'auth.oauth2.credentialsPlacement', 'body'),
+ credentialsId: get(si.request, 'auth.oauth2.credentialsId', 'credentials'),
+ tokenPlacement: get(si.request, 'auth.oauth2.tokenPlacement', 'header'),
+ tokenHeaderPrefix: get(si.request, 'auth.oauth2.tokenHeaderPrefix', ''),
+ tokenQueryKey: get(si.request, 'auth.oauth2.tokenQueryKey', ''),
+ autoFetchToken: get(si.request, 'auth.oauth2.autoFetchToken', true),
+ autoRefreshToken: get(si.request, 'auth.oauth2.autoRefreshToken', true),
+ additionalParameters: get(si.request, 'auth.oauth2.additionalParameters', {}),
};
break;
case 'authorization_code':
@@ -367,19 +346,53 @@ export const transformCollectionToSaveToExportAsFile = (collection, options = {}
callbackUrl: get(si.request, 'auth.oauth2.callbackUrl', ''),
authorizationUrl: get(si.request, 'auth.oauth2.authorizationUrl', ''),
accessTokenUrl: get(si.request, 'auth.oauth2.accessTokenUrl', ''),
+ refreshTokenUrl: get(si.request, 'auth.oauth2.refreshTokenUrl', ''),
clientId: get(si.request, 'auth.oauth2.clientId', ''),
clientSecret: get(si.request, 'auth.oauth2.clientSecret', ''),
scope: get(si.request, 'auth.oauth2.scope', ''),
- pkce: get(si.request, 'auth.oauth2.pkce', false)
+ credentialsPlacement: get(si.request, 'auth.oauth2.credentialsPlacement', 'body'),
+ pkce: get(si.request, 'auth.oauth2.pkce', false),
+ credentialsId: get(si.request, 'auth.oauth2.credentialsId', 'credentials'),
+ tokenPlacement: get(si.request, 'auth.oauth2.tokenPlacement', 'header'),
+ tokenHeaderPrefix: get(si.request, 'auth.oauth2.tokenHeaderPrefix', ''),
+ tokenQueryKey: get(si.request, 'auth.oauth2.tokenQueryKey', ''),
+ autoFetchToken: get(si.request, 'auth.oauth2.autoFetchToken', true),
+ autoRefreshToken: get(si.request, 'auth.oauth2.autoRefreshToken', true),
+ additionalParameters: get(si.request, 'auth.oauth2.additionalParameters', {}),
+ };
+ break;
+ case 'implicit':
+ di.request.auth.oauth2 = {
+ grantType: grantType,
+ callbackUrl: get(si.request, 'auth.oauth2.callbackUrl', ''),
+ authorizationUrl: get(si.request, 'auth.oauth2.authorizationUrl', ''),
+ clientId: get(si.request, 'auth.oauth2.clientId', ''),
+ scope: get(si.request, 'auth.oauth2.scope', ''),
+ state: get(si.request, 'auth.oauth2.state', ''),
+ credentialsId: get(si.request, 'auth.oauth2.credentialsId', 'credentials'),
+ tokenPlacement: get(si.request, 'auth.oauth2.tokenPlacement', 'header'),
+ tokenHeaderPrefix: get(si.request, 'auth.oauth2.tokenHeaderPrefix', 'Bearer'),
+ tokenQueryKey: get(si.request, 'auth.oauth2.tokenQueryKey', ''),
+ autoFetchToken: get(si.request, 'auth.oauth2.autoFetchToken', true),
+ additionalParameters: get(si.request, 'auth.oauth2.additionalParameters', {}),
};
break;
case 'client_credentials':
di.request.auth.oauth2 = {
grantType: grantType,
accessTokenUrl: get(si.request, 'auth.oauth2.accessTokenUrl', ''),
+ refreshTokenUrl: get(si.request, 'auth.oauth2.refreshTokenUrl', ''),
clientId: get(si.request, 'auth.oauth2.clientId', ''),
clientSecret: get(si.request, 'auth.oauth2.clientSecret', ''),
- scope: get(si.request, 'auth.oauth2.scope', '')
+ scope: get(si.request, 'auth.oauth2.scope', ''),
+ credentialsPlacement: get(si.request, 'auth.oauth2.credentialsPlacement', 'body'),
+ credentialsId: get(si.request, 'auth.oauth2.credentialsId', 'credentials'),
+ tokenPlacement: get(si.request, 'auth.oauth2.tokenPlacement', 'header'),
+ tokenHeaderPrefix: get(si.request, 'auth.oauth2.tokenHeaderPrefix', ''),
+ tokenQueryKey: get(si.request, 'auth.oauth2.tokenQueryKey', ''),
+ autoFetchToken: get(si.request, 'auth.oauth2.autoFetchToken', true),
+ autoRefreshToken: get(si.request, 'auth.oauth2.autoRefreshToken', true),
+ additionalParameters: get(si.request, 'auth.oauth2.additionalParameters', {}),
};
break;
}
@@ -404,6 +417,13 @@ export const transformCollectionToSaveToExportAsFile = (collection, options = {}
if (di.request.body.mode === 'json') {
di.request.body.json = replaceTabsWithSpaces(di.request.body.json);
}
+
+ if (di.request.body.mode === 'grpc') {
+ di.request.body.grpc = di.request.body.grpc.map(({name, content}, index) => ({
+ name: name ? name : `message ${index + 1}`,
+ content: replaceTabsWithSpaces(content)
+ }))
+ }
}
if (si.type == 'folder' && si?.root) {
@@ -412,7 +432,12 @@ export const transformCollectionToSaveToExportAsFile = (collection, options = {}
};
let { request, meta, docs } = si?.root || {};
- let { headers, script = {}, vars = {}, tests } = request || {};
+ let { auth, headers, script = {}, vars = {}, tests } = request || {};
+
+ // folder level auth
+ if (auth?.mode) {
+ di.root.request.auth = auth;
+ }
// folder level headers
if (headers?.length) {
@@ -451,6 +476,7 @@ export const transformCollectionToSaveToExportAsFile = (collection, options = {}
if (meta?.name) {
di.root.meta = {};
di.root.meta.name = meta?.name;
+ di.root.meta.seq = meta?.seq;
}
if (!Object.keys(di.root.request)?.length) {
delete di.root.request;
@@ -481,7 +507,11 @@ export const transformCollectionToSaveToExportAsFile = (collection, options = {}
collectionToSave.version = '1';
collectionToSave.items = [];
collectionToSave.activeEnvironmentUid = collection.activeEnvironmentUid;
- collectionToSave.environments = collection.environments || [];
+ // Save environments without runtime metadata (ephemeral/persistedValue)
+ collectionToSave.environments = (collection.environments || []).map((env) => ({
+ ...env,
+ variables: buildPersistedEnvVariables(env?.variables, { mode: 'save' })
+ }));
collectionToSave.root = {
request: {}
@@ -550,11 +580,14 @@ export const transformCollectionToSaveToExportAsFile = (collection, options = {}
export const transformRequestToSaveToFilesystem = (item) => {
const _item = item.draft ? item.draft : item;
+
const itemToSave = {
uid: _item.uid,
type: _item.type,
name: _item.name,
seq: _item.seq,
+ settings: _item.settings,
+ tags: _item.tags,
request: {
method: _item.request.method,
url: _item.request.url,
@@ -570,16 +603,25 @@ export const transformRequestToSaveToFilesystem = (item) => {
}
};
- each(_item.request.params, (param) => {
- itemToSave.request.params.push({
- uid: param.uid,
- name: param.name,
- value: param.value,
- description: param.description,
- type: param.type,
- enabled: param.enabled
+ if (_item.type === 'grpc-request') {
+ itemToSave.request.methodType = _item.request.methodType;
+ itemToSave.request.protoPath = _item.request.protoPath;
+ delete itemToSave.request.params
+ }
+
+ // Only process params for non-gRPC requests
+ if (_item.type !== 'grpc-request') {
+ each(_item.request.params, (param) => {
+ itemToSave.request.params.push({
+ uid: param.uid,
+ name: param.name,
+ value: param.value,
+ description: param.description,
+ type: param.type,
+ enabled: param.enabled
+ });
});
- });
+ }
each(_item.request.headers, (header) => {
itemToSave.request.headers.push({
@@ -598,6 +640,16 @@ export const transformRequestToSaveToFilesystem = (item) => {
};
}
+ if (itemToSave.request.body.mode === 'grpc') {
+ itemToSave.request.body = {
+ ...itemToSave.request.body,
+ grpc: itemToSave.request.body.grpc.map(({name, content}, index) => ({
+ name: name ? name : `message ${index + 1}`,
+ content: replaceTabsWithSpaces(content)
+ }))
+ };
+ }
+
return itemToSave;
};
@@ -625,7 +677,7 @@ export const deleteItemInCollectionByPathname = (pathname, collection) => {
};
export const isItemARequest = (item) => {
- return item.hasOwnProperty('request') && ['http-request', 'graphql-request'].includes(item.type) && !item.items;
+ return item.hasOwnProperty('request') && ['http-request', 'graphql-request', 'grpc-request'].includes(item.type) && !item.items;
};
export const isItemAFolder = (item) => {
@@ -651,6 +703,10 @@ export const humanizeRequestBodyMode = (mode) => {
label = 'SPARQL';
break;
}
+ case 'file': {
+ label = 'File / Binary';
+ break;
+ }
case 'formUrlEncoded': {
label = 'Form URL Encoded';
break;
@@ -725,23 +781,22 @@ export const humanizeRequestAPIKeyPlacement = (placement) => {
};
export const humanizeGrantType = (mode) => {
- let label = 'No Auth';
- switch (mode) {
- case 'password': {
- label = 'Password Credentials';
- break;
- }
- case 'authorization_code': {
- label = 'Authorization Code';
- break;
- }
- case 'client_credentials': {
- label = 'Client Credentials';
- break;
- }
+ if (!mode || typeof mode !== 'string') {
+ return '';
}
- return label;
+ switch (mode) {
+ case 'password':
+ return 'Password Credentials';
+ case 'authorization_code':
+ return 'Authorization Code';
+ case 'client_credentials':
+ return 'Client Credentials';
+ case 'implicit':
+ return 'Implicit';
+ default:
+ return mode;
+ }
};
export const refreshUidsInItem = (item) => {
@@ -751,6 +806,7 @@ export const refreshUidsInItem = (item) => {
each(get(item, 'request.params'), (param) => (param.uid = uuid()));
each(get(item, 'request.body.multipartForm'), (param) => (param.uid = uuid()));
each(get(item, 'request.body.formUrlEncoded'), (param) => (param.uid = uuid()));
+ each(get(item, 'request.body.file'), (param) => (param.uid = uuid()));
return item;
};
@@ -761,11 +817,13 @@ export const deleteUidsInItem = (item) => {
const headers = get(item, 'request.headers', []);
const bodyFormUrlEncoded = get(item, 'request.body.formUrlEncoded', []);
const bodyMultipartForm = get(item, 'request.body.multipartForm', []);
+ const file = get(item, 'request.body.file', []);
params.forEach((param) => delete param.uid);
headers.forEach((header) => delete header.uid);
bodyFormUrlEncoded.forEach((param) => delete param.uid);
bodyMultipartForm.forEach((param) => delete param.uid);
+ file.forEach((param) => delete param.uid);
return item;
};
@@ -801,6 +859,10 @@ export const getDefaultRequestPaneTab = (item) => {
if (item.type === 'graphql-request') {
return 'query';
}
+
+ if (item.type === 'grpc-request') {
+ return 'body';
+ }
};
export const getGlobalEnvironmentVariables = ({ globalEnvironments, activeGlobalEnvironmentUid }) => {
@@ -919,12 +981,15 @@ export const getAllVariables = (collection, item) => {
const uniqueMaskedVariables = [...new Set([...filteredMaskedEnvVariables, ...filteredMaskedGlobalEnvVariables])];
+ const oauth2CredentialVariables = getFormattedCollectionOauth2Credentials({ oauth2Credentials: collection?.oauth2Credentials })
+
return {
...globalEnvironmentVariables,
...collectionVariables,
...envVariables,
...folderVariables,
...requestVariables,
+ ...oauth2CredentialVariables,
...runtimeVariables,
pathParams: {
...pathParams
@@ -949,7 +1014,7 @@ export const maskInputValue = (value) => {
.join('');
};
-const getTreePathFromCollectionToItem = (collection, _item) => {
+export const getTreePathFromCollectionToItem = (collection, _item) => {
let path = [];
let item = findItemInCollection(collection, _item?.uid);
while (item) {
@@ -992,3 +1057,159 @@ const mergeVars = (collection, requestTreePath = []) => {
requestVariables
};
};
+
+export const getEnvVars = (environment = {}) => {
+ const variables = environment.variables;
+ if (!variables || !variables.length) {
+ return {
+ __name__: environment.name
+ };
+ }
+
+ const envVars = {};
+ each(variables, (variable) => {
+ if (variable.enabled) {
+ envVars[variable.name] = variable.value;
+ }
+ });
+
+ return {
+ ...envVars,
+ __name__: environment.name
+ };
+};
+
+export const getFormattedCollectionOauth2Credentials = ({ oauth2Credentials = [] }) => {
+ let credentialsVariables = {};
+ oauth2Credentials.forEach(({ credentialsId, credentials }) => {
+ if (credentials) {
+ Object.entries(credentials).forEach(([key, value]) => {
+ credentialsVariables[`$oauth2.${credentialsId}.${key}`] = value;
+ });
+ }
+ });
+ return credentialsVariables;
+};
+
+
+// item sequence utils - START
+
+export const resetSequencesInFolder = (folderItems) => {
+ const items = folderItems;
+ const sortedItems = sortByNameThenSequence(items);
+ return sortedItems.map((item, index) => {
+ item.seq = index + 1;
+ return item;
+ });
+};
+
+export const isItemBetweenSequences = (itemSequence, sourceItemSequence, targetItemSequence) => {
+ if (targetItemSequence > sourceItemSequence) {
+ return itemSequence > sourceItemSequence && itemSequence < targetItemSequence;
+ }
+ return itemSequence < sourceItemSequence && itemSequence >= targetItemSequence;
+};
+
+export const calculateNewSequence = (isDraggedItem, targetSequence, draggedSequence) => {
+ if (!isDraggedItem) {
+ return null;
+ }
+ return targetSequence > draggedSequence ? targetSequence - 1 : targetSequence;
+};
+
+export const getReorderedItemsInTargetDirectory = ({ items, targetItemUid, draggedItemUid }) => {
+ const itemsWithFixedSequences = resetSequencesInFolder(cloneDeep(items));
+ const targetItem = findItem(itemsWithFixedSequences, targetItemUid);
+ const draggedItem = findItem(itemsWithFixedSequences, draggedItemUid);
+ const targetSequence = targetItem?.seq;
+ const draggedSequence = draggedItem?.seq;
+ itemsWithFixedSequences?.forEach(item => {
+ const isDraggedItem = item?.uid === draggedItemUid;
+ const isBetween = isItemBetweenSequences(item?.seq, draggedSequence, targetSequence);
+ if (isBetween) {
+ item.seq += targetSequence > draggedSequence ? -1 : 1;
+ }
+ const newSequence = calculateNewSequence(isDraggedItem, targetSequence, draggedSequence);
+ if (newSequence !== null) {
+ item.seq = newSequence;
+ }
+ });
+ // only return items that have been reordered
+ return itemsWithFixedSequences.filter(item =>
+ items?.find(originalItem => originalItem?.uid === item?.uid)?.seq !== item?.seq
+ );
+};
+
+export const getReorderedItemsInSourceDirectory = ({ items }) => {
+ const itemsWithFixedSequences = resetSequencesInFolder(cloneDeep(items));
+ return itemsWithFixedSequences.filter(item =>
+ items?.find(originalItem => originalItem?.uid === item?.uid)?.seq !== item?.seq
+ );
+};
+
+export const calculateDraggedItemNewPathname = ({ draggedItem, targetItem, dropType, collectionPathname }) => {
+ const { pathname: targetItemPathname } = targetItem;
+ const { filename: draggedItemFilename } = draggedItem;
+ const targetItemDirname = path.dirname(targetItemPathname);
+ const isTargetTheCollection = targetItemPathname === collectionPathname;
+ const isTargetItemAFolder = isItemAFolder(targetItem);
+
+ if (dropType === 'inside' && (isTargetItemAFolder || isTargetTheCollection)) {
+ return path.join(targetItemPathname, draggedItemFilename)
+ } else if (dropType === 'adjacent') {
+ return path.join(targetItemDirname, draggedItemFilename)
+ }
+ return null;
+};
+
+// item sequence utils - END
+
+export const getUniqueTagsFromItems = (items = []) => {
+ const allTags = new Set();
+ const getTags = (items) => {
+ items.forEach(item => {
+ if (isItemARequest(item)) {
+ const tags = item.draft ? get(item, 'draft.tags', []) : get(item, 'tags', []);
+ tags.forEach(tag => allTags.add(tag));
+ }
+ if (item.items) {
+ getTags(item.items);
+ }
+ });
+ };
+ getTags(items);
+ return Array.from(allTags).sort();
+};
+
+
+export const getRequestItemsForCollectionRun = ({ recursive, items = [], tags }) => {
+ let requestItems = [];
+
+ if (recursive) {
+ requestItems = flattenItems(items);
+ } else {
+ each(items, (item) => {
+ if (item.request) {
+ requestItems.push(item);
+ }
+ });
+ }
+
+ const requestTypes = ['http-request', 'graphql-request'];
+ requestItems = requestItems.filter(request => requestTypes.includes(request.type));
+
+ if (tags && tags.include && tags.exclude) {
+ const includeTags = tags.include ? tags.include : [];
+ const excludeTags = tags.exclude ? tags.exclude : [];
+ requestItems = requestItems.filter(({ tags: requestTags = [], draft }) => {
+ requestTags = draft?.tags || requestTags || [];
+ return isRequestTagsIncluded(requestTags, includeTags, excludeTags);
+ });
+ }
+
+ return requestItems;
+};
+
+export const getPropertyFromDraftOrRequest = (item, propertyKey, defaultValue = null) => {
+ return item.draft ? get(item, `draft.${propertyKey}`, defaultValue) : get(item, propertyKey, defaultValue);
+};
\ No newline at end of file
diff --git a/packages/bruno-app/src/utils/common/bulkKeyValueUtils.js b/packages/bruno-app/src/utils/common/bulkKeyValueUtils.js
new file mode 100644
index 000000000..b165c2f3f
--- /dev/null
+++ b/packages/bruno-app/src/utils/common/bulkKeyValueUtils.js
@@ -0,0 +1,20 @@
+export function parseBulkKeyValue(value) {
+ return value
+ .split(/\r?\n/)
+ .map((pair) => {
+ const isEnabled = !pair.trim().startsWith('//');
+ const cleanPair = pair.replace(/^\/\/\s*/, '');
+ const sep = cleanPair.indexOf(':');
+ if (sep < 0) return null;
+ return {
+ name: cleanPair.slice(0, sep).trim(),
+ value: cleanPair.slice(sep + 1).trim(),
+ enabled: isEnabled
+ };
+ })
+ .filter(Boolean);
+}
+
+export function serializeBulkKeyValue(items) {
+ return items.map((item) => `${item.enabled ? '' : '//'}${item.name}:${item.value}`).join('\n');
+}
diff --git a/packages/bruno-app/src/utils/common/cache.js b/packages/bruno-app/src/utils/common/cache.js
deleted file mode 100644
index d8cee9e50..000000000
--- a/packages/bruno-app/src/utils/common/cache.js
+++ /dev/null
@@ -1,10 +0,0 @@
-class Cache {
- get(key) {
- return window.localStorage.getItem(key);
- }
- set(key, val) {
- window.localStorage.setItem(key, val);
- }
-}
-
-module.exports = new Cache();
diff --git a/packages/bruno-app/src/utils/common/codemirror.js b/packages/bruno-app/src/utils/common/codemirror.js
index 82b98a325..7306c63fb 100644
--- a/packages/bruno-app/src/utils/common/codemirror.js
+++ b/packages/bruno-app/src/utils/common/codemirror.js
@@ -1,11 +1,7 @@
import get from 'lodash/get';
+import { mockDataFunctions } from '@usebruno/common';
-let CodeMirror;
-const SERVER_RENDERED = typeof window === 'undefined' || global['PREVENT_CODEMIRROR_RENDER'] === true;
-
-if (!SERVER_RENDERED) {
- CodeMirror = require('codemirror');
-}
+const CodeMirror = require('codemirror');
const pathFoundInVariables = (path, obj) => {
const value = get(obj, path);
@@ -74,11 +70,11 @@ export class MaskedEditor {
} else {
for (let line = 0; line < lineCount; line++) {
const lineLength = this.editor.getLine(line).length;
- const maskedNode = document.createTextNode('*'.repeat(lineLength));
+ const maskedNode = document.createTextNode('*'.repeat(lineLength));
this.editor.markText(
{ line, ch: 0 },
{ line, ch: lineLength },
- { replacedWith: maskedNode, handleMouseEvents: false }
+ { replacedWith: maskedNode, handleMouseEvents: false }
);
}
}
@@ -86,7 +82,18 @@ export class MaskedEditor {
};
}
-export const defineCodeMirrorBrunoVariablesMode = (_variables, mode, highlightPathParams) => {
+/**
+ * Defines a custom CodeMirror mode for Bruno variables highlighting.
+ * This function creates a specialized mode that can highlight both Bruno template
+ * variables (in the format {{variable}}) and URL path parameters (in the format /:param).
+ *
+ * @param {Object} _variables - The variables object containing data to validate against
+ * @param {string} mode - The base CodeMirror mode to extend (e.g., 'javascript', 'application/json')
+ * @param {boolean} highlightPathParams - Whether to highlight URL path parameters
+ * @param {boolean} highlightVariables - Whether to highlight template variables
+ * @returns {void} - Registers the mode with CodeMirror for later use
+ */
+export const defineCodeMirrorBrunoVariablesMode = (_variables, mode, highlightPathParams, highlightVariables) => {
CodeMirror.defineMode('brunovariables', function (config, parserConfig) {
const { pathParams = {}, ...variables } = _variables || {};
const variablesOverlay = {
@@ -97,7 +104,9 @@ export const defineCodeMirrorBrunoVariablesMode = (_variables, mode, highlightPa
while ((ch = stream.next()) != null) {
if (ch === '}' && stream.peek() === '}') {
stream.eat('}');
- const found = pathFoundInVariables(word, variables);
+ // Check if it's a mock variable (starts with $) and exists in mockDataFunctions
+ const isMockVariable = word.startsWith('$') && mockDataFunctions.hasOwnProperty(word.substring(1));
+ const found = isMockVariable || pathFoundInVariables(word, variables);
const status = found ? 'valid' : 'invalid';
const randomClass = `random-${(Math.random() + 1).toString(36).substring(9)}`;
return `variable-${status} ${randomClass}`;
@@ -139,13 +148,15 @@ export const defineCodeMirrorBrunoVariablesMode = (_variables, mode, highlightPa
}
};
- let baseMode = CodeMirror.overlayMode(CodeMirror.getMode(config, parserConfig.backdrop || mode), variablesOverlay);
+ let baseMode = CodeMirror.getMode(config, parserConfig.backdrop || mode);
- if (highlightPathParams) {
- return CodeMirror.overlayMode(baseMode, urlPathParamsOverlay);
- } else {
- return baseMode;
+ if (highlightVariables) {
+ baseMode = CodeMirror.overlayMode(baseMode, variablesOverlay);
}
+ if (highlightPathParams) {
+ baseMode = CodeMirror.overlayMode(baseMode, urlPathParamsOverlay);
+ }
+ return baseMode;
});
};
@@ -159,6 +170,8 @@ export const getCodeMirrorModeBasedOnContentType = (contentType, body) => {
if (contentType.includes('json')) {
return 'application/ld+json';
+ } else if (contentType.includes('image')) {
+ return 'application/image';
} else if (contentType.includes('xml')) {
return 'application/xml';
} else if (contentType.includes('html')) {
@@ -169,8 +182,6 @@ export const getCodeMirrorModeBasedOnContentType = (contentType, body) => {
return 'application/xml';
} else if (contentType.includes('yaml')) {
return 'application/yaml';
- } else if (contentType.includes('image')) {
- return 'application/image';
} else {
return 'application/text';
}
diff --git a/packages/bruno-app/src/utils/common/error.js b/packages/bruno-app/src/utils/common/error.js
index e81e3fadc..c1ae6058c 100644
--- a/packages/bruno-app/src/utils/common/error.js
+++ b/packages/bruno-app/src/utils/common/error.js
@@ -34,3 +34,11 @@ export const toastError = (error, defaultErrorMsg = 'An error occurred') => {
return toast.error(errorMsg);
};
+
+export function formatIpcError(error) {
+ if (!(error instanceof Error)) return error;
+ if (!error?.message) return ''; // Avoid returning `null` or `undefined`
+ // https://github.com/electron/electron/blob/659e79fc08c6ffc2f7506dd1358918d97d240147/lib/renderer/api/ipc-renderer.ts#L24-L30
+ // There is no other way to get rid of this error prefix as of now.
+ return error.message.replace(/^Error invoking remote method '.+?': (Error: )?/, '');
+}
diff --git a/packages/bruno-app/src/utils/common/folders-requests-sorting.spec.js b/packages/bruno-app/src/utils/common/folders-requests-sorting.spec.js
new file mode 100644
index 000000000..fbcf71379
--- /dev/null
+++ b/packages/bruno-app/src/utils/common/folders-requests-sorting.spec.js
@@ -0,0 +1,374 @@
+const { describe, it, expect } = require('@jest/globals');
+const { sortByNameThenSequence } = require('./index');
+
+describe('sortByNameThenSequence', () => {
+ describe('Basic functionality', () => {
+ it('should return an empty array when given an empty array', () => {
+ const items = [];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([]);
+ });
+
+ it('should not mutate the original array', () => {
+ const items = [
+ { name: 'folder_2', seq: 2 },
+ { name: 'folder_1', seq: 1 }
+ ];
+ const originalItems = JSON.parse(JSON.stringify(items));
+ sortByNameThenSequence(items);
+ expect(items).toEqual(originalItems);
+ });
+
+ it('should return a new array instance', () => {
+ const items = [{ name: 'folder_1' }];
+ const result = sortByNameThenSequence(items);
+ expect(result).not.toBe(items);
+ });
+ });
+
+ describe('Alphabetical sorting (no sequence numbers)', () => {
+ it('should sort items alphabetically by name when no sequence numbers are present', () => {
+ const items = [
+ { name: 'folder_3' },
+ { name: 'folder_1' },
+ { name: 'folder_2' }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_1' },
+ { name: 'folder_2' },
+ { name: 'folder_3' }
+ ]);
+ });
+
+ it('should handle case-sensitive sorting correctly', () => {
+ const items = [
+ { name: 'Folder_2' },
+ { name: 'folder_1' },
+ { name: 'FOLDER_3' }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_1' },
+ { name: 'Folder_2' },
+ { name: 'FOLDER_3' }
+ ]);
+ });
+
+ it('should handle special characters in names', () => {
+ const items = [
+ { name: 'folder-2' },
+ { name: 'folder_1' },
+ { name: 'folder 3' }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder 3' },
+ { name: 'folder_1' },
+ { name: 'folder-2' }
+ ]);
+ });
+ });
+
+ describe('Sequence-based sorting (valid sequence numbers)', () => {
+ it('should sort items by sequence when all items have valid sequence numbers', () => {
+ const items = [
+ { name: 'folder_3', seq: 3 },
+ { name: 'folder_1', seq: 1 },
+ { name: 'folder_2', seq: 2 }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_1', seq: 1 },
+ { name: 'folder_2', seq: 2 },
+ { name: 'folder_3', seq: 3 }
+ ]);
+ });
+
+ it('should handle duplicate sequence numbers by inserting them in alphabetical order', () => {
+ const items = [
+ { name: 'folder_3', seq: 1 },
+ { name: 'folder_1', seq: 1 },
+ { name: 'folder_2', seq: 2 }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_1', seq: 1 },
+ { name: 'folder_3', seq: 1 },
+ { name: 'folder_2', seq: 2 },
+ ]);
+ });
+
+ it('should handle large sequence numbers correctly', () => {
+ const items = [
+ { name: 'folder_1', seq: 100 },
+ { name: 'folder_2', seq: 1 },
+ { name: 'folder_3', seq: 50 }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_2', seq: 1 },
+ { name: 'folder_3', seq: 50 },
+ { name: 'folder_1', seq: 100 }
+ ]);
+ });
+ });
+
+ describe('Invalid sequence numbers', () => {
+ it('should treat undefined sequence as invalid and sort alphabetically', () => {
+ const items = [
+ { name: 'folder_3', seq: undefined },
+ { name: 'folder_1', seq: undefined },
+ { name: 'folder_2', seq: undefined }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_1', seq: undefined },
+ { name: 'folder_2', seq: undefined },
+ { name: 'folder_3', seq: undefined }
+ ]);
+ });
+
+ it('should treat null sequence as invalid and sort alphabetically', () => {
+ const items = [
+ { name: 'folder_3', seq: null },
+ { name: 'folder_1', seq: null },
+ { name: 'folder_2', seq: null }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_1', seq: null },
+ { name: 'folder_2', seq: null },
+ { name: 'folder_3', seq: null }
+ ]);
+ });
+
+ it('should treat boolean values as invalid sequence numbers', () => {
+ const items = [
+ { name: 'folder_3', seq: true },
+ { name: 'folder_1', seq: false },
+ { name: 'folder_2', seq: true }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_1', seq: false },
+ { name: 'folder_2', seq: true },
+ { name: 'folder_3', seq: true }
+ ]);
+ });
+
+ it('should treat string values as invalid sequence numbers', () => {
+ const items = [
+ { name: 'folder_3', seq: '3' },
+ { name: 'folder_1', seq: '1' },
+ { name: 'folder_2', seq: 'invalid' }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_1', seq: '1' },
+ { name: 'folder_2', seq: 'invalid' },
+ { name: 'folder_3', seq: '3' }
+ ]);
+ });
+
+ it('should treat non-integer numbers as invalid sequence numbers', () => {
+ const items = [
+ { name: 'folder_3', seq: 3.5 },
+ { name: 'folder_1', seq: 1.2 },
+ { name: 'folder_2', seq: 2.0 }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_1', seq: 1.2 },
+ { name: 'folder_2', seq: 2.0 },
+ { name: 'folder_3', seq: 3.5 }
+ ]);
+ });
+
+ it('should treat zero and negative numbers as invalid sequence numbers', () => {
+ const items = [
+ { name: 'folder_3', seq: 0 },
+ { name: 'folder_1', seq: -1 },
+ { name: 'folder_2', seq: -5 }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_1', seq: -1 },
+ { name: 'folder_2', seq: -5 },
+ { name: 'folder_3', seq: 0 }
+ ]);
+ });
+
+ it('should treat NaN and Infinity as invalid sequence numbers', () => {
+ const items = [
+ { name: 'folder_3', seq: NaN },
+ { name: 'folder_1', seq: Infinity },
+ { name: 'folder_2', seq: -Infinity }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_1', seq: Infinity },
+ { name: 'folder_2', seq: -Infinity },
+ { name: 'folder_3', seq: NaN }
+ ]);
+ });
+
+ it('should handle invalid sequence numbers correctly', () => {
+ const items = [
+ { name: 'folder_4', seq: undefined },
+ { name: 'folder_1', seq: false },
+ { name: 'folder_5', seq: 'invalid' },
+ { name: 'folder_2', seq: true },
+ { name: 'folder_3', seq: null }
+ ];
+ const sorted = sortByNameThenSequence(items);
+ expect(sorted).toEqual([
+ { name: 'folder_1', seq: false },
+ { name: 'folder_2', seq: true },
+ { name: 'folder_3', seq: null },
+ { name: 'folder_4', seq: undefined },
+ { name: 'folder_5', seq: 'invalid' }
+ ]);
+ });
+ });
+
+ describe('Mixed valid and invalid sequence numbers', () => {
+ it('should handle mixed valid and invalid sequence numbers correctly', () => {
+ const items = [
+ { name: 'folder_4', seq: undefined },
+ { name: 'folder_1', seq: false },
+ { name: 'folder_5', seq: 3 },
+ { name: 'folder_2', seq: 2 },
+ { name: 'folder_3', seq: null },
+ { name: 'folder_6', seq: 9 },
+ { name: 'folder_8', seq: 'invalid' },
+ { name: 'folder_7', seq: 4 }
+ ];
+ const sorted = sortByNameThenSequence(items);
+ expect(sorted).toEqual([
+ { name: 'folder_1', seq: false },
+ { name: 'folder_2', seq: 2 },
+ { name: 'folder_5', seq: 3 },
+ { name: 'folder_7', seq: 4 },
+ { name: 'folder_3', seq: null },
+ { name: 'folder_4', seq: undefined },
+ { name: 'folder_8', seq: 'invalid' },
+ { name: 'folder_6', seq: 9 }
+ ]);
+ });
+
+ it('should insert sequenced items at their positions among non-sequenced items', () => {
+ const items = [
+ { name: 'folder_6' },
+ { name: 'folder_1', seq: 1 },
+ { name: 'folder_5' },
+ { name: 'folder_2', seq: 2 },
+ { name: 'folder_4' },
+ { name: 'folder_3', seq: 4 }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_1', seq: 1 },
+ { name: 'folder_2', seq: 2 },
+ { name: 'folder_4' },
+ { name: 'folder_3', seq: 4 },
+ { name: 'folder_5' },
+ { name: 'folder_6' }
+ ]);
+ });
+
+ it('should handle sequence numbers beyond the array length', () => {
+ const items = [
+ { name: 'folder_1', seq: 10 },
+ { name: 'folder_2' },
+ { name: 'folder_3', seq: 20 }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_2' },
+ { name: 'folder_1', seq: 10 },
+ { name: 'folder_3', seq: 20 }
+ ]);
+ });
+ });
+
+ describe('Edge cases and boundary conditions', () => {
+ it('should handle items with missing name property without throwing errors', () => {
+ const items = [
+ { seq: 1 },
+ { name: 'folder_1' },
+ { name: 'folder_2', seq: 2 }
+ ];
+ // Note: This might cause issues in production, but we test the current behavior
+ expect(() => sortByNameThenSequence(items)).not.toThrow();
+ });
+
+ it('should handle items with no seq property (equivalent to undefined)', () => {
+ const items = [
+ { name: 'folder_3' },
+ { name: 'folder_1', seq: 1 },
+ { name: 'folder_2' }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_1', seq: 1 },
+ { name: 'folder_2' },
+ { name: 'folder_3' }
+ ]);
+ });
+
+ it('should handle single item arrays', () => {
+ const items = [{ name: 'folder_1', seq: 1 }];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([{ name: 'folder_1', seq: 1 }]);
+ });
+
+ it('should handle items with identical names but different sequences', () => {
+ const items = [
+ { name: 'folder', seq: 2 },
+ { name: 'folder', seq: 1 },
+ { name: 'folder' }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder', seq: 1 },
+ { name: 'folder', seq: 2 },
+ { name: 'folder' }
+ ]);
+ });
+ });
+
+ describe('Complex scenarios', () => {
+ it('should handle a comprehensive mix of all scenarios', () => {
+ const items = [
+ { name: 'folder_10', seq: 'invalid' },
+ { name: 'folder_1', seq: false },
+ { name: 'folder_11', seq: 3 },
+ { name: 'folder_2', seq: 2 },
+ { name: 'folder_3', seq: null },
+ { name: 'folder_12', seq: 9 },
+ { name: 'folder_4', seq: undefined },
+ { name: 'folder_5' },
+ { name: 'folder_6', seq: 0 },
+ { name: 'folder_7', seq: 4 },
+ { name: 'folder_8', seq: 1 },
+ { name: 'folder_9', seq: -1 }
+ ];
+ const result = sortByNameThenSequence(items);
+ expect(result).toEqual([
+ { name: 'folder_8', seq: 1 },
+ { name: 'folder_2', seq: 2 },
+ { name: 'folder_11', seq: 3 },
+ { name: 'folder_7', seq: 4 },
+ { name: 'folder_1', seq: false },
+ { name: 'folder_10', seq: 'invalid' },
+ { name: 'folder_3', seq: null },
+ { name: 'folder_4', seq: undefined },
+ { name: 'folder_12', seq: 9 },
+ { name: 'folder_5' },
+ { name: 'folder_6', seq: 0 },
+ { name: 'folder_9', seq: -1 }
+ ]);
+ });
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-app/src/utils/common/index.js b/packages/bruno-app/src/utils/common/index.js
index 1244966b7..1c647ae28 100644
--- a/packages/bruno-app/src/utils/common/index.js
+++ b/packages/bruno-app/src/utils/common/index.js
@@ -1,5 +1,6 @@
import { customAlphabet } from 'nanoid';
import xmlFormat from 'xml-formatter';
+import { format, applyEdits } from 'jsonc-parser';
// a customized version of nanoid without using _ and -
export const uuid = () => {
@@ -51,9 +52,12 @@ export const safeStringifyJSON = (obj, indent = false) => {
}
};
-export const convertToCodeMirrorJson = (obj) => {
+export const prettifyJSON = (obj, spaces = 2) => {
try {
- return JSON5.stringify(obj).slice(1, -1);
+ const formatted = obj.replace(/\\"/g, '"').replace(/\\'/g, "'");
+ const edits = format(formatted, undefined, { tabSize: spaces, insertSpaces: true });
+
+ return applyEdits(formatted, edits);
} catch (e) {
return obj;
}
@@ -83,27 +87,40 @@ export const normalizeFileName = (name) => {
};
export const getContentType = (headers) => {
- const headersArray = typeof headers === 'object' ? Object.entries(headers) : [];
- if (headersArray.length > 0) {
- let contentType = headersArray
- .filter((header) => header[0].toLowerCase() === 'content-type')
- .map((header) => {
- return header[1];
- });
- if (contentType && contentType.length) {
- if (typeof contentType[0] == 'string' && /^[\w\-]+\/([\w\-]+\+)?json/.test(contentType[0])) {
- return 'application/ld+json';
- } else if (typeof contentType[0] == 'string' && /^[\w\-]+\/([\w\-]+\+)?xml/.test(contentType[0])) {
- return 'application/xml';
- }
-
- return contentType[0];
- }
+ // Return empty string for invalid headers
+ if (!headers || typeof headers !== 'object' || Object.keys(headers).length === 0) {
+ return '';
}
- return '';
-};
+ // Get content-type header value
+ const contentTypeHeader = Object.entries(headers)
+ .find(([key]) => key.toLowerCase() === 'content-type');
+
+ const contentType = contentTypeHeader && contentTypeHeader[1];
+
+ // Return empty string if no content-type or not a string
+ if (!contentType || typeof contentType !== 'string') {
+ return '';
+ }
+ // This pattern matches content types like application/json, application/ld+json, text/json, etc.
+ const JSON_PATTERN = /^[\w\-]+\/([\w\-]+\+)?json/;
+ // This pattern matches content types like image/svg.
+ const SVG_PATTERN = /^image\/svg/i;
+ // This pattern matches content types like application/xml, text/xml, application/atom+xml, etc.
+ const XML_PATTERN = /^[\w\-]+\/([\w\-]+\+)?xml/;
+
+ if (JSON_PATTERN.test(contentType)) {
+ return 'application/ld+json';
+ } else if (SVG_PATTERN.test(contentType)) {
+ return 'image/svg+xml';
+ } else if (XML_PATTERN.test(contentType)) {
+ return 'application/xml';
+ }
+
+ return contentType;
+}
+
export const startsWith = (str, search) => {
if (!str || !str.length || typeof str !== 'string') {
@@ -174,3 +191,73 @@ export const generateUidBasedOnHash = (str) => {
};
export const stringifyIfNot = v => typeof v === 'string' ? v : String(v);
+
+export const getEncoding = (headers) => {
+ // Parse the charset from content type: https://stackoverflow.com/a/33192813
+ const charsetMatch = /charset=([^()<>@,;:"/[\]?.=\s]*)/i.exec(headers?.['content-type'] || '');
+ return charsetMatch?.[1];
+}
+
+export const multiLineMsg = (...messages) => {
+ return messages.filter(m => m !== undefined && m !== null && m !== '').join('\n');
+}
+
+export const formatSize = (bytes) => {
+ // Handle invalid inputs
+ if (isNaN(bytes) || typeof bytes !== 'number') {
+ return '0B';
+ }
+
+ if (bytes < 1024) {
+ return bytes + 'B';
+ }
+ if (bytes < 1024 * 1024) {
+ return (bytes / 1024).toFixed(1) + 'KB';
+ }
+ if (bytes < 1024 * 1024 * 1024) {
+ return (bytes / (1024 * 1024)).toFixed(1) + 'MB';
+ }
+
+ return (bytes / (1024 * 1024 * 1024)).toFixed(1) + 'GB';
+}
+
+export const sortByNameThenSequence = items => {
+ const isSeqValid = seq => Number.isFinite(seq) && Number.isInteger(seq) && seq > 0;
+
+ // Sort folders alphabetically by name
+ const alphabeticallySorted = [...items].sort((a, b) => a.name && b.name && a.name.localeCompare(b.name));
+
+ // Extract folders without 'seq'
+ const withoutSeq = alphabeticallySorted.filter(f => !isSeqValid(f['seq']));
+
+ // Extract folders with 'seq' and sort them by 'seq'
+ const withSeq = alphabeticallySorted.filter(f => isSeqValid(f['seq'])).sort((a, b) => a.seq - b.seq);
+
+ const sortedItems = withoutSeq;
+
+ // Insert folders with 'seq' at their specified positions
+ withSeq.forEach((item) => {
+ const position = item.seq - 1;
+ const existingItem = withoutSeq[position];
+
+ // Check if there's already an item with the same sequence number
+ const hasItemWithSameSeq = Array.isArray(existingItem)
+ ? existingItem?.[0]?.seq === item.seq
+ : existingItem?.seq === item.seq;
+
+ if (hasItemWithSameSeq) {
+ // If there's a conflict, group items with same sequence together
+ const newGroup = Array.isArray(existingItem)
+ ? [...existingItem, item]
+ : [existingItem, item];
+
+ withoutSeq.splice(position, 1, newGroup);
+ } else {
+ // Insert item at the specified position
+ withoutSeq.splice(position, 0, item);
+ }
+ });
+
+ // return flattened sortedItems
+ return sortedItems.flat();
+};
\ No newline at end of file
diff --git a/packages/bruno-app/src/utils/common/index.spec.js b/packages/bruno-app/src/utils/common/index.spec.js
index 39f3dff0a..89eeebf2e 100644
--- a/packages/bruno-app/src/utils/common/index.spec.js
+++ b/packages/bruno-app/src/utils/common/index.spec.js
@@ -1,6 +1,6 @@
const { describe, it, expect } = require('@jest/globals');
-import { normalizeFileName, startsWith, humanizeDate, relativeDate } from './index';
+import { normalizeFileName, startsWith, humanizeDate, relativeDate, getContentType, formatSize } from './index';
describe('common utils', () => {
describe('normalizeFileName', () => {
@@ -107,4 +107,81 @@ describe('common utils', () => {
expect(relativeDate(date)).toBe('2 months ago');
});
});
+
+ describe('getContentType', () => {
+ it('should handle JSON content types correctly', () => {
+ expect(getContentType({ 'content-type': 'application/json' })).toBe('application/ld+json');
+ expect(getContentType({ 'content-type': 'text/json' })).toBe('application/ld+json');
+ expect(getContentType({ 'content-type': 'application/ld+json' })).toBe('application/ld+json');
+ });
+
+ it('should handle XML content types correctly', () => {
+ expect(getContentType({ 'content-type': 'text/xml' })).toBe('application/xml');
+ expect(getContentType({ 'content-type': 'application/xml' })).toBe('application/xml');
+ expect(getContentType({ 'content-type': 'application/atom+xml' })).toBe('application/xml');
+ });
+
+ it('should handle image content types correctly', () => {
+ expect(getContentType({ 'content-type': 'image/svg+xml;charset=utf-8' })).toBe('image/svg+xml');
+ expect(getContentType({ 'content-type': 'IMAGE/SVG+xml' })).toBe('image/svg+xml');
+ });
+
+ it('should return original content type when no pattern matches', () => {
+ expect(getContentType({ 'content-type': 'image/jpeg' })).toBe('image/jpeg');
+ expect(getContentType({ 'content-type': 'application/pdf' })).toBe('application/pdf');
+ });
+
+ it('should not be case sensitive', () => {
+ expect(getContentType({ 'content-type': 'text/json' })).toBe('application/ld+json');
+ expect(getContentType({ 'Content-Type': 'text/json' })).toBe('application/ld+json');
+ });
+
+ it('should handle empty content type', () => {
+ expect(getContentType({ 'content-type': '' })).toBe('');
+ expect(getContentType({ 'content-type': null })).toBe('');
+ expect(getContentType({ 'content-type': undefined })).toBe('');
+ });
+
+ it('should handle empty or invalid inputs', () => {
+ expect(getContentType({})).toBe('');
+ expect(getContentType(null)).toBe('');
+ expect(getContentType(undefined)).toBe('');
+ });
+ });
+
+ describe('formatSize', () => {
+ it('should format bytes', () => {
+ expect(formatSize(0)).toBe('0B');
+ expect(formatSize(1023)).toBe('1023B');
+ });
+
+ it('should format kilobytes', () => {
+ expect(formatSize(1024)).toBe('1.0KB');
+ expect(formatSize(1048575)).toBe('1024.0KB');
+ });
+
+ it('should format megabytes', () => {
+ expect(formatSize(1048576)).toBe('1.0MB');
+ expect(formatSize(1073741823)).toBe('1024.0MB');
+ });
+
+ it('should format gigabytes', () => {
+ expect(formatSize(1073741824)).toBe('1.0GB');
+ expect(formatSize(1099511627776)).toBe('1024.0GB');
+ });
+
+ it('should format decimal values', () => {
+ expect(formatSize(1126.5)).toBe('1.1KB');
+ expect(formatSize(1153433.6)).toBe('1.1MB');
+ expect(formatSize(1153433600)).toBe('1.1GB');
+ expect(formatSize(1024.1)).toBe('1.0KB');
+ expect(formatSize(1048576.1)).toBe('1.0MB');
+ });
+
+ it('should format invalid inputs', () => {
+ expect(formatSize(null)).toBe('0B');
+ expect(formatSize(undefined)).toBe('0B');
+ expect(formatSize(NaN)).toBe('0B');
+ });
+ });
});
diff --git a/packages/bruno-app/src/utils/common/ipc.js b/packages/bruno-app/src/utils/common/ipc.js
new file mode 100644
index 000000000..3559737f2
--- /dev/null
+++ b/packages/bruno-app/src/utils/common/ipc.js
@@ -0,0 +1,14 @@
+/**
+ * Wrapper for ipcRenderer.invoke that handles error cases
+ * @param {string} channel - The IPC channel name
+ * @param {...any} args - Arguments to pass to the channel
+ * @returns {Promise} - Resolves with the result or rejects with error
+ */
+export const callIpc = (channel, ...args) => {
+ const { ipcRenderer } = window;
+ if (!ipcRenderer) {
+ return Promise.reject(new Error('IPC Renderer not available'));
+ }
+
+ return ipcRenderer.invoke(channel, ...args);
+};
\ No newline at end of file
diff --git a/packages/bruno-app/src/utils/common/path.js b/packages/bruno-app/src/utils/common/path.js
new file mode 100644
index 000000000..ccd271a5e
--- /dev/null
+++ b/packages/bruno-app/src/utils/common/path.js
@@ -0,0 +1,40 @@
+import platform from 'platform';
+import path from 'path';
+
+const isWindowsOS = () => {
+ const os = platform.os;
+ const osFamily = os.family.toLowerCase();
+ return osFamily.includes('windows');
+};
+
+const brunoPath = isWindowsOS() ? path.win32 : path.posix;
+
+const getRelativePath = (absolutePath, collectionPath) => {
+ try {
+ const relativePath = brunoPath.relative(collectionPath, absolutePath);
+ return relativePath || absolutePath;
+ } catch (error) {
+ return absolutePath;
+ }
+};
+
+const getBasename = (filePath) => {
+ if (!filePath) {
+ return '';
+ }
+ const parts = filePath.split(path.sep);
+ return parts[parts.length - 1];
+};
+
+const getDirPath = (filePath) => {
+ const parts = filePath.split(path.sep);
+ parts.pop();
+ return parts.join(path.sep);
+};
+
+const getAbsoluteFilePath = (filePath, collectionPath) => {
+ return brunoPath.resolve(collectionPath, filePath);
+};
+
+export default brunoPath;
+export { getRelativePath, getBasename, getDirPath, getAbsoluteFilePath };
diff --git a/packages/bruno-app/src/utils/common/platform.js b/packages/bruno-app/src/utils/common/platform.js
index ddfdb3a1f..dc1d7d984 100644
--- a/packages/bruno-app/src/utils/common/platform.js
+++ b/packages/bruno-app/src/utils/common/platform.js
@@ -1,7 +1,6 @@
import trim from 'lodash/trim';
-import path from 'path';
-import slash from './slash';
import platform from 'platform';
+import path from './path';
export const isElectron = () => {
if (!window) {
@@ -16,21 +15,11 @@ export const resolveRequestFilename = (name) => {
};
export const getSubdirectoriesFromRoot = (rootPath, pathname) => {
- // convert to unix style path
- pathname = slash(pathname);
- rootPath = slash(rootPath);
const relativePath = path.relative(rootPath, pathname);
return relativePath ? relativePath.split(path.sep) : [];
};
-export const getDirectoryName = (pathname) => {
- // convert to unix style path
- pathname = slash(pathname);
-
- return path.dirname(pathname);
-};
-
export const isWindowsOS = () => {
const os = platform.os;
const osFamily = os.family.toLowerCase();
@@ -45,8 +34,6 @@ export const isMacOS = () => {
return osFamily.includes('os x');
};
-export const PATH_SEPARATOR = isWindowsOS() ? '\\' : '/';
-
export const getAppInstallDate = () => {
let dateString = localStorage.getItem('bruno.installedOn');
diff --git a/packages/bruno-app/src/utils/common/regex.js b/packages/bruno-app/src/utils/common/regex.js
index 53f46741e..a8e4c6eee 100644
--- a/packages/bruno-app/src/utils/common/regex.js
+++ b/packages/bruno-app/src/utils/common/regex.js
@@ -1 +1,56 @@
+const invalidCharacters = /[<>:"/\\|?*\x00-\x1F]/g; // replace invalid characters with hyphens
+const reservedDeviceNames = /^(CON|PRN|AUX|NUL|COM[0-9]|LPT[0-9])$/i;
+const firstCharacter = /^[^\s\-<>:"/\\|?*\x00-\x1F]/; // no space, hyphen and `invalidCharacters`
+const middleCharacters = /^[^<>:"/\\|?*\x00-\x1F]*$/; // no `invalidCharacters`
+const lastCharacter = /[^.\s<>:"/\\|?*\x00-\x1F]$/; // no dot, space and `invalidCharacters`
+
export const variableNameRegex = /^[\w-.]*$/;
+
+export const sanitizeName = (name) => {
+ name = name
+ .replace(invalidCharacters, '-') // replace invalid characters with hyphens
+ .replace(/^[\s\-]+/, '') // remove leading spaces and hyphens
+ .replace(/[.\s]+$/, ''); // remove trailing dots and spaces
+ return name;
+};
+
+export const validateName = (name) => {
+ if (!name) return false;
+ if (name.length > 255) return false; // max name length
+
+ if (reservedDeviceNames.test(name)) return false; // windows reserved names
+
+ return (
+ firstCharacter.test(name) &&
+ middleCharacters.test(name) &&
+ lastCharacter.test(name)
+ );
+};
+
+export const validateNameError = (name) => {
+ if (!name) return "Name cannot be empty.";
+
+ if (name.length > 255) {
+ return "Name cannot exceed 255 characters.";
+ }
+
+ if (reservedDeviceNames.test(name)) {
+ return "Name cannot be a reserved device name.";
+ }
+
+ if (!firstCharacter.test(name[0])) {
+ return "Invalid first character.";
+ }
+
+ for (let i = 1; i < name.length - 1; i++) {
+ if (!middleCharacters.test(name[i])) {
+ return `Invalid character '${name[i]}' at position ${i + 1}.`;
+ }
+ }
+
+ if (!lastCharacter.test(name[name.length - 1])) {
+ return "Invalid last character.";
+ }
+
+ return '';
+};
\ No newline at end of file
diff --git a/packages/bruno-app/src/utils/common/regex.spec.js b/packages/bruno-app/src/utils/common/regex.spec.js
new file mode 100644
index 000000000..3994a2b2d
--- /dev/null
+++ b/packages/bruno-app/src/utils/common/regex.spec.js
@@ -0,0 +1,166 @@
+const { describe, it, expect } = require('@jest/globals');
+
+import { sanitizeName, validateName } from './regex';
+
+describe('regex validators', () => {
+ describe('sanitize name', () => {
+ it('should remove invalid characters', () => {
+ expect(sanitizeName('hello world')).toBe('hello world');
+ expect(sanitizeName('hello-world')).toBe('hello-world');
+ expect(sanitizeName('hello_world')).toBe('hello_world');
+ expect(sanitizeName('hello_world-')).toBe('hello_world-');
+ expect(sanitizeName('hello_world-123')).toBe('hello_world-123');
+ expect(sanitizeName('hello_world-123!@#$%^&*()')).toBe('hello_world-123!@#$%^&-()');
+ expect(sanitizeName('hello_world?')).toBe('hello_world-');
+ expect(sanitizeName('foo/bar/')).toBe('foo-bar-');
+ expect(sanitizeName('foo\\bar\\')).toBe('foo-bar-');
+ });
+
+ it('should remove leading hyphens', () => {
+ expect(sanitizeName('-foo')).toBe('foo');
+ expect(sanitizeName('---foo')).toBe('foo');
+ expect(sanitizeName('-foo-bar')).toBe('foo-bar');
+ });
+
+ it('should remove trailing periods', () => {
+ expect(sanitizeName('.file')).toBe('.file');
+ expect(sanitizeName('.file.')).toBe('.file');
+ expect(sanitizeName('file.')).toBe('file');
+ expect(sanitizeName('file.name.')).toBe('file.name');
+ expect(sanitizeName('hello world.')).toBe('hello world');
+ });
+
+ it('should handle filenames with only invalid characters', () => {
+ expect(sanitizeName('<>:"/\\|?*')).toBe('');
+ expect(sanitizeName('::::')).toBe('');
+ });
+
+ it('should handle filenames with a mix of valid and invalid characters', () => {
+ expect(sanitizeName('test<>:"/\\|?*')).toBe('test---------');
+ expect(sanitizeName('foo')).toBe('foo-bar-');
+ });
+
+ it('should remove control characters', () => {
+ expect(sanitizeName('foo\x00bar')).toBe('foo-bar');
+ expect(sanitizeName('file\x1Fname')).toBe('file-name');
+ });
+
+ it('should return an empty string if the name is empty or consists only of invalid characters', () => {
+ expect(sanitizeName('')).toBe('');
+ expect(sanitizeName('<>:"/\\|?*')).toBe('');
+ });
+
+ it('should handle filenames with multiple consecutive invalid characters', () => {
+ expect(sanitizeName('foo< {
+ expect(sanitizeName(' ')).toBe('');
+ });
+
+ it('should handle names with leading/trailing spaces', () => {
+ expect(sanitizeName(' foo bar ')).toBe('foo bar');
+ });
+
+ it('should preserve valid non-ASCII characters', () => {
+ expect(sanitizeName('brunó')).toBe('brunó');
+ expect(sanitizeName('文件')).toBe('文件');
+ expect(sanitizeName('brunfais')).toBe('brunfais');
+ expect(sanitizeName('brunai')).toBe('brunai');
+ expect(sanitizeName('brunsборка')).toBe('brunsборка');
+ expect(sanitizeName('brunпривет')).toBe('brunпривет');
+ expect(sanitizeName('🐶')).toBe('🐶');
+ expect(sanitizeName('brunfais🐶')).toBe('brunfais🐶');
+ expect(sanitizeName('file-🐶-bruno')).toBe('file-🐶-bruno');
+ expect(sanitizeName('helló')).toBe('helló');
+ });
+
+ it('should preserve case sensitivity', () => {
+ expect(sanitizeName('FileName')).toBe('FileName');
+ expect(sanitizeName('fileNAME')).toBe('fileNAME');
+ });
+
+ it('should handle filenames with multiple consecutive periods (only remove trailing)', () => {
+ expect(sanitizeName('file.name...')).toBe('file.name');
+ expect(sanitizeName('...file')).toBe('...file');
+ expect(sanitizeName('file.name... ')).toBe('file.name');
+ expect(sanitizeName(' ...file')).toBe('...file');
+ expect(sanitizeName(' ...file ')).toBe('...file');
+ expect(sanitizeName(' ...file.... ')).toBe('...file');
+ });
+
+ it('should handle very long filenames', () => {
+ const longName = 'a'.repeat(250) + '.txt';
+ expect(sanitizeName(longName)).toBe(longName);
+ });
+
+ it('should handle names with leading/trailing invalid characters', () => {
+ expect(sanitizeName('-foo/bar-')).toBe('foo-bar-');
+ expect(sanitizeName('/foo\\bar/')).toBe('foo-bar-');
+ });
+
+ it('should handle different language unicode characters', () => {
+ expect(sanitizeName('你好世界!?@#$%^&*()')).toBe('你好世界!-@#$%^&-()');
+ expect(sanitizeName('こんにちは世界!?@#$%^&*()')).toBe('こんにちは世界!-@#$%^&-()');
+ expect(sanitizeName('안녕하세요 세계!?@#$%^&*()')).toBe('안녕하세요 세계!-@#$%^&-()');
+ expect(sanitizeName('مرحبا بالعالم!?@#$%^&*()')).toBe('مرحبا بالعالم!-@#$%^&-()');
+ expect(sanitizeName('Здравствуй мир!?@#$%^&*()')).toBe('Здравствуй мир!-@#$%^&-()');
+ expect(sanitizeName('नमस्ते दुनिया!?@#$%^&*()')).toBe('नमस्ते दुनिया!-@#$%^&-()');
+ expect(sanitizeName('สวัสดีชาวโลก!?@#$%^&*()')).toBe('สวัสดีชาวโลก!-@#$%^&-()');
+ expect(sanitizeName('γειά σου κόσμος!?@#$%^&*()')).toBe('γειά σου κόσμος!-@#$%^&-()');
+ });
+
+ });
+});
+
+describe('sanitizeName and validateName', () => {
+ it('should sanitize and then validate valid names', () => {
+ const validNames = [
+ 'valid_filename.txt',
+ ' valid name ',
+ ' valid-name ',
+ 'valid<>name.txt',
+ 'file/with?invalid*chars'
+ ];
+
+ validNames.forEach(name => {
+ const sanitized = sanitizeName(name);
+ expect(validateName(sanitized)).toBe(true);
+ });
+ });
+
+ it('should sanitize and then validate names with reserved device names', () => {
+ const reservedNames = ['CON', 'PRN', 'AUX', 'NUL', 'COM1', 'LPT2'];
+
+ reservedNames.forEach(name => {
+ const sanitized = sanitizeName(name);
+ expect(validateName(sanitized)).toBe(false);
+ });
+ });
+
+ it('should sanitize invalid names to empty strings', () => {
+ const invalidNames = [
+ ' <>:"/\\|?* ',
+ ' ... ',
+ ' ',
+ ];
+
+ invalidNames.forEach(name => {
+ const sanitized = sanitizeName(name);
+ expect(validateName(sanitized)).toBe(false);
+ });
+ });
+
+ it('should return false for reserved device names with leading/trailing spaces', () => {
+ const mixedNames = [
+ 'AUX ',
+ ' COM1 '
+ ];
+
+ mixedNames.forEach(name => {
+ const sanitized = sanitizeName(name);
+ expect(validateName(sanitized)).toBe(false);
+ });
+ });
+});
diff --git a/packages/bruno-app/src/utils/common/slash.js b/packages/bruno-app/src/utils/common/slash.js
deleted file mode 100644
index a2b39e94f..000000000
--- a/packages/bruno-app/src/utils/common/slash.js
+++ /dev/null
@@ -1,20 +0,0 @@
-/**
- * MIT License
- *
- * Copyright (c) Sindre Sorhus (https://sindresorhus.com)
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
- * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
-const slash = (path) => {
- const isExtendedLengthPath = /^\\\\\?\\/.test(path);
-
- if (isExtendedLengthPath) {
- return path;
- }
-
- return path.replace(/\\/g, '/');
-};
-
-export default slash;
diff --git a/packages/bruno-app/src/utils/curl/curl-to-json.js b/packages/bruno-app/src/utils/curl/curl-to-json.js
index c1398ab14..21daf8283 100644
--- a/packages/bruno-app/src/utils/curl/curl-to-json.js
+++ b/packages/bruno-app/src/utils/curl/curl-to-json.js
@@ -9,6 +9,7 @@
import parseCurlCommand from './parse-curl';
import * as querystring from 'query-string';
import * as jsesc from 'jsesc';
+import { buildQueryString } from '@usebruno/common/utils';
function getContentType(headers = {}) {
const contentType = Object.keys(headers).find((key) => key.toLowerCase() === 'content-type');
@@ -20,22 +21,6 @@ function repr(value, isKey) {
return isKey ? "'" + jsesc(value, { quotes: 'single' }) + "'" : value;
}
-function getQueries(request) {
- const queries = {};
- for (const paramName in request.query) {
- const rawValue = request.query[paramName];
- let paramValue;
- if (Array.isArray(rawValue)) {
- paramValue = rawValue.map(repr);
- } else {
- paramValue = repr(rawValue);
- }
- queries[repr(paramName)] = paramValue;
- }
-
- return queries;
-}
-
/**
* Converts request data to a string based on its content type.
*
@@ -49,15 +34,7 @@ function getDataString(request) {
const contentType = getContentType(request.headers);
- if (contentType && contentType.includes('application/json')) {
- try {
- const parsedData = JSON.parse(request.data);
- return { data: JSON.stringify(parsedData) };
- } catch (error) {
- console.error('Failed to parse JSON data:', error);
- return { data: request.data.toString() };
- }
- } else if (contentType && (contentType.includes('application/xml') || contentType.includes('text/plain'))) {
+ if (contentType && (contentType.includes('application/json') || contentType.includes('application/xml') || contentType.includes('text/plain'))) {
return { data: request.data };
}
@@ -99,9 +76,30 @@ function getMultipleDataString(request, parsedQueryString) {
function getFilesString(request) {
const data = {};
- data.files = {};
data.data = {};
+ if (request.isDataBinary) {
+ let filePath = '';
+
+ if (request.data.startsWith('@')) {
+ filePath = request.data.slice(1);
+ } else {
+ filePath = request.data;
+ }
+
+ data.data = [
+ {
+ filePath: repr(filePath),
+ contentType: request.headers['Content-Type'],
+ selected: true,
+ }
+ ];
+
+ return data;
+ }
+
+ data.files = {};
+
for (const multipartKey in request.multipartUploads) {
const multipartValue = request.multipartUploads[multipartKey];
if (multipartValue.startsWith('@')) {
@@ -126,6 +124,10 @@ function getFilesString(request) {
const curlToJson = (curlCommand) => {
const request = parseCurlCommand(curlCommand);
+ if (!request?.url) {
+ return null;
+ }
+
const requestJson = {};
// curl automatically prepends 'http' if the scheme is missing, but python fails and returns an error
@@ -140,6 +142,7 @@ const curlToJson = (curlCommand) => {
requestJson.url = request.urlWithoutQuery;
requestJson.raw_url = request.url;
requestJson.method = request.method;
+ requestJson.isDataBinary = request.isDataBinary;
if (request.cookies) {
const cookies = {};
@@ -159,14 +162,20 @@ const curlToJson = (curlCommand) => {
requestJson.headers = headers;
}
- if (request.query) {
- requestJson.queries = getQueries(request);
+ if (request.queries) {
+ requestJson.url = requestJson.url + '?' + buildQueryString(request.queries, { encode: false });
}
- if (typeof request.data === 'string' || typeof request.data === 'number') {
- Object.assign(requestJson, getDataString(request));
- } else if (request.multipartUploads) {
+ if (request.multipartUploads) {
+ requestJson.data = request.multipartUploads;
+ if (!requestJson.headers) {
+ requestJson.headers = {};
+ }
+ requestJson.headers['Content-Type'] = 'multipart/form-data';
+ } else if (request.isDataBinary) {
Object.assign(requestJson, getFilesString(request));
+ } else if (typeof request.data === 'string' || typeof request.data === 'number') {
+ Object.assign(requestJson, getDataString(request));
}
if (request.insecure) {
@@ -185,7 +194,7 @@ const curlToJson = (curlCommand) => {
}
}
- return Object.keys(requestJson).length ? requestJson : {};
+ return Object.keys(requestJson).length ? requestJson : null;
};
export default curlToJson;
diff --git a/packages/bruno-app/src/utils/curl/curl-to-json.spec.js b/packages/bruno-app/src/utils/curl/curl-to-json.spec.js
index 2d9785154..058064391 100644
--- a/packages/bruno-app/src/utils/curl/curl-to-json.spec.js
+++ b/packages/bruno-app/src/utils/curl/curl-to-json.spec.js
@@ -62,7 +62,7 @@ describe('curlToJson', () => {
it('should accept escaped curl string', () => {
const curlCommand = `curl https://www.usebruno.com
- -H $'cookie: val_1=\'\'; val_2=\\^373:0\\^373:0; val_3=\u0068\u0065\u006C\u006C\u006F'
+ -H $'cookie: val_1=\\'\\'; val_2=\\^373:0\\^373:0; val_3=\u0068\u0065\u006C\u006C\u006F'
`;
const result = curlToJson(curlCommand);
@@ -86,4 +86,38 @@ describe('curlToJson', () => {
method: 'get'
});
});
+
+ it('should return a parse a curl with a post body with binary file type', () => {
+ const curlCommand = `curl 'https://www.usebruno.com'
+ -H 'Accept: application/json, text/plain, */*'
+ -H 'Accept-Language: en-US,en;q=0.9,hi;q=0.8'
+ -H 'Content-Type: application/json;charset=utf-8'
+ -H 'Origin: https://www.usebruno.com'
+ -H 'Referer: https://www.usebruno.com/'
+ --data-binary '@/path/to/file'
+ `;
+
+ const result = curlToJson(curlCommand);
+
+ expect(result).toEqual({
+ url: 'https://www.usebruno.com',
+ raw_url: 'https://www.usebruno.com',
+ method: 'post',
+ headers: {
+ Accept: 'application/json, text/plain, */*',
+ 'Accept-Language': 'en-US,en;q=0.9,hi;q=0.8',
+ 'Content-Type': 'application/json;charset=utf-8',
+ Origin: 'https://www.usebruno.com',
+ Referer: 'https://www.usebruno.com/'
+ },
+ isDataBinary: true,
+ data: [
+ {
+ filePath: '/path/to/file',
+ contentType: 'application/json;charset=utf-8',
+ selected: true
+ }
+ ]
+ });
+ });
});
diff --git a/packages/bruno-app/src/utils/curl/index.js b/packages/bruno-app/src/utils/curl/index.js
index f486df56b..0b4d894cd 100644
--- a/packages/bruno-app/src/utils/curl/index.js
+++ b/packages/bruno-app/src/utils/curl/index.js
@@ -1,5 +1,5 @@
import { forOwn } from 'lodash';
-import { convertToCodeMirrorJson } from 'utils/common';
+import { prettifyJSON } from 'utils/common';
import curlToJson from './curl-to-json';
export const getRequestFromCurlCommand = (curlCommand, requestType = 'http-request') => {
@@ -34,6 +34,10 @@ export const getRequestFromCurlCommand = (curlCommand, requestType = 'http-reque
}
const request = curlToJson(curlCommand);
+ if (!request || !request.url) {
+ return null;
+ }
+
const parsedHeaders = request?.headers;
const headers =
parsedHeaders &&
@@ -50,16 +54,20 @@ export const getRequestFromCurlCommand = (curlCommand, requestType = 'http-reque
sparql: null,
multipartForm: null,
formUrlEncoded: null,
- graphql: null
+ graphql: null,
+ file: null
};
if (parsedBody && contentType && typeof contentType === 'string') {
if (requestType === 'graphql-request' && (contentType.includes('application/json') || contentType.includes('application/graphql'))) {
body.mode = 'graphql';
body.graphql = parseGraphQL(parsedBody);
- } else if (contentType.includes('application/json')) {
+ } else if (requestType === 'http-request' && request.isDataBinary) {
+ body.mode = 'file';
+ body.file = parsedBody;
+ }else if (contentType.includes('application/json')) {
body.mode = 'json';
- body.json = convertToCodeMirrorJson(parsedBody);
+ body.json = prettifyJSON(parsedBody);
} else if (contentType.includes('xml')) {
body.mode = 'xml';
body.xml = parsedBody;
@@ -73,7 +81,11 @@ export const getRequestFromCurlCommand = (curlCommand, requestType = 'http-reque
body.mode = 'text';
body.text = parsedBody;
}
+ } else if (parsedBody) {
+ body.mode = 'formUrlEncoded';
+ body.formUrlEncoded = parseFormData(parsedBody);
}
+
return {
url: request.url,
method: request.method,
diff --git a/packages/bruno-app/src/utils/curl/parse-curl.js b/packages/bruno-app/src/utils/curl/parse-curl.js
index 79db23672..d44aa547a 100644
--- a/packages/bruno-app/src/utils/curl/parse-curl.js
+++ b/packages/bruno-app/src/utils/curl/parse-curl.js
@@ -1,265 +1,494 @@
+import cookie from 'cookie';
+import URL from 'url';
+import { parse } from 'shell-quote';
+import { isEmpty } from 'lodash';
+import { parseQueryParams } from '@usebruno/common/utils';
+
/**
- * Copyright (c) 2014-2016 Nick Carneiro
- * https://github.com/curlconverter/curlconverter
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
+ * Flag definitions - maps flag names to their states and actions
+ * State-returning flags expect a value, immediate action flags don't
*/
+const FLAG_CATEGORIES = {
+ // State-returning flags (expect a value after the flag)
+ 'user-agent': ['-A', '--user-agent'],
+ 'header': ['-H', '--header'],
+ 'data': ['-d', '--data', '--data-ascii', '--data-urlencode'],
+ 'json': ['--json'],
+ 'user': ['-u', '--user'],
+ 'method': ['-X', '--request'],
+ 'cookie': ['-b', '--cookie'],
+ 'form': ['-F', '--form'],
+ // Special data flags with properties
+ 'data-raw': ['--data-raw'],
+ 'data-binary': ['--data-binary'],
-import * as cookie from 'cookie';
-import * as URL from 'url';
-import * as querystring from 'query-string';
-import yargs from 'yargs-parser';
+ // Immediate action flags (no value expected)
+ 'head': ['-I', '--head'],
+ 'compressed': ['--compressed'],
+ 'insecure': ['-k', '--insecure'],
+ /**
+ * Query flags: mark data for conversion to query parameters.
+ * While this is an immediate action flag, the actual conversion to a query string occurs later during post-build request processing.
+ * Due to the unpredictable order of flags, query string construction is deferred to the end.
+ */
+ 'query': ['-G', '--get']
+};
-const parseCurlCommand = (curlCommand) => {
- // catch escape sequences (e.g. -H $'cookie: it=\'\'')
- curlCommand = curlCommand.replace(/\$('.*')/g, (match, group) => group);
+/**
+ * Parse a curl command into a request object
+ *
+ * @TODO
+ * - Handle T (file upload)
+ */
+const parseCurlCommand = (curl) => {
+ const cleanedCommand = cleanCurlCommand(curl);
+ const parsedArgs = parse(cleanedCommand);
+ const request = buildRequest(parsedArgs);
- // Remove newlines (and from continuations)
- curlCommand = curlCommand.replace(/\\\r|\\\n/g, '');
+ return cleanRequest(postBuildProcessRequest(request));
+};
- // Remove extra whitespace
- curlCommand = curlCommand.replace(/\s+/g, ' ');
+/**
+ * Build request object by processing parsed arguments
+ * Uses a state machine pattern to handle flag-value pairs
+ */
+const buildRequest = (parsedArgs) => {
+ const request = { headers: {} };
+ let currentState = null;
- // yargs parses -XPOST as separate arguments. just prescreen for it.
- curlCommand = curlCommand.replace(/ -XPOST/, ' -X POST');
- curlCommand = curlCommand.replace(/ -XGET/, ' -X GET');
- curlCommand = curlCommand.replace(/ -XPUT/, ' -X PUT');
- curlCommand = curlCommand.replace(/ -XPATCH/, ' -X PATCH');
- curlCommand = curlCommand.replace(/ -XDELETE/, ' -X DELETE');
- curlCommand = curlCommand.replace(/ -XOPTIONS/, ' -X OPTIONS');
- // Safari adds `-Xnull` if is unable to determine the request type, it can be ignored
- curlCommand = curlCommand.replace(/ -Xnull/, ' ');
- curlCommand = curlCommand.trim();
-
- const parsedArguments = yargs(curlCommand, {
- boolean: ['I', 'head', 'compressed', 'L', 'k', 'silent', 's', 'G', 'get'],
- alias: {
- H: 'header',
- A: 'user-agent',
- u: 'user'
- }
- });
-
- let cookieString;
- let cookies;
- let url = parsedArguments._[1] || '';
-
- // remove surrounding quotes if present
- if (url && url.length) {
- url = url.replace(/^['"]|['"]$/g, '');
- }
-
- // if url argument wasn't where we expected it, try to find it in the other arguments
- if (!url) {
- for (const argName in parsedArguments) {
- if (typeof parsedArguments[argName] === 'string') {
- if (parsedArguments[argName].indexOf('http') === 0 || parsedArguments[argName].indexOf('www.') === 0) {
- url = parsedArguments[argName];
- }
- }
+ for (const arg of parsedArgs) {
+ const newState = processArgument(arg, currentState, request);
+ // Reset state after handling a value, or update to new state
+ if (currentState && !newState) {
+ currentState = null;
+ } else if (newState) {
+ currentState = newState;
}
}
- let headers;
-
- if (parsedArguments.header) {
- if (!headers) {
- headers = {};
- }
- if (!Array.isArray(parsedArguments.header)) {
- parsedArguments.header = [parsedArguments.header];
- }
- parsedArguments.header.forEach((header) => {
- if (header.indexOf('Cookie') !== -1) {
- cookieString = header;
- }
- const components = header.split(/:(.*)/);
- if (components[1]) {
- headers[components[0]] = components[1].trim();
- }
- });
- }
-
- if (parsedArguments['user-agent']) {
- if (!headers) {
- headers = {};
- }
- headers['User-Agent'] = parsedArguments['user-agent'];
- }
-
- if (parsedArguments.b) {
- cookieString = parsedArguments.b;
- }
- if (parsedArguments.cookie) {
- cookieString = parsedArguments.cookie;
- }
- let multipartUploads;
- if (parsedArguments.F) {
- multipartUploads = {};
- if (!Array.isArray(parsedArguments.F)) {
- parsedArguments.F = [parsedArguments.F];
- }
- parsedArguments.F.forEach((multipartArgument) => {
- // input looks like key=value. value could be json or a file path prepended with an @
- const splitArguments = multipartArgument.split('=', 2);
- const key = splitArguments[0];
- const value = splitArguments[1];
- multipartUploads[key] = value;
- });
- }
- if (cookieString) {
- const cookieParseOptions = {
- decode: function (s) {
- return s;
- }
- };
- // separate out cookie headers into separate data structure
- // note: cookie is case insensitive
- cookies = cookie.parse(cookieString.replace(/^Cookie: /gi, ''), cookieParseOptions);
- }
- let method;
- let parsedMethodArgument = parsedArguments.X || parsedArguments.request || parsedArguments.T;
- if (parsedMethodArgument === 'POST') {
- method = 'post';
- } else if (parsedMethodArgument === 'PUT') {
- method = 'put';
- } else if (parsedMethodArgument === 'PATCH') {
- method = 'patch';
- } else if (parsedMethodArgument === 'DELETE') {
- method = 'delete';
- } else if (parsedMethodArgument === 'OPTIONS') {
- method = 'options';
- } else if (
- (parsedArguments.d ||
- parsedArguments.data ||
- parsedArguments['data-ascii'] ||
- parsedArguments['data-binary'] ||
- parsedArguments['data-raw'] ||
- parsedArguments.F ||
- parsedArguments.form) &&
- !(parsedArguments.G || parsedArguments.get)
- ) {
- method = 'post';
- } else if (parsedArguments.I || parsedArguments.head) {
- method = 'head';
- } else {
- method = 'get';
- }
-
- const compressed = !!parsedArguments.compressed;
- const urlObject = URL.parse(url || '');
-
- // if GET request with data, convert data to query string
- // NB: the -G flag does not change the http verb. It just moves the data into the url.
- if (parsedArguments.G || parsedArguments.get) {
- urlObject.query = urlObject.query ? urlObject.query : '';
- let option = null;
- if ('d' in parsedArguments) option = 'd';
- if ('data' in parsedArguments) option = 'data';
- if ('data-urlencode' in parsedArguments) option = 'data-urlencode';
- if (option) {
- let urlQueryString = '';
-
- if (url.indexOf('?') < 0) {
- url += '?';
- } else {
- urlQueryString += '&';
- }
-
- if (typeof parsedArguments[option] === 'object') {
- urlQueryString += parsedArguments[option].join('&');
- } else {
- urlQueryString += parsedArguments[option];
- }
- urlObject.query += urlQueryString;
- url += urlQueryString;
- delete parsedArguments[option];
- }
- }
- if (urlObject.query && urlObject.query.endsWith('&')) {
- urlObject.query = urlObject.query.slice(0, -1);
- }
- const query = querystring.parse(urlObject.query, { sort: false });
- for (const param in query) {
- if (query[param] === null) {
- query[param] = '';
- }
- }
-
- urlObject.search = null; // Clean out the search/query portion.
-
- let urlWithoutQuery = URL.format(urlObject);
- let urlHost = urlObject?.host;
- if (!url?.includes(`${urlHost}/`)) {
- if (urlWithoutQuery && urlHost) {
- const [beforeHost, afterHost] = urlWithoutQuery.split(urlHost);
- urlWithoutQuery = beforeHost + urlHost + afterHost?.slice(1);
- }
- }
-
- const request = {
- url,
- urlWithoutQuery
- };
-
- if (compressed) {
- request.compressed = true;
- }
-
- if (Object.keys(query).length > 0) {
- request.query = query;
- }
- if (headers) {
- request.headers = headers;
- }
- request.method = method;
-
- if (cookies) {
- request.cookies = cookies;
- request.cookieString = cookieString.replace('Cookie: ', '');
- }
- if (multipartUploads) {
- request.multipartUploads = multipartUploads;
- }
- if (parsedArguments.data) {
- request.data = parsedArguments.data;
- } else if (parsedArguments['data-binary']) {
- request.data = parsedArguments['data-binary'];
- request.isDataBinary = true;
- } else if (parsedArguments.d) {
- request.data = parsedArguments.d;
- } else if (parsedArguments['data-ascii']) {
- request.data = parsedArguments['data-ascii'];
- } else if (parsedArguments['data-raw']) {
- request.data = parsedArguments['data-raw'];
- request.isDataRaw = true;
- } else if (parsedArguments['data-urlencode']) {
- request.data = parsedArguments['data-urlencode'];
- }
-
- if (parsedArguments.user && typeof parsedArguments.user === 'string') {
- const basicAuth = parsedArguments.user.split(':')
- const username = basicAuth[0] || ''
- const password = basicAuth[1] || ''
- request.auth = {
- mode: 'basic',
- basic: {
- username,
- password
- }
- }
- }
-
- if (Array.isArray(request.data)) {
- request.dataArray = request.data;
- request.data = request.data.join('&');
- }
-
- if (parsedArguments.k || parsedArguments.insecure) {
- request.insecure = true;
- }
return request;
};
+/**
+ * Process a single argument and return new state if needed
+ * State machine: flags set states, values are processed based on current state
+ */
+const processArgument = (arg, currentState, request) => {
+ // Handle flag arguments first (they set states)
+ const flagState = handleFlag(arg, request);
+ if (flagState) {
+ return flagState;
+ }
+
+ // Handle values based on current state (e.g., -H "value" where currentState is 'header')
+ if (arg && currentState) {
+ handleValue(arg, currentState, request);
+ return null;
+ }
+
+ // Handle URL detection (only when no current state to avoid conflicts)
+ if (!currentState && isURLOrFragment(arg)) {
+ setURL(request, arg);
+ return null;
+ }
+
+ return null;
+};
+
+/**
+ * Handle flag arguments and return new state
+ * Determines if flag expects a value or performs immediate action
+ */
+const handleFlag = (arg, request) => {
+ // Find which category this flag belongs to
+ for (const [category, flags] of Object.entries(FLAG_CATEGORIES)) {
+ if (flags.includes(arg)) {
+ return handleFlagCategory(category, arg, request);
+ }
+ }
+
+ return null;
+};
+
+/**
+ * Handle flag based on its category
+ * Returns state name for flags that expect values, null for immediate actions
+ */
+const handleFlagCategory = (category, arg, request) => {
+ switch (category) {
+ // State-returning flags (return category name to expect value)
+ case 'user-agent':
+ case 'header':
+ case 'data':
+ case 'json':
+ case 'user':
+ case 'method':
+ case 'cookie':
+ case 'form':
+ return category;
+
+ // Special data flags (set properties and return 'data' state)
+ case 'data-raw':
+ request.isDataRaw = true;
+ return 'data';
+
+ case 'data-binary':
+ request.isDataBinary = true;
+ return 'data';
+
+ // Immediate action flags (perform action and return null)
+ case 'head':
+ request.method = 'HEAD';
+ return null;
+
+ case 'compressed':
+ request.headers['Accept-Encoding'] = request.headers['Accept-Encoding'] || 'deflate, gzip';
+ return null;
+
+ case 'insecure':
+ request.insecure = true;
+ return null;
+
+ case 'query':
+ // set temporary property isQuery to true to indicate that the data should be converted to query string
+ // this is processed later at post build request processing
+ request.isQuery = true;
+ return null;
+
+ default:
+ return null;
+ }
+};
+
+/**
+ * Handle values based on the current parsing state
+ * Maps state names to their value processing functions
+ */
+const handleValue = (value, state, request) => {
+ const valueHandlers = {
+ 'header': () => setHeader(request, value),
+ 'user-agent': () => setUserAgent(request, value),
+ 'data': () => setData(request, value),
+ 'json': () => setJsonData(request, value),
+ 'form': () => setFormData(request, value),
+ 'user': () => setAuth(request, value),
+ 'method': () => setMethod(request, value),
+ 'cookie': () => setCookie(request, value)
+ };
+
+ const handler = valueHandlers[state];
+ if (handler) {
+ handler();
+ }
+};
+
+/**
+ * Set header from value
+ */
+const setHeader = (request, value) => {
+ const [headerName, headerValue] = value.split(/: (.+)/);
+ request.headers[headerName] = headerValue;
+};
+
+/**
+ * Set user agent
+ */
+const setUserAgent = (request, value) => {
+ request.headers['User-Agent'] = value;
+};
+
+/**
+ * Set authentication
+ */
+const setAuth = (request, value) => {
+ if (typeof value !== 'string') {
+ return;
+ }
+
+ const [username, password] = value.split(':');
+ request.auth = {
+ mode: 'basic',
+ basic: {
+ username: username || '',
+ password: password || ''
+ }
+ };
+};
+
+/**
+ * Set request method
+ */
+const setMethod = (request, value) => {
+ request.method = value.toUpperCase();
+};
+
+/**
+ * Set request cookies
+ */
+const setCookie = (request, value) => {
+ if (typeof value !== 'string') {
+ return;
+ }
+
+ const parsedCookies = cookie.parse(value);
+ request.cookies = { ...request.cookies, ...parsedCookies };
+ request.cookieString = request.cookieString ? request.cookieString + '; ' + value : value;
+
+ request.headers['Cookie'] = request.cookieString;
+};
+
+/**
+ * Set data (handles multiple -d flags by concatenating with &)
+ */
+const setData = (request, value) => {
+ request.data = request.data ? request.data + '&' + value : value;
+};
+
+/**
+ * Set JSON data
+ * JSON flag automatically sets Content-Type and converts GET/HEAD to POST
+ */
+const setJsonData = (request, value) => {
+ if (request.method === 'GET' || request.method === 'HEAD') {
+ request.method = 'POST';
+ }
+ request.headers['Content-Type'] = 'application/json';
+ // JSON data replaces existing data (don't append with &)
+ request.data = value;
+};
+
+/**
+ * Set form data
+ * Form data always sets method to POST and creates multipart uploads
+ */
+const setFormData = (request, value) => {
+ const formArray = Array.isArray(value) ? value : [value];
+ const multipartUploads = [];
+
+ formArray.forEach((field) => {
+ const upload = parseFormField(field);
+ if (upload) {
+ multipartUploads.push(upload);
+ }
+ });
+
+ request.multipartUploads = request.multipartUploads || [];
+ request.multipartUploads.push(...multipartUploads);
+ request.method = 'POST';
+};
+
+/**
+ * Parse a single form field
+ * Handles text fields, quoted values, and file uploads (@path)
+ */
+const parseFormField = (field) => {
+ const match = field.match(/^([^=]+)=(?:@?"([^"]*)"|@([^@]*)|([^@]*))?$/);
+
+ if (!match) return null;
+
+ const fieldName = match[1];
+ const fieldValue = match[2] || match[3] || match[4] || '';
+ const isFile = field.includes('@');
+
+ return {
+ name: fieldName,
+ value: fieldValue,
+ type: isFile ? 'file' : 'text',
+ enabled: true
+ };
+};
+
+/**
+ * Check if argument is a URL or URL fragment
+ */
+const isURLOrFragment = (arg) => {
+ return isURL(arg) || isURLFragment(arg);
+};
+
+/**
+ * Check if argument looks like a URL
+ */
+const isURL = (arg) => {
+ if (typeof arg !== 'string') {
+ return false;
+ }
+ return !!URL.parse(arg || '').host;
+};
+
+/**
+ * Check if argument looks like a URL fragment
+ * Handles shell-quote operator objects and query parameter patterns
+ */
+const isURLFragment = (arg) => {
+ if (arg && typeof arg === 'object' && arg.op === 'glob') {
+ return !!URL.parse(arg.pattern || '').host;
+ }
+ if (arg && typeof arg === 'object' && arg.op === '&') {
+ return true;
+ }
+ if (typeof arg === 'string') {
+ // check if arg is a query string containing key=value pair
+ return /^[^=]+=[^&]*$/.test(arg);
+ }
+ return false;
+};
+
+/**
+ * Set URL and related properties
+ * Handles URL concatenation for shell-quote fragments
+ */
+const setURL = (request, url) => {
+ const urlString = getUrlString(url);
+ if (!urlString) return;
+
+ const newUrl = request.url ? request.url + urlString : urlString;
+
+ const { url: formattedUrl, queries, urlWithoutQuery } = parseUrl(newUrl);
+
+ request.url = formattedUrl;
+ request.urlWithoutQuery = urlWithoutQuery;
+ request.queries = queries;
+};
+
+/**
+ * Convert URL fragment to string
+ * Handles shell-quote operator objects
+ */
+const getUrlString = (url) => {
+ if (typeof url === 'string') return url;
+ if (url?.op === 'glob') return url.pattern;
+ if (url?.op === '&') return '&';
+ return null;
+};
+
+/**
+ * Parse URL
+ * Returns formatted URL, URL without query, and queries
+ */
+const parseUrl = (url) => {
+ const parsedUrl = URL.parse(url);
+
+ const queries = parseQueryParams(parsedUrl.query, { decode: false });
+
+ let formattedUrl = URL.format(parsedUrl);
+ if (!url.endsWith('/') && formattedUrl.endsWith('/')) {
+ // Remove trailing slashes if origin url does not have a trailing slash
+ formattedUrl = formattedUrl.slice(0, -1);
+ }
+
+ const urlWithoutQuery = formattedUrl.split('?')[0];
+
+ return {
+ url: formattedUrl,
+ urlWithoutQuery,
+ queries
+ };
+};
+
+/**
+ * Convert data to query string
+ * Used when -G or --get flag is present to move data from body to URL
+ */
+const convertDataToQueryString = (request) => {
+ let url = request.url;
+
+ if (url.indexOf('?') < 0) {
+ url += '?';
+ } else if (!url.endsWith('&')) {
+ url += '&';
+ }
+
+ // append data to url as query string
+ url += request.data;
+
+ const { url: formattedUrl, queries } = parseUrl(url);
+
+ request.url = formattedUrl;
+ request.queries = queries;
+
+ return request;
+};
+
+/**
+ * Post-build processing of request
+ * Handles method conversion and query parameter processing
+ */
+const postBuildProcessRequest = (request) => {
+ if (request.isQuery && request.data) {
+ request = convertDataToQueryString(request);
+ // remove data and isQuery from request as they are no longer needed
+ delete request.data;
+ delete request.isQuery;
+
+ } else if (request.data) {
+ // if data is present, set method to POST unless the method is explicitly set
+ if (!request.method || request.method === 'HEAD') {
+ request.method = 'POST';
+ }
+ }
+
+ // if method is not set, set it to GET
+ if (!request.method) {
+ request.method = 'GET';
+ }
+
+ // bruno requires method to be lowercase
+ request.method = request.method.toLowerCase();
+
+ return request;
+};
+
+/**
+ * Clean up the final request object
+ */
+const cleanRequest = (request) => {
+ if (isEmpty(request.headers)) {
+ delete request.headers;
+ }
+
+ if (isEmpty(request.queries)) {
+ delete request.queries;
+ }
+
+ return request;
+};
+
+/**
+ * Clean up curl command
+ * Handles escape sequences, line continuations, and method concatenation
+ */
+const cleanCurlCommand = (curlCommand) => {
+ // Handle escape sequences
+ curlCommand = curlCommand.replace(/\$('.*')/g, (match, group) => group);
+ // Convert escaped single quotes to shell quote pattern
+ curlCommand = curlCommand.replace(/\\'(?!')/g, "'\\''");
+ // Fix concatenated HTTP methods
+ curlCommand = fixConcatenatedMethods(curlCommand);
+
+ return curlCommand.trim();
+};
+
+/**
+ * Fix concatenated HTTP methods
+ * Eg: Converts -XPOST to -X POST for proper parsing
+ */
+const fixConcatenatedMethods = (command) => {
+ const methodFixes = [
+ { from: / -XPOST/, to: ' -X POST' },
+ { from: / -XGET/, to: ' -X GET' },
+ { from: / -XPUT/, to: ' -X PUT' },
+ { from: / -XPATCH/, to: ' -X PATCH' },
+ { from: / -XDELETE/, to: ' -X DELETE' },
+ { from: / -XOPTIONS/, to: ' -X OPTIONS' },
+ { from: / -XHEAD/, to: ' -X HEAD' },
+ { from: / -Xnull/, to: ' ' }
+ ];
+
+ methodFixes.forEach(({ from, to }) => {
+ command = command.replace(from, to);
+ });
+
+ return command;
+};
+
export default parseCurlCommand;
diff --git a/packages/bruno-app/src/utils/curl/parse-curl.spec.js b/packages/bruno-app/src/utils/curl/parse-curl.spec.js
new file mode 100644
index 000000000..3ab767f62
--- /dev/null
+++ b/packages/bruno-app/src/utils/curl/parse-curl.spec.js
@@ -0,0 +1,755 @@
+const { describe, it, expect } = require('@jest/globals');
+import parseCurlCommand from './parse-curl';
+
+describe('parseCurlCommand', () => {
+ describe('Basic HTTP Methods', () => {
+ it('should parse simple GET request', () => {
+ const result = parseCurlCommand(`
+ curl https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ url: 'https://api.example.com/users',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+
+ it('should parse explicit POST method', () => {
+ const result = parseCurlCommand(`
+ curl -X POST https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ url: 'https://api.example.com/users',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+
+ it('should parse PUT method', () => {
+ const result = parseCurlCommand(`
+ curl -X PUT https://api.example.com/users/1
+ `);
+
+ expect(result).toEqual({
+ method: 'put',
+ url: 'https://api.example.com/users/1',
+ urlWithoutQuery: 'https://api.example.com/users/1'
+ });
+ });
+
+ it('should parse DELETE method', () => {
+ const result = parseCurlCommand(`
+ curl -X DELETE https://api.example.com/users/1
+ `);
+
+ expect(result).toEqual({
+ method: 'delete',
+ url: 'https://api.example.com/users/1',
+ urlWithoutQuery: 'https://api.example.com/users/1'
+ });
+ });
+
+ it('should parse HEAD method', () => {
+ const result = parseCurlCommand(`
+ curl -I https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'head',
+ url: 'https://api.example.com/users',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+ });
+
+ describe('Headers', () => {
+ it('should parse single header', () => {
+ const result = parseCurlCommand(`
+ curl --header "Content-Type: application/json" https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ headers: {
+ 'Content-Type': 'application/json'
+ },
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+
+ it('should parse multiple headers', () => {
+ const result = parseCurlCommand(`
+ curl -H "Content-Type: application/json" \
+ -H "Authorization: Bearer token" \
+ https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ headers: {
+ 'Content-Type': 'application/json',
+ 'Authorization': 'Bearer token'
+ },
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+
+ it('should parse user-agent header', () => {
+ const result = parseCurlCommand(`
+ curl -A "Custom User Agent" https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ headers: {
+ 'User-Agent': 'Custom User Agent'
+ },
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+ });
+
+ describe('Data and Request Body', () => {
+ it('should parse JSON data and change method to POST', () => {
+ const result = parseCurlCommand(`
+ curl -d '{"name": "John", "age": 30}' https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ data: '{"name": "John", "age": 30}',
+ url: 'https://api.example.com/users',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+
+ it('should parse post data', () => {
+ const result = parseCurlCommand(`
+ curl --data "name=John&age=30" https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ data: 'name=John&age=30',
+ url: 'https://api.example.com/users',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+
+ it('should handle multiple data flags', () => {
+ const result = parseCurlCommand(`
+ curl -d "name=John" \
+ -d "age=30" \
+ https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ data: 'name=John&age=30',
+ url: 'https://api.example.com/users',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+
+ it('should keep multiline data', () => {
+ const result = parseCurlCommand(`
+ curl -d '{"key": "some long message with line breaks
+
+
+ multiline"}' \
+ https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ data: `{"key": "some long message with line breaks
+
+
+ multiline"}`,
+ url: 'https://api.example.com/users',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+
+ it('should keep multi space data', () => {
+ const result = parseCurlCommand(`
+ curl -d '{"key": "some long spaced message"}' \
+ https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ data: '{"key": "some long spaced message"}',
+ url: 'https://api.example.com/users',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+
+ it('should parse binary data flag', () => {
+ const result = parseCurlCommand(`
+ curl --data-binary "@/path/to/file" https://api.example.com/upload
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ data: '@/path/to/file',
+ isDataBinary: true,
+ url: 'https://api.example.com/upload',
+ urlWithoutQuery: 'https://api.example.com/upload'
+ });
+ });
+
+ it('should parse raw data flag', () => {
+ const result = parseCurlCommand(`
+ curl --data-raw '{"raw": "data"}' https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ data: '{"raw": "data"}',
+ isDataRaw: true,
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+ });
+
+ describe('Authentication', () => {
+ it('should parse basic authentication', () => {
+ const result = parseCurlCommand(`
+ curl -u "username:password" https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ auth: {
+ mode: 'basic',
+ basic: {
+ username: 'username',
+ password: 'password'
+ }
+ },
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+
+ it('should handle username without password', () => {
+ const result = parseCurlCommand(`
+ curl --user "username" https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ auth: {
+ mode: 'basic',
+ basic: {
+ username: 'username',
+ password: ''
+ }
+ },
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+ });
+
+ describe('Form Data', () => {
+ it('should parse form data with text fields', () => {
+ const result = parseCurlCommand(`
+ curl -F "name=John" \
+ -F "age=30" \
+ https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ multipartUploads: [
+ { name: 'name', value: 'John', type: 'text', enabled: true },
+ { name: 'age', value: '30', type: 'text', enabled: true }
+ ],
+ url: 'https://api.example.com/users',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+
+ it('should parse form data with file uploads', () => {
+ const result = parseCurlCommand(`
+ curl --form "file=@/path/to/file.txt" https://api.example.com/upload
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ multipartUploads: [
+ { name: 'file', value: '/path/to/file.txt', type: 'file', enabled: true }
+ ],
+ url: 'https://api.example.com/upload',
+ urlWithoutQuery: 'https://api.example.com/upload'
+ });
+ });
+ });
+
+ describe('Cookie', () => {
+ it('should handle cookie flag', () => {
+ const result = parseCurlCommand(`
+ curl -b "session=abc123" https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ headers: {
+ 'Cookie': 'session=abc123'
+ },
+ cookieString: "session=abc123",
+ cookies: {
+ session: 'abc123'
+ },
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+
+ it('should handle cookie flag with multiple cookies', () => {
+ const result = parseCurlCommand(`
+ curl -b "session=abc123; user=john" https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ headers: {
+ 'Cookie': 'session=abc123; user=john'
+ },
+ cookieString: "session=abc123; user=john",
+ cookies: {
+ session: 'abc123',
+ user: 'john'
+ },
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+
+ it('should handle multiple cookie flags', () => {
+ const result = parseCurlCommand(`
+ curl -b "session=abc123" -b "user=john" https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ headers: {
+ 'Cookie': 'session=abc123; user=john'
+ },
+ cookieString: "session=abc123; user=john",
+ cookies: {
+ session: 'abc123',
+ user: 'john'
+ },
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+
+ it('should handle complex cookie string', () => {
+ const result = parseCurlCommand(`
+ curl -b "session=abc123; user=john; path=/; domain=example.com; expires=Thu, 01 Jan 1970 00:00:00 GMT; secure; HttpOnly" \
+ https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ headers: {
+ 'Cookie': 'session=abc123; user=john; path=/; domain=example.com; expires=Thu, 01 Jan 1970 00:00:00 GMT; secure; HttpOnly'
+ },
+ cookieString: "session=abc123; user=john; path=/; domain=example.com; expires=Thu, 01 Jan 1970 00:00:00 GMT; secure; HttpOnly",
+ cookies: {
+ session: 'abc123',
+ user: 'john',
+ path: '/',
+ domain: 'example.com',
+ expires: 'Thu, 01 Jan 1970 00:00:00 GMT',
+ },
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+ });
+
+ describe('Shell Quote Handling', () => {
+ it(`should handle shell quote patterns ('\'' => \')`, () => {
+ const result = parseCurlCommand(`
+ curl -d '{"name": "John\'\\'\'s data"}' https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ data: '{"name": "John\'s data"}',
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+
+ it('should handle complex escaped quotes', () => {
+ const result = parseCurlCommand(`
+ curl -d '{"message": "Don\\'t stop believing"}' https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ data: '{"message": "Don\'t stop believing"}',
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+ });
+
+ describe('URL Handling', () => {
+ it('should parse URLs with query parameters', () => {
+ const result = parseCurlCommand(`
+ curl https://api.example.com/users?page=1&limit=10&sort=asc
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ queries: [
+ { name: 'page', value: '1' },
+ { name: 'limit', value: '10' },
+ { name: 'sort', value: 'asc' }
+ ],
+ url: 'https://api.example.com/users?page=1&limit=10&sort=asc',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+
+ it('should handle URLs with paths', () => {
+ const result = parseCurlCommand(`
+ curl https://api.example.com/v1/users/123
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ url: 'https://api.example.com/v1/users/123',
+ urlWithoutQuery: 'https://api.example.com/v1/users/123'
+ });
+ });
+ });
+
+ describe('Edge Cases', () => {
+ it('should handle compressed flag', () => {
+ const result = parseCurlCommand(`
+ curl --compressed https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ headers: {
+ 'Accept-Encoding': 'deflate, gzip'
+ },
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+
+ it('should handle concatenated HTTP methods', () => {
+ const result = parseCurlCommand(`
+ curl -XPOST https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ url: 'https://api.example.com/users',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+
+ it('should handle newlines and continuations', () => {
+ const result = parseCurlCommand(`
+ curl -H "Content-Type: application/json" \
+ -d '{"name": "John"}' \
+ https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ headers: {
+ 'Content-Type': 'application/json'
+ },
+ data: '{"name": "John"}',
+ url: 'https://api.example.com/users',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+ });
+
+ describe('Complex Examples', () => {
+ it('should parse a complex curl command with multiple features', () => {
+ const result = parseCurlCommand(`
+ curl -X POST \
+ -H "Content-Type: application/json" \
+ -H "Authorization: Bearer token123" \
+ -H "X-Custom-Header: custom header" \
+ -d '{"name": "John\\'s data", "email": "john@example.com", "message": "Don\\'t stop believing!", "path": "/home/user/file.txt", "json": {"nested": "value", "array": [1, 2, 3]}}' \
+ -u "api_user:api_pass" \
+ --compressed \
+ https://api.example.com/v1/users?param1=value1¶m2=custom+param
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ headers: {
+ 'Content-Type': 'application/json',
+ 'Authorization': 'Bearer token123',
+ 'X-Custom-Header': 'custom header',
+ 'Accept-Encoding': 'deflate, gzip'
+ },
+ data: '{"name": "John\'s data", "email": "john@example.com", "message": "Don\'t stop believing!", "path": "/home/user/file.txt", "json": {"nested": "value", "array": [1, 2, 3]}}',
+ auth: {
+ mode: 'basic',
+ basic: {
+ username: 'api_user',
+ password: 'api_pass'
+ }
+ },
+ queries: [
+ { name: 'param1', value: 'value1' },
+ { name: 'param2', value: 'custom+param' }
+ ],
+ url: 'https://api.example.com/v1/users?param1=value1¶m2=custom+param',
+ urlWithoutQuery: 'https://api.example.com/v1/users'
+ });
+ });
+ });
+
+ describe('curl command with complex escape characters', () => {
+ it('should parse a curl command with complex escape characters', () => {
+ const result = parseCurlCommand(`
+ curl -X POST \
+ -H "Content-Type: application/json" \
+ -H "Authorization: Bearer token123" \
+ -d '{"name": "John\\'s data", "email": "john@example.com"}' \
+ -u "api_user:api_pass" \
+ --compressed \
+ https://api.example.com/v1/users
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ headers: {
+ 'Content-Type': 'application/json',
+ 'Authorization': 'Bearer token123',
+ 'Accept-Encoding': 'deflate, gzip'
+ },
+ data: '{"name": "John\'s data", "email": "john@example.com"}',
+ auth: {
+ mode: 'basic',
+ basic: {
+ username: 'api_user',
+ password: 'api_pass'
+ }
+ },
+ url: 'https://api.example.com/v1/users',
+ urlWithoutQuery: 'https://api.example.com/v1/users'
+ });
+ });
+ });
+
+ describe('JSON Flag', () => {
+ it('should handle basic JSON request', () => {
+ const result = parseCurlCommand(`
+ curl --json '{"name": "John Doe", "email": "john@example.com"}' \
+ https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ headers: {
+ 'Content-Type': 'application/json'
+ },
+ data: '{"name": "John Doe", "email": "john@example.com"}',
+ url: 'https://api.example.com/users',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+
+ it('should handle JSON with authentication headers', () => {
+ const result = parseCurlCommand(`
+ curl --json '{"title": "New Post", "content": "Post content"}' \
+ -H "Authorization: Bearer token123" \
+ https://api.example.com/posts
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ headers: {
+ 'Content-Type': 'application/json',
+ 'Authorization': 'Bearer token123'
+ },
+ data: '{"title": "New Post", "content": "Post content"}',
+ url: 'https://api.example.com/posts',
+ urlWithoutQuery: 'https://api.example.com/posts'
+ });
+ });
+
+ it('should handle complex JSON data', () => {
+ const result = parseCurlCommand(`
+ curl --json '{"user": {"name": "Jane", "email": "jane@example.com"}, "metadata": {"source": "web"}}' \
+ https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ headers: {
+ 'Content-Type': 'application/json'
+ },
+ data: '{"user": {"name": "Jane", "email": "jane@example.com"}, "metadata": {"source": "web"}}',
+ url: 'https://api.example.com/users',
+ urlWithoutQuery: 'https://api.example.com/users'
+ });
+ });
+
+ it('should handle JSON with escaped quotes', () => {
+ const result = parseCurlCommand(`
+ curl --json '{"message": "Don\\'t stop believing!", "user": "John\\'s account"}' \
+ https://api.example.com/messages
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ headers: {
+ 'Content-Type': 'application/json'
+ },
+ data: '{"message": "Don\'t stop believing!", "user": "John\'s account"}',
+ url: 'https://api.example.com/messages',
+ urlWithoutQuery: 'https://api.example.com/messages'
+ });
+ });
+
+ it('should handle JSON with arrays and nested objects', () => {
+ const result = parseCurlCommand(`
+ curl --json '{"items": [{"id": 1, "name": "Item 1"}, {"id": 2, "name": "Item 2"}], "total": 2}' \
+ https://api.example.com/orders
+ `);
+
+ expect(result).toEqual({
+ method: 'post',
+ headers: {
+ 'Content-Type': 'application/json'
+ },
+ data: '{"items": [{"id": 1, "name": "Item 1"}, {"id": 2, "name": "Item 2"}], "total": 2}',
+ url: 'https://api.example.com/orders',
+ urlWithoutQuery: 'https://api.example.com/orders'
+ });
+ });
+
+ it('should handle JSON with custom method', () => {
+ const result = parseCurlCommand(`
+ curl -X PUT \
+ --json '{"status": "completed", "updated_at": "2024-01-15T10:30:00Z"}' \
+ https://api.example.com/tasks/123
+ `);
+
+ expect(result).toEqual({
+ method: 'put',
+ headers: {
+ 'Content-Type': 'application/json'
+ },
+ data: '{"status": "completed", "updated_at": "2024-01-15T10:30:00Z"}',
+ url: 'https://api.example.com/tasks/123',
+ urlWithoutQuery: 'https://api.example.com/tasks/123'
+ });
+ });
+ });
+
+ describe('Insecure Flag', () => {
+ it('should handle -k flag', () => {
+ const result = parseCurlCommand(`
+ curl -k https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ insecure: true,
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+
+ it('should handle --insecure flag', () => {
+ const result = parseCurlCommand(`
+ curl --insecure https://api.example.com
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ insecure: true,
+ url: 'https://api.example.com',
+ urlWithoutQuery: 'https://api.example.com'
+ });
+ });
+ });
+
+ describe('Query Flag', () => {
+ it('should handle -G flag to convert POST data to GET query parameters', () => {
+ const result = parseCurlCommand(`
+ curl -G -d "name=John" -d "age=30" https://api.example.com/users
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ url: 'https://api.example.com/users?name=John&age=30',
+ urlWithoutQuery: 'https://api.example.com/users',
+ queries: [
+ { name: 'name', value: 'John' },
+ { name: 'age', value: '30' }
+ ]
+ });
+ });
+
+ it('should handle -G flag with --data-urlencode', () => {
+ const result = parseCurlCommand(`
+ curl -G --data-urlencode "name=John Doe" \
+ --data-urlencode "email=john@example.com" \
+ --data-urlencode "hello" \
+ https://api.example.com/users?test=urlquery&hello
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ url: 'https://api.example.com/users?test=urlquery&name=John%20Doe&email=john@example.com&hello',
+ urlWithoutQuery: 'https://api.example.com/users',
+ queries: [
+ { name: 'test', value: 'urlquery' },
+ { name: 'name', value: 'John%20Doe' },
+ { name: 'email', value: 'john@example.com' },
+ { name: 'hello', value: '' }
+ ]
+ });
+ });
+
+ it('should handle -G flag with complex data', () => {
+ const result = parseCurlCommand(`
+ curl -G -d "search=test+query" \
+ -d "filter=active" \
+ -d "sort=name" \
+ -d "page=1" \
+ https://api.example.com/search
+ `);
+
+ expect(result).toEqual({
+ method: 'get',
+ url: 'https://api.example.com/search?search=test+query&filter=active&sort=name&page=1',
+ urlWithoutQuery: 'https://api.example.com/search',
+ queries: [
+ { name: 'search', value: 'test+query' },
+ { name: 'filter', value: 'active' },
+ { name: 'sort', value: 'name' },
+ { name: 'page', value: '1' }
+ ]
+ });
+ });
+ });
+});
diff --git a/packages/bruno-app/src/utils/environments.js b/packages/bruno-app/src/utils/environments.js
new file mode 100644
index 000000000..50fcfcdf7
--- /dev/null
+++ b/packages/bruno-app/src/utils/environments.js
@@ -0,0 +1,31 @@
+const isPersistableEnvVarForMerge = (persistedNames) => (v) => {
+ return !v?.ephemeral || v?.persistedValue !== undefined || (v?.name && persistedNames.has(v.name));
+};
+
+const toPersistedEnvVarForMerge = (persistedNames) => (v) => {
+ const { ephemeral, persistedValue, ...rest } = v || {};
+ if (v?.ephemeral && persistedValue !== undefined && !(v?.name && persistedNames.has(v.name))) {
+ return { ...rest, value: persistedValue };
+ }
+ return rest;
+};
+
+const toPersistedEnvVarForSave = (v) => {
+ const { ephemeral, persistedValue, ...rest } = v || {};
+ return v?.ephemeral ? (persistedValue !== undefined ? { ...rest, value: persistedValue } : rest) : rest;
+};
+
+/*
+ High-level builder for persisted variables
+ - mode 'save': write what the user sees
+ - mode 'merge': write only allowed vars (non-ephemeral, ephemerals with persistedValue, or explicitly persisted this run)
+*/
+export const buildPersistedEnvVariables = (variables, { mode, persistedNames } = {}) => {
+ const src = Array.isArray(variables) ? variables : [];
+ if (mode === 'merge') {
+ const names = persistedNames instanceof Set ? persistedNames : new Set();
+ return src.filter(isPersistableEnvVarForMerge(names)).map(toPersistedEnvVarForMerge(names));
+ }
+ // default to save mode
+ return src.map(toPersistedEnvVarForSave);
+};
diff --git a/packages/bruno-app/src/utils/exporters/postman-collection.js b/packages/bruno-app/src/utils/exporters/postman-collection.js
index 7bcd229c1..65fc7e1ca 100644
--- a/packages/bruno-app/src/utils/exporters/postman-collection.js
+++ b/packages/bruno-app/src/utils/exporters/postman-collection.js
@@ -1,339 +1,9 @@
-import map from 'lodash/map';
import * as FileSaver from 'file-saver';
-import { deleteSecretsInEnvs, deleteUidsInEnvs, deleteUidsInItems } from '../collections/export';
-
-/**
- * Transforms a given URL string into an object representing the protocol, host, path, query, and variables.
- *
- * @param {string} url - The raw URL to be transformed.
- * @param {Object} params - The params object.
- * @returns {Object|null} An object containing the URL's protocol, host, path, query, and variables, or {} if an error occurs.
- */
-export const transformUrl = (url, params) => {
- if (typeof url !== 'string' || !url.trim()) {
- throw new Error("Invalid URL input");
- }
-
- const urlRegexPatterns = {
- protocolAndRestSeparator: /:\/\//,
- hostAndPathSeparator: /\/(.+)/,
- domainSegmentSeparator: /\./,
- pathSegmentSeparator: /\//,
- queryStringSeparator: /\?/
- };
-
- const postmanUrl = { raw: url };
-
- /**
- * Splits a URL into its protocol, host and path.
- *
- * @param {string} url - The URL to be split.
- * @returns {Object} An object containing the protocol and the raw host/path string.
- */
- const splitUrl = (url) => {
- const urlParts = url.split(urlRegexPatterns.protocolAndRestSeparator);
- if (urlParts.length === 1) {
- return { protocol: '', rawHostAndPath: urlParts[0] };
- } else if (urlParts.length === 2) {
- const [hostAndPath, _] = urlParts[1].split(urlRegexPatterns.queryStringSeparator);
- return { protocol: urlParts[0], rawHostAndPath: hostAndPath };
- } else {
- throw new Error(`Invalid URL format: ${url}`);
- }
- };
-
- /**
- * Splits the host and path from a raw host/path string.
- *
- * @param {string} rawHostAndPath - The raw host and path string to be split.
- * @returns {Object} An object containing the host and path.
- */
- const splitHostAndPath = (rawHostAndPath) => {
- const [host, path = ''] = rawHostAndPath.split(urlRegexPatterns.hostAndPathSeparator);
- return { host, path };
- };
-
- try {
- const { protocol, rawHostAndPath } = splitUrl(url);
- postmanUrl.protocol = protocol;
-
- const { host, path } = splitHostAndPath(rawHostAndPath);
- postmanUrl.host = host ? host.split(urlRegexPatterns.domainSegmentSeparator) : [];
- postmanUrl.path = path ? path.split(urlRegexPatterns.pathSegmentSeparator) : [];
- } catch (error) {
- console.error(error.message);
- return {};
- }
-
- // Construct query params.
- postmanUrl.query = params
- .filter((param) => param.type === 'query')
- .map(({ name, value, description }) => ({ key: name, value, description }));
-
- // Construct path params.
- postmanUrl.variable = params
- .filter((param) => param.type === 'path')
- .map(({ name, value, description }) => ({ key: name, value, description }));
-
- return postmanUrl;
-};
-
-/**
- * Collapses multiple consecutive slashes (`//`) into a single slash, while skipping the protocol (e.g., `http://` or `https://`).
- *
- * @param {String} url - A URL string
- * @returns {String} The sanitized URL
- *
- */
-const collapseDuplicateSlashes = (url) => {
- return url.replace(/(? {
- let sanitizedUrl = collapseDuplicateSlashes(url.replace(/\\/g, '//'));
- return sanitizedUrl;
-};
+import { brunoToPostman } from '@usebruno/converters';
export const exportCollection = (collection) => {
- delete collection.uid;
- delete collection.processEnvVariables;
- deleteUidsInItems(collection.items);
- deleteUidsInEnvs(collection.environments);
- deleteSecretsInEnvs(collection.environments);
- const generateInfoSection = () => {
- return {
- name: collection.name,
- description: collection.root?.docs,
- schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
- };
- };
-
- const generateCollectionVars = (collection) => {
- const pattern = /{{[^{}]+}}/g;
- let listOfVars = [];
-
- const findOccurrences = (obj, results) => {
- if (typeof obj === 'object') {
- if (Array.isArray(obj)) {
- obj.forEach((item) => findOccurrences(item, results));
- } else {
- for (const key in obj) {
- findOccurrences(obj[key], results);
- }
- }
- } else if (typeof obj === 'string') {
- obj.replace(pattern, (match) => {
- results.push(match.replace(/{{|}}/g, ''));
- });
- }
- };
-
- findOccurrences(collection, listOfVars);
-
- const finalArrayOfVars = [...new Set(listOfVars)];
-
- return finalArrayOfVars.map((variable) => ({
- key: variable,
- value: '',
- type: 'default'
- }));
- };
-
- const generateEventSection = (item) => {
- const eventArray = [];
- if (item?.request?.tests?.length) {
- eventArray.push({
- listen: 'test',
- script: {
- exec: item.request.tests.split('\n')
- // type: 'text/javascript'
- }
- });
- }
- if (item?.request?.script?.req) {
- eventArray.push({
- listen: 'prerequest',
- script: {
- exec: item.request.script.req.split('\n')
- // type: 'text/javascript'
- }
- });
- }
- return eventArray;
- };
-
- const generateHeaders = (headersArray) => {
- return map(headersArray, (item) => {
- return {
- key: item.name,
- value: item.value,
- disabled: !item.enabled,
- type: 'default'
- };
- });
- };
-
- const generateBody = (body) => {
- switch (body.mode) {
- case 'formUrlEncoded':
- return {
- mode: 'urlencoded',
- urlencoded: map(body.formUrlEncoded, (bodyItem) => {
- return {
- key: bodyItem.name,
- value: bodyItem.value,
- disabled: !bodyItem.enabled,
- type: 'default'
- };
- })
- };
- case 'multipartForm':
- return {
- mode: 'formdata',
- formdata: map(body.multipartForm, (bodyItem) => {
- return {
- key: bodyItem.name,
- value: bodyItem.value,
- disabled: !bodyItem.enabled,
- type: 'default'
- };
- })
- };
- case 'json':
- return {
- mode: 'raw',
- raw: body.json,
- options: {
- raw: {
- language: 'json'
- }
- }
- };
- case 'xml':
- return {
- mode: 'raw',
- raw: body.xml,
- options: {
- raw: {
- language: 'xml'
- }
- }
- };
- case 'text':
- return {
- mode: 'raw',
- raw: body.text,
- options: {
- raw: {
- language: 'text'
- }
- }
- };
- case 'graphql':
- return {
- mode: 'graphql',
- graphql: body.graphql
- };
- }
- };
-
- const generateAuth = (itemAuth) => {
- switch (itemAuth?.mode) {
- case 'bearer':
- return {
- type: 'bearer',
- bearer: {
- key: 'token',
- value: itemAuth.bearer.token,
- type: 'string'
- }
- };
- case 'basic': {
- return {
- type: 'basic',
- basic: [
- {
- key: 'password',
- value: itemAuth.basic.password,
- type: 'string'
- },
- {
- key: 'username',
- value: itemAuth.basic.username,
- type: 'string'
- }
- ]
- };
- }
- case 'apikey': {
- return {
- type: 'apikey',
- apikey: [
- {
- key: 'key',
- value: itemAuth.apikey.key,
- type: 'string'
- },
- {
- key: 'value',
- value: itemAuth.apikey.value,
- type: 'string'
- }
- ]
- };
- }
- default: {
- return {
- type: 'noauth'
- };
- }
- }
- };
-
- const generateRequestSection = (itemRequest) => {
- const requestObject = {
- method: itemRequest.method,
- header: generateHeaders(itemRequest.headers),
- auth: generateAuth(itemRequest.auth),
- description: itemRequest.docs,
- // We sanitize the URL to make sure it's in the right format before passing it to the transformUrl func. This means changing backslashes to forward slashes and reducing multiple slashes to a single one, except in the protocol part.
- url: transformUrl(sanitizeUrl(itemRequest.url), itemRequest.params)
- };
-
- if (itemRequest.body.mode !== 'none') {
- requestObject.body = generateBody(itemRequest.body);
- }
- return requestObject;
- };
-
- const generateItemSection = (itemsArray) => {
- return map(itemsArray, (item) => {
- if (item.type === 'folder') {
- return {
- name: item.name,
- item: item.items.length ? generateItemSection(item.items) : []
- };
- } else {
- return {
- name: item.name,
- event: generateEventSection(item),
- request: generateRequestSection(item.request)
- };
- }
- });
- };
- const collectionToExport = {};
- collectionToExport.info = generateInfoSection();
- collectionToExport.item = generateItemSection(collection.items);
- collectionToExport.variable = generateCollectionVars(collection);
+ const collectionToExport = brunoToPostman(collection);
const fileName = `${collection.name}.json`;
const fileBlob = new Blob([JSON.stringify(collectionToExport, null, 2)], { type: 'application/json' });
diff --git a/packages/bruno-app/src/utils/exporters/postman-collection.spec.js b/packages/bruno-app/src/utils/exporters/postman-collection.spec.js
deleted file mode 100644
index 23c6690cc..000000000
--- a/packages/bruno-app/src/utils/exporters/postman-collection.spec.js
+++ /dev/null
@@ -1,81 +0,0 @@
-const { sanitizeUrl, transformUrl } = require('./postman-collection');
-
-describe('transformUrl', () => {
- it('should handle basic URL with path variables', () => {
- const url = 'https://example.com/{{username}}/api/resource/:id';
- const params = [
- { name: 'id', value: '123', type: 'path' },
- ];
-
- const result = transformUrl(url, params);
-
- expect(result).toEqual({
- raw: 'https://example.com/{{username}}/api/resource/:id',
- protocol: 'https',
- host: ['example', 'com'],
- path: ['{{username}}', 'api', 'resource', ':id'],
- query: [],
- variable: [
- { key: 'id', value: '123' },
- ]
- });
- });
-
- it('should handle URL with query parameters', () => {
- const url = 'https://example.com/api/resource?limit=10&offset=20';
- const params = [
- { name: 'limit', value: '10', type: 'query' },
- { name: 'offset', value: '20', type: 'query' }
- ];
-
- const result = transformUrl(url, params);
-
- expect(result).toEqual({
- raw: 'https://example.com/api/resource?limit=10&offset=20',
- protocol: 'https',
- host: ['example', 'com'],
- path: ['api', 'resource'],
- query: [
- { key: 'limit', value: '10' },
- { key: 'offset', value: '20' }
- ],
- variable: []
- });
- });
-
- it('should handle URL without protocol', () => {
- const url = 'example.com/api/resource';
- const params = [];
-
- const result = transformUrl(url, params);
-
- expect(result).toEqual({
- raw: 'example.com/api/resource',
- protocol: '',
- host: ['example', 'com'],
- path: ['api', 'resource'],
- query: [],
- variable: []
- });
- });
-});
-
-describe('sanitizeUrl', () => {
- it('should replace backslashes with slashes', () => {
- const input = 'http:\\\\example.com\\path\\to\\file';
- const expected = 'http://example.com/path/to/file';
- expect(sanitizeUrl(input)).toBe(expected);
- });
-
- it('should collapse multiple slashes into a single slash', () => {
- const input = 'http://example.com//path///to////file';
- const expected = 'http://example.com/path/to/file';
- expect(sanitizeUrl(input)).toBe(expected);
- });
-
- it('should handle URLs with mixed slashes', () => {
- const input = 'http:\\example.com//path\\to//file';
- const expected = 'http://example.com/path/to/file';
- expect(sanitizeUrl(input)).toBe(expected);
- });
-})
diff --git a/packages/bruno-app/src/utils/filesystem.js b/packages/bruno-app/src/utils/filesystem.js
new file mode 100644
index 000000000..a3ec2acaa
--- /dev/null
+++ b/packages/bruno-app/src/utils/filesystem.js
@@ -0,0 +1,33 @@
+/**
+ * Filesystem utilities for the renderer process
+ * These functions communicate with the main process via IPC
+ */
+
+/**
+ * Check if a file exists
+ * @param {string} filePath - The file path to check
+ * @returns {Promise} - True if file exists, false otherwise
+ */
+export const existsSync = async (filePath) => {
+ try {
+ return await window?.ipcRenderer?.invoke('renderer:exists-sync', filePath);
+ } catch (error) {
+ console.error('Error checking if file exists:', error);
+ return false;
+ }
+};
+
+/**
+ * Resolve a relative path against a base path
+ * @param {string} relativePath - The relative path to resolve
+ * @param {string} basePath - The base path to resolve against
+ * @returns {Promise} - The resolved absolute path
+ */
+export const resolvePath = async (relativePath, basePath) => {
+ try {
+ return await window?.ipcRenderer?.invoke('renderer:resolve-path', relativePath, basePath);
+ } catch (error) {
+ console.error('Error resolving path:', error);
+ return relativePath;
+ }
+};
\ No newline at end of file
diff --git a/packages/bruno-app/src/utils/importers/bruno-collection.js b/packages/bruno-app/src/utils/importers/bruno-collection.js
index d96802c39..b6327b41d 100644
--- a/packages/bruno-app/src/utils/importers/bruno-collection.js
+++ b/packages/bruno-app/src/utils/importers/bruno-collection.js
@@ -1,43 +1,16 @@
-import fileDialog from 'file-dialog';
import { BrunoError } from 'utils/common/error';
import { validateSchema, transformItemsInCollection, updateUidsInCollection, hydrateSeqInCollection } from './common';
-const readFile = (files) => {
- return new Promise((resolve, reject) => {
- const fileReader = new FileReader();
- fileReader.onload = (e) => resolve(e.target.result);
- fileReader.onerror = (err) => reject(err);
- fileReader.readAsText(files[0]);
- });
-};
-const parseJsonCollection = (str) => {
- return new Promise((resolve, reject) => {
- try {
- let parsed = JSON.parse(str);
- return resolve(parsed);
- } catch (err) {
- console.log(err);
- reject(new BrunoError('Unable to parse the collection json file'));
- }
- });
+export const processBrunoCollection = async (jsonData) => {
+ try {
+ let collection = hydrateSeqInCollection(jsonData);
+ collection = updateUidsInCollection(collection);
+ collection = transformItemsInCollection(collection);
+ await validateSchema(collection);
+ return collection;
+ } catch (err) {
+ console.error('Error processing Bruno collection:', err);
+ throw new BrunoError('Import collection failed');
+ }
};
-
-const importCollection = () => {
- return new Promise((resolve, reject) => {
- fileDialog({ accept: 'application/json' })
- .then(readFile)
- .then(parseJsonCollection)
- .then(hydrateSeqInCollection)
- .then(updateUidsInCollection)
- .then(transformItemsInCollection)
- .then(validateSchema)
- .then((collection) => resolve({ collection }))
- .catch((err) => {
- console.log(err);
- reject(new BrunoError('Import collection failed'));
- });
- });
-};
-
-export default importCollection;
diff --git a/packages/bruno-app/src/utils/importers/common.js b/packages/bruno-app/src/utils/importers/common.js
index 88c4c7872..5d3b21d72 100644
--- a/packages/bruno-app/src/utils/importers/common.js
+++ b/packages/bruno-app/src/utils/importers/common.js
@@ -2,7 +2,7 @@ import each from 'lodash/each';
import get from 'lodash/get';
import cloneDeep from 'lodash/cloneDeep';
-import { uuid, normalizeFileName } from 'utils/common';
+import { uuid } from 'utils/common';
import { isItemARequest } from 'utils/collections';
import { collectionSchema } from '@usebruno/schema';
import { BrunoError } from 'utils/common/error';
@@ -35,6 +35,7 @@ export const updateUidsInCollection = (_collection) => {
each(get(item, 'request.assertions'), (a) => (a.uid = uuid()));
each(get(item, 'request.body.multipartForm'), (param) => (param.uid = uuid()));
each(get(item, 'request.body.formUrlEncoded'), (param) => (param.uid = uuid()));
+ each(get(item, 'request.body.file'), (param) => (param.uid = uuid()));
if (item.items && item.items.length) {
updateItemUids(item.items);
@@ -61,10 +62,9 @@ export const updateUidsInCollection = (_collection) => {
export const transformItemsInCollection = (collection) => {
const transformItems = (items = []) => {
each(items, (item) => {
- item.name = normalizeFileName(item.name);
-
- if (['http', 'graphql'].includes(item.type)) {
+ if (['http', 'graphql', 'grpc'].includes(item.type)) {
item.type = `${item.type}-request`;
+ const isGrpcRequest = item.type === 'grpc-request';
if (item.request.query) {
item.request.params = item.request.query.map((queryItem) => ({
@@ -74,6 +74,10 @@ export const transformItemsInCollection = (collection) => {
}));
}
+ if (isGrpcRequest) {
+ delete item.request.params;
+ }
+
delete item.request.query;
// from 5 feb 2024, multipartFormData needs to have a type
diff --git a/packages/bruno-app/src/utils/importers/insomnia-collection.js b/packages/bruno-app/src/utils/importers/insomnia-collection.js
index 74b56009d..5e41b5832 100644
--- a/packages/bruno-app/src/utils/importers/insomnia-collection.js
+++ b/packages/bruno-app/src/utils/importers/insomnia-collection.js
@@ -1,261 +1,26 @@
-import jsyaml from 'js-yaml';
-import each from 'lodash/each';
-import get from 'lodash/get';
-import fileDialog from 'file-dialog';
-import { uuid } from 'utils/common';
import { BrunoError } from 'utils/common/error';
-import { validateSchema, transformItemsInCollection, hydrateSeqInCollection } from './common';
+import { insomniaToBruno } from '@usebruno/converters';
-const readFile = (files) => {
- return new Promise((resolve, reject) => {
- const fileReader = new FileReader();
- fileReader.onload = (e) => {
- try {
- // try to load JSON
- const parsedData = JSON.parse(e.target.result);
- resolve(parsedData);
- } catch (jsonError) {
- // not a valid JSOn, try yaml
- try {
- const parsedData = jsyaml.load(e.target.result, { schema: jsyaml.CORE_SCHEMA });
- resolve(parsedData);
- } catch (yamlError) {
- console.error('Error parsing the file :', jsonError, yamlError);
- reject(new BrunoError('Import collection failed'));
- }
- }
- };
- fileReader.onerror = (err) => reject(err);
- fileReader.readAsText(files[0]);
- });
-};
-const parseGraphQL = (text) => {
+export const convertInsomniaToBruno = (data) => {
try {
- const graphql = JSON.parse(text);
-
- return {
- query: graphql.query,
- variables: JSON.stringify(graphql.variables, null, 2)
- };
- } catch (e) {
- return {
- query: '',
- variables: ''
- };
+ return insomniaToBruno(data);
+ } catch (err) {
+ console.error('Error converting Insomnia to Bruno:', err);
+ throw new BrunoError('Import collection failed: ' + err.message);
}
};
-const addSuffixToDuplicateName = (item, index, allItems) => {
- // Check if the request name already exist and if so add a number suffix
- const nameSuffix = allItems.reduce((nameSuffix, otherItem, otherIndex) => {
- if (otherItem.name === item.name && otherIndex < index) {
- nameSuffix++;
- }
- return nameSuffix;
- }, 0);
- return nameSuffix !== 0 ? `${item.name}_${nameSuffix}` : item.name;
-};
-
-const regexVariable = new RegExp('{{.*?}}', 'g');
-
-const normalizeVariables = (value) => {
- value = value || '';
- const variables = value.match(regexVariable) || [];
- each(variables, (variable) => {
- value = value.replace(variable, variable.replace('_.', '').replaceAll(' ', ''));
- });
- return value;
-};
-
-const transformInsomniaRequestItem = (request, index, allRequests) => {
- const name = addSuffixToDuplicateName(request, index, allRequests);
-
- const brunoRequestItem = {
- uid: uuid(),
- name,
- type: 'http-request',
- request: {
- url: request.url,
- method: request.method,
- auth: {
- mode: 'none',
- basic: null,
- bearer: null,
- digest: null
- },
- headers: [],
- params: [],
- body: {
- mode: 'none',
- json: null,
- text: null,
- xml: null,
- formUrlEncoded: [],
- multipartForm: []
- }
- }
- };
-
- each(request.headers, (header) => {
- brunoRequestItem.request.headers.push({
- uid: uuid(),
- name: header.name,
- value: header.value,
- description: header.description,
- enabled: !header.disabled
- });
- });
-
- each(request.parameters, (param) => {
- brunoRequestItem.request.params.push({
- uid: uuid(),
- name: param.name,
- value: param.value,
- description: param.description,
- type: 'query',
- enabled: !param.disabled
- });
- });
-
- each(request.pathParameters, (param) => {
- brunoRequestItem.request.params.push({
- uid: uuid(),
- name: param.name,
- value: param.value,
- description: '',
- type: 'path',
- enabled: true
- });
- });
-
- const authType = get(request, 'authentication.type', '');
-
- if (authType === 'basic') {
- brunoRequestItem.request.auth.mode = 'basic';
- brunoRequestItem.request.auth.basic = {
- username: normalizeVariables(get(request, 'authentication.username', '')),
- password: normalizeVariables(get(request, 'authentication.password', ''))
- };
- } else if (authType === 'bearer') {
- brunoRequestItem.request.auth.mode = 'bearer';
- brunoRequestItem.request.auth.bearer = {
- token: normalizeVariables(get(request, 'authentication.token', ''))
- };
+export const isInsomniaCollection = (data) => {
+ // Check for Insomnia v5 collection format – collection array must be present
+ if (typeof data.type === 'string' && data.type.startsWith('collection.insomnia.rest/5')) {
+ return Array.isArray(data.collection);
}
- const mimeType = get(request, 'body.mimeType', '').split(';')[0];
-
- if (mimeType === 'application/json') {
- brunoRequestItem.request.body.mode = 'json';
- brunoRequestItem.request.body.json = request.body.text;
- } else if (mimeType === 'application/x-www-form-urlencoded') {
- brunoRequestItem.request.body.mode = 'formUrlEncoded';
- each(request.body.params, (param) => {
- brunoRequestItem.request.body.formUrlEncoded.push({
- uid: uuid(),
- name: param.name,
- value: param.value,
- description: param.description,
- enabled: !param.disabled
- });
- });
- } else if (mimeType === 'multipart/form-data') {
- brunoRequestItem.request.body.mode = 'multipartForm';
- each(request.body.params, (param) => {
- brunoRequestItem.request.body.multipartForm.push({
- uid: uuid(),
- type: 'text',
- name: param.name,
- value: param.value,
- description: param.description,
- enabled: !param.disabled
- });
- });
- } else if (mimeType === 'text/plain') {
- brunoRequestItem.request.body.mode = 'text';
- brunoRequestItem.request.body.text = request.body.text;
- } else if (mimeType === 'text/xml' || mimeType === 'application/xml') {
- brunoRequestItem.request.body.mode = 'xml';
- brunoRequestItem.request.body.xml = request.body.text;
- } else if (mimeType === 'application/graphql') {
- brunoRequestItem.type = 'graphql-request';
- brunoRequestItem.request.body.mode = 'graphql';
- brunoRequestItem.request.body.graphql = parseGraphQL(request.body.text);
+ // Check for Insomnia v4 export format – must have __export_format and resources array
+ if (data._type === 'export') {
+ return Array.isArray(data.resources) && typeof data.__export_format === 'number';
}
- return brunoRequestItem;
+ return false;
};
-
-const parseInsomniaCollection = (data) => {
- const brunoCollection = {
- name: '',
- uid: uuid(),
- version: '1',
- items: [],
- environments: []
- };
-
- return new Promise((resolve, reject) => {
- try {
- const insomniaExport = data;
- const insomniaResources = get(insomniaExport, 'resources', []);
- const insomniaCollection = insomniaResources.find((resource) => resource._type === 'workspace');
-
- if (!insomniaCollection) {
- reject(new BrunoError('Collection not found inside Insomnia export'));
- }
-
- brunoCollection.name = insomniaCollection.name;
-
- const requestsAndFolders =
- insomniaResources.filter((resource) => resource._type === 'request' || resource._type === 'request_group') ||
- [];
-
- function createFolderStructure(resources, parentId = null) {
- const requestGroups =
- resources.filter((resource) => resource._type === 'request_group' && resource.parentId === parentId) || [];
- const requests = resources.filter((resource) => resource._type === 'request' && resource.parentId === parentId);
-
- const folders = requestGroups.map((folder, index, allFolder) => {
- const name = addSuffixToDuplicateName(folder, index, allFolder);
- const requests = resources.filter(
- (resource) => resource._type === 'request' && resource.parentId === folder._id
- );
-
- return {
- uid: uuid(),
- name,
- type: 'folder',
- items: createFolderStructure(resources, folder._id).concat(requests.map(transformInsomniaRequestItem))
- };
- });
-
- return folders.concat(requests.map(transformInsomniaRequestItem));
- }
-
- (brunoCollection.items = createFolderStructure(requestsAndFolders, insomniaCollection._id)),
- resolve(brunoCollection);
- } catch (err) {
- reject(new BrunoError('An error occurred while parsing the Insomnia collection'));
- }
- });
-};
-
-const importCollection = () => {
- return new Promise((resolve, reject) => {
- fileDialog({ accept: '.json, .yaml, .yml, application/json, application/yaml, application/x-yaml' })
- .then(readFile)
- .then(parseInsomniaCollection)
- .then(transformItemsInCollection)
- .then(hydrateSeqInCollection)
- .then(validateSchema)
- .then((collection) => resolve({ collection }))
- .catch((err) => {
- console.error(err);
- reject(new BrunoError('Import collection failed: ' + err.message));
- });
- });
-};
-
-export default importCollection;
diff --git a/packages/bruno-app/src/utils/importers/openapi-collection.js b/packages/bruno-app/src/utils/importers/openapi-collection.js
index d579402cd..5e619d97b 100644
--- a/packages/bruno-app/src/utils/importers/openapi-collection.js
+++ b/packages/bruno-app/src/utils/importers/openapi-collection.js
@@ -1,468 +1,27 @@
-import jsyaml from 'js-yaml';
-import each from 'lodash/each';
-import get from 'lodash/get';
-import fileDialog from 'file-dialog';
-import { uuid } from 'utils/common';
import { BrunoError } from 'utils/common/error';
-import { validateSchema, transformItemsInCollection, hydrateSeqInCollection } from './common';
+import { openApiToBruno } from '@usebruno/converters';
-const readFile = (files) => {
- return new Promise((resolve, reject) => {
- const fileReader = new FileReader();
- fileReader.onload = (e) => {
- try {
- // try to load JSON
- const parsedData = JSON.parse(e.target.result);
- resolve(parsedData);
- } catch (jsonError) {
- // not a valid JSOn, try yaml
- try {
- const parsedData = jsyaml.load(e.target.result);
- resolve(parsedData);
- } catch (yamlError) {
- console.error('Error parsing the file :', jsonError, yamlError);
- reject(new BrunoError('Import collection failed'));
- }
- }
- };
- fileReader.onerror = (err) => reject(err);
- fileReader.readAsText(files[0]);
- });
+export const convertOpenapiToBruno = (data) => {
+ try {
+ return openApiToBruno(data);
+ } catch (err) {
+ console.error('Error converting OpenAPI to Bruno:', err);
+ throw new BrunoError('Import collection failed: ' + err.message);
+ }
};
-const ensureUrl = (url) => {
- // emoving multiple slashes after the protocol if it exists, or after the beginning of the string otherwise
- return url.replace(/([^:])\/{2,}/g, '$1/');
+export const isOpenApiSpec = (data) => {
+ if (typeof data.info !== 'object' || data.info === null) {
+ return false;
+ }
+
+ if (typeof data.openapi === 'string' && data.openapi.trim().length) {
+ return true;
+ }
+
+ if (typeof data.swagger === 'string' && data.swagger.trim().length) {
+ return true;
+ }
+
+ return false;
};
-
-const buildEmptyJsonBody = (bodySchema) => {
- let _jsonBody = {};
- each(bodySchema.properties || {}, (prop, name) => {
- if (prop.type === 'object') {
- _jsonBody[name] = buildEmptyJsonBody(prop);
- } else if (prop.type === 'array') {
- if (prop.items && prop.items.type === 'object') {
- _jsonBody[name] = [buildEmptyJsonBody(prop.items)];
- } else {
- _jsonBody[name] = [];
- }
- } else {
- _jsonBody[name] = '';
- }
- });
- return _jsonBody;
-};
-
-const transformOpenapiRequestItem = (request) => {
- let _operationObject = request.operationObject;
-
- let operationName = _operationObject.summary || _operationObject.operationId || _operationObject.description;
- if (!operationName) {
- operationName = `${request.method} ${request.path}`;
- }
-
- // replace OpenAPI links in path by Bruno variables
- let path = request.path.replace(/{([a-zA-Z]+)}/g, `{{${_operationObject.operationId}_$1}}`);
-
- const brunoRequestItem = {
- uid: uuid(),
- name: operationName,
- type: 'http-request',
- request: {
- url: ensureUrl(request.global.server + path),
- method: request.method.toUpperCase(),
- auth: {
- mode: 'none',
- basic: null,
- bearer: null,
- digest: null
- },
- headers: [],
- params: [],
- body: {
- mode: 'none',
- json: null,
- text: null,
- xml: null,
- formUrlEncoded: [],
- multipartForm: []
- },
- script: {
- res: null
- }
- }
- };
-
- each(_operationObject.parameters || [], (param) => {
- if (param.in === 'query') {
- brunoRequestItem.request.params.push({
- uid: uuid(),
- name: param.name,
- value: '',
- description: param.description || '',
- enabled: param.required,
- type: 'query'
- });
- } else if (param.in === 'path') {
- brunoRequestItem.request.params.push({
- uid: uuid(),
- name: param.name,
- value: '',
- description: param.description || '',
- enabled: param.required,
- type: 'path'
- });
- } else if (param.in === 'header') {
- brunoRequestItem.request.headers.push({
- uid: uuid(),
- name: param.name,
- value: '',
- description: param.description || '',
- enabled: param.required
- });
- }
- });
-
- let auth;
- // allow operation override
- if (_operationObject.security && _operationObject.security.length > 0) {
- let schemeName = Object.keys(_operationObject.security[0])[0];
- auth = request.global.security.getScheme(schemeName);
- } else if (request.global.security.supported.length > 0) {
- auth = request.global.security.supported[0];
- }
-
- if (auth) {
- if (auth.type === 'http' && auth.scheme === 'basic') {
- brunoRequestItem.request.auth.mode = 'basic';
- brunoRequestItem.request.auth.basic = {
- username: '{{username}}',
- password: '{{password}}'
- };
- } else if (auth.type === 'http' && auth.scheme === 'bearer') {
- brunoRequestItem.request.auth.mode = 'bearer';
- brunoRequestItem.request.auth.bearer = {
- token: '{{token}}'
- };
- } else if (auth.type === 'apiKey' && auth.in === 'header') {
- brunoRequestItem.request.headers.push({
- uid: uuid(),
- name: auth.name,
- value: '{{apiKey}}',
- description: 'Authentication header',
- enabled: true
- });
- }
- }
-
- // TODO: handle allOf/anyOf/oneOf
- if (_operationObject.requestBody) {
- let content = get(_operationObject, 'requestBody.content', {});
- let mimeType = Object.keys(content)[0];
- let body = content[mimeType] || {};
- let bodySchema = body.schema;
- if (mimeType === 'application/json') {
- brunoRequestItem.request.body.mode = 'json';
- if (bodySchema && bodySchema.type === 'object') {
- let _jsonBody = buildEmptyJsonBody(bodySchema);
- brunoRequestItem.request.body.json = JSON.stringify(_jsonBody, null, 2);
- }
- if (bodySchema && bodySchema.type === 'array') {
- brunoRequestItem.request.body.json = JSON.stringify([buildEmptyJsonBody(bodySchema.items)], null, 2);
- }
- } else if (mimeType === 'application/x-www-form-urlencoded') {
- brunoRequestItem.request.body.mode = 'formUrlEncoded';
- if (bodySchema && bodySchema.type === 'object') {
- each(bodySchema.properties || {}, (prop, name) => {
- brunoRequestItem.request.body.formUrlEncoded.push({
- uid: uuid(),
- name: name,
- value: '',
- description: prop.description || '',
- enabled: true
- });
- });
- }
- } else if (mimeType === 'multipart/form-data') {
- brunoRequestItem.request.body.mode = 'multipartForm';
- if (bodySchema && bodySchema.type === 'object') {
- each(bodySchema.properties || {}, (prop, name) => {
- brunoRequestItem.request.body.multipartForm.push({
- uid: uuid(),
- type: 'text',
- name: name,
- value: '',
- description: prop.description || '',
- enabled: true
- });
- });
- }
- } else if (mimeType === 'text/plain') {
- brunoRequestItem.request.body.mode = 'text';
- brunoRequestItem.request.body.text = '';
- } else if (mimeType === 'text/xml') {
- brunoRequestItem.request.body.mode = 'xml';
- brunoRequestItem.request.body.xml = '';
- }
- }
-
- // build the extraction scripts from responses that have links
- // https://swagger.io/docs/specification/links/
- let script = [];
- each(_operationObject.responses || [], (response, responseStatus) => {
- if (Object.hasOwn(response, 'links')) {
- // only extract if the status code matches the response
- script.push(`if (res.status === ${responseStatus}) {`);
- each(response.links, (link) => {
- each(link.parameters || [], (expression, parameter) => {
- let value = openAPIRuntimeExpressionToScript(expression);
- script.push(` bru.setVar('${link.operationId}_${parameter}', ${value});`);
- });
- });
- script.push(`}`);
- }
- });
- if (script.length > 0) {
- brunoRequestItem.request.script.res = script.join('\n');
- }
-
- return brunoRequestItem;
-};
-
-const resolveRefs = (spec, components = spec?.components, visitedItems = new Set()) => {
- if (!spec || typeof spec !== 'object') {
- return spec;
- }
-
- if (Array.isArray(spec)) {
- return spec.map((item) => resolveRefs(item, components, visitedItems));
- }
-
- if ('$ref' in spec) {
- const refPath = spec.$ref;
-
- if (visitedItems.has(refPath)) {
- return spec;
- } else {
- visitedItems.add(refPath);
- }
-
- if (refPath.startsWith('#/components/')) {
- // Local reference within components
- const refKeys = refPath.replace('#/components/', '').split('/');
- let ref = components;
-
- for (const key of refKeys) {
- if (ref && ref[key]) {
- ref = ref[key];
- } else {
- // Handle invalid references gracefully?
- return spec;
- }
- }
-
- return resolveRefs(ref, components, visitedItems);
- } else {
- // Handle external references (not implemented here)
- // You would need to fetch the external reference and resolve it.
- // Example: Fetch and resolve an external reference from a URL.
- }
- }
-
- // Recursively resolve references in nested objects
- for (const prop in spec) {
- spec[prop] = resolveRefs(spec[prop], components, new Set(visitedItems));
- }
-
- return spec;
-};
-
-const groupRequestsByTags = (requests) => {
- let _groups = {};
- let ungrouped = [];
- each(requests, (request) => {
- let tags = request.operationObject.tags || [];
- if (tags.length > 0) {
- let tag = tags[0].trim(); // take first tag and trim whitespace
-
- if (tag) {
- if (!_groups[tag]) {
- _groups[tag] = [];
- }
- _groups[tag].push(request);
- } else {
- ungrouped.push(request);
- }
- } else {
- ungrouped.push(request);
- }
- });
-
- let groups = Object.keys(_groups).map((groupName) => {
- return {
- name: groupName,
- requests: _groups[groupName]
- };
- });
-
- return [groups, ungrouped];
-};
-
-const getDefaultUrl = (serverObject) => {
- let url = serverObject.url;
- if (serverObject.variables) {
- each(serverObject.variables, (variable, variableName) => {
- let sub = variable.default || (variable.enum ? variable.enum[0] : `{{${variableName}}}`);
- url = url.replace(`{${variableName}}`, sub);
- });
- }
- return url.endsWith('/') ? url.slice(0, -1) : url;
-};
-
-const getSecurity = (apiSpec) => {
- let defaultSchemes = apiSpec.security || [];
-
- let securitySchemes = get(apiSpec, 'components.securitySchemes', {});
- if (Object.keys(securitySchemes) === 0) {
- return {
- supported: []
- };
- }
-
- return {
- supported: defaultSchemes.map((scheme) => {
- var schemeName = Object.keys(scheme)[0];
- return securitySchemes[schemeName];
- }),
- schemes: securitySchemes,
- getScheme: (schemeName) => {
- return securitySchemes[schemeName];
- }
- };
-};
-
-const openAPIRuntimeExpressionToScript = (expression) => {
- // see https://swagger.io/docs/specification/links/#runtime-expressions
- if (expression === '$response.body') {
- return 'res.body';
- } else if (expression.startsWith('$response.body#')) {
- let pointer = expression.substring(15);
- // could use https://www.npmjs.com/package/json-pointer for better support
- return `res.body${pointer.replace('/', '.')}`;
- }
- return expression;
-};
-
-export const parseOpenApiCollection = (data) => {
- const brunoCollection = {
- name: '',
- uid: uuid(),
- version: '1',
- items: [],
- environments: []
- };
-
- return new Promise((resolve, reject) => {
- try {
- const collectionData = resolveRefs(data);
- if (!collectionData) {
- reject(new BrunoError('Invalid OpenAPI collection. Failed to resolve refs.'));
- return;
- }
-
- // Currently parsing of openapi spec is "do your best", that is
- // allows "invalid" openapi spec
-
- // Assumes v3 if not defined. v2 is not supported yet
- if (collectionData.openapi && !collectionData.openapi.startsWith('3')) {
- reject(new BrunoError('Only OpenAPI v3 is supported currently.'));
- return;
- }
-
- // TODO what if info.title not defined?
- brunoCollection.name = collectionData.info.title;
- let servers = collectionData.servers || [];
-
- // Create environments based on the servers
- servers.forEach((server, index) => {
- let baseUrl = getDefaultUrl(server);
- let environmentName = server.description ? server.description : `Environment ${index + 1}`;
-
- brunoCollection.environments.push({
- uid: uuid(),
- name: environmentName,
- variables: [
- {
- uid: uuid(),
- name: 'baseUrl',
- value: baseUrl,
- type: 'text',
- enabled: true,
- secret: false
- },
- ]
- });
- });
-
- let securityConfig = getSecurity(collectionData);
-
- let allRequests = Object.entries(collectionData.paths)
- .map(([path, methods]) => {
- return Object.entries(methods)
- .filter(([method, op]) => {
- return ['get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace'].includes(
- method.toLowerCase()
- );
- })
- .map(([method, operationObject]) => {
- return {
- method: method,
- path: path.replace(/{([^}]+)}/g, ':$1'), // Replace placeholders enclosed in curly braces with colons
- operationObject: operationObject,
- global: {
- server: '{{baseUrl}}',
- security: securityConfig
- }
- };
- });
- })
- .reduce((acc, val) => acc.concat(val), []); // flatten
-
- let [groups, ungroupedRequests] = groupRequestsByTags(allRequests);
- let brunoFolders = groups.map((group) => {
- return {
- uid: uuid(),
- name: group.name,
- type: 'folder',
- items: group.requests.map(transformOpenapiRequestItem)
- };
- });
-
- let ungroupedItems = ungroupedRequests.map(transformOpenapiRequestItem);
- let brunoCollectionItems = brunoFolders.concat(ungroupedItems);
- brunoCollection.items = brunoCollectionItems;
- resolve(brunoCollection);
- } catch (err) {
- console.error(err);
- reject(new BrunoError('An error occurred while parsing the OpenAPI collection'));
- }
- });
-};
-
-const importCollection = () => {
- return new Promise((resolve, reject) => {
- fileDialog({ accept: '.json, .yaml, .yml, application/json, application/yaml, application/x-yaml' })
- .then(readFile)
- .then(parseOpenApiCollection)
- .then(transformItemsInCollection)
- .then(hydrateSeqInCollection)
- .then(validateSchema)
- .then((collection) => resolve({ collection }))
- .catch((err) => {
- console.error(err);
- reject(new BrunoError('Import collection failed: ' + err.message));
- });
- });
-};
-
-export default importCollection;
diff --git a/packages/bruno-app/src/utils/importers/openapi-collection.spec.js b/packages/bruno-app/src/utils/importers/openapi-collection.spec.js
deleted file mode 100644
index 309221356..000000000
--- a/packages/bruno-app/src/utils/importers/openapi-collection.spec.js
+++ /dev/null
@@ -1,67 +0,0 @@
-import { parseOpenApiCollection } from './openapi-collection';
-import { uuid } from 'utils/common';
-
-jest.mock('utils/common');
-
-describe('openapi importer util functions', () => {
- afterEach(jest.clearAllMocks);
-
- it('should convert openapi object to bruno collection correctly', async () => {
- const input = {
- openapi: '3.0.3',
- info: {
- title: 'Sample API with Multiple Servers',
- description: 'API spec with multiple servers.',
- version: '1.0.0'
- },
- servers: [
- { url: 'https://api.example.com/v1', description: 'Production Server' },
- { url: 'https://staging-api.example.com/v1', description: 'Staging Server' },
- { url: 'http://localhost:3000/v1', description: 'Local Server' }
- ],
- paths: {
- '/users': {
- get: {
- summary: 'Get a list of users',
- parameters: [
- { name: 'page', in: 'query', required: false, schema: { type: 'integer' } },
- { name: 'limit', in: 'query', required: false, schema: { type: 'integer' } }
- ],
- responses: {
- '200': { description: 'A list of users' }
- }
- }
- }
- }
- };
-
- const expectedOutput = {
- name: 'Sample API with Multiple Servers',
- version: '1',
- items: [
- {
- name: 'Get a list of users',
- type: 'http-request',
- request: {
- url: '{{baseUrl}}/users',
- method: 'GET',
- params: [
- { name: 'page', value: '', enabled: false, type: 'query' },
- { name: 'limit', value: '', enabled: false, type: 'query' }
- ]
- }
- }
- ],
- environments: [
- { name: 'Production Server', variables: [{ name: 'baseUrl', value: 'https://api.example.com/v1' }] },
- { name: 'Staging Server', variables: [{ name: 'baseUrl', value: 'https://staging-api.example.com/v1' }] },
- { name: 'Local Server', variables: [{ name: 'baseUrl', value: 'http://localhost:3000/v1' }] }
- ]
- };
-
- const result = await parseOpenApiCollection(input);
-
- expect(result).toMatchObject(expectedOutput);
- expect(uuid).toHaveBeenCalledTimes(10);
- });
-});
diff --git a/packages/bruno-app/src/utils/importers/postman-collection.js b/packages/bruno-app/src/utils/importers/postman-collection.js
index b5a685e71..4622c2bb5 100644
--- a/packages/bruno-app/src/utils/importers/postman-collection.js
+++ b/packages/bruno-app/src/utils/importers/postman-collection.js
@@ -1,583 +1,41 @@
-import get from 'lodash/get';
import fileDialog from 'file-dialog';
-import { uuid } from 'utils/common';
import { BrunoError } from 'utils/common/error';
-import { validateSchema, transformItemsInCollection, hydrateSeqInCollection } from './common';
-import { postmanTranslation } from 'utils/importers/translators/postman_translation';
-import each from 'lodash/each';
+import { safeParseJSON } from 'utils/common/index';
const readFile = (files) => {
return new Promise((resolve, reject) => {
const fileReader = new FileReader();
- fileReader.onload = (e) => resolve(e.target.result);
+ fileReader.onload = (e) => resolve(safeParseJSON(e.target.result));
fileReader.onerror = (err) => reject(err);
fileReader.readAsText(files[0]);
});
};
-const parseGraphQLRequest = (graphqlSource) => {
- try {
- let queryResultObject = {
- query: '',
- variables: ''
- };
-
- if (typeof graphqlSource === 'string') {
- graphqlSource = JSON.parse(graphqlSource);
- }
-
- if (graphqlSource.hasOwnProperty('variables') && graphqlSource.variables !== '') {
- queryResultObject.variables = graphqlSource.variables;
- }
-
- if (graphqlSource.hasOwnProperty('query') && graphqlSource.query !== '') {
- queryResultObject.query = graphqlSource.query;
- }
-
- return queryResultObject;
- } catch (e) {
- return {
- query: '',
- variables: ''
- };
- }
-};
-
-const isItemAFolder = (item) => {
- return !item.request;
-};
-
-const convertV21Auth = (array) => {
- return array.reduce((accumulator, currentValue) => {
- accumulator[currentValue.key] = currentValue.value;
- return accumulator;
- }, {});
-};
-
-const constructUrlFromParts = (url) => {
- const { protocol = 'http', host, path, port, query, hash } = url || {};
- const hostStr = Array.isArray(host) ? host.filter(Boolean).join('.') : host || '';
- const pathStr = Array.isArray(path) ? path.filter(Boolean).join('/') : path || '';
- const portStr = port ? `:${port}` : '';
- const queryStr =
- query && Array.isArray(query) && query.length > 0
- ? `?${query
- .filter((q) => q.key)
- .map((q) => `${q.key}=${q.value || ''}`)
- .join('&')}`
- : '';
- const urlStr = `${protocol}://${hostStr}${portStr}${pathStr ? `/${pathStr}` : ''}${queryStr}`;
- return urlStr;
-};
-
-const constructUrl = (url) => {
- if (!url) return '';
-
- if (typeof url === 'string') {
- return url;
- }
-
- if (typeof url === 'object') {
- const { raw } = url;
-
- if (raw && typeof raw === 'string') {
- // If the raw URL contains url-fragments remove it
- if (raw.includes('#')) {
- return raw.split('#')[0]; // Returns the part of raw URL without the url-fragment part.
- }
- return raw;
- }
-
- // If no raw value exists, construct the URL from parts
- return constructUrlFromParts(url);
- }
-
- return '';
-};
-
-let translationLog = {};
-
-/* struct of translation log
- {
- [collectionName]: {
- script: [index1, index2],
- test: [index1, index2]
- }
- }
- */
-
-const pushTranslationLog = (type, index) => {
- if (!translationLog[i.name]) {
- translationLog[i.name] = {};
- }
- if (!translationLog[i.name][type]) {
- translationLog[i.name][type] = [];
- }
- translationLog[i.name][type].push(index + 1);
-};
-
-const importScriptsFromEvents = (events, requestObject, options, pushTranslationLog) => {
- events.forEach((event) => {
- if (event.script && event.script.exec) {
- if (event.listen === 'prerequest') {
- if (!requestObject.script) {
- requestObject.script = {};
- }
-
- if (Array.isArray(event.script.exec) && event.script.exec.length > 0) {
- requestObject.script.req = event.script.exec
- .map((line, index) =>
- options.enablePostmanTranslations.enabled
- ? postmanTranslation(line, () => pushTranslationLog('script', index))
- : `// ${line}`
- )
- .join('\n');
- } else if (typeof event.script.exec === 'string') {
- requestObject.script.req = options.enablePostmanTranslations.enabled
- ? postmanTranslation(event.script.exec, () => pushTranslationLog('script', 0))
- : `// ${event.script.exec}`;
- } else {
- console.warn('Unexpected event.script.exec type', typeof event.script.exec);
- }
- }
-
- if (event.listen === 'test') {
- if (!requestObject.tests) {
- requestObject.tests = {};
- }
-
- if (Array.isArray(event.script.exec) && event.script.exec.length > 0) {
- requestObject.tests = event.script.exec
- .map((line, index) =>
- options.enablePostmanTranslations.enabled
- ? postmanTranslation(line, () => pushTranslationLog('test', index))
- : `// ${line}`
- )
- .join('\n');
- } else if (typeof event.script.exec === 'string') {
- requestObject.tests = options.enablePostmanTranslations.enabled
- ? postmanTranslation(event.script.exec, () => pushTranslationLog('test', 0))
- : `// ${event.script.exec}`;
- } else {
- console.warn('Unexpected event.script.exec type', typeof event.script.exec);
- }
- }
- }
- });
-};
-
-const importCollectionLevelVariables = (variables, requestObject) => {
- const vars = variables.map((v) => ({
- uid: uuid(),
- name: v.key,
- value: v.value,
- enabled: true
- }));
-
- requestObject.vars.req = vars;
-};
-
-const importPostmanV2CollectionItem = (brunoParent, item, parentAuth, options) => {
- brunoParent.items = brunoParent.items || [];
- const folderMap = {};
- const requestMap = {};
-
- each(item, (i) => {
- if (isItemAFolder(i)) {
- const baseFolderName = i.name;
- let folderName = baseFolderName;
- let count = 1;
-
- while (folderMap[folderName]) {
- folderName = `${baseFolderName}_${count}`;
- count++;
- }
-
- const brunoFolderItem = {
- uid: uuid(),
- name: folderName,
- type: 'folder',
- items: [],
- root: {
- docs: i.description || '',
- meta: {
- name: folderName
- },
- request: {
- auth: {
- mode: 'none',
- basic: null,
- bearer: null,
- awsv4: null
- },
- headers: [],
- script: {},
- tests: '',
- vars: {}
- }
- }
- };
- if (i.item && i.item.length) {
- importPostmanV2CollectionItem(brunoFolderItem, i.item, i.auth ?? parentAuth, options);
- }
-
- if (i.event) {
- importScriptsFromEvents(i.event, brunoFolderItem.root.request, options, pushTranslationLog);
- }
-
- brunoParent.items.push(brunoFolderItem);
- folderMap[folderName] = brunoFolderItem;
-
- } else {
- if (i.request) {
- const baseRequestName = i.name;
- let requestName = baseRequestName;
- let count = 1;
-
- while (requestMap[requestName]) {
- requestName = `${baseRequestName}_${count}`;
- count++;
- }
-
- const url = constructUrl(i.request.url);
-
- const brunoRequestItem = {
- uid: uuid(),
- name: requestName,
- type: 'http-request',
- request: {
- url: url,
- method: i?.request?.method?.toUpperCase(),
- auth: {
- mode: 'none',
- basic: null,
- bearer: null,
- awsv4: null
- },
- headers: [],
- params: [],
- body: {
- mode: 'none',
- json: null,
- text: null,
- xml: null,
- formUrlEncoded: [],
- multipartForm: []
- },
- docs: i.request.description
- }
- };
-
- if (i.event) {
- i.event.forEach((event) => {
- if (event.listen === 'prerequest' && event.script && event.script.exec) {
- if (!brunoRequestItem.request.script) {
- brunoRequestItem.request.script = {};
- }
- if (Array.isArray(event.script.exec) && event.script.exec.length > 0) {
- brunoRequestItem.request.script.req = event.script.exec
- .map((line, index) =>
- options.enablePostmanTranslations.enabled
- ? postmanTranslation(line, () => pushTranslationLog('script', index))
- : `// ${line}`
- )
- .join('\n');
- } else if (typeof event.script.exec === 'string') {
- brunoRequestItem.request.script.req = options.enablePostmanTranslations.enabled
- ? postmanTranslation(event.script.exec, () => pushTranslationLog('script', 0))
- : `// ${event.script.exec}`;
- } else {
- console.warn('Unexpected event.script.exec type', typeof event.script.exec);
- }
- }
- if (event.listen === 'test' && event.script && event.script.exec) {
- if (!brunoRequestItem.request.tests) {
- brunoRequestItem.request.tests = {};
- }
- if (Array.isArray(event.script.exec) && event.script.exec.length > 0) {
- brunoRequestItem.request.tests = event.script.exec
- .map((line, index) =>
- options.enablePostmanTranslations.enabled
- ? postmanTranslation(line, () => pushTranslationLog('test', index))
- : `// ${line}`
- )
- .join('\n');
- } else if (typeof event.script.exec === 'string') {
- brunoRequestItem.request.tests = options.enablePostmanTranslations.enabled
- ? postmanTranslation(event.script.exec, () => pushTranslationLog('test', 0))
- : `// ${event.script.exec}`;
- } else {
- console.warn('Unexpected event.script.exec type', typeof event.script.exec);
- }
- }
- });
- }
-
- const bodyMode = get(i, 'request.body.mode');
- if (bodyMode) {
- if (bodyMode === 'formdata') {
- brunoRequestItem.request.body.mode = 'multipartForm';
-
- each(i.request.body.formdata, (param) => {
- const isFile = param.type === 'file';
- let value;
- let type;
-
- if (isFile) {
- // If param.src is an array, keep it as it is.
- // If param.src is a string, convert it into an array with a single element.
- value = Array.isArray(param.src) ? param.src : typeof param.src === 'string' ? [param.src] : null;
- type = 'file';
- } else {
- value = param.value;
- type = 'text';
- }
-
- brunoRequestItem.request.body.multipartForm.push({
- uid: uuid(),
- type: type,
- name: param.key,
- value: value,
- description: param.description,
- enabled: !param.disabled
- });
- });
- }
-
- if (bodyMode === 'urlencoded') {
- brunoRequestItem.request.body.mode = 'formUrlEncoded';
- each(i.request.body.urlencoded, (param) => {
- brunoRequestItem.request.body.formUrlEncoded.push({
- uid: uuid(),
- name: param.key,
- value: param.value,
- description: param.description,
- enabled: !param.disabled
- });
- });
- }
-
- if (bodyMode === 'raw') {
- let language = get(i, 'request.body.options.raw.language');
- if (!language) {
- language = searchLanguageByHeader(i.request.header);
- }
- if (language === 'json') {
- brunoRequestItem.request.body.mode = 'json';
- brunoRequestItem.request.body.json = i.request.body.raw;
- } else if (language === 'xml') {
- brunoRequestItem.request.body.mode = 'xml';
- brunoRequestItem.request.body.xml = i.request.body.raw;
- } else {
- brunoRequestItem.request.body.mode = 'text';
- brunoRequestItem.request.body.text = i.request.body.raw;
- }
- }
- }
-
- if (bodyMode === 'graphql') {
- brunoRequestItem.type = 'graphql-request';
- brunoRequestItem.request.body.mode = 'graphql';
- brunoRequestItem.request.body.graphql = parseGraphQLRequest(i.request.body.graphql);
- }
-
- each(i.request.header, (header) => {
- brunoRequestItem.request.headers.push({
- uid: uuid(),
- name: header.key,
- value: header.value,
- description: header.description,
- enabled: !header.disabled
- });
- });
-
- const auth = i.request.auth ?? parentAuth;
- if (auth?.[auth.type] && auth.type !== 'noauth') {
- let authValues = auth[auth.type];
- if (Array.isArray(authValues)) {
- authValues = convertV21Auth(authValues);
- }
- if (auth.type === 'basic') {
- brunoRequestItem.request.auth.mode = 'basic';
- brunoRequestItem.request.auth.basic = {
- username: authValues.username,
- password: authValues.password
- };
- } else if (auth.type === 'bearer') {
- brunoRequestItem.request.auth.mode = 'bearer';
- brunoRequestItem.request.auth.bearer = {
- token: authValues.token
- };
- } else if (auth.type === 'awsv4') {
- brunoRequestItem.request.auth.mode = 'awsv4';
- brunoRequestItem.request.auth.awsv4 = {
- accessKeyId: authValues.accessKey,
- secretAccessKey: authValues.secretKey,
- sessionToken: authValues.sessionToken,
- service: authValues.service,
- region: authValues.region,
- profileName: ''
- };
- } else if (auth.type === 'apikey'){
- brunoRequestItem.request.auth.mode = 'apikey';
- brunoRequestItem.request.auth.apikey = {
- key: authValues.key,
- value: authValues.value,
- placement: "header" //By default we are placing the apikey values in headers!
- }
- }
- }
-
- each(get(i, 'request.url.query'), (param) => {
- brunoRequestItem.request.params.push({
- uid: uuid(),
- name: param.key,
- value: param.value,
- description: param.description,
- type: 'query',
- enabled: !param.disabled
- });
- });
-
- each(get(i, 'request.url.variable', []), (param) => {
- if (!param.key) {
- // If no key, skip this iteration and discard the param
- return;
- }
-
- brunoRequestItem.request.params.push({
- uid: uuid(),
- name: param.key,
- value: param.value ?? '',
- description: param.description ?? '',
- type: 'path',
- enabled: true
- });
- });
-
- brunoParent.items.push(brunoRequestItem);
- requestMap[requestName] = brunoRequestItem;
- }
- }
- });
-};
-
-const searchLanguageByHeader = (headers) => {
- let contentType;
- each(headers, (header) => {
- if (header.key.toLowerCase() === 'content-type' && !header.disabled) {
- if (typeof header.value == 'string' && /^[\w\-]+\/([\w\-]+\+)?json/.test(header.value)) {
- contentType = 'json';
- } else if (typeof header.value == 'string' && /^[\w\-]+\/([\w\-]+\+)?xml/.test(header.value)) {
- contentType = 'xml';
- }
- return false;
- }
- });
- return contentType;
-};
-
-const importPostmanV2Collection = (collection, options) => {
- const brunoCollection = {
- name: collection.info.name,
- uid: uuid(),
- version: '1',
- items: [],
- environments: [],
- root: {
- docs: collection.info.description || '',
- meta: {
- name: collection.info.name
- },
- request: {
- auth: {
- mode: 'none',
- basic: null,
- bearer: null,
- awsv4: null
- },
- headers: [],
- script: {},
- tests: '',
- vars: {}
- }
- }
- };
-
- if (collection.event) {
- importScriptsFromEvents(collection.event, brunoCollection.root.request, options, pushTranslationLog);
- }
-
- if (collection?.variable){
- importCollectionLevelVariables(collection.variable, brunoCollection.root.request);
- }
-
- importPostmanV2CollectionItem(brunoCollection, collection.item, collection.auth, options);
-
- return brunoCollection;
-};
-
-const parsePostmanCollection = (str, options) => {
+const postmanToBruno = (collection) => {
return new Promise((resolve, reject) => {
- try {
- let collection = JSON.parse(str);
- let schema = get(collection, 'info.schema');
-
- let v2Schemas = [
- 'https://schema.getpostman.com/json/collection/v2.0.0/collection.json',
- 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
- ];
-
- if (v2Schemas.includes(schema)) {
- return resolve(importPostmanV2Collection(collection, options));
- }
-
- throw new BrunoError('Unknown postman schema');
- } catch (err) {
- console.log(err);
- if (err instanceof BrunoError) {
- return reject(err);
- }
-
- return reject(new BrunoError('Unable to parse the postman collection json file'));
- }
- });
-};
-
-const logTranslationDetails = (translationLog) => {
- if (Object.keys(translationLog || {}).length > 0) {
- console.warn(
- `[Postman Translation Logs]
-Collections incomplete : ${Object.keys(translationLog || {}).length}` +
- `\nTotal lines incomplete : ${Object.values(translationLog || {}).reduce(
- (acc, curr) => acc + (curr.script?.length || 0) + (curr.test?.length || 0),
- 0
- )}` +
- `\nSee details below :`,
- translationLog
- );
- }
-};
-
-const importCollection = (options) => {
- return new Promise((resolve, reject) => {
- fileDialog({ accept: 'application/json' })
- .then(readFile)
- .then((str) => parsePostmanCollection(str, options))
- .then(transformItemsInCollection)
- .then(hydrateSeqInCollection)
- .then(validateSchema)
- .then((collection) => resolve({ collection, translationLog }))
- .catch((err) => {
- console.log(err);
- translationLog = {};
- reject(new BrunoError('Import collection failed'));
- })
- .then(() => {
- logTranslationDetails(translationLog);
- translationLog = {};
+ window.ipcRenderer.invoke('renderer:convert-postman-to-bruno', collection)
+ .then(result => resolve(result))
+ .catch(err => {
+ console.error('Error converting Postman to Bruno via Electron:', err);
+ reject(new BrunoError('Conversion failed'));
});
});
};
-export default importCollection;
+const isPostmanCollection = (data) => {
+ const info = data.info;
+ if (!info || typeof info !== 'object') {
+ return false;
+ }
+
+ const schema = info.schema;
+ // Accept schemas hosted at schema.getpostman.com or schema.postman.com
+ const schemaRegex = /^https:\/\/schema\.(?:getpostman|postman)\.com\//;
+ if (typeof schema === 'string' && schemaRegex.test(schema)) {
+ return true;
+ }
+
+ return false;
+};
+
+export { postmanToBruno, readFile, isPostmanCollection };
diff --git a/packages/bruno-app/src/utils/importers/postman-environment.js b/packages/bruno-app/src/utils/importers/postman-environment.js
index 38f818f71..e4185deb5 100644
--- a/packages/bruno-app/src/utils/importers/postman-environment.js
+++ b/packages/bruno-app/src/utils/importers/postman-environment.js
@@ -1,60 +1,24 @@
-import each from 'lodash/each';
import fileDialog from 'file-dialog';
import { BrunoError } from 'utils/common/error';
+import { postmanToBrunoEnvironment } from '@usebruno/converters';
const readFile = (files) => {
return new Promise((resolve, reject) => {
const fileReader = new FileReader();
- fileReader.onload = (e) => resolve(e.target.result);
+ fileReader.onload = (e) => {
+ try {
+ let parsedPostmanEnvironment = JSON.parse(e.target.result);
+ resolve(parsedPostmanEnvironment);
+ } catch (err) {
+ console.error(err);
+ reject(new BrunoError('Unable to parse the postman environment json file'));
+ }
+ }
fileReader.onerror = (err) => reject(err);
fileReader.readAsText(files[0]);
});
};
-const isSecret = (type) => {
- return type === 'secret';
-};
-
-const importPostmanEnvironmentVariables = (brunoEnvironment, values) => {
- brunoEnvironment.variables = brunoEnvironment.variables || [];
-
- each(values, (i) => {
- const brunoEnvironmentVariable = {
- name: i.key,
- value: i.value,
- enabled: i.enabled,
- secret: isSecret(i.type)
- };
-
- brunoEnvironment.variables.push(brunoEnvironmentVariable);
- });
-};
-
-const importPostmanEnvironment = (environment) => {
- const brunoEnvironment = {
- name: environment.name,
- variables: []
- };
-
- importPostmanEnvironmentVariables(brunoEnvironment, environment.values);
- return brunoEnvironment;
-};
-
-const parsePostmanEnvironment = (str) => {
- return new Promise((resolve, reject) => {
- try {
- let environment = JSON.parse(str);
- return resolve(importPostmanEnvironment(environment));
- } catch (err) {
- console.log(err);
- if (err instanceof BrunoError) {
- return reject(err);
- }
- return reject(new BrunoError('Unable to parse the postman environment json file'));
- }
- });
-};
-
const importEnvironment = () => {
return new Promise((resolve, reject) => {
fileDialog({ multiple: true, accept: 'application/json' })
@@ -62,7 +26,7 @@ const importEnvironment = () => {
return Promise.all(
Object.values(files ?? {}).map((file) =>
readFile([file])
- .then(parsePostmanEnvironment)
+ .then((environment) => postmanToBrunoEnvironment(environment))
.catch((err) => {
console.error(`Error processing file: ${file.name || 'undefined'}`, err);
throw err;
diff --git a/packages/bruno-app/src/utils/importers/translators/index.spec.js b/packages/bruno-app/src/utils/importers/translators/index.spec.js
deleted file mode 100644
index 26b804b00..000000000
--- a/packages/bruno-app/src/utils/importers/translators/index.spec.js
+++ /dev/null
@@ -1,169 +0,0 @@
-const { postmanTranslation } = require('./postman_translation'); // Adjust path as needed
-
-describe('postmanTranslation function', () => {
- test('should translate pm commands correctly', () => {
- const inputScript = `
- pm.environment.get('key');
- pm.environment.set('key', 'value');
- pm.variables.get('key');
- pm.variables.set('key', 'value');
- pm.collectionVariables.get('key');
- pm.collectionVariables.set('key', 'value');
- const data = pm.response.json();
- pm.expect(pm.environment.has('key')).to.be.true;
- postman.setEnvironmentVariable('key', 'value');
- postman.getEnvironmentVariable('key');
- postman.clearEnvironmentVariable('key');
- `;
- const expectedOutput = `
- bru.getEnvVar('key');
- bru.setEnvVar('key', 'value');
- bru.getVar('key');
- bru.setVar('key', 'value');
- bru.getVar('key');
- bru.setVar('key', 'value');
- const data = res.getBody();
- expect(bru.getEnvVar('key') !== undefined && bru.getEnvVar('key') !== null).to.be.true;
- bru.setEnvVar('key', 'value');
- bru.getEnvVar('key');
- bru.deleteEnvVar('key');
- `;
- expect(postmanTranslation(inputScript)).toBe(expectedOutput);
- });
-
- test('should not translate non-pm commands', () => {
- const inputScript = `
- console.log('This script does not contain pm commands.');
- const data = pm.environment.get('key');
- pm.collectionVariables.set('key', data);
- `;
- const expectedOutput = `
- console.log('This script does not contain pm commands.');
- const data = bru.getEnvVar('key');
- bru.setVar('key', data);
- `;
- expect(postmanTranslation(inputScript)).toBe(expectedOutput);
- });
-
- test('should comment non-translated pm commands', () => {
- const inputScript = "pm.test('random test', () => postman.variables.replaceIn('{{$guid}}'));";
- const expectedOutput = "// test('random test', () => postman.variables.replaceIn('{{$guid}}'));";
- expect(postmanTranslation(inputScript)).toBe(expectedOutput);
- });
- test('should handle multiple pm commands on the same line', () => {
- const inputScript = "pm.environment.get('key'); pm.environment.set('key', 'value');";
- const expectedOutput = "bru.getEnvVar('key'); bru.setEnvVar('key', 'value');";
- expect(postmanTranslation(inputScript)).toBe(expectedOutput);
- });
- test('should handle comments and other JavaScript code', () => {
- const inputScript = `
- // This is a comment
- const value = 'test';
- pm.environment.set('key', value);
- /*
- Multi-line comment
- */
- const result = pm.environment.get('key');
- console.log('Result:', result);
- `;
- const expectedOutput = `
- // This is a comment
- const value = 'test';
- bru.setEnvVar('key', value);
- /*
- Multi-line comment
- */
- const result = bru.getEnvVar('key');
- console.log('Result:', result);
- `;
- expect(postmanTranslation(inputScript)).toBe(expectedOutput);
- });
-
- test('should handle nested commands and edge cases', () => {
- const inputScript = `
- const sampleObjects = [
- {
- key: pm.environment.get('key'),
- value: pm.variables.get('value')
- },
- {
- key: pm.collectionVariables.get('key'),
- value: pm.collectionVariables.get('value')
- }
- ];
- const dataTesting = Object.entries(sampleObjects || {}).reduce((acc, [key, value]) => {
- // this is a comment
- acc[key] = pm.collectionVariables.get(pm.environment.get(value));
- return acc; // Return the accumulator
- }, {});
- Object.values(dataTesting).forEach((data) => {
- pm.environment.set(data.key, pm.variables.get(data.value));
- });
- `;
- const expectedOutput = `
- const sampleObjects = [
- {
- key: bru.getEnvVar('key'),
- value: bru.getVar('value')
- },
- {
- key: bru.getVar('key'),
- value: bru.getVar('value')
- }
- ];
- const dataTesting = Object.entries(sampleObjects || {}).reduce((acc, [key, value]) => {
- // this is a comment
- acc[key] = bru.getVar(bru.getEnvVar(value));
- return acc; // Return the accumulator
- }, {});
- Object.values(dataTesting).forEach((data) => {
- bru.setEnvVar(data.key, bru.getVar(data.value));
- });
- `;
- expect(postmanTranslation(inputScript)).toBe(expectedOutput);
- });
-
- test('should handle test commands', () => {
- const inputScript = `
- pm.test('Status code is 200', () => {
- pm.response.to.have.status(200);
- });
- pm.test('this test will fail', () => {
- return false
- });
- `;
- const expectedOutput = `
- test('Status code is 200', () => {
- expect(res.getStatus()).to.equal(200);
- });
- test('this test will fail', () => {
- return false
- });
- `;
- expect(postmanTranslation(inputScript)).toBe(expectedOutput);
- });
-});
-
-test('should handle response commands', () => {
- const inputScript = `
- const responseTime = pm.response.responseTime;
- const responseCode = pm.response.code;
- const responseText = pm.response.text();
- `;
- const expectedOutput = `
- const responseTime = res.getResponseTime();
- const responseCode = res.getStatus();
- const responseText = res.getBody()?.toString();
- `;
- expect(postmanTranslation(inputScript)).toBe(expectedOutput);
-});
-
-test('should handle tests object', () => {
- const inputScript = `
- tests['Status code is 200'] = responseCode.code === 200;
- `;
- const expectedOutput = `
- test("Status code is 200", function() { expect(Boolean(responseCode.code === 200)).to.be.true; });
- `;
- expect(postmanTranslation(inputScript)).toBe(expectedOutput);
-});
diff --git a/packages/bruno-app/src/utils/importers/translators/postman_translation.js b/packages/bruno-app/src/utils/importers/translators/postman_translation.js
deleted file mode 100644
index b386d719e..000000000
--- a/packages/bruno-app/src/utils/importers/translators/postman_translation.js
+++ /dev/null
@@ -1,59 +0,0 @@
-const replacements = {
- 'pm\\.environment\\.get\\(': 'bru.getEnvVar(',
- 'pm\\.environment\\.set\\(': 'bru.setEnvVar(',
- 'pm\\.variables\\.get\\(': 'bru.getVar(',
- 'pm\\.variables\\.set\\(': 'bru.setVar(',
- 'pm\\.collectionVariables\\.get\\(': 'bru.getVar(',
- 'pm\\.collectionVariables\\.set\\(': 'bru.setVar(',
- 'pm\\.collectionVariables\\.has\\(': 'bru.hasVar(',
- 'pm\\.collectionVariables\\.unset\\(': 'bru.deleteVar(',
- 'pm\\.setNextRequest\\(': 'bru.setNextRequest(',
- 'pm\\.test\\(': 'test(',
- 'pm.response.to.have\\.status\\(': 'expect(res.getStatus()).to.equal(',
- 'pm\\.response\\.to\\.have\\.status\\(': 'expect(res.getStatus()).to.equal(',
- 'pm\\.response\\.json\\(': 'res.getBody(',
- 'pm\\.expect\\(': 'expect(',
- 'pm\\.environment\\.has\\(([^)]+)\\)': 'bru.getEnvVar($1) !== undefined && bru.getEnvVar($1) !== null',
- 'pm\\.response\\.code': 'res.getStatus()',
- 'pm\\.response\\.text\\(': 'res.getBody()?.toString(',
- 'pm\\.expect\\.fail\\(': 'expect.fail(',
- 'pm\\.response\\.responseTime': 'res.getResponseTime()',
- 'pm\\.environment\\.name': 'bru.getEnvName()',
- "tests\\['([^']+)'\\]\\s*=\\s*([^;]+);": 'test("$1", function() { expect(Boolean($2)).to.be.true; });',
- // deprecated translations
- 'postman\\.setEnvironmentVariable\\(': 'bru.setEnvVar(',
- 'postman\\.getEnvironmentVariable\\(': 'bru.getEnvVar(',
- 'postman\\.clearEnvironmentVariable\\(': 'bru.deleteEnvVar(',
-};
-
-const extendedReplacements = Object.keys(replacements).reduce((acc, key) => {
- const newKey = key.replace(/^pm\\\./, 'postman\\.');
- acc[key] = replacements[key];
- acc[newKey] = replacements[key];
- return acc;
-}, {});
-
-const compiledReplacements = Object.entries(extendedReplacements).map(([pattern, replacement]) => ({
- regex: new RegExp(pattern, 'g'),
- replacement
-}));
-
-export const postmanTranslation = (script, logCallback) => {
- try {
- let modifiedScript = script;
- let modified = false;
- for (const { regex, replacement } of compiledReplacements) {
- if (regex.test(modifiedScript)) {
- modifiedScript = modifiedScript.replace(regex, replacement);
- modified = true;
- }
- }
- if (modifiedScript.includes('pm.') || modifiedScript.includes('postman.')) {
- modifiedScript = modifiedScript.replace(/^(.*(pm\.|postman\.).*)$/gm, '// $1');
- logCallback?.();
- }
- return modifiedScript;
- } catch (e) {
- return script;
- }
-};
diff --git a/packages/bruno-app/src/utils/network/grpc-event-listeners.js b/packages/bruno-app/src/utils/network/grpc-event-listeners.js
new file mode 100644
index 000000000..75c8e3eb9
--- /dev/null
+++ b/packages/bruno-app/src/utils/network/grpc-event-listeners.js
@@ -0,0 +1,127 @@
+import { useEffect } from 'react';
+import { grpcResponseReceived, runGrpcRequestEvent } from 'providers/ReduxStore/slices/collections/index';
+import { useDispatch } from 'react-redux';
+import { isElectron } from 'utils/common/platform';
+import { updateActiveConnectionsInStore } from 'providers/ReduxStore/slices/collections/actions';
+
+const useGrpcEventListeners = () => {
+ const { ipcRenderer } = window;
+ const dispatch = useDispatch();
+
+ useEffect(() => {
+ if (!isElectron()) {
+ return () => {};
+ }
+
+ ipcRenderer.invoke('renderer:ready');
+
+ // Handle gRPC requestSent event
+ const removeGrpcRequestSentListener = ipcRenderer.on('grpc:request', (requestId, collectionUid, eventData) => {
+
+ dispatch(runGrpcRequestEvent({
+ eventType: "request",
+ itemUid: requestId,
+ collectionUid: collectionUid,
+ requestUid: requestId,
+ eventData
+ }));
+ });
+
+ const removeGrpcMessageSentListener = ipcRenderer.on('grpc:message', (requestId, collectionUid, eventData) => {
+
+ dispatch(runGrpcRequestEvent({
+ eventType: "message",
+ itemUid: requestId,
+ collectionUid: collectionUid,
+ requestUid: requestId,
+ eventData
+ }));
+ });
+
+ // Handle gRPC response event (for unary calls and streaming)
+ const removeGrpcResponseListener = ipcRenderer.on(`grpc:response`, (requestId, collectionUid, data) => {
+
+ dispatch(grpcResponseReceived({
+ itemUid: requestId,
+ collectionUid: collectionUid,
+ eventType: 'response',
+ eventData: data
+ }));
+ });
+
+ // Handle gRPC metadata
+ const removeGrpcMetadataListener = ipcRenderer.on(`grpc:metadata`, (requestId, collectionUid, data) => {
+
+ dispatch(grpcResponseReceived({
+ itemUid: requestId,
+ collectionUid: collectionUid,
+ eventType: 'metadata',
+ eventData: data
+ }));
+ });
+
+ // Handle gRPC status updates
+ const removeGrpcStatusListener = ipcRenderer.on(`grpc:status`, (requestId, collectionUid, data) => {
+
+ dispatch(grpcResponseReceived({
+ itemUid: requestId,
+ collectionUid: collectionUid,
+ eventType: 'status',
+ eventData: data
+ }));
+ });
+
+ // Handle gRPC errors
+ const removeGrpcErrorListener = ipcRenderer.on(`grpc:error`, (requestId, collectionUid, data) => {
+
+ dispatch(grpcResponseReceived({
+ itemUid: requestId,
+ collectionUid: collectionUid,
+ eventType: 'error',
+ eventData: data
+ }));
+ });
+
+ // Handle gRPC end event
+ const removeGrpcEndListener = ipcRenderer.on(`grpc:server-end-stream`, (requestId, collectionUid, data) => {
+
+ dispatch(grpcResponseReceived({
+ itemUid: requestId,
+ collectionUid: collectionUid,
+ eventType: 'end',
+ eventData: data
+ }));
+ });
+
+ // Handle gRPC cancel event
+ const removeGrpcCancelListener = ipcRenderer.on(`grpc:server-cancel-stream`, (requestId, collectionUid, data) => {
+
+ dispatch(grpcResponseReceived({
+ itemUid: requestId,
+ collectionUid: collectionUid,
+ eventType: 'cancel',
+ eventData: data
+ }));
+ });
+
+ const removeGrpcConnectionsChangedListener = ipcRenderer.on(`grpc:connections-changed`, (data) => {
+
+ dispatch(updateActiveConnectionsInStore(data));
+ });
+
+ return () => {
+ removeGrpcRequestSentListener();
+ removeGrpcMessageSentListener();
+ removeGrpcResponseListener();
+ removeGrpcMetadataListener();
+ removeGrpcStatusListener();
+ removeGrpcErrorListener();
+ removeGrpcEndListener();
+ removeGrpcCancelListener();
+ removeGrpcConnectionsChangedListener();
+ };
+
+ }, [isElectron]);
+};
+
+export default useGrpcEventListeners;
\ No newline at end of file
diff --git a/packages/bruno-app/src/utils/network/index.js b/packages/bruno-app/src/utils/network/index.js
index 18a2b8a1c..0022b5045 100644
--- a/packages/bruno-app/src/utils/network/index.js
+++ b/packages/bruno-app/src/utils/network/index.js
@@ -1,10 +1,12 @@
-import { safeStringifyJSON } from 'utils/common';
-
export const sendNetworkRequest = async (item, collection, environment, runtimeVariables) => {
return new Promise((resolve, reject) => {
if (['http-request', 'graphql-request'].includes(item.type)) {
sendHttpRequest(item, collection, environment, runtimeVariables)
.then((response) => {
+ // if there is an error, we return the response object as is
+ if (response?.error) {
+ resolve(response)
+ }
resolve({
state: 'success',
data: response.data,
@@ -14,7 +16,8 @@ export const sendNetworkRequest = async (item, collection, environment, runtimeV
size: response.size,
status: response.status,
statusText: response.statusText,
- duration: response.duration
+ duration: response.duration,
+ timeline: response.timeline
});
})
.catch((err) => reject(err));
@@ -22,6 +25,23 @@ export const sendNetworkRequest = async (item, collection, environment, runtimeV
});
};
+export const sendGrpcRequest = async (item, collection, environment, runtimeVariables) => {
+ return new Promise((resolve, reject) => {
+ startGrpcRequest(item, collection, environment, runtimeVariables)
+ .then((initialState) => {
+ // Return an initial state object to update the UI
+ // The real response data will be handled by event listeners
+ resolve({
+ ...initialState,
+ timeline: []
+ });
+ })
+ .catch((err) => reject(err));
+ });
+}
+
+
+
const sendHttpRequest = async (item, collection, environment, runtimeVariables) => {
return new Promise((resolve, reject) => {
const { ipcRenderer } = window;
@@ -36,17 +56,7 @@ const sendHttpRequest = async (item, collection, environment, runtimeVariables)
export const sendCollectionOauth2Request = async (collection, environment, runtimeVariables) => {
return new Promise((resolve, reject) => {
const { ipcRenderer } = window;
- ipcRenderer
- .invoke('send-collection-oauth2-request', collection, environment, runtimeVariables)
- .then(resolve)
- .catch(reject);
- });
-};
-
-export const clearOauth2Cache = async (uid) => {
- return new Promise((resolve, reject) => {
- const { ipcRenderer } = window;
- ipcRenderer.invoke('clear-oauth2-cache', uid).then(resolve).catch(reject);
+ resolve({});
});
};
@@ -65,3 +75,141 @@ export const cancelNetworkRequest = async (cancelTokenUid) => {
ipcRenderer.invoke('cancel-http-request', cancelTokenUid).then(resolve).catch(reject);
});
};
+
+export const startGrpcRequest = async (item, collection, environment, runtimeVariables) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+ const request = item.draft ? item.draft : item;
+
+ ipcRenderer.invoke('grpc:start-connection', {
+ request,
+ collection,
+ environment,
+ runtimeVariables
+ })
+ .then(() => {
+ resolve();
+ })
+ .catch(err => {
+ reject(err);
+ });
+ });
+};
+
+/**
+ * Sends a message to an existing gRPC stream
+ * @param {string} requestId - The request ID to send a message to
+ * @param {Object} message - The message to send
+ * @returns {Promise} - The result of the send operation
+ */
+export const sendGrpcMessage = async (item, collectionUid, message) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('grpc:send-message', item.uid, collectionUid, message)
+ .then(resolve)
+ .catch(reject);
+ });
+};
+
+/**
+ * Cancels a running gRPC request
+ * @param {string} requestId - The request ID to cancel
+ * @returns {Promise} - The result of the cancel operation
+ */
+export const cancelGrpcRequest = async (requestId) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('grpc:cancel', requestId)
+ .then(resolve)
+ .catch(reject);
+ });
+};
+
+/**
+ * Ends a gRPC streaming request (client-streaming or bidirectional)
+ * @param {string} requestId - The request ID to end
+ * @returns {Promise} - The result of the end operation
+ */
+export const endGrpcStream = async (requestId) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('grpc:end', requestId)
+ .then(resolve)
+ .catch(reject);
+ });
+};
+
+export const loadGrpcMethodsFromProtoFile = async (filePath, includeDirs = []) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('grpc:load-methods-proto', { filePath, includeDirs }).then(resolve).catch(reject);
+ });
+};
+
+// export const getGrpcMethodsFromReflection = async (request, collection, environment, runtimeVariables) => {
+// return new Promise((resolve, reject) => {
+// const { ipcRenderer } = window;
+// ipcRenderer.invoke('grpc:load-methods-reflection', { request, collection, environment, runtimeVariables }).then(resolve).catch(reject);
+// });
+// };
+
+export const cancelGrpcConnection = async (connectionId) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('grpc:cancel-request', { requestId: connectionId }).then(resolve).catch(reject);
+ });
+};
+
+export const endGrpcConnection = async (connectionId) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('grpc:end-request', { requestId: connectionId }).then(resolve).catch(reject);
+ });
+};
+
+/**
+ * Check if a gRPC connection is active
+ * @param {string} connectionId - The connection ID to check
+ * @returns {Promise} - Whether the connection is active
+ */
+export const isGrpcConnectionActive = async (connectionId) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+ ipcRenderer.invoke('grpc:is-connection-active', connectionId)
+ .then(response => {
+ if (response.success) {
+ resolve(response.isActive);
+ } else {
+ // If there was an error, assume the connection is not active
+ console.error('Error checking connection status:', response.error);
+ resolve(false);
+ }
+ })
+ .catch(err => {
+ console.error('Failed to check connection status:', err);
+ // On error, assume the connection is not active
+ resolve(false);
+ });
+ });
+};
+
+/**
+ * Generates a sample gRPC message for a method
+ * @param {string} methodPath - The full gRPC method path
+ * @param {string|null} existingMessage - Optional existing message JSON string to use as a template
+ * @param {Object} options - Additional options for message generation
+ * @returns {Promise} The generated sample message or error
+ */
+export const generateGrpcSampleMessage = async (methodPath, existingMessage = null, options = {}) => {
+ return new Promise((resolve, reject) => {
+ const { ipcRenderer } = window;
+
+ ipcRenderer.invoke('grpc:generate-sample-message', {
+ methodPath,
+ existingMessage,
+ options
+ })
+ .then(resolve)
+ .catch(reject);
+ });
+};
diff --git a/packages/bruno-app/src/utils/tabs/index.js b/packages/bruno-app/src/utils/tabs/index.js
index a6fa29dd7..f99670623 100644
--- a/packages/bruno-app/src/utils/tabs/index.js
+++ b/packages/bruno-app/src/utils/tabs/index.js
@@ -1,7 +1,7 @@
import find from 'lodash/find';
export const isItemARequest = (item) => {
- return item.hasOwnProperty('request') && ['http-request', 'graphql-request'].includes(item.type);
+ return item.hasOwnProperty('request') && ['http-request', 'graphql-request', 'grpc-request'].includes(item.type);
};
export const isItemAFolder = (item) => {
@@ -11,3 +11,10 @@ export const isItemAFolder = (item) => {
export const itemIsOpenedInTabs = (item, tabs) => {
return find(tabs, (t) => t.uid === item.uid);
};
+
+export const scrollToTheActiveTab = () => {
+ const activeTab = document.querySelector('.request-tab.active');
+ if (activeTab) {
+ activeTab.scrollIntoView({ behavior: 'smooth', block: 'start' });
+ }
+};
\ No newline at end of file
diff --git a/packages/bruno-app/src/utils/tests/collections/grpc-export-import.spec.js b/packages/bruno-app/src/utils/tests/collections/grpc-export-import.spec.js
new file mode 100644
index 000000000..9596e50d4
--- /dev/null
+++ b/packages/bruno-app/src/utils/tests/collections/grpc-export-import.spec.js
@@ -0,0 +1,221 @@
+import { transformCollectionToSaveToExportAsFile, transformRequestToSaveToFilesystem } from '../../collections/index';
+import { transformItemsInCollection } from '../../importers/common';
+
+describe('gRPC Export/Import', () => {
+ describe('transformCollectionToSaveToExportAsFile', () => {
+ it('should preserve gRPC-specific fields when exporting collection', () => {
+ const collection = {
+ uid: 'test-collection',
+ name: 'Test Collection',
+ items: [
+ {
+ uid: 'grpc-request-1',
+ type: 'grpc-request',
+ name: 'Test gRPC Request',
+ request: {
+ url: 'grpc://localhost:50051',
+ method: '/randomService/randomMethod',
+ methodType: 'unary',
+ protoPath: 'proto/service.proto',
+ headers: [],
+ body: {
+ mode: 'grpc',
+ grpc: [{ name: 'message', content: '{}' }]
+ }
+ }
+ }
+ ]
+ };
+
+ const result = transformCollectionToSaveToExportAsFile(collection);
+ const grpcRequest = result.items[0];
+
+ expect(grpcRequest.request.methodType).toBe('unary');
+ expect(grpcRequest.request.method).toBe('/randomService/randomMethod');
+ expect(grpcRequest.request.protoPath).toBe('proto/service.proto');
+ expect(grpcRequest.request.params).toBeUndefined();
+ });
+
+ it('should handle different gRPC method types correctly', () => {
+ const collection = {
+ uid: 'test-collection',
+ name: 'Test Collection',
+ items: [
+ {
+ uid: 'grpc-request-1',
+ type: 'grpc-request',
+ name: 'Streaming Request',
+ request: {
+ url: 'grpc://localhost:50051',
+ method: '/randomService/randomMethod',
+ methodType: 'bidi-streaming',
+ protoPath: 'proto/streaming.proto',
+ headers: [],
+ body: { mode: 'grpc', grpc: [] }
+ }
+ }
+ ]
+ };
+
+ const result = transformCollectionToSaveToExportAsFile(collection);
+ const grpcRequest = result.items[0];
+
+ expect(grpcRequest.request.methodType).toBe('bidi-streaming');
+ expect(grpcRequest.request.method).toBe('/randomService/randomMethod');
+ expect(grpcRequest.request.protoPath).toBe('proto/streaming.proto');
+ });
+
+ it('should handle gRPC requests without method', () => {
+ const collection = {
+ uid: 'test-collection',
+ name: 'Test Collection',
+ items: [
+ {
+ uid: 'grpc-request-1',
+ type: 'grpc-request',
+ name: 'Streaming Request',
+ request: {
+ url: 'grpc://localhost:50051',
+ methodType: 'unary',
+ headers: [],
+ body: { mode: 'grpc', grpc: [] }
+ }
+ }
+ ]
+ };
+
+ const result = transformCollectionToSaveToExportAsFile(collection);
+ const grpcRequest = result.items[0];
+
+ expect(grpcRequest.request.methodType).toBe('unary');
+ expect(grpcRequest.request.method).toBeUndefined();
+ expect(grpcRequest.request.protoPath).toBeUndefined();
+ });
+ });
+
+ describe('transformRequestToSaveToFilesystem', () => {
+ it('should preserve gRPC fields and remove params for gRPC requests', () => {
+ const grpcRequest = {
+ uid: 'grpc-request-1',
+ type: 'grpc-request',
+ name: 'Test gRPC',
+ request: {
+ url: 'grpc://localhost:50051',
+ method: '/randomService/randomMethod',
+ methodType: 'server-streaming',
+ protoPath: 'proto/service.proto',
+ params: [{ uid: 'param-1', name: 'test', value: 'value' }],
+ headers: [],
+ body: { mode: 'grpc', grpc: [] }
+ }
+ };
+
+ const result = transformRequestToSaveToFilesystem(grpcRequest);
+
+ expect(result.request.methodType).toBe('server-streaming');
+ expect(result.request.protoPath).toBe('proto/service.proto');
+ expect(result.request.params).toBeUndefined();
+ });
+
+ it('should not remove params for non-gRPC requests', () => {
+ const httpRequest = {
+ uid: 'http-request-1',
+ type: 'http-request',
+ name: 'Test HTTP',
+ request: {
+ url: 'http://localhost:3000',
+ method: 'GET',
+ params: [{ uid: 'param-1', name: 'test', value: 'value' }],
+ headers: [],
+ body: { mode: 'json', json: '{}' }
+ }
+ };
+
+ const result = transformRequestToSaveToFilesystem(httpRequest);
+
+ expect(result.request.params).toHaveLength(1);
+ expect(result.request.params[0].name).toBe('test');
+ });
+ });
+
+ describe('transformItemsInCollection', () => {
+ it('should transform gRPC request type correctly during import', () => {
+ const collection = {
+ uid: 'test-collection',
+ items: [
+ {
+ uid: 'grpc-request-1',
+ type: 'grpc',
+ name: 'Test gRPC',
+ request: {
+ url: 'grpc://localhost:50051',
+ methodType: 'unary',
+ protoPath: 'proto/service.proto',
+ body: { mode: 'grpc', grpc: [] }
+ }
+ }
+ ]
+ };
+
+ transformItemsInCollection(collection);
+ const grpcRequest = collection.items[0];
+
+ expect(grpcRequest.type).toBe('grpc-request');
+ expect(grpcRequest.request.methodType).toBe('unary');
+ expect(grpcRequest.request.protoPath).toBe('proto/service.proto');
+ });
+
+ it('should handle gRPC requests without protoPath', () => {
+ const collection = {
+ uid: 'test-collection',
+ items: [
+ {
+ uid: 'grpc-request-1',
+ type: 'grpc',
+ name: 'Test gRPC',
+ request: {
+ url: 'grpc://localhost:50051',
+ method: '/randomService/randomMethod',
+ methodType: 'client-streaming',
+ body: { mode: 'grpc', grpc: [] }
+ }
+ }
+ ]
+ };
+
+ transformItemsInCollection(collection);
+ const grpcRequest = collection.items[0];
+
+ expect(grpcRequest.type).toBe('grpc-request');
+ expect(grpcRequest.request.methodType).toBe('client-streaming');
+ expect(grpcRequest.request.protoPath).toBeUndefined();
+ });
+
+ it('should handle gRPC requests without method', () => {
+ const collection = {
+ uid: 'test-collection',
+ items: [
+ {
+ uid: 'grpc-request-1',
+ type: 'grpc',
+ name: 'Test gRPC',
+ request: {
+ url: 'grpc://localhost:50051',
+ methodType: 'unary',
+ protoPath: 'proto/service.proto',
+ body: { mode: 'grpc', grpc: [] }
+ }
+ }
+ ]
+ };
+
+ transformItemsInCollection(collection);
+ const grpcRequest = collection.items[0];
+
+ expect(grpcRequest.type).toBe('grpc-request');
+ expect(grpcRequest.request.method).toBeUndefined();
+ expect(grpcRequest.request.methodType).toBe('unary');
+ expect(grpcRequest.request.protoPath).toBe('proto/service.proto');
+ });
+ });
+});
diff --git a/packages/bruno-app/src/utils/tests/collections/items-sequencing.spec.js b/packages/bruno-app/src/utils/tests/collections/items-sequencing.spec.js
new file mode 100644
index 000000000..adfb5dab9
--- /dev/null
+++ b/packages/bruno-app/src/utils/tests/collections/items-sequencing.spec.js
@@ -0,0 +1,126 @@
+import { resetSequencesInFolder, isItemBetweenSequences } from 'utils/collections/index';
+
+describe('resetSequencesInFolder', () => {
+ it('should fix the sequences in the folder 1', () => {
+ const folder = {
+ items: [
+ { uid: '1', seq: 1 },
+ { uid: '2', seq: 3 },
+ { uid: '3', seq: 6 },
+ ],
+ };
+
+ const fixedFolder = resetSequencesInFolder(folder.items);
+ expect(fixedFolder).toEqual([
+ { uid: '1', seq: 1 },
+ { uid: '2', seq: 2 },
+ { uid: '3', seq: 3 },
+ ]);
+ });
+
+
+ it('should fix the sequences in the folder 2', () => {
+ const folder = {
+ items: [
+ { uid: '1', seq: 3 },
+ { uid: '2', seq: 1 },
+ { uid: '3', seq: 2 },
+ ],
+ };
+
+ const fixedFolder = resetSequencesInFolder(folder.items);
+ expect(fixedFolder).toEqual([
+ { uid: '2', seq: 1 },
+ { uid: '3', seq: 2 },
+ { uid: '1', seq: 3 },
+ ]);
+ });
+
+ it('should fix the sequences in the folder with missing sequences', () => {
+ const folder = {
+ items: [
+ { uid: '1', seq: 1 },
+ { uid: '2', type: 'folder' },
+ { uid: '3', type: 'folder' },
+ { uid: '4', seq: 7 },
+ ]
+ };
+
+ const fixedFolder = resetSequencesInFolder(folder.items);
+ expect(fixedFolder).toEqual([
+ { uid: '1', seq: 1 },
+ { uid: '2', seq: 2, type: 'folder' },
+ { uid: '3', seq: 3, type: 'folder' },
+ { uid: '4', seq: 4 },
+ ]);
+ });
+
+ it('should fix the sequences in the folder with same sequences', () => {
+ const folder = {
+ items: [
+ { uid: '1', seq: 2 },
+ { uid: '2', seq: 2 },
+ { uid: '3', seq: 3 },
+ { uid: '4', seq: 1 },
+ ],
+ };
+
+ const fixedFolder = resetSequencesInFolder(folder.items);
+ expect(fixedFolder).toEqual([
+ { uid: '4', seq: 1 },
+ { uid: '1', seq: 2 },
+ { uid: '2', seq: 3 },
+ { uid: '3', seq: 4 },
+ ]);
+ });
+});
+
+describe('isItemBetweenSequences', () => {
+ it('should return true if the item is between the sequences 1', () => {
+ const item = { uid: '1', seq: 2 };
+ const draggedSequence = 1;
+ const targetSequence = 5;
+ const result = isItemBetweenSequences(item?.seq, draggedSequence, targetSequence);
+ expect(result).toBe(true);
+ });
+
+ it('should return true if the item is between the sequences 2', () => {
+ const item = { uid: '1', seq: 2 };
+ const draggedSequence = 1;
+ const targetSequence = 5;
+ const result = isItemBetweenSequences(item?.seq, draggedSequence, targetSequence);
+ expect(result).toBe(true);
+ });
+
+ it('should return true if the item is between the sequences 3', () => {
+ const item = { uid: '1', seq: 4 };
+ const draggedSequence = 1;
+ const targetSequence = 5;
+ const result = isItemBetweenSequences(item?.seq, draggedSequence, targetSequence);
+ expect(result).toBe(true);
+ });
+
+ it('should return true if the item is between the sequences 4', () => {
+ const item = { uid: '1', seq: 1 };
+ const draggedSequence = 5;
+ const targetSequence = 1;
+ const result = isItemBetweenSequences(item?.seq, draggedSequence, targetSequence);
+ expect(result).toBe(true);
+ });
+
+ it('should return false if the item is between the sequences 1', () => {
+ const item = { uid: '1', seq: 1 };
+ const draggedSequence = 1;
+ const targetSequence = 5;
+ const result = isItemBetweenSequences(item?.seq, draggedSequence, targetSequence);
+ expect(result).toBe(false);
+ });
+
+ it('should return false if the item is between the sequences 2', () => {
+ const item = { uid: '1', seq: 5 };
+ const draggedSequence = 1;
+ const targetSequence = 5;
+ const result = isItemBetweenSequences(item?.seq, draggedSequence, targetSequence);
+ expect(result).toBe(false);
+ });
+});
diff --git a/packages/bruno-app/src/utils/url/index.js b/packages/bruno-app/src/utils/url/index.js
index 852b5fab3..a8ac1b812 100644
--- a/packages/bruno-app/src/utils/url/index.js
+++ b/packages/bruno-app/src/utils/url/index.js
@@ -1,11 +1,6 @@
-import isEmpty from 'lodash/isEmpty';
-import trim from 'lodash/trim';
-import each from 'lodash/each';
-import filter from 'lodash/filter';
import find from 'lodash/find';
-import brunoCommon from '@usebruno/common';
-const { interpolate } = brunoCommon;
+import { interpolate } from '@usebruno/common';
const hasLength = (str) => {
if (!str || !str.length) {
@@ -17,20 +12,6 @@ const hasLength = (str) => {
return str.length > 0;
};
-export const parseQueryParams = (query) => {
- try {
- if (!query || !query.length) {
- return [];
- }
-
- return Array.from(new URLSearchParams(query.split('#')[0]).entries())
- .map(([name, value]) => ({ name, value }));
- } catch (error) {
- console.error('Error parsing query params:', error);
- return [];
- }
-};
-
export const parsePathParams = (url) => {
let uri = url.slice();
@@ -66,26 +47,6 @@ export const parsePathParams = (url) => {
return paths;
};
-export const stringifyQueryParams = (params) => {
- if (!params || isEmpty(params)) {
- return '';
- }
-
- let queryString = [];
- each(params, (p) => {
- const hasEmptyName = isEmpty(trim(p.name));
- const hasEmptyVal = isEmpty(trim(p.value));
-
- // query param name must be present
- if (!hasEmptyName) {
- // if query param value is missing, push only , else push
- queryString.push(hasEmptyVal ? p.name : `${p.name}=${p.value}`);
- }
- });
-
- return queryString.join('&');
-};
-
export const splitOnFirst = (str, char) => {
if (!str || !str.length) {
return [str];
@@ -108,21 +69,12 @@ export const isValidUrl = (url) => {
}
};
-export const interpolateUrl = ({ url, globalEnvironmentVariables = {}, envVars, runtimeVariables, processEnvVars }) => {
+export const interpolateUrl = ({ url, variables }) => {
if (!url || !url.length || typeof url !== 'string') {
return;
}
- return interpolate(url, {
- ...globalEnvironmentVariables,
- ...envVars,
- ...runtimeVariables,
- process: {
- env: {
- ...processEnvVars
- }
- }
- });
+ return interpolate(url, variables);
};
export const interpolateUrlPathParams = (url, params) => {
diff --git a/packages/bruno-app/src/utils/url/index.spec.js b/packages/bruno-app/src/utils/url/index.spec.js
index 0645befee..bbcc919c8 100644
--- a/packages/bruno-app/src/utils/url/index.spec.js
+++ b/packages/bruno-app/src/utils/url/index.spec.js
@@ -1,72 +1,4 @@
-import { parseQueryParams, splitOnFirst, parsePathParams, interpolateUrl, interpolateUrlPathParams } from './index';
-
-describe('Url Utils - parseQueryParams', () => {
- it('should parse query - case 1', () => {
- const params = parseQueryParams('');
- expect(params).toEqual([]);
- });
-
- it('should parse query - case 2', () => {
- const params = parseQueryParams('a');
- expect(params).toEqual([{ name: 'a', value: '' }]);
- });
-
- it('should parse query - case 3', () => {
- const params = parseQueryParams('a=');
- expect(params).toEqual([{ name: 'a', value: '' }]);
- });
-
- it('should parse query - case 4', () => {
- const params = parseQueryParams('a=1');
- expect(params).toEqual([{ name: 'a', value: '1' }]);
- });
-
- it('should parse query - case 5', () => {
- const params = parseQueryParams('a=1&');
- expect(params).toEqual([{ name: 'a', value: '1' }]);
- });
-
- it('should parse query - case 6', () => {
- const params = parseQueryParams('a=1&b');
- expect(params).toEqual([
- { name: 'a', value: '1' },
- { name: 'b', value: '' }
- ]);
- });
-
- it('should parse query - case 7', () => {
- const params = parseQueryParams('a=1&b=');
- expect(params).toEqual([
- { name: 'a', value: '1' },
- { name: 'b', value: '' }
- ]);
- });
-
- it('should parse query - case 8', () => {
- const params = parseQueryParams('a=1&b=2');
- expect(params).toEqual([
- { name: 'a', value: '1' },
- { name: 'b', value: '2' }
- ]);
- });
-
- it('should parse query with "=" character - case 9', () => {
- const params = parseQueryParams('a=1&b={color=red,size=large}&c=3');
- expect(params).toEqual([
- { name: 'a', value: '1' },
- { name: 'b', value: '{color=red,size=large}' },
- { name: 'c', value: '3' }
- ]);
- });
-
- it('should parse query with fragment - case 10', () => {
- const params = parseQueryParams('a=1&b=2#I-AM-FRAGMENT');
- expect(params).toEqual([
- { name: 'a', value: '1' },
- { name: 'b', value: '2' }
- ]);
- });
-});
+import { splitOnFirst, parsePathParams, interpolateUrl, interpolateUrlPathParams } from './index';
describe('Url Utils - parsePathParams', () => {
it('should parse path - case 1', () => {
@@ -145,11 +77,7 @@ describe('Url Utils - interpolateUrl, interpolateUrlPathParams', () => {
const url = '{{host}}/api/:id/path?foo={{foo}}&bar={{bar}}&baz={{process.env.baz}}';
const expectedUrl = 'https://example.com/api/:id/path?foo=foo_value&bar=bar_value&baz=baz_value';
- const envVars = { host: 'https://example.com', foo: 'foo_value' };
- const runtimeVariables = { bar: 'bar_value' };
- const processEnvVars = { baz: 'baz_value' };
-
- const result = interpolateUrl({ url, envVars, runtimeVariables, processEnvVars });
+ const result = interpolateUrl({ url, variables: { host: 'https://example.com', foo: 'foo_value', bar: 'bar_value', 'process.env.baz': 'baz_value' } });
expect(result).toEqual(expectedUrl);
});
@@ -169,11 +97,7 @@ describe('Url Utils - interpolateUrl, interpolateUrlPathParams', () => {
const params = [{ name: 'id', type: 'path', enabled: true, value: '123' }];
const expectedUrl = 'https://example.com/api/123/path?foo=foo_value&bar=bar_value&baz=baz_value';
- const envVars = { host: 'https://example.com', foo: 'foo_value' };
- const runtimeVariables = { bar: 'bar_value' };
- const processEnvVars = { baz: 'baz_value' };
-
- const intermediateResult = interpolateUrl({ url, envVars, runtimeVariables, processEnvVars });
+ const intermediateResult = interpolateUrl({ url, variables: { host: 'https://example.com', foo: 'foo_value', bar: 'bar_value', 'process.env.baz': 'baz_value' } });
const result = interpolateUrlPathParams(intermediateResult, params);
expect(result).toEqual(expectedUrl);
diff --git a/packages/bruno-cli/package.json b/packages/bruno-cli/package.json
index 8353e8ba8..c298273b4 100644
--- a/packages/bruno-cli/package.json
+++ b/packages/bruno-cli/package.json
@@ -46,13 +46,16 @@
"package.json"
],
"dependencies": {
- "@aws-sdk/credential-providers": "3.658.1",
+ "@aws-sdk/credential-providers": "3.750.0",
"@usebruno/common": "0.1.0",
+ "@usebruno/converters": "^0.1.0",
+ "@usebruno/filestore": "^0.1.0",
"@usebruno/js": "0.12.0",
"@usebruno/lang": "0.12.0",
+ "@usebruno/requests": "^0.1.0",
"@usebruno/vm2": "^3.9.13",
"aws4-axios": "^3.3.0",
- "axios": "1.7.5",
+ "axios": "^1.8.3",
"axios-ntlm": "^1.4.2",
"chai": "^4.3.7",
"chalk": "^3.0.0",
@@ -62,11 +65,10 @@
"http-proxy-agent": "^7.0.0",
"https-proxy-agent": "^7.0.2",
"iconv-lite": "^0.6.3",
+ "js-yaml": "^4.1.0",
"lodash": "^4.17.21",
"qs": "^6.11.0",
"socks-proxy-agent": "^8.0.2",
- "tough-cookie": "^4.1.3",
- "@usebruno/vm2": "^3.9.13",
"xmlbuilder": "^15.1.1",
"yargs": "^17.6.2"
}
diff --git a/packages/bruno-cli/readme.md b/packages/bruno-cli/readme.md
index ec82267fb..c1d38f457 100644
--- a/packages/bruno-cli/readme.md
+++ b/packages/bruno-cli/readme.md
@@ -1,9 +1,11 @@
-# bruno-cli
+# Bruno CLI
With Bruno CLI, you can now run your API collections with ease using simple command line commands.
This makes it easier to test your APIs in different environments, automate your testing process, and integrate your API tests with your continuous integration and deployment workflows.
+For detailed documentation, visit [Bruno CLI Documentation](https://docs.usebruno.com/bru-cli/overview).
+
## Installation
To install the Bruno CLI, use the node package manager of your choice, such as NPM:
@@ -56,6 +58,68 @@ If you need to limit the trusted CA to a specified set when validating the reque
bru run request.bru --cacert myCustomCA.pem --ignore-truststore
```
+## Importing Collections
+
+You can import collections from other formats, such as OpenAPI, using the import command:
+
+```bash
+bru import openapi --source api.yml --output ~/Desktop/my-collection --collection-name "My API"
+```
+
+You can also use the shorter form with aliases:
+
+```bash
+bru import openapi -s api.yml -o ~/Desktop/my-collection -n "My API"
+```
+
+This creates a Bruno collection directory that can be opened in Bruno.
+
+You can also import directly from a URL:
+
+```bash
+bru import openapi --source https://example.com/api-spec.json --output ~/Desktop --collection-name "Remote API"
+```
+
+You can also export the collection as a JSON file:
+
+```bash
+bru import openapi --source api.yml --output-file ~/Desktop/my-collection.json --collection-name "My API"
+```
+
+Import Options:
+
+| Option | Details |
+| ------------------------- | -------------------------------------------------- |
+| --source, -s | Path to the source file or URL (required) |
+| --output, -o | Path to the output directory |
+| --output-file, -f | Path to the output JSON file |
+| --collection-name, -n | Name for the imported collection |
+| --insecure | Skip SSL certificate validation when fetching from URLs |
+
+## Command Line Options
+
+| Option | Details |
+| ---------------------------- | ----------------------------------------------------------------------------- |
+| -h, --help | Show help |
+| --version | Show version number |
+| -r | Indicates a recursive run (default: false) |
+| --cacert [string] | CA certificate to verify peer against |
+| --env [string] | Specify environment to run with |
+| --env-var [string] | Overwrite a single environment variable, multiple usages possible |
+| -o, --output [string] | Path to write file results to |
+| -f, --format [string] | Format of the file results; available formats are "json" (default) or "junit" |
+| --reporter-json [string] | Path to generate a JSON report |
+| --reporter-junit [string] | Path to generate a JUnit report |
+| --reporter-html [string] | Path to generate an HTML report |
+| --insecure | Allow insecure server connections |
+| --tests-only | Only run requests that have tests |
+| --bail | Stop execution after a failure of a request, test, or assertion |
+| --csv-file-path | CSV file to run the collection with |
+| --reporter--skip-all-headers | Skip all headers in the report |
+| --reporter-skip-headers | Skip specific headers in the report |
+| --client-cert-config | Client certificate configuration by passing a JSON file |
+| --delay [number] | Add delay to each request |
+
## Scripting
Bruno cli returns the following exit status codes:
diff --git a/packages/bruno-cli/src/commands/import.js b/packages/bruno-cli/src/commands/import.js
new file mode 100644
index 000000000..dd12a8bc3
--- /dev/null
+++ b/packages/bruno-cli/src/commands/import.js
@@ -0,0 +1,230 @@
+const fs = require('fs');
+const path = require('path');
+const chalk = require('chalk');
+const jsyaml = require('js-yaml');
+const axios = require('axios');
+const { openApiToBruno } = require('@usebruno/converters');
+const { exists, isDirectory, sanitizeName } = require('../utils/filesystem');
+const { createCollectionFromBrunoObject } = require('../utils/collection');
+
+const command = 'import ';
+const desc = 'Import a collection from other formats';
+
+const builder = (yargs) => {
+ yargs
+ .positional('type', {
+ describe: 'Type of collection to import',
+ type: 'string',
+ choices: ['openapi']
+ })
+ .option('source', {
+ alias: 's',
+ describe: 'Path to the source file or URL',
+ type: 'string',
+ demandOption: true
+ })
+ .option('output', {
+ alias: 'o',
+ describe: 'Path to the output directory',
+ type: 'string',
+ conflicts: 'output-file'
+ })
+ .option('output-file', {
+ alias: 'f',
+ describe: 'Path to the output JSON file',
+ type: 'string',
+ conflicts: 'output'
+ })
+ .option('collection-name', {
+ alias: 'n',
+ describe: 'Name for the imported collection',
+ type: 'string'
+ })
+ .option('insecure', {
+ type: 'boolean',
+ describe: 'Skip SSL certificate verification when fetching from URLs',
+ default: false
+ })
+ .example('$0 import openapi --source api.yml --output ~/Desktop/my-collection --collection-name "My API"')
+ .example('$0 import openapi -s api.yml -o ~/Desktop/my-collection -n "My API"')
+ .example('$0 import openapi --source https://example.com/api-spec.json --output ~/Desktop --collection-name "Remote API"')
+ .example('$0 import openapi --source https://self-signed.example.com/api.json --insecure --output ~/Desktop')
+ .example('$0 import openapi --source api.yml --output-file ~/Desktop/my-collection.json --collection-name "My API"')
+ .example('$0 import openapi -s api.yml -f ~/Desktop/my-collection.json -n "My API"');
+};
+
+const isUrl = (str) => {
+ try {
+ return Boolean(new URL(str));
+ } catch (error) {
+ return false;
+ }
+};
+
+const readOpenApiFile = async (source, options = {}) => {
+ try {
+ let content;
+
+ if (isUrl(source)) {
+ // Handle URL input
+ console.log(chalk.yellow(`Fetching specification from URL: ${source}`));
+ try {
+ const axiosOptions = {
+ timeout: 30000, // 30 second timeout
+ maxContentLength: 10 * 1024 * 1024,
+ validateStatus: status => status >= 200 && status < 300
+ };
+
+ // Skip SSL certificate validation if insecure flag is set
+ if (options.insecure) {
+ console.log(chalk.yellow('Warning: SSL certificate verification is disabled. Use with caution.'));
+ axiosOptions.httpsAgent = new (require('https')).Agent({ rejectUnauthorized: false });
+ }
+
+ const response = await axios.get(source, axiosOptions);
+ content = response.data;
+ } catch (error) {
+ if (error.code === 'ECONNABORTED') {
+ throw new Error('Request timed out. The server took too long to respond.');
+ } else if (error.code === 'CERT_HAS_EXPIRED' || error.code === 'DEPTH_ZERO_SELF_SIGNED_CERT' ||
+ error.code === 'ERR_TLS_CERT_ALTNAME_INVALID') {
+ throw new Error(`SSL Certificate error: ${error.code}. Try using --insecure if you trust this source.`);
+ } else if (error.response) {
+ throw new Error(`Failed to fetch from URL: ${error.response.status} ${error.response.statusText}`);
+ } else if (error.request) {
+ throw new Error(`No response received from server. Check the URL and your network connection.`);
+ } else {
+ throw new Error(`Error fetching URL: ${error.message}`);
+ }
+ }
+
+ // If response is already an object, return it directly
+ if (typeof content === 'object' && content !== null) {
+ return content;
+ }
+ } else {
+ // Handle file input
+ if (!await exists(source)) {
+ throw new Error(`File does not exist: ${source}`);
+ }
+ content = fs.readFileSync(source, 'utf8');
+ }
+
+ // If content is a string, try to parse as JSON or YAML
+ if (typeof content === 'string') {
+ try {
+ return JSON.parse(content);
+ } catch (jsonError) {
+ try {
+ return jsyaml.load(content);
+ } catch (yamlError) {
+ throw new Error('Failed to parse content as JSON or YAML');
+ }
+ }
+ }
+
+ return content;
+ } catch (error) {
+ // Let the specific error handling from above propagate
+ throw error;
+ }
+};
+
+const handler = async (argv) => {
+ try {
+ const { type, source, output, outputFile, collectionName, insecure } = argv;
+
+ if (!type || type !== 'openapi') {
+ console.error(chalk.red('Only OpenAPI import is supported currently'));
+ process.exit(1);
+ }
+
+ if (!source) {
+ console.error(chalk.red('Source file or URL is required'));
+ process.exit(1);
+ }
+
+ if (!output && !outputFile) {
+ console.error(chalk.red('Either --output or --output-file is required'));
+ process.exit(1);
+ }
+
+ console.log(chalk.yellow(`Reading OpenAPI specification from ${source}...`));
+
+ const openApiSpec = await readOpenApiFile(source, { insecure });
+
+ if (!openApiSpec) {
+ console.error(chalk.red('Failed to parse OpenAPI specification'));
+ process.exit(1);
+ }
+
+ console.log(chalk.yellow('Converting OpenAPI specification to Bruno format...'));
+
+ // Convert OpenAPI to Bruno format
+ let brunoCollection = openApiToBruno(openApiSpec);
+
+ // Override collection name if provided
+ if (collectionName) {
+ brunoCollection.name = collectionName;
+ }
+
+ if (outputFile) {
+ // Save as JSON file
+ const outputPath = path.resolve(outputFile);
+ fs.writeFileSync(outputPath, JSON.stringify(brunoCollection, null, 2));
+ console.log(chalk.green(`Bruno collection saved as JSON to ${outputPath}`));
+ } else if (output) {
+ const resolvedOutput = path.resolve(output);
+
+ // Check if output is an existing directory
+ const isOutputDirectory = await exists(resolvedOutput) && isDirectory(resolvedOutput);
+
+ // Determine the final output directory
+ let outputDir;
+ if (isOutputDirectory) {
+ // If output is an existing directory, use collection name to create a subdirectory
+ const dirName = sanitizeName(brunoCollection.name);
+ outputDir = path.join(resolvedOutput, dirName);
+
+ // Check if this subfolder already exists
+ if (await exists(outputDir)) {
+ const dirContents = fs.readdirSync(outputDir);
+ if (dirContents.length > 0) {
+ console.error(chalk.red(`Output directory is not empty: ${outputDir}`));
+ process.exit(1);
+ }
+ } else {
+ // Create the subfolder
+ fs.mkdirSync(outputDir, { recursive: true });
+ }
+ } else {
+ // If output doesn't exist or is not a directory, use it directly
+ outputDir = resolvedOutput;
+
+ // Check if parent directory exists
+ const parentDir = path.dirname(outputDir);
+ if (!await exists(parentDir)) {
+ console.error(chalk.red(`Parent directory does not exist: ${parentDir}`));
+ process.exit(1);
+ }
+
+ fs.mkdirSync(outputDir, { recursive: true });
+ }
+
+ await createCollectionFromBrunoObject(brunoCollection, outputDir);
+ console.log(chalk.green(`Bruno collection created at ${outputDir}`));
+ }
+ } catch (error) {
+ console.error(chalk.red(`Error: ${error.message}`));
+ process.exit(1);
+ }
+};
+
+module.exports = {
+ command,
+ desc,
+ builder,
+ handler,
+ isUrl,
+ readOpenApiFile
+};
\ No newline at end of file
diff --git a/packages/bruno-cli/src/commands/run.js b/packages/bruno-cli/src/commands/run.js
index 29edf63b9..e3b7aa3ea 100644
--- a/packages/bruno-cli/src/commands/run.js
+++ b/packages/bruno-cli/src/commands/run.js
@@ -2,252 +2,102 @@ const fs = require('fs');
const chalk = require('chalk');
const path = require('path');
const { forOwn, cloneDeep } = require('lodash');
+const { getRunnerSummary } = require('@usebruno/common/runner');
const { exists, isFile, isDirectory } = require('../utils/filesystem');
const { runSingleRequest } = require('../runner/run-single-request');
-const { bruToEnvJson, getEnvVars } = require('../utils/bru');
+const { getEnvVars } = require('../utils/bru');
+const { isRequestTagsIncluded } = require("@usebruno/common")
const makeJUnitOutput = require('../reporters/junit');
const makeHtmlOutput = require('../reporters/html');
const { rpad } = require('../utils/common');
-const { bruToJson, getOptions, collectionBruToJson } = require('../utils/bru');
-const { dotenvToJson } = require('@usebruno/lang');
+const { getOptions } = require('../utils/bru');
+const { parseDotEnv, parseEnvironment } = require('@usebruno/filestore');
const constants = require('../constants');
-const command = 'run [filename]';
-const desc = 'Run a request';
+const { findItemInCollection, createCollectionJsonFromPathname, getCallStack } = require('../utils/collection');
+const { hasExecutableTestInScript } = require('../utils/request');
+const command = 'run [paths...]';
+const desc = 'Run one or more requests/folders';
+
+const formatTestSummary = (label, maxLength, passed, failed, total, errorCount = 0, skippedCount = 0) => {
+ const parts = [
+ `${rpad(label, maxLength)} ${chalk.green(`${passed} passed`)}`
+ ];
+
+ if (failed > 0) parts.push(chalk.red(`${failed} failed`));
+ if (errorCount > 0) parts.push(chalk.red(`${errorCount} error`));
+ if (skippedCount > 0) parts.push(chalk.magenta(`${skippedCount} skipped`));
+
+ parts.push(`${total} total`);
+
+ return parts.join(', ');
+};
const printRunSummary = (results) => {
- let totalRequests = 0;
- let passedRequests = 0;
- let failedRequests = 0;
- let totalAssertions = 0;
- let passedAssertions = 0;
- let failedAssertions = 0;
- let totalTests = 0;
- let passedTests = 0;
- let failedTests = 0;
-
- for (const result of results) {
- totalRequests += 1;
- totalTests += result.testResults.length;
- totalAssertions += result.assertionResults.length;
- let anyFailed = false;
- let hasAnyTestsOrAssertions = false;
- for (const testResult of result.testResults) {
- hasAnyTestsOrAssertions = true;
- if (testResult.status === 'pass') {
- passedTests += 1;
- } else {
- anyFailed = true;
- failedTests += 1;
- }
- }
- for (const assertionResult of result.assertionResults) {
- hasAnyTestsOrAssertions = true;
- if (assertionResult.status === 'pass') {
- passedAssertions += 1;
- } else {
- anyFailed = true;
- failedAssertions += 1;
- }
- }
- if (!hasAnyTestsOrAssertions && result.error) {
- failedRequests += 1;
- } else {
- passedRequests += 1;
- }
- }
-
- const maxLength = 12;
-
- let requestSummary = `${rpad('Requests:', maxLength)} ${chalk.green(`${passedRequests} passed`)}`;
- if (failedRequests > 0) {
- requestSummary += `, ${chalk.red(`${failedRequests} failed`)}`;
- }
- requestSummary += `, ${totalRequests} total`;
-
- let assertSummary = `${rpad('Tests:', maxLength)} ${chalk.green(`${passedTests} passed`)}`;
- if (failedTests > 0) {
- assertSummary += `, ${chalk.red(`${failedTests} failed`)}`;
- }
- assertSummary += `, ${totalTests} total`;
-
- let testSummary = `${rpad('Assertions:', maxLength)} ${chalk.green(`${passedAssertions} passed`)}`;
- if (failedAssertions > 0) {
- testSummary += `, ${chalk.red(`${failedAssertions} failed`)}`;
- }
- testSummary += `, ${totalAssertions} total`;
-
- console.log('\n' + chalk.bold(requestSummary));
- console.log(chalk.bold(assertSummary));
- console.log(chalk.bold(testSummary));
-
- return {
+ const {
totalRequests,
passedRequests,
failedRequests,
+ skippedRequests,
+ errorRequests,
totalAssertions,
passedAssertions,
failedAssertions,
totalTests,
passedTests,
- failedTests
- };
-};
+ failedTests,
+ totalPreRequestTests,
+ passedPreRequestTests,
+ failedPreRequestTests,
+ totalPostResponseTests,
+ passedPostResponseTests,
+ failedPostResponseTests
+ } = getRunnerSummary(results);
-const createCollectionFromPath = (collectionPath) => {
- const environmentsPath = path.join(collectionPath, `environments`);
- const getFilesInOrder = (collectionPath) => {
- let collection = {
- pathname: collectionPath
- };
- const traverse = (currentPath) => {
- const filesInCurrentDir = fs.readdirSync(currentPath);
+ const maxLength = 12;
- if (currentPath.includes('node_modules')) {
- return;
- }
- const currentDirItems = [];
- for (const file of filesInCurrentDir) {
- const filePath = path.join(currentPath, file);
- const stats = fs.lstatSync(filePath);
- if (
- stats.isDirectory() &&
- filePath !== environmentsPath &&
- !filePath.startsWith('.git') &&
- !filePath.startsWith('node_modules')
- ) {
- let folderItem = { name: file, pathname: filePath, type: 'folder', items: traverse(filePath) }
- const folderBruFilePath = path.join(filePath, 'folder.bru');
- const folderBruFileExists = fs.existsSync(folderBruFilePath);
- if(folderBruFileExists) {
- const folderBruContent = fs.readFileSync(folderBruFilePath, 'utf8');
- let folderBruJson = collectionBruToJson(folderBruContent);
- folderItem.root = folderBruJson;
- }
- currentDirItems.push(folderItem);
- }
- }
+ const requestSummary = formatTestSummary('Requests:', maxLength, passedRequests, failedRequests, totalRequests, errorRequests, skippedRequests);
+ const testSummary = formatTestSummary('Tests:', maxLength, passedTests, failedTests, totalTests);
+ const assertSummary = formatTestSummary('Assertions:', maxLength, passedAssertions, failedAssertions, totalAssertions);
- for (const file of filesInCurrentDir) {
- if (['collection.bru', 'folder.bru'].includes(file)) {
- continue;
- }
- const filePath = path.join(currentPath, file);
- const stats = fs.lstatSync(filePath);
-
- if (!stats.isDirectory() && path.extname(filePath) === '.bru') {
- const bruContent = fs.readFileSync(filePath, 'utf8');
- const bruJson = bruToJson(bruContent);
- currentDirItems.push({
- name: file,
- pathname: filePath,
- ...bruJson
- });
- }
- }
- return currentDirItems
- };
- collection.items = traverse(collectionPath);
- return collection;
- };
- return getFilesInOrder(collectionPath);
-};
-
-const getBruFilesRecursively = (dir, testsOnly) => {
- const environmentsPath = 'environments';
- const collection = {};
-
- const getFilesInOrder = (dir) => {
- let bruJsons = [];
-
- const traverse = (currentPath) => {
- const filesInCurrentDir = fs.readdirSync(currentPath);
-
- if (currentPath.includes('node_modules')) {
- return;
- }
-
- for (const file of filesInCurrentDir) {
- const filePath = path.join(currentPath, file);
- const stats = fs.lstatSync(filePath);
-
- // todo: we might need a ignore config inside bruno.json
- if (
- stats.isDirectory() &&
- filePath !== environmentsPath &&
- !filePath.startsWith('.git') &&
- !filePath.startsWith('node_modules')
- ) {
- traverse(filePath);
- }
- }
-
- const currentDirBruJsons = [];
- for (const file of filesInCurrentDir) {
- if (['collection.bru', 'folder.bru'].includes(file)) {
- continue;
- }
- const filePath = path.join(currentPath, file);
- const stats = fs.lstatSync(filePath);
-
- if (!stats.isDirectory() && path.extname(filePath) === '.bru') {
- const bruContent = fs.readFileSync(filePath, 'utf8');
- const bruJson = bruToJson(bruContent);
- const requestHasTests = bruJson.request?.tests;
- const requestHasActiveAsserts = bruJson.request?.assertions.some((x) => x.enabled) || false;
-
- if (testsOnly) {
- if (requestHasTests || requestHasActiveAsserts) {
- currentDirBruJsons.push({
- bruFilepath: filePath,
- bruJson
- });
- }
- } else {
- currentDirBruJsons.push({
- bruFilepath: filePath,
- bruJson
- });
- }
- }
- }
-
- // order requests by sequence
- currentDirBruJsons.sort((a, b) => {
- const aSequence = a.bruJson.seq || 0;
- const bSequence = b.bruJson.seq || 0;
- return aSequence - bSequence;
- });
-
- bruJsons = bruJsons.concat(currentDirBruJsons);
- };
-
- traverse(dir);
- return bruJsons;
- };
-
- return getFilesInOrder(dir);
-};
-
-const getCollectionRoot = (dir) => {
- const collectionRootPath = path.join(dir, 'collection.bru');
- const exists = fs.existsSync(collectionRootPath);
- if (!exists) {
- return {};
+ let preRequestTestSummary = '';
+ if (totalPreRequestTests > 0) {
+ preRequestTestSummary = formatTestSummary('Pre-Request Tests:', maxLength, passedPreRequestTests, failedPreRequestTests, totalPreRequestTests);
}
- const content = fs.readFileSync(collectionRootPath, 'utf8');
- return collectionBruToJson(content);
-};
-
-const getFolderRoot = (dir) => {
- const folderRootPath = path.join(dir, 'folder.bru');
- const exists = fs.existsSync(folderRootPath);
- if (!exists) {
- return {};
+ let postResponseTestSummary = '';
+ if (totalPostResponseTests > 0) {
+ postResponseTestSummary = formatTestSummary('Post-Response Tests:', maxLength, passedPostResponseTests, failedPostResponseTests, totalPostResponseTests);
}
- const content = fs.readFileSync(folderRootPath, 'utf8');
- return collectionBruToJson(content);
+ console.log('\n' + chalk.bold(requestSummary));
+ if (preRequestTestSummary) {
+ console.log(chalk.bold(preRequestTestSummary));
+ }
+ if (postResponseTestSummary) {
+ console.log(chalk.bold(postResponseTestSummary));
+ }
+ console.log(chalk.bold(testSummary));
+ console.log(chalk.bold(assertSummary));
+
+ return {
+ totalRequests,
+ passedRequests,
+ failedRequests,
+ skippedRequests,
+ errorRequests,
+ totalAssertions,
+ passedAssertions,
+ failedAssertions,
+ totalTests,
+ passedTests,
+ failedTests,
+ totalPreRequestTests,
+ passedPreRequestTests,
+ failedPreRequestTests,
+ totalPostResponseTests,
+ passedPostResponseTests,
+ failedPostResponseTests
+ }
};
const getJsSandboxRuntime = (sandbox) => {
@@ -280,12 +130,16 @@ const builder = async (yargs) => {
describe: 'Environment variables',
type: 'string'
})
+ .option('env-file', {
+ describe: 'Path to environment file (.bru) - can be absolute or relative path',
+ type: 'string'
+ })
.option('env-var', {
describe: 'Overwrite a single environment variable, multiple usages possible',
type: 'string'
})
.option('sandbox', {
- describe: 'Javscript sandbox to use; available sandboxes are "developer" (default) or "safe"',
+ describe: 'Javascript sandbox to use; available sandboxes are "developer" (default) or "safe"',
default: 'developer',
type: 'string'
})
@@ -338,11 +192,29 @@ const builder = async (yargs) => {
type: 'string',
description: 'Path to the Client certificate config file used for securing the connection in the request'
})
-
+ .option('--noproxy', {
+ type: 'boolean',
+ description: 'Disable all proxy settings (both collection-defined and system proxies)',
+ default: false
+ })
+ .option('delay', {
+ type:"number",
+ description: "Delay between each requests (in miliseconds)"
+ })
+ .option('tags', {
+ type: 'string',
+ description: 'Tags to include in the run'
+ })
+ .option('exclude-tags', {
+ type: 'string',
+ description: 'Tags to exclude from the run'
+ })
.example('$0 run request.bru', 'Run a request')
.example('$0 run request.bru --env local', 'Run a request with the environment set to local')
+ .example('$0 run request.bru --env-file env.bru', 'Run a request with the environment from env.bru file')
.example('$0 run folder', 'Run all requests in a folder')
.example('$0 run folder -r', 'Run all requests in a folder recursively')
+ .example('$0 run request.bru folder', 'Run a request and all requests in a folder')
.example('$0 run --reporter-skip-all-headers', 'Run all requests in a folder recursively with omitted headers from the reporter output')
.example(
'$0 run --reporter-skip-headers "Authorization"',
@@ -368,7 +240,6 @@ const builder = async (yargs) => {
'$0 run request.bru --reporter-junit results.xml --reporter-html results.html',
'Run a request and write the results to results.html in html format and results.xml in junit format in the current directory'
)
-
.example('$0 run request.bru --tests-only', 'Run all requests that have a test')
.example(
'$0 run request.bru --cacert myCustomCA.pem',
@@ -378,17 +249,24 @@ const builder = async (yargs) => {
'$0 run folder --cacert myCustomCA.pem --ignore-truststore',
'Use a custom CA certificate exclusively when validating the peers of the requests in the specified folder.'
)
- .example('$0 run --client-cert-config client-cert-config.json', 'Run a request with Client certificate configurations');
+ .example('$0 run --client-cert-config client-cert-config.json', 'Run a request with Client certificate configurations')
+ .example('$0 run folder --delay delayInMs', 'Run a folder with given miliseconds delay between each requests.')
+ .example('$0 run --noproxy', 'Run requests with system proxy disabled')
+ .example(
+ '$0 run folder --tags=hello,world --exclude-tags=skip',
+ 'Run only requests with tags "hello" or "world" and exclude any request with tag "skip".'
+ );
};
const handler = async function (argv) {
try {
let {
- filename,
+ paths,
cacert,
ignoreTruststore,
disableCookies,
env,
+ envFile,
envVar,
insecure,
r: recursive,
@@ -402,29 +280,16 @@ const handler = async function (argv) {
bail,
reporterSkipAllHeaders,
reporterSkipHeaders,
- clientCertConfig
+ clientCertConfig,
+ noproxy,
+ delay,
+ tags: includeTags,
+ excludeTags
} = argv;
const collectionPath = process.cwd();
- // todo
- // right now, bru must be run from the root of the collection
- // will add support in the future to run it from anywhere inside the collection
- const brunoJsonPath = path.join(collectionPath, 'bruno.json');
- const brunoJsonExists = await exists(brunoJsonPath);
- if (!brunoJsonExists) {
- console.error(chalk.red(`You can run only at the root of a collection`));
- process.exit(constants.EXIT_STATUS.ERROR_NOT_IN_COLLECTION);
- }
-
- const brunoConfigFile = fs.readFileSync(brunoJsonPath, 'utf8');
- const brunoConfig = JSON.parse(brunoConfigFile);
- const collectionRoot = getCollectionRoot(collectionPath);
- let collection = createCollectionFromPath(collectionPath);
- collection = {
- brunoConfig,
- root: collectionRoot,
- ...collection
- }
+ let collection = createCollectionJsonFromPathname(collectionPath);
+ const { root: collectionRoot, brunoConfig } = collection;
if (clientCertConfig) {
try {
@@ -460,34 +325,31 @@ const handler = async function (argv) {
}
}
-
- if (filename && filename.length) {
- const pathExists = await exists(filename);
- if (!pathExists) {
- console.error(chalk.red(`File or directory ${filename} does not exist`));
- process.exit(constants.EXIT_STATUS.ERROR_FILE_NOT_FOUND);
- }
- } else {
- filename = './';
- recursive = true;
- }
-
const runtimeVariables = {};
let envVars = {};
- if (env) {
- const envFile = path.join(collectionPath, 'environments', `${env}.bru`);
- const envPathExists = await exists(envFile);
+ if (env && envFile) {
+ console.error(chalk.red(`Cannot use both --env and --env-file options together`));
+ process.exit(constants.EXIT_STATUS.ERROR_MALFORMED_ENV_OVERRIDE);
+ }
+
+ if (envFile || env) {
+ const envFilePath = envFile
+ ? path.resolve(collectionPath, envFile)
+ : path.join(collectionPath, 'environments', `${env}.bru`);
+
+ const envFileExists = await exists(envFilePath);
+ if (!envFileExists) {
+ const errorPath = envFile || `environments/${env}.bru`;
+ console.error(chalk.red(`Environment file not found: `) + chalk.dim(errorPath));
- if (!envPathExists) {
- console.error(chalk.red(`Environment file not found: `) + chalk.dim(`environments/${env}.bru`));
process.exit(constants.EXIT_STATUS.ERROR_ENV_NOT_FOUND);
}
- const envBruContent = fs.readFileSync(envFile, 'utf8');
- const envJson = bruToEnvJson(envBruContent);
+ const envBruContent = fs.readFileSync(envFilePath, 'utf8').replace(/\r\n/g, '\n');
+ const envJson = parseEnvironment(envBruContent);
envVars = getEnvVars(envJson);
- envVars.__name__ = env;
+ envVars.__name__ = envFile ? path.basename(envFilePath, '.bru') : env;
}
if (envVar) {
@@ -507,7 +369,7 @@ const handler = async function (argv) {
if (!match) {
console.error(
chalk.red(`Overridable environment variable not correct: use name=value - presented: `) +
- chalk.dim(`${value}`)
+ chalk.dim(`${value}`)
);
process.exit(constants.EXIT_STATUS.ERROR_INCORRECT_ENV_OVERRIDE);
}
@@ -526,6 +388,9 @@ const handler = async function (argv) {
if (disableCookies) {
options['disableCookies'] = true;
}
+ if (noproxy) {
+ options['noproxy'] = true;
+ }
if (cacert && cacert.length) {
if (insecure) {
console.error(chalk.red(`Ignoring the cacert option since insecure connections are enabled`));
@@ -540,6 +405,9 @@ const handler = async function (argv) {
}
options['ignoreTruststore'] = ignoreTruststore;
+ includeTags = includeTags ? includeTags.split(',') : [];
+ excludeTags = excludeTags ? excludeTags.split(',') : [];
+
if (['json', 'junit', 'html'].indexOf(format) === -1) {
console.error(chalk.red(`Format must be one of "json", "junit or "html"`));
process.exit(constants.EXIT_STATUS.ERROR_INCORRECT_OUTPUT_FORMAT);
@@ -572,78 +440,89 @@ const handler = async function (argv) {
};
if (dotEnvExists) {
const content = fs.readFileSync(dotEnvPath, 'utf8');
- const jsonData = dotenvToJson(content);
+ const jsonData = parseDotEnv(content);
forOwn(jsonData, (value, key) => {
processEnvVars[key] = value;
});
}
- const _isFile = isFile(filename);
+ let requestItems = [];
let results = [];
- let bruJsons = [];
-
- if (_isFile) {
- console.log(chalk.yellow('Running Request \n'));
- const bruContent = fs.readFileSync(filename, 'utf8');
- const bruJson = bruToJson(bruContent);
- bruJsons.push({
- bruFilepath: filename,
- bruJson
- });
+ if (!paths || !paths.length) {
+ paths = ['./'];
+ recursive = true;
}
- const _isDirectory = isDirectory(filename);
- if (_isDirectory) {
- if (!recursive) {
- console.log(chalk.yellow('Running Folder \n'));
- const files = fs.readdirSync(filename);
- const bruFiles = files.filter((file) => !['folder.bru'].includes(file) && file.endsWith('.bru'));
+ const resolvedPaths = paths.map(p => path.resolve(process.cwd(), p));
- for (const bruFile of bruFiles) {
- const bruFilepath = path.join(filename, bruFile);
- const bruContent = fs.readFileSync(bruFilepath, 'utf8');
- const bruJson = bruToJson(bruContent);
- const requestHasTests = bruJson.request?.tests;
- const requestHasActiveAsserts = bruJson.request?.assertions.some((x) => x.enabled) || false;
- if (testsOnly) {
- if (requestHasTests || requestHasActiveAsserts) {
- bruJsons.push({
- bruFilepath,
- bruJson
- });
- }
- } else {
- bruJsons.push({
- bruFilepath,
- bruJson
- });
- }
- }
- bruJsons.sort((a, b) => {
- const aSequence = a.bruJson.seq || 0;
- const bSequence = b.bruJson.seq || 0;
- return aSequence - bSequence;
- });
- } else {
- console.log(chalk.yellow('Running Folder Recursively \n'));
-
- bruJsons = getBruFilesRecursively(filename, testsOnly);
+ for (const resolvedPath of resolvedPaths) {
+ const pathExists = await exists(resolvedPath);
+ if (!pathExists) {
+ console.error(chalk.red(`Path not found: ${resolvedPath}`));
+ process.exit(constants.EXIT_STATUS.ERROR_FILE_NOT_FOUND);
}
}
+ requestItems = getCallStack(resolvedPaths, collection, { recursive });
+
+ if (testsOnly) {
+ requestItems = requestItems.filter((item) => {
+ const requestHasTests = hasExecutableTestInScript(item.request?.tests);
+ const requestHasActiveAsserts = item.request?.assertions.some((x) => x.enabled) || false;
+
+ const preRequestScript = item.request?.script?.req;
+ const requestHasPreRequestTests = hasExecutableTestInScript(preRequestScript);
+
+ const postResponseScript = item.request?.script?.res;
+ const requestHasPostResponseTests = hasExecutableTestInScript(postResponseScript);
+
+ return requestHasTests || requestHasActiveAsserts || requestHasPreRequestTests || requestHasPostResponseTests;
+ });
+ }
+
+ requestItems = requestItems.filter((item) => {
+ return isRequestTagsIncluded(item.tags, includeTags, excludeTags);
+ });
+
const runtime = getJsSandboxRuntime(sandbox);
+
+ const runSingleRequestByPathname = async (relativeItemPathname) => {
+ return new Promise(async (resolve, reject) => {
+ let itemPathname = path.join(collectionPath, relativeItemPathname);
+ if (itemPathname && !itemPathname?.endsWith('.bru')) {
+ itemPathname = `${itemPathname}.bru`;
+ }
+ const requestItem = cloneDeep(findItemInCollection(collection, itemPathname));
+ if (requestItem) {
+ const res = await runSingleRequest(
+ requestItem,
+ collectionPath,
+ runtimeVariables,
+ envVars,
+ processEnvVars,
+ brunoConfig,
+ collectionRoot,
+ runtime,
+ collection,
+ runSingleRequestByPathname
+ );
+ resolve(res?.response);
+ }
+ reject(`bru.runRequest: invalid request path - ${itemPathname}`);
+ });
+ }
+
let currentRequestIndex = 0;
let nJumps = 0; // count the number of jumps to avoid infinite loops
- while (currentRequestIndex < bruJsons.length) {
- const iter = cloneDeep(bruJsons[currentRequestIndex]);
- const { bruFilepath, bruJson } = iter;
+ while (currentRequestIndex < requestItems.length) {
+ const requestItem = cloneDeep(requestItems[currentRequestIndex]);
+ const { pathname } = requestItem;
const start = process.hrtime();
const result = await runSingleRequest(
- bruFilepath,
- bruJson,
+ requestItem,
collectionPath,
runtimeVariables,
envVars,
@@ -651,13 +530,25 @@ const handler = async function (argv) {
brunoConfig,
collectionRoot,
runtime,
- collection
+ collection,
+ runSingleRequestByPathname
);
+ const isLastRun = currentRequestIndex === requestItems.length - 1;
+ const isValidDelay = !Number.isNaN(delay) && delay > 0;
+ if(isValidDelay && !isLastRun){
+ console.log(chalk.yellow(`Waiting for ${delay}ms or ${(delay/1000).toFixed(3)}s before next request.`));
+ await new Promise((resolve) => setTimeout(resolve, delay));
+ }
+
+ if(Number.isNaN(delay) && !isLastRun){
+ console.log(chalk.red(`Ignoring delay because it's not a valid number.`));
+ }
+
results.push({
...result,
runtime: process.hrtime(start)[0] + process.hrtime(start)[1] / 1e9,
- suitename: bruFilepath.replace('.bru', '')
+ suitename: pathname.replace('.bru', '')
});
if (reporterSkipAllHeaders) {
@@ -668,9 +559,11 @@ const handler = async function (argv) {
}
const deleteHeaderIfExists = (headers, header) => {
- if (headers && headers[header]) {
- delete headers[header];
- }
+ Object.keys(headers).forEach((key) => {
+ if (key.toLowerCase() === header.toLowerCase()) {
+ delete headers[key];
+ }
+ });
};
if (reporterSkipHeaders?.length) {
@@ -691,26 +584,33 @@ const handler = async function (argv) {
// bail if option is set and there is a failure
if (bail) {
- const requestFailure = result?.error;
+ const requestFailure = result?.error && !result?.skipped;
const testFailure = result?.testResults?.find((iter) => iter.status === 'fail');
const assertionFailure = result?.assertionResults?.find((iter) => iter.status === 'fail');
- if (requestFailure || testFailure || assertionFailure) {
+ const preRequestTestFailure = result?.preRequestTestResults?.find((iter) => iter.status === 'fail');
+ const postResponseTestFailure = result?.postResponseTestResults?.find((iter) => iter.status === 'fail');
+ if (requestFailure || testFailure || assertionFailure || preRequestTestFailure || postResponseTestFailure) {
break;
}
}
// determine next request
const nextRequestName = result?.nextRequestName;
+
+ if (result?.shouldStopRunnerExecution) {
+ break;
+ }
+
if (nextRequestName !== undefined) {
nJumps++;
if (nJumps > 10000) {
console.error(chalk.red(`Too many jumps, possible infinite loop`));
- process.exit(constants.EXIT_STATUS.ERROR_INFINTE_LOOP);
+ process.exit(constants.EXIT_STATUS.ERROR_INFINITE_LOOP);
}
if (nextRequestName === null) {
break;
}
- const nextRequestIdx = bruJsons.findIndex((iter) => iter.bruJson.name === nextRequestName);
+ const nextRequestIdx = requestItems.findIndex((iter) => iter.name === nextRequestName);
if (nextRequestIdx >= 0) {
currentRequestIndex = nextRequestIdx;
} else {
@@ -767,7 +667,7 @@ const handler = async function (argv) {
}
}
- if (summary.failedAssertions + summary.failedTests + summary.failedRequests > 0) {
+ if ((summary.failedAssertions + summary.failedTests + summary.failedPreRequestTests + summary.failedPostResponseTests + summary.failedRequests > 0) || (summary?.errorRequests > 0)) {
process.exit(constants.EXIT_STATUS.ERROR_FAILED_COLLECTION);
}
} catch (err) {
diff --git a/packages/bruno-cli/src/constants.js b/packages/bruno-cli/src/constants.js
index e7de8a6e0..cdc0d47aa 100644
--- a/packages/bruno-cli/src/constants.js
+++ b/packages/bruno-cli/src/constants.js
@@ -10,7 +10,7 @@ const EXIT_STATUS = {
// The specified output dir does not exist
ERROR_MISSING_OUTPUT_DIR: 2,
// request chain caused an endless loop
- ERROR_INFINTE_LOOP: 3,
+ ERROR_INFINITE_LOOP: 3,
// bru was called outside of a collection root
ERROR_NOT_IN_COLLECTION: 4,
// The specified file was not found
diff --git a/packages/bruno-cli/src/reporters/junit.js b/packages/bruno-cli/src/reporters/junit.js
index 30fb51939..e4a622722 100644
--- a/packages/bruno-cli/src/reporters/junit.js
+++ b/packages/bruno-cli/src/reporters/junit.js
@@ -62,7 +62,10 @@ const makeJUnitOutput = async (results, outputPath) => {
suite.testcase.push(testcase);
});
- if (result.error) {
+ if (result?.skipped) {
+ suite['@skipped'] = 1;
+ }
+ else if (result.error) {
suite['@errors'] = 1;
suite['@tests'] = 1;
suite.testcase = [
diff --git a/packages/bruno-cli/src/runner/awsv4auth-helper.js b/packages/bruno-cli/src/runner/awsv4auth-helper.js
index 4a2ff5aa2..a95a45124 100644
--- a/packages/bruno-cli/src/runner/awsv4auth-helper.js
+++ b/packages/bruno-cli/src/runner/awsv4auth-helper.js
@@ -9,10 +9,11 @@ async function resolveAwsV4Credentials(request) {
const awsv4 = request.awsv4config;
if (isStrPresent(awsv4.profileName)) {
try {
- credentialsProvider = fromIni({
- profile: awsv4.profileName
+ const credentialsProvider = fromIni({
+ profile: awsv4.profileName,
+ ignoreCache: true
});
- credentials = await credentialsProvider();
+ const credentials = await credentialsProvider();
awsv4.accessKeyId = credentials.accessKeyId;
awsv4.secretAccessKey = credentials.secretAccessKey;
awsv4.sessionToken = credentials.sessionToken;
diff --git a/packages/bruno-cli/src/runner/interpolate-vars.js b/packages/bruno-cli/src/runner/interpolate-vars.js
index 88cee00cb..7ec7041b5 100644
--- a/packages/bruno-cli/src/runner/interpolate-vars.js
+++ b/packages/bruno-cli/src/runner/interpolate-vars.js
@@ -32,7 +32,7 @@ const interpolateVars = (request, envVariables = {}, runtimeVariables = {}, proc
});
});
- const _interpolate = (str) => {
+ const _interpolate = (str, { escapeJSONStrings } = {}) => {
if (!str || !str.length || typeof str !== 'string') {
return str;
}
@@ -51,7 +51,7 @@ const interpolateVars = (request, envVariables = {}, runtimeVariables = {}, proc
}
};
- return interpolate(str, combinedVars);
+ return interpolate(str, combinedVars, { escapeJSONStrings });
};
request.url = _interpolate(request.url);
@@ -67,14 +67,14 @@ const interpolateVars = (request, envVariables = {}, runtimeVariables = {}, proc
if (typeof request.data === 'object') {
try {
let parsed = JSON.stringify(request.data);
- parsed = _interpolate(parsed);
+ parsed = _interpolate(parsed, { escapeJSONStrings: true });
request.data = JSON.parse(parsed);
} catch (err) {}
}
if (typeof request.data === 'string') {
if (request?.data?.length) {
- request.data = _interpolate(request.data);
+ request.data = _interpolate(request.data, { escapeJSONStrings: true });
}
}
} else if (contentType === 'application/x-www-form-urlencoded') {
@@ -147,13 +147,44 @@ const interpolateVars = (request, envVariables = {}, runtimeVariables = {}, proc
// todo: we have things happening in two places w.r.t basic auth
// need to refactor this in the future
// the request.auth (basic auth) object gets set inside the prepare-request.js file
- if (request.auth) {
- const username = _interpolate(request.auth.username) || '';
- const password = _interpolate(request.auth.password) || '';
+ if (request.basicAuth) {
+ const username = _interpolate(request.basicAuth.username) || '';
+ const password = _interpolate(request.basicAuth.password) || '';
// use auth header based approach and delete the request.auth object
request.headers['Authorization'] = `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`;
- delete request.auth;
+ delete request.basicAuth;
+ }
+
+ if (request?.oauth2?.grantType) {
+ switch (request.oauth2.grantType) {
+ case 'password':
+ request.oauth2.accessTokenUrl = _interpolate(request.oauth2.accessTokenUrl) || '';
+ request.oauth2.refreshTokenUrl = _interpolate(request.oauth2.refreshTokenUrl) || '';
+ request.oauth2.username = _interpolate(request.oauth2.username) || '';
+ request.oauth2.password = _interpolate(request.oauth2.password) || '';
+ request.oauth2.clientId = _interpolate(request.oauth2.clientId) || '';
+ request.oauth2.clientSecret = _interpolate(request.oauth2.clientSecret) || '';
+ request.oauth2.scope = _interpolate(request.oauth2.scope) || '';
+ request.oauth2.credentialsPlacement = _interpolate(request.oauth2.credentialsPlacement) || '';
+ request.oauth2.tokenPlacement = _interpolate(request.oauth2.tokenPlacement) || '';
+ request.oauth2.tokenHeaderPrefix = _interpolate(request.oauth2.tokenHeaderPrefix) || '';
+ request.oauth2.tokenQueryKey = _interpolate(request.oauth2.tokenQueryKey) || '';
+ break;
+ case 'client_credentials':
+ request.oauth2.accessTokenUrl = _interpolate(request.oauth2.accessTokenUrl) || '';
+ request.oauth2.refreshTokenUrl = _interpolate(request.oauth2.refreshTokenUrl) || '';
+ request.oauth2.clientId = _interpolate(request.oauth2.clientId) || '';
+ request.oauth2.clientSecret = _interpolate(request.oauth2.clientSecret) || '';
+ request.oauth2.scope = _interpolate(request.oauth2.scope) || '';
+ request.oauth2.credentialsPlacement = _interpolate(request.oauth2.credentialsPlacement) || '';
+ request.oauth2.tokenPlacement = _interpolate(request.oauth2.tokenPlacement) || '';
+ request.oauth2.tokenHeaderPrefix = _interpolate(request.oauth2.tokenHeaderPrefix) || '';
+ request.oauth2.tokenQueryKey = _interpolate(request.oauth2.tokenQueryKey) || '';
+ break;
+ default:
+ break;
+ }
}
if (request.awsv4config) {
@@ -165,12 +196,14 @@ const interpolateVars = (request, envVariables = {}, runtimeVariables = {}, proc
request.awsv4config.profileName = _interpolate(request.awsv4config.profileName) || '';
}
- // interpolate vars for ntlmConfig auth
- if (request.ntlmConfig) {
- request.ntlmConfig.username = _interpolate(request.ntlmConfig.username) || '';
- request.ntlmConfig.password = _interpolate(request.ntlmConfig.password) || '';
- request.ntlmConfig.domain = _interpolate(request.ntlmConfig.domain) || '';
- }
+ // interpolate vars for ntlmConfig auth
+ if (request.ntlmConfig) {
+ request.ntlmConfig.username = _interpolate(request.ntlmConfig.username) || '';
+ request.ntlmConfig.password = _interpolate(request.ntlmConfig.password) || '';
+ request.ntlmConfig.domain = _interpolate(request.ntlmConfig.domain) || '';
+ }
+
+ if(request?.auth) delete request.auth;
if (request) return request;
};
diff --git a/packages/bruno-cli/src/runner/oauth2.js b/packages/bruno-cli/src/runner/oauth2.js
new file mode 100644
index 000000000..f5335dc55
--- /dev/null
+++ b/packages/bruno-cli/src/runner/oauth2.js
@@ -0,0 +1,6 @@
+const { getOAuth2Token } = require('@usebruno/requests');
+const tokenStore = require('./tokenStore');
+
+module.exports = {
+ getOAuth2Token: (oauth2Config) => getOAuth2Token(oauth2Config, tokenStore)
+};
\ No newline at end of file
diff --git a/packages/bruno-cli/src/runner/prepare-request.js b/packages/bruno-cli/src/runner/prepare-request.js
index 11963bd29..1b5993852 100644
--- a/packages/bruno-cli/src/runner/prepare-request.js
+++ b/packages/bruno-cli/src/runner/prepare-request.js
@@ -1,8 +1,8 @@
const { get, each, filter } = require('lodash');
const decomment = require('decomment');
const crypto = require('node:crypto');
-const { mergeHeaders, mergeScripts, mergeVars, getTreePathFromCollectionToItem } = require('../utils/collection');
-const { createFormData } = require('../utils/form-data');
+const { mergeHeaders, mergeScripts, mergeVars, mergeAuth, getTreePathFromCollectionToItem } = require('../utils/collection');
+const { buildFormUrlEncodedPayload } = require('../utils/form-data');
const prepareRequest = (item = {}, collection = {}) => {
const request = item?.request;
@@ -16,6 +16,7 @@ const prepareRequest = (item = {}, collection = {}) => {
mergeHeaders(collection, request, requestTreePath);
mergeScripts(collection, request, requestTreePath, scriptFlow);
mergeVars(collection, request, requestTreePath);
+ mergeAuth(collection, request, requestTreePath);
}
each(get(request, 'headers', []), (h) => {
@@ -31,21 +32,23 @@ const prepareRequest = (item = {}, collection = {}) => {
method: request.method,
url: request.url,
headers: headers,
- pathParams: request?.params?.filter((param) => param.type === 'path'),
+ name: item.name,
+ pathParams: request.params?.filter((param) => param.type === 'path'),
+ settings: item.settings,
responseType: 'arraybuffer'
};
const collectionAuth = get(collection, 'root.request.auth');
if (collectionAuth && request.auth?.mode === 'inherit') {
if (collectionAuth.mode === 'basic') {
- axiosRequest.auth = {
+ axiosRequest.basicAuth = {
username: get(collectionAuth, 'basic.username'),
password: get(collectionAuth, 'basic.password')
};
}
if (collectionAuth.mode === 'bearer') {
- axiosRequest.headers['Authorization'] = `Bearer ${get(collectionAuth, 'bearer.token')}`;
+ axiosRequest.headers['Authorization'] = `Bearer ${get(collectionAuth, 'bearer.token', '')}`;
}
if (collectionAuth.mode === 'apikey') {
@@ -65,11 +68,88 @@ const prepareRequest = (item = {}, collection = {}) => {
}
}
}
+
+ if (collectionAuth.mode === 'digest') {
+ axiosRequest.digestConfig = {
+ username: get(collectionAuth, 'digest.username'),
+ password: get(collectionAuth, 'digest.password')
+ };
+ }
+
+ if (collectionAuth.mode === 'oauth2') {
+ const grantType = get(collectionAuth, 'oauth2.grantType');
+
+ if (grantType === 'client_credentials') {
+ axiosRequest.oauth2 = {
+ grantType,
+ accessTokenUrl: get(collectionAuth, 'oauth2.accessTokenUrl'),
+ clientId: get(collectionAuth, 'oauth2.clientId'),
+ clientSecret: get(collectionAuth, 'oauth2.clientSecret'),
+ scope: get(collectionAuth, 'oauth2.scope'),
+ credentialsPlacement: get(collectionAuth, 'oauth2.credentialsPlacement'),
+ tokenPlacement: get(collectionAuth, 'oauth2.tokenPlacement'),
+ tokenHeaderPrefix: get(collectionAuth, 'oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(collectionAuth, 'oauth2.tokenQueryKey')
+ };
+ } else if (grantType === 'password') {
+ axiosRequest.oauth2 = {
+ grantType,
+ accessTokenUrl: get(collectionAuth, 'oauth2.accessTokenUrl'),
+ username: get(collectionAuth, 'oauth2.username'),
+ password: get(collectionAuth, 'oauth2.password'),
+ clientId: get(collectionAuth, 'oauth2.clientId'),
+ clientSecret: get(collectionAuth, 'oauth2.clientSecret'),
+ scope: get(collectionAuth, 'oauth2.scope'),
+ credentialsPlacement: get(collectionAuth, 'oauth2.credentialsPlacement'),
+ tokenPlacement: get(collectionAuth, 'oauth2.tokenPlacement'),
+ tokenHeaderPrefix: get(collectionAuth, 'oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(collectionAuth, 'oauth2.tokenQueryKey')
+ };
+ }
+ }
+ if (collectionAuth.mode === 'awsv4') {
+ axiosRequest.awsv4config = {
+ accessKeyId: get(collectionAuth, 'awsv4.accessKeyId'),
+ secretAccessKey: get(collectionAuth, 'awsv4.secretAccessKey'),
+ sessionToken: get(collectionAuth, 'awsv4.sessionToken'),
+ service: get(collectionAuth, 'awsv4.service'),
+ region: get(collectionAuth, 'awsv4.region'),
+ profileName: get(collectionAuth, 'awsv4.profileName')
+ };
+ }
+
+ if (collectionAuth.mode === 'ntlm') {
+ axiosRequest.ntlmConfig = {
+ username: get(collectionAuth, 'ntlm.username'),
+ password: get(collectionAuth, 'ntlm.password'),
+ domain: get(collectionAuth, 'ntlm.domain')
+ };
+ }
+
+ if (collectionAuth.mode === 'wsse') {
+ const username = get(collectionAuth, 'wsse.username', '');
+ const password = get(collectionAuth, 'wsse.password', '');
+
+ const ts = new Date().toISOString();
+ const nonce = crypto.randomBytes(16).toString('hex');
+
+ // Create the password digest using SHA-1 as required for WSSE
+ const hash = crypto.createHash('sha1');
+ hash.update(nonce + ts + password);
+ const digest = Buffer.from(hash.digest('hex').toString('utf8')).toString('base64');
+
+ // Construct the WSSE header
+ axiosRequest.headers[
+ 'X-WSSE'
+ ] = `UsernameToken Username="${username}", PasswordDigest="${digest}", Nonce="${nonce}", Created="${ts}"`;
+ }
+
+ console.log('axiosRequest', axiosRequest);
}
if (request.auth && request.auth.mode !== 'inherit') {
if (request.auth.mode === 'basic') {
- axiosRequest.auth = {
+ axiosRequest.basicAuth = {
username: get(request, 'auth.basic.username'),
password: get(request, 'auth.basic.password')
};
@@ -95,7 +175,7 @@ const prepareRequest = (item = {}, collection = {}) => {
}
if (request.auth.mode === 'bearer') {
- axiosRequest.headers['Authorization'] = `Bearer ${get(request, 'auth.bearer.token')}`;
+ axiosRequest.headers['Authorization'] = `Bearer ${get(request, 'auth.bearer.token', '')}`;
}
if (request.auth.mode === 'wsse') {
@@ -115,6 +195,63 @@ const prepareRequest = (item = {}, collection = {}) => {
'X-WSSE'
] = `UsernameToken Username="${username}", PasswordDigest="${digest}", Nonce="${nonce}", Created="${ts}"`;
}
+
+ if (request.auth.mode === 'digest') {
+ axiosRequest.digestConfig = {
+ username: get(request, 'auth.digest.username'),
+ password: get(request, 'auth.digest.password')
+ };
+ }
+
+ if (request.auth.mode === 'oauth2') {
+ const grantType = get(request, 'auth.oauth2.grantType');
+
+ if (grantType === 'client_credentials') {
+ axiosRequest.oauth2 = {
+ grantType,
+ clientId: get(request, 'auth.oauth2.clientId'),
+ clientSecret: get(request, 'auth.oauth2.clientSecret'),
+ scope: get(request, 'auth.oauth2.scope'),
+ accessTokenUrl: get(request, 'auth.oauth2.accessTokenUrl'),
+ tokenPlacement: get(request, 'auth.oauth2.tokenPlacement'),
+ credentialsPlacement: get(request, 'auth.oauth2.credentialsPlacement'),
+ tokenHeaderPrefix: get(request, 'auth.oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(request, 'auth.oauth2.tokenQueryKey')
+ };
+ } else if (grantType === 'password') {
+ axiosRequest.oauth2 = {
+ grantType,
+ username: get(request, 'auth.oauth2.username'),
+ password: get(request, 'auth.oauth2.password'),
+ clientId: get(request, 'auth.oauth2.clientId'),
+ clientSecret: get(request, 'auth.oauth2.clientSecret'),
+ scope: get(request, 'auth.oauth2.scope'),
+ accessTokenUrl: get(request, 'auth.oauth2.accessTokenUrl'),
+ tokenPlacement: get(request, 'auth.oauth2.tokenPlacement'),
+ credentialsPlacement: get(request, 'auth.oauth2.credentialsPlacement'),
+ tokenHeaderPrefix: get(request, 'auth.oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(request, 'auth.oauth2.tokenQueryKey')
+ };
+ }
+ }
+
+ if (request.auth.mode === 'apikey') {
+ if (request.auth.apikey?.placement === 'header') {
+ axiosRequest.headers[request.auth.apikey?.key] = request.auth.apikey?.value;
+ }
+
+ if (request.auth.apikey?.placement === 'queryparams') {
+ if (axiosRequest.url && request.auth.apikey?.key) {
+ try {
+ const urlObj = new URL(request.url);
+ urlObj.searchParams.set(request.auth.apikey?.key, request.auth.apikey?.value);
+ axiosRequest.url = urlObj.toString();
+ } catch (error) {
+ console.error('Invalid URL:', request.url, error);
+ }
+ }
+ }
+ }
}
request.body = request.body || {};
@@ -152,13 +289,13 @@ const prepareRequest = (item = {}, collection = {}) => {
}
if (request.body.mode === 'formUrlEncoded') {
- axiosRequest.headers['content-type'] = 'application/x-www-form-urlencoded';
- const params = {};
+ if (!contentTypeDefined) {
+ axiosRequest.headers['content-type'] = 'application/x-www-form-urlencoded';
+ }
const enabledParams = filter(request.body.formUrlEncoded, (p) => p.enabled);
- each(enabledParams, (p) => (params[p.name] = p.value));
- axiosRequest.data = params;
+ axiosRequest.data = buildFormUrlEncodedPayload(enabledParams);
}
-
+
if (request.body.mode === 'multipartForm') {
axiosRequest.headers['content-type'] = 'multipart/form-data';
const enabledParams = filter(request.body.multipartForm, (p) => p.enabled);
diff --git a/packages/bruno-cli/src/runner/run-single-request.js b/packages/bruno-cli/src/runner/run-single-request.js
index b2bbc3795..a682d4814 100644
--- a/packages/bruno-cli/src/runner/run-single-request.js
+++ b/packages/bruno-cli/src/runner/run-single-request.js
@@ -20,19 +20,20 @@ const { addAwsV4Interceptor, resolveAwsV4Credentials } = require('./awsv4auth-he
const { shouldUseProxy, PatchedHttpsProxyAgent, getSystemProxyEnvVariables } = require('../utils/proxy-util');
const path = require('path');
const { parseDataFromResponse } = require('../utils/common');
-const { getCookieStringForUrl, saveCookies, shouldUseCookies } = require('../utils/cookies');
+const { getCookieStringForUrl, saveCookies } = require('../utils/cookies');
const { createFormData } = require('../utils/form-data');
+const { getOAuth2Token } = require('./oauth2');
const protocolRegex = /^([-+\w]{1,25})(:?\/\/|:)/;
const { NtlmClient } = require('axios-ntlm');
-
+const { addDigestInterceptor } = require('@usebruno/requests');
+const { encodeUrl } = require('@usebruno/common').utils;
const onConsoleLog = (type, args) => {
console[type](...args);
};
const runSingleRequest = async function (
- filename,
- bruJson,
+ item,
collectionPath,
runtimeVariables,
envVariables,
@@ -40,15 +41,38 @@ const runSingleRequest = async function (
brunoConfig,
collectionRoot,
runtime,
- collection
+ collection,
+ runSingleRequestByPathname
) {
+ const { pathname: itemPathname } = item;
+ const relativeItemPathname = path.relative(collectionPath, itemPathname);
+
+ const logResults = (results, title) => {
+ if (results?.length) {
+ if (title) {
+ console.log(chalk.dim(title));
+ }
+ each(results, (r) => {
+ const message = r.description || `${r.lhsExpr}: ${r.rhsExpr}`;
+ if (r.status === 'pass') {
+ console.log(chalk.green(` ✓ `) + chalk.dim(message));
+ } else {
+ console.log(chalk.red(` ✕ `) + chalk.red(message));
+ if (r.error) {
+ console.log(chalk.red(` ${r.error}`));
+ }
+ }
+ });
+ }
+ };
+
try {
let request;
let nextRequestName;
- let item = {
- pathname: path.join(collectionPath, filename),
- ...bruJson
- }
+ let shouldStopRunnerExecution = false;
+ let preRequestTestResults = [];
+ let postResponseTestResults = [];
+
request = prepareRequest(item, collection);
request.__bruno__executionMode = 'cli';
@@ -58,6 +82,7 @@ const runSingleRequest = async function (
// run pre request script
const requestScriptFile = get(request, 'script.req');
+ const collectionName = collection?.brunoConfig?.name
if (requestScriptFile?.length) {
const scriptRuntime = new ScriptRuntime({ runtime: scriptingConfig?.runtime });
const result = await scriptRuntime.runRequestScript(
@@ -68,22 +93,63 @@ const runSingleRequest = async function (
collectionPath,
onConsoleLog,
processEnvVars,
- scriptingConfig
+ scriptingConfig,
+ runSingleRequestByPathname,
+ collectionName
);
if (result?.nextRequestName !== undefined) {
nextRequestName = result.nextRequestName;
}
+
+ if (result?.stopExecution) {
+ shouldStopRunnerExecution = true;
+ }
+
+ if (result?.skipRequest) {
+ return {
+ test: {
+ filename: relativeItemPathname
+ },
+ request: {
+ method: request.method,
+ url: request.url,
+ headers: request.headers,
+ data: request.data
+ },
+ response: {
+ status: 'skipped',
+ statusText: 'request skipped via pre-request script',
+ data: null,
+ responseTime: 0
+ },
+ error: null,
+ status: 'skipped',
+ skipped: true,
+ assertionResults: [],
+ testResults: [],
+ preRequestTestResults: result?.results || [],
+ postResponseTestResults: [],
+ shouldStopRunnerExecution
+ };
+ }
+
+ preRequestTestResults = result?.results || [];
}
// interpolate variables inside request
interpolateVars(request, envVariables, runtimeVariables, processEnvVars);
+ if (request.settings?.encodeUrl) {
+ request.url = encodeUrl(request.url);
+ }
+
if (!protocolRegex.test(request.url)) {
request.url = `http://${request.url}`;
}
const options = getOptions();
const insecure = get(options, 'insecure', false);
+ const noproxy = get(options, 'noproxy', false);
const httpsAgentRequestFields = {};
if (insecure) {
httpsAgentRequestFields['rejectUnauthorized'] = false;
@@ -148,15 +214,22 @@ const runSingleRequest = async function (
const collectionProxyConfig = get(brunoConfig, 'proxy', {});
const collectionProxyEnabled = get(collectionProxyConfig, 'enabled', false);
- if (collectionProxyEnabled === true) {
+
+ if (noproxy) {
+ // If noproxy flag is set, don't use any proxy
+ proxyMode = 'off';
+ } else if (collectionProxyEnabled === true) {
+ // If collection proxy is enabled, use it
proxyConfig = collectionProxyConfig;
proxyMode = 'on';
- } else {
- // if the collection level proxy is not set, pick the system level proxy by default, to maintain backward compatibility
+ } else if (collectionProxyEnabled === 'global') {
+ // If collection proxy is set to 'global', use system proxy
const { http_proxy, https_proxy } = getSystemProxyEnvVariables();
if (http_proxy?.length || https_proxy?.length) {
proxyMode = 'system';
}
+ } else {
+ proxyMode = 'off';
}
if (proxyMode === 'on') {
@@ -170,8 +243,8 @@ const runSingleRequest = async function (
let uriPort = isUndefined(proxyPort) || isNull(proxyPort) ? '' : `:${proxyPort}`;
let proxyUri;
if (proxyAuthEnabled) {
- const proxyAuthUsername = interpolateString(get(proxyConfig, 'auth.username'), interpolationOptions);
- const proxyAuthPassword = interpolateString(get(proxyConfig, 'auth.password'), interpolationOptions);
+ const proxyAuthUsername = encodeURIComponent(interpolateString(get(proxyConfig, 'auth.username'), interpolationOptions));
+ const proxyAuthPassword = encodeURIComponent(interpolateString(get(proxyConfig, 'auth.password'), interpolationOptions));
proxyUri = `${proxyProtocol}://${proxyAuthUsername}:${proxyAuthPassword}@${proxyHostname}${uriPort}`;
} else {
@@ -214,6 +287,10 @@ const runSingleRequest = async function (
https_proxy,
Object.keys(httpsAgentRequestFields).length > 0 ? { ...httpsAgentRequestFields } : undefined
);
+ } else {
+ request.httpsAgent = new https.Agent({
+ ...httpsAgentRequestFields
+ });
}
} catch (error) {
throw new Error('Invalid system https_proxy');
@@ -233,16 +310,42 @@ const runSingleRequest = async function (
if (!options.disableCookies) {
const cookieString = getCookieStringForUrl(request.url);
if (cookieString && typeof cookieString === 'string' && cookieString.length) {
- request.headers['cookie'] = cookieString;
+ const existingCookieHeaderName = Object.keys(request.headers).find(
+ name => name.toLowerCase() === 'cookie'
+ );
+ const existingCookieString = existingCookieHeaderName ? request.headers[existingCookieHeaderName] : '';
+
+ // Helper function to parse cookies into an object
+ const parseCookies = (str) => str.split(';').reduce((cookies, cookie) => {
+ const [name, ...rest] = cookie.split('=');
+ if (name && name.trim()) {
+ cookies[name.trim()] = rest.join('=').trim();
+ }
+ return cookies;
+ }, {});
+
+ const mergedCookies = {
+ ...parseCookies(existingCookieString),
+ ...parseCookies(cookieString),
+ };
+
+ const combinedCookieString = Object.entries(mergedCookies)
+ .map(([name, value]) => `${name}=${value}`)
+ .join('; ');
+
+ request.headers[existingCookieHeaderName || 'Cookie'] = combinedCookieString;
}
}
// stringify the request url encoded params
- if (request.headers['content-type'] === 'application/x-www-form-urlencoded') {
- request.data = qs.stringify(request.data);
+ const contentTypeHeader = Object.keys(request.headers).find(
+ name => name.toLowerCase() === 'content-type'
+ );
+ if (contentTypeHeader && request.headers[contentTypeHeader] === 'application/x-www-form-urlencoded') {
+ request.data = qs.stringify(request.data, { arrayFormat: 'repeat' });
}
- if (request?.headers?.['content-type'] === 'multipart/form-data') {
+ if (contentTypeHeader && request.headers[contentTypeHeader] === 'multipart/form-data') {
if (!(request?.data instanceof FormData)) {
let form = createFormData(request.data, collectionPath);
request.data = form;
@@ -250,10 +353,45 @@ const runSingleRequest = async function (
}
}
+ let requestMaxRedirects = request.maxRedirects
+ request.maxRedirects = 0
+
+ // Set default value for requestMaxRedirects if not explicitly set
+ if (requestMaxRedirects === undefined) {
+ requestMaxRedirects = 5; // Default to 5 redirects
+ }
+
+ // Handle OAuth2 authentication
+ if (request.oauth2) {
+ try {
+ const token = await getOAuth2Token(request.oauth2);
+ if (token) {
+ const { tokenPlacement = 'header', tokenHeaderPrefix = '', tokenQueryKey = 'access_token' } = request.oauth2;
+
+ if (tokenPlacement === 'header' && token) {
+ request.headers['Authorization'] = `${tokenHeaderPrefix} ${token}`.trim();
+ } else if (tokenPlacement === 'url') {
+ try {
+ const url = new URL(request.url);
+ url.searchParams.set(tokenQueryKey, token);
+ request.url = url.toString();
+ } catch (error) {
+ console.error('Error applying OAuth2 token to URL:', error.message);
+ }
+ }
+ }
+ } catch (error) {
+ console.error('OAuth2 token fetch error:', error.message);
+ }
+
+ // Remove oauth2 config from request to prevent it from being sent
+ delete request.oauth2;
+ }
+
let response, responseTime;
try {
- let axiosInstance = makeAxiosInstance();
+ let axiosInstance = makeAxiosInstance({ requestMaxRedirects: requestMaxRedirects, disableCookies: options.disableCookies });
if (request.ntlmConfig) {
axiosInstance=NtlmClient(request.ntlmConfig,axiosInstance.defaults)
delete request.ntlmConfig;
@@ -278,11 +416,17 @@ const runSingleRequest = async function (
delete request.awsv4config;
}
+ if (request.digestConfig) {
+ addDigestInterceptor(axiosInstance, request);
+ delete request.digestConfig;
+ }
+
/** @type {import('axios').AxiosResponse} */
response = await axiosInstance(request);
- const { data } = parseDataFromResponse(response, request.__brunoDisableParsingResponseJson);
+ const { data, dataBuffer } = parseDataFromResponse(response, request.__brunoDisableParsingResponseJson);
response.data = data;
+ response.dataBuffer = dataBuffer;
// Prevents the duration on leaking to the actual result
responseTime = response.headers.get('request-duration');
@@ -294,18 +438,19 @@ const runSingleRequest = async function (
}
} catch (err) {
if (err?.response) {
- const { data } = parseDataFromResponse(err?.response);
+ const { data, dataBuffer } = parseDataFromResponse(err?.response);
err.response.data = data;
+ err.response.dataBuffer = dataBuffer;
response = err.response;
// Prevents the duration on leaking to the actual result
responseTime = response.headers.get('request-duration');
response.headers.delete('request-duration');
} else {
- console.log(chalk.red(stripExtension(filename)) + chalk.dim(` (${err.message})`));
+ console.log(chalk.red(stripExtension(relativeItemPathname)) + chalk.dim(` (${err.message})`));
return {
test: {
- filename: filename
+ filename: relativeItemPathname
},
request: {
method: request.method,
@@ -314,16 +459,21 @@ const runSingleRequest = async function (
data: request.data
},
response: {
- status: null,
+ status: 'error',
statusText: null,
headers: null,
data: null,
+ url: null,
responseTime: 0
},
error: err?.message || err?.errors?.map(e => e?.message)?.at(0) || err?.code || 'Request Failed!',
+ status: 'error',
assertionResults: [],
testResults: [],
- nextRequestName: nextRequestName
+ preRequestTestResults,
+ postResponseTestResults,
+ nextRequestName: nextRequestName,
+ shouldStopRunnerExecution
};
}
}
@@ -331,12 +481,15 @@ const runSingleRequest = async function (
response.responseTime = responseTime;
console.log(
- chalk.green(stripExtension(filename)) +
+ chalk.green(stripExtension(relativeItemPathname)) +
chalk.dim(` (${response.status} ${response.statusText}) - ${responseTime} ms`)
);
+ // Log pre-request test results
+ logResults(preRequestTestResults, 'Pre-Request Tests');
+
// run post-response vars
- const postResponseVars = get(bruJson, 'request.vars.res');
+ const postResponseVars = get(item, 'request.vars.res');
if (postResponseVars?.length) {
const varsRuntime = new VarsRuntime({ runtime: scriptingConfig?.runtime });
varsRuntime.runPostResponseVars(
@@ -354,25 +507,37 @@ const runSingleRequest = async function (
const responseScriptFile = get(request, 'script.res');
if (responseScriptFile?.length) {
const scriptRuntime = new ScriptRuntime({ runtime: scriptingConfig?.runtime });
- const result = await scriptRuntime.runResponseScript(
- decomment(responseScriptFile),
- request,
- response,
- envVariables,
- runtimeVariables,
- collectionPath,
- null,
- processEnvVars,
- scriptingConfig
- );
- if (result?.nextRequestName !== undefined) {
- nextRequestName = result.nextRequestName;
+ try {
+ const result = await scriptRuntime.runResponseScript(
+ decomment(responseScriptFile),
+ request,
+ response,
+ envVariables,
+ runtimeVariables,
+ collectionPath,
+ null,
+ processEnvVars,
+ scriptingConfig,
+ runSingleRequestByPathname,
+ collectionName
+ );
+ if (result?.nextRequestName !== undefined) {
+ nextRequestName = result.nextRequestName;
+ }
+
+ if (result?.stopExecution) {
+ shouldStopRunnerExecution = true;
+ }
+
+ postResponseTestResults = result?.results || [];
+ logResults(postResponseTestResults, 'Post-Response Tests');
+ } catch (error) {
+ console.error('Post-response script execution error:', error);
}
}
- // run assertions
let assertionResults = [];
- const assertions = get(bruJson, 'request.assertions');
+ const assertions = get(item, 'request.assertions');
if (assertions) {
const assertRuntime = new AssertRuntime({ runtime: scriptingConfig?.runtime });
assertionResults = assertRuntime.runAssertions(
@@ -383,15 +548,6 @@ const runSingleRequest = async function (
runtimeVariables,
processEnvVars
);
-
- each(assertionResults, (r) => {
- if (r.status === 'pass') {
- console.log(chalk.green(` ✓ `) + chalk.dim(`assert: ${r.lhsExpr}: ${r.rhsExpr}`));
- } else {
- console.log(chalk.red(` ✕ `) + chalk.red(`assert: ${r.lhsExpr}: ${r.rhsExpr}`));
- console.log(chalk.red(` ${r.error}`));
- }
- });
}
// run tests
@@ -399,37 +555,42 @@ const runSingleRequest = async function (
const testFile = get(request, 'tests');
if (typeof testFile === 'string') {
const testRuntime = new TestRuntime({ runtime: scriptingConfig?.runtime });
- const result = await testRuntime.runTests(
- decomment(testFile),
- request,
- response,
- envVariables,
- runtimeVariables,
- collectionPath,
- null,
- processEnvVars,
- scriptingConfig
- );
- testResults = get(result, 'results', []);
+ try {
+ const result = await testRuntime.runTests(
+ decomment(testFile),
+ request,
+ response,
+ envVariables,
+ runtimeVariables,
+ collectionPath,
+ null,
+ processEnvVars,
+ scriptingConfig,
+ runSingleRequestByPathname,
+ collectionName
+ );
+ testResults = get(result, 'results', []);
- if (result?.nextRequestName !== undefined) {
- nextRequestName = result.nextRequestName;
+ if (result?.nextRequestName !== undefined) {
+ nextRequestName = result.nextRequestName;
+ }
+
+ if (result?.stopExecution) {
+ shouldStopRunnerExecution = true;
+ }
+
+ logResults(testResults, 'Tests');
+ } catch (error) {
+ console.error('Test script execution error:', error);
}
}
- if (testResults?.length) {
- each(testResults, (testResult) => {
- if (testResult.status === 'pass') {
- console.log(chalk.green(` ✓ `) + chalk.dim(testResult.description));
- } else {
- console.log(chalk.red(` ✕ `) + chalk.red(testResult.description));
- }
- });
- }
+
+ logResults(assertionResults, 'Assertions');
return {
test: {
- filename: filename
+ filename: relativeItemPathname
},
request: {
method: request.method,
@@ -442,18 +603,23 @@ const runSingleRequest = async function (
statusText: response.statusText,
headers: response.headers,
data: response.data,
+ url: response.request ? response.request.protocol + '//' + response.request.host + response.request.path : null,
responseTime
},
error: null,
+ status: 'pass',
assertionResults,
testResults,
- nextRequestName: nextRequestName
+ preRequestTestResults,
+ postResponseTestResults,
+ nextRequestName: nextRequestName,
+ shouldStopRunnerExecution
};
} catch (err) {
- console.log(chalk.red(stripExtension(filename)) + chalk.dim(` (${err.message})`));
+ console.log(chalk.red(stripExtension(relativeItemPathname)) + chalk.dim(` (${err.message})`));
return {
test: {
- filename: filename
+ filename: relativeItemPathname
},
request: {
method: null,
@@ -462,15 +628,19 @@ const runSingleRequest = async function (
data: null
},
response: {
- status: null,
+ status: 'error',
statusText: null,
headers: null,
data: null,
+ url: null,
responseTime: 0
},
+ status: 'error',
error: err.message,
assertionResults: [],
- testResults: []
+ testResults: [],
+ preRequestTestResults: [],
+ postResponseTestResults: []
};
}
};
diff --git a/packages/bruno-cli/src/runner/tokenStore.js b/packages/bruno-cli/src/runner/tokenStore.js
new file mode 100644
index 000000000..1bc5c3273
--- /dev/null
+++ b/packages/bruno-cli/src/runner/tokenStore.js
@@ -0,0 +1,22 @@
+// In-memory token store implementation for OAuth2 tokens
+const tokenStore = {
+ tokens: new Map(),
+
+ // Save a token with optional expiry information
+ async saveToken(serviceId, account, token) {
+ this.tokens.set(`${serviceId}:${account}`, token);
+ return true;
+ },
+
+ // Get a token
+ async getToken(serviceId, account) {
+ return this.tokens.get(`${serviceId}:${account}`);
+ },
+
+ // Delete a token
+ async deleteToken(serviceId, account) {
+ return this.tokens.delete(`${serviceId}:${account}`);
+ }
+};
+
+module.exports = tokenStore;
\ No newline at end of file
diff --git a/packages/bruno-cli/src/utils/axios-instance.js b/packages/bruno-cli/src/utils/axios-instance.js
index 834cda2a8..1d0e7ccd9 100644
--- a/packages/bruno-cli/src/utils/axios-instance.js
+++ b/packages/bruno-cli/src/utils/axios-instance.js
@@ -1,5 +1,47 @@
const axios = require('axios');
const { CLI_VERSION } = require('../constants');
+const { addCookieToJar, getCookieStringForUrl } = require('./cookies');
+
+const redirectResponseCodes = [301, 302, 303, 307, 308];
+const METHOD_CHANGING_REDIRECTS = [301, 302, 303];
+
+const saveCookies = (url, headers) => {
+ if (headers['set-cookie']) {
+ let setCookieHeaders = Array.isArray(headers['set-cookie'])
+ ? headers['set-cookie']
+ : [headers['set-cookie']];
+ for (let setCookieHeader of setCookieHeaders) {
+ if (typeof setCookieHeader === 'string' && setCookieHeader.length) {
+ addCookieToJar(setCookieHeader, url);
+ }
+ }
+ }
+};
+
+const createRedirectConfig = (error, redirectUrl) => {
+ const requestConfig = {
+ ...error.config,
+ url: redirectUrl,
+ headers: { ...error.config.headers }
+ };
+
+ const statusCode = error.response.status;
+ const originalMethod = (error.config.method || 'get').toLowerCase();
+
+ // For 301, 302, 303: change method to GET unless it was HEAD
+ if (METHOD_CHANGING_REDIRECTS.includes(statusCode) && originalMethod !== 'head') {
+ requestConfig.method = 'get';
+ requestConfig.data = undefined;
+
+ // Clean up headers that are no longer relevant
+ delete requestConfig.headers['content-length'];
+ delete requestConfig.headers['Content-Length'];
+ delete requestConfig.headers['content-type'];
+ delete requestConfig.headers['Content-Type'];
+ }
+
+ return requestConfig;
+};
/**
* Function that configures axios with timing interceptors
@@ -7,10 +49,13 @@ const { CLI_VERSION } = require('../constants');
* @see https://github.com/axios/axios/issues/695
* @returns {axios.AxiosInstance}
*/
-function makeAxiosInstance() {
+function makeAxiosInstance({ requestMaxRedirects = 5, disableCookies } = {}) {
+ let redirectCount = 0;
+
/** @type {axios.AxiosInstance} */
const instance = axios.create({
proxy: false,
+ maxRedirects: 0,
headers: {
"User-Agent": `bruno-runtime/${CLI_VERSION}`
}
@@ -18,6 +63,15 @@ function makeAxiosInstance() {
instance.interceptors.request.use((config) => {
config.headers['request-start-time'] = Date.now();
+
+ // Add cookies to request if available and not disabled
+ if (!disableCookies) {
+ const cookieString = getCookieStringForUrl(config.url);
+ if (cookieString && typeof cookieString === 'string' && cookieString.length) {
+ config.headers['cookie'] = cookieString;
+ }
+ }
+
return config;
});
@@ -26,6 +80,8 @@ function makeAxiosInstance() {
const end = Date.now();
const start = response.config.headers['request-start-time'];
response.headers['request-duration'] = end - start;
+ redirectCount = 0;
+
return response;
},
(error) => {
@@ -33,6 +89,42 @@ function makeAxiosInstance() {
const end = Date.now();
const start = error.config.headers['request-start-time'];
error.response.headers['request-duration'] = end - start;
+
+ if (redirectResponseCodes.includes(error.response.status)) {
+ if (redirectCount >= requestMaxRedirects) {
+ // todo: needs to be discussed whether the original error response message should be modified or not
+ return Promise.reject(error);
+ }
+
+ const locationHeader = error.response.headers.location;
+ if (!locationHeader) {
+ // todo: needs to be discussed whether the original error response message should be modified or not
+ return Promise.reject(error);
+ }
+
+ redirectCount++;
+ let redirectUrl = locationHeader;
+
+ if (!locationHeader.match(/^https?:\/\//i)) {
+ const URL = require('url');
+ redirectUrl = URL.resolve(error.config.url, locationHeader);
+ }
+
+ if (!disableCookies){
+ saveCookies(error.config.url, error.response.headers);
+ }
+
+ const requestConfig = createRedirectConfig(error, redirectUrl);
+
+ if (!disableCookies) {
+ const cookieString = getCookieStringForUrl(redirectUrl);
+ if (cookieString && typeof cookieString === 'string' && cookieString.length) {
+ requestConfig.headers['cookie'] = cookieString;
+ }
+ }
+
+ return instance(requestConfig);
+ }
}
return Promise.reject(error);
}
diff --git a/packages/bruno-cli/src/utils/bru.js b/packages/bruno-cli/src/utils/bru.js
index cb8cee7fe..daa883aba 100644
--- a/packages/bruno-cli/src/utils/bru.js
+++ b/packages/bruno-cli/src/utils/bru.js
@@ -1,9 +1,12 @@
const _ = require('lodash');
-const { bruToEnvJsonV2, bruToJsonV2, collectionBruToJson: _collectionBruToJson } = require('@usebruno/lang');
+const {
+ parseRequest: _parseRequest,
+ parseCollection: _parseCollection
+} = require('@usebruno/filestore');
const collectionBruToJson = (bru) => {
try {
- const json = _collectionBruToJson(bru);
+ const json = _parseCollection(bru);
const transformedJson = {
request: {
@@ -15,6 +18,20 @@ const collectionBruToJson = (bru) => {
}
};
+ // add meta if it exists
+ // this is only for folder bru file
+ // in the future, all of this will be replaced by standard bru lang
+ const sequence = _.get(json, 'meta.seq');
+ if (json?.meta) {
+ transformedJson.meta = {
+ name: json.meta.name,
+ };
+
+ if (sequence) {
+ transformedJson.meta.seq = Number(sequence);
+ }
+ }
+
return transformedJson;
} catch (error) {
return Promise.reject(error);
@@ -32,30 +49,36 @@ const collectionBruToJson = (bru) => {
*/
const bruToJson = (bru) => {
try {
- const json = bruToJsonV2(bru);
+ const json = _parseRequest(bru);
let requestType = _.get(json, 'meta.type');
- if (requestType === 'http') {
- requestType = 'http-request';
- } else if (requestType === 'graphql') {
- requestType = 'graphql-request';
- } else {
- requestType = 'http';
+
+ switch (requestType) {
+ case 'http':
+ requestType = 'http-request';
+ break;
+ case 'graphql':
+ requestType = 'graphql-request';
+ break;
+ case 'grpc':
+ requestType = 'grpc-request';
+ break;
+ default:
+ requestType = 'http-request';
}
const sequence = _.get(json, 'meta.seq');
-
const transformedJson = {
type: requestType,
name: _.get(json, 'meta.name'),
- seq: !isNaN(sequence) ? Number(sequence) : 1,
+ seq: !_.isNaN(sequence) ? Number(sequence) : 1,
+ settings: _.get(json, 'settings', {}),
+ tags: _.get(json, 'meta.tags', []),
request: {
- method: _.upperCase(_.get(json, 'http.method')),
- url: _.get(json, 'http.url'),
+ url: _.get(json, requestType === 'grpc-request' ? 'grpc.url' : 'http.url'),
+ headers: requestType === 'grpc-request' ? _.get(json, 'metadata', []) : _.get(json, 'headers', []),
auth: _.get(json, 'auth', {}),
params: _.get(json, 'params', []),
- headers: _.get(json, 'headers', []),
- body: _.get(json, 'body', {}),
vars: _.get(json, 'vars', []),
assertions: _.get(json, 'assertions', []),
script: _.get(json, 'script', {}),
@@ -63,8 +86,29 @@ const bruToJson = (bru) => {
}
};
- transformedJson.request.body.mode = _.get(json, 'http.body', 'none');
- transformedJson.request.auth.mode = _.get(json, 'http.auth', 'none');
+ if (requestType === 'grpc-request') {
+ const selectedMethod = _.get(json, 'grpc.method');
+ if(selectedMethod) transformedJson.request.method = selectedMethod;
+ const selectedMethodType = _.get(json, 'grpc.methodType');
+ if(selectedMethodType) transformedJson.request.methodType = selectedMethodType;
+ const protoPath = _.get(json, 'grpc.protoPath');
+ if(protoPath) transformedJson.request.protoPath = protoPath;
+ transformedJson.request.auth.mode = _.get(json, 'grpc.auth', 'none');
+ transformedJson.request.body = _.get(json, 'body', {
+ mode: 'grpc',
+ grpc: [{
+ name: 'message 1',
+ content: '{}'
+ }]
+ });
+ } else {
+ transformedJson.request.method = _.upperCase(_.get(json, 'http.method'));
+ transformedJson.request.auth.mode = _.get(json, 'http.auth', 'none');
+ transformedJson.request.body = _.get(json, 'body', {});
+ transformedJson.request.body.mode = _.get(json, 'http.body', 'none');
+ }
+
+
return transformedJson;
} catch (err) {
@@ -72,14 +116,6 @@ const bruToJson = (bru) => {
}
};
-const bruToEnvJson = (bru) => {
- try {
- return bruToEnvJsonV2(bru);
- } catch (err) {
- return Promise.reject(err);
- }
-};
-
const getEnvVars = (environment = {}) => {
const variables = environment.variables;
if (!variables || !variables.length) {
@@ -103,7 +139,6 @@ const getOptions = () => {
module.exports = {
bruToJson,
- bruToEnvJson,
getEnvVars,
getOptions,
collectionBruToJson
diff --git a/packages/bruno-cli/src/utils/collection.js b/packages/bruno-cli/src/utils/collection.js
index 365732c48..ab9a3b0c9 100644
--- a/packages/bruno-cli/src/utils/collection.js
+++ b/packages/bruno-cli/src/utils/collection.js
@@ -1,5 +1,114 @@
const { get, each, find, compact } = require('lodash');
const os = require('os');
+const fs = require('fs');
+const path = require('path');
+const { sanitizeName } = require('./filesystem');
+const { parseRequest, parseCollection, parseFolder, stringifyCollection, stringifyFolder, stringifyEnvironment, stringifyRequest } = require('@usebruno/filestore');
+const constants = require('../constants');
+const chalk = require('chalk');
+
+const createCollectionJsonFromPathname = (collectionPath) => {
+ const environmentsPath = path.join(collectionPath, `environments`);
+
+ // get the collection bruno json config [/bruno.json]
+ const brunoConfig = getCollectionBrunoJsonConfig(collectionPath);
+
+ // get the collection root [/collection.bru]
+ const collectionRoot = getCollectionRoot(collectionPath);
+
+ // get the collection items recursively
+ const traverse = (currentPath) => {
+ const filesInCurrentDir = fs.readdirSync(currentPath);
+ if (currentPath.includes('node_modules')) {
+ return;
+ }
+ const currentDirItems = [];
+ for (const file of filesInCurrentDir) {
+ const filePath = path.join(currentPath, file);
+ const stats = fs.lstatSync(filePath);
+ if (stats.isDirectory()) {
+ if (filePath === environmentsPath) continue;
+ if (filePath.startsWith('.git') || filePath.startsWith('node_modules')) continue;
+
+ // get the folder root
+ let folderItem = { name: file, pathname: filePath, type: 'folder', items: traverse(filePath) }
+ const folderBruJson = getFolderRoot(filePath);
+ if (folderBruJson) {
+ folderItem.root = folderBruJson;
+ folderItem.seq = folderBruJson.meta.seq;
+ }
+ currentDirItems.push(folderItem);
+ }
+ else {
+ if (['collection.bru', 'folder.bru'].includes(file)) continue;
+ if (path.extname(filePath) !== '.bru') continue;
+
+ // get the request item
+ const bruContent = fs.readFileSync(filePath, 'utf8');
+ const requestItem = parseRequest(bruContent);
+ currentDirItems.push({
+ name: file,
+ pathname: filePath,
+ ...requestItem
+ });
+ }
+ }
+ let currentDirFolderItems = currentDirItems?.filter((iter) => iter.type === 'folder');
+ let sortedFolderItems = sortByNameThenSequence(currentDirFolderItems);
+
+ let currentDirRequestItems = currentDirItems?.filter((iter) => iter.type !== 'folder');
+ let sortedRequestItems = currentDirRequestItems?.sort((a, b) => a.seq - b.seq);
+
+ return sortedFolderItems?.concat(sortedRequestItems);
+ };
+ let collectionItems = traverse(collectionPath);
+
+ let collection = {
+ brunoConfig,
+ root: collectionRoot,
+ pathname: collectionPath,
+ items: collectionItems
+ }
+
+ return collection;
+};
+
+const getCollectionBrunoJsonConfig = (dir) => {
+ // right now, bru must be run from the root of the collection
+ // will add support in the future to run it from anywhere inside the collection
+ const brunoJsonPath = path.join(dir, 'bruno.json');
+ const brunoJsonExists = fs.existsSync(brunoJsonPath);
+ if (!brunoJsonExists) {
+ console.error(chalk.red(`You can run only at the root of a collection`));
+ process.exit(constants.EXIT_STATUS.ERROR_NOT_IN_COLLECTION);
+ }
+
+ const brunoConfigFile = fs.readFileSync(brunoJsonPath, 'utf8');
+ const brunoConfig = JSON.parse(brunoConfigFile);
+ return brunoConfig;
+}
+
+const getCollectionRoot = (dir) => {
+ const collectionRootPath = path.join(dir, 'collection.bru');
+ const exists = fs.existsSync(collectionRootPath);
+ if (!exists) {
+ return {};
+ }
+
+ const content = fs.readFileSync(collectionRootPath, 'utf8');
+ return parseCollection(content);
+};
+
+const getFolderRoot = (dir) => {
+ const folderRootPath = path.join(dir, 'folder.bru');
+ const exists = fs.existsSync(folderRootPath);
+ if (!exists) {
+ return null;
+ }
+
+ const content = fs.readFileSync(folderRootPath, 'utf8');
+ return parseFolder(content);
+};
const mergeHeaders = (collection, request, requestTreePath) => {
let headers = new Map();
@@ -200,9 +309,252 @@ const getTreePathFromCollectionToItem = (collection, _item) => {
return path;
};
+const mergeAuth = (collection, request, requestTreePath) => {
+ let collectionAuth = collection?.root?.request?.auth || { mode: 'none' };
+ let effectiveAuth = collectionAuth;
+
+ for (let i of requestTreePath) {
+ if (i.type === 'folder') {
+ const folderAuth = i?.root?.request?.auth;
+ if (folderAuth && folderAuth.mode && folderAuth.mode !== 'none' && folderAuth.mode !== 'inherit') {
+ effectiveAuth = folderAuth;
+ }
+ }
+ }
+
+ if (request.auth && request.auth.mode === 'inherit') {
+ request.auth = effectiveAuth;
+ }
+}
+
+const getAllRequestsInFolder = (folderItems = [], recursive = true) => {
+ let requests = [];
+
+ if (folderItems && folderItems.length) {
+ folderItems.forEach((item) => {
+ if (item.type !== 'folder') {
+ requests.push(item);
+ } else {
+ if (recursive) {
+ requests = requests.concat(getAllRequestsInFolder(item.items, recursive));
+ }
+ }
+ });
+ }
+ return requests;
+};
+
+const getAllRequestsAtFolderRoot = (folderItems = []) => {
+ return getAllRequestsInFolder(folderItems, false);
+}
+
+const getCallStack = (resolvedPaths = [], collection, {recursive}) => {
+ let requestItems = [];
+
+
+ if (!resolvedPaths || !resolvedPaths.length) {
+ return requestItems;
+ }
+
+ for (const resolvedPath of resolvedPaths) {
+ if (!resolvedPath || !resolvedPath.length) {
+ continue;
+ }
+
+ if (resolvedPath === collection.pathname) {
+ requestItems = requestItems.concat(getAllRequestsInFolder(collection.items, recursive));
+ continue;
+ }
+
+ const item = findItemInCollection(collection, resolvedPath);
+ if (!item) {
+ continue;
+ }
+
+ if (item.type === 'folder') {
+ requestItems = requestItems.concat(getAllRequestsInFolder(item.items, recursive));
+ } else {
+ requestItems.push(item);
+ }
+ }
+
+ return requestItems;
+};
+
+/**
+ * Safe write file implementation to handle errors
+ * @param {string} filePath - Path to write file
+ * @param {string} content - Content to write
+ */
+const safeWriteFileSync = (filePath, content) => {
+ try {
+ fs.writeFileSync(filePath, content, { encoding: 'utf8' });
+ } catch (error) {
+ console.error(`Error writing file ${filePath}:`, error);
+ }
+};
+
+/**
+ * Creates a Bruno collection directory structure from a Bruno collection object
+ *
+ * @param {Object} collection - The Bruno collection object
+ * @param {string} dirPath - The output directory path
+ */
+const createCollectionFromBrunoObject = async (collection, dirPath) => {
+ // Create bruno.json
+ const brunoConfig = {
+ version: '1',
+ name: collection.name,
+ type: 'collection',
+ ignore: ['node_modules', '.git']
+ };
+
+ fs.writeFileSync(
+ path.join(dirPath, 'bruno.json'),
+ JSON.stringify(brunoConfig, null, 2)
+ );
+
+ // Create collection.bru if root exists
+ if (collection.root) {
+ const collectionContent = await stringifyCollection(collection.root);
+ fs.writeFileSync(path.join(dirPath, 'collection.bru'), collectionContent);
+ }
+
+ // Process environments
+ if (collection.environments && collection.environments.length) {
+ const envDirPath = path.join(dirPath, 'environments');
+ fs.mkdirSync(envDirPath, { recursive: true });
+
+ for (const env of collection.environments) {
+ const content = await stringifyEnvironment(env);
+ const filename = sanitizeName(`${env.name}.bru`);
+ fs.writeFileSync(path.join(envDirPath, filename), content);
+ }
+ }
+
+ // Process collection items
+ await processCollectionItems(collection.items, dirPath);
+
+ return dirPath;
+};
+
+/**
+ * Recursively processes collection items to create files and folders
+ *
+ * @param {Array} items - Collection items
+ * @param {string} currentPath - Current directory path
+ */
+const processCollectionItems = async (items = [], currentPath) => {
+ for (const item of items) {
+ if (item.type === 'folder') {
+ // Create folder
+ let sanitizedFolderName = sanitizeName(item?.filename || item?.name);
+ const folderPath = path.join(currentPath, sanitizedFolderName);
+ fs.mkdirSync(folderPath, { recursive: true });
+
+ // Create folder.bru file if root exists
+ if (item?.root?.meta?.name) {
+ const folderBruFilePath = path.join(folderPath, 'folder.bru');
+ if (item.seq) {
+ item.root.meta.seq = item.seq;
+ }
+ const folderContent = await stringifyFolder(item.root);
+ safeWriteFileSync(folderBruFilePath, folderContent);
+ }
+
+ // Process folder items recursively
+ if (item.items && item.items.length) {
+ await processCollectionItems(item.items, folderPath);
+ }
+ } else if (['http-request', 'graphql-request'].includes(item.type)) {
+ // Create request file
+ let sanitizedFilename = sanitizeName(item?.filename || `${item.name}.bru`);
+ if (!sanitizedFilename.endsWith('.bru')) {
+ sanitizedFilename += '.bru';
+ }
+
+ // Convert JSON to BRU format based on the item type
+ let type = item.type === 'http-request' ? 'http' : 'graphql';
+ const bruJson = {
+ type: type,
+ name: item.name,
+ seq: typeof item.seq === 'number' ? item.seq : 1,
+ tags: item.tags || [],
+ settings: {},
+ request: {
+ method: item.request?.method || 'GET',
+ url: item.request?.url || '',
+ headers: item.request?.headers || [],
+ params: item.request?.params || [],
+ auth: item.request?.auth || {},
+ body: item.request?.body || {},
+ script: item.request?.script || {},
+ vars: item.request?.vars || { req: [], res: [] },
+ assertions: item.request?.assertions || [],
+ tests: item.request?.tests || '',
+ docs: item.request?.docs || ''
+ }
+ };
+
+ // Convert to BRU format and write to file
+ const content = await stringifyRequest(bruJson);
+ safeWriteFileSync(path.join(currentPath, sanitizedFilename), content);
+ }
+ }
+};
+
+const sortByNameThenSequence = items => {
+ const isSeqValid = seq => Number.isFinite(seq) && Number.isInteger(seq) && seq > 0;
+
+ // Sort folders alphabetically by name
+ const alphabeticallySorted = [...items].sort((a, b) => a.name && b.name && a.name.localeCompare(b.name));
+
+ // Extract folders without 'seq'
+ const withoutSeq = alphabeticallySorted.filter(f => !isSeqValid(f['seq']));
+
+ // Extract folders with 'seq' and sort them by 'seq'
+ const withSeq = alphabeticallySorted.filter(f => isSeqValid(f['seq'])).sort((a, b) => a.seq - b.seq);
+
+ const sortedItems = withoutSeq;
+
+ // Insert folders with 'seq' at their specified positions
+ withSeq.forEach((item) => {
+ const position = item.seq - 1;
+ const existingItem = withoutSeq[position];
+
+ // Check if there's already an item with the same sequence number
+ const hasItemWithSameSeq = Array.isArray(existingItem)
+ ? existingItem?.[0]?.seq === item.seq
+ : existingItem?.seq === item.seq;
+
+ if (hasItemWithSameSeq) {
+ // If there's a conflict, group items with same sequence together
+ const newGroup = Array.isArray(existingItem)
+ ? [...existingItem, item]
+ : [existingItem, item];
+
+ withoutSeq.splice(position, 1, newGroup);
+ } else {
+ // Insert item at the specified position
+ withoutSeq.splice(position, 0, item);
+ }
+ });
+
+ // return flattened sortedItems
+ return sortedItems.flat();
+};
+
+
module.exports = {
+ createCollectionJsonFromPathname,
mergeHeaders,
mergeVars,
mergeScripts,
- getTreePathFromCollectionToItem
+ findItemInCollection,
+ getTreePathFromCollectionToItem,
+ createCollectionFromBrunoObject,
+ mergeAuth,
+ getAllRequestsInFolder,
+ getAllRequestsAtFolderRoot,
+ getCallStack
}
\ No newline at end of file
diff --git a/packages/bruno-cli/src/utils/common.js b/packages/bruno-cli/src/utils/common.js
index d2eeec366..7a2ae3bf2 100644
--- a/packages/bruno-cli/src/utils/common.js
+++ b/packages/bruno-cli/src/utils/common.js
@@ -34,14 +34,10 @@ const parseDataFromResponse = (response, disableParsingResponseJson = false) =>
// Filter out ZWNBSP character
// https://gist.github.com/antic183/619f42b559b78028d1fe9e7ae8a1352d
data = data.replace(/^\uFEFF/, '');
-
- // If the response is a string and starts and ends with double quotes, it's a stringified JSON and should not be parsed
- if (!disableParsingResponseJson && !(typeof data === 'string' && data.startsWith('"') && data.endsWith('"'))) {
+ if (!disableParsingResponseJson) {
data = JSON.parse(data);
}
- } catch {
-
- }
+ } catch { }
return { data, dataBuffer };
};
diff --git a/packages/bruno-cli/src/utils/cookies.js b/packages/bruno-cli/src/utils/cookies.js
index acb58b505..9e160a784 100644
--- a/packages/bruno-cli/src/utils/cookies.js
+++ b/packages/bruno-cli/src/utils/cookies.js
@@ -1,100 +1 @@
-const { Cookie, CookieJar } = require('tough-cookie');
-const each = require('lodash/each');
-
-const cookieJar = new CookieJar();
-
-const addCookieToJar = (setCookieHeader, requestUrl) => {
- const cookie = Cookie.parse(setCookieHeader, { loose: true });
- cookieJar.setCookieSync(cookie, requestUrl, {
- ignoreError: true // silently ignore things like parse errors and invalid domains
- });
-};
-
-const getCookiesForUrl = (url) => {
- return cookieJar.getCookiesSync(url);
-};
-
-const getCookieStringForUrl = (url) => {
- const cookies = getCookiesForUrl(url);
-
- if (!Array.isArray(cookies) || !cookies.length) {
- return '';
- }
-
- const validCookies = cookies.filter((cookie) => !cookie.expires || cookie.expires > Date.now());
-
- return validCookies.map((cookie) => cookie.cookieString()).join('; ');
-};
-
-const getDomainsWithCookies = () => {
- return new Promise((resolve, reject) => {
- const domainCookieMap = {};
-
- cookieJar.store.getAllCookies((err, cookies) => {
- if (err) {
- return reject(err);
- }
-
- cookies.forEach((cookie) => {
- if (!domainCookieMap[cookie.domain]) {
- domainCookieMap[cookie.domain] = [cookie];
- } else {
- domainCookieMap[cookie.domain].push(cookie);
- }
- });
-
- const domains = Object.keys(domainCookieMap);
- const domainsWithCookies = [];
-
- each(domains, (domain) => {
- const cookies = domainCookieMap[domain];
- const validCookies = cookies.filter((cookie) => !cookie.expires || cookie.expires > Date.now());
-
- if (validCookies.length) {
- domainsWithCookies.push({
- domain,
- cookies: validCookies,
- cookieString: validCookies.map((cookie) => cookie.cookieString()).join('; ')
- });
- }
- });
-
- resolve(domainsWithCookies);
- });
- });
-};
-
-const deleteCookiesForDomain = (domain) => {
- return new Promise((resolve, reject) => {
- cookieJar.store.removeCookies(domain, null, (err) => {
- if (err) {
- return reject(err);
- }
-
- return resolve();
- });
- });
-};
-
-const saveCookies = (url, headers) => {
- let setCookieHeaders = [];
- if (headers['set-cookie']) {
- setCookieHeaders = Array.isArray(headers['set-cookie'])
- ? headers['set-cookie']
- : [headers['set-cookie']];
- for (let setCookieHeader of setCookieHeaders) {
- if (typeof setCookieHeader === 'string' && setCookieHeader.length) {
- addCookieToJar(setCookieHeader, url);
- }
- }
- }
-}
-
-module.exports = {
- addCookieToJar,
- getCookiesForUrl,
- getCookieStringForUrl,
- getDomainsWithCookies,
- deleteCookiesForDomain,
- saveCookies
-};
+module.exports = require('@usebruno/requests').cookies;
diff --git a/packages/bruno-cli/src/utils/filesystem.js b/packages/bruno-cli/src/utils/filesystem.js
index 4b066ac68..46aa6c797 100644
--- a/packages/bruno-cli/src/utils/filesystem.js
+++ b/packages/bruno-cli/src/utils/filesystem.js
@@ -29,7 +29,7 @@ const isFile = (filepath) => {
const isDirectory = (dirPath) => {
try {
- return fs.existsSync(dirPath) && fs.lstatSync(dirPath).isDirectory();
+ return fs.existsSync(dirPath) && fs.statSync(dirPath).isDirectory();
} catch (_) {
return false;
}
@@ -118,6 +118,46 @@ const getSubDirectories = (dir) => {
}
};
+/**
+ * Sanitizes a filename to make it safe for filesystem operations
+ *
+ * @param {string} name - The name to sanitize
+ * @returns {string} - The sanitized name
+ */
+const sanitizeName = (name) => {
+ if (!name) return '';
+
+ const invalidCharacters = /[<>:"/\\|?*\x00-\x1F]/g;
+ return name
+ .replace(invalidCharacters, '-') // replace invalid characters with hyphens
+ .replace(/^[.\s-]+/, '') // remove leading dots, hyphens and spaces
+ .replace(/[.\s]+$/, ''); // remove trailing dots and spaces (keep trailing hyphens)
+};
+
+/**
+ * Validates if a name is valid for the filesystem
+ *
+ * @param {string} name - The name to validate
+ * @returns {boolean} - True if the name is valid, false otherwise
+ */
+const validateName = (name) => {
+ if (!name) return false;
+
+ const reservedDeviceNames = /^(CON|PRN|AUX|NUL|COM[0-9]|LPT[0-9])$/i;
+ const firstCharacter = /^[^.\s\-\<>:"/\\|?*\x00-\x1F]/; // no dot, space, or hyphen at start
+ const middleCharacters = /^[^<>:"/\\|?*\x00-\x1F]*$/; // no invalid characters
+ const lastCharacter = /[^.\s]$/; // no dot or space at end, hyphen allowed
+
+ if (name.length > 255) return false; // max name length
+ if (reservedDeviceNames.test(name)) return false; // windows reserved names
+
+ return (
+ firstCharacter.test(name) &&
+ middleCharacters.test(name) &&
+ lastCharacter.test(name)
+ );
+};
+
module.exports = {
exists,
isSymbolicLink,
@@ -131,5 +171,7 @@ module.exports = {
searchForFiles,
searchForBruFiles,
stripExtension,
- getSubDirectories
+ getSubDirectories,
+ sanitizeName,
+ validateName
};
diff --git a/packages/bruno-cli/src/utils/form-data.js b/packages/bruno-cli/src/utils/form-data.js
index eab5d5824..7bb00ba81 100644
--- a/packages/bruno-cli/src/utils/form-data.js
+++ b/packages/bruno-cli/src/utils/form-data.js
@@ -3,6 +3,25 @@ const FormData = require('form-data');
const fs = require('fs');
const path = require('path');
+/**
+ * @param {Array.} params The request body Array
+ * @returns {object} Returns an obj with repeating key as an array of values
+ * {item: 2, item: 3, item1: 4} becomes {item: [2,3], item1: 4}
+ */
+const buildFormUrlEncodedPayload = (params) => {
+ return params.reduce((acc, p) => {
+ if (!acc[p.name]) {
+ acc[p.name] = p.value;
+ } else if (Array.isArray(acc[p.name])) {
+ acc[p.name].push(p.value);
+ } else {
+ acc[p.name] = [acc[p.name], p.value];
+ }
+ return acc;
+ }, {});
+};
+
+
const createFormData = (data, collectionPath) => {
// make axios work in node using form data
// reference: https://github.com/axios/axios/issues/1006#issuecomment-320165427
@@ -38,5 +57,6 @@ const createFormData = (data, collectionPath) => {
};
module.exports = {
+ buildFormUrlEncodedPayload,
createFormData
}
\ No newline at end of file
diff --git a/packages/bruno-cli/src/utils/request.js b/packages/bruno-cli/src/utils/request.js
new file mode 100644
index 000000000..6a75a3cc7
--- /dev/null
+++ b/packages/bruno-cli/src/utils/request.js
@@ -0,0 +1,44 @@
+
+// Check for meaningful test() calls (not commented out or in strings)
+const hasExecutableTestInScript = (script) => {
+ if (!script) return false;
+
+ // Remove single-line comments (// ...) and multi-line comments (/* ... */)
+ let cleanScript = script
+ .replace(/\/\/.*$/gm, '') // Remove line comments
+ .replace(/\/\*[\s\S]*?\*\//g, ''); // Remove block comments
+
+ // Remove string literals to avoid matching test() inside strings
+ cleanScript = cleanScript
+ .replace(/"(?:[^"\\]|\\.)*"/g, '""') // Remove double-quoted strings
+ .replace(/'(?:[^'\\]|\\.)*'/g, "''") // Remove single-quoted strings
+ .replace(/`(?:[^`\\]|\\.)*`/g, '``'); // Remove template literals
+
+ // Look for standalone test() calls (not object method calls like obj.test())
+ // Find all test( occurrences and check they're not preceded by dots
+ let hasValidTest = false;
+ let searchFrom = 0;
+
+ while (true) {
+ const index = cleanScript.indexOf('test', searchFrom);
+ if (index === -1) break;
+
+ // Check if this looks like test( with optional whitespace
+ const afterTest = cleanScript.substring(index + 4);
+ if (/^\s*\(/.test(afterTest)) {
+ // Found test( - check if it's not preceded by a dot
+ if (index === 0 || cleanScript[index - 1] !== '.') {
+ hasValidTest = true;
+ break;
+ }
+ }
+
+ searchFrom = index + 1;
+ }
+
+ return hasValidTest;
+};
+
+module.exports = {
+ hasExecutableTestInScript
+};
\ No newline at end of file
diff --git a/packages/bruno-cli/tests/commands/run.spec.js b/packages/bruno-cli/tests/commands/run.spec.js
deleted file mode 100644
index 10cdf42b4..000000000
--- a/packages/bruno-cli/tests/commands/run.spec.js
+++ /dev/null
@@ -1,67 +0,0 @@
-const { describe, it, expect } = require('@jest/globals');
-
-const { printRunSummary } = require('../../src/commands/run');
-
-describe('printRunSummary', () => {
- // Suppress console.log output
- jest.spyOn(console, 'log').mockImplementation(() => {});
-
- it('should produce the correct summary for a successful run', () => {
- const results = [
- {
- testResults: [{ status: 'pass' }, { status: 'pass' }, { status: 'pass' }],
- assertionResults: [{ status: 'pass' }, { status: 'pass' }],
- error: null
- },
- {
- testResults: [{ status: 'pass' }, { status: 'pass' }],
- assertionResults: [{ status: 'pass' }, { status: 'pass' }, { status: 'pass' }],
- error: null
- }
- ];
-
- const summary = printRunSummary(results);
-
- expect(summary.totalRequests).toBe(2);
- expect(summary.passedRequests).toBe(2);
- expect(summary.failedRequests).toBe(0);
- expect(summary.totalAssertions).toBe(5);
- expect(summary.passedAssertions).toBe(5);
- expect(summary.failedAssertions).toBe(0);
- expect(summary.totalTests).toBe(5);
- expect(summary.passedTests).toBe(5);
- expect(summary.failedTests).toBe(0);
- });
-
- it('should produce the correct summary for a failed run', () => {
- const results = [
- {
- testResults: [{ status: 'fail' }, { status: 'pass' }, { status: 'pass' }],
- assertionResults: [{ status: 'pass' }, { status: 'fail' }],
- error: null
- },
- {
- testResults: [{ status: 'pass' }, { status: 'fail' }],
- assertionResults: [{ status: 'pass' }, { status: 'fail' }, { status: 'fail' }],
- error: null
- },
- {
- testResults: [],
- assertionResults: [],
- error: new Error('Request failed')
- }
- ];
-
- const summary = printRunSummary(results);
-
- expect(summary.totalRequests).toBe(3);
- expect(summary.passedRequests).toBe(2);
- expect(summary.failedRequests).toBe(1);
- expect(summary.totalAssertions).toBe(5);
- expect(summary.passedAssertions).toBe(2);
- expect(summary.failedAssertions).toBe(3);
- expect(summary.totalTests).toBe(5);
- expect(summary.passedTests).toBe(3);
- expect(summary.failedTests).toBe(2);
- });
-});
diff --git a/packages/bruno-cli/tests/reporters/html.spec.js b/packages/bruno-cli/tests/reporters/html.spec.js
deleted file mode 100644
index b45e57f41..000000000
--- a/packages/bruno-cli/tests/reporters/html.spec.js
+++ /dev/null
@@ -1,81 +0,0 @@
-const { describe, it, expect } = require('@jest/globals');
-const fs = require('fs');
-
-const makeHtmlOutput = require('../../src/reporters/html');
-
-describe('makeHtmlOutput', () => {
- beforeEach(() => {
- jest.spyOn(fs, 'writeFileSync').mockImplementation(() => {});
- });
-
- afterEach(() => {
- jest.restoreAllMocks();
- });
-
- it('should produce an html report', () => {
- const outputJson = {
- summary: {
- totalRequests: 1,
- passedRequests: 1,
- failedRequests: 1,
- totalAssertions: 1,
- passedAssertions: 1,
- failedAssertions: 1,
- totalTests: 1,
- passedTests: 1,
- failedTests: 1
- },
- results: [
- {
- description: 'description provided',
- suitename: 'Tests/Suite A',
- request: {
- method: 'GET',
- url: 'https://ima.test'
- },
- assertionResults: [
- {
- lhsExpr: 'res.status',
- rhsExpr: 'eq 200',
- status: 'pass'
- },
- {
- lhsExpr: 'res.status',
- rhsExpr: 'neq 200',
- status: 'fail',
- error: 'expected 200 to not equal 200'
- }
- ],
- runtime: 1.2345678
- },
- {
- request: {
- method: 'GET',
- url: 'https://imanother.test'
- },
- suitename: 'Tests/Suite B',
- testResults: [
- {
- lhsExpr: 'res.status',
- rhsExpr: 'eq 200',
- description: 'A test that passes',
- status: 'pass'
- },
- {
- description: 'A test that fails',
- status: 'fail',
- error: 'expected 200 to not equal 200',
- status: 'fail'
- }
- ],
- runtime: 2.3456789
- }
- ]
- };
-
- makeHtmlOutput(outputJson, '/tmp/testfile.html');
-
- const htmlReport = fs.writeFileSync.mock.calls[0][1];
- expect(htmlReport).toContain(JSON.stringify(outputJson, null, 2));
- });
-});
diff --git a/packages/bruno-cli/tests/runner/collection-json-from-pathname.spec.js b/packages/bruno-cli/tests/runner/collection-json-from-pathname.spec.js
new file mode 100644
index 000000000..8cab346cd
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/collection-json-from-pathname.spec.js
@@ -0,0 +1,172 @@
+const path = require("node:path");
+const { describe, it, expect } = require('@jest/globals');
+const constants = require('../../src/constants');
+const { createCollectionJsonFromPathname } = require('../../src/utils/collection');
+
+describe('create collection json from pathname', () => {
+ it("should throw an error when the pathname is not a valid bruno collection root", () => {
+ const invalidCollectionPathname = path.join(__dirname, './fixtures/collection-invalid');
+ jest.spyOn(console, 'error').mockImplementation(() => { });
+ let mockProcessExit = jest.spyOn(process, 'exit').mockImplementation((code) => { throw new Error(code); });
+ try { createCollectionJsonFromPathname(invalidCollectionPathname); } catch { }
+ expect(mockProcessExit).toHaveBeenCalledWith(constants.EXIT_STATUS.ERROR_NOT_IN_COLLECTION);
+ jest.restoreAllMocks();
+ })
+
+ it("creates a bruno collection json from the collection bru files", () => {
+ const collectionPathname = path.join(__dirname, './fixtures/collection-json-from-pathname/collection');
+ const outputCollectionJson = createCollectionJsonFromPathname(collectionPathname);
+
+ let c = outputCollectionJson;
+ expect(c).toBeDefined();
+
+ /* collection bruno.json */
+ expect(c).toHaveProperty('brunoConfig.version', "1");
+ expect(c).toHaveProperty('brunoConfig.name', 'collection');
+ expect(c).toHaveProperty('brunoConfig.type', 'collection');
+ expect(c).toHaveProperty('brunoConfig.ignore', ["node_modules", ".git"]);
+ expect(c).toHaveProperty('brunoConfig.proxy.enabled', false);
+ expect(c).toHaveProperty('brunoConfig.proxy.protocol', 'http');
+ expect(c).toHaveProperty('brunoConfig.proxy.hostname', '');
+ expect(c).toHaveProperty('brunoConfig.proxy.port', 3000);
+ expect(c).toHaveProperty('brunoConfig.proxy.auth.enabled', false);
+ expect(c).toHaveProperty('brunoConfig.proxy.auth.username', '');
+ expect(c).toHaveProperty('brunoConfig.proxy.auth.password', '');
+ expect(c).toHaveProperty('brunoConfig.proxy.bypassProxy', '');
+ expect(c).toHaveProperty('brunoConfig.scripts.moduleWhitelist', ['crypto', 'buffer']);
+ expect(c).toHaveProperty('brunoConfig.scripts.filesystemAccess.allow', true);
+ expect(c).toHaveProperty('brunoConfig.clientCertificates.enabled', true);
+ expect(c).toHaveProperty('brunoConfig.clientCertificates.certs', []);
+
+ /* collection pathname */
+ expect(c).toHaveProperty('pathname', collectionPathname);
+
+ /* collection root */
+ // headers
+ expect(c).toHaveProperty('root.request.headers[0].name', 'collection_header');
+ expect(c).toHaveProperty('root.request.headers[0].value', 'collection_header_value');
+ expect(c).toHaveProperty('root.request.headers[0].enabled', true);
+ // auth
+ expect(c).toHaveProperty('root.request.auth.mode', 'basic');
+ expect(c).toHaveProperty('root.request.auth.basic.username', 'username');
+ expect(c).toHaveProperty('root.request.auth.basic.password', 'password');
+ // pre-request scripts
+ expect(c).toHaveProperty('root.request.script.req', 'const collectionPreRequestScript = true;');
+ // collection root - post-response scripts
+ expect(c).toHaveProperty('root.request.script.res', 'const collectionPostResponseScript = true;');
+ // pre-request vars
+ expect(c).toHaveProperty('root.request.vars.req[0].name', 'collection_pre_var');
+ expect(c).toHaveProperty('root.request.vars.req[0].value', 'collection_pre_var_value');
+ expect(c).toHaveProperty('root.request.vars.req[0].enabled', true);
+ // post-response vars
+ expect(c).toHaveProperty('root.request.vars.res[0].name', 'collection_post_var');
+ expect(c).toHaveProperty('root.request.vars.res[0].value', 'collection_post_var_value');
+ expect(c).toHaveProperty('root.request.vars.res[0].enabled', true);
+ // tests
+ expect(c).toHaveProperty('root.request.tests', 'test(\"collection level script\", function() {\n expect(\"test\").to.equal(\"test\");\n});');
+
+ /* collection items names and sequences */
+ // /folder_2
+ expect(c).toHaveProperty('items[0].type', 'folder');
+ expect(c).toHaveProperty('items[0].name', 'folder_2');
+ expect(c).toHaveProperty('items[0].seq', 1);
+
+ // /folder_2/request_1
+ expect(c).toHaveProperty('items[0].items[0].name', 'request_1');
+ expect(c).toHaveProperty('items[0].items[0].seq', 1);
+
+ // /folder_2/request_3
+ expect(c).toHaveProperty('items[0].items[1].name', 'request_3');
+ expect(c).toHaveProperty('items[0].items[1].seq', 2);
+
+ // /folder_2/request_2
+ expect(c).toHaveProperty('items[0].items[2].name', 'request_2');
+ expect(c).toHaveProperty('items[0].items[2].seq', 3);
+
+ // /folder_1
+ expect(c).toHaveProperty('items[1].type', 'folder');
+ expect(c).toHaveProperty('items[1].name', 'folder_1');
+ expect(c).toHaveProperty('items[1].seq', 5);
+
+ // /folder_1/folder_2
+ expect(c).toHaveProperty('items[1].items[0].name', 'folder_2');
+ expect(c).toHaveProperty('items[1].items[0].seq', 1);
+
+ // /folder_1/folder_2/request_3
+ expect(c).toHaveProperty('items[1].items[0].items[0].name', 'request_3');
+ expect(c).toHaveProperty('items[1].items[0].items[0].seq', 1);
+
+ // /folder_1/folder_2/request_1
+ expect(c).toHaveProperty('items[1].items[0].items[1].name', 'request_1');
+ expect(c).toHaveProperty('items[1].items[0].items[1].seq', 2);
+
+ // /folder_1/folder_2/request_2
+ expect(c).toHaveProperty('items[1].items[0].items[2].name', 'request_2');
+ expect(c).toHaveProperty('items[1].items[0].items[2].seq', 3);
+
+ // /folder_1/folder_1
+ expect(c).toHaveProperty('items[1].items[1].name', 'folder_1');
+ expect(c).toHaveProperty('items[1].items[1].seq', 2);
+
+ // /folder_1/folder_1/request_3
+ expect(c).toHaveProperty('items[1].items[1].items[0].name', 'request_3');
+ expect(c).toHaveProperty('items[1].items[1].items[0].seq', 1);
+
+ // /folder_1/folder_1/request_2
+ expect(c).toHaveProperty('items[1].items[1].items[1].name', 'request_2');
+ expect(c).toHaveProperty('items[1].items[1].items[1].seq', 2);
+
+ // /folder_1/folder_1/request_1
+ expect(c).toHaveProperty('items[1].items[1].items[2].name', 'request_1');
+ expect(c).toHaveProperty('items[1].items[1].items[2].seq', 3);
+
+ // /folder_1/request_1
+ expect(c).toHaveProperty('items[1].items[2].name', 'request_1');
+ expect(c).toHaveProperty('items[1].items[2].seq', 3);
+
+ // /folder_1/request_3
+ expect(c).toHaveProperty('items[1].items[3].name', 'request_3');
+ expect(c).toHaveProperty('items[1].items[3].seq', 4);
+
+ // /folder_1/request_2
+ expect(c).toHaveProperty('items[1].items[4].name', 'request_2');
+ expect(c).toHaveProperty('items[1].items[4].seq', 5);
+
+ // /request_2
+ expect(c).toHaveProperty('items[2].name', 'request_3');
+ expect(c).toHaveProperty('items[2].seq', 2);
+
+ // /request_3
+ expect(c).toHaveProperty('items[3].name', 'request_1');
+ expect(c).toHaveProperty('items[3].seq', 3);
+
+ // /request_4
+ expect(c).toHaveProperty('items[4].name', 'request_2');
+ expect(c).toHaveProperty('items[4].seq', 4);
+
+ /* collection request item - /request_4 */
+ // /request_4
+ // headers
+ expect(c).toHaveProperty('items[4].request.headers[0].name', 'request_header');
+ expect(c).toHaveProperty('items[4].request.headers[0].value', 'request_header_value');
+ expect(c).toHaveProperty('items[4].request.headers[0].enabled', true);
+ // auth
+ expect(c).toHaveProperty('items[4].request.auth.mode', 'basic');
+ expect(c).toHaveProperty('items[4].request.auth.basic.username', 'username');
+ expect(c).toHaveProperty('items[4].request.auth.basic.password', 'password');
+ // pre-request scripts
+ expect(c).toHaveProperty('items[4].request.script.req', 'const requestPreRequestScript = true;');
+ // request items[4] - post-response scripts
+ expect(c).toHaveProperty('items[4].request.script.res', 'const requestPostResponseScript = true;');
+ // pre-request vars
+ expect(c).toHaveProperty('items[4].request.vars.req[0].name', 'request_pre_var');
+ expect(c).toHaveProperty('items[4].request.vars.req[0].value', 'request_pre_var_value');
+ expect(c).toHaveProperty('items[4].request.vars.req[0].enabled', true);
+ // post-response vars
+ expect(c).toHaveProperty('items[4].request.vars.res[0].name', 'request_post_var');
+ expect(c).toHaveProperty('items[4].request.vars.res[0].value', 'request_post_var_value');
+ expect(c).toHaveProperty('items[4].request.vars.res[0].enabled', true);
+ // tests
+ expect(c).toHaveProperty('items[4].request.tests', 'test(\"request level script\", function() {\n expect(\"test\").to.equal(\"test\");\n});');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/bruno.json b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/bruno.json
new file mode 100644
index 000000000..366f84472
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/bruno.json
@@ -0,0 +1,31 @@
+{
+ "version": "1",
+ "name": "collection",
+ "type": "collection",
+ "ignore": [
+ "node_modules",
+ ".git"
+ ],
+ "proxy": {
+ "enabled": false,
+ "protocol": "http",
+ "hostname": "",
+ "port": 3000,
+ "auth": {
+ "enabled": false,
+ "username": "",
+ "password": ""
+ },
+ "bypassProxy": ""
+ },
+ "scripts": {
+ "moduleWhitelist": ["crypto", "buffer"],
+ "filesystemAccess": {
+ "allow": true
+ }
+ },
+ "clientCertificates": {
+ "enabled": true,
+ "certs": []
+ }
+}
\ No newline at end of file
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/collection.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/collection.bru
new file mode 100644
index 000000000..bdfbfc430
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/collection.bru
@@ -0,0 +1,38 @@
+headers {
+ collection_header: collection_header_value
+}
+
+auth {
+ mode: basic
+}
+
+auth:basic {
+ username: username
+ password: password
+}
+
+vars:pre-request {
+ collection_pre_var: collection_pre_var_value
+}
+
+vars:post-response {
+ collection_post_var: collection_post_var_value
+}
+
+script:pre-request {
+ const collectionPreRequestScript = true;
+}
+
+script:post-response {
+ const collectionPostResponseScript = true;
+}
+
+tests {
+ test("collection level script", function() {
+ expect("test").to.equal("test");
+ });
+}
+
+docs {
+ # docs
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder.bru
new file mode 100644
index 000000000..fb30da65c
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder.bru
@@ -0,0 +1,4 @@
+meta {
+ name: folder_1
+ seq: 5
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_1/folder.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_1/folder.bru
new file mode 100644
index 000000000..2b5e3cd2f
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_1/folder.bru
@@ -0,0 +1,4 @@
+meta {
+ name: folder_1
+ seq: 2
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_1/request_1.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_1/request_1.bru
new file mode 100644
index 000000000..79ff1676a
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_1/request_1.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_1
+ type: http
+ seq: 3
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_1/request_2.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_1/request_2.bru
new file mode 100644
index 000000000..b0b7e046e
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_1/request_2.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_2
+ type: http
+ seq: 2
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_1/request_3.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_1/request_3.bru
new file mode 100644
index 000000000..7953c4499
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_1/request_3.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_3
+ type: http
+ seq: 1
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_2/folder.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_2/folder.bru
new file mode 100644
index 000000000..674476e89
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_2/folder.bru
@@ -0,0 +1,4 @@
+meta {
+ name: folder_2
+ seq: 1
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_2/request_1.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_2/request_1.bru
new file mode 100644
index 000000000..c93c6cb37
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_2/request_1.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_1
+ type: http
+ seq: 2
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_2/request_2.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_2/request_2.bru
new file mode 100644
index 000000000..375cc9f6d
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_2/request_2.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_2
+ type: http
+ seq: 3
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_2/request_3.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_2/request_3.bru
new file mode 100644
index 000000000..7953c4499
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/folder_2/request_3.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_3
+ type: http
+ seq: 1
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/request_1.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/request_1.bru
new file mode 100644
index 000000000..79ff1676a
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/request_1.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_1
+ type: http
+ seq: 3
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/request_2.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/request_2.bru
new file mode 100644
index 000000000..7dac68aed
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/request_2.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_2
+ type: http
+ seq: 5
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/request_3.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/request_3.bru
new file mode 100644
index 000000000..8a818f66c
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_1/request_3.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_3
+ type: http
+ seq: 4
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_2/folder.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_2/folder.bru
new file mode 100644
index 000000000..674476e89
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_2/folder.bru
@@ -0,0 +1,4 @@
+meta {
+ name: folder_2
+ seq: 1
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_2/request_1.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_2/request_1.bru
new file mode 100644
index 000000000..b8fb205ed
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_2/request_1.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_1
+ type: http
+ seq: 1
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_2/request_2.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_2/request_2.bru
new file mode 100644
index 000000000..375cc9f6d
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_2/request_2.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_2
+ type: http
+ seq: 3
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_2/request_3.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_2/request_3.bru
new file mode 100644
index 000000000..a2582cf6c
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/folder_2/request_3.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_3
+ type: http
+ seq: 2
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/request_1.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/request_1.bru
new file mode 100644
index 000000000..79ff1676a
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/request_1.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_1
+ type: http
+ seq: 3
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/request_2.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/request_2.bru
new file mode 100644
index 000000000..1aef2b30e
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/request_2.bru
@@ -0,0 +1,58 @@
+meta {
+ name: request_2
+ type: http
+ seq: 4
+}
+
+post {
+ url: https://echo.usebruno.com/:request_path_param?request_query_param=request_query_param_value
+ body: text
+ auth: basic
+}
+
+params:query {
+ request_query_param: request_query_param_value
+}
+
+params:path {
+ request_path_param: request_path_param_value
+}
+
+headers {
+ request_header: request_header_value
+}
+
+auth:basic {
+ username: username
+ password: password
+}
+
+body:text {
+ ping
+}
+
+vars:pre-request {
+ request_pre_var: request_pre_var_value
+}
+
+vars:post-response {
+ request_post_var: request_post_var_value
+}
+
+assert {
+ res.status: eq 200
+}
+
+script:pre-request {
+ const requestPreRequestScript = true;
+}
+
+script:post-response {
+ const requestPostResponseScript = true;
+}
+
+tests {
+ test("request level script", function() {
+ expect("test").to.equal("test");
+ });
+}
diff --git a/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/request_3.bru b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/request_3.bru
new file mode 100644
index 000000000..a2582cf6c
--- /dev/null
+++ b/packages/bruno-cli/tests/runner/fixtures/collection-json-from-pathname/collection/request_3.bru
@@ -0,0 +1,11 @@
+meta {
+ name: request_3
+ type: http
+ seq: 2
+}
+
+get {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
diff --git a/packages/bruno-cli/tests/runner/prepare-request.spec.js b/packages/bruno-cli/tests/runner/prepare-request.spec.js
index ffc9986df..d532dcff1 100644
--- a/packages/bruno-cli/tests/runner/prepare-request.spec.js
+++ b/packages/bruno-cli/tests/runner/prepare-request.spec.js
@@ -117,7 +117,7 @@ describe('prepare-request: prepareRequest', () => {
const result = prepareRequest(item, collection);
const expected = { username: 'testUser', password: 'testPass123' };
- expect(result.auth).toEqual(expected);
+ expect(result.basicAuth).toEqual(expected);
});
});
@@ -150,6 +150,159 @@ describe('prepare-request: prepareRequest', () => {
});
});
+ describe('OAuth2 Authentication', () => {
+ it('If collection auth is OAuth2 with client credentials grant type', () => {
+ collection.root.request.auth = {
+ mode: 'oauth2',
+ oauth2: {
+ grantType: 'client_credentials',
+ accessTokenUrl: 'https://auth.example.com/token',
+ clientId: 'test_client_id',
+ clientSecret: 'test_client_secret',
+ scope: 'read write',
+ credentialsPlacement: 'header',
+ tokenPlacement: 'header',
+ tokenHeaderPrefix: 'Bearer',
+ tokenQueryKey: 'access_token'
+ }
+ };
+
+ const result = prepareRequest(item, collection);
+
+ expect(result.oauth2).toBeDefined();
+ expect(result.oauth2.grantType).toBe('client_credentials');
+ expect(result.oauth2.accessTokenUrl).toBe('https://auth.example.com/token');
+ expect(result.oauth2.clientId).toBe('test_client_id');
+ expect(result.oauth2.clientSecret).toBe('test_client_secret');
+ expect(result.oauth2.scope).toBe('read write');
+ expect(result.oauth2.credentialsPlacement).toBe('header');
+ expect(result.oauth2.tokenPlacement).toBe('header');
+ expect(result.oauth2.tokenHeaderPrefix).toBe('Bearer');
+ expect(result.oauth2.tokenQueryKey).toBe('access_token');
+ });
+
+ it('If collection auth is OAuth2 with password grant type', () => {
+ collection.root.request.auth = {
+ mode: 'oauth2',
+ oauth2: {
+ grantType: 'password',
+ accessTokenUrl: 'https://auth.example.com/token',
+ username: 'test_user',
+ password: 'test_password',
+ clientId: 'test_client_id',
+ clientSecret: 'test_client_secret',
+ scope: 'read write',
+ credentialsPlacement: 'body',
+ tokenPlacement: 'url',
+ tokenHeaderPrefix: 'Bearer',
+ tokenQueryKey: 'access_token'
+ }
+ };
+
+ const result = prepareRequest(item, collection);
+
+ expect(result.oauth2).toBeDefined();
+ expect(result.oauth2.grantType).toBe('password');
+ expect(result.oauth2.accessTokenUrl).toBe('https://auth.example.com/token');
+ expect(result.oauth2.username).toBe('test_user');
+ expect(result.oauth2.password).toBe('test_password');
+ expect(result.oauth2.clientId).toBe('test_client_id');
+ expect(result.oauth2.clientSecret).toBe('test_client_secret');
+ expect(result.oauth2.scope).toBe('read write');
+ expect(result.oauth2.credentialsPlacement).toBe('body');
+ expect(result.oauth2.tokenPlacement).toBe('url');
+ expect(result.oauth2.tokenHeaderPrefix).toBe('Bearer');
+ expect(result.oauth2.tokenQueryKey).toBe('access_token');
+ });
+ });
+
+ describe('AWS v4 Authentication', () => {
+ it('If collection auth is AWS v4', () => {
+ collection.root.request.auth = {
+ mode: 'awsv4',
+ awsv4: {
+ accessKeyId: 'AKIAIOSFODNN7EXAMPLE',
+ secretAccessKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
+ sessionToken: 'session-token',
+ service: 's3',
+ region: 'us-west-2',
+ profileName: 'default'
+ }
+ };
+
+ const result = prepareRequest(item, collection);
+ const expected = {
+ accessKeyId: 'AKIAIOSFODNN7EXAMPLE',
+ secretAccessKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
+ sessionToken: 'session-token',
+ service: 's3',
+ region: 'us-west-2',
+ profileName: 'default'
+ };
+ expect(result.awsv4config).toEqual(expected);
+ });
+ });
+
+ describe('NTLM Authentication', () => {
+ it('If collection auth is NTLM', () => {
+ collection.root.request.auth = {
+ mode: 'ntlm',
+ ntlm: {
+ username: 'testUser',
+ password: 'testPass123',
+ domain: 'testDomain'
+ }
+ };
+
+ const result = prepareRequest(item, collection);
+ const expected = {
+ username: 'testUser',
+ password: 'testPass123',
+ domain: 'testDomain'
+ };
+ expect(result.ntlmConfig).toEqual(expected);
+ });
+ });
+
+ describe('WSSE Authentication', () => {
+ it('If collection auth is WSSE', () => {
+ collection.root.request.auth = {
+ mode: 'wsse',
+ wsse: {
+ username: 'testUser',
+ password: 'testPass123'
+ }
+ };
+
+ const result = prepareRequest(item, collection);
+ expect(result.headers).toHaveProperty('X-WSSE');
+ expect(result.headers['X-WSSE']).toContain('UsernameToken Username="testUser"');
+ expect(result.headers['X-WSSE']).toContain('PasswordDigest="');
+ expect(result.headers['X-WSSE']).toContain('Nonce="');
+ expect(result.headers['X-WSSE']).toContain('Created="');
+ });
+ });
+
+ describe('Digest Authentication', () => {
+ it('If collection auth is digest auth', () => {
+ collection.root.request.auth = {
+ mode: 'digest',
+ digest: {
+ username: 'testUser',
+ password: 'testPass123'
+ }
+ };
+
+ const result = prepareRequest(item, collection);
+
+ const expected = {
+ username: 'testUser',
+ password: 'testPass123'
+ };
+ expect(result.digestConfig).toEqual(expected);
+ });
+ });
+
describe('No Authentication', () => {
it('If request does not have auth configured', () => {
delete item.request.auth;
@@ -161,4 +314,209 @@ describe('prepare-request: prepareRequest', () => {
});
});
});
+
+ describe('Properly maps request-level auth', () => {
+ let item;
+
+ beforeEach(() => {
+ item = {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'GET',
+ headers: [],
+ params: [],
+ url: 'https://usebruno.com',
+ auth: {
+ mode: 'basic' // Will be overridden in each test
+ },
+ script: {
+ req: 'console.log("Pre Request")',
+ res: 'console.log("Post Response")'
+ }
+ }
+ };
+ });
+
+ describe('API Key Authentication', () => {
+ it('If request auth is apikey in header', () => {
+ item.request.auth = {
+ mode: "apikey",
+ apikey: {
+ key: "x-api-key",
+ value: "{{apiKey}}",
+ placement: "header"
+ }
+ };
+
+ const result = prepareRequest(item);
+ expect(result.headers).toHaveProperty('x-api-key', '{{apiKey}}');
+ });
+
+ it('If request auth is apikey in header and request has existing headers', () => {
+ item.request.auth = {
+ mode: "apikey",
+ apikey: {
+ key: "x-api-key",
+ value: "{{apiKey}}",
+ placement: "header"
+ }
+ };
+
+ item.request.headers.push({ name: 'Content-Type', value: 'application/json', enabled: true });
+ const result = prepareRequest(item);
+ expect(result.headers).toHaveProperty('Content-Type', 'application/json');
+ expect(result.headers).toHaveProperty('x-api-key', '{{apiKey}}');
+ });
+
+ it('If request auth is apikey in query parameters', () => {
+ item.request.auth = {
+ mode: "apikey",
+ apikey: {
+ key: "x-api-key",
+ value: "{{apiKey}}",
+ placement: "queryparams"
+ }
+ };
+
+ const urlObj = new URL(item.request.url);
+ urlObj.searchParams.set(item.request.auth.apikey.key, item.request.auth.apikey.value);
+
+ const expected = urlObj.toString();
+ const result = prepareRequest(item);
+ expect(result.url).toEqual(expected);
+ });
+ });
+
+ describe('Basic Authentication', () => {
+ it('If request auth is basic auth', () => {
+ item.request.auth = {
+ mode: 'basic',
+ basic: {
+ username: 'testUser',
+ password: 'testPass123'
+ }
+ };
+
+ const result = prepareRequest(item);
+ const expected = { username: 'testUser', password: 'testPass123' };
+ expect(result.basicAuth).toEqual(expected);
+ });
+ });
+
+ describe('Bearer Token Authentication', () => {
+ it('If request auth is bearer token', () => {
+ item.request.auth = {
+ mode: 'bearer',
+ bearer: {
+ token: 'token123'
+ }
+ };
+
+ const result = prepareRequest(item);
+ expect(result.headers).toHaveProperty('Authorization', 'Bearer token123');
+ });
+
+ it('If request auth is bearer token and request has existing headers', () => {
+ item.request.auth = {
+ mode: 'bearer',
+ bearer: {
+ token: 'token123'
+ }
+ };
+
+ item.request.headers.push({ name: 'Content-Type', value: 'application/json', enabled: true });
+
+ const result = prepareRequest(item);
+ expect(result.headers).toHaveProperty('Authorization', 'Bearer token123');
+ expect(result.headers).toHaveProperty('Content-Type', 'application/json');
+ });
+ });
+
+ describe('AWS v4 Authentication', () => {
+ it('If request auth is AWS v4', () => {
+ item.request.auth = {
+ mode: 'awsv4',
+ awsv4: {
+ accessKeyId: 'AKIAIOSFODNN7EXAMPLE',
+ secretAccessKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
+ sessionToken: 'request-session-token',
+ service: 'dynamodb',
+ region: 'us-east-1',
+ profileName: 'dev'
+ }
+ };
+
+ const result = prepareRequest(item);
+ const expected = {
+ accessKeyId: 'AKIAIOSFODNN7EXAMPLE',
+ secretAccessKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
+ sessionToken: 'request-session-token',
+ service: 'dynamodb',
+ region: 'us-east-1',
+ profileName: 'dev'
+ };
+ expect(result.awsv4config).toEqual(expected);
+ });
+ });
+
+ describe('NTLM Authentication', () => {
+ it('If request auth is NTLM', () => {
+ item.request.auth = {
+ mode: 'ntlm',
+ ntlm: {
+ username: 'testUser',
+ password: 'testPass123',
+ domain: 'testDomain'
+ }
+ };
+
+ const result = prepareRequest(item);
+ const expected = {
+ username: 'testUser',
+ password: 'testPass123',
+ domain: 'testDomain'
+ };
+ expect(result.ntlmConfig).toEqual(expected);
+ });
+ });
+
+ describe('WSSE Authentication', () => {
+ it('If request auth is WSSE', () => {
+ item.request.auth = {
+ mode: 'wsse',
+ wsse: {
+ username: 'requestUser',
+ password: 'requestPass'
+ }
+ };
+
+ const result = prepareRequest(item);
+ expect(result.headers).toHaveProperty('X-WSSE');
+ expect(result.headers['X-WSSE']).toContain('UsernameToken Username="requestUser"');
+ expect(result.headers['X-WSSE']).toContain('PasswordDigest="');
+ expect(result.headers['X-WSSE']).toContain('Nonce="');
+ expect(result.headers['X-WSSE']).toContain('Created="');
+ });
+ });
+
+ describe('Digest Authentication', () => {
+ it('If request auth is digest auth', () => {
+ item.request.auth = {
+ mode: 'digest',
+ digest: {
+ username: 'requestUser',
+ password: 'requestPass123'
+ }
+ };
+
+ const result = prepareRequest(item);
+ const expected = {
+ username: 'requestUser',
+ password: 'requestPass123'
+ };
+ expect(result.digestConfig).toEqual(expected);
+ });
+ });
+ });
});
diff --git a/packages/bruno-cli/tests/utils/collection/get-call-stack.spec.js b/packages/bruno-cli/tests/utils/collection/get-call-stack.spec.js
new file mode 100644
index 000000000..8260b1485
--- /dev/null
+++ b/packages/bruno-cli/tests/utils/collection/get-call-stack.spec.js
@@ -0,0 +1,460 @@
+const { describe, it, expect, beforeEach } = require('@jest/globals');
+const { getCallStack } = require('../../../src/utils/collection');
+
+const collection = {
+ brunoConfig: {
+ version: '1',
+ name: 'multirun-cli',
+ type: 'collection',
+ ignore: ['node_modules', '.git']
+ },
+ root: {
+ request: {
+ headers: [],
+ auth: {},
+ script: {},
+ vars: {},
+ tests: ''
+ }
+ },
+ pathname: '/Users/tempo/Downloads/t-temp/multirun-cli-20',
+ items: [
+ {
+ name: 'root-folder',
+ pathname: '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder',
+ type: 'folder',
+ items: [
+ {
+ name: 'root-child-folder',
+ pathname: '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-folder',
+ type: 'folder',
+ items: [
+ {
+ name: 'root-child-child-folder',
+ pathname:
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-folder/root-child-child-folder',
+ type: 'folder',
+ items: [
+ {
+ name: 'root-child-child-child-req-0',
+ pathname:
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-folder/root-child-child-folder/root-child-child-child-req-0.bru',
+ type: 'http-request',
+ seq: 1,
+ request: {
+ method: 'GET',
+ url: 'https://g.cn',
+ auth: {
+ mode: 'inherit'
+ },
+ params: [],
+ headers: [],
+ body: {
+ mode: 'none'
+ },
+ vars: [],
+ assertions: [],
+ script: {
+ req: 'console.log("root-child-child-child-file-0")'
+ },
+ tests: ''
+ }
+ },
+ {
+ name: 'root-child-child-child-req-1',
+ pathname:
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-folder/root-child-child-folder/root-child-child-child-req-1.bru',
+ type: 'http-request',
+ seq: 2,
+ request: {
+ method: 'GET',
+ url: 'https://g.cn',
+ auth: {
+ mode: 'inherit'
+ },
+ params: [],
+ headers: [],
+ body: {
+ mode: 'none'
+ },
+ vars: [],
+ assertions: [],
+ script: {
+ req: 'console.log("root-child-child-child-file-1")'
+ },
+ tests: ''
+ }
+ }
+ ],
+ root: {
+ request: {
+ headers: [],
+ auth: {},
+ script: {},
+ vars: {},
+ tests: ''
+ },
+ meta: {
+ name: 'root-child-child-folder',
+ seq: 3
+ }
+ },
+ seq: 3
+ },
+ {
+ name: 'root-child-child-req-0',
+ pathname:
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-folder/root-child-child-req-0.bru',
+ type: 'http-request',
+ seq: 4,
+ request: {
+ method: 'GET',
+ url: 'https://g.cn',
+ auth: {
+ mode: 'inherit'
+ },
+ params: [],
+ headers: [],
+ body: {
+ mode: 'none'
+ },
+ vars: [],
+ assertions: [],
+ script: {
+ req: 'console.log("root-child-child-file-0")'
+ },
+ tests: ''
+ }
+ },
+ {
+ name: 'root-child-child-req-1',
+ pathname:
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-folder/root-child-child-req-1.bru',
+ type: 'http-request',
+ seq: 5,
+ request: {
+ method: 'GET',
+ url: 'https://g.cn',
+ auth: {
+ mode: 'inherit'
+ },
+ params: [],
+ headers: [],
+ body: {
+ mode: 'none'
+ },
+ vars: [],
+ assertions: [],
+ script: {
+ req: 'console.log("root-child-child-file-1")'
+ },
+ tests: ''
+ }
+ }
+ ],
+ root: {
+ request: {
+ headers: [],
+ auth: {},
+ script: {},
+ vars: {},
+ tests: ''
+ },
+ meta: {
+ name: 'root-child-folder',
+ seq: 6
+ }
+ },
+ seq: 6
+ },
+ {
+ name: 'root-child-req-0',
+ pathname: '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-req-0.bru',
+ type: 'http-request',
+ seq: 7,
+ request: {
+ method: 'GET',
+ url: 'https://g.cn',
+ auth: {
+ mode: 'inherit'
+ },
+ params: [],
+ headers: [],
+ body: {
+ mode: 'none'
+ },
+ vars: [],
+ assertions: [],
+ script: {
+ req: 'console.log("root-child-file-0")'
+ },
+ tests: ''
+ }
+ },
+ {
+ name: 'root-child-req-1',
+ pathname: '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-req-1.bru',
+ type: 'http-request',
+ seq: 8,
+ request: {
+ method: 'GET',
+ url: 'https://g.cn',
+ auth: {
+ mode: 'inherit'
+ },
+ params: [],
+ headers: [],
+ body: {
+ mode: 'none'
+ },
+ vars: [],
+ assertions: [],
+ script: {
+ req: 'console.log("root-child-file-1")'
+ },
+ tests: ''
+ }
+ }
+ ],
+ root: {
+ request: {
+ headers: [],
+ auth: {},
+ script: {},
+ vars: {},
+ tests: ''
+ },
+ meta: {
+ name: 'root-folder',
+ seq: 9
+ }
+ },
+ seq: 9
+ },
+ {
+ name: 'root-req-0',
+ pathname: '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-req-0.bru',
+ type: 'http-request',
+ seq: 10,
+ request: {
+ method: 'GET',
+ url: 'https://g.cn',
+ auth: {
+ mode: 'inherit'
+ },
+ params: [],
+ headers: [],
+ body: {
+ mode: 'none'
+ },
+ vars: [],
+ assertions: [],
+ script: {
+ req: 'console.log("root-file-0")'
+ },
+ tests: ''
+ }
+ },
+ {
+ name: 'root-req-1',
+ pathname: '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-req-1.bru',
+ type: 'http-request',
+ seq: 11,
+ request: {
+ method: 'GET',
+ url: 'https://g.cn',
+ auth: {
+ mode: 'inherit'
+ },
+ params: [],
+ headers: [],
+ body: {
+ mode: 'none'
+ },
+ vars: [],
+ assertions: [],
+ script: {
+ req: 'console.log("root-file-1")'
+ },
+ tests: ''
+ }
+ },
+ {
+ name: 'root-req-2',
+ pathname: '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-req-2.bru',
+ type: 'http-request',
+ seq: 12,
+ request: {
+ method: 'GET',
+ url: 'https://g.cn',
+ auth: {
+ mode: 'inherit'
+ },
+ params: [],
+ headers: [],
+ body: {
+ mode: 'none'
+ },
+ vars: [],
+ assertions: [],
+ script: {
+ req: 'console.log("root-file-2")'
+ },
+ tests: ''
+ }
+ }
+ ]
+};
+
+const sequenceChangedCollection = {
+ brunoConfig: {
+ version: '1',
+ name: 'sequenceChangedCollection',
+ type: 'collection',
+ ignore: ['node_modules', '.git']
+ },
+ root: {},
+ pathname: '/Users/tempo/Downloads/t-temp/sequenceChangedCollection',
+ items: [
+ {
+ name: 'three',
+ pathname: '/Users/tempo/Downloads/t-temp/sequenceChangedCollection/three.bru',
+ type: 'http-request',
+ seq: 1,
+ request: {
+ method: 'GET',
+ url: 'https://usebruno.com',
+ auth: {
+ mode: 'inherit'
+ },
+ params: [],
+ headers: [],
+ body: {
+ mode: 'none'
+ },
+ vars: [],
+ assertions: [],
+ script: {},
+ tests: ''
+ }
+ },
+ {
+ name: 'one',
+ pathname: '/Users/tempo/Downloads/t-temp/sequenceChangedCollection/one.bru',
+ type: 'http-request',
+ seq: 2,
+ request: {
+ method: 'GET',
+ url: 'https://usebruno.com',
+ auth: {
+ mode: 'inherit'
+ },
+ params: [],
+ headers: [],
+ body: {
+ mode: 'none'
+ },
+ vars: [],
+ assertions: [],
+ script: {},
+ tests: ''
+ }
+ },
+ {
+ name: 'two',
+ pathname: '/Users/tempo/Downloads/t-temp/sequenceChangedCollection/two.bru',
+ type: 'http-request',
+ seq: 2,
+ request: {
+ method: 'GET',
+ url: 'https://usebruno.com',
+ auth: {
+ mode: 'inherit'
+ },
+ params: [],
+ headers: [],
+ body: {
+ mode: 'none'
+ },
+ vars: [],
+ assertions: [],
+ script: {},
+ tests: ''
+ }
+ }
+ ]
+};
+
+describe('getCallStack', () => {
+ it('should return all requests in the collection', () => {
+ const callStack = getCallStack(['/Users/tempo/Downloads/t-temp/multirun-cli-20'], collection, { recursive: true });
+ const expectedCallStack = [
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-folder/root-child-child-folder/root-child-child-child-req-0.bru',
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-folder/root-child-child-folder/root-child-child-child-req-1.bru',
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-folder/root-child-child-req-0.bru',
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-folder/root-child-child-req-1.bru',
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-req-0.bru',
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-req-1.bru',
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-req-0.bru',
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-req-1.bru',
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-req-2.bru'
+ ];
+ expect(callStack.map((item) => item.pathname)).toEqual(expectedCallStack);
+ });
+
+ it('should return all requests in the collection when sequence is changed', () => {
+ const callStack = getCallStack(
+ ['/Users/tempo/Downloads/t-temp/sequenceChangedCollection'],
+ sequenceChangedCollection,
+ {
+ recursive: true
+ }
+ );
+ const expectedCallStack = [
+ '/Users/tempo/Downloads/t-temp/sequenceChangedCollection/three.bru',
+ '/Users/tempo/Downloads/t-temp/sequenceChangedCollection/one.bru',
+ '/Users/tempo/Downloads/t-temp/sequenceChangedCollection/two.bru'
+ ];
+ expect(callStack.map((item) => item.pathname)).toEqual(expectedCallStack);
+ });
+});
+
+describe('getCallStack with collection sequence changed', () => {
+ it('should return an empty array', () => {
+ const callStack = getCallStack(
+ ['/Users/tempo/Downloads/t-temp/sequenceChangedCollection'],
+ sequenceChangedCollection,
+ {
+ recursive: true
+ }
+ );
+ const expectedCallStack = [
+ '/Users/tempo/Downloads/t-temp/sequenceChangedCollection/three.bru',
+ '/Users/tempo/Downloads/t-temp/sequenceChangedCollection/one.bru',
+ '/Users/tempo/Downloads/t-temp/sequenceChangedCollection/two.bru'
+ ];
+ expect(callStack.map((item) => item.pathname)).toEqual(expectedCallStack);
+ });
+});
+
+describe('getCallStack with muliple folders and requests run', () => {
+ it('should return an empty array', () => {
+ const callStack = getCallStack(
+ [
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-req-0.bru',
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-folder/root-child-child-req-0.bru',
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-req-2.bru'
+ ],
+ collection,
+ {
+ recursive: true
+ }
+ );
+ const expectedCallStack = [
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-req-0.bru',
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-folder/root-child-folder/root-child-child-req-0.bru',
+ '/Users/tempo/Downloads/t-temp/multirun-cli-20/root-req-2.bru'
+ ];
+ expect(callStack.map((item) => item.pathname)).toEqual(expectedCallStack);
+ });
+});
diff --git a/packages/bruno-cli/tests/utils/common.spec.js b/packages/bruno-cli/tests/utils/common.spec.js
new file mode 100644
index 000000000..bd4c1e7e0
--- /dev/null
+++ b/packages/bruno-cli/tests/utils/common.spec.js
@@ -0,0 +1,309 @@
+const { describe, it, expect } = require('@jest/globals');
+const { hasExecutableTestInScript } = require('../../src/utils/request');
+
+describe('hasExecutableTestInScript', () => {
+ describe('should return true for valid test() calls', () => {
+ it('should detect basic test calls', () => {
+ const script = `
+ test("should work", function() {
+ expect(true).to.be.true;
+ });
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+
+ it('should detect indented test calls', () => {
+ const script = `
+ if (true) {
+ test("indented test", function() {
+ expect(1).to.equal(1);
+ });
+ }
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+
+ it('should detect test calls with extra whitespace', () => {
+ const script = `test ("with spaces", function() { });`;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+
+ it('should detect test calls after assignments', () => {
+ const script = `
+ const result = test("assignment test", function() {
+ expect("hello").to.be.a("string");
+ });
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+
+ it('should detect test calls in conditionals', () => {
+ const script = `
+ if (condition) {
+ test("conditional test", function() {
+ expect(true).to.be.true;
+ });
+ }
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+
+ it('should detect test calls in arrays', () => {
+ const script = `
+ const tests = [
+ test("array test", function() {
+ expect(Array.isArray([])).to.be.true;
+ })
+ ];
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+
+ it('should detect test calls in ternary operators', () => {
+ const script = `
+ const result = condition ? test("ternary test", function() {
+ expect(true).to.be.true;
+ }) : null;
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+
+ it('should detect test calls after semicolons', () => {
+ const script = `
+ const data = res.data; test("after semicolon", function() {
+ expect(data).to.be.an("object");
+ });
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+
+ it('should detect test calls in object values', () => {
+ const script = `
+ const config = {
+ validation: test("object value test", function() {
+ expect(true).to.be.true;
+ })
+ };
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+
+ it('should detect multiple test calls', () => {
+ const script = `
+ test("first test", function() {
+ expect(1).to.equal(1);
+ });
+
+ test("second test", function() {
+ expect(2).to.equal(2);
+ });
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+
+ it('should detect test calls at start of script', () => {
+ const script = `test("at start", function() { expect(true).to.be.true; });`;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+ });
+
+ describe('should return false for invalid test() calls', () => {
+ it('should ignore commented out test calls with //', () => {
+ const script = `
+ // test("commented test", function() {
+ // expect(true).to.be.true;
+ // });
+ console.log("no real tests here");
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(false);
+ });
+
+ it('should ignore commented out test calls with /* */', () => {
+ const script = `
+ /* test("block commented test", function() {
+ expect(true).to.be.true;
+ }); */
+ console.log("no real tests here");
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(false);
+ });
+
+ it('should ignore test() in double-quoted strings', () => {
+ const script = `
+ console.log("This contains test() but should not match");
+ console.log("Remember to test() your API");
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(false);
+ });
+
+ it('should ignore test() in single-quoted strings', () => {
+ const script = `
+ console.log('Single quote test() should not match');
+ const message = 'Use test() for validation';
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(false);
+ });
+
+ it('should ignore test() in template literals', () => {
+ const script = `
+ console.log(\`Template literal test() should not match\`);
+ const message = \`Remember to test() your code\`;
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(false);
+ });
+
+ it('should ignore object method calls', () => {
+ const script = `
+ const obj = { test: function() { return "not a real test"; } };
+ obj.test("This is a method call");
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(false);
+ });
+
+ it('should ignore this.test() calls', () => {
+ const script = `
+ this.test("Another method call");
+ this.test();
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(false);
+ });
+
+ it('should ignore complex object chain calls', () => {
+ const script = `
+ api.client.test("Should not match");
+ user.test.endpoint("Chained method");
+ window.test("Should not match");
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(false);
+ });
+
+ it('should ignore object methods in variables', () => {
+ const script = `
+ const validator = {
+ test: function(value) { return value > 0; }
+ };
+ validator.test(42);
+
+ const tester = { test: () => "mock" };
+ tester.test("method call");
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(false);
+ });
+
+ it('should return false for empty scripts', () => {
+ expect(hasExecutableTestInScript('')).toBe(false);
+ expect(hasExecutableTestInScript(null)).toBe(false);
+ expect(hasExecutableTestInScript(undefined)).toBe(false);
+ });
+
+ it('should return false for scripts with no test calls', () => {
+ const script = `
+ bru.setVar("userId", "12345");
+ console.log("Setting up request");
+ const data = res.data;
+ bru.setVar("responseData", data);
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(false);
+ });
+
+ it('should return false when test is part of other words', () => {
+ const script = `
+ const testing = "value";
+ const protest = "demo";
+ const fastest = "speed";
+ console.log("contest results");
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(false);
+ });
+ });
+
+ describe('should handle mixed scenarios correctly', () => {
+ it('should return true when valid test exists among invalid ones', () => {
+ const script = `
+ // test("commented out");
+ console.log("test() in string");
+ obj.test("method call");
+
+ test("real test", function() {
+ expect(true).to.be.true;
+ });
+
+ api.client.test("another method");
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+
+ it('should return false when only invalid tests exist', () => {
+ const script = `
+ // test("commented out test", function() {
+ // expect(true).to.be.true;
+ // });
+
+ console.log("test() inside string");
+ console.log('test() in single quotes');
+ console.log(\`test() in template\`);
+
+ const obj = { test: () => "mock" };
+ obj.test("method call");
+ this.test("another method");
+ api.client.test("chained method");
+
+ bru.setVar("test", "variable name");
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(false);
+ });
+
+ it('should handle complex nested quotes correctly', () => {
+ const script = `
+ console.log("String with 'nested quotes' and test() call");
+ console.log('String with "nested quotes" and test() call');
+
+ test("real test with \\"escaped quotes\\"", function() {
+ expect(true).to.be.true;
+ });
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+
+ it('should handle multi-line comments correctly', () => {
+ const script = `
+ /*
+ * This is a multi-line comment with
+ * test("commented test", function() {
+ * expect(true).to.be.true;
+ * });
+ */
+
+ test("real test", function() {
+ expect(true).to.be.true;
+ });
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+
+ it('should handle inline comments correctly', () => {
+ const script = `
+ const data = res.data; // test("inline comment")
+ test("real test", function() { // this is a real test
+ expect(data).to.be.an("object");
+ });
+ `;
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+ });
+
+ describe('edge cases', () => {
+ it('should handle test calls immediately after dots (edge case)', () => {
+ const script = `
+ // This should not match because it's after a dot
+ console.test("should not match");
+
+ // But this should match because there's a space
+ console. test("should match due to space");
+ `;
+ // Note: Our current implementation would consider the second one valid
+ // because there's a space between the dot and test
+ expect(hasExecutableTestInScript(script)).toBe(true);
+ });
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-common/babel.config.js b/packages/bruno-common/babel.config.js
new file mode 100644
index 000000000..2f87e5c7c
--- /dev/null
+++ b/packages/bruno-common/babel.config.js
@@ -0,0 +1,6 @@
+module.exports = {
+ presets: [
+ ['@babel/preset-env', { modules: 'auto' }],
+ '@babel/preset-typescript',
+ ],
+};
diff --git a/packages/bruno-common/jest.config.js b/packages/bruno-common/jest.config.js
index a58c252f8..546abd629 100644
--- a/packages/bruno-common/jest.config.js
+++ b/packages/bruno-common/jest.config.js
@@ -1,5 +1,9 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
module.exports = {
- preset: 'ts-jest',
+ transform: {
+ '^.+\\.(ts|js)$': 'babel-jest',
+ },
+ transformIgnorePatterns: [
+ '/node_modules/(?!(lodash-es|is-ip|ip-regex|super-regex|function-timeout|time-span|convert-hrtime|clone-regexp|is-regexp)/)'
+ ],
testEnvironment: 'node'
};
diff --git a/packages/bruno-common/package.json b/packages/bruno-common/package.json
index df2d6f969..c989069df 100644
--- a/packages/bruno-common/package.json
+++ b/packages/bruno-common/package.json
@@ -5,6 +5,23 @@
"main": "dist/cjs/index.js",
"module": "dist/esm/index.js",
"types": "dist/index.d.ts",
+ "exports": {
+ ".": {
+ "require": "./dist/cjs/index.js",
+ "import": "./dist/esm/index.js",
+ "types": "./dist/index.d.ts"
+ },
+ "./runner": {
+ "require": "./dist/runner/cjs/index.js",
+ "import": "./dist/runner/esm/index.js",
+ "types": "./dist/runner/index.d.ts"
+ },
+ "./utils": {
+ "require": "./dist/utils/cjs/index.js",
+ "import": "./dist/utils/esm/index.js",
+ "types": "./dist/utils/index.d.ts"
+ }
+ },
"files": [
"dist",
"src",
@@ -15,20 +32,29 @@
"test": "jest",
"test:watch": "jest --watch",
"prebuild": "npm run clean",
- "build": "rollup -c",
+ "build": "rollup -c rollup.config.js",
+ "watch": "rollup -c -w",
"prepack": "npm run test && npm run build"
},
"devDependencies": {
+ "@babel/preset-env": "^7.26.9",
+ "@babel/preset-typescript": "^7.27.0",
+ "@faker-js/faker": "^9.7.0",
+ "@jest/globals": "^29.7.0",
"@rollup/plugin-commonjs": "^23.0.2",
"@rollup/plugin-node-resolve": "^15.0.1",
- "@rollup/plugin-typescript": "^9.0.2",
- "rollup":"3.29.5",
+ "@rollup/plugin-typescript": "^12.1.2",
+ "@types/jest": "^29.5.14",
+ "babel-jest": "^29.7.0",
+ "is-ip": "^5.0.1",
+ "moment": "^2.29.4",
+ "rollup": "3.29.5",
"rollup-plugin-dts": "^5.0.0",
"rollup-plugin-peer-deps-external": "^2.2.4",
"rollup-plugin-terser": "^7.0.2",
- "typescript": "^4.8.4"
+ "typescript": "^5.8.3"
},
"overrides": {
- "rollup":"3.29.5"
+ "rollup": "3.29.5"
}
}
diff --git a/packages/bruno-common/rollup.config.js b/packages/bruno-common/rollup.config.js
index 51aedecb6..398379451 100644
--- a/packages/bruno-common/rollup.config.js
+++ b/packages/bruno-common/rollup.config.js
@@ -7,34 +7,59 @@ const peerDepsExternal = require('rollup-plugin-peer-deps-external');
const packageJson = require('./package.json');
-module.exports = [
- {
- input: 'src/index.ts',
- output: [
- {
- file: packageJson.main,
- format: 'cjs',
- sourcemap: true
- },
- {
- file: packageJson.module,
- format: 'esm',
- sourcemap: true
+function createBuildConfig({ inputDir, input, cjsOutput, esmOutput }) {
+ return [
+ {
+ input,
+ output: [
+ {
+ file: cjsOutput,
+ format: 'cjs',
+ sourcemap: true
+ },
+ {
+ file: esmOutput,
+ format: 'esm',
+ sourcemap: true
+ }
+ ],
+ plugins: [
+ peerDepsExternal(),
+ nodeResolve(),
+ commonjs(),
+ typescript({
+ tsconfig: './tsconfig.json',
+ include: [inputDir]
+ }),
+ terser()
+ ],
+ treeshake: {
+ moduleSideEffects: false
}
- ],
- plugins: [
- peerDepsExternal(),
- nodeResolve({
- extensions: ['.css']
- }),
- commonjs(),
- typescript({ tsconfig: './tsconfig.json' }),
- terser()
- ]
- },
- {
- input: 'dist/esm/index.d.ts',
- output: [{ file: 'dist/index.d.ts', format: 'esm' }],
- plugins: [dts.default()]
- }
+ }
+ ];
+}
+
+// todo: configure declarations
+module.exports = [
+ // Main package build
+ ...createBuildConfig({
+ inputDir: 'src/**/*',
+ input: 'src/index.ts',
+ cjsOutput: packageJson.main,
+ esmOutput: packageJson.module
+ }),
+ // reports/html
+ ...createBuildConfig({
+ inputDir: 'src/runner/**/*',
+ input: 'src/runner/index.ts',
+ cjsOutput: 'dist/runner/cjs/index.js',
+ esmOutput: 'dist/runner/esm/index.js'
+ }),
+ ...createBuildConfig({
+ inputDir: 'src/utils/**/*',
+ input: 'src/utils/index.ts',
+ cjsOutput: 'dist/utils/cjs/index.js',
+ esmOutput: 'dist/utils/esm/index.js'
+ })
];
diff --git a/packages/bruno-common/src/index.ts b/packages/bruno-common/src/index.ts
index 04a709c57..e72c1d847 100644
--- a/packages/bruno-common/src/index.ts
+++ b/packages/bruno-common/src/index.ts
@@ -1,5 +1,5 @@
-import interpolate from './interpolate';
+export { mockDataFunctions } from './utils/faker-functions';
+export { default as interpolate } from './interpolate';
+export { default as isRequestTagsIncluded } from './tags';
-export default {
- interpolate
-};
+export * as utils from './utils';
\ No newline at end of file
diff --git a/packages/bruno-common/src/interpolate/index.spec.ts b/packages/bruno-common/src/interpolate/index.spec.ts
index adfdf54cd..025898a42 100644
--- a/packages/bruno-common/src/interpolate/index.spec.ts
+++ b/packages/bruno-common/src/interpolate/index.spec.ts
@@ -1,5 +1,5 @@
import interpolate from './index';
-
+import moment from 'moment';
describe('interpolate', () => {
it('should replace placeholders with values from the object', () => {
const inputString = 'Hello, my name is {{user.name}} and I am {{user.age}} years old';
@@ -41,7 +41,7 @@ describe('interpolate', () => {
Hi, I am {{user.full_name}},
I am {{user.age}} years old.
My favorite food is {{user.fav-food[0]}} and {{user.fav-food[1]}}.
- I like attention: {{user.want.attention}}
+ I like attention: {{user['want.attention']}}
`;
const expectedStr = `
Hi, I am Bruno,
@@ -67,19 +67,21 @@ describe('interpolate', () => {
expect(result).toBe('Hello, my name is {{ user.name }} and I am 4 years old');
});
- it('should give precedence to the last key in case of duplicates', () => {
- const inputString = 'Hello, my name is {{user.name}} and I am {{user.age}} years old';
+ test('should give precedence to the last key in case of duplicates (not at the top level)', () => {
+ const inputString = `Hello, my name is {{data['user.name']}} and {{data.user.name}} I am {{data.user.age}} years old`;
const inputObject = {
- 'user.name': 'Bruno',
- user: {
- name: 'Not Bruno',
- age: 4
+ data: {
+ 'user.name': 'Bruno',
+ user: {
+ name: 'Not _Bruno_',
+ age: 4
+ }
}
};
const result = interpolate(inputString, inputObject);
- expect(result).toBe('Hello, my name is Not Bruno and I am 4 years old');
+ expect(result).toBe('Hello, my name is Bruno and Not _Bruno_ I am 4 years old');
});
});
@@ -238,7 +240,7 @@ describe('interpolate - recursive', () => {
Hi, I am {{user.full_name}},
I am {{user.age}} years old.
My favorite food is {{user.fav-food[0]}} and {{user.fav-food[1]}}.
- I like attention: {{user.want.attention}}
+ I like attention: {{user['want.attention']}}
`;
const inputObject = {
user: {
@@ -297,46 +299,46 @@ describe('interpolate - recursive', () => {
expect(result).toBe('{{recursion3}}');
});
- it('should replace repetead placeholders with 1 level of recursion with values from the object', () => {
- const inputString = '{{repetead}}';
+ it('should replace repeated placeholders with 1 level of recursion with values from the object', () => {
+ const inputString = '{{repeated}}';
const inputObject = {
- repetead: '{{repetead2}} {{repetead2}}',
- repetead2: 'repetead2'
+ repeated: '{{repeated2}} {{repeated2}}',
+ repeated2: 'repeated2'
};
const result = interpolate(inputString, inputObject);
- expect(result).toBe(new Array(2).fill('repetead2').join(' '));
+ expect(result).toBe(new Array(2).fill('repeated2').join(' '));
});
- it('should replace repetead placeholders with 2 level of recursion with values from the object', () => {
- const inputString = '{{repetead}}';
+ it('should replace repeated placeholders with 2 level of recursion with values from the object', () => {
+ const inputString = '{{repeated}}';
const inputObject = {
- repetead: '{{repetead2}} {{repetead2}}',
- repetead2: '{{repetead3}} {{repetead3}} {{repetead3}}',
- repetead3: 'repetead3'
+ repeated: '{{repeated2}} {{repeated2}}',
+ repeated2: '{{repeated3}} {{repeated3}} {{repeated3}}',
+ repeated3: 'repeated3'
};
const result = interpolate(inputString, inputObject);
- expect(result).toBe(new Array(6).fill('repetead3').join(' '));
+ expect(result).toBe(new Array(6).fill('repeated3').join(' '));
});
- it('should replace repetead placeholders with 3 level of recursion with values from the object', () => {
- const inputString = '{{repetead}}';
+ it('should replace repeated placeholders with 3 level of recursion with values from the object', () => {
+ const inputString = '{{repeated}}';
const inputObject = {
- repetead: '{{repetead2}} {{repetead2}}',
- repetead2: '{{repetead3}} {{repetead3}} {{repetead3}}',
- repetead3: '{{repetead4}} {{repetead4}} {{repetead4}} {{repetead4}}',
- repetead4: 'repetead4'
+ repeated: '{{repeated2}} {{repeated2}}',
+ repeated2: '{{repeated3}} {{repeated3}} {{repeated3}}',
+ repeated3: '{{repeated4}} {{repeated4}} {{repeated4}} {{repeated4}}',
+ repeated4: 'repeated4'
};
const result = interpolate(inputString, inputObject);
- expect(result).toBe(new Array(24).fill('repetead4').join(' '));
+ expect(result).toBe(new Array(24).fill('repeated4').join(' '));
});
- it('should replace mutiple interdependent variables in the same input string', () => {
+ it('should replace multiple interdependent variables in the same input string', () => {
const inputString = `{
"x": "{{v2}} {{v1}}"
}`;
@@ -354,3 +356,218 @@ describe('interpolate - recursive', () => {
}`);
});
});
+
+describe('interpolate - object handling', () => {
+ it('should stringify simple objects', () => {
+ const inputString = 'User: {{user}}';
+ const inputObject = {
+ 'user': { name: 'Bruno', age: 4 }
+ };
+
+ const result = interpolate(inputString, inputObject);
+
+ expect(result).toBe('User: {"name":"Bruno","age":4}');
+ });
+
+ it('should stringify simple objects (dot notation)', () => {
+ const inputString = 'User: {{user.data}}';
+ const inputObject = {
+ 'user.data': { name: 'Bruno', age: 4 }
+ };
+
+ const result = interpolate(inputString, inputObject);
+
+ expect(result).toBe('User: {"name":"Bruno","age":4}');
+ });
+
+ it('should stringify nested objects', () => {
+ const inputString = 'User: {{user}}';
+ const inputObject = {
+ 'user': {
+ name: 'Bruno',
+ age: 4,
+ preferences: {
+ food: ['egg', 'meat'],
+ toys: { favorite: 'ball' }
+ }
+ }
+ };
+
+ const result = interpolate(inputString, inputObject);
+
+ expect(result).toBe('User: {"name":"Bruno","age":4,"preferences":{"food":["egg","meat"],"toys":{"favorite":"ball"}}}');
+ });
+
+ it('should stringify arrays', () => {
+ const inputString = 'User favorites: {{favorites}}';
+ const inputObject = {
+ favorites: ['egg', 'meat', 'treats']
+ };
+
+ const result = interpolate(inputString, inputObject);
+
+ expect(result).toBe('User favorites: ["egg","meat","treats"]');
+ });
+
+ it('should handle null values correctly', () => {
+ const inputString = 'User: {{user}}';
+ const inputObject = {
+ 'user': null
+ };
+
+ const result = interpolate(inputString, inputObject);
+
+ expect(result).toBe('User: null');
+ });
+
+ it('should handle objects with nested interpolation', () => {
+ const inputString = 'User: {{user}}';
+ const inputObject = {
+ 'user': {
+ name: 'Bruno',
+ message: '{{user.greeting}}'
+ },
+ 'user.greeting': 'Hello there!'
+ };
+
+ const result = interpolate(inputString, inputObject);
+
+ expect(result).toBe('User: {"name":"Bruno","message":"Hello there!"}');
+ });
+
+ it('should handle objects within arrays', () => {
+ const inputString = 'Items: {{items}}';
+ const inputObject = {
+ 'items': [
+ { id: 1, name: 'Toy' },
+ { id: 2, name: 'Bone' },
+ { id: 3, name: 'Ball', colors: ['red', 'blue'] }
+ ]
+ };
+
+ const result = interpolate(inputString, inputObject);
+
+ expect(result).toBe('Items: [{"id":1,"name":"Toy"},{"id":2,"name":"Bone"},{"id":3,"name":"Ball","colors":["red","blue"]}]');
+ });
+});
+
+describe('interpolate - mock variable interpolation', () => {
+ it('should replace mock variables with generated values', () => {
+ const inputString = '{{$randomInt}}, {{$randomIP}}, {{$randomIPV4}}, {{$randomIPV6}}, {{$randomBoolean}}';
+
+ const result = interpolate(inputString, {});
+
+ // Validate the result using regex patterns
+ const randomIntPattern = /^(?:[0-9]{1,2}|[1-9][0-9]{2}|1000)$/;
+ const randomIPPattern = /^([\da-f]{1,4}:){7}[\da-f]{1,4}$|^(\d{1,3}\.){3}\d{1,3}$/;
+ const randomIPV4Pattern = /^(\d{1,3}\.){3}\d{1,3}$/;
+ const randomIPV6Pattern = /^([\da-f]{1,4}:){7}[\da-f]{1,4}$/;
+ const randomBooleanPattern = /^(true|false)$/;
+
+ const [randomInt, randomIP, randomIPV4, randomIPV6, randomBoolean] = result.split(', ');
+
+ expect(randomIntPattern.test(randomInt)).toBe(true);
+ expect(randomIPPattern.test(randomIP)).toBe(true);
+ expect(randomIPV4Pattern.test(randomIPV4)).toBe(true);
+ expect(randomIPV6Pattern.test(randomIPV6)).toBe(true);
+ expect(randomBooleanPattern.test(randomBoolean)).toBe(true);
+ });
+
+ it('should leave mock variables unchanged if no corresponding function exists', () => {
+ const inputString = 'Random number: {{$nonExistentMock}}';
+
+ const result = interpolate(inputString, {});
+
+ expect(result).toBe('Random number: {{$nonExistentMock}}');
+ });
+
+ it('should escape special characters in mock variable values and produce valid JSON when escapeJSONStrings is true', () => {
+ const inputString = '{"escapedValue": "{{$randomLoremParagraphs}}"}';
+
+ expect(() => {
+ const result = interpolate(inputString, {}, { escapeJSONStrings: true });
+ JSON.parse(result); // This should not throw an error
+ }).not.toThrow();
+ });
+
+ it('should not produce valid JSON when escapeJSONStrings is false', () => {
+ const inputString = '{"escapedValue": "{{$randomLoremParagraphs}}"}';
+
+ expect(() => {
+ const result = interpolate(inputString, {}, { escapeJSONStrings: false });
+ JSON.parse(result); // This should throw an error
+ }).toThrow();
+ });
+
+ it('should throw an error when producing invalid JSON regardless of escapeJSONStrings option', () => {
+ const inputString = '{"escapedValue": "{{$randomLoremParagraphs}}"}';
+
+ // Test without providing the options argument
+ expect(() => {
+ const result = interpolate(inputString, {});
+ JSON.parse(result); // This should throw an error
+ }).toThrow();
+
+ // Test with escapeJSONStrings explicitly set to false
+ expect(() => {
+ const result = interpolate(inputString, {}, { escapeJSONStrings: false });
+ JSON.parse(result); // This should throw an error
+ }).toThrow();
+ });
+});
+
+describe('interpolate - Date() handling', () => {
+ it('should interpolate Date() using JSON.stringify', () => {
+ const inputString = 'Date is {{date}}';
+ const inputObject = {
+ date: new Date("2025-04-17T15:33:41.117Z")
+ };
+
+ const jsonStringifiedDate = JSON.stringify(inputObject.date);
+ const result = interpolate(inputString, inputObject);
+
+ expect(result).toBe('Date is "2025-04-17T15:33:41.117Z"');
+ expect(result).toBe(`Date is ${jsonStringifiedDate}`);
+ })
+
+ it('should interpolate Date() when its nested in an object', () => {
+ const inputString = 'Date is {{date}}';
+ const inputObject = {
+ date: {
+ now: new Date("2025-04-17T15:33:41.117Z")
+ }
+ };
+
+ const result = interpolate(inputString, inputObject);
+
+ expect(result).toBe('Date is {"now":"2025-04-17T15:33:41.117Z"}');
+ })
+});
+
+describe('interpolate - moment() handling', () => {
+ it('should interpolate moment() using JSON.stringify', () => {
+ const inputString = 'Date is {{date}}';
+ const inputObject = {
+ date: moment("2025-04-17T15:33:41.117Z")
+ };
+
+ const jsonStringifiedDate = JSON.stringify(inputObject.date);
+ const result = interpolate(inputString, inputObject);
+
+ expect(result).toBe('Date is "2025-04-17T15:33:41.117Z"');
+ expect(result).toBe(`Date is ${jsonStringifiedDate}`);
+ })
+
+ it('should interpolate moment() when its nested in an object', () => {
+ const inputString = 'Date is {{date}}';
+ const inputObject = {
+ date: {
+ now: moment("2025-04-17T15:33:41.117Z")
+ }
+ };
+
+ const result = interpolate(inputString, inputObject);
+
+ expect(result).toBe('Date is {"now":"2025-04-17T15:33:41.117Z"}');
+ })
+})
\ No newline at end of file
diff --git a/packages/bruno-common/src/interpolate/index.ts b/packages/bruno-common/src/interpolate/index.ts
index 4a4092d88..83d803480 100644
--- a/packages/bruno-common/src/interpolate/index.ts
+++ b/packages/bruno-common/src/interpolate/index.ts
@@ -11,22 +11,51 @@
* Output: Hello, my name is Bruno and I am 4 years old
*/
-import { Set } from 'typescript';
-import { flattenObject } from '../utils';
+import { mockDataFunctions } from '../utils/faker-functions';
+import { get } from "lodash-es";
-const interpolate = (str: string, obj: Record): string => {
- if (!str || typeof str !== 'string' || !obj || typeof obj !== 'object') {
+const interpolate = (
+ str: string,
+ obj: Record,
+ options: { escapeJSONStrings?: boolean } = { escapeJSONStrings: false }
+): string => {
+ if (!str || typeof str !== 'string') {
return str;
}
- const flattenedObj = flattenObject(obj);
+ const { escapeJSONStrings } = options;
- return replace(str, flattenedObj);
+ const patternRegex = /\{\{\$(\w+)\}\}/g;
+ str = str.replace(patternRegex, (match, keyword) => {
+ let replacement = mockDataFunctions[keyword as keyof typeof mockDataFunctions]?.();
+
+ if (replacement === undefined) return match;
+ replacement = String(replacement);
+
+ if (!escapeJSONStrings) return replacement;
+
+ // All the below chars inside of a JSON String field
+ // will make it invalid JSON. So we will have to escape them with `\`.
+ // This is not exhaustive but selective to what faker-js can output.
+ if (!/[\\\n\r\t\"]/.test(replacement)) return replacement;
+ return replacement
+ .replace(/\\/g, '\\\\')
+ .replace(/\n/g, '\\n')
+ .replace(/\r/g, '\\r')
+ .replace(/\t/g, '\\t')
+ .replace(/\"/g, '\\"');
+ });
+
+ if (!obj || typeof obj !== 'object') {
+ return str;
+ }
+
+ return replace(str, obj);
};
const replace = (
str: string,
- flattenedObj: Record,
+ obj: Record,
visited = new Set(),
results = new Map()
): string => {
@@ -37,7 +66,10 @@ const replace = (
const patternRegex = /\{\{([^}]+)\}\}/g;
matchFound = false;
resultStr = resultStr.replace(patternRegex, (match, placeholder) => {
- const replacement = flattenedObj[placeholder];
+ let replacement = get(obj, placeholder);
+ if (typeof replacement === 'object' && replacement !== null) {
+ replacement = JSON.stringify(replacement);
+ }
if (results.has(match)) {
return results.get(match);
@@ -45,7 +77,7 @@ const replace = (
if (patternRegex.test(replacement) && !visited.has(match)) {
visited.add(match);
- const result = replace(replacement, flattenedObj, visited, results);
+ const result = replace(replacement, obj, visited, results);
results.set(match, result);
matchFound = true;
@@ -64,4 +96,4 @@ const replace = (
return resultStr;
};
-export default interpolate;
+export default interpolate;
\ No newline at end of file
diff --git a/packages/bruno-common/src/runner/index.ts b/packages/bruno-common/src/runner/index.ts
new file mode 100644
index 000000000..3e3c842b0
--- /dev/null
+++ b/packages/bruno-common/src/runner/index.ts
@@ -0,0 +1,4 @@
+import { generateHtmlReport } from "./reports/html/generate-report";
+import { getRunnerSummary } from "./runner-summary";
+
+export { generateHtmlReport, getRunnerSummary };
\ No newline at end of file
diff --git a/packages/bruno-common/src/runner/reports/html/generate-report.ts b/packages/bruno-common/src/runner/reports/html/generate-report.ts
new file mode 100644
index 000000000..7309c483e
--- /dev/null
+++ b/packages/bruno-common/src/runner/reports/html/generate-report.ts
@@ -0,0 +1,38 @@
+import { T_RunnerResults } from "../../types";
+import { isHtmlContentType, getContentType, redactImageData, encodeBase64 } from "../../utils";
+import htmlTemplateString from "./template";
+
+const generateHtmlReport = ({
+ runnerResults
+}: {
+ runnerResults: T_RunnerResults[]
+}): string => {
+ const resultsWithSummaryAndCleanData = runnerResults.map(({ iterationIndex, results, summary }) => {
+ return {
+ iterationIndex,
+ results: results.map((result) => {
+ const { request, response } = result || {};
+ const requestContentType = request?.headers ? getContentType(request?.headers) : '';
+ const responseContentType = response?.headers ? getContentType(response?.headers) : '';
+ return {
+ ...result,
+ request: {
+ ...result.request,
+ data: request?.data ? redactImageData(request?.data, requestContentType) : request?.data,
+ isHtml: isHtmlContentType(requestContentType)
+ },
+ response: {
+ ...result.response,
+ data: response?.data ? redactImageData(response?.data, responseContentType) : response?.data,
+ isHtml: isHtmlContentType(responseContentType)
+ }
+ }
+ }),
+ summary
+ }
+ });
+ const htmlString = htmlTemplateString(encodeBase64(JSON.stringify(resultsWithSummaryAndCleanData)));
+ return htmlString;
+};
+
+export { generateHtmlReport }
\ No newline at end of file
diff --git a/packages/bruno-common/src/runner/reports/html/template.ts b/packages/bruno-common/src/runner/reports/html/template.ts
new file mode 100644
index 000000000..cd0839e67
--- /dev/null
+++ b/packages/bruno-common/src/runner/reports/html/template.ts
@@ -0,0 +1,682 @@
+export const htmlTemplateString = (resutsJsonString: string) =>`
+
+
+ Bruno
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Dark
+ Light
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
;
+ data: string | object | null | boolean | number;
+ isHtml?: boolean;
+};
+
+type T_EmptyResponse = {
+ status?: null | undefined;
+ statusText?: null | undefined;
+ headers?: null | undefined;
+ data?: null | undefined;
+ responseTime?: number | undefined;
+ isHtml?: boolean | undefined;
+}
+
+type T_SkippedResponse = {
+ status?: string | null | undefined;
+ statusText?: string | null | undefined;
+ headers?: null | undefined;
+ data?: null | undefined;
+ responseTime?: number | undefined;
+ isHtml?: boolean | undefined;
+}
+
+// response types
+type T_Response = {
+ status: number | string;
+ statusText: string;
+ headers: Record;
+ data: string | object | null | boolean | number;
+ isHtml?: boolean;
+};
+
+// result type
+export type T_RunnerRequestExecutionResult = {
+ iterationIndex: number;
+ name: string;
+ path: string;
+ request: T_EmptyRequest | T_Request;
+ response: T_EmptyResponse | T_Response | T_SkippedResponse;
+ status: null | undefined | string;
+ error: null | undefined | string;
+ assertionResults?: T_AssertionResult[];
+ testResults?: T_TestResult[];
+ preRequestTestResults?: T_TestResult[];
+ postResponseTestResults?: T_TestResult[];
+ runDuration: number;
+}
+
+export type T_RunnerResults = {
+ iterationIndex: number;
+ iterationData?: any; // todo - csv/json row data
+ results: T_RunnerRequestExecutionResult[];
+ summary: T_RunSummary;
+}
+
+// run summary type
+export type T_RunSummary = {
+ totalRequests: number;
+ passedRequests: number;
+ failedRequests: number;
+ errorRequests: number;
+ skippedRequests: number;
+ totalAssertions: number;
+ passedAssertions: number;
+ failedAssertions: number;
+ totalTests: number;
+ passedTests: number;
+ failedTests: number;
+ totalPreRequestTests: number;
+ passedPreRequestTests: number;
+ failedPreRequestTests: number;
+ totalPostResponseTests: number;
+ passedPostResponseTests: number;
+ failedPostResponseTests: number;
+}
\ No newline at end of file
diff --git a/packages/bruno-common/src/runner/utils/index.ts b/packages/bruno-common/src/runner/utils/index.ts
new file mode 100644
index 000000000..76f1f774c
--- /dev/null
+++ b/packages/bruno-common/src/runner/utils/index.ts
@@ -0,0 +1,31 @@
+export const encodeBase64 = (str: string) => {
+ const bytes = new TextEncoder().encode(str);
+ const binary = bytes.reduce((acc, byte) => acc + String.fromCharCode(byte), '');
+ return btoa(binary);
+}
+
+export const decodeBase64 = (base64: string) => {
+ const binary = atob(base64);
+ const bytes = Uint8Array.from(binary, c => c.charCodeAt(0));
+ return new TextDecoder().decode(bytes);
+}
+
+export const getContentType = (headers: Record): string => {
+ if (!headers || typeof headers !== 'object') {
+ return '';
+ }
+ const contentType = Object.entries(headers)
+ .find(([key]) => key.toLowerCase() === 'content-type')?.[1];
+ return typeof contentType === 'string' ? contentType : '';
+};
+
+export const isHtmlContentType = (contentType: string) => {
+ return contentType?.includes("html");
+};
+
+export const redactImageData = (data: string | object | number | boolean, contentType: string) => {
+ if (contentType?.includes("image")) {
+ return "Response content redacted (image data)";
+ }
+ return data;
+}
\ No newline at end of file
diff --git a/packages/bruno-common/src/tags/index.spec.ts b/packages/bruno-common/src/tags/index.spec.ts
new file mode 100644
index 000000000..46d307502
--- /dev/null
+++ b/packages/bruno-common/src/tags/index.spec.ts
@@ -0,0 +1,43 @@
+import isRequestTagsIncluded from './index';
+
+describe('isRequestTagsIncluded', () => {
+ it('should include request when it has an included tag', () => {
+ const requestTags = ['tag1', 'tag2'];
+ const includeTags = ['tag1'];
+ const excludeTags: string[] = [];
+ const result = isRequestTagsIncluded(requestTags, includeTags, excludeTags);
+ expect(result).toBe(true);
+ });
+
+ it('should include request when included tags is empty', () => {
+ const requestTags = ['tag1', 'tag2'];
+ const includeTags: string[] = [];
+ const excludeTags: string[] = [];
+ const result = isRequestTagsIncluded(requestTags, includeTags, excludeTags);
+ expect(result).toBe(true);
+ });
+
+ it('should exclude request when it does not have an included tag', () => {
+ const requestTags = ['tag1'];
+ const includeTags = ['tag2'];
+ const excludeTags: string[] = [];
+ const result = isRequestTagsIncluded(requestTags, includeTags, excludeTags);
+ expect(result).toBe(false);
+ });
+
+ it('should exclude request when it has an excluded tag', () => {
+ const requestTags = ['tag1'];
+ const includeTags: string[] = [];
+ const excludeTags = ['tag1'];
+ const result = isRequestTagsIncluded(requestTags, includeTags, excludeTags);
+ expect(result).toBe(false);
+ });
+
+ it('should exclude request when it has both included and excluded tag', () => {
+ const requestTags = ['tag1', 'tag2'];
+ const includeTags: string[] = ['tag2'];
+ const excludeTags = ['tag1'];
+ const result = isRequestTagsIncluded(requestTags, includeTags, excludeTags);
+ expect(result).toBe(false);
+ });
+});
diff --git a/packages/bruno-common/src/tags/index.ts b/packages/bruno-common/src/tags/index.ts
new file mode 100644
index 000000000..a2adfe798
--- /dev/null
+++ b/packages/bruno-common/src/tags/index.ts
@@ -0,0 +1,13 @@
+/**
+ * A request should be included if it has at least one tag that is included and no tags that are excluded
+ * @param requestTags Tags of the request
+ * @param includeTags Tags to include
+ * @param excludeTags Tags to exclude
+ */
+export const isRequestTagsIncluded = (requestTags: string[], includeTags: string[], excludeTags: string[]) => {
+ const shouldInclude = includeTags.length === 0 || requestTags.some((tag) => includeTags.includes(tag));
+ const shouldExclude = excludeTags.length > 0 && requestTags.some((tag) => excludeTags.includes(tag));
+ return shouldInclude && !shouldExclude;
+};
+
+export default isRequestTagsIncluded;
diff --git a/packages/bruno-common/src/utils/faker-functions.spec.ts b/packages/bruno-common/src/utils/faker-functions.spec.ts
new file mode 100644
index 000000000..eb2e70793
--- /dev/null
+++ b/packages/bruno-common/src/utils/faker-functions.spec.ts
@@ -0,0 +1,157 @@
+import { mockDataFunctions } from "./faker-functions";
+
+describe("mockDataFunctions Regex Validation", () => {
+ beforeAll(() => {
+ jest.useFakeTimers();
+ jest.setSystemTime(new Date('2024-01-01T00:00:00.000Z'));
+ });
+
+ afterAll(() => {
+ jest.useRealTimers();
+ });
+
+ test("timestamp and isoTimestamp should return mocked time values", () => {
+ const expectedTimestamp = '1704067200';
+ const expectedIsoTimestamp = '2024-01-01T00:00:00.000Z';
+
+ expect(mockDataFunctions.timestamp()).toBe(expectedTimestamp);
+ expect(mockDataFunctions.isoTimestamp()).toBe(expectedIsoTimestamp);
+ });
+
+ test("all values should match their expected patterns", () => {
+ const patterns: Record = {
+ guid: /^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$/,
+ randomUUID: /^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$/,
+ randomNanoId: /^[\w-]{21,}$/,
+ randomAlphaNumeric: /^[\w]$/,
+ randomBoolean: /^(true|false)$/,
+ randomInt: /^(?:[0-9]{1,2}|[1-9][0-9]{2}|1000)$/,
+ randomColor: /^[\w\s]+$/,
+ randomHexColor: /^#[\da-f]{6}$/,
+ randomAbbreviation: /^\w{2,6}$/,
+ randomIP: /^([\da-f]{1,4}:){7}[\da-f]{1,4}$|^(\d{1,3}\.){3}\d{1,3}$/,
+ randomIPV4: /^(\d{1,3}\.){3}\d{1,3}$/,
+ randomIPV6: /^([\da-f]{1,4}:){7}[\da-f]{1,4}$/,
+ randomMACAddress: /^([\da-f]{2}:){5}[\da-f]{2}$/,
+ randomPassword: /^[\w\d]{8,}$/,
+ randomLocale: /^[A-Z]{2}$/,
+ randomUserAgent: /^[\w\/\.\s\(\)\+\-;:_,]+$/,
+ randomProtocol: /^(http|https|ftp)s?$/,
+ randomSemver: /^\d+\.\d+\.\d+$/,
+ randomFirstName: /^[\s\S]+$/,
+ randomLastName: /^[\s\S]+$/,
+ randomFullName: /^[\s\S]+$/,
+ randomNamePrefix: /^[\s\S]+$/,
+ randomNameSuffix: /^[\s\S]+$/,
+ randomJobArea: /^[\s\S]+$/,
+ randomJobDescriptor: /^[\s\S]+$/,
+ randomJobTitle: /^[\s\S]+$/,
+ randomJobType: /^[\s\S]+$/,
+ randomPhoneNumber: /^[\s\S]+$/,
+ randomPhoneNumberExt: /^[\s\S]+$/,
+ randomCity: /^[\s\S]+$/,
+ randomStreetName: /^[\s\S]+$/,
+ randomStreetAddress: /^[\s\S]+$/,
+ randomCountry: /^[\s\S]+$/,
+ randomCountryCode: /^[\s\S]+$/,
+ randomLatitude: /^[\s\S]+$/,
+ randomLongitude: /^[\s\S]+$/,
+ randomAvatarImage: /^[\s\S]+$/,
+ randomImageUrl: /^[\s\S]+$/,
+ randomAbstractImage: /^[\s\S]+$/,
+ randomAnimalsImage: /^[\s\S]+$/,
+ randomBusinessImage: /^[\s\S]+$/,
+ randomCatsImage: /^[\s\S]+$/,
+ randomCityImage: /^[\s\S]+$/,
+ randomFoodImage: /^[\s\S]+$/,
+ randomNightlifeImage: /^[\s\S]+$/,
+ randomFashionImage: /^[\s\S]+$/,
+ randomPeopleImage: /^[\s\S]+$/,
+ randomNatureImage: /^[\s\S]+$/,
+ randomSportsImage: /^[\s\S]+$/,
+ randomTransportImage: /^[\s\S]+$/,
+ randomImageDataUri: /^[\s\S]+$/,
+ randomBankAccount: /^[\s\S]+$/,
+ randomBankAccountName: /^[\s\S]+$/,
+ randomCreditCardMask: /^[\s\S]+$/,
+ randomBankAccountBic: /^[\s\S]+$/,
+ randomBankAccountIban: /^[\s\S]+$/,
+ randomTransactionType: /^[\s\S]+$/,
+ randomCurrencyCode: /^[\s\S]+$/,
+ randomCurrencyName: /^[\s\S]+$/,
+ randomCurrencySymbol: /^[\s\S]+$/,
+ randomBitcoin: /^[\s\S]+$/,
+ randomCompanyName: /^[\s\S]+$/,
+ randomCompanySuffix: /^[\s\S]+$/,
+ randomBs: /^[\s\S]+$/,
+ randomBsAdjective: /^[\s\S]+$/,
+ randomBsBuzz: /^[\s\S]+$/,
+ randomBsNoun: /^[\s\S]+$/,
+ randomCatchPhrase: /^[\s\S]+$/,
+ randomCatchPhraseAdjective: /^[\s\S]+$/,
+ randomCatchPhraseDescriptor: /^[\s\S]+$/,
+ randomCatchPhraseNoun: /^[\s\S]+$/,
+ randomDatabaseColumn: /^[\s\S]+$/,
+ randomDatabaseType: /^[\s\S]+$/,
+ randomDatabaseCollation: /^[\s\S]+$/,
+ randomDatabaseEngine: /^[\s\S]+$/,
+ randomDateFuture: /^[\s\S]+$/,
+ randomDatePast: /^[\s\S]+$/,
+ randomDateRecent: /^[\s\S]+$/,
+ randomWeekday: /^[\s\S]+$/,
+ randomMonth: /^[\s\S]+$/,
+ randomDomainName: /^[\s\S]+$/,
+ randomDomainSuffix: /^[\s\S]+$/,
+ randomDomainWord: /^[\s\S]+$/,
+ randomEmail: /^[\w_.\-]+@[\w]+\.[a-z]+$/,
+ randomExampleEmail: /^[\w\.-]+@example\.[a-z]+$/,
+ randomUserName: /^[\w.\-]+$/,
+ randomUrl: /^https:\/\/[\w\-]+\.[a-z]+\/?$/,
+ randomFileName: /^[\w\_]+\.[\w\d]+$/,
+ randomFileType: /^[\w]+$/,
+ randomFileExt: /^[\w\d]+$/,
+ randomCommonFileName: /^[\w\_]+\.[\w\d]+$/,
+ randomCommonFileType: /^[\w]+$/,
+ randomCommonFileExt: /^[\w\d]+$/,
+ randomFilePath: /^[\s\S]+$/,
+ randomDirectoryPath: /^\/[-\w\+\/]+$/,
+ randomMimeType: /^[\w]+\/[\w\d\-\+\.]+$/,
+ randomPrice: /^\d+\.\d{2}$/,
+ randomProduct: /^[\s\S]+$/,
+ randomProductAdjective: /^[\s\S]+$/,
+ randomProductMaterial: /^[\s\S]+$/,
+ randomProductName: /^[\s\S]+$/,
+ randomDepartment: /^[\s\S]+$/,
+ randomNoun: /^[\s\S]+$/,
+ randomVerb: /^[\s\S]+$/,
+ randomIngverb: /^[\s\S]+$/,
+ randomAdjective: /^[\s\S]+$/,
+ randomWord: /^[\s\S]+$/,
+ randomWords: /^[\s\S]+$/,
+ randomPhrase: /^[\s\S]+$/,
+ randomLoremWord: /^[\s\S]+$/,
+ randomLoremWords: /^[\s\S]+$/,
+ randomLoremSentence: /^[\s\S]+$/,
+ randomLoremSentences: /^[\s\S]+$/,
+ randomLoremParagraph: /^[\s\S]+$/,
+ randomLoremParagraphs: /^[\s\S]+$/,
+ randomLoremText: /^[\s\S]+$/,
+ randomLoremSlug: /^[\s\S]+$/,
+ randomLoremLines: /^[\s\S]+$/,
+ };
+
+ const errors: string[] = [];
+
+ Object.entries(mockDataFunctions).forEach(([key, func]) => {
+ const pattern = patterns[key];
+ const value = String(func());
+ if (!value.match(pattern)) {
+ errors.push(`Pattern mismatch for ${key}: expected ${pattern}, received ${value}`);
+ }
+ });
+
+ if (errors.length > 0) {
+ throw new Error(errors.join("\n"));
+ }
+ });
+});
diff --git a/packages/bruno-common/src/utils/faker-functions.ts b/packages/bruno-common/src/utils/faker-functions.ts
new file mode 100644
index 000000000..a86a8bb89
--- /dev/null
+++ b/packages/bruno-common/src/utils/faker-functions.ts
@@ -0,0 +1,124 @@
+import { faker } from '@faker-js/faker';
+
+export const mockDataFunctions = {
+ guid: () => faker.string.uuid(),
+ timestamp: () => Math.floor(Date.now() / 1000).toString(),
+ isoTimestamp: () => new Date().toISOString(),
+ randomUUID: () => faker.string.uuid(),
+ randomNanoId: () => faker.string.nanoid(),
+ randomAlphaNumeric: () => faker.string.alphanumeric(),
+ randomBoolean: () => faker.datatype.boolean(),
+ randomInt: () => faker.number.int(1000),
+ randomColor: () => faker.color.human(),
+ randomHexColor: () => faker.color.rgb(),
+ randomAbbreviation: () => faker.hacker.abbreviation(),
+ randomIP: () => faker.internet.ip(),
+ randomIPV4: () => faker.internet.ipv4(),
+ randomIPV6: () => faker.internet.ipv6(),
+ randomMACAddress: () => faker.internet.mac(),
+ randomPassword: () => faker.internet.password(),
+ randomLocale: () => faker.location.countryCode(),
+ randomUserAgent: () => faker.internet.userAgent(),
+ randomProtocol: () => faker.internet.protocol(),
+ randomSemver: () => faker.system.semver(),
+ randomFirstName: () => faker.person.firstName(),
+ randomLastName: () => faker.person.lastName(),
+ randomFullName: () => faker.person.fullName(),
+ randomNamePrefix: () => faker.person.prefix(),
+ randomNameSuffix: () => faker.person.suffix(),
+ randomJobArea: () => faker.person.jobArea(),
+ randomJobDescriptor: () => faker.person.jobDescriptor(),
+ randomJobTitle: () => faker.person.jobTitle(),
+ randomJobType: () => faker.person.jobType(),
+ randomPhoneNumber: () => faker.phone.number(),
+ randomPhoneNumberExt: () => faker.phone.number(),
+ randomCity: () => faker.location.city(),
+ randomStreetName: () => faker.location.street(),
+ randomStreetAddress: () => faker.location.streetAddress(),
+ randomCountry: () => faker.location.country(),
+ randomCountryCode: () => faker.location.countryCode(),
+ randomLatitude: () => faker.location.latitude(),
+ randomLongitude: () => faker.location.longitude(),
+ randomAvatarImage: () => faker.image.avatar(),
+ randomImageUrl: () => faker.image.url(),
+ randomAbstractImage: () => faker.image.urlLoremFlickr({ category: 'abstract' }),
+ randomAnimalsImage: () => faker.image.urlLoremFlickr({ category: 'animals' }),
+ randomBusinessImage: () => faker.image.urlLoremFlickr({ category: 'business' }),
+ randomCatsImage: () => faker.image.urlLoremFlickr({ category: 'cats' }),
+ randomCityImage: () => faker.image.urlLoremFlickr({ category: 'city' }),
+ randomFoodImage: () => faker.image.urlLoremFlickr({ category: 'food' }),
+ randomNightlifeImage: () => faker.image.urlLoremFlickr({ category: 'nightlife' }),
+ randomFashionImage: () => faker.image.urlLoremFlickr({ category: 'fashion' }),
+ randomPeopleImage: () => faker.image.urlLoremFlickr({ category: 'people' }),
+ randomNatureImage: () => faker.image.urlLoremFlickr({ category: 'nature' }),
+ randomSportsImage: () => faker.image.urlLoremFlickr({ category: 'sports' }),
+ randomTransportImage: () => faker.image.urlLoremFlickr({ category: 'transport' }),
+ randomImageDataUri: () => faker.image.dataUri(),
+ randomBankAccount: () => faker.finance.accountNumber(),
+ randomBankAccountName: () => faker.finance.accountName(),
+ randomCreditCardMask: () => faker.finance.iban().replace(/(?<=.{4})\w(?=.{2})/g, '*'),
+ randomBankAccountBic: () => faker.finance.bic(),
+ randomBankAccountIban: () => faker.finance.iban(),
+ randomTransactionType: () => faker.finance.transactionType(),
+ randomCurrencyCode: () => faker.finance.currencyCode(),
+ randomCurrencyName: () => faker.finance.currencyName(),
+ randomCurrencySymbol: () => faker.finance.currencySymbol(),
+ randomBitcoin: () => faker.finance.bitcoinAddress(),
+ randomCompanyName: () => faker.company.name(),
+ randomCompanySuffix: () => faker.company.name(),
+ randomBs: () => faker.company.buzzPhrase(),
+ randomBsAdjective: () => faker.company.buzzAdjective(),
+ randomBsBuzz: () => faker.company.buzzVerb(),
+ randomBsNoun: () => faker.company.buzzNoun(),
+ randomCatchPhrase: () => faker.company.catchPhrase(),
+ randomCatchPhraseAdjective: () => faker.company.catchPhraseAdjective(),
+ randomCatchPhraseDescriptor: () => faker.company.catchPhraseDescriptor(),
+ randomCatchPhraseNoun: () => faker.company.catchPhraseNoun(),
+ randomDatabaseColumn: () => faker.database.column(),
+ randomDatabaseType: () => faker.database.type(),
+ randomDatabaseCollation: () => faker.database.collation(),
+ randomDatabaseEngine: () => faker.database.engine(),
+ randomDateFuture: () => faker.date.future().toISOString(),
+ randomDatePast: () => faker.date.past().toISOString(),
+ randomDateRecent: () => faker.date.recent().toISOString(),
+ randomWeekday: () => faker.date.weekday(),
+ randomMonth: () => faker.date.month(),
+ randomDomainName: () => faker.internet.domainName(),
+ randomDomainSuffix: () => faker.internet.domainSuffix(),
+ randomDomainWord: () => faker.internet.domainWord(),
+ randomEmail: () => faker.internet.email(),
+ randomExampleEmail: () => faker.internet.exampleEmail(),
+ randomUserName: () => faker.internet.username(),
+ randomUrl: () => faker.internet.url(),
+ randomFileName: () => faker.system.fileName(),
+ randomFileType: () => faker.system.fileType(),
+ randomFileExt: () => faker.system.fileExt(),
+ randomCommonFileName: () => faker.system.commonFileName(),
+ randomCommonFileType: () => faker.system.commonFileType(),
+ randomCommonFileExt: () => faker.system.commonFileExt(),
+ randomFilePath: () => faker.system.filePath(),
+ randomDirectoryPath: () => faker.system.directoryPath(),
+ randomMimeType: () => faker.system.mimeType(),
+ randomPrice: () => faker.commerce.price(),
+ randomProduct: () => faker.commerce.product(),
+ randomProductAdjective: () => faker.commerce.productAdjective(),
+ randomProductMaterial: () => faker.commerce.productMaterial(),
+ randomProductName: () => faker.commerce.productName(),
+ randomDepartment: () => faker.commerce.department(),
+ randomNoun: () => faker.hacker.noun(),
+ randomVerb: () => faker.hacker.verb(),
+ randomIngverb: () => faker.hacker.ingverb(),
+ randomAdjective: () => faker.hacker.adjective(),
+ randomWord: () => faker.hacker.noun(),
+ randomWords: () => faker.lorem.words(),
+ randomPhrase: () => faker.hacker.phrase(),
+ randomLoremWord: () => faker.lorem.word(),
+ randomLoremWords: () => faker.lorem.words(),
+ randomLoremSentence: () => faker.lorem.sentence(),
+ randomLoremSentences: () => faker.lorem.sentences(),
+ randomLoremParagraph: () => faker.lorem.paragraph(),
+ randomLoremParagraphs: () => faker.lorem.paragraphs(),
+ randomLoremText: () => faker.lorem.text(),
+ randomLoremSlug: () => faker.lorem.slug(),
+ randomLoremLines: () => faker.lorem.lines()
+};
diff --git a/packages/bruno-common/src/utils/index.spec.ts b/packages/bruno-common/src/utils/index.spec.ts
deleted file mode 100644
index 09689ac65..000000000
--- a/packages/bruno-common/src/utils/index.spec.ts
+++ /dev/null
@@ -1,51 +0,0 @@
-import { flattenObject } from './index';
-
-describe('flattenObject', () => {
- it('should flatten a simple object', () => {
- const input = { a: 1, b: { c: 2, d: { e: 3 } } };
- const output = flattenObject(input);
- expect(output).toEqual({ a: 1, 'b.c': 2, 'b.d.e': 3 });
- });
-
- it('should flatten an object with arrays', () => {
- const input = { a: 1, b: { c: [2, 3, 4], d: { e: 5 } } };
- const output = flattenObject(input);
- expect(output).toEqual({ a: 1, 'b.c[0]': 2, 'b.c[1]': 3, 'b.c[2]': 4, 'b.d.e': 5 });
- });
-
- it('should flatten an object with arrays having objects', () => {
- const input = { a: 1, b: { c: [{ d: 2 }, { e: 3 }], f: { g: 4 } } };
- const output = flattenObject(input);
- expect(output).toEqual({ a: 1, 'b.c[0].d': 2, 'b.c[1].e': 3, 'b.f.g': 4 });
- });
-
- it('should handle null values', () => {
- const input = { a: 1, b: { c: null, d: { e: 3 } } };
- const output = flattenObject(input);
- expect(output).toEqual({ a: 1, 'b.c': null, 'b.d.e': 3 });
- });
-
- it('should handle an empty object', () => {
- const input = {};
- const output = flattenObject(input);
- expect(output).toEqual({});
- });
-
- it('should handle an object with nested empty objects', () => {
- const input = { a: { b: {}, c: { d: {} } } };
- const output = flattenObject(input);
- expect(output).toEqual({});
- });
-
- it('should handle an object with duplicate keys - dot notation used to define the last duplicate key', () => {
- const input = { a: { b: 2 }, 'a.b': 1 };
- const output = flattenObject(input);
- expect(output).toEqual({ 'a.b': 1 });
- });
-
- it('should handle an object with duplicate keys - inner object used to define the last duplicate key', () => {
- const input = { 'a.b': 1, a: { b: 2 } };
- const output = flattenObject(input);
- expect(output).toEqual({ 'a.b': 2 });
- });
-});
diff --git a/packages/bruno-common/src/utils/index.ts b/packages/bruno-common/src/utils/index.ts
index bba8f1310..eee1e5d9b 100644
--- a/packages/bruno-common/src/utils/index.ts
+++ b/packages/bruno-common/src/utils/index.ts
@@ -1,11 +1,5 @@
-export const flattenObject = (obj: Record, parentKey: string = ''): Record => {
- return Object.entries(obj).reduce((acc: Record, [key, value]: [string, any]) => {
- const newKey = parentKey ? (Array.isArray(obj) ? `${parentKey}[${key}]` : `${parentKey}.${key}`) : key;
- if (typeof value === 'object' && value !== null) {
- Object.assign(acc, flattenObject(value, newKey));
- } else {
- acc[newKey] = value;
- }
- return acc;
- }, {});
-};
+export {
+ encodeUrl,
+ parseQueryParams,
+ buildQueryString,
+} from './url';
\ No newline at end of file
diff --git a/packages/bruno-common/src/utils/url/index.spec.ts b/packages/bruno-common/src/utils/url/index.spec.ts
new file mode 100644
index 000000000..e9815e306
--- /dev/null
+++ b/packages/bruno-common/src/utils/url/index.spec.ts
@@ -0,0 +1,221 @@
+import { encodeUrl, parseQueryParams, buildQueryString } from './index';
+
+describe('encodeUrl', () => {
+ describe('basic functionality', () => {
+ it('should return the original URL when query string is empty', () => {
+ const url = 'https://example.com/path?';
+ expect(encodeUrl(url)).toBe(url);
+ });
+
+ it('should preserve URLs without query parameters', () => {
+ const url = 'https://api.example.com/v1/users';
+ expect(encodeUrl(url)).toBe(url);
+ });
+ });
+
+ describe('query parameter encoding', () => {
+ it('should handle a single query parameter', () => {
+ const url = 'https://example.com/api?name=john';
+ const expected = 'https://example.com/api?name=john';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should handle simple query parameters', () => {
+ const url = 'https://example.com/api?name=john&age=25';
+ const expected = 'https://example.com/api?name=john&age=25';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should encode query parameters with special characters', () => {
+ const url = 'https://example.com/api?name=john doe&email=john@example.com';
+ const expected = 'https://example.com/api?name=john%20doe&email=john%40example.com';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should encode query parameters with special URL characters', () => {
+ const url = 'https://example.com/api?path=/users/123&redirect=https://other.com';
+ const expected = 'https://example.com/api?path=%2Fusers%2F123&redirect=https%3A%2F%2Fother.com';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should encode query parameters with unicode characters', () => {
+ const url = 'https://example.com/api?name=José&city=München';
+ const expected = 'https://example.com/api?name=Jos%C3%A9&city=M%C3%BCnchen';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should handle query parameters with empty values', () => {
+ const url = 'https://example.com/api?name=&age=25&active=';
+ const expected = 'https://example.com/api?name&age=25&active';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should encode query parameters with pipe operator', () => {
+ const url = 'https://example.com/api?filter=status|active&sort=name|asc&tags=frontend|backend|api';
+ const expected = 'https://example.com/api?filter=status%7Cactive&sort=name%7Casc&tags=frontend%7Cbackend%7Capi';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should encode query parameters with pipe operator and spaces', () => {
+ const url = 'https://example.com/api?categories=web development|mobile apps|data science&status=in progress|completed';
+ const expected = 'https://example.com/api?categories=web%20development%7Cmobile%20apps%7Cdata%20science&status=in%20progress%7Ccompleted';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+ });
+
+ describe('hash fragment handling', () => {
+ it('should preserve hash fragments with encoded query parameters', () => {
+ const url = 'https://example.com/api?name=john doe#section1';
+ const expected = 'https://example.com/api?name=john%20doe#section1';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should preserve hash fragments with pipe operator in query', () => {
+ const url = 'https://example.com/api?filter=status|active#results';
+ const expected = 'https://example.com/api?filter=status%7Cactive#results';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+ });
+
+ describe('edge cases', () => {
+ it('should handle invalid input gracefully', () => {
+ expect(encodeUrl('')).toBe('');
+ expect(encodeUrl(null as any)).toBe(null);
+ expect(encodeUrl(undefined as any)).toBe(undefined);
+ expect(encodeUrl(123 as any)).toBe(123);
+ });
+
+ it('should handle URLs with multiple question marks', () => {
+ const url = 'https://example.com/api?name=john?age=25';
+ const expected = 'https://example.com/api?name=john%3Fage%3D25';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should handle complex query parameters with multiple special characters', () => {
+ const url = 'https://example.com/api?search=hello world!@#$%^&*()&filter=active&sort=name asc';
+ const expected = 'https://example.com/api?search=hello%20world!%40#$%^&*()&filter=active&sort=name asc';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should handle already encoded URLs', () => {
+ const url = 'https://example.com/api?name=john%20doe&email=john%40example.com';
+ const expected = 'https://example.com/api?name=john%2520doe&email=john%2540example.com';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should handle pipe operator in already encoded URLs', () => {
+ const url = 'https://example.com/api?filter=status%7Cactive&sort=name%7Casc';
+ const expected = 'https://example.com/api?filter=status%257Cactive&sort=name%257Casc';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+ });
+
+ describe('real-world scenarios', () => {
+ it('should handle API URLs with complex query parameters', () => {
+ const url = 'https://api.github.com/search/repositories?q=language:javascript&sort=stars&order=desc&per_page=10';
+ const expected = 'https://api.github.com/search/repositories?q=language%3Ajavascript&sort=stars&order=desc&per_page=10';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should handle OAuth callback URLs', () => {
+ const url = 'https://myapp.com/callback?code=abc123&state=xyz789&redirect_uri=https://myapp.com/dashboard';
+ const expected = 'https://myapp.com/callback?code=abc123&state=xyz789&redirect_uri=https%3A%2F%2Fmyapp.com%2Fdashboard';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should handle GraphQL queries with pipe operator', () => {
+ const url = 'https://api.example.com/graphql?query=query{users(status:active|pending){id,name}}&variables={"filter":"status|active"}';
+ const expected = 'https://api.example.com/graphql?query=query%7Busers(status%3Aactive%7Cpending)%7Bid%2Cname%7D%7D&variables=%7B%22filter%22%3A%22status%7Cactive%22%7D';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should handle search APIs with complex queries', () => {
+ const url = 'https://api.example.com/search?q=react typescript tutorial&type=article,code&language=en&date_range=2023-01-01:2023-12-31&sort=relevance:desc';
+ const expected = 'https://api.example.com/search?q=react%20typescript%20tutorial&type=article%2Ccode&language=en&date_range=2023-01-01%3A2023-12-31&sort=relevance%3Adesc';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+
+ it('should handle e-commerce API filters', () => {
+ const url = 'https://api.shop.com/products?category=electronics&brand=apple|samsung|google&price_range=100:1000&rating=4.5:5.0&availability=in_stock&sort=price:asc&limit=50';
+ const expected = 'https://api.shop.com/products?category=electronics&brand=apple%7Csamsung%7Cgoogle&price_range=100%3A1000&rating=4.5%3A5.0&availability=in_stock&sort=price%3Aasc&limit=50';
+ expect(encodeUrl(url)).toBe(expected);
+ });
+ });
+});
+
+describe('parseQueryParams', () => {
+ it('should extract query parameters correctly', () => {
+ const queryString = 'name=john&age=25&active=true';
+ const result = parseQueryParams(queryString);
+ expect(result).toEqual([
+ { name: 'name', value: 'john' },
+ { name: 'age', value: '25' },
+ { name: 'active', value: 'true' }
+ ]);
+ });
+
+ it('should handle empty query string', () => {
+ const result = parseQueryParams('');
+ expect(result).toEqual([]);
+ });
+
+ it('should handle query parameters with empty values', () => {
+ const queryString = 'name=&age=25&active=';
+ const result = parseQueryParams(queryString);
+ expect(result).toEqual([
+ { name: 'name', value: '' },
+ { name: 'age', value: '25' },
+ { name: 'active', value: '' }
+ ]);
+ });
+
+ it('should extract query parameters with pipe operator', () => {
+ const queryString = 'filter=status|active&sort=name|asc&tags=frontend|backend';
+ const result = parseQueryParams(queryString);
+ expect(result).toEqual([
+ { name: 'filter', value: 'status|active' },
+ { name: 'sort', value: 'name|asc' },
+ { name: 'tags', value: 'frontend|backend' }
+ ]);
+ });
+});
+
+describe('buildQueryString', () => {
+ it('should build query string correctly', () => {
+ const params = [
+ { name: 'name', value: 'john' },
+ { name: 'age', value: '25' },
+ { name: 'active', value: 'true' }
+ ];
+ const result = buildQueryString(params);
+ expect(result).toBe('name=john&age=25&active=true');
+ });
+
+ it('should encode parameters by default', () => {
+ const params = [
+ { name: 'name', value: 'john doe' },
+ { name: 'email', value: 'john@example.com' }
+ ];
+ const result = buildQueryString(params, { encode: true });
+ expect(result).toBe('name=john%20doe&email=john%40example.com');
+ });
+
+ it('should encode pipe operator in parameters', () => {
+ const params = [
+ { name: 'filter', value: 'status|active' },
+ { name: 'sort', value: 'name|asc' },
+ { name: 'tags', value: 'frontend|backend|api' }
+ ];
+ const result = buildQueryString(params, { encode: true });
+ expect(result).toBe('filter=status%7Cactive&sort=name%7Casc&tags=frontend%7Cbackend%7Capi');
+ });
+
+ it('should not encode parameters when encode is false', () => {
+ const params = [
+ { name: 'filter', value: 'status|active' },
+ { name: 'sort', value: 'name|asc' }
+ ];
+ const result = buildQueryString(params, { encode: false });
+ expect(result).toBe('filter=status|active&sort=name|asc');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-common/src/utils/url/index.ts b/packages/bruno-common/src/utils/url/index.ts
new file mode 100644
index 000000000..7b3debebb
--- /dev/null
+++ b/packages/bruno-common/src/utils/url/index.ts
@@ -0,0 +1,86 @@
+interface QueryParam {
+ name: string;
+ value?: string;
+}
+
+interface BuildQueryStringOptions {
+ encode?: boolean;
+}
+
+interface ExtractQueryParamsOptions {
+ decode?: boolean;
+}
+
+function buildQueryString(paramsArray: QueryParam[], { encode = false }: BuildQueryStringOptions = {}): string {
+ return paramsArray
+ .filter(({ name }) => typeof name === 'string' && name.trim().length > 0)
+ .map(({ name, value }) => {
+ const finalName = encode ? encodeURIComponent(name) : name;
+ const finalValue = encode ? encodeURIComponent(value ?? '') : (value ?? '');
+
+ return finalValue ? `${finalName}=${finalValue}` : finalName;
+ })
+ .join('&');
+}
+
+function parseQueryParams(query: string, { decode = false }: ExtractQueryParamsOptions = {}): QueryParam[] {
+ if (!query || !query.length) {
+ return [];
+ }
+
+ try {
+ const [queryString, ...hashParts] = query.split('#');
+ const pairs = queryString.split('&');
+
+ const params = pairs.map(pair => {
+ const [name, ...valueParts] = pair.split('=');
+
+ if (!name) {
+ return null;
+ }
+
+ return {
+ name: decode ? decodeURIComponent(name) : name,
+ value: decode ? decodeURIComponent(valueParts.join('=')) : valueParts.join('=')
+ };
+ }).filter((param): param is NonNullable => param !== null);
+
+ return params;
+ } catch (error) {
+ console.error('Error parsing query params:', error);
+ return [];
+ }
+}
+
+const encodeUrl = (url: string): string => {
+ // Early return for invalid input
+ if (!url || typeof url !== 'string') {
+ return url;
+ }
+
+ const [urlWithoutHash, ...hashFragments] = url.split('#');
+ const [basePath, ...queryString] = urlWithoutHash.split('?');
+
+ // If no query parameters exist, return original URL
+ if (!queryString || queryString.length === 0) {
+ return url;
+ }
+
+ const queryParams = parseQueryParams(queryString.join('?'), { decode: false });
+ // Parse and re-encode query parameters
+ const encodedQueryString = buildQueryString(queryParams, { encode: true });
+
+ // Reconstruct URL with encoded query parameters
+ const encodedUrl = `${basePath}?${encodedQueryString}${hashFragments.length > 0 ? `#${hashFragments.join('#')}` : ''}`;
+
+ return encodedUrl;
+};
+
+export {
+ encodeUrl,
+ parseQueryParams,
+ buildQueryString,
+ type QueryParam,
+ type BuildQueryStringOptions,
+ type ExtractQueryParamsOptions
+};
\ No newline at end of file
diff --git a/packages/bruno-common/tsconfig.json b/packages/bruno-common/tsconfig.json
index 57a8bcc74..9978d57dc 100644
--- a/packages/bruno-common/tsconfig.json
+++ b/packages/bruno-common/tsconfig.json
@@ -6,14 +6,14 @@
"skipLibCheck": true,
"jsx": "react",
"module": "ESNext",
- "declaration": true,
- "declarationDir": "types",
"sourceMap": true,
"outDir": "dist",
"moduleResolution": "node",
- "emitDeclarationOnly": true,
"allowSyntheticDefaultImports": true,
- "forceConsistentCasingInFileNames": true
+ "forceConsistentCasingInFileNames": true,
+ "allowJs": true,
+ "checkJs": false
},
+ "include": ["src/**/*.ts", "src/**/*.js"],
"exclude": ["dist", "node_modules", "tests"]
}
diff --git a/packages/bruno-converters/.gitignore b/packages/bruno-converters/.gitignore
new file mode 100644
index 000000000..f6eabff32
--- /dev/null
+++ b/packages/bruno-converters/.gitignore
@@ -0,0 +1,22 @@
+# dependencies
+node_modules
+yarn.lock
+pnpm-lock.yaml
+package-lock.json
+.pnp
+.pnp.js
+
+# testing
+coverage
+
+# production
+dist
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/packages/bruno-converters/babel.config.js b/packages/bruno-converters/babel.config.js
new file mode 100644
index 000000000..c74fb53e2
--- /dev/null
+++ b/packages/bruno-converters/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+ presets: [['@babel/preset-env', { targets: { node: 'current' } }]],
+};
diff --git a/packages/bruno-converters/jest.config.js b/packages/bruno-converters/jest.config.js
new file mode 100644
index 000000000..fa59852bc
--- /dev/null
+++ b/packages/bruno-converters/jest.config.js
@@ -0,0 +1,13 @@
+module.exports = {
+ transform: {
+ '^.+\\.js$': 'babel-jest',
+ },
+ setupFiles: ['/jest.setup.js'],
+ transformIgnorePatterns: [
+ 'node_modules/(?!(nanoid)/)'
+ ],
+ testEnvironment: 'node',
+ moduleNameMapper: {
+ '^nanoid(/(.*)|$)': 'nanoid$1'
+ }
+};
diff --git a/packages/bruno-converters/jest.setup.js b/packages/bruno-converters/jest.setup.js
new file mode 100644
index 000000000..a2246e495
--- /dev/null
+++ b/packages/bruno-converters/jest.setup.js
@@ -0,0 +1,11 @@
+// Mock the uuid function
+jest.mock('./src/common', () => {
+ // Import the original module to keep other functions intact
+ const originalModule = jest.requireActual('./src/common');
+
+ return {
+ __esModule: true, // Use this property to indicate it's an ES module
+ ...originalModule,
+ uuid: jest.fn(() => 'mockeduuidvalue123456'), // Mock uuid to return a fixed value
+ };
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/license.md b/packages/bruno-converters/license.md
new file mode 100644
index 000000000..3628f730f
--- /dev/null
+++ b/packages/bruno-converters/license.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Anoop M D, Anusree P S and Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/bruno-converters/package.json b/packages/bruno-converters/package.json
new file mode 100644
index 000000000..2a2450ef0
--- /dev/null
+++ b/packages/bruno-converters/package.json
@@ -0,0 +1,47 @@
+{
+ "name": "@usebruno/converters",
+ "version": "0.1.0",
+ "license": "MIT",
+ "main": "dist/cjs/index.js",
+ "module": "dist/esm/index.js",
+ "types": "dist/index.d.ts",
+ "files": [
+ "dist",
+ "src",
+ "package.json"
+ ],
+ "scripts": {
+ "clean": "rimraf dist",
+ "test": "node --experimental-vm-modules $(npx which jest) --colors --collectCoverage",
+ "prebuild": "npm run clean",
+ "build": "rollup -c",
+ "watch": "rollup -c -w",
+ "prepack": "npm run test && npm run build"
+ },
+ "dependencies": {
+ "@usebruno/schema": "^0.7.0",
+ "js-yaml": "^4.1.0",
+ "jscodeshift": "^17.3.0",
+ "lodash": "^4.17.21",
+ "nanoid": "3.3.8"
+ },
+ "devDependencies": {
+ "@babel/core": "^7.25.2",
+ "@babel/preset-env": "^7.25.4",
+ "@rollup/plugin-alias": "^5.1.0",
+ "@rollup/plugin-commonjs": "^23.0.2",
+ "@rollup/plugin-node-resolve": "^15.0.1",
+ "@rollup/plugin-typescript": "^9.0.2",
+ "@web/rollup-plugin-copy": "^0.5.1",
+ "babel-jest": "^29.7.0",
+ "rimraf": "^5.0.7",
+ "rollup": "3.29.5",
+ "rollup-plugin-dts": "^5.0.0",
+ "rollup-plugin-peer-deps-external": "^2.2.4",
+ "rollup-plugin-terser": "^7.0.2",
+ "typescript": "^4.8.4"
+ },
+ "overrides": {
+ "rollup": "3.29.5"
+ }
+}
diff --git a/packages/bruno-converters/readme.md b/packages/bruno-converters/readme.md
new file mode 100644
index 000000000..8f8df3f44
--- /dev/null
+++ b/packages/bruno-converters/readme.md
@@ -0,0 +1,78 @@
+# bruno-converters
+
+The converters package is responsible for converting collections from one format to a Bruno collection.
+It can be used as a standalone package or as a part of the Bruno framework.
+
+## Installation
+
+```bash
+npm install @usebruno/converters
+```
+
+## Usage
+
+### Convert Postman collection to Bruno collection
+
+```javascript
+const { postmanToBruno } = require('@usebruno/converters');
+
+// Convert Postman collection to Bruno collection
+const brunoCollection = postmanToBruno(postmanCollection);
+```
+
+### Convert Postman Environment to Bruno Environment
+
+```javascript
+const { postmanToBrunoEnvironment } = require('@usebruno/converters');
+
+const brunoEnvironment = postmanToBrunoEnvironment(postmanEnvironment);
+```
+
+### Convert Insomnia collection to Bruno collection
+
+```javascript
+const { insomniaToBruno } = require('@usebruno/converters');
+
+const brunoCollection = insomniaToBruno(insomniaCollection);
+```
+
+### Convert OpenAPI specification to Bruno collection
+
+```javascript
+const { openApiToBruno } = require('@usebruno/converters');
+
+const brunoCollection = openApiToBruno(openApiSpecification);
+```
+
+## Example
+
+```bash copy
+
+const { postmanToBruno } = require('@usebruno/converters');
+const fs = require('fs/promises');
+const path = require('path');
+
+async function convertPostmanToBruno(inputFile, outputFile) {
+ try {
+ // Read Postman collection file
+ const inputData = await fs.readFile(inputFile, 'utf8');
+
+ // Convert to Bruno collection
+ const brunoCollection = postmanToBruno(JSON.parse(inputData));
+
+ // Save Bruno collection
+ await fs.writeFile(outputFile, JSON.stringify(brunoCollection, null, 2));
+
+ console.log('Conversion successful!');
+ } catch (error) {
+ console.error('Error during conversion:', error);
+ }
+}
+
+// Usage
+const inputFilePath = path.resolve(__dirname, 'demo_collection.postman_collection.json');
+const outputFilePath = path.resolve(__dirname, 'bruno-collection.json');
+
+convertPostmanToBruno(inputFilePath, outputFilePath);
+
+```
diff --git a/packages/bruno-converters/rollup.config.js b/packages/bruno-converters/rollup.config.js
new file mode 100644
index 000000000..ec9a7a4c9
--- /dev/null
+++ b/packages/bruno-converters/rollup.config.js
@@ -0,0 +1,43 @@
+const { nodeResolve } = require('@rollup/plugin-node-resolve');
+const commonjs = require('@rollup/plugin-commonjs');
+const { terser } = require('rollup-plugin-terser');
+const peerDepsExternal = require('rollup-plugin-peer-deps-external');
+const { copy } = require('@web/rollup-plugin-copy');
+
+const packageJson = require('./package.json');
+const alias = require('@rollup/plugin-alias');
+const path = require('path');
+
+module.exports = [
+ {
+ input: 'src/index.js',
+ output: [
+ {
+ dir: path.dirname(packageJson.main),
+ format: 'cjs',
+ sourcemap: true
+ },
+ {
+ dir: path.dirname(packageJson.module),
+ format: 'esm',
+ sourcemap: true
+ }
+ ],
+ plugins: [
+ peerDepsExternal(),
+ nodeResolve({
+ preferBuiltins: true,
+ extensions: ['.js', '.css'] // Resolve .js files
+ }),
+ commonjs(),
+ terser(),
+ alias({
+ entries: [{ find: 'src', replacement: path.resolve(__dirname, 'src') }]
+ }),
+ copy({
+ patterns: 'src/workers/scripts/**/*',
+ rootDir: '.'
+ })
+ ]
+ }
+];
diff --git a/packages/bruno-converters/src/common/index.js b/packages/bruno-converters/src/common/index.js
new file mode 100644
index 000000000..8672ed548
--- /dev/null
+++ b/packages/bruno-converters/src/common/index.js
@@ -0,0 +1,212 @@
+import each from 'lodash/each';
+import get from 'lodash/get';
+import { customAlphabet } from 'nanoid';
+import cloneDeep from 'lodash/cloneDeep';
+import { collectionSchema } from '@usebruno/schema';
+
+export const safeParseJSON = (str) => {
+ if (!str || !str.length || typeof str !== 'string') {
+ return str;
+ }
+ try {
+ return JSON.parse(str);
+ } catch (e) {
+ return str;
+ }
+};
+
+export const safeStringifyJSON = (obj, indent = false) => {
+ if (obj === undefined) {
+ return obj;
+ }
+ try {
+ if (indent) {
+ return JSON.stringify(obj, null, 2);
+ }
+ return JSON.stringify(obj);
+ } catch (e) {
+ return obj;
+ }
+};
+
+export const isItemARequest = (item) => {
+ return item.hasOwnProperty('request') && ['http-request', 'graphql-request'].includes(item.type) && !item.items;
+};
+
+// a customized version of nanoid without using _ and -
+export const uuid = () => {
+ // https://github.com/ai/nanoid/blob/main/url-alphabet/index.js
+ const urlAlphabet = 'useandom26T198340PX75pxJACKVERYMINDBUSHWOLFGQZbfghjklqvwyzrict';
+ const customNanoId = customAlphabet(urlAlphabet, 21);
+
+ return customNanoId();
+};
+
+export const validateSchema = (collection = {}) => {
+ try {
+ collectionSchema.validateSync(collection);
+ return collection;
+ } catch (err) {
+ console.log("Error validating schema", err);
+ throw new Error('The Collection has an invalid schema');
+ }
+};
+
+export const updateUidsInCollection = (_collection) => {
+ const collection = cloneDeep(_collection);
+
+ collection.uid = uuid();
+
+ const updateItemUids = (items = []) => {
+ each(items, (item) => {
+ item.uid = uuid();
+
+ each(get(item, 'request.headers'), (header) => (header.uid = uuid()));
+ each(get(item, 'request.params'), (param) => (param.uid = uuid()));
+ each(get(item, 'request.vars.req'), (v) => (v.uid = uuid()));
+ each(get(item, 'request.vars.res'), (v) => (v.uid = uuid()));
+ each(get(item, 'request.assertions'), (a) => (a.uid = uuid()));
+ each(get(item, 'request.body.multipartForm'), (param) => (param.uid = uuid()));
+ each(get(item, 'request.body.formUrlEncoded'), (param) => (param.uid = uuid()));
+ each(get(item, 'request.body.file'), (param) => (param.uid = uuid()));
+
+ if (item.items && item.items.length) {
+ updateItemUids(item.items);
+ }
+ });
+ };
+ updateItemUids(collection.items);
+
+ const updateEnvUids = (envs = []) => {
+ each(envs, (env) => {
+ env.uid = uuid();
+ each(env.variables, (variable) => (variable.uid = uuid()));
+ });
+ };
+ updateEnvUids(collection.environments);
+
+ return collection;
+};
+
+// todo
+// need to eventually get rid of supporting old collection app models
+// 1. start with making request type a constant fetched from a single place
+// 2. move references of param and replace it with query inside the app
+export const transformItemsInCollection = (collection) => {
+ const transformItems = (items = []) => {
+ each(items, (item) => {
+
+ if (['http', 'graphql'].includes(item.type)) {
+ item.type = `${item.type}-request`;
+
+ if (item.request.query) {
+ item.request.params = item.request.query.map((queryItem) => ({
+ ...queryItem,
+ type: 'query',
+ uid: queryItem.uid || uuid()
+ }));
+ }
+
+ delete item.request.query;
+
+ // from 5 feb 2024, multipartFormData needs to have a type
+ // this was introduced when we added support for file uploads
+ // below logic is to make older collection exports backward compatible
+ let multipartFormData = get(item, 'request.body.multipartForm');
+ if (multipartFormData) {
+ each(multipartFormData, (form) => {
+ if (!form.type) {
+ form.type = 'text';
+ }
+ });
+ }
+ }
+
+ if (item.items && item.items.length) {
+ transformItems(item.items);
+ }
+ });
+ };
+
+ transformItems(collection.items);
+
+ return collection;
+};
+
+export const hydrateSeqInCollection = (collection) => {
+ const hydrateSeq = (items = []) => {
+ let index = 1;
+ each(items, (item) => {
+ if (isItemARequest(item) && !item.seq) {
+ item.seq = index;
+ index++;
+ }
+ if (item.items && item.items.length) {
+ hydrateSeq(item.items);
+ }
+ });
+ };
+ hydrateSeq(collection.items);
+
+ return collection;
+};
+
+export const deleteUidsInItems = (items) => {
+ each(items, (item) => {
+ delete item.uid;
+
+ if (['http-request', 'graphql-request', 'grpc-request'].includes(item.type)) {
+ each(get(item, 'request.headers'), (header) => delete header.uid);
+ each(get(item, 'request.params'), (param) => delete param.uid);
+ each(get(item, 'request.vars.req'), (v) => delete v.uid);
+ each(get(item, 'request.vars.res'), (v) => delete v.uid);
+ each(get(item, 'request.vars.assertions'), (a) => delete a.uid);
+ each(get(item, 'request.body.multipartForm'), (param) => delete param.uid);
+ each(get(item, 'request.body.formUrlEncoded'), (param) => delete param.uid);
+ each(get(item, 'request.body.file'), (param) => delete param.uid);
+ }
+
+ if (item.items && item.items.length) {
+ deleteUidsInItems(item.items);
+ }
+ });
+};
+
+/**
+ * Some of the models in the app are not consistent with the Collection Json format
+ * This function is used to transform the models to the Collection Json format
+ */
+export const transformItem = (items = []) => {
+ each(items, (item) => {
+ if (['http-request', 'graphql-request'].includes(item.type)) {
+ if (item.type === 'graphql-request') {
+ item.type = 'graphql';
+ }
+
+ if (item.type === 'http-request') {
+ item.type = 'http';
+ }
+ }
+
+ if (item.items && item.items.length) {
+ transformItem(item.items);
+ }
+ });
+};
+
+export const deleteUidsInEnvs = (envs) => {
+ each(envs, (env) => {
+ delete env.uid;
+ each(env.variables, (variable) => delete variable.uid);
+ });
+};
+
+export const deleteSecretsInEnvs = (envs) => {
+ each(envs, (env) => {
+ each(env.variables, (variable) => {
+ if (variable.secret) {
+ variable.value = '';
+ }
+ });
+ });
+};
\ No newline at end of file
diff --git a/packages/bruno-converters/src/constants/index.js b/packages/bruno-converters/src/constants/index.js
new file mode 100644
index 000000000..723a09fea
--- /dev/null
+++ b/packages/bruno-converters/src/constants/index.js
@@ -0,0 +1,3 @@
+import { invalidVariableCharacterRegex } from './regex';
+
+export { invalidVariableCharacterRegex };
diff --git a/packages/bruno-converters/src/constants/regex.js b/packages/bruno-converters/src/constants/regex.js
new file mode 100644
index 000000000..989dbc1c3
--- /dev/null
+++ b/packages/bruno-converters/src/constants/regex.js
@@ -0,0 +1 @@
+export const invalidVariableCharacterRegex = /[^\w-.]/g;
\ No newline at end of file
diff --git a/packages/bruno-converters/src/index.js b/packages/bruno-converters/src/index.js
new file mode 100644
index 000000000..d5b3d3a3b
--- /dev/null
+++ b/packages/bruno-converters/src/index.js
@@ -0,0 +1,6 @@
+export { default as postmanToBruno } from './postman/postman-to-bruno.js';
+export { default as postmanToBrunoEnvironment } from './postman/postman-env-to-bruno-env.js';
+export { default as brunoToPostman } from './postman/bruno-to-postman.js';
+export { default as openApiToBruno } from './openapi/openapi-to-bruno.js';
+export { default as insomniaToBruno } from './insomnia/insomnia-to-bruno.js';
+export { default as postmanTranslation } from './postman/postman-translations.js';
\ No newline at end of file
diff --git a/packages/bruno-converters/src/insomnia/insomnia-to-bruno.js b/packages/bruno-converters/src/insomnia/insomnia-to-bruno.js
new file mode 100644
index 000000000..4968870b0
--- /dev/null
+++ b/packages/bruno-converters/src/insomnia/insomnia-to-bruno.js
@@ -0,0 +1,319 @@
+import each from 'lodash/each';
+import get from 'lodash/get';
+import jsyaml from 'js-yaml';
+import { validateSchema, transformItemsInCollection, hydrateSeqInCollection, uuid } from '../common';
+
+const parseGraphQL = (text) => {
+ try {
+ const graphql = JSON.parse(text);
+
+ return {
+ query: graphql.query,
+ variables: JSON.stringify(graphql.variables, null, 2)
+ };
+ } catch (e) {
+ return {
+ query: '',
+ variables: ''
+ };
+ }
+};
+
+const addSuffixToDuplicateName = (item, index, allItems) => {
+ // Check if the request name already exist and if so add a number suffix
+ const nameSuffix = allItems.reduce((nameSuffix, otherItem, otherIndex) => {
+ if (otherItem.name === item.name && otherIndex < index) {
+ nameSuffix++;
+ }
+ return nameSuffix;
+ }, 0);
+ return nameSuffix !== 0 ? `${item.name}_${nameSuffix}` : item.name;
+};
+
+const regexVariable = new RegExp('{{.*?}}', 'g');
+
+const normalizeVariables = (value) => {
+ value = value || '';
+ const variables = value.match(regexVariable) || [];
+ each(variables, (variable) => {
+ value = value.replace(variable, variable.replace('_.', '').replaceAll(' ', ''));
+ });
+ return value;
+};
+
+const transformInsomniaRequestItem = (request, index, allRequests) => {
+ const name = addSuffixToDuplicateName(request, index, allRequests);
+
+ const brunoRequestItem = {
+ uid: uuid(),
+ name,
+ type: 'http-request',
+ request: {
+ url: request.url,
+ method: request.method,
+ auth: {
+ mode: 'none',
+ basic: null,
+ bearer: null,
+ digest: null
+ },
+ headers: [],
+ params: [],
+ body: {
+ mode: 'none',
+ json: null,
+ text: null,
+ xml: null,
+ formUrlEncoded: [],
+ multipartForm: []
+ }
+ }
+ };
+
+ each(request.headers, (header) => {
+ brunoRequestItem.request.headers.push({
+ uid: uuid(),
+ name: header.name,
+ value: header.value,
+ description: header.description,
+ enabled: !header.disabled
+ });
+ });
+
+ each(request.parameters, (param) => {
+ brunoRequestItem.request.params.push({
+ uid: uuid(),
+ name: param.name,
+ value: param.value,
+ description: param.description,
+ type: 'query',
+ enabled: !param.disabled
+ });
+ });
+
+ each(request.pathParameters, (param) => {
+ brunoRequestItem.request.params.push({
+ uid: uuid(),
+ name: param.name,
+ value: param.value,
+ description: '',
+ type: 'path',
+ enabled: true
+ });
+ });
+
+ const authType = get(request, 'authentication.type', '');
+
+ if (authType === 'basic') {
+ brunoRequestItem.request.auth.mode = 'basic';
+ brunoRequestItem.request.auth.basic = {
+ username: normalizeVariables(get(request, 'authentication.username', '')),
+ password: normalizeVariables(get(request, 'authentication.password', ''))
+ };
+ } else if (authType === 'bearer') {
+ brunoRequestItem.request.auth.mode = 'bearer';
+ brunoRequestItem.request.auth.bearer = {
+ token: normalizeVariables(get(request, 'authentication.token', ''))
+ };
+ }
+
+ const mimeType = get(request, 'body.mimeType', '').split(';')[0];
+
+ if (mimeType === 'application/json') {
+ brunoRequestItem.request.body.mode = 'json';
+ brunoRequestItem.request.body.json = request.body.text;
+ } else if (mimeType === 'application/x-www-form-urlencoded') {
+ brunoRequestItem.request.body.mode = 'formUrlEncoded';
+ each(request.body.params, (param) => {
+ brunoRequestItem.request.body.formUrlEncoded.push({
+ uid: uuid(),
+ name: param.name,
+ value: param.value,
+ description: param.description,
+ enabled: !param.disabled
+ });
+ });
+ } else if (mimeType === 'multipart/form-data') {
+ brunoRequestItem.request.body.mode = 'multipartForm';
+ each(request.body.params, (param) => {
+ brunoRequestItem.request.body.multipartForm.push({
+ uid: uuid(),
+ type: 'text',
+ name: param.name,
+ value: param.value,
+ description: param.description,
+ enabled: !param.disabled
+ });
+ });
+ } else if (mimeType === 'text/plain') {
+ brunoRequestItem.request.body.mode = 'text';
+ brunoRequestItem.request.body.text = request.body.text;
+ } else if (mimeType === 'text/xml' || mimeType === 'application/xml') {
+ brunoRequestItem.request.body.mode = 'xml';
+ brunoRequestItem.request.body.xml = request.body.text;
+ } else if (mimeType === 'application/graphql') {
+ brunoRequestItem.type = 'graphql-request';
+ brunoRequestItem.request.body.mode = 'graphql';
+ brunoRequestItem.request.body.graphql = parseGraphQL(request.body.text);
+ }
+
+ const settings = {
+ encodeUrl: request.settings?.encodeUrl !== false && request.settingEncodeUrl !== false, // handles v4 and v5 import
+ }
+
+ brunoRequestItem.settings = settings;
+
+ return brunoRequestItem;
+};
+
+const isInsomniaV5Export = (data) => {
+ // V5 format has a type property at the root level
+ if (data.type && data.type.startsWith('collection.insomnia.rest/5')) {
+ return true;
+ }
+ return false;
+};
+
+const parseInsomniaV5Collection = (data) => {
+ const brunoCollection = {
+ name: data.name || 'Untitled Collection',
+ uid: uuid(),
+ version: '1',
+ items: [],
+ environments: []
+ };
+
+ try {
+ // Parse the collection items
+ const parseCollectionItems = (items, allItems = []) => {
+ if (!Array.isArray(items)) {
+ throw new Error('Invalid items format: expected array');
+ }
+
+ return items.map((item, index) => {
+ if (!item) {
+ return null;
+ }
+
+ // In v5, requests might be defined with method property or meta.type
+ if (item.method && item.url) {
+ const request = {
+ _id: item.meta?.id || uuid(),
+ name: item.name || 'Untitled Request',
+ url: item.url || '',
+ method: item.method || '',
+ headers: item.headers || [],
+ parameters: item.parameters || [],
+ pathParameters: item.pathParameters || [],
+ authentication: item.authentication || {},
+ body: item.body || {},
+ settings: item.settings || {}
+ };
+ return transformInsomniaRequestItem(request, index, allItems);
+ } else if (item.children && Array.isArray(item.children)) {
+ // Process folder
+ return {
+ uid: uuid(),
+ name: item.name || 'Untitled Folder',
+ type: 'folder',
+ items: parseCollectionItems(item.children, item.children)
+ };
+ }
+ return null;
+ }).filter(Boolean);
+ };
+
+ if (data.collection && Array.isArray(data.collection)) {
+ brunoCollection.items = parseCollectionItems(data.collection, data.collection);
+ }
+
+ // Parse environments if available
+ if (data.environments) {
+ // Handle environments implementation if needed
+ }
+
+ return brunoCollection;
+ } catch (err) {
+ console.error('Error parsing collection:', err);
+ throw new Error('An error occurred while parsing the Insomnia v5 collection: ' + err.message);
+ }
+};
+
+const parseInsomniaCollection = (data) => {
+ const brunoCollection = {
+ name: '',
+ uid: uuid(),
+ version: '1',
+ items: [],
+ environments: []
+ };
+
+ try {
+ const insomniaResources = get(data, 'resources', []);
+ const insomniaCollection = insomniaResources.find((resource) => resource._type === 'workspace');
+
+ if (!insomniaCollection) {
+ throw new Error('Collection not found inside Insomnia export');
+ }
+
+ brunoCollection.name = insomniaCollection.name;
+
+ const requestsAndFolders =
+ insomniaResources.filter((resource) => resource._type === 'request' || resource._type === 'request_group') ||
+ [];
+
+ function createFolderStructure(resources, parentId = null) {
+ const requestGroups =
+ resources.filter((resource) => resource._type === 'request_group' && resource.parentId === parentId) || [];
+ const requests = resources.filter((resource) => resource._type === 'request' && resource.parentId === parentId);
+
+ const folders = requestGroups.map((folder, index, allFolder) => {
+ const name = addSuffixToDuplicateName(folder, index, allFolder);
+ const requests = resources.filter(
+ (resource) => resource._type === 'request' && resource.parentId === folder._id
+ );
+
+ return {
+ uid: uuid(),
+ name,
+ type: 'folder',
+ items: createFolderStructure(resources, folder._id).concat(
+ requests.filter(r => r.parentId === folder._id).map(transformInsomniaRequestItem)
+ )
+ };
+ });
+
+ return folders.concat(requests.map(transformInsomniaRequestItem));
+ }
+
+ brunoCollection.items = createFolderStructure(requestsAndFolders, insomniaCollection._id);
+ return brunoCollection;
+ } catch (err) {
+ console.error('Error parsing collection:', err);
+ throw new Error('An error occurred while parsing the Insomnia collection: ' + err.message);
+ }
+};
+
+export const insomniaToBruno = (insomniaCollection) => {
+ try {
+ if(typeof insomniaCollection !== 'object') {
+ insomniaCollection = jsyaml.load(insomniaCollection);
+ }
+ let collection;
+ if (isInsomniaV5Export(insomniaCollection)) {
+ collection = parseInsomniaV5Collection(insomniaCollection);
+ } else {
+ collection = parseInsomniaCollection(insomniaCollection);
+ }
+
+ const transformedCollection = transformItemsInCollection(collection);
+ const hydratedCollection = hydrateSeqInCollection(transformedCollection);
+ const validatedCollection = validateSchema(hydratedCollection);
+ return validatedCollection;
+ } catch (err) {
+ console.error(err);
+ throw new Error('Import collection failed: ' + err.message);
+ }
+};
+
+export default insomniaToBruno;
diff --git a/packages/bruno-converters/src/openapi/openapi-to-bruno.js b/packages/bruno-converters/src/openapi/openapi-to-bruno.js
new file mode 100644
index 000000000..7d1cf3b11
--- /dev/null
+++ b/packages/bruno-converters/src/openapi/openapi-to-bruno.js
@@ -0,0 +1,471 @@
+import each from 'lodash/each';
+import get from 'lodash/get';
+import jsyaml from 'js-yaml';
+import { validateSchema, transformItemsInCollection, hydrateSeqInCollection, uuid } from '../common';
+
+const ensureUrl = (url) => {
+ // removing multiple slashes after the protocol if it exists, or after the beginning of the string otherwise
+ return url.replace(/([^:])\/{2,}/g, '$1/');
+};
+
+const buildEmptyJsonBody = (bodySchema, visited = new Map()) => {
+ // Check for circular references
+ if (visited.has(bodySchema)) {
+ return {};
+ }
+
+ // Add this schema to visited map
+ visited.set(bodySchema, true);
+
+ let _jsonBody = {};
+ each(bodySchema.properties || {}, (prop, name) => {
+ if (prop.type === 'object') {
+ _jsonBody[name] = buildEmptyJsonBody(prop, visited);
+ } else if (prop.type === 'array') {
+ if (prop.items && prop.items.type === 'object') {
+ _jsonBody[name] = [buildEmptyJsonBody(prop.items, visited)];
+ } else {
+ _jsonBody[name] = [];
+ }
+ } else if (prop.type === 'integer') {
+ _jsonBody[name] = 0;
+ } else if (prop.type === 'boolean') {
+ _jsonBody[name] = false;
+ } else {
+ _jsonBody[name] = '';
+ }
+ });
+ return _jsonBody;
+};
+
+const transformOpenapiRequestItem = (request) => {
+ let _operationObject = request.operationObject;
+
+ let operationName = _operationObject.summary || _operationObject.operationId || _operationObject.description;
+ if (!operationName) {
+ operationName = `${request.method} ${request.path}`;
+ }
+
+ // replace OpenAPI links in path by Bruno variables
+ let path = request.path.replace(/{([a-zA-Z]+)}/g, `{{${_operationObject.operationId}_$1}}`);
+
+ const brunoRequestItem = {
+ uid: uuid(),
+ name: operationName,
+ type: 'http-request',
+ request: {
+ url: ensureUrl(request.global.server + path),
+ method: request.method.toUpperCase(),
+ auth: {
+ mode: 'inherit',
+ basic: null,
+ bearer: null,
+ digest: null
+ },
+ headers: [],
+ params: [],
+ body: {
+ mode: 'none',
+ json: null,
+ text: null,
+ xml: null,
+ formUrlEncoded: [],
+ multipartForm: []
+ },
+ script: {
+ res: null
+ }
+ }
+ };
+
+ each(_operationObject.parameters || [], (param) => {
+ if (param.in === 'query') {
+ brunoRequestItem.request.params.push({
+ uid: uuid(),
+ name: param.name,
+ value: '',
+ description: param.description || '',
+ enabled: param.required,
+ type: 'query'
+ });
+ } else if (param.in === 'path') {
+ brunoRequestItem.request.params.push({
+ uid: uuid(),
+ name: param.name,
+ value: '',
+ description: param.description || '',
+ enabled: param.required,
+ type: 'path'
+ });
+ } else if (param.in === 'header') {
+ brunoRequestItem.request.headers.push({
+ uid: uuid(),
+ name: param.name,
+ value: '',
+ description: param.description || '',
+ enabled: param.required
+ });
+ }
+ });
+
+ let auth;
+ // allow operation override
+ if (_operationObject.security && _operationObject.security.length > 0) {
+ let schemeName = Object.keys(_operationObject.security[0])[0];
+ auth = request.global.security.getScheme(schemeName);
+ } else if (request.global.security.supported.length > 0) {
+ auth = request.global.security.supported[0];
+ }
+
+ if (auth) {
+ if (auth.type === 'http' && auth.scheme === 'basic') {
+ brunoRequestItem.request.auth.mode = 'basic';
+ brunoRequestItem.request.auth.basic = {
+ username: '{{username}}',
+ password: '{{password}}'
+ };
+ } else if (auth.type === 'http' && auth.scheme === 'bearer') {
+ brunoRequestItem.request.auth.mode = 'bearer';
+ brunoRequestItem.request.auth.bearer = {
+ token: '{{token}}'
+ };
+ } else if (auth.type === 'apiKey' && auth.in === 'header') {
+ brunoRequestItem.request.headers.push({
+ uid: uuid(),
+ name: auth.name,
+ value: '{{apiKey}}',
+ description: 'Authentication header',
+ enabled: true
+ });
+ }
+ }
+
+ // TODO: handle allOf/anyOf/oneOf
+ if (_operationObject.requestBody) {
+ let content = get(_operationObject, 'requestBody.content', {});
+ let mimeType = Object.keys(content)[0];
+ let body = content[mimeType] || {};
+ let bodySchema = body.schema;
+ if (mimeType === 'application/json') {
+ brunoRequestItem.request.body.mode = 'json';
+ if (bodySchema && bodySchema.type === 'object') {
+ let _jsonBody = buildEmptyJsonBody(bodySchema);
+ brunoRequestItem.request.body.json = JSON.stringify(_jsonBody, null, 2);
+ }
+ if (bodySchema && bodySchema.type === 'array') {
+ brunoRequestItem.request.body.json = JSON.stringify([buildEmptyJsonBody(bodySchema.items)], null, 2);
+ }
+ } else if (mimeType === 'application/x-www-form-urlencoded') {
+ brunoRequestItem.request.body.mode = 'formUrlEncoded';
+ if (bodySchema && bodySchema.type === 'object') {
+ each(bodySchema.properties || {}, (prop, name) => {
+ brunoRequestItem.request.body.formUrlEncoded.push({
+ uid: uuid(),
+ name: name,
+ value: '',
+ description: prop.description || '',
+ enabled: true
+ });
+ });
+ }
+ } else if (mimeType === 'multipart/form-data') {
+ brunoRequestItem.request.body.mode = 'multipartForm';
+ if (bodySchema && bodySchema.type === 'object') {
+ each(bodySchema.properties || {}, (prop, name) => {
+ brunoRequestItem.request.body.multipartForm.push({
+ uid: uuid(),
+ type: 'text',
+ name: name,
+ value: '',
+ description: prop.description || '',
+ enabled: true
+ });
+ });
+ }
+ } else if (mimeType === 'text/plain') {
+ brunoRequestItem.request.body.mode = 'text';
+ brunoRequestItem.request.body.text = '';
+ } else if (mimeType === 'text/xml') {
+ brunoRequestItem.request.body.mode = 'xml';
+ brunoRequestItem.request.body.xml = '';
+ }
+ }
+
+ // build the extraction scripts from responses that have links
+ // https://swagger.io/docs/specification/links/
+ let script = [];
+ each(_operationObject.responses || [], (response, responseStatus) => {
+ if (Object.hasOwn(response, 'links')) {
+ // only extract if the status code matches the response
+ script.push(`if (res.status === ${responseStatus}) {`);
+ each(response.links, (link) => {
+ each(link.parameters || [], (expression, parameter) => {
+ let value = openAPIRuntimeExpressionToScript(expression);
+ script.push(` bru.setVar('${link.operationId}_${parameter}', ${value});`);
+ });
+ });
+ script.push(`}`);
+ }
+ });
+ if (script.length > 0) {
+ brunoRequestItem.request.script.res = script.join('\n');
+ }
+
+ return brunoRequestItem;
+};
+
+const resolveRefs = (spec, components = spec?.components, cache = new Map()) => {
+ if (!spec || typeof spec !== 'object') {
+ return spec;
+ }
+
+ if (cache.has(spec)) {
+ return cache.get(spec);
+ }
+
+ if (Array.isArray(spec)) {
+ return spec.map(item => resolveRefs(item, components, cache));
+ }
+
+ if ('$ref' in spec) {
+ const refPath = spec.$ref;
+
+ if (cache.has(refPath)) {
+ return cache.get(refPath);
+ }
+
+ if (refPath.startsWith('#/components/')) {
+ const refKeys = refPath.replace('#/components/', '').split('/');
+ let ref = components;
+
+ for (const key of refKeys) {
+ if (ref && ref[key]) {
+ ref = ref[key];
+ } else {
+ return spec;
+ }
+ }
+
+ cache.set(refPath, {});
+ const resolved = resolveRefs(ref, components, cache);
+ cache.set(refPath, resolved);
+ return resolved;
+ }
+ return spec;
+ }
+
+ const resolved = {};
+ cache.set(spec, resolved);
+
+ for (const [key, value] of Object.entries(spec)) {
+ resolved[key] = resolveRefs(value, components, cache);
+ }
+
+ return resolved;
+};
+
+const groupRequestsByTags = (requests) => {
+ let _groups = {};
+ let ungrouped = [];
+ each(requests, (request) => {
+ let tags = request.operationObject.tags || [];
+ if (tags.length > 0) {
+ let tag = tags[0].trim(); // take first tag and trim whitespace
+
+ if (tag) {
+ if (!_groups[tag]) {
+ _groups[tag] = [];
+ }
+ _groups[tag].push(request);
+ } else {
+ ungrouped.push(request);
+ }
+ } else {
+ ungrouped.push(request);
+ }
+ });
+
+ let groups = Object.keys(_groups).map((groupName) => {
+ return {
+ name: groupName,
+ requests: _groups[groupName]
+ };
+ });
+
+ return [groups, ungrouped];
+};
+
+const getDefaultUrl = (serverObject) => {
+ let url = serverObject.url;
+ if (serverObject.variables) {
+ each(serverObject.variables, (variable, variableName) => {
+ let sub = variable.default || (variable.enum ? variable.enum[0] : `{{${variableName}}}`);
+ url = url.replace(`{${variableName}}`, sub);
+ });
+ }
+ return url.endsWith('/') ? url.slice(0, -1) : url;
+};
+
+const getSecurity = (apiSpec) => {
+ let defaultSchemes = apiSpec.security || [];
+
+ let securitySchemes = get(apiSpec, 'components.securitySchemes', {});
+ if (Object.keys(securitySchemes) === 0) {
+ return {
+ supported: []
+ };
+ }
+
+ return {
+ supported: defaultSchemes.map((scheme) => {
+ var schemeName = Object.keys(scheme)[0];
+ return securitySchemes[schemeName];
+ }),
+ schemes: securitySchemes,
+ getScheme: (schemeName) => {
+ return securitySchemes[schemeName];
+ }
+ };
+};
+
+const openAPIRuntimeExpressionToScript = (expression) => {
+ // see https://swagger.io/docs/specification/links/#runtime-expressions
+ if (expression === '$response.body') {
+ return 'res.body';
+ } else if (expression.startsWith('$response.body#')) {
+ let pointer = expression.substring(15);
+ // could use https://www.npmjs.com/package/json-pointer for better support
+ return `res.body${pointer.replace('/', '.')}`;
+ }
+ return expression;
+};
+
+export const parseOpenApiCollection = (data) => {
+ const brunoCollection = {
+ name: '',
+ uid: uuid(),
+ version: '1',
+ items: [],
+ environments: []
+ };
+ try {
+ const collectionData = resolveRefs(data);
+ if (!collectionData) {
+ throw new Error('Invalid OpenAPI collection. Failed to resolve refs.');
+ return;
+ }
+
+ // Currently parsing of openapi spec is "do your best", that is
+ // allows "invalid" openapi spec
+
+ // Assumes v3 if not defined. v2 is not supported yet
+ if (collectionData.openapi && !collectionData.openapi.startsWith('3')) {
+ throw new Error('Only OpenAPI v3 is supported currently.');
+ return;
+ }
+
+ brunoCollection.name = collectionData.info?.title?.trim() || 'Untitled Collection';
+
+ let servers = collectionData.servers || [];
+
+ // Create environments based on the servers
+ servers.forEach((server, index) => {
+ let baseUrl = getDefaultUrl(server);
+ let environmentName = server.description ? server.description : `Environment ${index + 1}`;
+
+ brunoCollection.environments.push({
+ uid: uuid(),
+ name: environmentName,
+ variables: [
+ {
+ uid: uuid(),
+ name: 'baseUrl',
+ value: baseUrl,
+ type: 'text',
+ enabled: true,
+ secret: false
+ },
+ ]
+ });
+ });
+
+ let securityConfig = getSecurity(collectionData);
+
+ let allRequests = Object.entries(collectionData.paths)
+ .map(([path, methods]) => {
+ return Object.entries(methods)
+ .filter(([method, op]) => {
+ return ['get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace'].includes(
+ method.toLowerCase()
+ );
+ })
+ .map(([method, operationObject]) => {
+ return {
+ method: method,
+ path: path.replace(/{([^}]+)}/g, ':$1'), // Replace placeholders enclosed in curly braces with colons
+ operationObject: operationObject,
+ global: {
+ server: '{{baseUrl}}',
+ security: securityConfig
+ }
+ };
+ });
+ })
+ .reduce((acc, val) => acc.concat(val), []); // flatten
+
+ let [groups, ungroupedRequests] = groupRequestsByTags(allRequests);
+ let brunoFolders = groups.map((group) => {
+ return {
+ uid: uuid(),
+ name: group.name,
+ type: 'folder',
+ root: {
+ request: {
+ auth: {
+ mode: 'inherit',
+ basic: null,
+ bearer: null,
+ digest: null
+ }
+ },
+ meta: {
+ name: group.name
+ }
+ },
+ items: group.requests.map(transformOpenapiRequestItem)
+ };
+ });
+
+ let ungroupedItems = ungroupedRequests.map(transformOpenapiRequestItem);
+ let brunoCollectionItems = brunoFolders.concat(ungroupedItems);
+ brunoCollection.items = brunoCollectionItems;
+ return brunoCollection;
+ } catch (err) {
+ if (!(err instanceof Error)) {
+ throw new Error('Unknown error');
+ }
+ throw err;
+ }
+};
+
+export const openApiToBruno = (openApiSpecification) => {
+ try {
+ if(typeof openApiSpecification !== 'object') {
+ openApiSpecification = jsyaml.load(openApiSpecification);
+ }
+
+ const collection = parseOpenApiCollection(openApiSpecification);
+ const transformedCollection = transformItemsInCollection(collection);
+ const hydratedCollection = hydrateSeqInCollection(transformedCollection);
+ const validatedCollection = validateSchema(hydratedCollection);
+ return validatedCollection
+ } catch (err) {
+ console.error('Error converting OpenAPI to Bruno:', err);
+ if (!(err instanceof Error)) {
+ throw new Error('Unknown error');
+ }
+ throw err;
+ }
+};
+
+export default openApiToBruno;
diff --git a/packages/bruno-converters/src/postman/bruno-to-postman.js b/packages/bruno-converters/src/postman/bruno-to-postman.js
new file mode 100644
index 000000000..e4748c229
--- /dev/null
+++ b/packages/bruno-converters/src/postman/bruno-to-postman.js
@@ -0,0 +1,371 @@
+import map from 'lodash/map';
+import { deleteSecretsInEnvs, deleteUidsInEnvs, deleteUidsInItems } from '../common';
+
+/**
+ * Transforms a given URL string into an object representing the protocol, host, path, query, and variables.
+ *
+ * @param {string} url - The raw URL to be transformed.
+ * @param {Object} params - The params object.
+ * @returns {Object|null} An object containing the URL's protocol, host, path, query, and variables, or {} if an error occurs.
+ */
+export const transformUrl = (url, params) => {
+ if (typeof url !== 'string' || !url.trim()) {
+ url = "";
+ console.error("Invalid URL input:", url);
+ }
+
+ const urlRegexPatterns = {
+ protocolAndRestSeparator: /:\/\//,
+ hostAndPathSeparator: /\/(.+)/,
+ domainSegmentSeparator: /\./,
+ pathSegmentSeparator: /\//,
+ queryStringSeparator: /\?/
+ };
+
+ const postmanUrl = { raw: url };
+
+ /**
+ * Splits a URL into its protocol, host and path.
+ *
+ * @param {string} url - The URL to be split.
+ * @returns {Object} An object containing the protocol and the raw host/path string.
+ */
+ const splitUrl = (url) => {
+ const urlParts = url.split(urlRegexPatterns.protocolAndRestSeparator);
+ if (urlParts.length === 1) {
+ return { protocol: '', rawHostAndPath: urlParts[0] };
+ } else if (urlParts.length === 2) {
+ const [hostAndPath, _] = urlParts[1].split(urlRegexPatterns.queryStringSeparator);
+ return { protocol: urlParts[0], rawHostAndPath: hostAndPath };
+ } else {
+ throw new Error(`Invalid URL format: ${url}`);
+ }
+ };
+
+ /**
+ * Splits the host and path from a raw host/path string.
+ *
+ * @param {string} rawHostAndPath - The raw host and path string to be split.
+ * @returns {Object} An object containing the host and path.
+ */
+ const splitHostAndPath = (rawHostAndPath) => {
+ const [host, path = ''] = rawHostAndPath.split(urlRegexPatterns.hostAndPathSeparator);
+ return { host, path };
+ };
+
+ try {
+ const { protocol, rawHostAndPath } = splitUrl(url);
+ postmanUrl.protocol = protocol;
+
+ const { host, path } = splitHostAndPath(rawHostAndPath);
+ postmanUrl.host = host ? host.split(urlRegexPatterns.domainSegmentSeparator) : [];
+ postmanUrl.path = path ? path.split(urlRegexPatterns.pathSegmentSeparator) : [];
+ } catch (error) {
+ console.error(error.message);
+ return {};
+ }
+
+ // Construct query params.
+ postmanUrl.query = params
+ .filter((param) => param.type === 'query')
+ .map(({ name, value, description }) => ({ key: name, value, description }));
+
+ // Construct path params.
+ postmanUrl.variable = params
+ .filter((param) => param.type === 'path')
+ .map(({ name, value, description }) => ({ key: name, value, description }));
+
+ return postmanUrl;
+};
+
+/**
+ * Collapses multiple consecutive slashes (`//`) into a single slash, while skipping the protocol (e.g., `http://` or `https://`).
+ *
+ * @param {String} url - A URL string
+ * @returns {String} The sanitized URL
+ *
+ */
+const collapseDuplicateSlashes = (url) => {
+ return url.replace(/(? {
+ let sanitizedUrl = collapseDuplicateSlashes(url.replace(/\\/g, '//'));
+ return sanitizedUrl;
+};
+
+export const brunoToPostman = (collection) => {
+ delete collection.uid;
+ delete collection.processEnvVariables;
+ deleteUidsInItems(collection.items);
+ deleteUidsInEnvs(collection.environments);
+ deleteSecretsInEnvs(collection.environments);
+
+ const generateInfoSection = () => {
+ return {
+ name: collection.name,
+ description: collection.root?.docs,
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ };
+ };
+
+ const generateCollectionVars = (collection) => {
+ const pattern = /{{[^{}]+}}/g;
+ let listOfVars = [];
+
+ const findOccurrences = (obj, results) => {
+ if (typeof obj === 'object') {
+ if (Array.isArray(obj)) {
+ obj.forEach((item) => findOccurrences(item, results));
+ } else {
+ for (const key in obj) {
+ findOccurrences(obj[key], results);
+ }
+ }
+ } else if (typeof obj === 'string') {
+ obj.replace(pattern, (match) => {
+ results.push(match.replace(/{{|}}/g, ''));
+ });
+ }
+ };
+
+ findOccurrences(collection, listOfVars);
+
+ const finalArrayOfVars = [...new Set(listOfVars)];
+
+ return finalArrayOfVars.map((variable) => ({
+ key: variable,
+ value: '',
+ type: 'default'
+ }));
+ };
+
+ const generateEventSection = (item) => {
+ const eventArray = [];
+ if (item?.request?.tests?.length) {
+ eventArray.push({
+ listen: 'test',
+ script: {
+ exec: item.request.tests.split('\n')
+ // type: 'text/javascript'
+ }
+ });
+ }
+ if (item?.request?.script?.req) {
+ eventArray.push({
+ listen: 'prerequest',
+ script: {
+ exec: item.request.script.req.split('\n')
+ // type: 'text/javascript'
+ }
+ });
+ }
+ return eventArray;
+ };
+
+ const generateHeaders = (headersArray) => {
+ if (!headersArray || !Array.isArray(headersArray)) {
+ return [];
+ }
+ return map(headersArray, (item) => {
+ return {
+ key: item.name || '',
+ value: item.value || '',
+ disabled: !item.enabled,
+ type: 'default'
+ };
+ });
+ };
+
+ const generateBody = (body) => {
+ if (!body || !body.mode) {
+ return {
+ mode: 'raw',
+ raw: ''
+ };
+ }
+
+ switch (body.mode) {
+ case 'formUrlEncoded':
+ return {
+ mode: 'urlencoded',
+ urlencoded: map(body.formUrlEncoded || [], (bodyItem) => {
+ return {
+ key: bodyItem.name || '',
+ value: bodyItem.value || '',
+ disabled: !bodyItem.enabled,
+ type: 'default'
+ };
+ })
+ };
+ case 'multipartForm':
+ return {
+ mode: 'formdata',
+ formdata: map(body.multipartForm || [], (bodyItem) => {
+ return {
+ key: bodyItem.name || '',
+ value: bodyItem.value || '',
+ disabled: !bodyItem.enabled,
+ type: 'default'
+ };
+ })
+ };
+ case 'json':
+ return {
+ mode: 'raw',
+ raw: body.json || '',
+ options: {
+ raw: {
+ language: 'json'
+ }
+ }
+ };
+ case 'xml':
+ return {
+ mode: 'raw',
+ raw: body.xml || '',
+ options: {
+ raw: {
+ language: 'xml'
+ }
+ }
+ };
+ case 'text':
+ return {
+ mode: 'raw',
+ raw: body.text || '',
+ options: {
+ raw: {
+ language: 'text'
+ }
+ }
+ };
+ case 'graphql':
+ return {
+ mode: 'graphql',
+ graphql: body.graphql || {}
+ };
+ default:
+ return {
+ mode: 'raw',
+ raw: ''
+ };
+ }
+ };
+
+ const generateAuth = (itemAuth) => {
+ switch (itemAuth?.mode) {
+ case 'bearer':
+ return {
+ type: 'bearer',
+ bearer: {
+ key: 'token',
+ value: itemAuth.bearer?.token || '',
+ type: 'string'
+ }
+ };
+ case 'basic': {
+ return {
+ type: 'basic',
+ basic: [
+ {
+ key: 'password',
+ value: itemAuth.basic?.password || '',
+ type: 'string'
+ },
+ {
+ key: 'username',
+ value: itemAuth.basic?.username || '',
+ type: 'string'
+ }
+ ]
+ };
+ }
+ case 'apikey': {
+ return {
+ type: 'apikey',
+ apikey: [
+ {
+ key: 'key',
+ value: itemAuth.apikey?.key || '',
+ type: 'string'
+ },
+ {
+ key: 'value',
+ value: itemAuth.apikey?.value || '',
+ type: 'string'
+ }
+ ]
+ };
+ }
+ default: {
+ return {
+ type: 'noauth'
+ };
+ }
+ }
+ };
+
+ const generateRequestSection = (itemRequest) => {
+ if (!itemRequest) {
+ return {};
+ }
+
+ const requestObject = {
+ method: itemRequest.method || 'GET',
+ header: generateHeaders(itemRequest.headers),
+ auth: generateAuth(itemRequest.auth),
+ description: itemRequest.docs || '',
+ // We sanitize the URL to make sure it's in the right format before passing it to the transformUrl func. This means changing backslashes to forward slashes and reducing multiple slashes to a single one, except in the protocol part.
+ url: transformUrl(sanitizeUrl(itemRequest.url || ''), itemRequest.params || [])
+ };
+
+ if (itemRequest.body && itemRequest.body.mode !== 'none') {
+ requestObject.body = generateBody(itemRequest.body);
+ }
+ return requestObject;
+ };
+
+ const generateItemSection = (itemsArray) => {
+ if (!itemsArray || !Array.isArray(itemsArray)) {
+ return [];
+ }
+
+ return map(itemsArray, (item) => {
+ if (!item) {
+ return null;
+ }
+
+ if (item.type === 'grpc-request') {
+ return null;
+ }
+
+ if (item.type === 'folder') {
+ return {
+ name: item.name || 'Untitled Folder',
+ item: item.items && item.items.length ? generateItemSection(item.items) : []
+ };
+ } else {
+ return {
+ name: item.name || 'Untitled Request',
+ event: generateEventSection(item),
+ request: generateRequestSection(item.request)
+ };
+ }
+ });
+ };
+ const collectionToExport = {};
+ collectionToExport.info = generateInfoSection();
+ collectionToExport.item = generateItemSection(collection.items);
+ collectionToExport.variable = generateCollectionVars(collection);
+ return collectionToExport;
+};
+
+export default brunoToPostman;
diff --git a/packages/bruno-converters/src/postman/postman-env-to-bruno-env.js b/packages/bruno-converters/src/postman/postman-env-to-bruno-env.js
new file mode 100644
index 000000000..1b0a4bf36
--- /dev/null
+++ b/packages/bruno-converters/src/postman/postman-env-to-bruno-env.js
@@ -0,0 +1,45 @@
+import each from 'lodash/each';
+import { invalidVariableCharacterRegex } from '../constants';
+import { uuid } from '../common';
+
+const isSecret = (type) => {
+ return type === 'secret';
+};
+
+const importPostmanEnvironmentVariables = (brunoEnvironment, values = []) => {
+ brunoEnvironment.variables = brunoEnvironment.variables || [];
+
+ each(values.filter(i => !(i.key == null && i.value == null)), (i) => {
+ const brunoEnvironmentVariable = {
+ uid: uuid(),
+ name: (i.key ?? '').replace(invalidVariableCharacterRegex, '_'),
+ value: i.value ?? '',
+ enabled: i.enabled,
+ type: 'text',
+ secret: isSecret(i.type)
+ };
+
+ brunoEnvironment.variables.push(brunoEnvironmentVariable);
+ });
+};
+
+const importPostmanEnvironment = (environment) => {
+ const brunoEnvironment = {
+ name: environment.name,
+ variables: []
+ };
+
+ importPostmanEnvironmentVariables(brunoEnvironment, environment.values);
+ return brunoEnvironment;
+};
+
+export const postmanToBrunoEnvironment = (postmanEnvironment) => {
+ try {
+ return importPostmanEnvironment(postmanEnvironment);
+ } catch (err) {
+ console.log(err);
+ throw new Error('Unable to parse the postman environment json file');
+ }
+};
+
+export default postmanToBrunoEnvironment;
diff --git a/packages/bruno-converters/src/postman/postman-to-bruno.js b/packages/bruno-converters/src/postman/postman-to-bruno.js
new file mode 100644
index 000000000..b05fe0a9a
--- /dev/null
+++ b/packages/bruno-converters/src/postman/postman-to-bruno.js
@@ -0,0 +1,706 @@
+import get from 'lodash/get';
+import { validateSchema, transformItemsInCollection, hydrateSeqInCollection, uuid } from '../common';
+import each from 'lodash/each';
+import postmanTranslation from './postman-translations';
+import { invalidVariableCharacterRegex } from '../constants/index';
+
+const AUTH_TYPES = Object.freeze({
+ BASIC: 'basic',
+ BEARER: 'bearer',
+ AWSV4: 'awsv4',
+ APIKEY: 'apikey',
+ DIGEST: 'digest',
+ OAUTH2: 'oauth2',
+ NOAUTH: 'noauth',
+ NONE: 'none'
+});
+
+const parseGraphQLRequest = (graphqlSource) => {
+ try {
+ let queryResultObject = {
+ query: '',
+ variables: ''
+ };
+
+ if (typeof graphqlSource === 'string') {
+ graphqlSource = JSON.parse(graphqlSource);
+ }
+
+ if (graphqlSource.hasOwnProperty('variables') && graphqlSource.variables !== '') {
+ queryResultObject.variables = graphqlSource.variables;
+ }
+
+ if (graphqlSource.hasOwnProperty('query') && graphqlSource.query !== '') {
+ queryResultObject.query = graphqlSource.query;
+ }
+
+ return queryResultObject;
+ } catch (e) {
+ return {
+ query: '',
+ variables: ''
+ };
+ }
+};
+
+const isItemAFolder = (item) => {
+ return !item.request;
+};
+
+const convertV21Auth = (array) => {
+ return array.reduce((accumulator, currentValue) => {
+ accumulator[currentValue.key] = currentValue.value;
+ return accumulator;
+ }, {});
+};
+
+const constructUrlFromParts = (url) => {
+ if (!url) return '';
+
+ const { protocol = 'http', host, path, port, query, hash } = url || {};
+ const hostStr = Array.isArray(host) ? host.filter(Boolean).join('.') : host || '';
+ const pathStr = Array.isArray(path) ? path.filter(Boolean).join('/') : path || '';
+ const portStr = port ? `:${port}` : '';
+ const queryStr =
+ query && Array.isArray(query) && query.length > 0
+ ? `?${query
+ .filter((q) => q && q.key)
+ .map((q) => `${q.key}=${q.value || ''}`)
+ .join('&')}`
+ : '';
+ const urlStr = `${protocol}://${hostStr}${portStr}${pathStr ? `/${pathStr}` : ''}${queryStr}`;
+ return urlStr;
+};
+
+const constructUrl = (url) => {
+ if (!url) return '';
+
+ if (typeof url === 'string') {
+ return url;
+ }
+
+ if (typeof url === 'object') {
+ const { raw } = url;
+
+ if (raw && typeof raw === 'string') {
+ // If the raw URL contains url-fragments remove it
+ if (raw.includes('#')) {
+ return raw.split('#')[0]; // Returns the part of raw URL without the url-fragment part.
+ }
+ return raw;
+ }
+
+ // If no raw value exists, construct the URL from parts
+ return constructUrlFromParts(url);
+ }
+
+ return '';
+};
+
+const importScriptsFromEvents = (events, requestObject) => {
+ events.forEach((event) => {
+ if (event.script && event.script.exec) {
+ if (event.listen === 'prerequest') {
+ if (!requestObject.script) {
+ requestObject.script = {};
+ }
+
+ if (event.script.exec && event.script.exec.length > 0) {
+ requestObject.script.req = postmanTranslation(event.script.exec)
+ } else {
+ requestObject.script.req = '';
+ console.warn('Unexpected event.script.exec type', typeof event.script.exec);
+ }
+ }
+
+ if (event.listen === 'test') {
+ if (!requestObject.script) {
+ requestObject.script = {};
+ }
+
+ if (event.script.exec && event.script.exec.length > 0) {
+ requestObject.script.res = postmanTranslation(event.script.exec)
+ } else {
+ requestObject.script.res = '';
+ console.warn('Unexpected event.script.exec type', typeof event.script.exec);
+ }
+ }
+ }
+ });
+};
+
+const importCollectionLevelVariables = (variables, requestObject) => {
+ const vars = variables.filter(v => !(v.key == null && v.value == null)).map((v) => ({
+ uid: uuid(),
+ name: (v.key ?? '').replace(invalidVariableCharacterRegex, '_'),
+ value: v.value ?? '',
+ enabled: true
+ }));
+
+ requestObject.vars.req = vars;
+};
+
+export const processAuth = (auth, requestObject, isCollection = false) => {
+ // As of 14/05/2025
+ // When collections are set to "No Auth" in Postman, the auth object is null.
+ // When folders and requests are set to "Inherit" in Postman, the auth object is null.
+ // When folders and requests are set to "No Auth" in Postman, the auth object is present.
+
+ // Handle collection-specific "No Auth"
+ if (isCollection && !auth) return; // Return as requestObject is a collection and has a default mode = none
+
+ // Handle folder/request specific "Inherit"
+ if (!auth) return; // Return as requestObject is a folder/request and has a default mode = inherit
+
+ // Handle folder/request specific "No Auth"
+ if (auth.type === AUTH_TYPES.NOAUTH) {
+ requestObject.auth.mode = AUTH_TYPES.NONE; // Set the mode to none
+ return; // No further processing needed
+ }
+
+ let authValues = auth[auth.type] ?? [];
+ if (Array.isArray(authValues)) {
+ authValues = convertV21Auth(authValues);
+ }
+
+ requestObject.auth.mode = auth.type; // Set the mode based on Postman's auth type
+
+ switch (auth.type) {
+ case AUTH_TYPES.BASIC:
+ requestObject.auth.basic = {
+ username: authValues.username || '',
+ password: authValues.password || ''
+ };
+ break;
+ case AUTH_TYPES.BEARER:
+ requestObject.auth.bearer = {
+ token: authValues.token || ''
+ };
+ break;
+ case AUTH_TYPES.AWSV4:
+ requestObject.auth.awsv4 = {
+ accessKeyId: authValues.accessKey || '',
+ secretAccessKey: authValues.secretKey || '',
+ sessionToken: authValues.sessionToken || '',
+ service: authValues.service || '',
+ region: authValues.region || '',
+ profileName: ''
+ };
+ break;
+ case AUTH_TYPES.APIKEY:
+ requestObject.auth.apikey = {
+ key: authValues.key || '',
+ value: authValues.value?.toString() || '', // Convert the value to a string as Postman's schema does not rigidly define the type of it,
+ placement: 'header' //By default we are placing the apikey values in headers!
+ };
+ break;
+ case AUTH_TYPES.DIGEST:
+ requestObject.auth.digest = {
+ username: authValues.username || '',
+ password: authValues.password || ''
+ };
+ break;
+ case AUTH_TYPES.OAUTH2:
+ const findValueUsingKey = (key) => authValues[key] || '';
+
+ // Maps Postman's grant_type to the Bruno's grantType string expected in the target object
+ const oauth2GrantTypeMaps = {
+ authorization_code_with_pkce: 'authorization_code',
+ authorization_code: 'authorization_code',
+ client_credentials: 'client_credentials',
+ password_credentials: 'password'
+ };
+
+ const postmanGrantType = findValueUsingKey('grant_type');
+ const targetGrantType = oauth2GrantTypeMaps[postmanGrantType] || 'client_credentials'; // Default
+
+ // Common properties for all OAuth2 grant types
+ const baseOAuth2Config = {
+ grantType: targetGrantType,
+ accessTokenUrl: findValueUsingKey('accessTokenUrl'),
+ refreshTokenUrl: findValueUsingKey('refreshTokenUrl'),
+ clientId: findValueUsingKey('clientId'),
+ clientSecret: findValueUsingKey('clientSecret'),
+ scope: findValueUsingKey('scope'),
+ state: findValueUsingKey('state'),
+ tokenPlacement: findValueUsingKey('addTokenTo') === 'header' ? 'header' : 'url',
+ credentialsPlacement: findValueUsingKey('client_authentication') === 'body' ? 'body' : 'basic_auth_header'
+ };
+
+ switch (postmanGrantType) {
+ case 'authorization_code':
+ requestObject.auth.oauth2 = {
+ ...baseOAuth2Config,
+ authorizationUrl: findValueUsingKey('authUrl'),
+ callbackUrl: findValueUsingKey('redirect_uri'),
+ pkce: false // PKCE is not used for standard authorization_code
+ };
+ break;
+ case 'authorization_code_with_pkce':
+ requestObject.auth.oauth2 = {
+ ...baseOAuth2Config,
+ authorizationUrl: findValueUsingKey('authUrl'),
+ callbackUrl: findValueUsingKey('redirect_uri'),
+ pkce: true, // Explicitly set pkce to true for this grant type
+ };
+ break;
+ case 'password_credentials':
+ requestObject.auth.oauth2 = {
+ ...baseOAuth2Config,
+ username: findValueUsingKey('username'),
+ password: findValueUsingKey('password'),
+ };
+ break;
+ case 'client_credentials':
+ requestObject.auth.oauth2 = baseOAuth2Config;
+ break;
+ default:
+ console.warn('Unexpected OAuth2 grant type after mapping:', targetGrantType);
+ requestObject.auth.oauth2 = baseOAuth2Config; // Fallback to default which is Client Credentials
+ break;
+ }
+ break;
+ default:
+ requestObject.auth.mode = AUTH_TYPES.NONE;
+ console.warn('Unexpected auth.type:', auth.type, '- Mode set, but no specific config generated.');
+ break;
+ }
+};
+
+const importPostmanV2CollectionItem = (brunoParent, item, { useWorkers = false } = {}, scriptMap) => {
+ brunoParent.items = brunoParent.items || [];
+ const folderMap = {};
+ const requestMap = {};
+ const requestMethods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE']
+
+ item.forEach((i, index) => {
+ if (isItemAFolder(i)) {
+ const baseFolderName = i.name || 'Untitled Folder';
+ let folderName = baseFolderName;
+ let count = 1;
+
+ while (folderMap[folderName]) {
+ folderName = `${baseFolderName}_${count}`;
+ count++;
+ }
+
+ const brunoFolderItem = {
+ uid: uuid(),
+ name: folderName,
+ type: 'folder',
+ items: [],
+ seq: index + 1,
+ root: {
+ docs: i.description || '',
+ meta: {
+ name: folderName
+ },
+ request: {
+ auth: {
+ mode: 'inherit',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ },
+ headers: [],
+ script: {},
+ tests: '',
+ vars: {}
+ }
+ }
+ };
+
+ brunoParent.items.push(brunoFolderItem);
+
+ // Folder level auth
+ processAuth(i.auth, brunoFolderItem.root.request);
+
+ if (i.item && i.item.length) {
+ importPostmanV2CollectionItem(brunoFolderItem, i.item, { useWorkers }, scriptMap);
+ }
+
+ if (i.event) {
+ if (useWorkers) {
+ scriptMap.set(brunoFolderItem.uid, {
+ events: i.event,
+ request: brunoFolderItem.root.request
+ });
+ } else {
+ importScriptsFromEvents(i.event, brunoFolderItem.root.request);
+ }
+ }
+
+ folderMap[folderName] = brunoFolderItem;
+
+ } else if (i.request) {
+ if (!requestMethods.includes(i?.request?.method.toUpperCase())) {
+ console.warn('Unexpected request.method', i?.request?.method);
+ return;
+ }
+
+ const baseRequestName = i.name || 'Untitled Request';
+ let requestName = baseRequestName;
+ let count = 1;
+
+ while (requestMap[requestName]) {
+ requestName = `${baseRequestName}_${count}`;
+ count++;
+ }
+
+ const url = constructUrl(i.request.url);
+
+ const brunoRequestItem = {
+ uid: uuid(),
+ name: requestName,
+ type: 'http-request',
+ seq: index + 1,
+ request: {
+ url: url,
+ method: i?.request?.method?.toUpperCase(),
+ auth: {
+ mode: 'inherit',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ },
+ headers: [],
+ params: [],
+ body: {
+ mode: 'none',
+ json: null,
+ text: null,
+ xml: null,
+ formUrlEncoded: [],
+ multipartForm: []
+ },
+ docs: i.request.description || ''
+ }
+ };
+
+ const settings = {
+ encodeUrl: i.protocolProfileBehavior?.disableUrlEncoding !== true
+ }
+
+ brunoRequestItem.settings = settings;
+
+ brunoParent.items.push(brunoRequestItem);
+
+ if (i.event) {
+ if (useWorkers) {
+ scriptMap.set(brunoRequestItem.uid, {
+ events: i.event,
+ request: brunoRequestItem.request
+ });
+ } else {
+ i.event.forEach((event) => {
+ if (event.listen === 'prerequest' && event.script && event.script.exec) {
+ if (!brunoRequestItem.request?.script) {
+ brunoRequestItem.request.script = {};
+ }
+ if (event.script.exec && event.script.exec.length > 0) {
+ brunoRequestItem.request.script.req = postmanTranslation(event.script.exec)
+ } else {
+ brunoRequestItem.request.script.req = '';
+ console.warn('Unexpected event.script.exec type', typeof event.script.exec);
+ }
+ }
+ if (event.listen === 'test' && event.script && event.script.exec) {
+ if (!brunoRequestItem.request?.script) {
+ brunoRequestItem.request.script = {};
+ }
+ if (event.script.exec && event.script.exec.length > 0) {
+ brunoRequestItem.request.script.res = postmanTranslation(event.script.exec)
+ } else {
+ brunoRequestItem.request.script.res = '';
+ console.warn('Unexpected event.script.exec type', typeof event.script.exec);
+ }
+ }
+
+ });
+ }
+ }
+
+ const bodyMode = get(i, 'request.body.mode');
+ if (bodyMode) {
+ if (bodyMode === 'formdata') {
+ brunoRequestItem.request.body.mode = 'multipartForm';
+
+ each(i.request.body.formdata, (param) => {
+ const isFile = param.type === 'file';
+ let value;
+ let type;
+
+ if (isFile) {
+ // If param.src is an array, keep it as it is.
+ // If param.src is a string, convert it into an array with a single element.
+ value = Array.isArray(param.src) ? param.src : typeof param.src === 'string' ? [param.src] : null;
+ type = 'file';
+ } else {
+ value = param.value;
+ type = 'text';
+ }
+
+ brunoRequestItem.request.body.multipartForm.push({
+ uid: uuid(),
+ type: type,
+ name: param.key,
+ value: value,
+ description: param.description,
+ enabled: !param.disabled
+ });
+ });
+ }
+
+ if (bodyMode === 'urlencoded') {
+ brunoRequestItem.request.body.mode = 'formUrlEncoded';
+ each(i.request.body.urlencoded, (param) => {
+ brunoRequestItem.request.body.formUrlEncoded.push({
+ uid: uuid(),
+ name: param.key,
+ value: param.value,
+ description: param.description,
+ enabled: !param.disabled
+ });
+ });
+ }
+
+ if (bodyMode === 'raw') {
+ let language = get(i, 'request.body.options.raw.language');
+ if (!language) {
+ language = searchLanguageByHeader(i.request.header);
+ }
+ if (language === 'json') {
+ brunoRequestItem.request.body.mode = 'json';
+ brunoRequestItem.request.body.json = i.request.body.raw;
+ } else if (language === 'xml') {
+ brunoRequestItem.request.body.mode = 'xml';
+ brunoRequestItem.request.body.xml = i.request.body.raw;
+ } else {
+ brunoRequestItem.request.body.mode = 'text';
+ brunoRequestItem.request.body.text = i.request.body.raw;
+ }
+ }
+ }
+
+ if (bodyMode === 'graphql') {
+ brunoRequestItem.type = 'graphql-request';
+ brunoRequestItem.request.body.mode = 'graphql';
+ brunoRequestItem.request.body.graphql = parseGraphQLRequest(i.request.body.graphql);
+ }
+
+ each(i.request.header, (header) => {
+ brunoRequestItem.request.headers.push({
+ uid: uuid(),
+ name: header.key,
+ value: header.value,
+ description: header.description,
+ enabled: !header.disabled
+ });
+ });
+
+ // Request-level auth
+ processAuth(i.request.auth, brunoRequestItem.request);
+
+ each(get(i, 'request.url.query'), (param) => {
+ brunoRequestItem.request.params.push({
+ uid: uuid(),
+ name: param.key,
+ value: param.value,
+ description: param.description,
+ type: 'query',
+ enabled: !param.disabled
+ });
+ });
+
+ each(get(i, 'request.url.variable', []), (param) => {
+ if (!param.key) {
+ // If no key, skip this iteration and discard the param
+ return;
+ }
+
+ brunoRequestItem.request.params.push({
+ uid: uuid(),
+ name: param.key,
+ value: param.value ?? '',
+ description: param.description ?? '',
+ type: 'path',
+ enabled: true
+ });
+ });
+
+ requestMap[requestName] = brunoRequestItem;
+ }
+ });
+};
+
+
+const searchLanguageByHeader = (headers) => {
+ let contentType;
+ each(headers, (header) => {
+ if (header.key.toLowerCase() === 'content-type' && !header.disabled) {
+ if (typeof header.value == 'string' && /^[\w\-]+\/([\w\-]+\+)?json/.test(header.value)) {
+ contentType = 'json';
+ } else if (typeof header.value == 'string' && /^[\w\-]+\/([\w\-]+\+)?xml/.test(header.value)) {
+ contentType = 'xml';
+ }
+ return false;
+ }
+ });
+ return contentType;
+};
+
+const importPostmanV2Collection = async (collection, { useWorkers = false }) => {
+ const brunoCollection = {
+ name: collection.info.name || 'Untitled Collection',
+ uid: uuid(),
+ version: '1',
+ items: [],
+ environments: [],
+ root: {
+ docs: collection.info.description || '',
+ meta: {
+ name: collection.info.name || 'Untitled Collection'
+ },
+ request: {
+ auth: {
+ mode: 'none',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ },
+ headers: [],
+ script: {},
+ tests: '',
+ vars: {}
+ }
+ }
+ };
+
+ if (collection.event) {
+ importScriptsFromEvents(collection.event, brunoCollection.root.request);
+ }
+
+ if (collection?.variable) {
+ importCollectionLevelVariables(collection.variable, brunoCollection.root.request);
+ }
+
+ // Collection level auth
+ processAuth(collection.auth, brunoCollection.root.request, true);
+
+ // Create a single scriptMap for all items
+ const scriptMap = useWorkers ? new Map() : null;
+
+ importPostmanV2CollectionItem(brunoCollection, collection.item, { useWorkers }, scriptMap);
+
+ // Process all scripts in a single call at the top level
+ if (useWorkers && scriptMap && scriptMap.size > 0) {
+ try {
+ const { default: scriptTranslationWorker } = await import('../workers/postman-translator-worker');
+ const translatedScripts = await scriptTranslationWorker(scriptMap);
+
+ // Apply translated scripts to all items in the collection
+ const applyScriptsToItems = (items) => {
+ items.forEach(item => {
+ if (item.type === 'folder') {
+ // Apply scripts to the folder
+ if (translatedScripts.has(item.uid)) {
+ if (!item.root.request.script) {
+ item.root.request.script = {};
+ }
+ if (!item.root.request.tests) {
+ item.root.request.tests = '';
+ }
+
+ const script = translatedScripts.get(item.uid).request?.script?.req;
+ const tests = translatedScripts.get(item.uid).request?.script?.res;
+
+ item.root.request.script.req = script && script.length > 0 ? script : '';
+ item.root.request.script.res = tests && tests.length > 0 ? tests : '';
+ }
+
+ // Recursively apply to nested items
+ if (item.items && item.items.length > 0) {
+ applyScriptsToItems(item.items);
+ }
+ } else {
+ if (translatedScripts.has(item.uid)) {
+ if (!item.request.script) {
+ item.request.script = {};
+ }
+ if (!item.request.tests) {
+ item.request.tests = '';
+ }
+
+ const script = translatedScripts.get(item.uid).request?.script?.req;
+ const tests = translatedScripts.get(item.uid).request?.script?.res;
+
+ item.request.script.req = script && script.length > 0 ? script : '';
+ item.request.script.res = tests && tests.length > 0 ? tests : '';
+ }
+ }
+ });
+ };
+
+ applyScriptsToItems(brunoCollection.items);
+
+ } catch (error) {
+ console.error('Error in script translation worker:', error);
+ } finally {
+ scriptMap.clear();
+ }
+ }
+
+ return brunoCollection;
+};
+
+
+const parsePostmanCollection = async (collection, { useWorkers = false }) => {
+ try {
+ let schema = get(collection, 'info.schema');
+
+ let v2Schemas = [
+ 'https://schema.getpostman.com/json/collection/v2.0.0/collection.json',
+ 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json',
+ 'https://schema.postman.com/json/collection/v2.0.0/collection.json',
+ 'https://schema.postman.com/json/collection/v2.1.0/collection.json'
+ ];
+
+ if (v2Schemas.includes(schema)) {
+ return await importPostmanV2Collection(collection, { useWorkers });
+ }
+
+ throw new Error('Unsupported Postman schema version. Only Postman Collection v2.0 and v2.1 are supported.');
+ } catch (err) {
+ console.log(err);
+ if (err instanceof Error) {
+ throw err;
+ }
+
+ throw new Error('Invalid Postman collection format. Please check your JSON file.');
+ }
+};
+
+const postmanToBruno = async (postmanCollection, { useWorkers = false } = {}) => {
+ try {
+
+ const parsedPostmanCollection = await parsePostmanCollection(postmanCollection, { useWorkers });
+ const transformedCollection = transformItemsInCollection(parsedPostmanCollection);
+ const hydratedCollection = hydrateSeqInCollection(transformedCollection);
+ const validatedCollection = validateSchema(hydratedCollection);
+ return validatedCollection;
+ } catch (err) {
+ console.log(err);
+ throw new Error(`Import collection failed: ${err.message}`);
+ }
+};
+
+export default postmanToBruno;
\ No newline at end of file
diff --git a/packages/bruno-converters/src/postman/postman-translations.js b/packages/bruno-converters/src/postman/postman-translations.js
new file mode 100644
index 000000000..43c034db9
--- /dev/null
+++ b/packages/bruno-converters/src/postman/postman-translations.js
@@ -0,0 +1,107 @@
+import translateCode from '../utils/jscode-shift-translator';
+
+const replacements = {
+ 'pm\\.environment\\.get\\(': 'bru.getEnvVar(',
+ 'pm\\.environment\\.set\\(': 'bru.setEnvVar(',
+ 'pm\\.variables\\.get\\(': 'bru.getVar(',
+ 'pm\\.variables\\.set\\(': 'bru.setVar(',
+ 'pm\\.variables\\.replaceIn\\(': 'bru.interpolate(',
+ 'pm\\.collectionVariables\\.get\\(': 'bru.getVar(',
+ 'pm\\.collectionVariables\\.set\\(': 'bru.setVar(',
+ 'pm\\.collectionVariables\\.has\\(': 'bru.hasVar(',
+ 'pm\\.collectionVariables\\.unset\\(': 'bru.deleteVar(',
+ 'pm\\.setNextRequest\\(': 'bru.setNextRequest(',
+ 'pm\\.test\\(': 'test(',
+ 'pm.response.to.have\\.status\\(': 'expect(res.getStatus()).to.equal(',
+ 'pm\\.response\\.to\\.have\\.status\\(': 'expect(res.getStatus()).to.equal(',
+ 'pm\\.response\\.json\\(': 'res.getBody(',
+ 'pm\\.expect\\(': 'expect(',
+ 'pm\\.environment\\.has\\(([^)]+)\\)': 'bru.getEnvVar($1) !== undefined && bru.getEnvVar($1) !== null',
+ 'pm\\.response\\.code': 'res.getStatus()',
+ 'pm\\.response\\.text\\(\\)': 'JSON.stringify(res.getBody())',
+ 'pm\\.expect\\.fail\\(': 'expect.fail(',
+ 'pm\\.response\\.responseTime': 'res.getResponseTime()',
+ 'pm\\.globals\\.set\\(': 'bru.setGlobalEnvVar(',
+ 'pm\\.globals\\.get\\(': 'bru.getGlobalEnvVar(',
+ 'pm\\.response\\.headers\\.get\\(': 'res.getHeader(',
+ 'pm\\.response\\.to\\.have\\.body\\(': 'expect(res.getBody()).to.equal(',
+ 'pm\\.response\\.to\\.have\\.header\\(': 'expect(res.getHeaders()).to.have.property(',
+ 'pm\\.response\\.size\\(\\)': 'res.getSize()',
+ 'pm\\.response\\.size\\(\\)\\.body': 'res.getSize().body',
+ 'pm\\.response\\.responseSize': 'res.getSize().body',
+ 'pm\\.response\\.size\\(\\)\\.header': 'res.getSize().header',
+ 'pm\\.response\\.size\\(\\)\\.total': 'res.getSize().total',
+ 'pm\\.environment\\.name': 'bru.getEnvName()',
+ 'pm\\.response\\.status': 'res.statusText',
+ 'pm\\.response\\.headers': 'res.getHeaders()',
+ "tests\\['([^']+)'\\]\\s*=\\s*([^;]+);": 'test("$1", function() { expect(Boolean($2)).to.be.true; });',
+ 'pm\\.request\\.url': 'req.getUrl()',
+ 'pm\\.request\\.method': 'req.getMethod()',
+ 'pm\\.request\\.headers': 'req.getHeaders()',
+ 'pm\\.request\\.body': 'req.getBody()',
+ 'pm\\.info\\.requestName': 'req.getName()',
+ // deprecated translations
+ 'postman\\.setEnvironmentVariable\\(': 'bru.setEnvVar(',
+ 'postman\\.getEnvironmentVariable\\(': 'bru.getEnvVar(',
+ 'postman\\.clearEnvironmentVariable\\(': 'bru.deleteEnvVar(',
+ 'pm\\.execution\\.skipRequest\\(\\)': 'bru.runner.skipRequest()',
+ 'pm\\.execution\\.skipRequest': 'bru.runner.skipRequest',
+ 'pm\\.execution\\.setNextRequest\\(null\\)': 'bru.runner.stopExecution()',
+ 'pm\\.execution\\.setNextRequest\\(\'null\'\\)': 'bru.runner.stopExecution()',
+ // Cookie jar translations
+ 'pm\\.cookies\\.jar\\(\\)': 'bru.cookies.jar()',
+ 'pm\\.cookies\\.jar\\(\\)\\.get\\(': 'bru.cookies.jar().getCookie(',
+ 'pm\\.cookies\\.jar\\(\\)\\.set\\(': 'bru.cookies.jar().setCookie(',
+ 'pm\\.cookies\\.jar\\(\\)\\.unset\\(': 'bru.cookies.jar().deleteCookie(',
+ 'pm\\.cookies\\.jar\\(\\)\\.clear\\(': 'bru.cookies.jar().deleteCookies(',
+ 'pm\\.cookies\\.jar\\(\\)\\.getAll\\(': 'bru.cookies.jar().getCookies(',
+};
+
+const extendedReplacements = Object.keys(replacements).reduce((acc, key) => {
+ const newKey = key.replace(/^pm\\\./, 'postman\\.');
+ acc[key] = replacements[key];
+ acc[newKey] = replacements[key];
+ return acc;
+}, {});
+
+const compiledReplacements = Object.entries(extendedReplacements).map(([pattern, replacement]) => ({
+ regex: new RegExp(pattern, 'g'),
+ replacement
+}));
+
+const processRegexReplacement = (code) => {
+ for (const { regex, replacement } of compiledReplacements) {
+ if (regex.test(code)) {
+ code = code.replace(regex, replacement);
+
+ }
+ }
+ if ((code.includes('pm.') || code.includes('postman.'))) {
+ code = code.replace(/^(.*(pm\.|postman\.).*)$/gm, '// $1');
+ }
+ return code;
+}
+
+
+const postmanTranslation = (script, options = {}) => {
+ let modifiedScript = Array.isArray(script) ? script.join('\n') : script;
+
+ try {
+ let translatedCode = translateCode(modifiedScript);
+ if ((translatedCode.includes('pm.') || translatedCode.includes('postman.'))) {
+ translatedCode = translatedCode.replace(/^(.*(pm\.|postman\.).*)$/gm, '// $1');
+ }
+ return translatedCode;
+ } catch (e) {
+ console.warn('Error in postman translation:', e);
+
+ try {
+ return processRegexReplacement(modifiedScript);
+ } catch (e) {
+ console.warn('Error in postman translation:', e);
+ return modifiedScript;
+ }
+ }
+};
+
+export default postmanTranslation;
\ No newline at end of file
diff --git a/packages/bruno-converters/src/utils/jscode-shift-translator.js b/packages/bruno-converters/src/utils/jscode-shift-translator.js
new file mode 100644
index 000000000..14450e054
--- /dev/null
+++ b/packages/bruno-converters/src/utils/jscode-shift-translator.js
@@ -0,0 +1,891 @@
+import sendRequestTransformer from './send-request-transformer';
+const j = require('jscodeshift');
+const cloneDeep = require('lodash/cloneDeep');
+
+/**
+ * Efficiently builds a string representation of a member expression without using toSource()
+ *
+ * @param {Object} node - The member expression node from the AST
+ * @return {string} - String representation of the member expression (e.g., "pm.environment.get")
+ */
+function getMemberExpressionString(node) {
+ // Handle base case: if this is an Identifier
+ if (node.type === 'Identifier') {
+ return node.name;
+ }
+
+ if (node.type === 'CallExpression') {
+ const calleeStr = getMemberExpressionString(node.callee);
+ return `${calleeStr}()`;
+ }
+
+ // Handle member expressions
+ if (node.type === 'MemberExpression') {
+ const objectStr = getMemberExpressionString(node.object);
+
+ // For computed properties like obj[prop], we need special handling
+ if (node.computed) {
+ // For literals like obj["prop"], we can include them in the string
+ if (node.property.type === 'Literal' && typeof node.property.value === 'string') {
+ return `${objectStr}.${node.property.value}`;
+ }
+ // For other computed properties, we can't reliably represent them as a simple string
+ return `${objectStr}.[computed]`;
+ }
+
+ // For regular property access like obj.prop
+ if (node.property.type === 'Identifier') {
+ return `${objectStr}.${node.property.name}`;
+ }
+ }
+
+ return '[unsupported]';
+}
+
+// Simple 1:1 translations for straightforward replacements
+const simpleTranslations = {
+ // Global Variables
+ 'pm.globals.get': 'bru.getGlobalEnvVar',
+ 'pm.globals.set': 'bru.setGlobalEnvVar',
+
+ // Environment variables
+ 'pm.environment.get': 'bru.getEnvVar',
+ 'pm.environment.set': 'bru.setEnvVar',
+ 'pm.environment.name': 'bru.getEnvName()',
+ 'pm.environment.unset': 'bru.deleteEnvVar',
+
+ // Variables
+ 'pm.variables.get': 'bru.getVar',
+ 'pm.variables.set': 'bru.setVar',
+ 'pm.variables.has': 'bru.hasVar',
+ 'pm.variables.replaceIn': 'bru.interpolate',
+ // Collection variables
+ 'pm.collectionVariables.get': 'bru.getVar',
+ 'pm.collectionVariables.set': 'bru.setVar',
+ 'pm.collectionVariables.has': 'bru.hasVar',
+ 'pm.collectionVariables.unset': 'bru.deleteVar',
+
+ // Request flow control
+ 'pm.setNextRequest': 'bru.setNextRequest',
+
+ // Testing
+ 'pm.test': 'test',
+ 'pm.expect': 'expect',
+ 'pm.expect.fail': 'expect.fail',
+
+ // Info
+ 'pm.info.requestName': 'req.getName()',
+
+ // Request properties
+ 'pm.request.url': 'req.getUrl()',
+ 'pm.request.method': 'req.getMethod()',
+ 'pm.request.headers': 'req.getHeaders()',
+ 'pm.request.body': 'req.getBody()',
+
+ // Response properties
+ 'pm.response.json': 'res.getBody',
+ 'pm.response.code': 'res.getStatus()',
+ 'pm.response.status': 'res.statusText',
+ 'pm.response.responseTime': 'res.getResponseTime()',
+ 'pm.response.statusText': 'res.statusText',
+ 'pm.response.headers': 'res.getHeaders()',
+ 'pm.response.size': 'res.getSize',
+ 'pm.response.responseSize': 'res.getSize().body',
+ 'pm.response.size().body': 'res.getSize().body',
+ 'pm.response.size().header': 'res.getSize().header',
+ 'pm.response.size().total': 'res.getSize().total',
+ 'pm.cookies.jar': 'bru.cookies.jar',
+
+ 'pm.cookies.jar().get': 'bru.cookies.jar().getCookie',
+ 'pm.cookies.jar().getAll': 'bru.cookies.jar().getCookies',
+ 'pm.cookies.jar().set': 'bru.cookies.jar().setCookie',
+ 'pm.cookies.jar().unset': 'bru.cookies.jar().deleteCookie',
+ 'pm.cookies.jar().clear': 'bru.cookies.jar().deleteCookies',
+
+ // Execution control
+ 'pm.execution.skipRequest': 'bru.runner.skipRequest',
+
+ // Legacy Postman API (deprecated) (we can use pm instead of postman, as we are converting all postman references to pm in the code as the part of pre-processing)
+ 'pm.setEnvironmentVariable': 'bru.setEnvVar',
+ 'pm.getEnvironmentVariable': 'bru.getEnvVar',
+ 'pm.clearEnvironmentVariable': 'bru.deleteEnvVar',
+};
+
+/* Complex transformations that need custom handling
+* Note: Transform functions can return either a single node or an array of nodes.
+* When returning an array of nodes, each node in the array will be inserted
+* as a separate statement, which allows a single Postman expression to be
+* transformed into multiple Bruno statements (e.g. for complex assertions).
+*/
+
+const complexTransformations = [
+ // pm.sendRequest transformation
+ {
+ pattern: 'pm.sendRequest',
+ transform: sendRequestTransformer
+ },
+
+ // pm.environment.has requires special handling
+ {
+ pattern: 'pm.environment.has',
+ transform: (path, j) => {
+ const callExpr = path.parent.value;
+
+ const args = callExpr.arguments;
+
+ // Create: bru.getEnvVar(arg) !== undefined && bru.getEnvVar(arg) !== null
+ return j.logicalExpression(
+ '&&',
+ j.binaryExpression(
+ '!==',
+ j.callExpression(j.identifier('bru.getEnvVar'), args),
+ j.identifier('undefined')
+ ),
+ j.binaryExpression(
+ '!==',
+ j.callExpression(j.identifier('bru.getEnvVar'), args),
+ j.identifier('null')
+ )
+ );
+ }
+ },
+
+ {
+ pattern: 'pm.response.text',
+ transform: (_, j) => {
+ return j.callExpression(j.identifier('JSON.stringify'), [j.identifier('res.getBody()')]);
+ }
+ },
+ {
+ pattern: 'pm.response.headers.get',
+ transform: (path, j) => {
+ return j.callExpression(j.identifier('res.getHeader'), path.parent.value.arguments);
+ }
+ },
+ // Handle pm.response.to.have.status
+ {
+ pattern: 'pm.response.to.have.status',
+ transform: (path, j) => {
+ const callExpr = path.parent.value;
+
+ const args = callExpr.arguments;
+
+ // Create: expect(res.getStatus()).to.equal(arg)
+ return j.callExpression(
+ j.memberExpression(
+ j.callExpression(
+ j.identifier('expect'),
+ [
+ j.callExpression(
+ j.identifier('res.getStatus'),
+ []
+ )
+ ]
+ ),
+ j.identifier('to.equal')
+ ),
+ args
+ );
+ }
+ },
+
+ // handle 'pm.response.to.have.header' to expect(res.getHeaders()).to.have.property(args)
+ {
+ pattern: 'pm.response.to.have.header',
+ transform: (path, j) => {
+ const callExpr = path.parent.value;
+
+ const args = callExpr.arguments;
+
+
+ if (args.length > 0) {
+ // Apply toLowerCase() to the first argument
+ args[0] = j.callExpression(
+ j.memberExpression(
+ args[0],
+ j.identifier('toLowerCase')
+ ),
+ []
+ );
+ }
+
+ // Create: expect(res.getHeaders()).to.have.property(args)
+ return j.callExpression(
+ j.memberExpression(
+ j.callExpression(
+ j.identifier('expect'),
+ [
+ j.callExpression(
+ j.identifier('res.getHeaders'),
+ []
+ )
+ ]
+ ),
+ j.identifier('to.have.property')
+ ),
+ args
+ );
+
+ }
+ },
+ // handle pm.response.to.have.body to expect(res.getBody()).to.equal(arg)
+ {
+ pattern: 'pm.response.to.have.body',
+ transform: (path, j) => {
+ const callExpr = path.parent.value;
+
+ const args = callExpr.arguments;
+
+ return j.callExpression(
+ j.memberExpression(
+ j.callExpression(j.identifier('expect'), [j.identifier('res.getBody()')]),
+ j.identifier('to.equal')
+ ),
+ args
+ );
+
+ }
+ },
+
+ // Handle pm.execution.setNextRequest(null)
+ {
+ pattern: 'pm.execution.setNextRequest',
+ transform: (path, j) => {
+ const callExpr = path.parent.value;
+
+ const args = callExpr.arguments;
+
+ // If argument is null or 'null', transform to bru.runner.stopExecution()
+ if (
+ args[0].type === 'Literal' && (args[0].value === null || args[0].value === 'null')
+ ) {
+ return j.callExpression(
+ j.identifier('bru.runner.stopExecution'),
+ []
+ );
+ }
+
+ // Otherwise, keep as bru.runner.setNextRequest with the same argument
+ return j.callExpression(
+ j.identifier('bru.runner.setNextRequest'),
+ args
+ );
+ }
+ },
+];
+
+// Create a map for complex transformations to enable O(1) lookups
+const complexTransformationsMap = {};
+complexTransformations.forEach(transform => {
+ complexTransformationsMap[transform.pattern] = transform;
+});
+
+const varInitsToReplace = new Set(['pm', 'postman', 'pm.request','pm.response', 'pm.test', 'pm.expect', 'pm.environment', 'pm.variables', 'pm.collectionVariables', 'pm.execution', 'pm.globals']);
+
+/**
+ * Process all transformations (both simple and complex) in the AST in a single pass
+ * @param {Object} ast - jscodeshift AST
+ * @param {Set} transformedNodes - Set of already transformed nodes
+ */
+function processTransformations(ast, transformedNodes) {
+ ast.find(j.MemberExpression).forEach(path => {
+ if (transformedNodes.has(path.node)) return;
+
+ // Get string representation using our utility function
+ const memberExprStr = getMemberExpressionString(path.value);
+
+ // First check for simple transformations (O(1))
+ if (simpleTranslations.hasOwnProperty(memberExprStr)) {
+ const replacement = simpleTranslations[memberExprStr];
+ j(path).replaceWith(j.identifier(replacement));
+ transformedNodes.add(path.node);
+ return; // Skip complex transformation check if simple transformation applied
+ }
+
+ // Then check for complex transformations (O(1))
+ if (complexTransformationsMap.hasOwnProperty(memberExprStr) &&
+ path.parent.value.type === 'CallExpression') {
+ const transform = complexTransformationsMap[memberExprStr];
+ const replacement = transform.transform(path, j);
+ if (Array.isArray(replacement)) {
+ replacement.forEach((nodePath, index) => {
+ if(index === 0) {
+ j(path.parent).replaceWith(nodePath);
+ } else {
+ j(path.parent.parent).insertAfter(nodePath);
+ }
+ transformedNodes.add(nodePath.node);
+ transformedNodes.add(path.parent.node);
+ });
+ } else {
+ j(path.parent).replaceWith(replacement);
+ transformedNodes.add(path.node);
+ transformedNodes.add(path.parent.node);
+ }
+ }
+ });
+}
+
+/**
+ * Translates Postman script code to Bruno script code
+ * @param {string} code - The Postman script code to translate
+ * @returns {string} The translated Bruno script code
+ */
+function translateCode(code) {
+ // Replace 'postman' with 'pm' using regex before creating the AST
+ // This is more efficient than an AST traversal
+ code = code.replace(/\bpostman\b/g, 'pm');
+
+ const ast = j(code);
+
+ // Keep track of transformed nodes to avoid double-processing
+ const transformedNodes = new Set();
+
+ // Preprocess the code to resolve all aliases
+ preprocessAliases(ast);
+
+ // Handle cookie jar variable assignments and method renaming
+ processCookieJarVariables(ast);
+
+ // Process all transformations in a single pass
+ processTransformations(ast, transformedNodes);
+
+ // Handle legacy Postman global APIs
+ handleLegacyGlobalAPIs(ast, transformedNodes, code);
+
+ // Handle special Postman syntax patterns
+ handleTestsBracketNotation(ast);
+
+ return ast.toSource();
+}
+
+/**
+ * Preprocess all variable aliases in the AST to simplify later transformations
+ * @param {Object} ast - jscodeshift AST
+ */
+function preprocessAliases(ast) {
+ // Create a symbol table to track what each variable references
+ const symbolTable = new Map();
+ const MAX_ITERATIONS = 5;
+ let iterations = 0;
+
+ // Keep preprocessing until no more changes can be made
+ let changesMade;
+ do {
+ changesMade = false;
+
+ // First pass: Identify all variables
+ findVariableDefinitions(ast, symbolTable);
+
+ // Second pass: Replace all variable references with their resolved values
+ changesMade = resolveVariableReferences(ast, symbolTable) || false;
+
+ // Third pass: Clean up variable declarations that are no longer needed
+ changesMade = removeResolvedDeclarations(ast, symbolTable) || false;
+
+ iterations++;
+
+ } while (changesMade && iterations < MAX_ITERATIONS);
+}
+
+/**
+ * Find all variable definitions and track what they reference
+ * @param {Object} ast - jscodeshift AST
+ * @param {Map} symbolTable - Map to track variable references
+ */
+function findVariableDefinitions(ast, symbolTable) {
+ // Use a single traversal to handle both direct assignments and object destructuring
+ ast.find(j.VariableDeclarator).forEach(path => {
+ // Only process nodes that have an initializer
+ if (!path.value.init) return;
+
+ // Handle direct assignments: const response = pm.response
+ if (path.value.id.type === 'Identifier') {
+ const varName = path.value.id.name;
+
+ // If it's a direct identifier, just map it
+ if (path.value.init.type === 'Identifier') {
+ symbolTable.set(varName, {
+ type: 'identifier',
+ value: path.value.init.name
+ });
+ }
+ // If it's a member expression, store both parts
+ else if (path.value.init.type === 'MemberExpression') {
+ const sourceCode = getMemberExpressionString(path.value.init);
+ symbolTable.set(varName, {
+ type: 'memberExpression',
+ value: sourceCode,
+ node: path.value.init
+ });
+ }
+ }
+ // Handle object destructuring: const { response } = pm
+ else if (path.value.id.type === 'ObjectPattern' && path.value.init.type === 'Identifier') {
+ const source = path.value.init.name;
+
+ path.value.id.properties.forEach(prop => {
+ if (prop.key.name && prop.value.type === 'Identifier') {
+ const destVarName = prop.value.name;
+ symbolTable.set(destVarName, {
+ type: 'memberExpression',
+ value: `${source}.${prop.key.name}`,
+ node: j.memberExpression(
+ j.identifier(source),
+ j.identifier(prop.key.name)
+ )
+ });
+ }
+ });
+ }
+ });
+}
+
+/**
+ * Resolve variable references by replacing them with their original values
+ * @param {Object} ast - jscodeshift AST
+ * @param {Map} symbolTable - Map of variable references
+ * @returns {boolean} Whether any changes were made
+ */
+function resolveVariableReferences(ast, symbolTable) {
+ let changesMade = false;
+
+ /**
+ * Example of what this function does:
+ *
+ * Input Postman code:
+ * const response = pm.response;
+ * const jsonData = response.json(); // response is a reference to pm.response
+ *
+ * After resolution:
+ * const response = pm.response;
+ * const jsonData = pm.response.json(); // response reference is replaced with pm.response
+ *
+ * Then in the next preprocessing phase, unnecessary variables like 'response' will be removed.
+ */
+
+ // Replace all identifier references with their resolved values
+ ast.find(j.Identifier).forEach(path => {
+ const varName = path.value.name;
+
+ /**
+ * Skip specific types of identifiers that shouldn't be replaced:
+ *
+ * Case 1: Variable definitions (left side of declarations)
+ * -----------------------------------------------------
+ * In code like:
+ * const response = pm.response;
+ * ^
+ * We shouldn't replace 'response' on the left side with pm.response,
+ * which would result in: const pm.response = pm.response; (invalid syntax)
+ *
+ * Case 2: Property names in member expressions
+ * -----------------------------------------------------
+ * In code like:
+ * console.log(response.status);
+ * ^
+ * We shouldn't replace the 'status' property name with anything,
+ * only the 'response' object reference should be replaced.
+ *
+ * We only want to replace identifiers that are being used as references,
+ * not the ones being defined or used as property names.
+ */
+
+ // Skip if this is a variable definition or property name
+ if (path.parent.value.type === 'VariableDeclarator' && path.parent.value.id === path.value) {
+ return;
+ }
+ if (path.parent.value.type === 'MemberExpression' && path.parent.value.property === path.value && !path.parent.value.computed) {
+ return;
+ }
+
+ // Only replace if this is a known variable
+ if (!symbolTable.has(varName)) return;
+
+ const symbolInfo = symbolTable.get(varName);
+ if(!varInitsToReplace.has(symbolInfo.value)) {
+ return;
+ }
+ const newNode = cloneDeep(symbolInfo.node);
+ j(path).replaceWith(newNode);
+ symbolTable.set(varName, {
+ type: 'memberExpression',
+ value: symbolInfo.value,
+ node: newNode
+ });
+ changesMade = true;
+
+ });
+
+ return changesMade;
+}
+
+/**
+ * Remove variable declarations that have been resolved
+ * @param {Object} ast - jscodeshift AST
+ * @param {Map} symbolTable - Map of variable references
+ * @returns {boolean} Whether any changes were made
+ */
+function removeResolvedDeclarations(ast, symbolTable) {
+ let changesMade = false;
+
+ /**
+ * Example of what this function does:
+ *
+ * Original Postman code:
+ * const response = pm.response;
+ * const jsonData = response.json();
+ * console.log(jsonData.name);
+ *
+ * After variable resolution:
+ * const response = pm.response; // This declaration is now redundant
+ * const jsonData = pm.response.json(); // This value has been resolved
+ * console.log(jsonData.name); // This still references jsonData
+ *
+ * Final code after this cleanup step:
+ * const jsonData = pm.response.json(); // response variable declaration is removed
+ * console.log(jsonData.name); // jsonData is kept since it's still referenced
+ *
+ * We only remove declarations that:
+ * 1. Have been fully resolved (references to pm.* objects)
+ * 2. No longer provide any value (since all references were replaced with resolved values)
+ */
+
+ // Use a single traversal to handle both regular variable declarations and destructuring
+ ast.find(j.VariableDeclarator).forEach(path => {
+ // Case 1: Handle regular variable declarations
+ if (path.value.id.type === 'Identifier') {
+ const varName = path.value.id.name;
+ const replacement = symbolTable.get(varName);
+ if(!replacement || !varInitsToReplace.has(replacement.value)) return;
+
+ /**
+ * This code differentiates between two types of variable declarations:
+ *
+ * Example 1: Single variable declaration
+ * -----------------------------------
+ * Input: const response = pm.response;
+ * Action: The entire statement can be removed
+ * Output: [statement removed]
+ *
+ * Example 2: Multiple variables in one declaration
+ * -----------------------------------
+ * Input: const response = pm.response, unrelated = 5;
+ * Action: Only remove the 'response' declarator, keep the others
+ * Output: const unrelated = 5;
+ *
+ * We need this distinction to ensure we don't accidentally remove
+ * unrelated variables that happen to be declared in the same statement.
+ */
+ const declarationPath = j(path).closest(j.VariableDeclaration);
+ if (declarationPath.get().value.declarations.length === 1) {
+ declarationPath.remove();
+ } else {
+ // Otherwise just remove this declarator
+ j(path).remove();
+ }
+
+ changesMade = true;
+ }
+ // Case 2: Handle destructuring of pm
+ else if (path.value.id.type === 'ObjectPattern' &&
+ path.value.init &&
+ path.value.init.type === 'Identifier' &&
+ path.value.init.name === 'pm') {
+
+ /**
+ * Example of destructuring removal:
+ *
+ * Original Postman code:
+ * const { response, environment } = pm;
+ * console.log(response.json().name);
+ * console.log(environment.get("variable"));
+ *
+ * After variable resolution steps:
+ * const { response, environment } = pm; // This destructuring is now redundant
+ * console.log(pm.response.json().name); // 'response' references already replaced with pm.response
+ * console.log(pm.environment.get("variable")); // 'environment' references replaced
+ *
+ * Final code after this cleanup step:
+ * console.log(pm.response.json().name); // Destructuring declaration is completely removed
+ * console.log(pm.environment.get("variable"));
+ *
+ * This step specifically targets the Postman pattern of destructuring the pm object,
+ * which is common in Postman scripts but needs to be removed in the Bruno conversion.
+ */
+
+ const declarationPath = j(path).closest(j.VariableDeclaration);
+ if (declarationPath.get().value.declarations.length === 1) {
+ declarationPath.remove();
+ } else {
+ j(path).remove();
+ }
+
+ changesMade = true;
+ }
+ });
+
+ return changesMade;
+}
+
+/**
+ * Process cookie jar variable assignments and rename methods on those variables
+ * @param {Object} ast - jscodeshift AST
+ */
+function processCookieJarVariables(ast) {
+ // Map of Postman cookie jar method names to Bruno equivalents
+ const cookieMethodMapping = {
+ 'get': 'getCookie',
+ 'getAll': 'getCookies',
+ 'set': 'setCookie',
+ 'unset': 'deleteCookie',
+ 'clear': 'deleteCookies'
+ };
+
+ // Track variables that are assigned to cookie jar instances
+ const cookieJarVariables = new Set();
+
+ // First pass: Find all variables assigned to cookie jar instances
+ ast.find(j.VariableDeclarator).forEach(path => {
+ if (path.value.init && path.value.init.type === 'CallExpression') {
+ const initCall = path.value.init;
+
+ // Check if this is a cookie jar assignment
+ if (initCall.callee.type === 'MemberExpression') {
+ const calleeStr = getMemberExpressionString(initCall.callee);
+
+ if (calleeStr === 'pm.cookies.jar' || calleeStr === 'bru.cookies.jar') {
+ if (path.value.id.type === 'Identifier') {
+ cookieJarVariables.add(path.value.id.name);
+ }
+ }
+ }
+ }
+ });
+
+ // Second pass: Rename method calls on cookie jar variables
+ ast.find(j.CallExpression).forEach(path => {
+ if (path.value.callee.type === 'MemberExpression' &&
+ path.value.callee.object.type === 'Identifier' &&
+ path.value.callee.property.type === 'Identifier') {
+
+ const varName = path.value.callee.object.name;
+ const methodName = path.value.callee.property.name;
+
+ // If this is a method call on a cookie jar variable
+ if (cookieJarVariables.has(varName) && cookieMethodMapping[methodName]) {
+ const newMethodName = cookieMethodMapping[methodName];
+ path.value.callee.property.name = newMethodName;
+ }
+ }
+ });
+}
+
+/**
+ * Handle Postman's tests["..."] = ... syntax
+ * @param {Object} ast - jscodeshift AST
+ */
+function handleTestsBracketNotation(ast) {
+ // Find the ExpressionStatement that contains the assignment
+ ast.find(j.ExpressionStatement, {
+ expression: {
+ type: 'AssignmentExpression',
+ left: {
+ type: 'MemberExpression',
+ object: { name: 'tests' },
+ computed: true,
+ property: {} // Accept any property type
+ }
+ }
+ }).forEach(path => {
+ // Get the assignment expression
+ const assignment = path.value.expression;
+ const left = assignment.left;
+
+ // Verify it's a valid tests[] expression
+ if (left.object.type === 'Identifier' &&
+ left.object.name === 'tests' &&
+ left.computed === true) {
+
+ const property = left.property;
+ const rightSide = assignment.right;
+
+ // Handle string literals
+ if (property.type === 'Literal' && typeof property.value === 'string') {
+ const testName = property.value;
+
+ // Replace with test() function call
+ j(path).replaceWith(
+ j.expressionStatement(
+ j.callExpression(
+ j.identifier('test'),
+ [
+ j.literal(testName),
+ j.functionExpression(
+ null,
+ [],
+ j.blockStatement([
+ j.expressionStatement(
+ j.memberExpression(
+ j.callExpression(
+ j.identifier('expect'),
+ [
+ j.callExpression(
+ j.identifier('Boolean'),
+ [rightSide]
+ )
+ ]
+ ),
+ j.identifier('to.be.true')
+ )
+ )
+ ])
+ )
+ ]
+ )
+ )
+ );
+ }
+ // Handle template literals
+ else if (property.type === 'TemplateLiteral') {
+ // Create a template literal with the same quasi and expressions
+ const templateLiteral = j.templateLiteral(
+ property.quasis,
+ property.expressions
+ );
+
+ // Replace with test() function call using template literal
+ j(path).replaceWith(
+ j.expressionStatement(
+ j.callExpression(
+ j.identifier('test'),
+ [
+ templateLiteral,
+ j.functionExpression(
+ null,
+ [],
+ j.blockStatement([
+ j.expressionStatement(
+ j.memberExpression(
+ j.callExpression(
+ j.identifier('expect'),
+ [
+ j.callExpression(
+ j.identifier('Boolean'),
+ [rightSide]
+ )
+ ]
+ ),
+ j.identifier('to.be.true')
+ )
+ )
+ ])
+ )
+ ]
+ )
+ )
+ );
+ }
+ }
+ });
+}
+
+/**
+ * Handle legacy Postman global API transformations
+ * This function processes legacy Postman globals like responseBody, responseHeaders, responseTime
+ * while preserving user-defined variables with the same names
+ *
+ * @param {Object} ast - jscodeshift AST
+ * @param {Set} transformedNodes - Set of already transformed nodes
+ * @param {string} code - The original Postman script code
+ */
+function handleLegacyGlobalAPIs(ast, transformedNodes, code) {
+ // regex check before the ast traversal
+ const legacyGlobalRegex = /responseBody|responseHeaders|responseTime/;
+
+ if (!legacyGlobalRegex.test(code)) {
+ return;
+ }
+
+ // Check for variable declarations with legacy global names - track which ones have conflicts
+ const conflictingNames = new Set();
+
+ // Check variable declarations
+ ast.find(j.VariableDeclarator).forEach(path => {
+ if (path.value.id.type === 'Identifier') {
+ const varName = path.value.id.name;
+ if (legacyGlobalRegex.test(varName)) {
+ conflictingNames.add(varName);
+ }
+ }
+ });
+
+ // Handle JSON.parse(responseBody) → res.getBody()
+ // Only transform if responseBody doesn't have a user variable conflict
+ if (!conflictingNames.has('responseBody')) {
+ ast.find(j.CallExpression).forEach(path => {
+ if (transformedNodes.has(path.node)) return;
+
+ const callExpr = path.value;
+ if (callExpr.callee.type === 'MemberExpression' && callExpr.callee.object.name === 'JSON' && callExpr.callee.property.name === 'parse') {
+ const args = callExpr.arguments;
+
+ // Check if the argument is 'responseBody'
+ if (args.length > 0 && args[0].type === 'Identifier' && args[0].name === 'responseBody') {
+ // Replace JSON.parse(responseBody) with res.getBody()
+ j(path).replaceWith(j.identifier('res.getBody()'));
+ transformedNodes.add(path.node);
+ }
+ }
+ });
+ }
+
+ // Handle standalone legacy Postman global variables
+ const legacyGlobals = [
+ { name: 'responseBody', replacement: 'res.getBody()' },
+ { name: 'responseHeaders', replacement: 'res.getHeaders()' },
+ { name: 'responseTime', replacement: 'res.getResponseTime()' }
+ ];
+
+ legacyGlobals.forEach(({ name, replacement }) => {
+ // Skip transformation if this name has a user variable conflict
+ if (conflictingNames.has(name)) {
+ return;
+ }
+
+ ast.find(j.Identifier, { name }).forEach(path => {
+ if (transformedNodes.has(path.node)) return;
+
+ // Only transform identifiers that are being used as values, not as variable names
+ const parent = path.parent.value;
+
+ // Skip if this is part of a variable declaration (const responseBody = ...)
+ if (parent.type === 'VariableDeclarator' && parent.id === path.node) {
+ return; // Keep unchanged
+ }
+
+ // Skip if this is part of an assignment (responseBody = ...)
+ if (parent.type === 'AssignmentExpression' && parent.left === path.node) {
+ return; // Keep unchanged
+ }
+
+ // Skip if this is part of a function parameter
+ if (parent.type === 'FunctionDeclaration' || parent.type === 'FunctionExpression') {
+ return; // Keep unchanged
+ }
+
+ // Skip if this is part of an object property
+ if (parent.type === 'Property' && (parent.key === path.node || parent.value === path.node)) {
+ return; // Keep unchanged
+ }
+
+ // Transform all other references (including function call arguments)
+ // This will transform console.log(responseBody) → console.log(res.getBody())
+ j(path).replaceWith(j.identifier(replacement));
+ transformedNodes.add(path.node);
+ });
+ });
+}
+
+export { getMemberExpressionString };
+export default translateCode;
\ No newline at end of file
diff --git a/packages/bruno-converters/src/utils/send-request-transformer.js b/packages/bruno-converters/src/utils/send-request-transformer.js
new file mode 100644
index 000000000..4f16c4311
--- /dev/null
+++ b/packages/bruno-converters/src/utils/send-request-transformer.js
@@ -0,0 +1,330 @@
+/**
+ * Convert Postman header array format to Bruno headers object
+ * @param {Object} j - jscodeshift API
+ * @param {Object} arrayValue - Array expression of key-value pair objects
+ * @returns {Object} - Object expression with key-value pairs
+ */
+const convertArrayToObject = (j, arrayValue) => {
+ const obj = j.objectExpression([]);
+
+ if (arrayValue.type === 'ArrayExpression') {
+ arrayValue.elements.forEach(elem => {
+ if (elem.type === 'ObjectExpression') {
+ const keyProp = elem.properties.find(p => (p.key.name === 'key' || p.key.value === 'key'));
+ const valueProp = elem.properties.find(p => (p.key.name === 'value' || p.key.value === 'value'));
+
+ if (keyProp && valueProp) {
+ obj.properties.push(
+ j.property(
+ 'init',
+ j.literal(keyProp.value.value),
+ valueProp.value
+ )
+ );
+ }
+ }
+ });
+ }
+
+ return obj;
+};
+
+/**
+ * Add or update a specific header in the request options
+ * @param {Object} j - jscodeshift API
+ * @param {Object} requestOptions - Request options object
+ * @param {string} headerName - Header name to add/update
+ * @param {string} headerValue - Header value
+ */
+const addOrUpdateHeader = (j, requestOptions, headerName, headerValue) => {
+ let headersProp = requestOptions.properties.find(p => (p.key.name === 'headers' || p.key.value === 'headers'));
+
+ if (!headersProp) {
+ headersProp = j.property('init', j.identifier('headers'), j.objectExpression([]));
+ requestOptions.properties.push(headersProp);
+ } else if (headersProp.value.type !== 'ObjectExpression') {
+ headersProp.value = j.objectExpression([]);
+ }
+
+ // filter out existing header with same name (case-insensitive)
+ headersProp.value.properties = headersProp.value.properties.filter(p =>
+ p.key.type !== 'Literal' ||
+ p.key.value.toLowerCase() !== headerName.toLowerCase()
+ );
+
+ headersProp.value.properties.push(
+ j.property(
+ 'init',
+ j.literal(headerName),
+ j.literal(headerValue)
+ )
+ );
+};
+
+/**
+ * Transform headers property from array to object format
+ * @param {Object} j - jscodeshift API
+ * @param {Object} requestOptions - Request options object
+ */
+const transformHeaders = (j, requestOptions) => {
+ if (requestOptions.type !== 'ObjectExpression') return;
+
+ requestOptions.properties.forEach(prop => {
+ // find and rename 'header' property to 'headers'
+ if (prop.key.name === 'header' || prop.key.value === 'header') {
+ prop.key.name = 'headers';
+ prop.key.value = 'headers';
+
+ // Handle array of header objects
+ if (prop.value.type === 'ArrayExpression') {
+ prop.value = convertArrayToObject(j, prop.value);
+ }
+ }
+ });
+};
+
+/**
+ * Transform body property based on body mode
+ * @param {Object} j - jscodeshift API
+ * @param {Object} requestOptions - Request options object
+ * @returns {Array|null} - Array of statements if formdata is used, null otherwise
+ */
+const transformBody = (j, requestOptions) => {
+ if (requestOptions.type !== 'ObjectExpression') return null;
+
+ requestOptions.properties.forEach(prop => {
+ if (prop.key.name === 'body' || prop.key.value === 'body') {
+ if (prop.value.type === 'ObjectExpression') {
+ const bodyProps = prop.value.properties;
+ const modeProp = bodyProps.find(p => (p.key.name === 'mode' || p.key.value === 'mode'));
+
+ if (modeProp && modeProp.value.type === 'Literal') {
+ const bodyMode = modeProp.value.value;
+
+ // Handle raw mode (text, json, xml, etc.)
+ if (bodyMode === 'raw') {
+ const rawProp = bodyProps.find(p => (p.key.name === 'raw' || p.key.value === 'raw'));
+
+ if (rawProp) {
+ // Replace body with data
+ prop.key.name = 'data';
+ prop.key.value = 'data';
+ prop.value = rawProp.value;
+ }
+ }
+ // Handle urlencoded mode
+ else if (bodyMode === 'urlencoded') {
+ const urlencodedProp = bodyProps.find(p => (p.key.name === 'urlencoded' || p.key.value === 'urlencoded') && p.value.type === 'ArrayExpression');
+
+ if (urlencodedProp) {
+ // Replace the body property with a 'data' property
+ prop.key.name = 'data';
+ prop.key.value = 'data';
+
+ // Transform the urlencoded array to an object
+ prop.value = convertArrayToObject(j, urlencodedProp.value);
+
+ // Add Content-Type header for urlencoded
+ addOrUpdateHeader(j, requestOptions, 'Content-Type', 'application/x-www-form-urlencoded');
+ }
+ }
+ // Handle formdata mode
+ else if (bodyMode === 'formdata') {
+ const formdataProp = bodyProps.find(p => (p.key.name === 'formdata' || p.key.value === 'formdata') && p.value.type === 'ArrayExpression');
+
+ if (formdataProp) {
+ // Replace the body property with a 'data' property
+ prop.key.name = 'data';
+ prop.key.value = 'data';
+
+ // Transform the urlencoded array to an object
+ prop.value = convertArrayToObject(j, formdataProp.value);
+
+ // Add Content-Type header for urlencoded
+ addOrUpdateHeader(j, requestOptions, 'Content-Type', 'multipart/form-data');
+ }
+ }
+ }
+ }
+ }
+ });
+};
+
+/**
+ * Transform callback function to Bruno format
+ * @param {Object} j - jscodeshift API
+ * @param {Object} callback - Callback function expression
+ * @returns {Object} - Transformed callback function
+ */
+const transformCallback = (j, callback) => {
+ if (!callback || (callback.type !== 'FunctionExpression' && callback.type !== 'ArrowFunctionExpression')) return null;
+
+ const params = callback.params;
+ const callbackBody = callback.body;
+
+ // Get the response parameter name (typically the second param)
+ let responseVarName = 'response'; // Default if not found
+ if (params.length >= 2 && params[1].type === 'Identifier') {
+ responseVarName = params[1].name;
+ }
+
+ let errorVarName = 'error'; // Default if not found
+ if (params.length >= 1 && params[0].type === 'Identifier') {
+ errorVarName = params[0].name;
+ }
+
+ // Define translations for callback response properties
+ const responsePropertyMap = {
+ 'json': 'data',
+ 'text': 'data',
+ 'code': 'status',
+ 'status': 'statusText',
+ };
+
+ // Process the callback body to transform response property references
+ j(callbackBody).find(j.MemberExpression, {
+ object: {
+ type: 'Identifier',
+ name: responseVarName
+ }
+ }).forEach(memberPath => {
+ const property = memberPath.node.property;
+
+ // Handle property access
+ if (property.type === 'Identifier' && responsePropertyMap[property.name]) {
+ const bruProperty = responsePropertyMap[property.name];
+ if (bruProperty) {
+ // Check if memberPath is part of a CallExpression
+ const parentPath = memberPath.parent;
+ if (parentPath && parentPath.node.type === 'CallExpression') {
+ // Replace the entire CallExpression with a property access
+ j(parentPath).replaceWith(
+ j.memberExpression(
+ j.identifier(responseVarName),
+ j.identifier(bruProperty)
+ )
+ );
+ } else {
+ // Regular property access replacement
+ j(memberPath).replaceWith(
+ j.memberExpression(
+ j.identifier(responseVarName),
+ j.identifier(bruProperty)
+ )
+ );
+ }
+ }
+ }
+ });
+
+ // Create the callback block
+ return j.functionExpression(
+ null,
+ [j.identifier(errorVarName), j.identifier(responseVarName)],
+ j.blockStatement(callbackBody.body)
+ );
+};
+
+/**
+ * Find and transform variable declaration for request config
+ * @param {Object} j - jscodeshift API
+ * @param {Object} root - Root AST node
+ * @param {string} variableName - Name of the variable to find
+ * @param {Set} visited - Set of visited variable names to prevent infinite loops
+ * @returns {Object|null} - Transformed object expression or null if not found
+ */
+const findAndTransformVariableDeclaration = (j, root, variableName, visited = new Set()) => {
+ // Prevent infinite loops from circular references
+ if (visited.has(variableName)) {
+ return null;
+ }
+ visited.add(variableName);
+
+ let transformedConfig = null;
+
+ // Find the variable declaration
+ root.find(j.VariableDeclarator, {
+ id: { name: variableName }
+ }).forEach(declaratorPath => {
+ const init = declaratorPath.value.init;
+
+ if (init && init.type === 'ObjectExpression') {
+ // Found the actual object expression - clone and transform it
+ const configClone = j(init).at(0).get().value;
+
+ // Transform headers and body
+ transformHeaders(j, configClone);
+ transformBody(j, configClone);
+
+ transformedConfig = configClone;
+ }
+ else if (init && init.type === 'Identifier') {
+ // This variable references another variable - follow the chain
+ const referencedVariableName = init.name;
+ transformedConfig = findAndTransformVariableDeclaration(j, root, referencedVariableName, visited);
+ }
+ });
+
+ return transformedConfig;
+};
+
+const sendRequestTransformer = (path, j) => {
+ const callExpr = path.parent.value;
+ if (callExpr.type !== 'CallExpression') return;
+
+ // Clone the argument object for modification
+ const args = [...callExpr.arguments];
+ if (!args.length) return;
+
+ const requestOptions = args[0];
+ const callback = args[1];
+
+ // Check if original call was awaited
+ const wasAwaited = path.parent.parent.value.type === 'AwaitExpression';
+
+ // transform the request config options
+ if (requestOptions.type === 'ObjectExpression') {
+ // Transform headers
+ transformHeaders(j, requestOptions);
+ // Transform body
+ transformBody(j, requestOptions);
+ }
+ // Handle case where requestOptions is a variable reference
+ else if (requestOptions.type === 'Identifier') {
+ const variableName = requestOptions.name;
+
+ // Find the root of the current file/program
+ const root = j(path).closest(j.Program);
+
+ // Find and transform the variable declaration
+ findAndTransformVariableDeclaration(j, root, variableName);
+ }
+
+ // Create the callback block and promise chain if there's a callback
+ if (callback) {
+ const transformedCallback = transformCallback(j, callback);
+
+ // Add async keyword to the callback function
+ if (transformedCallback && (transformedCallback.type === 'FunctionExpression' || transformedCallback.type === 'ArrowFunctionExpression')) {
+ transformedCallback.async = true;
+ }
+
+ // Create expression: await bru.sendRequest(requestConfig, callback);
+ const sendRequestCall = j.callExpression(
+ j.identifier('bru.sendRequest'),
+ transformedCallback ? [requestOptions, transformedCallback] : [requestOptions]
+ );
+
+ return wasAwaited ? sendRequestCall : j.awaitExpression(sendRequestCall);
+ }
+
+ // If there's no callback, just transform to await bru.sendRequest
+ const sendRequestCall = j.callExpression(
+ j.identifier('bru.sendRequest'),
+ [requestOptions]
+ );
+
+ return wasAwaited ? sendRequestCall : j.awaitExpression(sendRequestCall);
+};
+
+export default sendRequestTransformer;
\ No newline at end of file
diff --git a/packages/bruno-converters/src/workers/postman-translator-worker.js b/packages/bruno-converters/src/workers/postman-translator-worker.js
new file mode 100644
index 000000000..1c9ebea79
--- /dev/null
+++ b/packages/bruno-converters/src/workers/postman-translator-worker.js
@@ -0,0 +1,211 @@
+const { Worker } = require('node:worker_threads');
+const path = require('node:path');
+const os = require('node:os');
+
+function getMaxWorkers() {
+ return Math.max(os.availableParallelism(), 1)
+}
+
+class WorkerPool {
+ constructor(scriptPath, size) {
+ this.workers = [];
+ this.idle = [];
+ this.queue = [];
+ this.scriptPath = scriptPath;
+ this.size = size;
+ }
+
+ // Initialize the worker pool
+ initialize() {
+ for (let i = 0; i < this.size; i++) {
+ const worker = new Worker(this.scriptPath);
+ this.workers.push(worker);
+ this.idle.push(i);
+ }
+ }
+
+ // Run a task on a worker
+ runTask(data) {
+ return new Promise((resolve, reject) => {
+ const task = { data, resolve, reject };
+
+ if (this.idle.length > 0) {
+ this._runTaskOnWorker(this.idle.shift(), task);
+ } else {
+ this.queue.push(task);
+ }
+ });
+ }
+
+ // Run a task on a specific worker
+ _runTaskOnWorker(workerId, task) {
+ const worker = this.workers[workerId];
+
+ const messageHandler = (result) => {
+ // Cleanup listeners
+ worker.removeListener('message', messageHandler);
+ worker.removeListener('error', errorHandler);
+
+ // Mark worker as idle
+ this.idle.push(workerId);
+
+ // Process queue if tasks are waiting
+ if (this.queue.length > 0) {
+ this._runTaskOnWorker(workerId, this.queue.shift());
+ }
+
+ // Resolve the task
+ task.resolve(result);
+ };
+
+ const errorHandler = (err) => {
+ worker.removeListener('message', messageHandler);
+ worker.removeListener('error', errorHandler);
+
+ this.idle.push(workerId);
+
+ if (this.queue.length > 0) {
+ this._runTaskOnWorker(workerId, this.queue.shift());
+ }
+
+ task.reject(err);
+ };
+
+ worker.on('message', messageHandler);
+ worker.on('error', errorHandler);
+ worker.postMessage(task.data);
+ }
+
+ // Terminate all workers
+ terminate() {
+ for (const worker of this.workers) {
+ worker.terminate();
+ }
+ this.workers = [];
+ this.idle = [];
+ }
+}
+
+// Helper function to count lines in a script
+function countScriptLines(script) {
+ if (!script) return 0;
+ return Array.isArray(script) ? script.length : script.split('\n').length;
+}
+
+// Calculate complexity of a script entry
+function calculateScriptComplexity([uid, entry]) {
+ let totalLines = 0;
+ const { events } = entry
+
+ if (events && Array.isArray(events)) {
+ events.forEach(({ script }) => {
+ if (script && script.exec) {
+ totalLines += countScriptLines(script.exec);
+ }
+ });
+ }
+
+ return { uid, entry, complexity: totalLines || 1 }; // Minimum complexity of 1
+}
+
+// Create balanced batches based on script complexity
+function createBalancedBatches(scriptEntries, workerCount) {
+ // Calculate complexity for each script
+ const scriptsWithComplexity = scriptEntries.map(calculateScriptComplexity);
+
+ // Sort scripts by complexity (descending)
+ scriptsWithComplexity.sort((a, b) => b.complexity - a.complexity);
+
+ // Initialize batches
+ const batches = Array.from({ length: workerCount }, () => ({
+ entries: [],
+ totalComplexity: 0
+ }));
+
+ // Algorithm: Greedy load balancing
+ // 1. Process scripts in descending order of complexity
+ // 2. Always assign each script to the batch with lowest current load
+ // 3. This minimizes the maximum workload across all workers
+ for (const { uid, entry, complexity } of scriptsWithComplexity) {
+
+ const batchWithLowestComplexity = batches.reduce(
+ (target, current) => current.totalComplexity < target.totalComplexity ? current : target
+ );
+
+ // Add the script to this batch
+ batchWithLowestComplexity.entries.push({uid, entry});
+ batchWithLowestComplexity.totalComplexity += complexity;
+ }
+
+ return batches.map(batch =>
+ batch.entries.map(({ uid, entry }) => [uid, entry])
+ ).filter(batch => batch.length > 0);
+}
+
+const scriptTranslationWorker = async (scriptMap) => {
+ // Convert the Map to an array of entries
+ const scriptEntries = Array.from(scriptMap.entries());
+ const maxWorkers = getMaxWorkers();
+
+ // For very small collections, don't parallelize
+ if (scriptEntries.length <= 50) {
+ const workerPool = new WorkerPool(path.join(__dirname,'./src/workers/scripts/translate-postman-scripts.js'), 1);
+ workerPool.initialize();
+
+ try {
+ const translatedScripts = new Map();
+ const result = await workerPool.runTask({ scripts: scriptEntries });
+
+ if (result.error) {
+ console.error('Error in script translation worker:', result.error);
+ throw new Error(result.error);
+ }
+
+ result.forEach(([uid, { request }]) => {
+ translatedScripts.set(uid, { request });
+ });
+
+ return translatedScripts;
+ } finally {
+ workerPool.terminate();
+ }
+ }
+
+
+ const workerCount = Math.min(maxWorkers, 4);
+
+ // Create balanced batches based on script complexity
+ const batches = createBalancedBatches(scriptEntries, workerCount);
+
+ const translatedScripts = new Map();
+
+ // Create worker pool with optimal size
+ const workerPool = new WorkerPool(path.join(__dirname,'./src/workers/scripts/translate-postman-scripts.js'), workerCount);
+ workerPool.initialize();
+
+ // Process all batches in parallel using worker pool
+ const batchPromises = batches.map(batch => {
+ return workerPool.runTask({ scripts: batch })
+ .then(modScripts => {
+ modScripts.forEach(([name, { request }]) => {
+ translatedScripts.set(name, { request });
+ });
+ })
+ .catch(err => {
+ console.error('Error in script translation worker:', err);
+ throw new Error(err);
+ });
+ });
+
+ // Wait for all batches to complete
+ try {
+ await Promise.allSettled(batchPromises);
+ } finally {
+ // Clean up worker pool
+ workerPool.terminate();
+ }
+
+ return translatedScripts;
+};
+
+export default scriptTranslationWorker
\ No newline at end of file
diff --git a/packages/bruno-converters/src/workers/scripts/translate-postman-scripts.js b/packages/bruno-converters/src/workers/scripts/translate-postman-scripts.js
new file mode 100644
index 000000000..816a08f03
--- /dev/null
+++ b/packages/bruno-converters/src/workers/scripts/translate-postman-scripts.js
@@ -0,0 +1,43 @@
+const { parentPort } = require('node:worker_threads');
+const { postmanTranslation } = require('@usebruno/converters');
+
+parentPort.on('message', (workerData) => {
+ try {
+ const { scripts } = workerData;
+ const modScripts = scripts.map(([uid, { events }]) => {
+ const requestObject = {
+ script: {}
+ }
+
+ if (events && Array.isArray(events)) {
+ events.forEach((event) => {
+ if(event?.script && event.script.exec) {
+ if(event.listen === 'prerequest') {
+ if(event.script.exec && event.script.exec.length > 0) {
+ requestObject.script.req = postmanTranslation(event.script.exec);
+ } else {
+ requestObject.script.req = '';
+ }
+ }
+
+ if(event.listen === 'test') {
+ if(event.script.exec && event.script.exec.length > 0) {
+ requestObject.script.res = postmanTranslation(event.script.exec);
+ } else {
+ requestObject.script.res = '';
+ }
+ }
+ }
+ });
+ }
+
+ return [uid, { request: requestObject }];
+ });
+
+ parentPort.postMessage(modScripts);
+ }
+ catch(error) {
+ console.error(error);
+ parentPort.postMessage({ error: error?.message });
+ }
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/insomnia/insomnia-collection-v5.spec.js b/packages/bruno-converters/tests/insomnia/insomnia-collection-v5.spec.js
new file mode 100644
index 000000000..3d620d1db
--- /dev/null
+++ b/packages/bruno-converters/tests/insomnia/insomnia-collection-v5.spec.js
@@ -0,0 +1,165 @@
+import { describe, it, expect } from '@jest/globals';
+import insomniaToBruno from '../../src/insomnia/insomnia-to-bruno';
+
+describe('insomnia-collection', () => {
+ it('should correctly import a valid Insomnia v5 collection file', async () => {
+ const brunoCollection = insomniaToBruno(insomniaCollection);
+
+ expect(brunoCollection).toMatchObject(expectedOutput)
+ });
+});
+
+const insomniaCollection = `
+type: collection.insomnia.rest/5.0
+name: Hello World Workspace Insomnia
+meta:
+ id: wrk_9381cf78cb0a4eaaab1d571f29f928dc
+ created: 1744194421962
+ modified: 1744194421962
+collection:
+ - name: Folder1
+ meta:
+ id: fld_6beacec0bd2f4370be98169217e82a2c
+ created: 1744194421968
+ modified: 1744194421968
+ sortKey: -1744194421968
+ children:
+ - url: https://httpbin.org/get
+ name: Request1
+ meta:
+ id: req_e9fbdc9c88984068a04f442e052d4ff1
+ created: 1744194421965
+ modified: 1744194421965
+ isPrivate: false
+ sortKey: -1744194421965
+ method: GET
+ settings:
+ renderRequestBody: true
+ encodeUrl: true
+ followRedirects: global
+ cookies:
+ send: true
+ store: true
+ rebuildPath: true
+ - name: Folder2
+ meta:
+ id: fld_96508d79bf06420a853b07482ab280d7
+ created: 1744194421969
+ modified: 1744194421969
+ sortKey: -1744194421969
+ children:
+ - url: https://httpbin.org/get
+ name: Request2
+ meta:
+ id: req_3c572aa26a964f1f800bfa5c53cacb75
+ created: 1744194421967
+ modified: 1744194421967
+ isPrivate: false
+ sortKey: -1744194421968
+ method: GET
+ settings:
+ renderRequestBody: true
+ encodeUrl: false
+ followRedirects: global
+ cookies:
+ send: true
+ store: true
+ rebuildPath: true
+cookieJar:
+ name: Default Jar
+ meta:
+ id: jar_9ecb97079037c7d5bb888f0bfdec9b0e1275c6d1
+ created: 1744194421971
+ modified: 1744194421971
+environments:
+ name: Imported Environment
+ meta:
+ id: env_a8a9a8ff952d4d079edf53f8ee22a423
+ created: 1744194421970
+ modified: 1744194421970
+ isPrivate: false
+ data:
+ var1: value1
+ var2: value2
+`
+
+const expectedOutput = {
+ "environments": [],
+ "items": [
+ {
+ "items": [
+ {
+ "name": "Request1",
+ "request": {
+ "auth": {
+ "basic": null,
+ "bearer": null,
+ "digest": null,
+ "mode": "none",
+ },
+ "body": {
+ "formUrlEncoded": [],
+ "json": null,
+ "mode": "none",
+ "multipartForm": [],
+ "text": null,
+ "xml": null,
+ },
+ "headers": [],
+ "method": "GET",
+ "params": [],
+ "url": "https://httpbin.org/get",
+ },
+ "seq": 1,
+ "type": "http-request",
+ "uid": "mockeduuidvalue123456",
+ "settings": {
+ "encodeUrl": true,
+ },
+ },
+ ],
+ "name": "Folder1",
+ "type": "folder",
+ "uid": "mockeduuidvalue123456",
+ },
+ {
+ "items": [
+ {
+ "name": "Request2",
+ "request": {
+ "auth": {
+ "basic": null,
+ "bearer": null,
+ "digest": null,
+ "mode": "none",
+ },
+ "body": {
+ "formUrlEncoded": [],
+ "json": null,
+ "mode": "none",
+ "multipartForm": [],
+ "text": null,
+ "xml": null,
+ },
+ "headers": [],
+ "method": "GET",
+ "params": [],
+ "url": "https://httpbin.org/get",
+ },
+ "seq": 1,
+ "type": "http-request",
+ "uid": "mockeduuidvalue123456",
+ "settings": {
+ "encodeUrl": false,
+ },
+ },
+ ],
+ "name": "Folder2",
+ "type": "folder",
+ "uid": "mockeduuidvalue123456",
+ },
+ ],
+ "name": "Hello World Workspace Insomnia",
+ "uid": "mockeduuidvalue123456",
+ "version": "1",
+};
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/insomnia/insomnia-collection.spec.js b/packages/bruno-converters/tests/insomnia/insomnia-collection.spec.js
new file mode 100644
index 000000000..03df7e44f
--- /dev/null
+++ b/packages/bruno-converters/tests/insomnia/insomnia-collection.spec.js
@@ -0,0 +1,204 @@
+import { describe, it, expect } from '@jest/globals';
+import insomniaToBruno from '../../src/insomnia/insomnia-to-bruno';
+
+describe('insomnia-collection', () => {
+ it('should correctly import a valid Insomnia collection file', async () => {
+ const brunoCollection = insomniaToBruno(insomniaCollection);
+
+ expect(brunoCollection).toMatchObject(expectedOutput)
+ });
+});
+
+const insomniaCollection = {
+ "_type": "export",
+ "__export_format": 4,
+ "__export_date": "2024-05-20T10:02:44.123Z",
+ "__export_source": "insomnia.desktop.app:v2021.5.2",
+ "resources": [
+ {
+ "_id": "req_1",
+ "_type": "request",
+ "parentId": "fld_1",
+ "name": "Request1",
+ "method": "GET",
+ "url": "https://httpbin.org/get",
+ "settingEncodeUrl": false,
+ "parameters": []
+ },
+ {
+ "_id": "req_2",
+ "_type": "request",
+ "parentId": "fld_2",
+ "name": "Request2",
+ "method": "GET",
+ "url": "https://httpbin.org/get",
+ "settingEncodeUrl": true,
+ "parameters": []
+ },
+ {
+ "_id": "fld_1",
+ "_type": "request_group",
+ "parentId": "wrk_1",
+ "name": "Folder1"
+ },
+ {
+ "_id": "fld_2",
+ "_type": "request_group",
+ "parentId": "wrk_1",
+ "name": "Folder2"
+ },
+ {
+ "_id": "wrk_1",
+ "_type": "workspace",
+ "name": "Hello World Workspace Insomnia"
+ },
+ {
+ "_id": "env_1",
+ "_type": "environment",
+ "parentId": "wrk_1",
+ "data": {
+ "var1": "value1",
+ "var2": "value2"
+ }
+ }
+ ]
+};
+
+const expectedOutput = {
+ "environments": [],
+ "items": [
+ {
+ "items": [
+ {
+ "name": "Request1",
+ "request": {
+ "auth": {
+ "basic": null,
+ "bearer": null,
+ "digest": null,
+ "mode": "none",
+ },
+ "body": {
+ "formUrlEncoded": [],
+ "json": null,
+ "mode": "none",
+ "multipartForm": [],
+ "text": null,
+ "xml": null,
+ },
+ "headers": [],
+ "method": "GET",
+ "params": [],
+ "url": "https://httpbin.org/get",
+ },
+ "seq": 1,
+ "type": "http-request",
+ "uid": "mockeduuidvalue123456",
+ "settings": {
+ "encodeUrl": false,
+ },
+ },
+ {
+ "name": "Request1",
+ "request": {
+ "auth": {
+ "basic": null,
+ "bearer": null,
+ "digest": null,
+ "mode": "none",
+ },
+ "body": {
+ "formUrlEncoded": [],
+ "json": null,
+ "mode": "none",
+ "multipartForm": [],
+ "text": null,
+ "xml": null,
+ },
+ "headers": [],
+ "method": "GET",
+ "params": [],
+ "url": "https://httpbin.org/get",
+ },
+ "seq": 2,
+ "type": "http-request",
+ "uid": "mockeduuidvalue123456",
+ "settings": {
+ "encodeUrl": false,
+ },
+ },
+ ],
+ "name": "Folder1",
+ "type": "folder",
+ "uid": "mockeduuidvalue123456",
+ },
+ {
+ "items": [
+ {
+ "name": "Request2",
+ "request": {
+ "auth": {
+ "basic": null,
+ "bearer": null,
+ "digest": null,
+ "mode": "none",
+ },
+ "body": {
+ "formUrlEncoded": [],
+ "json": null,
+ "mode": "none",
+ "multipartForm": [],
+ "text": null,
+ "xml": null,
+ },
+ "headers": [],
+ "method": "GET",
+ "params": [],
+ "url": "https://httpbin.org/get",
+ },
+ "seq": 1,
+ "type": "http-request",
+ "uid": "mockeduuidvalue123456",
+ "settings": {
+ "encodeUrl": true,
+ },
+ },
+ {
+ "name": "Request2",
+ "request": {
+ "auth": {
+ "basic": null,
+ "bearer": null,
+ "digest": null,
+ "mode": "none",
+ },
+ "body": {
+ "formUrlEncoded": [],
+ "json": null,
+ "mode": "none",
+ "multipartForm": [],
+ "text": null,
+ "xml": null,
+ },
+ "headers": [],
+ "method": "GET",
+ "params": [],
+ "url": "https://httpbin.org/get",
+ },
+ "seq": 2,
+ "type": "http-request",
+ "uid": "mockeduuidvalue123456",
+ "settings": {
+ "encodeUrl": true,
+ },
+ },
+ ],
+ "name": "Folder2",
+ "type": "folder",
+ "uid": "mockeduuidvalue123456",
+ },
+ ],
+ "name": "Hello World Workspace Insomnia",
+ "uid": "mockeduuidvalue123456",
+ "version": "1",
+};
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/openapi/openapi-to-bruno/openapi-circular-references.spec.js b/packages/bruno-converters/tests/openapi/openapi-to-bruno/openapi-circular-references.spec.js
new file mode 100644
index 000000000..debaedc72
--- /dev/null
+++ b/packages/bruno-converters/tests/openapi/openapi-to-bruno/openapi-circular-references.spec.js
@@ -0,0 +1,248 @@
+import { describe, it, expect } from '@jest/globals';
+import openApiToBruno from '../../../src/openapi/openapi-to-bruno';
+
+describe('openapi-circular-references', () => {
+ it('should handle simple circular references in schema correctly', async () => {
+ const brunoCollection = openApiToBruno(circularRefsData);
+
+ expect(brunoCollection).toMatchObject(circularRefsOutput);
+ });
+
+ it('should handle complex circular reference chains correctly', async () => {
+ const brunoCollection = openApiToBruno(complexCircularRefsData);
+
+ expect(brunoCollection).toMatchObject(circularRefsOutput);
+ });
+});
+
+const circularRefsData = {
+ "components": {
+ "schemas": {
+ "schema_1": {
+ "additionalProperties": false,
+ "description": "schema_1",
+ "properties": {
+ "conditions": {
+ "$ref": "#/components/schemas/schema_1"
+ }
+ },
+ "type": "object"
+ },
+ "schema_2": {
+ "additionalProperties": false,
+ "description": "schema_2",
+ "properties": {
+ "conditionGroup": {
+ "description": "nested schema_1",
+ "items": { "$ref": "#/components/schemas/schema_1" },
+ "type": "array"
+ },
+ "operation": {
+ "description": "operation",
+ "enum": ["ANY", "ALL"],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "info": {
+ "description": "circular reference openapi sample json spec",
+ "title": "circular reference openapi sample json spec",
+ "version": "0.1"
+ },
+ "openapi": "3.0.1",
+ "paths": {
+ "/": {
+ "post": {
+ "deprecated": false,
+ "description": "echo ping api",
+ "operationId": "echo ping",
+ "parameters": [],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/schema_1"
+ }
+ }
+ },
+ "description": "echo ping api",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "example": "ping"
+ }
+ },
+ "description": "Returned if the request is successful."
+ }
+ }
+ }
+ }
+ },
+ "servers": [{ "url": "https://echo.usebruno.com" }]
+};
+
+// More complex circular reference test with a longer chain
+const complexCircularRefsData = {
+ "components": {
+ "schemas": {
+ "schema_1": {
+ "additionalProperties": false,
+ "description": "schema_1",
+ "properties": {
+ "conditionGroup": {
+ "description": "nested schema_1",
+ "items": { "$ref": "#/components/schemas/schema_2" },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "schema_2": {
+ "additionalProperties": false,
+ "description": "schema_2",
+ "properties": {
+ "conditionGroup": {
+ "description": "nested schema_2",
+ "items": { "$ref": "#/components/schemas/schema_3" },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "schema_3": {
+ "additionalProperties": false,
+ "description": "schema_3",
+ "properties": {
+ "conditionGroup": {
+ "description": "nested schema_3",
+ "items": { "$ref": "#/components/schemas/schema_4" },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "schema_4": {
+ "additionalProperties": false,
+ "description": "schema_4",
+ "properties": {
+ "conditionGroup": {
+ "description": "nested schema_4",
+ "items": { "$ref": "#/components/schemas/schema_5" },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "schema_5": {
+ "additionalProperties": false,
+ "description": "schema_4",
+ "properties": {
+ "conditionGroup": {
+ "description": "nested schema_5",
+ "items": { "$ref": "#/components/schemas/schema_1" },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "schema_6": {
+ "additionalProperties": false,
+ "description": "schema_3",
+ "properties": {
+ "conditionGroup": {
+ "description": "nested schema_3",
+ "items": { "$ref": "#/components/schemas/schema_1" },
+ "type": "array"
+ },
+ "operation": {
+ "description": "operation",
+ "enum": ["ANY", "ALL"],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "info": {
+ "description": "circular reference openapi sample json spec",
+ "title": "circular reference openapi sample json spec",
+ "version": "0.1"
+ },
+ "openapi": "3.0.1",
+ "paths": {
+ "/": {
+ "post": {
+ "deprecated": false,
+ "description": "echo ping api",
+ "operationId": "echo ping",
+ "parameters": [],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/schema_1"
+ }
+ }
+ },
+ "description": "echo ping api",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "example": "ping"
+ }
+ },
+ "description": "Returned if the request is successful."
+ }
+ }
+ }
+ }
+ },
+ "servers": [{ "url": "https://echo.usebruno.com" }]
+};
+
+const circularRefsOutput = {
+ "environments": [
+ {
+ "name": "Environment 1",
+ "variables": [
+ {
+ "enabled": true,
+ "name": "baseUrl",
+ "secret": false,
+ "type": "text",
+ "value": "https://echo.usebruno.com",
+ },
+ ],
+ },
+ ],
+ "items": [
+ {
+ "name": "echo ping",
+ "type": "http-request",
+ "request": {
+ "url": "{{baseUrl}}/",
+ "method": "POST",
+ "auth": {
+ "mode": "inherit",
+ },
+ "headers": [],
+ "params": [],
+ "body": {
+ "mode": "json",
+ }
+ },
+ },
+ ],
+ "name": "circular reference openapi sample json spec",
+ "version": "1",
+};
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/openapi/openapi-to-bruno/openapi-to-bruno.spec.js b/packages/bruno-converters/tests/openapi/openapi-to-bruno/openapi-to-bruno.spec.js
new file mode 100644
index 000000000..91ff66460
--- /dev/null
+++ b/packages/bruno-converters/tests/openapi/openapi-to-bruno/openapi-to-bruno.spec.js
@@ -0,0 +1,333 @@
+import { describe, it, expect } from '@jest/globals';
+import openApiToBruno from '../../../src/openapi/openapi-to-bruno';
+
+describe('openapi-collection', () => {
+ it('should correctly import a valid OpenAPI file', async () => {
+ const brunoCollection = openApiToBruno(openApiCollectionString);
+
+ expect(brunoCollection).toMatchObject(expectedOutput);
+ });
+
+ it('should set auth mode to inherit when no security is defined in the collection', () => {
+ const brunoCollection = openApiToBruno(openApiCollectionString);
+
+ // The openApiCollectionString has no security defined, so auth mode should be 'inherit'
+ expect(brunoCollection.items[0].items[0].request.auth.mode).toBe('inherit');
+ });
+
+ it('trims whitespace from info.title and uses the trimmed value as the collection name', () => {
+ const openApiWithTitle = `
+openapi: '3.0.0'
+info:
+ version: '1.0.0'
+ title: ' My API '
+paths:
+ /get:
+ get:
+ summary: 'Request'
+ operationId: 'getRequest'
+ responses:
+ '200':
+ description: 'OK'
+servers:
+ - url: 'https://example.com'
+`;
+ const result = openApiToBruno(openApiWithTitle);
+ expect(result.name).toBe('My API');
+ });
+
+ it('defaults to Untitled Collection if info.title is only whitespace', () => {
+ const openApiWithTitle = `
+openapi: '3.0.0'
+info:
+ version: '1.0.0'
+ title: ' '
+paths:
+ /get:
+ get:
+ summary: 'Request'
+ operationId: 'getRequest'
+ responses:
+ '200':
+ description: 'OK'
+servers:
+ - url: 'https://example.com'
+`;
+ const result = openApiToBruno(openApiWithTitle);
+ expect(result.name).toBe('Untitled Collection');
+ });
+
+ it('defaults to Untitled Collection if info.title is an empty string', () => {
+ const openApiWithEmptyTitle = `
+openapi: '3.0.0'
+info:
+ version: '1.0.0'
+ title: ''
+paths:
+ /get:
+ get:
+ summary: 'Request'
+ operationId: 'getRequest'
+ responses:
+ '200':
+ description: 'OK'
+servers:
+ - url: 'https://example.com'
+`;
+ const result = openApiToBruno(openApiWithEmptyTitle);
+ expect(result.name).toBe('Untitled Collection');
+ });
+
+ it('defaults to Untitled Collection if info.title is missing', () => {
+ const openApiWithoutTitle = `
+openapi: '3.0.0'
+info:
+ version: '1.0.0'
+paths:
+ /get:
+ get:
+ summary: 'Request'
+ operationId: 'getRequest'
+ responses:
+ '200':
+ description: 'OK'
+servers:
+ - url: 'https://example.com'
+`;
+ const result = openApiToBruno(openApiWithoutTitle);
+ expect(result.name).toBe('Untitled Collection');
+ });
+
+ it('defaults to Untitled Collection if info is missing entirely', () => {
+ const openApiWithMissingInfo = `
+openapi: '3.0.0'
+paths:
+ /get:
+ get:
+ summary: 'Request'
+ operationId: 'getRequest'
+ responses:
+ '200':
+ description: 'OK'
+servers:
+ - url: 'https://example.com'
+`;
+ const result = openApiToBruno(openApiWithMissingInfo);
+ expect(result.name).toBe('Untitled Collection');
+ });
+
+ describe('authentication inheritance', () => {
+ it('should set auth mode to inherit when no security is defined', () => {
+ const openApiWithoutSecurity = `
+openapi: '3.0.0'
+info:
+ version: '1.0.0'
+ title: 'API without security'
+paths:
+ /test:
+ get:
+ summary: 'Test endpoint'
+ operationId: 'testEndpoint'
+ responses:
+ '200':
+ description: 'OK'
+servers:
+ - url: 'https://example.com'
+`;
+ const result = openApiToBruno(openApiWithoutSecurity);
+ expect(result.items[0].request.auth.mode).toBe('inherit');
+ });
+
+ it('should set auth mode to inherit when no global security schemes exist', () => {
+ const openApiWithEmptySecurity = `
+openapi: '3.0.0'
+info:
+ version: '1.0.0'
+ title: 'API with empty security'
+security: []
+paths:
+ /test:
+ get:
+ summary: 'Test endpoint'
+ operationId: 'testEndpoint'
+ responses:
+ '200':
+ description: 'OK'
+servers:
+ - url: 'https://example.com'
+`;
+ const result = openApiToBruno(openApiWithEmptySecurity);
+ expect(result.items[0].request.auth.mode).toBe('inherit');
+ });
+
+ it('should set auth mode to inherit when components.securitySchemes is empty', () => {
+ const openApiWithEmptyComponents = `
+openapi: '3.0.0'
+info:
+ version: '1.0.0'
+ title: 'API with empty components'
+components:
+ securitySchemes: {}
+paths:
+ /test:
+ get:
+ summary: 'Test endpoint'
+ operationId: 'testEndpoint'
+ responses:
+ '200':
+ description: 'OK'
+servers:
+ - url: 'https://example.com'
+`;
+ const result = openApiToBruno(openApiWithEmptyComponents);
+ expect(result.items[0].request.auth.mode).toBe('inherit');
+ });
+
+ it('should set auth mode to inherit when operation has empty security array', () => {
+ const openApiWithEmptyOperationSecurity = `
+openapi: '3.0.0'
+info:
+ version: '1.0.0'
+ title: 'API with empty operation security'
+components:
+ securitySchemes:
+ basicAuth:
+ type: http
+ scheme: basic
+paths:
+ /test:
+ get:
+ summary: 'Test endpoint'
+ operationId: 'testEndpoint'
+ security: []
+ responses:
+ '200':
+ description: 'OK'
+servers:
+ - url: 'https://example.com'
+`;
+ const result = openApiToBruno(openApiWithEmptyOperationSecurity);
+ expect(result.items[0].request.auth.mode).toBe('inherit');
+ });
+
+ it('should set auth mode to inherit for folder root when no security is defined', () => {
+ const openApiWithTags = `
+openapi: '3.0.0'
+info:
+ version: '1.0.0'
+ title: 'API with tags'
+paths:
+ /test:
+ get:
+ tags:
+ - TestGroup
+ summary: 'Test endpoint'
+ operationId: 'testEndpoint'
+ responses:
+ '200':
+ description: 'OK'
+servers:
+ - url: 'https://example.com'
+`;
+ const result = openApiToBruno(openApiWithTags);
+ expect(result.items[0].type).toBe('folder');
+ expect(result.items[0].root.request.auth.mode).toBe('inherit');
+ });
+ });
+});
+
+const openApiCollectionString = `
+openapi: "3.0.0"
+info:
+ version: "1.0.0"
+ title: "Hello World OpenAPI"
+paths:
+ /get:
+ get:
+ tags:
+ - Folder1
+ - Folder2
+ summary: "Request1 and Request2"
+ operationId: "getRequests"
+ responses:
+ '200':
+ description: "Successful response"
+components:
+ parameters:
+ var1:
+ in: "query"
+ name: "var1"
+ required: true
+ schema:
+ type: "string"
+ default: "value1"
+ var2:
+ in: "query"
+ name: "var2"
+ required: true
+ schema:
+ type: "string"
+ default: "value2"
+servers:
+ - url: "https://httpbin.org"
+`;
+
+const expectedOutput = {
+ "environments": [
+ {
+ "name": "Environment 1",
+ "uid": "mockeduuidvalue123456",
+ "variables": [
+ {
+ "enabled": true,
+ "name": "baseUrl",
+ "secret": false,
+ "type": "text",
+ "uid": "mockeduuidvalue123456",
+ "value": "https://httpbin.org",
+ },
+ ],
+ },
+ ],
+ "items": [
+ {
+ "items": [
+ {
+ "name": "Request1 and Request2",
+ "request": {
+ "auth": {
+ "basic": null,
+ "bearer": null,
+ "digest": null,
+ "mode": "inherit",
+ },
+ "body": {
+ "formUrlEncoded": [],
+ "json": null,
+ "mode": "none",
+ "multipartForm": [],
+ "text": null,
+ "xml": null,
+ },
+ "headers": [],
+ "method": "GET",
+ "params": [],
+ "script": {
+ "res": null,
+ },
+ "url": "{{baseUrl}}/get",
+ },
+ "seq": 1,
+ "type": "http-request",
+ "uid": "mockeduuidvalue123456",
+ },
+ ],
+ "name": "Folder1",
+ "type": "folder",
+ "uid": "mockeduuidvalue123456",
+ },
+ ],
+ "name": "Hello World OpenAPI",
+ "uid": "mockeduuidvalue123456",
+ "version": "1",
+};
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/bruno-to-postman.spec.js b/packages/bruno-converters/tests/postman/bruno-to-postman.spec.js
new file mode 100644
index 000000000..7d5018997
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/bruno-to-postman.spec.js
@@ -0,0 +1,494 @@
+import { sanitizeUrl, transformUrl, brunoToPostman } from "../../src/postman/bruno-to-postman";
+
+describe('transformUrl', () => {
+ it('should handle basic URL with path variables', () => {
+ const url = 'https://example.com/{{username}}/api/resource/:id';
+ const params = [
+ { name: 'id', value: '123', type: 'path' },
+ ];
+
+ const result = transformUrl(url, params);
+
+ expect(result).toEqual({
+ raw: 'https://example.com/{{username}}/api/resource/:id',
+ protocol: 'https',
+ host: ['example', 'com'],
+ path: ['{{username}}', 'api', 'resource', ':id'],
+ query: [],
+ variable: [
+ { key: 'id', value: '123' },
+ ]
+ });
+ });
+
+ it('should handle URL with query parameters', () => {
+ const url = 'https://example.com/api/resource?limit=10&offset=20';
+ const params = [
+ { name: 'limit', value: '10', type: 'query' },
+ { name: 'offset', value: '20', type: 'query' }
+ ];
+
+ const result = transformUrl(url, params);
+
+ expect(result).toEqual({
+ raw: 'https://example.com/api/resource?limit=10&offset=20',
+ protocol: 'https',
+ host: ['example', 'com'],
+ path: ['api', 'resource'],
+ query: [
+ { key: 'limit', value: '10' },
+ { key: 'offset', value: '20' }
+ ],
+ variable: []
+ });
+ });
+
+ it('should handle URL without protocol', () => {
+ const url = 'example.com/api/resource';
+ const params = [];
+
+ const result = transformUrl(url, params);
+
+ expect(result).toEqual({
+ raw: 'example.com/api/resource',
+ protocol: '',
+ host: ['example', 'com'],
+ path: ['api', 'resource'],
+ query: [],
+ variable: []
+ });
+ });
+});
+
+describe('sanitizeUrl', () => {
+ it('should replace backslashes with slashes', () => {
+ const input = 'http:\\\\example.com\\path\\to\\file';
+ const expected = 'http://example.com/path/to/file';
+ expect(sanitizeUrl(input)).toBe(expected);
+ });
+
+ it('should collapse multiple slashes into a single slash', () => {
+ const input = 'http://example.com//path///to////file';
+ const expected = 'http://example.com/path/to/file';
+ expect(sanitizeUrl(input)).toBe(expected);
+ });
+
+ it('should handle URLs with mixed slashes', () => {
+ const input = 'http:\\example.com//path\\to//file';
+ const expected = 'http://example.com/path/to/file';
+ expect(sanitizeUrl(input)).toBe(expected);
+ });
+});
+
+describe('brunoToPostman null checks and fallbacks', () => {
+ it('should handle null or undefined headers', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'GET',
+ url: 'https://example.com',
+ headers: null
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].request.header).toEqual([]);
+ });
+
+ it('should handle null or undefined items in headers', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'GET',
+ url: 'https://example.com',
+ headers: [
+ { name: null, value: 'test-value', enabled: true },
+ { name: 'Content-Type', value: null, enabled: true }
+ ]
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].request.header).toEqual([
+ { key: '', value: 'test-value', disabled: false, type: 'default' },
+ { key: 'Content-Type', value: '', disabled: false, type: 'default' }
+ ]);
+ });
+
+ it('should handle null or undefined body', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'GET',
+ url: 'https://example.com',
+ body: null
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ // Should not have body property since we're checking for body before adding it
+ expect(result.item[0].request.body).toBeUndefined();
+ });
+
+ it('should handle null or undefined body mode', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'GET',
+ url: 'https://example.com',
+ body: {}
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ // Should use default raw mode for undefined body mode
+ expect(result.item[0].request.body).toEqual({
+ mode: 'raw',
+ raw: ''
+ });
+ });
+
+ it('should handle null or undefined formUrlEncoded array', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'POST',
+ url: 'https://example.com',
+ body: {
+ mode: 'formUrlEncoded',
+ formUrlEncoded: null
+ }
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].request.body).toEqual({
+ mode: 'urlencoded',
+ urlencoded: []
+ });
+ });
+
+ it('should handle null or undefined multipartForm array', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'POST',
+ url: 'https://example.com',
+ body: {
+ mode: 'multipartForm',
+ multipartForm: null
+ }
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].request.body).toEqual({
+ mode: 'formdata',
+ formdata: []
+ });
+ });
+
+ it('should handle null or undefined items in form data', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'POST',
+ url: 'https://example.com',
+ body: {
+ mode: 'formUrlEncoded',
+ formUrlEncoded: [
+ { name: null, value: 'test-value', enabled: true },
+ { name: 'field', value: null, enabled: true }
+ ]
+ }
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].request.body.urlencoded).toEqual([
+ { key: '', value: 'test-value', disabled: false, type: 'default' },
+ { key: 'field', value: '', disabled: false, type: 'default' }
+ ]);
+ });
+
+ it('should handle null or undefined method', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ url: 'https://example.com',
+ method: null
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].request.method).toBe('GET');
+ });
+
+ it('should handle null or undefined url', () => {
+ // Mock console.error to prevent it from logging during test
+ const originalConsoleError = console.error;
+ console.error = jest.fn();
+
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'GET',
+ url: null
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].request.url.raw).toBe('');
+ });
+
+ it('should handle null or undefined params', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'GET',
+ url: 'https://example.com',
+ params: null
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].request.url.variable).toEqual([]);
+ });
+
+ it('should handle null or undefined docs', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'GET',
+ url: 'https://example.com',
+ docs: null
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].request.description).toBe('');
+ });
+
+ it('should handle null or undefined folder name', () => {
+ const simpleCollection = {
+ items: [
+ {
+ type: 'folder',
+ name: null,
+ items: []
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].name).toBe('Untitled Folder');
+ });
+
+ it('should handle null or undefined request name', () => {
+ const simpleCollection = {
+ items: [
+ {
+ type: 'http-request',
+ name: null,
+ request: {
+ method: 'GET',
+ url: 'https://example.com'
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].name).toBe('Untitled Request');
+ });
+
+ it('should handle null or undefined folder items', () => {
+ const simpleCollection = {
+ items: [
+ {
+ type: 'folder',
+ name: 'Test Folder',
+ items: null
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].item).toEqual([]);
+ });
+
+ it('should handle null or undefined auth object', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'GET',
+ url: 'https://example.com',
+ auth: null
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].request.auth).toEqual({ type: 'noauth' });
+ });
+
+ it('should handle missing token in bearer auth', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'GET',
+ url: 'https://example.com',
+ auth: {
+ mode: 'bearer',
+ bearer: { token: null }
+ }
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].request.auth).toEqual({
+ type: 'bearer',
+ bearer: {
+ key: 'token',
+ value: '',
+ type: 'string'
+ }
+ });
+ });
+
+ it('should handle missing username/password in basic auth', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'GET',
+ url: 'https://example.com',
+ auth: {
+ mode: 'basic',
+ basic: { username: null, password: undefined }
+ }
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].request.auth).toEqual({
+ type: 'basic',
+ basic: [
+ {
+ key: 'password',
+ value: '',
+ type: 'string'
+ },
+ {
+ key: 'username',
+ value: '',
+ type: 'string'
+ }
+ ]
+ });
+ });
+
+ it('should handle missing key/value in apikey auth', () => {
+ const simpleCollection = {
+ items: [
+ {
+ name: 'Test Request',
+ type: 'http-request',
+ request: {
+ method: 'GET',
+ url: 'https://example.com',
+ auth: {
+ mode: 'apikey',
+ apikey: { key: null, value: undefined }
+ }
+ }
+ }
+ ]
+ };
+
+ const result = brunoToPostman(simpleCollection);
+ expect(result.item[0].request.auth).toEqual({
+ type: 'apikey',
+ apikey: [
+ {
+ key: 'key',
+ value: '',
+ type: 'string'
+ },
+ {
+ key: 'value',
+ value: '',
+ type: 'string'
+ }
+ ]
+ });
+ });
+});
diff --git a/packages/bruno-converters/tests/postman/postman-env-to-bruno-env.spec.js b/packages/bruno-converters/tests/postman/postman-env-to-bruno-env.spec.js
new file mode 100644
index 000000000..d1831b480
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-env-to-bruno-env.spec.js
@@ -0,0 +1,153 @@
+import { describe, it, expect } from '@jest/globals';
+import postmanToBrunoEnvironment from '../../src/postman/postman-env-to-bruno-env';
+
+describe('postmanToBrunoEnvironment Function', () => {
+ it('should correctly import a valid Postman environment file', async () => {
+ const postmanEnvironment = {
+ "id": "some-id",
+ "name": "My Environment",
+ "values": [
+ {
+ "key": "var1",
+ "value": "value1",
+ "enabled": true,
+ "type": "text"
+ },
+ {
+ "key": "var2",
+ "value": "value2",
+ "enabled": false,
+ "type": "secret"
+ }
+ ]
+ };
+
+ const brunoEnvironment = await postmanToBrunoEnvironment(postmanEnvironment);
+
+ const expectedEnvironment = {
+ name: 'My Environment',
+ variables: [
+ {
+ name: 'var1',
+ value: 'value1',
+ enabled: true,
+ secret: false,
+ type: 'text',
+ uid: "mockeduuidvalue123456",
+ },
+ {
+ name: 'var2',
+ value: 'value2',
+ enabled: false,
+ secret: true,
+ type: 'text',
+ uid: "mockeduuidvalue123456",
+ },
+ ],
+ };
+
+ expect(brunoEnvironment).toEqual(expectedEnvironment);
+ });
+
+ it('should handle falsy values in environment variables', async () => {
+ const postmanEnvironment = {
+ "id": "some-id",
+ "name": "My Environment",
+ "values": [
+ {
+ "enabled": true,
+ "type": "text"
+ },
+ {
+ "value": "",
+ "enabled": true,
+ "type": "text"
+ },
+ {
+ "key": "",
+ "enabled": true,
+ "type": "text"
+ },
+ {
+ "key": "",
+ "value": "",
+ "enabled": true,
+ "type": "text"
+ }
+ ]
+ };
+
+ const brunoEnvironment = await postmanToBrunoEnvironment(postmanEnvironment);
+
+ const expectedEnvironment = {
+ name: 'My Environment',
+ variables: [
+ {
+ name: '',
+ value: '',
+ enabled: true,
+ secret: false,
+ type: 'text',
+ uid: "mockeduuidvalue123456",
+ },
+ {
+ name: '',
+ value: '',
+ enabled: true,
+ secret: false,
+ type: 'text',
+ uid: "mockeduuidvalue123456",
+ },
+ {
+ name: '',
+ value: '',
+ enabled: true,
+ secret: false,
+ type: 'text',
+ uid: "mockeduuidvalue123456"
+ }
+ ],
+ };
+
+ expect(brunoEnvironment).toEqual(expectedEnvironment);
+ });
+
+ it.skip('should throw Error when JSON parsing fails', async () => {
+ const invalidBrunoEnvironment = {
+ "id": "some-id",
+ "name": "My Environment",
+ "values": [
+ {
+ "key": "var1",
+ "value": "value1",
+ "enabled": true,
+ "type": "text"
+ }
+ ]
+ }
+
+ await expect(postmanToBrunoEnvironment(invalidBrunoEnvironment)).rejects.toThrow(Error);
+ await expect(postmanToBrunoEnvironment(invalidBrunoEnvironment)).rejects.toThrow(
+ 'Unable to parse the postman environment json file'
+ );
+ });
+
+ it("should handle empty variables", async () => {
+ const collectionWithEmptyVars = {
+ "name": "My Environment",
+ "values": []
+ };
+
+ const brunoCollection = await postmanToBrunoEnvironment(collectionWithEmptyVars);
+ expect(brunoCollection.variables).toEqual([]);
+ });
+
+ it("should handle undefined variables", async () => {
+ const collectionWithUndefinedVars = {
+ "name": "My Environment",
+ };
+
+ const brunoCollection = await postmanToBrunoEnvironment(collectionWithUndefinedVars);
+ expect(brunoCollection.variables).toEqual([]);
+ });
+});
diff --git a/packages/bruno-converters/tests/postman/postman-to-bruno/collection-auth.spec.js b/packages/bruno-converters/tests/postman/postman-to-bruno/collection-auth.spec.js
new file mode 100644
index 000000000..67cd32cd8
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-to-bruno/collection-auth.spec.js
@@ -0,0 +1,371 @@
+import { describe, it, expect } from '@jest/globals';
+import postmanToBruno from '../../../src/postman/postman-to-bruno';
+
+describe('Collection Authentication', () => {
+ it('should handle no auth at collection level (when auth property is absent)', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Collection level no auth',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [],
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+ // console.log('result', JSON.stringify(result, null, 2));
+
+ expect(result.root.request.auth).toEqual({
+ mode: 'none',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle basic auth at collection level', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Collection level basic auth',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [],
+ auth: {
+ type: 'basic',
+ basic: [
+ {
+ key: 'password',
+ value: 'testpass',
+ type: 'string'
+ },
+ {
+ key: 'username',
+ value: 'testuser',
+ type: 'string'
+ }
+ ]
+ },
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+ // console.log('result', JSON.stringify(result, null, 2));
+
+ expect(result.root.request.auth).toEqual({
+ mode: 'basic',
+ basic: {
+ username: 'testuser',
+ password: 'testpass'
+ },
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle bearer token auth at collection level', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Collection level bearer token',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [],
+ auth: {
+ type: 'bearer',
+ bearer: [
+ {
+ key: 'token',
+ value: 'token',
+ type: 'string'
+ }
+ ]
+ },
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+ // console.log('result', JSON.stringify(result, null, 2));
+
+ expect(result.root.request.auth).toEqual({
+ mode: 'bearer',
+ basic: null,
+ bearer: {
+ token: 'token'
+ },
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle API key auth at collection level', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Collection level api key',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [],
+ auth: {
+ type: 'apikey',
+ apikey: [
+ {
+ key: 'value',
+ value: 'apikey',
+ type: 'string'
+ },
+ {
+ key: 'key',
+ value: 'apikey',
+ type: 'string'
+ }
+ ]
+ },
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.root.request.auth).toEqual({
+ mode: 'apikey',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: {
+ key: 'apikey',
+ value: 'apikey',
+ placement: 'header'
+ },
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle digest auth at collection level', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Collection level digest auth',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [],
+ auth: {
+ type: 'digest',
+ digest: [
+ {
+ key: 'password',
+ value: 'digest auth',
+ type: 'string'
+ },
+ {
+ key: 'username',
+ value: 'digest auth',
+ type: 'string'
+ },
+ {
+ key: 'algorithm',
+ value: 'MD5',
+ type: 'string'
+ }
+ ]
+ },
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.root.request.auth).toEqual({
+ mode: 'digest',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: {
+ username: 'digest auth',
+ password: 'digest auth'
+ }
+ });
+ });
+ it('should handle missing auth values when auth.type exists', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Collection with missing auth values',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [],
+ auth: {
+ type: 'basic'
+ // Missing basic auth values
+ },
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.root.request.auth).toEqual({
+ mode: 'basic',
+ basic: {
+ username: '',
+ password: ''
+ },
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle missing auth values for different auth types', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Collection with missing auth values for different types',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [],
+ auth: {
+ type: 'bearer'
+ // Missing bearer token
+ },
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.root.request.auth).toEqual({
+ mode: 'bearer',
+ basic: null,
+ bearer: {
+ token: ''
+ },
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+});
diff --git a/packages/bruno-converters/tests/postman/postman-to-bruno/folder-auth.spec.js b/packages/bruno-converters/tests/postman/postman-to-bruno/folder-auth.spec.js
new file mode 100644
index 000000000..9ab0534eb
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-to-bruno/folder-auth.spec.js
@@ -0,0 +1,422 @@
+import { describe, it, expect } from '@jest/globals';
+import postmanToBruno from '../../../src/postman/postman-to-bruno';
+
+describe('Folder Authentication', () => {
+ it('should handle "Inherit Auth" at folder level (auth property absent)', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Folder Inherit Auth',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [
+ {
+ name: 'Inheriting Folder',
+ items: []
+ }
+ ],
+ auth: {
+ type: 'basic',
+ basic: [
+ {
+ key: 'password',
+ value: 'testpass',
+ type: 'string'
+ },
+ {
+ key: 'username',
+ value: 'testuser',
+ type: 'string'
+ }
+ ]
+ },
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.items[0].root.request.auth).toEqual({
+ mode: 'inherit',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle explicit "No Auth" at folder level', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Folder No Auth',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [
+ {
+ name: 'No Auth Folder',
+ item: [],
+ auth: {
+ type: 'noauth'
+ }
+ }
+ ],
+ auth: {
+ type: 'basic',
+ basic: [
+ {
+ key: 'password',
+ value: 'testpass',
+ type: 'string'
+ },
+ {
+ key: 'username',
+ value: 'testuser',
+ type: 'string'
+ }
+ ]
+ },
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.items[0].root.request.auth).toEqual({
+ mode: 'none',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle basic auth at folder level', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Folder level basic auth',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [
+ {
+ name: 'folder',
+ item: [],
+ auth: {
+ type: 'basic',
+ basic: [
+ {
+ key: 'password',
+ value: 'testpass',
+ type: 'string'
+ },
+ {
+ key: 'username',
+ value: 'testuser',
+ type: 'string'
+ }
+ ]
+ },
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.items[0].root.request.auth).toEqual({
+ mode: 'basic',
+ basic: {
+ username: 'testuser',
+ password: 'testpass'
+ },
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle bearer token auth at folder level', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Folder level bearer token',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [
+ {
+ name: 'folder',
+ item: [],
+ auth: {
+ type: 'bearer',
+ bearer: [
+ {
+ key: 'token',
+ value: 'token',
+ type: 'string'
+ }
+ ]
+ },
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.items[0].root.request.auth).toEqual({
+ mode: 'bearer',
+ basic: null,
+ bearer: { token: 'token' },
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle API key auth at folder level', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Folder level API key',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [
+ {
+ name: 'folder',
+ item: [],
+ auth: {
+ type: 'apikey',
+ apikey: [
+ {
+ key: 'value',
+ value: 'apikey',
+ type: 'string'
+ },
+ {
+ key: 'key',
+ value: 'apikey',
+ type: 'string'
+ }
+ ]
+ },
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.items[0].root.request.auth).toEqual({
+ mode: 'apikey',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: { key: 'apikey', value: 'apikey', placement: 'header' },
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle digest auth at folder level', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Folder level digest auth',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [
+ {
+ name: 'folder',
+ item: [],
+ auth: {
+ type: 'digest',
+ digest: [
+ {
+ key: 'password',
+ value: 'digest pass',
+ type: 'string'
+ },
+ {
+ key: 'username',
+ value: 'digest user',
+ type: 'string'
+ },
+ {
+ key: 'algorithm',
+ value: 'MD5',
+ type: 'string'
+ }
+ ]
+ },
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.items[0].root.request.auth).toEqual({
+ mode: 'digest',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: { username: 'digest user', password: 'digest pass' }
+ });
+ });
+
+ it('should handle missing auth values in folder level auth', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Folder with missing auth values',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [
+ {
+ name: 'folder',
+ item: [],
+ auth: {
+ type: 'basic'
+ // Missing basic values
+ },
+ event: [
+ {
+ listen: 'prerequest',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ },
+ {
+ listen: 'test',
+ script: {
+ type: 'text/javascript',
+ packages: {},
+ exec: ['']
+ }
+ }
+ ]
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.items[0].root.request.auth).toEqual({
+ mode: 'basic',
+ basic: {
+ username: '',
+ password: ''
+ },
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+});
diff --git a/packages/bruno-converters/tests/postman/postman-to-bruno/postman-to-bruno.spec.js b/packages/bruno-converters/tests/postman/postman-to-bruno/postman-to-bruno.spec.js
new file mode 100644
index 000000000..4e1084ec1
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-to-bruno/postman-to-bruno.spec.js
@@ -0,0 +1,524 @@
+import { describe, it, expect } from '@jest/globals';
+import postmanToBruno from '../../../src/postman/postman-to-bruno';
+
+describe('postman-collection', () => {
+ it('should correctly import a valid Postman collection file', async () => {
+ const brunoCollection = await postmanToBruno(postmanCollection);
+ expect(brunoCollection).toMatchObject(expectedOutput);
+ });
+
+ it('should handle falsy values in collection variables', async () => {
+ const collectionWithFalsyVars = {
+ "info": {
+ "_postman_id": "7f91bbd8-cb97-41ac-8d0b-e1fcd8bb4ce9",
+ "name": "collection with falsy vars",
+ "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+ },
+ "variable": [
+ {
+ "type": "string"
+ },
+ {
+ "key": "",
+ "type": "string"
+ },
+ {
+ "value": "",
+ "type": "string"
+ },
+ {
+ "key": "",
+ "value": "",
+ "type": "string"
+ }
+ ],
+ "item": []
+ };
+
+ const brunoCollection = await postmanToBruno(collectionWithFalsyVars);
+
+ expect(brunoCollection.root.request.vars.req).toEqual([
+ {
+ uid: "mockeduuidvalue123456",
+ name: '',
+ value: '',
+ enabled: true
+ },
+ {
+ uid: "mockeduuidvalue123456",
+ name: '',
+ value: '',
+ enabled: true
+ },
+ {
+ uid: "mockeduuidvalue123456",
+ name: '',
+ value: '',
+ enabled: true
+ }
+ ]);
+ });
+
+ it("should handle empty variables", async () => {
+ const collectionWithEmptyVars = {
+ "info": {
+ "_postman_id": "7f91bbd8-cb97-41ac-8d0b-e1fcd8bb4ce9",
+ "name": "collection with falsy vars",
+ "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+ },
+ "variable": [],
+ "item": []
+ };
+
+ const brunoCollection = await postmanToBruno(collectionWithEmptyVars);
+ expect(brunoCollection.root.request.vars.req).toEqual([]);
+ });
+
+ it('should handle collection with auth object having undefined type', async () => {
+ const collectionWithUndefinedAuthType = {
+ 'info': {
+ '_postman_id': '7f91bbd8-cb97-41ac-8d0b-e1fcd8bb4ce9',
+ 'name': 'collection with undefined auth type',
+ 'schema': 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ 'auth': {
+ 'basic': [
+ { key: 'username', value: 'testuser', type: 'string' },
+ { key: 'password', value: 'testpass', type: 'string' }
+ ]
+ },
+ 'item': [
+ {
+ 'name': 'request',
+ 'request': {
+ 'method': 'GET',
+ 'header': [],
+ 'url': {
+ 'raw': 'https://api.example.com/test',
+ 'protocol': 'https',
+ 'host': ['api', 'example', 'com'],
+ 'path': ['test']
+ }
+ }
+ }
+ ]
+ };
+
+ const brunoCollection = await postmanToBruno(collectionWithUndefinedAuthType);
+
+ // Collection level auth should default to 'none'
+ expect(brunoCollection.root.request.auth).toEqual({
+ mode: 'none',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+
+ // Request should inherit auth mode
+ expect(brunoCollection.items[0].request.auth).toEqual({
+ mode: 'inherit',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle collection with auth object having null type', async () => {
+ const collectionWithNullAuthType = {
+ 'info': {
+ '_postman_id': '7f91bbd8-cb97-41ac-8d0b-e1fcd8bb4ce9',
+ 'name': 'collection with null auth type',
+ 'schema': 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ 'auth': {
+ 'type': null,
+ 'bearer': {
+ 'token': 'test-token'
+ }
+ },
+ 'item': [
+ {
+ 'name': 'request',
+ 'request': {
+ 'method': 'GET',
+ 'header': [],
+ 'url': {
+ 'raw': 'https://api.example.com/test',
+ 'protocol': 'https',
+ 'host': ['api', 'example', 'com'],
+ 'path': ['test']
+ }
+ }
+ }
+ ]
+ };
+
+ const brunoCollection = await postmanToBruno(collectionWithNullAuthType);
+
+ // Collection level auth should default to 'none'
+ expect(brunoCollection.root.request.auth).toEqual({
+ mode: 'none',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle collection with auth object having unexpected type value', async () => {
+ const collectionWithUnexpectedAuthType = {
+ 'info': {
+ '_postman_id': '7f91bbd8-cb97-41ac-8d0b-e1fcd8bb4ce9',
+ 'name': 'collection with unexpected auth type',
+ 'schema': 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ 'auth': {
+ 'type': 'unexpected_auth_type',
+ 'basic': [
+ { key: 'username', value: 'testuser', type: 'string' },
+ { key: 'password', value: 'testpass', type: 'string' }
+ ]
+ },
+ 'item': [
+ {
+ 'name': 'request',
+ 'request': {
+ 'method': 'GET',
+ 'header': [],
+ 'url': {
+ 'raw': 'https://api.example.com/test',
+ 'protocol': 'https',
+ 'host': ['api', 'example', 'com'],
+ 'path': ['test']
+ }
+ }
+ }
+ ]
+ };
+
+ const brunoCollection = await postmanToBruno(collectionWithUnexpectedAuthType);
+
+ // Collection level auth should default to 'none'
+ expect(brunoCollection.root.request.auth).toEqual({
+ mode: 'none',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+
+ // Request should inherit auth mode
+ expect(brunoCollection.items[0].request.auth).toEqual({
+ mode: 'inherit',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle request with auth object having undefined type', async () => {
+ const collectionWithRequestUndefinedAuthType = {
+ 'info': {
+ '_postman_id': '7f91bbd8-cb97-41ac-8d0b-e1fcd8bb4ce9',
+ 'name': 'collection with request undefined auth type',
+ 'schema': 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ 'item': [
+ {
+ 'name': 'request',
+ 'request': {
+ 'method': 'GET',
+ 'header': [],
+ 'url': {
+ 'raw': 'https://api.example.com/test',
+ 'protocol': 'https',
+ 'host': ['api', 'example', 'com'],
+ 'path': ['test']
+ },
+ 'auth': {
+ 'basic': [
+ { key: 'username', value: 'testuser', type: 'string' },
+ { key: 'password', value: 'testpass', type: 'string' }
+ ]
+ }
+ }
+ }
+ ]
+ };
+
+ const brunoCollection = await postmanToBruno(collectionWithRequestUndefinedAuthType);
+
+ // Collection level auth should default to 'none'
+ expect(brunoCollection.root.request.auth).toEqual({
+ mode: 'none',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+
+ // Request auth should default to 'none'
+ expect(brunoCollection.items[0].request.auth).toEqual({
+ mode: 'none',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle folder with auth object having unexpected type', async () => {
+ const collectionWithFolderUnexpectedAuthType = {
+ 'info': {
+ '_postman_id': '7f91bbd8-cb97-41ac-8d0b-e1fcd8bb4ce9',
+ 'name': 'collection with folder unexpected auth type',
+ 'schema': 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ 'item': [
+ {
+ 'name': 'folder',
+ 'auth': {
+ 'type': 'unexpected_folder_auth_type',
+ 'bearer': {
+ 'token': 'folder-token'
+ }
+ },
+ 'item': [
+ {
+ 'name': 'request',
+ 'request': {
+ 'method': 'GET',
+ 'header': [],
+ 'url': {
+ 'raw': 'https://api.example.com/test',
+ 'protocol': 'https',
+ 'host': ['api', 'example', 'com'],
+ 'path': ['test']
+ }
+ }
+ }
+ ]
+ }
+ ]
+ };
+
+ const brunoCollection = await postmanToBruno(collectionWithFolderUnexpectedAuthType);
+
+ // Folder auth should default to 'none'
+ expect(brunoCollection.items[0].root.request.auth).toEqual({
+ mode: 'none',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+
+ // Request should inherit auth mode
+ expect(brunoCollection.items[0].items[0].request.auth).toEqual({
+ mode: 'inherit',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+});
+
+// Simple Collection (postman)
+// ├── folder
+// │ └── request (GET)
+// └── request (GET)
+
+const postmanCollection = {
+ "info": {
+ "_postman_id": "7f91bbd8-cb97-41ac-8d0b-e1fcd8bb4ce9",
+ "name": "simple collection",
+ "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
+ "_exporter_id": "21992467",
+ "_collection_link": "https://random-user-007.postman.co/workspace/testing~7523f559-3d5f-4c30-8315-3cb3c3ff98b7/collection/21992467-7f91bbd8-cb97-41ac-8d0b-e1fcd8bb4ce9?action=share&source=collection_link&creator=007"
+ },
+ "item": [
+ {
+ "name": "folder",
+ "item": [
+ {
+ "name": "request",
+ "request": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "https://usebruno.com",
+ "protocol": "https",
+ "host": [
+ "usebruno",
+ "com"
+ ]
+ }
+ },
+ "response": []
+ }
+ ]
+ },
+ {
+ "name": "request",
+ "request": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "https://usebruno.com",
+ "protocol": "https",
+ "host": [
+ "usebruno",
+ "com"
+ ]
+ }
+ },
+ "response": []
+ }
+ ]
+};
+
+// Simple Collection (bruno)
+// ├── folder
+// │ └── request (GET)
+// └── request (GET)
+
+const expectedOutput = {
+ "name": "simple collection",
+ "uid": "mockeduuidvalue123456",
+ "version": "1",
+ "items": [
+ {
+ "uid": "mockeduuidvalue123456",
+ "name": "folder",
+ "type": "folder",
+ "seq": 1,
+ "items": [
+ {
+ "uid": "mockeduuidvalue123456",
+ "name": "request",
+ "type": "http-request",
+ "seq": 1,
+ "request": {
+ "url": "https://usebruno.com",
+ "method": "GET",
+ "auth": {
+ "mode": "inherit",
+ "basic": null,
+ "bearer": null,
+ "awsv4": null,
+ "apikey": null,
+ "oauth2": null,
+ "digest": null
+ },
+ "headers": [],
+ "params": [],
+ "body": {
+ "mode": "none",
+ "json": null,
+ "text": null,
+ "xml": null,
+ "formUrlEncoded": [],
+ "multipartForm": []
+ },
+ "docs": ""
+ }
+ }
+ ],
+ "root": {
+ "docs": "",
+ "meta": {
+ "name": "folder"
+ },
+ "request": {
+ "auth": {
+ "mode": "inherit",
+ "basic": null,
+ "bearer": null,
+ "awsv4": null,
+ "apikey": null,
+ "oauth2": null,
+ "digest": null
+ },
+ "headers": [],
+ "script": {},
+ "tests": "",
+ "vars": {}
+ }
+ }
+ },
+ {
+ "uid": "mockeduuidvalue123456",
+ "name": "request",
+ "type": "http-request",
+ "seq": 2,
+ "request": {
+ "url": "https://usebruno.com",
+ "method": "GET",
+ "auth": {
+ "mode": "inherit",
+ "basic": null,
+ "bearer": null,
+ "awsv4": null,
+ "apikey": null,
+ "oauth2": null,
+ "digest": null
+ },
+ "headers": [],
+ "params": [],
+ "body": {
+ "mode": "none",
+ "json": null,
+ "text": null,
+ "xml": null,
+ "formUrlEncoded": [],
+ "multipartForm": []
+ },
+ "docs": ""
+ },
+ }
+ ],
+ "environments": [],
+ "root": {
+ "docs": "",
+ "meta": {
+ "name": "simple collection"
+ },
+ "request": {
+ "auth": {
+ "mode": "none",
+ "basic": null,
+ "bearer": null,
+ "awsv4": null,
+ "apikey": null,
+ "oauth2": null,
+ "digest": null
+ },
+ "headers": [],
+ "script": {},
+ "tests": "",
+ "vars": {}
+ }
+ }
+ };
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-to-bruno/postman-translations/postman-request.spec.js b/packages/bruno-converters/tests/postman/postman-to-bruno/postman-translations/postman-request.spec.js
new file mode 100644
index 000000000..93eed719a
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-to-bruno/postman-translations/postman-request.spec.js
@@ -0,0 +1,29 @@
+const { default: postmanTranslation } = require("../../../../src/postman/postman-translations");
+
+describe('postmanTranslations - request commands', () => {
+ test('should handle request commands', () => {
+ const inputScript = `
+ const requestUrl = pm.request.url;
+ const requestMethod = pm.request.method;
+ const requestHeaders = pm.request.headers;
+ const requestBody = pm.request.body;
+ const requestName = pm.info.requestName;
+
+ pm.test('Request method is POST', function() {
+ pm.expect(pm.request.method).to.equal('POST');
+ });
+ `;
+ const expectedOutput = `
+ const requestUrl = req.getUrl();
+ const requestMethod = req.getMethod();
+ const requestHeaders = req.getHeaders();
+ const requestBody = req.getBody();
+ const requestName = req.getName();
+
+ test('Request method is POST', function() {
+ expect(req.getMethod()).to.equal('POST');
+ });
+ `;
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-to-bruno/postman-translations/postman-response.spec.js b/packages/bruno-converters/tests/postman/postman-to-bruno/postman-translations/postman-response.spec.js
new file mode 100644
index 000000000..590825f13
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-to-bruno/postman-translations/postman-response.spec.js
@@ -0,0 +1,41 @@
+const { default: postmanTranslation } = require("../../../../src/postman/postman-translations");
+
+describe('postmanTranslations - response commands', () => {
+ test('should handle response commands', () => {
+ const inputScript = `
+ const responseTime = pm.response.responseTime;
+ const responseCode = pm.response.code;
+ const responseText = pm.response.text();
+ const responseJson = pm.response.json();
+ const responseStatus = pm.response.status;
+ const responseHeaders = pm.response.headers;
+ const responseSize = pm.response.size();
+ const responseSizeBody = pm.response.size().body;
+ const responseSizeHeader = pm.response.size().header;
+ const responseSizeTotal = pm.response.size().total;
+ const responseSizeBody2 = pm.response.responseSize;
+
+ pm.test('Status code is 200', function() {
+ pm.response.to.have.status(200);
+ });
+ `;
+ const expectedOutput = `
+ const responseTime = res.getResponseTime();
+ const responseCode = res.getStatus();
+ const responseText = JSON.stringify(res.getBody());
+ const responseJson = res.getBody();
+ const responseStatus = res.statusText;
+ const responseHeaders = res.getHeaders();
+ const responseSize = res.getSize();
+ const responseSizeBody = res.getSize().body;
+ const responseSizeHeader = res.getSize().header;
+ const responseSizeTotal = res.getSize().total;
+ const responseSizeBody2 = res.getSize().body;
+
+ test('Status code is 200', function() {
+ expect(res.getStatus()).to.equal(200);
+ });
+ `;
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+});
diff --git a/packages/bruno-converters/tests/postman/postman-to-bruno/process-auth.spec.js b/packages/bruno-converters/tests/postman/postman-to-bruno/process-auth.spec.js
new file mode 100644
index 000000000..a6d90ed1b
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-to-bruno/process-auth.spec.js
@@ -0,0 +1,516 @@
+const { processAuth } = require("../../../src/postman/postman-to-bruno");
+
+
+describe('processAuth', () => {
+ let requestObject;
+
+ beforeEach(() => {
+ requestObject = {
+ auth: {
+ mode: 'none',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ }
+ };
+ });
+
+ it('should handle no auth', () => {
+ processAuth(null, requestObject);
+ expect(requestObject.auth.mode).toBe('none');
+ });
+
+ it('should handle noauth type', () => {
+ processAuth({ type: 'noauth' }, requestObject);
+ expect(requestObject.auth.mode).toBe('none');
+ });
+
+ it('should handle basic auth', () => {
+ const auth = {
+ type: 'basic',
+ basic: [
+ { key: 'username', value: 'testuser', type: 'string' },
+ { key: 'password', value: 'testpass', type: 'string' }
+ ]
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('basic');
+ expect(requestObject.auth.basic).toEqual({
+ username: 'testuser',
+ password: 'testpass'
+ });
+ });
+
+ it('should handle basic auth with missing values', () => {
+ const auth = {
+ type: 'basic',
+ basic: {}
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('basic');
+ expect(requestObject.auth.basic).toEqual({
+ username: '',
+ password: ''
+ });
+ });
+
+ it('should handle basic auth with missing basic key', () => {
+ const auth = {
+ type: 'basic'
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('basic');
+ expect(requestObject.auth.basic).toEqual({
+ username: '',
+ password: ''
+ });
+ });
+
+ it('should handle bearer auth', () => {
+ const auth = {
+ type: 'bearer',
+ bearer: {
+ token: 'test-token'
+ }
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('bearer');
+ expect(requestObject.auth.bearer).toEqual({
+ token: 'test-token'
+ });
+ });
+
+ it('should handle bearer auth with missing values', () => {
+ const auth = {
+ type: 'bearer',
+ bearer: {}
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('bearer');
+ expect(requestObject.auth.bearer).toEqual({
+ token: ''
+ });
+ });
+
+ it('should handle bearer auth with missing bearer key', () => {
+ const auth = {
+ type: 'bearer'
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('bearer');
+ expect(requestObject.auth.bearer).toEqual({
+ token: ''
+ });
+ });
+
+ it('should handle awsv4 auth', () => {
+ const auth = {
+ type: 'awsv4',
+ awsv4: {
+ accessKey: 'test-access-key',
+ secretKey: 'test-secret-key',
+ sessionToken: 'test-session-token',
+ service: 'test-service',
+ region: 'test-region'
+ }
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('awsv4');
+ expect(requestObject.auth.awsv4).toEqual({
+ accessKeyId: 'test-access-key',
+ secretAccessKey: 'test-secret-key',
+ sessionToken: 'test-session-token',
+ service: 'test-service',
+ region: 'test-region',
+ profileName: ''
+ });
+ });
+
+ it('should handle awsv4 auth with missing values', () => {
+ const auth = {
+ type: 'awsv4',
+ awsv4: {}
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('awsv4');
+ expect(requestObject.auth.awsv4).toEqual({
+ accessKeyId: '',
+ secretAccessKey: '',
+ sessionToken: '',
+ service: '',
+ region: '',
+ profileName: ''
+ });
+ });
+
+ it('should handle awsv4 auth with missing awsv4 key', () => {
+ const auth = {
+ type: 'awsv4'
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('awsv4');
+ expect(requestObject.auth.awsv4).toEqual({
+ accessKeyId: '',
+ secretAccessKey: '',
+ sessionToken: '',
+ service: '',
+ region: '',
+ profileName: ''
+ });
+ });
+
+ it('should handle apikey auth', () => {
+ const auth = {
+ type: 'apikey',
+ apikey: {
+ key: 'test-key',
+ value: 'test-value'
+ }
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('apikey');
+ expect(requestObject.auth.apikey).toEqual({
+ key: 'test-key',
+ value: 'test-value',
+ placement: 'header'
+ });
+ });
+
+ it('should handle apikey auth with missing values', () => {
+ const auth = {
+ type: 'apikey',
+ apikey: {}
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('apikey');
+ expect(requestObject.auth.apikey).toEqual({
+ key: '',
+ value: '',
+ placement: 'header'
+ });
+ });
+
+ it('should handle apikey auth with missing apikey key', () => {
+ const auth = {
+ type: 'apikey'
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('apikey');
+ expect(requestObject.auth.apikey).toEqual({
+ key: '',
+ value: '',
+ placement: 'header'
+ });
+ });
+
+ it('should handle digest auth', () => {
+ const auth = {
+ type: 'digest',
+ digest: {
+ username: 'testuser',
+ password: 'testpass'
+ }
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('digest');
+ expect(requestObject.auth.digest).toEqual({
+ username: 'testuser',
+ password: 'testpass'
+ });
+ });
+
+ it('should handle digest auth with missing values', () => {
+ const auth = {
+ type: 'digest',
+ digest: {}
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('digest');
+ expect(requestObject.auth.digest).toEqual({
+ username: '',
+ password: ''
+ });
+ });
+
+ it('should handle digest auth with missing digest key', () => {
+ const auth = {
+ type: 'digest'
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('digest');
+ expect(requestObject.auth.digest).toEqual({
+ username: '',
+ password: ''
+ });
+ });
+
+ it('should handle oauth2 auth with authorization_code grant type', () => {
+ const auth = {
+ type: 'oauth2',
+ oauth2: {
+ grant_type: 'authorization_code',
+ authUrl: 'https://auth.example.com',
+ redirect_uri: 'https://callback.example.com',
+ accessTokenUrl: 'https://token.example.com',
+ refreshTokenUrl: 'https://refresh.example.com',
+ clientId: 'test-client-id',
+ clientSecret: 'test-client-secret',
+ scope: 'test-scope',
+ state: 'test-state',
+ addTokenTo: 'header',
+ client_authentication: 'body'
+ }
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('oauth2');
+ expect(requestObject.auth.oauth2).toEqual({
+ grantType: 'authorization_code',
+ authorizationUrl: 'https://auth.example.com',
+ callbackUrl: 'https://callback.example.com',
+ accessTokenUrl: 'https://token.example.com',
+ refreshTokenUrl: 'https://refresh.example.com',
+ clientId: 'test-client-id',
+ clientSecret: 'test-client-secret',
+ scope: 'test-scope',
+ state: 'test-state',
+ pkce: false,
+ tokenPlacement: 'header',
+ credentialsPlacement: 'body'
+ });
+ });
+
+ it('should handle oauth2 auth with password_credentials grant type', () => {
+ const auth = {
+ type: 'oauth2',
+ oauth2: {
+ grant_type: 'password_credentials',
+ accessTokenUrl: 'https://token.example.com',
+ refreshTokenUrl: 'https://refresh.example.com',
+ username: 'testuser',
+ password: 'testpass',
+ clientId: 'test-client-id',
+ clientSecret: 'test-client-secret',
+ scope: 'test-scope',
+ state: 'test-state',
+ addTokenTo: 'header',
+ client_authentication: 'body'
+ }
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('oauth2');
+ expect(requestObject.auth.oauth2).toEqual({
+ grantType: 'password',
+ accessTokenUrl: 'https://token.example.com',
+ refreshTokenUrl: 'https://refresh.example.com',
+ username: 'testuser',
+ password: 'testpass',
+ clientId: 'test-client-id',
+ clientSecret: 'test-client-secret',
+ scope: 'test-scope',
+ state: 'test-state',
+ tokenPlacement: 'header',
+ credentialsPlacement: 'body'
+ });
+ });
+
+ it('should handle oauth2 auth with client_credentials grant type', () => {
+ const auth = {
+ type: 'oauth2',
+ oauth2: {
+ grant_type: 'client_credentials',
+ accessTokenUrl: 'https://token.example.com',
+ refreshTokenUrl: 'https://refresh.example.com',
+ clientId: 'test-client-id',
+ clientSecret: 'test-client-secret',
+ scope: 'test-scope',
+ state: 'test-state',
+ addTokenTo: 'header',
+ client_authentication: 'body'
+ }
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('oauth2');
+ expect(requestObject.auth.oauth2).toEqual({
+ grantType: 'client_credentials',
+ accessTokenUrl: 'https://token.example.com',
+ refreshTokenUrl: 'https://refresh.example.com',
+ clientId: 'test-client-id',
+ clientSecret: 'test-client-secret',
+ scope: 'test-scope',
+ state: 'test-state',
+ tokenPlacement: 'header',
+ credentialsPlacement: 'body'
+ });
+ });
+
+ it('should handle oauth2 auth with missing values', () => {
+ const auth = {
+ type: 'oauth2',
+ oauth2: {}
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('oauth2');
+ expect(requestObject.auth.oauth2).toEqual({
+ grantType: 'client_credentials',
+ accessTokenUrl: '',
+ refreshTokenUrl: '',
+ clientId: '',
+ clientSecret: '',
+ scope: '',
+ state: '',
+ tokenPlacement: 'url',
+ credentialsPlacement: 'basic_auth_header'
+ });
+ });
+
+ it('should handle oauth2 auth with missing oauth2 key', () => {
+ const auth = {
+ type: 'oauth2'
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('oauth2');
+ expect(requestObject.auth.oauth2).toEqual({
+ grantType: 'client_credentials',
+ accessTokenUrl: '',
+ refreshTokenUrl: '',
+ clientId: '',
+ clientSecret: '',
+ scope: '',
+ state: '',
+ tokenPlacement: 'url',
+ credentialsPlacement: 'basic_auth_header'
+ });
+ });
+
+ it('should handle oauth2 auth with authorization_code_with_pkce grant type', () => {
+ const auth = {
+ type: 'oauth2',
+ oauth2: {
+ grant_type: 'authorization_code_with_pkce',
+ authUrl: 'https://auth.example.com',
+ redirect_uri: 'https://callback.example.com',
+ accessTokenUrl: 'https://token.example.com',
+ refreshTokenUrl: 'https://refresh.example.com',
+ clientId: 'test-client-id',
+ clientSecret: 'test-client-secret',
+ scope: 'test-scope',
+ state: 'test-state',
+ addTokenTo: 'header',
+ client_authentication: 'body'
+ }
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('oauth2');
+ expect(requestObject.auth.oauth2).toEqual({
+ grantType: 'authorization_code',
+ authorizationUrl: 'https://auth.example.com',
+ callbackUrl: 'https://callback.example.com',
+ accessTokenUrl: 'https://token.example.com',
+ refreshTokenUrl: 'https://refresh.example.com',
+ clientId: 'test-client-id',
+ clientSecret: 'test-client-secret',
+ scope: 'test-scope',
+ state: 'test-state',
+ pkce: true,
+ tokenPlacement: 'header',
+ credentialsPlacement: 'body'
+ });
+ });
+
+ it('should handle auth object with undefined type', () => {
+ const auth = {};
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('none');
+ expect(requestObject.auth.basic).toBe(null);
+ expect(requestObject.auth.bearer).toBe(null);
+ expect(requestObject.auth.awsv4).toBe(null);
+ expect(requestObject.auth.apikey).toBe(null);
+ expect(requestObject.auth.oauth2).toBe(null);
+ expect(requestObject.auth.digest).toBe(null);
+ });
+
+ it('should handle type as null and auth as null', () => {
+ const auth = {
+ type: null,
+ auth: null
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('none');
+ expect(requestObject.auth.basic).toBe(null);
+ expect(requestObject.auth.bearer).toBe(null);
+ expect(requestObject.auth.awsv4).toBe(null);
+ expect(requestObject.auth.apikey).toBe(null);
+ expect(requestObject.auth.oauth2).toBe(null);
+ expect(requestObject.auth.digest).toBe(null);
+ });
+
+ it('should handle auth object with undefined type, but basic auth', () => {
+ const auth = {
+ basic: [
+ { key: 'username', value: 'testuser', type: 'string' },
+ { key: 'password', value: 'testpass', type: 'string' }
+ ]
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('none');
+ expect(requestObject.auth.basic).toBe(null);
+ expect(requestObject.auth.bearer).toBe(null);
+ expect(requestObject.auth.awsv4).toBe(null);
+ expect(requestObject.auth.apikey).toBe(null);
+ expect(requestObject.auth.oauth2).toBe(null);
+ expect(requestObject.auth.digest).toBe(null);
+ });
+
+ it('should handle auth object with null type', () => {
+ const auth = {
+ type: null,
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('none');
+ expect(requestObject.auth.basic).toBe(null);
+ expect(requestObject.auth.bearer).toBe(null);
+ expect(requestObject.auth.awsv4).toBe(null);
+ expect(requestObject.auth.apikey).toBe(null);
+ expect(requestObject.auth.oauth2).toBe(null);
+ expect(requestObject.auth.digest).toBe(null);
+ });
+
+ it('should handle auth object with empty string type', () => {
+ const auth = {
+ type: null,
+ basic: {
+ username: 'testuser',
+ password: 'testpass'
+ }
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('none');
+ expect(requestObject.auth.basic).toBe(null);
+ expect(requestObject.auth.bearer).toBe(null);
+ expect(requestObject.auth.awsv4).toBe(null);
+ expect(requestObject.auth.apikey).toBe(null);
+ expect(requestObject.auth.oauth2).toBe(null);
+ expect(requestObject.auth.digest).toBe(null);
+ });
+
+ it('should handle auth object with boolean type value', () => {
+ const auth = {
+ type: "unknown_auth_type",
+ unknown_auth_type: {
+ accessKey: 'test-access-key',
+ secretKey: 'test-secret-key'
+ }
+ };
+ processAuth(auth, requestObject);
+ expect(requestObject.auth.mode).toBe('none');
+ expect(requestObject.auth.basic).toBe(null);
+ expect(requestObject.auth.bearer).toBe(null);
+ expect(requestObject.auth.awsv4).toBe(null);
+ expect(requestObject.auth.apikey).toBe(null);
+ expect(requestObject.auth.oauth2).toBe(null);
+ expect(requestObject.auth.digest).toBe(null);
+ });
+});
diff --git a/packages/bruno-converters/tests/postman/postman-to-bruno/request-auth.spec.js b/packages/bruno-converters/tests/postman/postman-to-bruno/request-auth.spec.js
new file mode 100644
index 000000000..09cc712c9
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-to-bruno/request-auth.spec.js
@@ -0,0 +1,395 @@
+import { describe, it, expect } from '@jest/globals';
+import postmanToBruno from '../../../src/postman/postman-to-bruno';
+
+describe('Request Authentication', () => {
+
+
+ it('should handle basic auth at request level', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Request Auth Collection',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [
+ {
+ name: 'Basic Auth Request',
+ request: {
+ method: 'GET',
+ url: 'https://api.example.com/test',
+ auth: {
+ type: 'basic',
+ basic: [
+ { key: 'username', value: 'requestuser' },
+ { key: 'password', value: 'requestpass' }
+ ]
+ }
+ }
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.items[0].request.auth).toEqual({
+ mode: 'basic',
+ basic: {
+ username: 'requestuser',
+ password: 'requestpass'
+ },
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should inherit folder auth when request has no auth', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Inherit Request Auth Collection',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [
+ {
+ name: 'Auth Folder',
+ auth: {
+ type: 'bearer',
+ bearer: [{ key: 'token', value: 'foldertoken' }]
+ },
+ item: [
+ {
+ name: 'Inherit Auth Request',
+ request: {
+ method: 'GET',
+ url: 'https://api.example.com/test'
+ }
+ }
+ ]
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.items[0].items[0].request.auth).toEqual({
+ mode: 'inherit',
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle "Inherit Auth" for request (auth property absent, inherits from folder)', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Request Inherit Auth from Folder',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [
+ {
+ name: 'Auth Folder',
+ auth: { // Folder has auth
+ type: 'bearer',
+ bearer: [{ key: 'token', value: 'foldertoken' }]
+ },
+ item: [
+ {
+ name: 'Inheriting Request',
+ request: {
+ method: 'GET',
+ url: 'https://api.example.com/test'
+ // auth property is ABSENT for this request, meaning "Inherit auth from parent"
+ }
+ }
+ ]
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.items[0].items[0].request.auth).toEqual({
+ mode: 'inherit',
+ basic: null,
+ bearer: null, // It should NOT have the folder's token directly here after import
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle "Inherit Auth" for request (auth property absent, inherits from collection if folder also inherits)', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Request Inherit Auth from Collection',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ auth: { // Collection has auth
+ type: 'basic',
+ basic: [
+
+ { key: 'username', value: 'requestuser' },
+ { key: 'password', value: 'requestpass' }
+ ]
+ },
+ item: [
+ {
+ name: 'Inheriting Folder',
+ // auth property is ABSENT for this folder
+ item: [
+ {
+ name: 'Inheriting Request',
+ request: {
+ method: 'GET',
+ url: 'https://api.example.com/test'
+ // auth property is ABSENT for this request
+ }
+ }
+ ]
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ // Check folder first
+ expect(result.items[0].root.request.auth).toEqual({
+ mode: 'inherit',
+ basic: null, bearer: null, awsv4: null, apikey: null, oauth2: null, digest: null
+ });
+ // Then check request
+ expect(result.items[0].items[0].request.auth).toEqual({
+ mode: 'inherit',
+ basic: null, bearer: null, awsv4: null, apikey: null, oauth2: null, digest: null
+ });
+ });
+
+ it('should handle explicit "No Auth" at request level', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Request No Auth',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ item: [
+ {
+ name: 'Auth Folder', // Parent folder might have auth
+ auth: {
+ type: 'bearer',
+ bearer: [{ key: 'token', value: 'foldertoken' }]
+ },
+ item: [
+ {
+ name: 'Explicit No Auth Request',
+ request: {
+ method: 'GET',
+ url: 'https://api.example.com/test',
+ auth: { // Request explicitly set to "No Auth"
+ type: 'noauth'
+ }
+ }
+ }
+ ]
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ expect(result.items[0].items[0].request.auth).toEqual({
+ mode: 'none', // <<<< KEY CHECK
+ basic: null,
+ bearer: null,
+ awsv4: null,
+ apikey: null,
+ oauth2: null,
+ digest: null
+ });
+ });
+
+ it('should handle "Inherit Auth" for a request nested under multiple inheriting folders', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Multi-Level Inherit Auth',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ auth: { // Collection level auth
+ type: 'basic',
+ basic: [
+ { key: 'username', value: 'collectionUser' },
+ { key: 'password', value: 'collectionPass' }
+ ]
+ },
+ item: [
+ {
+ name: 'Folder Level 1 (Inherit)',
+ // auth property is ABSENT for this folder, meaning "Inherit"
+ item: [
+ {
+ name: 'Folder Level 2 (Inherit)',
+ // auth property is ABSENT for this folder, meaning "Inherit"
+ item: [
+ {
+ name: 'Deeply Nested Request (Inherit)',
+ request: {
+ method: 'GET',
+ url: 'https://api.example.com/deep'
+ // auth property is ABSENT for this request, meaning "Inherit"
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ // Check Folder Level 1
+ expect(result.items[0].root.request.auth).toEqual({
+ mode: 'inherit',
+ basic: null, bearer: null, awsv4: null, apikey: null, oauth2: null, digest: null
+ });
+
+ // Check Folder Level 2
+ expect(result.items[0].items[0].root.request.auth).toEqual({
+ mode: 'inherit',
+ basic: null, bearer: null, awsv4: null, apikey: null, oauth2: null, digest: null
+ });
+
+ // Check the Request
+ expect(result.items[0].items[0].items[0].request.auth).toEqual({
+ mode: 'inherit',
+ basic: null, bearer: null, awsv4: null, apikey: null, oauth2: null, digest: null
+ });
+ });
+
+ it('should handle "Inherit Auth" where an intermediate folder has explicit auth', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Multi-Level Inherit with Override',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ auth: { // Collection level auth
+ type: 'basic',
+ basic: [
+ { key: 'username', value: 'collectionUser' },
+ { key: 'password', value: 'collectionPass' }
+ ]
+ },
+ item: [
+ {
+ name: 'Folder Level 1 (Explicit Bearer)',
+ auth: { // This folder has its own auth
+ type: 'bearer',
+ bearer: [{ key: 'token', value: 'folder1Token' }]
+ },
+ item: [
+ {
+ name: 'Folder Level 2 (Inherit from Folder 1)',
+ // auth property is ABSENT for this folder, meaning "Inherit"
+ item: [
+ {
+ name: 'Deeply Nested Request (Inherit from Folder 1 via Folder 2)',
+ request: {
+ method: 'GET',
+ url: 'https://api.example.com/deep_override'
+ // auth property is ABSENT for this request, meaning "Inherit"
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ // Check Folder Level 1
+ expect(result.items[0].root.request.auth).toEqual({
+ mode: 'bearer',
+ basic: null,
+ bearer: { token: 'folder1Token' }, // Explicitly set
+ awsv4: null, apikey: null, oauth2: null, digest: null
+ });
+
+ // Check Folder Level 2
+ expect(result.items[0].items[0].root.request.auth).toEqual({
+ mode: 'inherit', // Inherits from Folder 1
+ basic: null, bearer: null, awsv4: null, apikey: null, oauth2: null, digest: null
+ });
+
+ // Check the Request
+ expect(result.items[0].items[0].items[0].request.auth).toEqual({
+ mode: 'inherit', // Inherits from Folder 1
+ basic: null, bearer: null, awsv4: null, apikey: null, oauth2: null, digest: null
+ });
+ });
+
+ it('should handle "Inherit Auth" where an intermediate folder has explicit "No Auth"', async () => {
+ const postmanCollection = {
+ info: {
+ name: 'Multi-Level Inherit with No Auth Stop',
+ schema: 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'
+ },
+ auth: { // Collection level auth
+ type: 'basic',
+ basic: [
+ { key: 'username', value: 'collectionUser' },
+ { key: 'password', value: 'collectionPass' }
+ ]
+ },
+ item: [
+ {
+ name: 'Folder Level 1 (Explicit No Auth)',
+ auth: { // This folder is explicitly "No Auth"
+ type: 'noauth'
+ },
+ item: [
+ {
+ name: 'Folder Level 2 (Inherit from Folder 1 - so No Auth)',
+ // auth property is ABSENT for this folder, meaning "Inherit"
+ item: [
+ {
+ name: 'Deeply Nested Request (Inherit from Folder 1 via Folder 2 - so No Auth)',
+ request: {
+ method: 'GET',
+ url: 'https://api.example.com/deep_no_auth_stop'
+ // auth property is ABSENT for this request, meaning "Inherit"
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ };
+
+ const result = await postmanToBruno(postmanCollection);
+
+ // Check Folder Level 1
+ expect(result.items[0].root.request.auth).toEqual({
+ mode: 'none', // Explicitly "No Auth"
+ basic: null, bearer: null, awsv4: null, apikey: null, oauth2: null, digest: null
+ });
+
+ // Check Folder Level 2
+ expect(result.items[0].items[0].root.request.auth).toEqual({
+ mode: 'inherit', // Inherits from Folder 1
+ basic: null, bearer: null, awsv4: null, apikey: null, oauth2: null, digest: null
+ });
+
+ // Check the Request
+ expect(result.items[0].items[0].items[0].request.auth).toEqual({
+ mode: 'inherit', // Inherits from Folder 1
+ basic: null, bearer: null, awsv4: null, apikey: null, oauth2: null, digest: null
+ });
+ });
+
+});
diff --git a/packages/bruno-converters/tests/postman/postman-translations/postman-comments.spec.js b/packages/bruno-converters/tests/postman/postman-translations/postman-comments.spec.js
new file mode 100644
index 000000000..ba3f29d37
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/postman-comments.spec.js
@@ -0,0 +1,53 @@
+const { default: postmanTranslation } = require("../../../src/postman/postman-translations");
+
+describe('postmanTranslations - comment handling', () => {
+ test('should not translate non-pm commands', () => {
+ const inputScript = `
+ console.log('This script does not contain pm commands.');
+ const data = pm.environment.get('key');
+ pm.collectionVariables.set('key', data);
+ `;
+ const expectedOutput = `
+ console.log('This script does not contain pm commands.');
+ const data = bru.getEnvVar('key');
+ bru.setVar('key', data);
+ `;
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should comment non-translated pm commands', () => {
+ const inputScript = "pm.test('random test', () => pm.globals.clear());";
+ const expectedOutput = "// test('random test', () => pm.globals.clear());";
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should handle multiple pm commands on the same line', () => {
+ const inputScript = "pm.environment.get('key'); pm.environment.set('key', 'value');";
+ const expectedOutput = "bru.getEnvVar('key'); bru.setEnvVar('key', 'value');";
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should handle comments and other JavaScript code', () => {
+ const inputScript = `
+ // This is a comment
+ const value = 'test';
+ pm.environment.set('key', value);
+ /*
+ Multi-line comment
+ */
+ const result = pm.environment.get('key');
+ console.log('Result:', result);
+ `;
+ const expectedOutput = `
+ // This is a comment
+ const value = 'test';
+ bru.setEnvVar('key', value);
+ /*
+ Multi-line comment
+ */
+ const result = bru.getEnvVar('key');
+ console.log('Result:', result);
+ `;
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/postman-cookie-conversions.spec.js b/packages/bruno-converters/tests/postman/postman-translations/postman-cookie-conversions.spec.js
new file mode 100644
index 000000000..e4fe0ee32
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/postman-cookie-conversions.spec.js
@@ -0,0 +1,319 @@
+const { default: postmanTranslation } = require("../../../src/postman/postman-translations");
+
+describe('postmanTranslations - cookie API conversions', () => {
+ test('should convert pm.cookies.jar().get to bru.cookies.jar().getCookie', () => {
+ const inputScript = `pm.cookies.jar().get('https://example.com', 'sessionId', (err, cookie) => {
+ console.log(cookie);
+ });`;
+
+ const expectedOutput = `bru.cookies.jar().getCookie('https://example.com', 'sessionId', (err, cookie) => {
+ console.log(cookie);
+ });`;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should convert pm.cookies.jar().getAll to bru.cookies.jar().getCookies', () => {
+ const inputScript = `pm.cookies.jar().getAll('https://example.com', (err, cookies) => {
+ console.log(cookies);
+ });`;
+
+ const expectedOutput = `bru.cookies.jar().getCookies('https://example.com', (err, cookies) => {
+ console.log(cookies);
+ });`;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should convert pm.cookies.jar().set to bru.cookies.jar().setCookie', () => {
+ const inputScript = `pm.cookies.jar().set('https://example.com', 'sessionId', 'abc123', (err) => {
+ if (err) console.error(err);
+ });`;
+
+ const expectedOutput = `bru.cookies.jar().setCookie('https://example.com', 'sessionId', 'abc123', (err) => {
+ if (err) console.error(err);
+ });`;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should convert pm.cookies.jar().unset to bru.cookies.jar().deleteCookie', () => {
+ const inputScript = `pm.cookies.jar().unset('https://example.com', 'sessionId', (err) => {
+ if (err) console.error(err);
+ });`;
+
+ const expectedOutput = `bru.cookies.jar().deleteCookie('https://example.com', 'sessionId', (err) => {
+ if (err) console.error(err);
+ });`;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should convert pm.cookies.jar().clear to bru.cookies.jar().deleteCookies (behavior difference)', () => {
+ const inputScript = `pm.cookies.jar().clear('https://example.com', (err) => {
+ if (err) console.error(err);
+ });`;
+
+ const expectedOutput = `bru.cookies.jar().deleteCookies('https://example.com', (err) => {
+ if (err) console.error(err);
+ });`;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should handle multiple cookie operations in one script', () => {
+ const inputScript = `
+ pm.cookies.jar().set('https://api.example.com', 'auth', 'token123');
+ const cookie = pm.cookies.jar().get('https://api.example.com', 'auth');
+ pm.cookies.jar().getAll('https://api.example.com', (err, cookies) => {
+ console.log('All cookies:', cookies);
+ });
+ pm.cookies.jar().unset('https://api.example.com', 'temp');
+ pm.cookies.jar().clear('https://api.example.com');
+ `;
+
+ const expectedOutput = `
+ bru.cookies.jar().setCookie('https://api.example.com', 'auth', 'token123');
+ const cookie = bru.cookies.jar().getCookie('https://api.example.com', 'auth');
+ bru.cookies.jar().getCookies('https://api.example.com', (err, cookies) => {
+ console.log('All cookies:', cookies);
+ });
+ bru.cookies.jar().deleteCookie('https://api.example.com', 'temp');
+ bru.cookies.jar().deleteCookies('https://api.example.com');
+ `;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should convert variable assignment and method calls on cookie jar variables', () => {
+ const inputScript = `
+ const jar = pm.cookies.jar();
+ jar.set('https://example.com', 'user', 'john');
+ const userCookie = jar.get('https://example.com', 'user');
+ `;
+
+ const expectedOutput = `
+ const jar = bru.cookies.jar();
+ jar.setCookie('https://example.com', 'user', 'john');
+ const userCookie = jar.getCookie('https://example.com', 'user');
+ `;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should convert jar.get to jar.getCookie with callback', () => {
+ const inputScript = `
+ const jar = pm.cookies.jar();
+ jar.get('https://api.example.com', 'authToken', (error, cookie) => {
+ if (error) {
+ console.error('Error getting cookie:', error);
+ } else {
+ console.log('Retrieved cookie:', cookie);
+ }
+ });
+ `;
+
+ const expectedOutput = `
+ const jar = bru.cookies.jar();
+ jar.getCookie('https://api.example.com', 'authToken', (error, cookie) => {
+ if (error) {
+ console.error('Error getting cookie:', error);
+ } else {
+ console.log('Retrieved cookie:', cookie);
+ }
+ });
+ `;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should convert jar.getAll to jar.getCookies with callback', () => {
+ const inputScript = `
+ const jar = pm.cookies.jar();
+ jar.getAll('https://api.example.com', (error, cookies) => {
+ if (error) {
+ console.error('Error getting cookies:', error);
+ } else {
+ console.log('All cookies:', cookies);
+ }
+ });
+ `;
+
+ const expectedOutput = `
+ const jar = bru.cookies.jar();
+ jar.getCookies('https://api.example.com', (error, cookies) => {
+ if (error) {
+ console.error('Error getting cookies:', error);
+ } else {
+ console.log('All cookies:', cookies);
+ }
+ });
+ `;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should convert jar.set to jar.setCookie with cookie object', () => {
+ const inputScript = `
+ const jar = pm.cookies.jar();
+ jar.set('https://api.example.com', {
+ key: 'sessionId',
+ value: 'abc123',
+ path: '/api',
+ httpOnly: true,
+ secure: true
+ }, (error) => {
+ if (error) console.error(error);
+ });
+ `;
+
+ const expectedOutput = `
+ const jar = bru.cookies.jar();
+ jar.setCookie('https://api.example.com', {
+ key: 'sessionId',
+ value: 'abc123',
+ path: '/api',
+ httpOnly: true,
+ secure: true
+ }, (error) => {
+ if (error) console.error(error);
+ });
+ `;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should convert jar.unset to jar.deleteCookie', () => {
+ const inputScript = `
+ const jar = pm.cookies.jar();
+ jar.unset('https://api.example.com', 'tempCookie', (error) => {
+ if (error) {
+ console.error('Failed to delete cookie:', error);
+ } else {
+ console.log('Cookie deleted successfully');
+ }
+ });
+ `;
+
+ const expectedOutput = `
+ const jar = bru.cookies.jar();
+ jar.deleteCookie('https://api.example.com', 'tempCookie', (error) => {
+ if (error) {
+ console.error('Failed to delete cookie:', error);
+ } else {
+ console.log('Cookie deleted successfully');
+ }
+ });
+ `;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should convert jar.clear to jar.deleteCookies', () => {
+ const inputScript = `
+ const jar = pm.cookies.jar();
+ jar.clear('https://api.example.com', (error) => {
+ if (error) {
+ console.error('Failed to clear cookies:', error);
+ } else {
+ console.log('All cookies cleared for domain');
+ }
+ });
+ `;
+
+ const expectedOutput = `
+ const jar = bru.cookies.jar();
+ jar.deleteCookies('https://api.example.com', (error) => {
+ if (error) {
+ console.error('Failed to clear cookies:', error);
+ } else {
+ console.log('All cookies cleared for domain');
+ }
+ });
+ `;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should handle complex cookie workflow with jar variable', () => {
+ const inputScript = `
+ const cookieJar = pm.cookies.jar();
+
+ // Set multiple cookies
+ cookieJar.set('https://example.com', 'auth', 'token123');
+ cookieJar.set('https://example.com', {
+ key: 'preferences',
+ value: JSON.stringify({theme: 'dark'}),
+ path: '/'
+ });
+
+ // Get specific cookie
+ cookieJar.get('https://example.com', 'auth', (err, authCookie) => {
+ console.log('Auth cookie:', authCookie);
+ });
+
+ // Get all cookies
+ cookieJar.getAll('https://example.com', (err, allCookies) => {
+ console.log('Total cookies:', allCookies.length);
+ });
+
+ // Clean up
+ cookieJar.unset('https://example.com', 'temp');
+ cookieJar.clear('https://example.com');
+ `;
+
+ const expectedOutput = `
+ const cookieJar = bru.cookies.jar();
+
+ // Set multiple cookies
+ cookieJar.setCookie('https://example.com', 'auth', 'token123');
+ cookieJar.setCookie('https://example.com', {
+ key: 'preferences',
+ value: JSON.stringify({theme: 'dark'}),
+ path: '/'
+ });
+
+ // Get specific cookie
+ cookieJar.getCookie('https://example.com', 'auth', (err, authCookie) => {
+ console.log('Auth cookie:', authCookie);
+ });
+
+ // Get all cookies
+ cookieJar.getCookies('https://example.com', (err, allCookies) => {
+ console.log('Total cookies:', allCookies.length);
+ });
+
+ // Clean up
+ cookieJar.deleteCookie('https://example.com', 'temp');
+ cookieJar.deleteCookies('https://example.com');
+ `;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+
+ test('should handle mixed jar variable and direct calls', () => {
+ const inputScript = `
+ const jar = pm.cookies.jar();
+ jar.get('https://api.com', 'session');
+
+ pm.cookies.jar().set('https://other.com', 'temp', 'value');
+
+ jar.getAll('https://api.com', (err, cookies) => {
+ console.log(cookies);
+ });
+ `;
+
+ const expectedOutput = `
+ const jar = bru.cookies.jar();
+ jar.getCookie('https://api.com', 'session');
+
+ bru.cookies.jar().setCookie('https://other.com', 'temp', 'value');
+
+ jar.getCookies('https://api.com', (err, cookies) => {
+ console.log(cookies);
+ });
+ `;
+
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/postman-edge-cases.spec.js b/packages/bruno-converters/tests/postman/postman-translations/postman-edge-cases.spec.js
new file mode 100644
index 000000000..d304026ea
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/postman-edge-cases.spec.js
@@ -0,0 +1,47 @@
+const { default: postmanTranslation } = require("../../../src/postman/postman-translations");
+
+describe('postmanTranslations - edge cases', () => {
+ test('should handle nested commands and edge cases', () => {
+ const inputScript = `
+ const sampleObjects = [
+ {
+ key: pm.environment.get('key'),
+ value: pm.variables.get('value')
+ },
+ {
+ key: pm.collectionVariables.get('key'),
+ value: pm.collectionVariables.get('value')
+ }
+ ];
+ const dataTesting = Object.entries(sampleObjects || {}).reduce((acc, [key, value]) => {
+ // this is a comment
+ acc[key] = pm.collectionVariables.get(pm.environment.get(value));
+ return acc; // Return the accumulator
+ }, {});
+ Object.values(dataTesting).forEach((data) => {
+ pm.environment.set(data.key, pm.variables.get(data.value));
+ });
+ `;
+ const expectedOutput = `
+ const sampleObjects = [
+ {
+ key: bru.getEnvVar('key'),
+ value: bru.getVar('value')
+ },
+ {
+ key: bru.getVar('key'),
+ value: bru.getVar('value')
+ }
+ ];
+ const dataTesting = Object.entries(sampleObjects || {}).reduce((acc, [key, value]) => {
+ // this is a comment
+ acc[key] = bru.getVar(bru.getEnvVar(value));
+ return acc; // Return the accumulator
+ }, {});
+ Object.values(dataTesting).forEach((data) => {
+ bru.setEnvVar(data.key, bru.getVar(data.value));
+ });
+ `;
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/postman-test-commands.spec.js b/packages/bruno-converters/tests/postman/postman-translations/postman-test-commands.spec.js
new file mode 100644
index 000000000..7c75b518e
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/postman-test-commands.spec.js
@@ -0,0 +1,23 @@
+const { default: postmanTranslation } = require("../../../src/postman/postman-translations");
+
+describe('postmanTranslations - test commands', () => {
+ test('should handle test commands', () => {
+ const inputScript = `
+ pm.test('Status code is 200', () => {
+ pm.response.to.have.status(200);
+ });
+ pm.test('this test will fail', () => {
+ return false
+ });
+ `;
+ const expectedOutput = `
+ test('Status code is 200', () => {
+ expect(res.getStatus()).to.equal(200);
+ });
+ test('this test will fail', () => {
+ return false
+ });
+ `;
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/postman-variables.spec.js b/packages/bruno-converters/tests/postman/postman-translations/postman-variables.spec.js
new file mode 100644
index 000000000..70801f295
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/postman-variables.spec.js
@@ -0,0 +1,25 @@
+const { default: postmanTranslation } = require("../../../src/postman/postman-translations");
+
+describe('postmanTranslations - variables commands', () => {
+ test('should translate variable commands correctly', () => {
+ const inputScript = `
+ pm.environment.get('key');
+ pm.environment.set('key', 'value');
+ pm.variables.get('key');
+ pm.variables.set('key', 'value');
+ pm.collectionVariables.get('key');
+ pm.collectionVariables.set('key', 'value');
+ pm.expect(pm.environment.has('key')).to.be.true;
+ `;
+ const expectedOutput = `
+ bru.getEnvVar('key');
+ bru.setEnvVar('key', 'value');
+ bru.getVar('key');
+ bru.setVar('key', 'value');
+ bru.getVar('key');
+ bru.setVar('key', 'value');
+ expect(bru.getEnvVar('key') !== undefined && bru.getEnvVar('key') !== null).to.be.true;
+ `;
+ expect(postmanTranslation(inputScript)).toBe(expectedOutput);
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/combined.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/combined.test.js
new file mode 100644
index 000000000..4916a10c0
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/combined.test.js
@@ -0,0 +1,495 @@
+import translateCode from '../../../../src/utils/jscode-shift-translator';
+
+describe('Combined API Features Translation', () => {
+ // Basic translation test
+ it('should translate code', () => {
+ const code = 'console.log("Hello, world!");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(code);
+ });
+
+ // Preserving comments
+ it('should preserve comments', () => {
+ const code = '// This is a comment';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('// This is a comment');
+ });
+
+ it('should preserve comments inside functions', () => {
+ const code = `
+ function getUserDetails() {
+ // Get user details from API
+ const response = pm.response.json();
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ function getUserDetails() {
+ // Get user details from API
+ const response = res.getBody();
+ }
+ `);
+ });
+
+ it('should preserve comments inside if statements', () => {
+ const code = `
+ if (pm.response.code === 200) {
+ // Success
+ console.log("Success");
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ if (res.getStatus() === 200) {
+ // Success
+ console.log("Success");
+ }
+ `);
+ });
+
+ it('should preserve multiline comments', () => {
+ const code = `
+ /*
+ This is a multiline comment
+ */
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ /*
+ This is a multiline comment
+ */
+ `);
+ });
+
+ it('should preserve comments inside for loops', () => {
+ const code = `
+ for (let i = 0; i < 10; i++) {
+ // Loop iteration
+ console.log(pm.response.json()[i]);
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ for (let i = 0; i < 10; i++) {
+ // Loop iteration
+ console.log(res.getBody()[i]);
+ }
+ `);
+ });
+
+ // Multiple transformations in the same code block
+ it('should handle multiple translations in the same code block', () => {
+ const code = `
+ const token = pm.environment.get("authToken");
+ pm.test("Auth flow works", function() {
+ const response = pm.response.json();
+ pm.expect(response.authenticated).to.be.true;
+ pm.environment.set("userId", response.user.id);
+ pm.collectionVariables.set("sessionId", response.session.id);
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).not.toContain('pm.test("Auth flow works", function() {');
+ expect(translatedCode).not.toContain('pm.expect(response.authenticated).to.be.true;');
+ expect(translatedCode).not.toContain('pm.environment.set("userId", response.user.id);');
+ expect(translatedCode).not.toContain('pm.collectionVariables.set("sessionId", response.session.id);');
+ expect(translatedCode).toContain('const token = bru.getEnvVar("authToken");');
+ expect(translatedCode).toContain('test("Auth flow works", function() {');
+ expect(translatedCode).toContain('const response = res.getBody();');
+ expect(translatedCode).toContain('expect(response.authenticated).to.be.true;');
+ expect(translatedCode).toContain('bru.setEnvVar("userId", response.user.id);');
+ expect(translatedCode).toContain('bru.setVar("sessionId", response.session.id);');
+ });
+
+ // Nested expressions
+ it('should handle nested Postman API calls', () => {
+ const code = 'pm.environment.set("computed", pm.variables.get("base") + "-suffix");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.setEnvVar("computed", bru.getVar("base") + "-suffix");');
+ });
+
+ it('should handle more complex nested expressions', () => {
+ const code = 'pm.collectionVariables.set("fullPath", pm.environment.get("baseUrl") + pm.variables.get("endpoint"));';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.setVar("fullPath", bru.getEnvVar("baseUrl") + bru.getVar("endpoint"));');
+ });
+
+ // Unrelated code
+ it('should leave unrelated code untouched', () => {
+ const code = `
+ function calculateTotal(items) {
+ return items.reduce((sum, item) => sum + item.price, 0);
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(code);
+ });
+
+ it('should handle Postman API calls within JavaScript methods', () => {
+ const code = `
+ const helpers = {
+ getAuthHeader: function() {
+ return "Bearer " + pm.environment.get("token");
+ }
+ };
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('return "Bearer " + bru.getEnvVar("token");');
+ });
+
+
+ it('should handle aliases with object destructuring', () => {
+ const code = `
+ const { environment, variables } = pm;
+ environment.set("token", "abc123");
+ variables.get("userId");
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe(`
+ bru.setEnvVar("token", "abc123");
+ bru.getVar("userId");
+ `);
+ });
+
+ // Code context tests
+ it('should translate pm commands inside functions', () => {
+ const code = `
+ function getAuthHeader() {
+ return "Bearer " + pm.environment.get("token");
+ }
+ `;
+
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ function getAuthHeader() {
+ return "Bearer " + bru.getEnvVar("token");
+ }
+ `);
+ });
+
+ it('should translate pm commands inside if statements', () => {
+ const code = `
+ if (pm.response.code === 200) {
+ console.log("Success");
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ if (res.getStatus() === 200) {
+ console.log("Success");
+ }
+ `);
+ });
+
+
+ it('should translate pm commands inside if statements', () => {
+ const code = `
+ const json = pm.response.json();
+ if (json.code === 200) {
+ console.log("Success");
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const json = res.getBody();
+ if (json.code === 200) {
+ console.log("Success");
+ }
+ `);
+ });
+
+ it('should translate pm commands inside else statements', () => {
+ const code = `
+ if (pm.response.code === 200) {
+ console.log("Success");
+ pm.response.to.have.status(200);
+ } else {
+ console.log("Failure");
+ expect(res.getStatus()).to.equal(400);
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ if (res.getStatus() === 200) {
+ console.log("Success");
+ expect(res.getStatus()).to.equal(200);
+ } else {
+ console.log("Failure");
+ expect(res.getStatus()).to.equal(400);
+ }
+ `);
+ });
+
+ it('should translate pm commands inside for loops', () => {
+ const code = `
+ for (let i = 0; i < pm.response.json().length; i++) {
+ console.log(pm.response.json()[i]);
+ }
+ `;
+
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ for (let i = 0; i < res.getBody().length; i++) {
+ console.log(res.getBody()[i]);
+ }
+ `);
+ });
+
+ it('should translate pm commands inside while loops', () => {
+ const code = `
+ while (pm.response.code === 200) {
+ console.log("Success");
+ }
+ `;
+
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ while (res.getStatus() === 200) {
+ console.log("Success");
+ }
+ `);
+ });
+
+ it('should translate pm commands inside switch statements', () => {
+ const code = `
+ switch (pm.response.code) {
+ case 200:
+ console.log("Success");
+ break;
+ }
+ `;
+
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ switch (res.getStatus()) {
+ case 200:
+ console.log("Success");
+ break;
+ }
+ `);
+ });
+
+ it('should translate pm commands inside try catch statements', () => {
+ const code = `
+ try {
+ pm.response.to.have.status(200);
+ } catch (error) {
+ console.log("Failure");
+ expect(res.getStatus()).to.equal(400);
+ }
+ `;
+
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ try {
+ expect(res.getStatus()).to.equal(200);
+ } catch (error) {
+ console.log("Failure");
+ expect(res.getStatus()).to.equal(400);
+ }
+ `);
+ });
+
+ it('should translate aliases within if statements block', () => {
+ const code = `
+ const env = pm.environment;
+ const vars = pm.variables;
+ const collVars = pm.collectionVariables;
+ const test = pm.test;
+ const expect = pm.expect;
+ const response = pm.response;
+
+ function processResponse() {
+ if(response.code === 200) {
+ console.log("Success");
+ } else if(response.code === 400) {
+ console.log("Failure");
+ expect(response.code).to.equal(400);
+ } else {
+ console.log("Unknown status code");
+ expect(response.code).to.equal(500);
+ }
+ }
+ `;
+
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ function processResponse() {
+ if(res.getStatus() === 200) {
+ console.log("Success");
+ } else if(res.getStatus() === 400) {
+ console.log("Failure");
+ expect(res.getStatus()).to.equal(400);
+ } else {
+ console.log("Unknown status code");
+ expect(res.getStatus()).to.equal(500);
+ }
+ }
+ `);
+ });
+
+ it('should handle pm aliases inside functions', () => {
+ const code = `
+ const tempRes = pm.response;
+ const tempTest = pm.test;
+ const tempExpect = pm.expect;
+ const tempEnv = pm.environment;
+ const tempVars = pm.variables;
+ const tempCollVars = pm.collectionVariables;
+
+ function processResponse() {
+ tempTest("Status code is 200", function() { expect(tempRes.code).to.equal(200); });
+ tempEnv.set("userId", tempRes.json().userId);
+ tempVars.set("token", tempRes.json().token);
+ tempCollVars.set("sessionId", tempRes.json().sessionId);
+ }
+ `;
+
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe(`
+ function processResponse() {
+ test("Status code is 200", function() { expect(res.getStatus()).to.equal(200); });
+ bru.setEnvVar("userId", res.getBody().userId);
+ bru.setVar("token", res.getBody().token);
+ bru.setVar("sessionId", res.getBody().sessionId);
+ }
+ `);
+ });
+
+ it('should nested pm commands', () => {
+ const code = `
+ pm.collectionVariables.get(pm.environment.get('key'))
+ pm.test("Status code is 200", function() {
+ pm.response.to.have.status(200);
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ bru.getVar(bru.getEnvVar('key'))
+ test("Status code is 200", function() {
+ expect(res.getStatus()).to.equal(200);
+ });
+ `);
+ });
+
+ it('should handle pm objects in template literals', () => {
+ const code = `
+ const baseUrl = pm.environment.get("baseUrl");
+ const endpoint = pm.variables.get("endpoint");
+ const url = \`\${baseUrl}/api/\${endpoint}\`;
+ console.log(\`Response status: \${pm.response.code}\`);
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const baseUrl = bru.getEnvVar("baseUrl");');
+ expect(translatedCode).toContain('const endpoint = bru.getVar("endpoint");');
+ expect(translatedCode).toContain('const url = `${baseUrl}/api/${endpoint}`;');
+ expect(translatedCode).toContain('console.log(`Response status: ${res.getStatus()}`);');
+ });
+
+ it('should handle pm objects in arrow functions', () => {
+ const code = `
+ const getAuthHeader = () => "Bearer " + pm.environment.get("token");
+ const processItems = items => items.forEach(item => {
+ pm.variables.set(item.key, item.value);
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const getAuthHeader = () => "Bearer " + bru.getEnvVar("token");');
+ expect(translatedCode).toContain('const processItems = items => items.forEach(item => {');
+ expect(translatedCode).toContain('bru.setVar(item.key, item.value);');
+ });
+
+ it('test', () => {
+ const code = `
+ const globals = pm.globals;
+ const key = globals.get("key");
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const key = bru.getGlobalEnvVar("key");
+ `);
+ })
+
+ it('should handle pm.response.to.have.body integrated with other assertions', () => {
+ const code = `
+ pm.test("Response validation", function() {
+ pm.response.to.have.status(200);
+ pm.response.to.have.body({"success": true});
+ pm.response.to.have.header("Content-Type", "application/json");
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ const expectedOutput = `
+ test("Response validation", function() {
+ expect(res.getStatus()).to.equal(200);
+ expect(res.getBody()).to.equal({"success": true});
+ expect(res.getHeaders()).to.have.property("Content-Type".toLowerCase(), "application/json");
+ });
+ `;
+ expect(translatedCode).toBe(expectedOutput);
+ });
+
+ it('should handle pm.response.to.have.body with dynamic content', () => {
+ const code = `
+ const expectedResponse = {
+ id: pm.environment.get("userId"),
+ token: pm.variables.get("authToken"),
+ timestamp: new Date().getTime()
+ };
+
+ pm.test("Dynamic response validation", function() {
+ pm.response.to.have.body(expectedResponse);
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ const expectedOutput = `
+ const expectedResponse = {
+ id: bru.getEnvVar("userId"),
+ token: bru.getVar("authToken"),
+ timestamp: new Date().getTime()
+ };
+
+ test("Dynamic response validation", function() {
+ expect(res.getBody()).to.equal(expectedResponse);
+ });
+ `
+ expect(translatedCode).toBe(expectedOutput);
+ });
+
+ it('should handle pm.response.to.have.body in control structures', () => {
+ const code = `
+ const jsonData = pm.response.json();
+
+ if (jsonData.status === "success") {
+ pm.response.to.have.body({
+ status: "success",
+ data: jsonData.data
+ });
+ } else {
+ pm.expect(jsonData.error).to.exist;
+ }
+ `;
+ const translatedCode = translateCode(code);
+
+ const expectedOutput = `
+ const jsonData = res.getBody();
+
+ if (jsonData.status === "success") {
+ expect(res.getBody()).to.equal({
+ status: "success",
+ data: jsonData.data
+ });
+ } else {
+ expect(jsonData.error).to.exist;
+ }
+ `;
+ expect(translatedCode).toBe(expectedOutput);
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/environment.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/environment.test.js
new file mode 100644
index 000000000..c3461f6de
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/environment.test.js
@@ -0,0 +1,242 @@
+import translateCode from '../../../../src/utils/jscode-shift-translator';
+
+describe('Environment Variable Translation', () => {
+ it('should translate pm.environment.get', () => {
+ const code = 'pm.environment.get("test");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.getEnvVar("test");');
+ });
+
+ it('should translate pm.environment.set', () => {
+ const code = 'pm.environment.set("test", "value");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.setEnvVar("test", "value");');
+ });
+
+ it('should translate pm.environment.has', () => {
+ const code = 'pm.environment.has("test")';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.getEnvVar("test") !== undefined && bru.getEnvVar("test") !== null');
+ });
+
+ it('should translate pm.environment.unset', () => {
+ const code = 'pm.environment.unset("test");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.deleteEnvVar("test");');
+ });
+
+ it('should translate pm.environment.name', () => {
+ const code = 'pm.environment.name;';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.getEnvName();');
+ });
+
+ it('should handle nested Postman API calls with environment', () => {
+ const code = 'pm.environment.set("computed", pm.variables.get("base") + "-suffix");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.setEnvVar("computed", bru.getVar("base") + "-suffix");');
+ });
+
+ it('should handle JSON operations with environment variables', () => {
+ const code = 'pm.environment.set("user", JSON.stringify({ id: 123, name: "John" }));';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.setEnvVar("user", JSON.stringify({ id: 123, name: "John" }));');
+ });
+
+ it('should handle JSON.parse with environment variables', () => {
+ const code = 'const userData = JSON.parse(pm.environment.get("user"));';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const userData = JSON.parse(bru.getEnvVar("user"));');
+ });
+
+ it('should translate pm.environment.name with different access patterns', () => {
+ const code = `
+ const envName1 = pm.environment.name;
+ const env = pm.environment;
+ const envName2 = env.name;
+ console.log(pm.environment.name);
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const envName1 = bru.getEnvName();
+ const envName2 = bru.getEnvName();
+ console.log(bru.getEnvName());
+ `);
+ });
+
+ it('should handle environment aliases', () => {
+ const code = `
+ const env = pm.environment;
+ const name = env.name;
+ const has = env.has("test");
+ const set = env.set("test", "value");
+ const get = env.get("test");
+ const unset = env.unset("test");
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const name = bru.getEnvName();
+ const has = bru.getEnvVar("test") !== undefined && bru.getEnvVar("test") !== null;
+ const set = bru.setEnvVar("test", "value");
+ const get = bru.getEnvVar("test");
+ const unset = bru.deleteEnvVar("test");
+ `);
+ });
+
+ // Legacy API (postman.) tests related to environment
+ it('should translate postman.setEnvironmentVariable', () => {
+ const code = 'postman.setEnvironmentVariable("apiKey", "abc123");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.setEnvVar("apiKey", "abc123");');
+ });
+
+ it('should translate postman.getEnvironmentVariable', () => {
+ const code = 'const baseUrl = postman.getEnvironmentVariable("baseUrl");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const baseUrl = bru.getEnvVar("baseUrl");');
+ });
+
+ it('should translate postman.clearEnvironmentVariable', () => {
+ const code = 'postman.clearEnvironmentVariable("tempToken");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.deleteEnvVar("tempToken");');
+ });
+
+ it('should handle all environment variable methods together', () => {
+ const code = `
+ // All environment variable methods
+ const envName = pm.environment.name;
+ const hasToken = pm.environment.has("token");
+ const token = pm.environment.get("token");
+ pm.environment.set("timestamp", new Date().toISOString());
+
+ console.log(\`Environment: \${envName}, Has token: \${hasToken}, Token: \${token}\`);
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const envName = bru.getEnvName();');
+ expect(translatedCode).toContain('const hasToken = bru.getEnvVar("token") !== undefined && bru.getEnvVar("token") !== null;');
+ expect(translatedCode).toContain('const token = bru.getEnvVar("token");');
+ expect(translatedCode).toContain('bru.setEnvVar("timestamp", new Date().toISOString());');
+ });
+
+ // Additional robust tests for environment variables
+ it('should handle environment variables with computed property names', () => {
+ const code = `
+ const prefix = "api";
+ const suffix = "Key";
+ pm.environment.set(prefix + "_" + suffix, "abc123");
+ const computedValue = pm.environment.get(prefix + "_" + suffix);
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('bru.setEnvVar(prefix + "_" + suffix, "abc123");');
+ expect(translatedCode).toContain('const computedValue = bru.getEnvVar(prefix + "_" + suffix);');
+ });
+
+ it('should handle environment variables in complex object structures', () => {
+ const code = `
+ const config = {
+ baseUrl: pm.environment.get("apiUrl"),
+ headers: {
+ "Authorization": "Bearer " + pm.environment.get("token"),
+ "X-Api-Key": pm.environment.get("apiKey") || "default-key"
+ },
+ timeout: parseInt(pm.environment.get("timeout") || "5000"),
+ validate: pm.environment.has("validateResponses")
+ };
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('baseUrl: bru.getEnvVar("apiUrl"),');
+ expect(translatedCode).toContain('"Authorization": "Bearer " + bru.getEnvVar("token"),');
+ expect(translatedCode).toContain('"X-Api-Key": bru.getEnvVar("apiKey") || "default-key"');
+ expect(translatedCode).toContain('timeout: parseInt(bru.getEnvVar("timeout") || "5000"),');
+ expect(translatedCode).toContain('validate: bru.getEnvVar("validateResponses") !== undefined && bru.getEnvVar("validateResponses") !== null');
+ });
+
+ it('should handle environment variables in conditionals correctly', () => {
+ const code = `
+ if (pm.environment.has("apiKey")) {
+ if (pm.environment.get("apiKey").length > 0) {
+ console.log("Valid API key exists");
+ } else {
+ console.log("API key is empty");
+ }
+ } else {
+ console.log("No API key defined");
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('if (bru.getEnvVar("apiKey") !== undefined && bru.getEnvVar("apiKey") !== null) {');
+ expect(translatedCode).toContain('if (bru.getEnvVar("apiKey").length > 0) {');
+ });
+
+ it('should handle multiple levels of environment variable aliasing', () => {
+ const code = `
+ const env = pm.environment;
+
+ env.set("key", "value");
+ const value = env.get("key");
+ const exists = env.has("key");
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ bru.setEnvVar("key", "value");
+ const value = bru.getEnvVar("key");
+ const exists = bru.getEnvVar("key") !== undefined && bru.getEnvVar("key") !== null;
+ `);
+ });
+
+ it('should handle environment variables with dynamic values', () => {
+ const code = `
+ // Generate a timestamp for this request
+ const timestamp = new Date().toISOString();
+ pm.environment.set("requestTimestamp", timestamp);
+
+ // Generate a unique ID
+ const uniqueId = "req_" + Math.random().toString(36).substring(2, 15);
+ pm.environment.set("requestId", uniqueId);
+
+ // Calculate an expiry time (30 minutes from now)
+ const expiryTime = new Date();
+ expiryTime.setMinutes(expiryTime.getMinutes() + 30);
+ pm.environment.set("tokenExpiry", expiryTime.getTime());
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('bru.setEnvVar("requestTimestamp", timestamp);');
+ expect(translatedCode).toContain('bru.setEnvVar("requestId", uniqueId);');
+ expect(translatedCode).toContain('bru.setEnvVar("tokenExpiry", expiryTime.getTime());');
+ });
+
+ it('should handle environment variables in try-catch blocks', () => {
+ const code = `
+ try {
+ const configStr = pm.environment.get("config");
+ const config = JSON.parse(configStr);
+ console.log("Config loaded:", config.version);
+ } catch (error) {
+ console.error("Failed to parse config");
+ pm.environment.set("configError", error.message);
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('const configStr = bru.getEnvVar("config");');
+ expect(translatedCode).toContain('bru.setEnvVar("configError", error.message);');
+ });
+
+ it('should handle legacy environment and pm.setEnvironmentVariable together', () => {
+ const code = `
+ // Legacy style
+ postman.setEnvironmentVariable("legacyKey", "legacyValue");
+
+ // Mixed with newer style
+ const value = pm.environment.get("anotherKey");
+
+ // Another legacy form
+ pm.setEnvironmentVariable("thirdKey", "thirdValue");
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('bru.setEnvVar("legacyKey", "legacyValue");');
+ expect(translatedCode).toContain('const value = bru.getEnvVar("anotherKey");');
+ expect(translatedCode).toContain('bru.setEnvVar("thirdKey", "thirdValue");');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/exec-flow.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/exec-flow.test.js
new file mode 100644
index 000000000..053e99685
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/exec-flow.test.js
@@ -0,0 +1,64 @@
+import translateCode from '../../../../src/utils/jscode-shift-translator';
+
+describe('Execution Flow Translation', () => {
+ // Request flow control
+ it('should translate pm.setNextRequest', () => {
+ const code = 'pm.setNextRequest("Get User Details");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.setNextRequest("Get User Details");');
+ });
+
+ it('should translate pm.execution.skipRequest', () => {
+ const code = 'if (condition) pm.execution.skipRequest();';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('if (condition) bru.runner.skipRequest();');
+ });
+
+ it('should translate pm.execution.setNextRequest(null)', () => {
+ const code = 'pm.execution.setNextRequest(null);';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.runner.stopExecution();');
+ });
+
+ it('should translate pm.execution.setNextRequest("null")', () => {
+ const code = 'pm.execution.setNextRequest("null");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.runner.stopExecution();');
+ });
+
+ it('should handle pm.execution.setNextRequest with non-null parameters', () => {
+ const code = `
+ // Continue normal flow
+ pm.execution.setNextRequest("Get user details");
+
+ // With variable
+ const nextReq = "Update profile";
+ pm.execution.setNextRequest(nextReq);
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('bru.runner.setNextRequest("Get user details");');
+ expect(translatedCode).toContain('bru.runner.setNextRequest(nextReq);');
+ });
+
+ it('should handle all execution control methods together', () => {
+ const code = `
+ // All execution control methods
+ if (pm.response.code === 401) {
+ pm.execution.skipRequest();
+ } else if (pm.response.code === 500) {
+ pm.execution.setNextRequest(null);
+ } else {
+ pm.setNextRequest("Get User Details");
+ }
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('if (res.getStatus() === 401) {');
+ expect(translatedCode).toContain('bru.runner.skipRequest();');
+ expect(translatedCode).toContain('} else if (res.getStatus() === 500) {');
+ expect(translatedCode).toContain('bru.runner.stopExecution();');
+ expect(translatedCode).toContain('} else {');
+ expect(translatedCode).toContain('bru.setNextRequest("Get User Details");');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/legacy-global-apis.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/legacy-global-apis.test.js
new file mode 100644
index 000000000..489bf734a
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/legacy-global-apis.test.js
@@ -0,0 +1,299 @@
+import translateCode from '../../../../src/utils/jscode-shift-translator.js';
+
+describe('Legacy Postman API Translation', () => {
+ describe('handleLegacyGlobalAPIs - No Conflicts', () => {
+ test('should translate responseBody when no user variables exist', () => {
+ const input = `
+ const data = JSON.parse(responseBody);
+`;
+
+ const result = translateCode(input);
+ const expected = `
+ const data = res.getBody();
+`;
+
+ expect(result).toEqual(expected);
+ });
+
+ test('should translate responseHeaders when no user variables exist', () => {
+ const input = `
+ console.log(responseHeaders);
+ const headers = responseHeaders;
+ `;
+
+ const result = translateCode(input);
+
+ expect(result).toContain('res.getHeaders()');
+ expect(result).not.toContain('responseHeaders');
+ });
+
+ test('should translate responseTime when no user variables exist', () => {
+ const input = `
+ console.log(responseTime);
+ const time = responseTime;
+ `;
+
+ const result = translateCode(input);
+
+ expect(result).toContain('res.getResponseTime()');
+ expect(result).not.toContain('responseTime');
+ });
+
+ test('should translate JSON.parse(responseBody) when no user variables exist', () => {
+ const input = `
+ const data = JSON.parse(responseBody);
+ console.log(data);
+ `;
+
+ const result = translateCode(input);
+
+ expect(result).toContain('res.getBody()');
+ expect(result).not.toContain('JSON.parse(responseBody)');
+ expect(result).not.toContain('responseBody');
+ });
+
+ test('should translate JSON.parse(responseBody) usage without assignment when no user variables exist', () => {
+ const input = `
+ console.log(JSON.parse(responseBody));
+ `;
+
+ const result = translateCode(input);
+ const expected = `
+ console.log(res.getBody());
+ `;
+
+ expect(result).toContain(expected);
+ });
+
+ test('should translate all legacy APIs when no conflicts exist', () => {
+ const input = `
+ const data = JSON.parse(responseBody);
+ const headers = responseHeaders;
+ const time = responseTime;
+
+ console.log(data, headers, time);
+ `;
+
+ const result = translateCode(input);
+
+ expect(result).toContain('res.getBody()');
+ expect(result).toContain('res.getHeaders()');
+ expect(result).toContain('res.getResponseTime()');
+ expect(result).not.toContain('responseBody');
+ expect(result).not.toContain('responseHeaders');
+ expect(result).not.toContain('responseTime');
+ });
+ });
+
+ describe('handleLegacyGlobalAPIs - With Conflicts', () => {
+ test('should NOT translate responseBody when user variable exists', () => {
+ const input = `
+ const responseBody = pm.response.json();
+ console.log(responseBody);
+ `;
+
+ const result = translateCode(input);
+ const expected = `
+ const responseBody = res.getBody();
+ console.log(responseBody);
+ `;
+
+ // pm.response.json() should be transformed to res.getBody() (Postman API transformation)
+ expect(result).toEqual(expected);
+ });
+
+ test('should NOT translate responseHeaders when user variable exists', () => {
+ const input = `
+ const responseHeaders = pm.response.headers;
+ console.log(responseHeaders);
+ `;
+
+ const result = translateCode(input);
+ const expected = `
+ const responseHeaders = res.getHeaders();
+ console.log(responseHeaders);
+ `;
+
+ expect(result).toEqual(expected);
+ });
+
+ test('should NOT translate responseTime when user variable exists', () => {
+ const input = `
+ const responseTime = pm.response.responseTime;
+ console.log(responseTime);
+ `;
+
+ const result = translateCode(input);
+ const expected = `
+ const responseTime = res.getResponseTime();
+ console.log(responseTime);
+ `;
+
+ expect(result).toEqual(expected);
+ });
+
+ test('should NOT translate JSON.parse(responseBody) when user variable exists', () => {
+ const input = `
+ const responseBody = pm.response.json();
+ const data = JSON.parse(responseBody);
+ console.log(data);
+ `;
+
+ const result = translateCode(input);
+ const expected = `
+ const responseBody = res.getBody();
+ const data = JSON.parse(responseBody);
+ console.log(data);
+ `;
+
+ expect(result).toEqual(expected);
+ });
+ });
+
+ describe('handleLegacyGlobalAPIs - Partial Conflicts', () => {
+ test('should translate non-conflicting APIs when some conflicts exist', () => {
+ const input = `
+ const responseBody = pm.response.json();
+ console.log(responseBody);
+ console.log(responseHeaders);
+ console.log(responseTime);
+ `;
+
+ const result = translateCode(input);
+ const expected = `
+ const responseBody = res.getBody();
+ console.log(responseBody);
+ console.log(res.getHeaders());
+ console.log(res.getResponseTime());
+ `;
+
+ expect(result).toEqual(expected);
+
+ });
+
+ test('should translate JSON.parse(responseBody) only when no conflict exists', () => {
+ const input = `
+ const responseHeaders = pm.response.headers;
+ const data = JSON.parse(responseBody);
+ console.log(responseHeaders);
+ `;
+
+ const result = translateCode(input);
+ const expected = `
+ const responseHeaders = res.getHeaders();
+ const data = res.getBody();
+ console.log(responseHeaders);
+ `;
+
+ expect(result).toEqual(expected);
+ });
+ });
+
+ describe('handleLegacyGlobalAPIs - Edge Cases', () => {
+ test.skip('should handle function parameters with legacy names', () => {
+ const input = `
+ function test(responseBody) {
+ console.log(responseBody);
+ console.log(responseHeaders);
+ }
+ `;
+
+ const result = translateCode(input);
+ const expected = `
+ function test(responseBody) {
+ console.log(responseBody);
+ console.log(res.getHeaders());
+ }
+ `;
+
+ expect(result).toEqual(expected);
+ });
+
+ test('should handle object properties with legacy names', () => {
+ const input = `
+ const config = {
+ responseBody: 'custom',
+ responseHeaders: 'custom'
+ };
+ console.log(responseTime);
+ `;
+
+ const result = translateCode(input);
+
+ const expected = `
+ const config = {
+ responseBody: 'custom',
+ responseHeaders: 'custom'
+ };
+ console.log(res.getResponseTime());
+ `;
+
+ expect(result).toEqual(expected);
+ });
+
+ test('should handle assignments with legacy names', () => {
+ const input = `
+ responseBody = 'new value';
+ responseHeaders = 'new headers';
+ console.log(responseTime);
+ `;
+
+ const result = translateCode(input);
+
+ const expected = `
+ responseBody = 'new value';
+ responseHeaders = 'new headers';
+ console.log(res.getResponseTime());
+ `;
+
+ expect(result).toEqual(expected);
+ });
+
+ test('should handle mixed usage patterns', () => {
+ const input = `
+ const responseBody = pm.response.json();
+ const data = JSON.parse(responseBody);
+ console.log(responseHeaders);
+ console.log(responseTime);
+
+ function test(data) {
+ console.log(responseBody);
+ console.log(responseHeaders);
+ }
+ `;
+
+ const result = translateCode(input);
+
+ const expected = `
+ const responseBody = res.getBody();
+ const data = JSON.parse(responseBody);
+ console.log(res.getHeaders());
+ console.log(res.getResponseTime());
+
+ function test(data) {
+ console.log(responseBody);
+ console.log(res.getHeaders());
+ }
+ `;
+
+ expect(result).toEqual(expected);
+ });
+ });
+
+ describe('handleLegacyGlobalAPIs - No Legacy APIs', () => {
+ test('should not modify code when no legacy APIs are present', () => {
+ const input = `
+ const data = { name: 'test' };
+ console.log(data.name);
+ `;
+
+ const result = translateCode(input);
+ const expected = `
+ const data = { name: 'test' };
+ console.log(data.name);
+ `;
+
+ expect(result).toEqual(expected);
+ });
+ });
+});
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/legacy-tests-syntax.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/legacy-tests-syntax.test.js
new file mode 100644
index 000000000..34c6f32a6
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/legacy-tests-syntax.test.js
@@ -0,0 +1,283 @@
+import translateCode from '../../../../src/utils/jscode-shift-translator';
+
+describe('Legacy Tests[] Syntax Translation', () => {
+ it('should handle tests[] commands', () => {
+ const code = `
+ tests["Status code is 200"] = pm.response.code === 200;`;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ test("Status code is 200", function() {
+ expect(Boolean(res.getStatus() === 200)).to.be.true;
+ });`);
+ });
+
+ it('should handle tests[] with complex expressions', () => {
+ const code = `
+ tests["Response has valid data"] = pm.response.json().data && pm.response.json().data.length > 0;`;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ test("Response has valid data", function() {
+ expect(Boolean(res.getBody().data && res.getBody().data.length > 0)).to.be.true;
+ });`);
+ });
+
+ it('should handle tests[] with string equality', () => {
+ const code = `
+ tests["Content-Type is application/json"] = pm.response.headers.get("Content-Type") === "application/json";`;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ test("Content-Type is application/json", function() {
+ expect(Boolean(res.getHeader("Content-Type") === "application/json")).to.be.true;
+ });`);
+ });
+
+ it('should handle tests[] with function calls', () => {
+ const code = `
+ tests["Response time is acceptable"] = pm.response.responseTime < 500;`;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ test("Response time is acceptable", function() {
+ expect(Boolean(res.getResponseTime() < 500)).to.be.true;
+ });`);
+ });
+
+ it('should handle tests[] with variable references', () => {
+ const code = `
+ const expectedStatus = 201;
+ tests["Status code is correct"] = pm.response.code === expectedStatus;`;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const expectedStatus = 201;
+ test("Status code is correct", function() {
+ expect(Boolean(res.getStatus() === expectedStatus)).to.be.true;
+ });`);
+ });
+
+ it('should handle multiple tests[] statements', () => {
+ const code = `
+ tests["Status code is 200"] = pm.response.code === 200;
+ tests["Response has data"] = pm.response.json().hasOwnProperty("data");`;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ test("Status code is 200", function() {
+ expect(Boolean(res.getStatus() === 200)).to.be.true;
+ });
+ test("Response has data", function() {
+ expect(Boolean(res.getBody().hasOwnProperty("data"))).to.be.true;
+ });`);
+ });
+
+ it('should handle tests[] with special characters in name', () => {
+ const code = `
+ tests["Special characters: !@#$%^&*()"] = true;`;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ test("Special characters: !@#$%^&*()", function() {
+ expect(Boolean(true)).to.be.true;
+ });`);
+ });
+
+ it('should handle tests[] with pm.environment variables', () => {
+ const code = `
+ tests["Response matches environment variable"] = pm.response.json().id === pm.environment.get("expectedId");`;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ test("Response matches environment variable", function() {
+ expect(Boolean(res.getBody().id === bru.getEnvVar("expectedId"))).to.be.true;
+ });`);
+ });
+
+ it('should handle nested pm objects in tests[] assignments', () => {
+ const code = `
+ tests["Authentication header is present"] = pm.request.headers.has("Authorization");
+ tests["Data count is correct"] = pm.response.json().items.length === pm.variables.get("expectedCount");
+ `;
+ const translatedCode = translateCode(code);
+
+ // The exact translation might vary depending on implementation details,
+ // but we can check for key transformations
+ expect(translatedCode).toContain('test("Authentication header is present"');
+ expect(translatedCode).toContain('test("Data count is correct"');
+ expect(translatedCode).toContain('res.getBody().items.length === bru.getVar("expectedCount")');
+ });
+
+ // Additional robust tests for legacy tests[] syntax
+ it('should handle tests[] with complex boolean expressions', () => {
+ const code = `
+ tests["Complex validation"] = (pm.response.code >= 200 && pm.response.code < 300) ||
+ (pm.response.json().success === true && pm.response.json().data !== null);`;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("Complex validation", function() {');
+ expect(translatedCode).toContain('expect(Boolean((res.getStatus() >= 200 && res.getStatus() < 300) ||');
+ expect(translatedCode).toContain('(res.getBody().success === true && res.getBody().data !== null))).to.be.true;');
+ });
+
+ it('should handle tests[] with array methods', () => {
+ const code = `
+ tests["All items have an ID"] = pm.response.json().items.every(item => item.hasOwnProperty('id'));
+ tests["Has premium item"] = pm.response.json().items.some(item => item.type === 'premium');`;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("All items have an ID", function() {');
+ expect(translatedCode).toContain('expect(Boolean(res.getBody().items.every(item => item.hasOwnProperty(\'id\')))).to.be.true;');
+ expect(translatedCode).toContain('test("Has premium item", function() {');
+ expect(translatedCode).toContain('expect(Boolean(res.getBody().items.some(item => item.type === \'premium\'))).to.be.true;');
+ });
+
+ it('should handle tests[] with template literals in the name', () => {
+ const code = `
+ const endpoint = "users";
+ tests[\`Endpoint \${endpoint} returns valid response\`] = pm.response.code === 200;`;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const endpoint = "users";');
+ expect(translatedCode).toContain('test(`Endpoint ${endpoint} returns valid response`, function() {');
+ expect(translatedCode).toContain('expect(Boolean(res.getStatus() === 200)).to.be.true;');
+ });
+
+ it('should handle tests[] with deep property access', () => {
+ const code = `
+ tests["User has admin role"] = pm.response.json().user &&
+ pm.response.json().user.roles &&
+ pm.response.json().user.roles.includes('admin');`;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("User has admin role", function() {');
+ expect(translatedCode).toContain('expect(Boolean(res.getBody().user &&');
+ expect(translatedCode).toContain('res.getBody().user.roles &&');
+ expect(translatedCode).toContain('res.getBody().user.roles.includes(\'admin\'))).to.be.true;');
+ });
+
+ it('should handle tests[] with JSON schema validation patterns', () => {
+ const code = `
+ const schema = {
+ type: "object",
+ required: ["id", "name"],
+ properties: {
+ id: { type: "string" },
+ name: { type: "string" }
+ }
+ };
+
+ const data = pm.response.json();
+
+ // Basic schema validation patterns
+ tests["Has required fields"] = data.hasOwnProperty('id') && data.hasOwnProperty('name');
+ tests["ID is string"] = typeof data.id === 'string';
+ tests["Name is string"] = typeof data.name === 'string';`;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const schema = {');
+ expect(translatedCode).toContain('type: "object",');
+ expect(translatedCode).toContain('required: ["id", "name"],');
+ expect(translatedCode).toContain('const data = res.getBody();');
+ expect(translatedCode).toContain('test("Has required fields", function() {');
+ expect(translatedCode).toContain('expect(Boolean(data.hasOwnProperty(\'id\') && data.hasOwnProperty(\'name\'))).to.be.true;');
+ expect(translatedCode).toContain('test("ID is string", function() {');
+ expect(translatedCode).toContain('expect(Boolean(typeof data.id === \'string\')).to.be.true;');
+ });
+
+ it('should handle tests[] within conditional blocks', () => {
+ const code = `
+ const data = pm.response.json();
+
+ if (pm.response.code === 200) {
+ tests["Success response has data"] = data.hasOwnProperty('items');
+
+ if (data.items.length > 0) {
+ tests["First item has ID"] = data.items[0].hasOwnProperty('id');
+ }
+ } else {
+ tests["Error response has message"] = data.hasOwnProperty('message');
+ }`;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const data = res.getBody();');
+ expect(translatedCode).toContain('if (res.getStatus() === 200) {');
+ expect(translatedCode).toContain('test("Success response has data", function() {');
+ expect(translatedCode).toContain('expect(Boolean(data.hasOwnProperty(\'items\'))).to.be.true;');
+ expect(translatedCode).toContain('if (data.items.length > 0) {');
+ expect(translatedCode).toContain('test("First item has ID", function() {');
+ expect(translatedCode).toContain('expect(Boolean(data.items[0].hasOwnProperty(\'id\'))).to.be.true;');
+ expect(translatedCode).toContain('} else {');
+ expect(translatedCode).toContain('test("Error response has message", function() {');
+ expect(translatedCode).toContain('expect(Boolean(data.hasOwnProperty(\'message\'))).to.be.true;');
+ });
+
+ it('should handle tests[] with combination of legacy and modern styles', () => {
+ const code = `
+ // Legacy style
+ tests["Status code is 200"] = pm.response.code === 200;
+
+ // Modern style
+ pm.test("Response has valid data", function() {
+ const json = pm.response.json();
+ pm.expect(json).to.be.an('object');
+ pm.expect(json.items).to.be.an('array');
+
+ // Mix by using tests[] inside pm.test
+ tests["All items have price"] = json.items.every(item => item.hasOwnProperty('price'));
+ });`;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("Status code is 200", function() {');
+ expect(translatedCode).toContain('expect(Boolean(res.getStatus() === 200)).to.be.true;');
+ expect(translatedCode).toContain('test("Response has valid data", function() {');
+ expect(translatedCode).toContain('const json = res.getBody();');
+ expect(translatedCode).toContain('expect(json).to.be.an(\'object\');');
+ expect(translatedCode).toContain('expect(json.items).to.be.an(\'array\');');
+ expect(translatedCode).toContain('test("All items have price", function() {');
+ expect(translatedCode).toContain('expect(Boolean(json.items.every(item => item.hasOwnProperty(\'price\')))).to.be.true;');
+ });
+
+ it('should handle complex real-world tests[] example', () => {
+ const code = `
+ // Parse response
+ const response = pm.response.json();
+
+ // Basic response validation
+ tests["Status code is 200"] = pm.response.code === 200;
+ tests["Response is valid JSON"] = response !== null && typeof response === 'object';
+
+ // Check headers
+ tests["Has content-type header"] = pm.response.headers.has("Content-Type");
+ tests["Content-Type is JSON"] = pm.response.headers.get("Content-Type").includes("application/json");
+
+ // Validate against expected values
+ const expectedItems = parseInt(pm.environment.get("expectedItemCount"));
+ tests["Has correct number of items"] = response.items.length === expectedItems;
+
+ // Check for required fields on all items
+ const requiredFields = ["id", "name", "price", "category"];
+ tests["All items have required fields"] = response.items.every(item => {
+ return requiredFields.every(field => item.hasOwnProperty(field));
+ });
+
+ // Validate specific business rules
+ tests["No items with zero price"] = response.items.every(item => parseFloat(item.price) > 0);
+ tests["Has at least one featured item"] = response.items.some(item => item.featured === true);
+
+ // If we find a specific item we're looking for, save its ID for later
+ const targetItem = response.items.find(item => item.name === pm.variables.get("targetItemName"));
+ if (targetItem) {
+ pm.environment.set("targetItemId", targetItem.id);
+ tests["Found target item"] = true;
+ }`;
+ const translatedCode = translateCode(code);
+
+ // Check key transformations
+ expect(translatedCode).toContain('const response = res.getBody();');
+ expect(translatedCode).toContain('test("Status code is 200", function() {');
+ expect(translatedCode).toContain('expect(Boolean(res.getStatus() === 200)).to.be.true;');
+ expect(translatedCode).toContain('test("Has content-type header", function() {');
+ expect(translatedCode).toContain('expect(Boolean(res.getHeaders().has("Content-Type"))).to.be.true;');
+ expect(translatedCode).toContain('test("Content-Type is JSON", function() {');
+ expect(translatedCode).toContain('expect(Boolean(res.getHeader("Content-Type").includes("application/json"))).to.be.true;');
+ expect(translatedCode).toContain('const expectedItems = parseInt(bru.getEnvVar("expectedItemCount"));');
+ expect(translatedCode).toContain('test("Has correct number of items", function() {');
+ expect(translatedCode).toContain('expect(Boolean(response.items.length === expectedItems)).to.be.true;');
+ expect(translatedCode).toContain('const targetItem = response.items.find(item => item.name === bru.getVar("targetItemName"));');
+ expect(translatedCode).toContain('bru.setEnvVar("targetItemId", targetItem.id);');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/multiline-syntax.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/multiline-syntax.test.js
new file mode 100644
index 000000000..a9be82130
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/multiline-syntax.test.js
@@ -0,0 +1,283 @@
+import translateCode from '../../../../src/utils/jscode-shift-translator';
+
+describe('Multiline Syntax Handling', () => {
+ it('should handle basic multiline variable syntax with indentation', () => {
+ const code = `
+ const userId = pm.variables
+ .get("userId");
+ pm.variables
+ .set("timestamp", new Date().toISOString());
+ const hasToken = pm.variables
+ .has("token");
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const userId = bru.getVar("userId");
+ bru.setVar("timestamp", new Date().toISOString());
+ const hasToken = bru.hasVar("token");
+ `);
+ });
+
+ it('should handle multiline environment variable syntax', () => {
+ const code = `
+ const baseUrl = pm
+ .environment
+ .get("baseUrl");
+ pm
+ .environment
+ .set("requestTime", Date.now());
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const baseUrl = bru.getEnvVar("baseUrl");
+ bru.setEnvVar("requestTime", Date.now());
+ `);
+ });
+
+ it('should handle multiline collection variable syntax', () => {
+ const code = `
+ const apiKey = pm.collectionVariables
+ .get("apiKey");
+ pm.collectionVariables
+ .set("lastRun", new Date().toISOString());
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const apiKey = bru.getVar("apiKey");
+ bru.setVar("lastRun", new Date().toISOString());
+ `);
+ });
+
+ it('should handle complex environment.has transformation with multiline syntax', () => {
+ const code = `
+ if (pm.environment
+ .has("apiKey")) {
+ console.log("API Key exists");
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ if (bru.getEnvVar("apiKey") !== undefined && bru.getEnvVar("apiKey") !== null) {
+ console.log("API Key exists");
+ }
+ `);
+ });
+
+ it('should handle response.to.have.status with multiline formatting', () => {
+ const code = `
+ pm.test("Status code is correct", function() {
+ pm
+ .response
+ .to
+ .have
+ .status(200);
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(200)');
+ });
+
+ it('should handle response.to.have.header with multiline formatting', () => {
+ const code = `
+ pm.test("Content type is present", function() {
+ pm
+ .response
+ .to
+ .have
+ .header("content-type");
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('expect(res.getHeaders()).to.have.property("content-type".toLowerCase())');
+ });
+
+ it('should handle response properties with multiline syntax', () => {
+ const code = `
+ const responseBody = pm
+ .response
+ .json();
+ const responseText = pm
+ .response
+ .text;
+ const responseTime = pm
+ .response
+ .responseTime;
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('const responseBody = res.getBody()');
+ expect(translatedCode).toContain('const responseText = ');
+ expect(translatedCode).toContain('const responseTime = res.getResponseTime()');
+ });
+
+ it('should handle execution flow control with multiline syntax', () => {
+ const code = `
+ // Stop execution
+ pm
+ .execution
+ .setNextRequest(null);
+
+ // Continue to next request
+ pm
+ .execution
+ .setNextRequest("Next API Call");
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('// Stop execution');
+ expect(translatedCode).toContain('// Continue to next request');
+ expect(translatedCode).toContain('bru.runner.stopExecution()');
+ expect(translatedCode).toContain('bru.runner.setNextRequest("Next API Call")');
+ });
+
+ it('should handle mixed normal and multiline syntax in the same code', () => {
+ const code = `
+ // Normal syntax
+ const normalVar = pm.variables.get("normal");
+
+ // Multiline syntax
+ const multilineVar = pm.variables
+ .get("multiline");
+
+ // Normal syntax again
+ pm.variables.set("normalSet", "value");
+
+ // Multiline syntax again
+ pm.variables
+ .set("multilineSet", "value");
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ // Normal syntax
+ const normalVar = bru.getVar("normal");
+
+ // Multiline syntax
+ const multilineVar = bru.getVar("multiline");
+
+ // Normal syntax again
+ bru.setVar("normalSet", "value");
+
+ // Multiline syntax again
+ bru.setVar("multilineSet", "value");
+ `);
+ });
+
+ it('should handle complex multiline method chaining', () => {
+ const code = `
+ pm
+ .test("Test with chaining", function() {
+ pm
+ .response
+ .to
+ .have
+ .status(200);
+
+ const body = pm
+ .response
+ .json();
+
+ pm
+ .expect(body)
+ .to
+ .have
+ .property('success')
+ .equal(true);
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('test("Test with chaining", function() {');
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(200)');
+ expect(translatedCode).toContain('const body = res.getBody()');
+ expect(translatedCode).toContain('.property(\'success\')');
+ expect(translatedCode).toContain('.equal(true)');
+ });
+
+ it('should handle a comprehensive script with various multiline formats', () => {
+ const code = `
+ // This comprehensive script tests different multiline styles and whitespace variations
+
+ // Environment variables with different formatting styles
+ const baseUrl = pm.environment.get("baseUrl");
+ const apiKey = pm
+ .environment
+ .get("apiKey");
+ const userId = pm.environment
+ .get("userId");
+
+ // Mix of variable styles
+ pm.variables.set("testId", "test-" + Date.now());
+ pm
+ .variables
+ .set("timestamp", new Date().toISOString());
+
+ // Collection variables with inconsistent spacing
+ pm.collectionVariables
+ .set("lastRun", new Date());
+
+ // Complex conditionals with multiline expressions
+ if (pm
+ .environment
+ .has("apiKey") &&
+ pm.variables.has("testId")) {
+
+ // Testing response with mixed syntax styles
+ pm.test("Response validation", function() {
+ // Normal style
+ pm.response.to.have.status(200);
+
+ // Multiline with different indentation
+ pm
+ .response
+ .to
+ .have
+ .header("content-type");
+
+ pm.response
+ .to.have
+ .jsonBody("success", true);
+
+ // Extreme indentation
+ pm
+ .response
+ .to
+ .not
+ .have
+ .jsonBody("error");
+ });
+
+ // Flow control with mixed styles
+ if (pm.response.code === 401) {
+ pm.execution.setNextRequest(null);
+ } else {
+ pm
+ .execution
+ .setNextRequest("Next API Call");
+ }
+ }
+ `;
+
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const baseUrl = bru.getEnvVar("baseUrl")');
+ expect(translatedCode).toContain('const apiKey = bru.getEnvVar("apiKey")');
+ expect(translatedCode).toContain('const userId = bru.getEnvVar("userId")');
+
+ // Check variables translations
+ expect(translatedCode).toContain('bru.setVar("testId", "test-" + Date.now())');
+ expect(translatedCode).toContain('bru.setVar("timestamp", new Date().toISOString())');
+
+ // Check collection variables
+ expect(translatedCode).toContain('bru.setVar("lastRun", new Date())');
+
+ // Check complex conditionals
+ expect(translatedCode).toContain('if (bru.getEnvVar("apiKey") !== undefined && bru.getEnvVar("apiKey") !== null &&');
+ expect(translatedCode).toContain('bru.hasVar("testId"))');
+
+ // Check response testing
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(200)');
+ expect(translatedCode).toContain('expect(res.getHeaders()).to.have.property("content-type".toLowerCase())');
+
+ // Check flow control
+ expect(translatedCode).toContain('if (res.getStatus() === 401)');
+ expect(translatedCode).toContain('bru.runner.stopExecution()');
+ expect(translatedCode).toContain('bru.runner.setNextRequest("Next API Call")');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/postman-references.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/postman-references.test.js
new file mode 100644
index 000000000..20e7890a7
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/postman-references.test.js
@@ -0,0 +1,132 @@
+import translateCode from '../../../../src/utils/jscode-shift-translator';
+
+describe('Postman to PM References Conversion', () => {
+ // Basic conversions
+ it('should convert basic postman references to pm', () => {
+ const code = 'postman.setEnvironmentVariable("key", "value");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('bru.setEnvVar("key", "value");');
+ // The key part is that it should convert postman.* to pm.* internally before
+ // translating to bru.* APIs
+ });
+
+ it('should convert postman variable access to pm', () => {
+ const code = 'const value = postman.getEnvironmentVariable("key");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const value = bru.getEnvVar("key");');
+ });
+
+ it('should handle postman variable assignments', () => {
+ const code = `
+ const envVar = postman.environment.get("apiKey");
+ const baseUrl = postman.environment.get("baseUrl");
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('const envVar = bru.getEnvVar("apiKey");');
+ expect(translatedCode).toContain('const baseUrl = bru.getEnvVar("baseUrl");');
+ });
+
+ // More complex patterns
+ it('should handle mixed postman and pm references in the same code', () => {
+ const code = `
+ // Using both postman and pm APIs
+ const apiKey = postman.environment.get("apiKey");
+ const baseUrl = pm.environment.get("baseUrl");
+
+ // Using both formats in a test
+ postman.test("Status code is 200", function() {
+ pm.expect(pm.response.code).to.equal(200);
+ });
+ `;
+
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('const apiKey = bru.getEnvVar("apiKey");');
+ expect(translatedCode).toContain('const baseUrl = bru.getEnvVar("baseUrl");');
+ expect(translatedCode).toContain('test("Status code is 200", function() {');
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(200);');
+ });
+
+ it('should handle postman references in object destructuring', () => {
+ const code = `
+ const { environment } = postman;
+ environment.set("key", "value");
+ `;
+
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('bru.setEnvVar("key", "value");');
+ });
+
+ // Complex control flows
+ it('should handle postman references in control flow statements', () => {
+ const code = `
+ if (postman.environment.get("isProduction") === "true") {
+ const apiUrl = postman.environment.get("prodUrl");
+ postman.setNextRequest("Production Flow");
+ } else {
+ const apiUrl = postman.environment.get("devUrl");
+ postman.setNextRequest("Development Flow");
+ }
+ `;
+
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('if (bru.getEnvVar("isProduction") === "true") {');
+ expect(translatedCode).toContain('const apiUrl = bru.getEnvVar("prodUrl");');
+ expect(translatedCode).toContain('bru.setNextRequest("Production Flow");');
+ expect(translatedCode).toContain('const apiUrl = bru.getEnvVar("devUrl");');
+ expect(translatedCode).toContain('bru.setNextRequest("Development Flow");');
+ });
+
+ // Legacy response handling
+ it('should handle legacy postman response methods', () => {
+ const code = `
+ // Using legacy response handling
+ const responseCode = postman.response.code;
+ const responseBody = postman.response.json();
+
+ // Set environment variables with response data
+ postman.setEnvironmentVariable("lastResponseCode", responseCode);
+ `;
+
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('const responseCode = res.getStatus();');
+ expect(translatedCode).toContain('const responseBody = res.getBody();');
+ expect(translatedCode).toContain('bru.setEnvVar("lastResponseCode", responseCode);');
+ });
+
+ // Postman in string literals should be untouched
+ it('should not convert postman references in string literals', () => {
+ const code = `
+ console.log("This is a pm script");
+ const message = "We're using pm to test our API";
+ `;
+
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('console.log("This is a pm script");');
+ expect(translatedCode).toContain('const message = "We\'re using pm to test our API";');
+ });
+
+ // Complex example with aliasing
+ it('should handle complex postman reference patterns with aliasing', () => {
+ const code = `
+ // Aliasing the postman object
+ const env = postman.environment;
+ const code = postman.code;
+
+ // Using the alias
+ const apiKey = env.get("apiKey");
+ const userId = env.get("userId");
+
+ // Using alias in tests
+ postman.test("Response is valid", function() {
+ postman.expect(code).to.equal(200);
+ });
+ `;
+
+ const translatedCode = translateCode(code);
+ // Should handle the aliases properly
+ expect(translatedCode).toContain('const apiKey = bru.getEnvVar("apiKey");');
+ expect(translatedCode).toContain('const userId = bru.getEnvVar("userId");');
+ expect(translatedCode).toContain('test("Response is valid", function() {');
+ expect(translatedCode).toContain('expect(code).to.equal(200);');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/request.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/request.test.js
new file mode 100644
index 000000000..a81bc6c72
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/request.test.js
@@ -0,0 +1,108 @@
+import translateCode from '../../../../src/utils/jscode-shift-translator';
+
+describe('Request Translation', () => {
+ it('should translate pm.request.url', () => {
+ const code = 'const requestUrl = pm.request.url;';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const requestUrl = req.getUrl();');
+ });
+
+ it('should translate pm.request.method', () => {
+ const code = 'const method = pm.request.method;';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const method = req.getMethod();');
+ });
+
+ it('should translate pm.request.headers', () => {
+ const code = 'const headers = pm.request.headers;';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const headers = req.getHeaders();');
+ });
+
+ it('should translate pm.request.body', () => {
+ const code = 'const body = pm.request.body;';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const body = req.getBody();');
+ });
+
+ it('should translate pm.response.statusText', () => {
+ const code = 'const statusText = pm.response.statusText;';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const statusText = res.statusText;');
+ });
+
+ it('should translate multiple request methods in one block', () => {
+ const code = `
+ const url = pm.request.url;
+ const method = pm.request.method;
+ const headers = pm.request.headers;
+ const body = pm.request.body;
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const url = req.getUrl();
+ const method = req.getMethod();
+ const headers = req.getHeaders();
+ const body = req.getBody();
+ `);
+ });
+
+ it('should handle request and response properties together', () => {
+ const code = `
+ // Get request data
+ const url = pm.request.url;
+ const method = pm.request.method;
+
+ // Get response data
+ const statusCode = pm.response.code;
+ const statusText = pm.response.statusText;
+
+ // Verify expectations
+ pm.test("Request was made correctly", function() {
+ pm.expect(method).to.equal("POST");
+ pm.expect(url).to.include("/api/items");
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('const url = req.getUrl();');
+ expect(translatedCode).toContain('const method = req.getMethod();');
+ expect(translatedCode).toContain('const statusCode = res.getStatus();');
+ expect(translatedCode).toContain('const statusText = res.statusText;');
+ expect(translatedCode).toContain('test("Request was made correctly", function() {');
+ expect(translatedCode).toContain('expect(method).to.equal("POST");');
+ expect(translatedCode).toContain('expect(url).to.include("/api/items");');
+ });
+
+ it('should handle request properties in conditional blocks', () => {
+ const code = `
+ if (pm.request.method === "POST") {
+ console.log("This is a POST request to " + pm.request.url);
+ pm.test("Request has correct content-type", function() {
+ pm.expect(pm.request.headers.has("Content-Type")).to.be.true;
+ });
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('if (req.getMethod() === "POST") {');
+ expect(translatedCode).toContain('console.log("This is a POST request to " + req.getUrl());');
+ expect(translatedCode).toContain('test("Request has correct content-type", function() {');
+ // Note: The expectation for headers.has might be transformed differently
+ // depending on how complex transformations are handled
+ });
+
+ it('should handle request data extraction and variable setting', () => {
+ const code = `
+ // Extract request data
+ const requestData = pm.request.body;
+ const contentType = pm.request.headers.get("Content-Type");
+
+ // Save for later use
+ pm.variables.set("lastRequestBody", JSON.stringify(requestData));
+ pm.environment.set("lastContentType", contentType);
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('const requestData = req.getBody();');
+ expect(translatedCode).toContain('bru.setVar("lastRequestBody", JSON.stringify(requestData));');
+ expect(translatedCode).toContain('bru.setEnvVar("lastContentType", contentType);');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/response.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/response.test.js
new file mode 100644
index 000000000..5df2fe5bb
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/response.test.js
@@ -0,0 +1,587 @@
+import translateCode from '../../../../src/utils/jscode-shift-translator';
+
+describe('Response Translation', () => {
+ // Basic response property tests
+ it('should translate pm.response.json', () => {
+ const code = 'const jsonData = pm.response.json();';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const jsonData = res.getBody();');
+ });
+
+ it('should translate pm.response.code', () => {
+ const code = 'if (pm.response.code === 200) { console.log("Success"); }';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('if (res.getStatus() === 200) { console.log("Success"); }');
+ });
+
+ it('should translate pm.response.text', () => {
+ const code = 'const responseText = pm.response.text();';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const responseText = JSON.stringify(res.getBody());');
+ });
+
+ it('should translate pm.response.responseTime', () => {
+ const code = 'console.log("Response time:", pm.response.responseTime);';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('console.log("Response time:", res.getResponseTime());');
+ });
+
+ it('should translate pm.response.statusText', () => {
+ const code = 'console.log("Status text:", pm.response.statusText);';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('console.log("Status text:", res.statusText);');
+ });
+
+ it('should translate pm.response.headers', () => {
+ const code = 'console.log("Headers:", pm.response.headers);';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('console.log("Headers:", res.getHeaders());');
+ });
+
+ // Complex response transformations
+ it('should transform pm.response.to.have.status', () => {
+ const code = 'pm.response.to.have.status(201);';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('expect(res.getStatus()).to.equal(201);');
+ });
+
+ it('should transform pm.response.to.have.header with single argument', () => {
+ const code = 'pm.response.to.have.header("Content-Type");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('expect(res.getHeaders()).to.have.property("Content-Type".toLowerCase());');
+ });
+
+ it('should transform multiple pm.response.to.have.header statements', () => {
+ const code = `
+ pm.response.to.have.header("Content-Type", "application/json");
+ pm.response.to.have.header("Cache-Control", "no-cache");
+ `;
+ const translatedCode = translateCode(code);
+
+ // Check for the existence of all four assertions (two pairs)
+ expect(translatedCode).toContain('expect(res.getHeaders()).to.have.property("Content-Type".toLowerCase(), "application/json");');
+ expect(translatedCode).toContain('expect(res.getHeaders()).to.have.property("Cache-Control".toLowerCase(), "no-cache");');
+ });
+
+ it('should transform pm.response.to.have.header inside control structures', () => {
+ const code = `
+ if (pm.response.code === 200) {
+ pm.response.to.have.header("Content-Type", "application/json");
+ }
+ `;
+ const translatedCode = translateCode(code);
+
+ // The assertions should be inside the if block
+ expect(translatedCode).toContain('if (res.getStatus() === 200) {');
+ expect(translatedCode).toContain('expect(res.getHeaders()).to.have.property("Content-Type".toLowerCase(), "application/json");');
+ });
+
+ it('should transform pm.response.to.have.header with variable parameters', () => {
+ const code = `
+ const headerName = "Content-Type";
+ const expectedValue = "application/json";
+ pm.response.to.have.header(headerName, expectedValue);
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const headerName = "Content-Type";');
+ expect(translatedCode).toContain('const expectedValue = "application/json";');
+ expect(translatedCode).toContain('expect(res.getHeaders()).to.have.property(headerName.toLowerCase(), expectedValue);');
+ });
+
+ // Response aliases tests
+ it('should handle response aliases', () => {
+ const code = `
+ const response = pm.response;
+ const status = response.status;
+ const body = response.json();
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const status = res.statusText;
+ const body = res.getBody();
+ `);
+ });
+
+ // Response to.have.status with different formats
+ it('should handle pm.response.to.have.status with different status codes', () => {
+ const code = `
+ // Test different status codes
+ pm.response.to.have.status(200); // OK
+ pm.response.to.have.status(201); // Created
+ pm.response.to.have.status(400); // Bad Request
+ pm.response.to.have.status(404); // Not Found
+ pm.response.to.have.status(500); // Server Error
+
+ // With variables
+ const expectedStatus = 200;
+ pm.response.to.have.status(expectedStatus);
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(200);');
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(201);');
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(400);');
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(404);');
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(500);');
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(expectedStatus);');
+ });
+
+ // Alias for pm.response.to.have.status
+ it('should handle pm.response.to.have.status alias', () => {
+ const code = `
+ const resp = pm.response;
+ resp.to.have.status(200);
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ expect(res.getStatus()).to.equal(200);
+ `);
+ });
+
+ it('should handle pm.response.to.have.header alias', () => {
+ const code = `
+ const resp = pm.response;
+ resp.to.have.header("Content-Type");
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ expect(res.getHeaders()).to.have.property("Content-Type".toLowerCase());
+ `);
+ });
+
+ it('should handle pm.response.to.have.header alias with value check', () => {
+ const code = `
+ const resp = pm.response;
+ resp.to.have.header("Content-Type", "application/json");
+ `;
+ const translatedCode = translateCode(code);
+
+ // Check for both assertions when using an alias
+ expect(translatedCode).toContain('expect(res.getHeaders()).to.have.property("Content-Type".toLowerCase(), "application/json");');
+ });
+
+
+ it('should translate response.status', () => {
+ const code = `
+ const resp = pm.response;
+ const statusCode = resp.status;
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const statusCode = res.statusText;
+ `);
+ });
+
+ it('should translate response.body', () => {
+ const code = `
+ const resp = pm.response;
+ const responseBody = resp.json();
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const responseBody = res.getBody();
+ `);
+ });
+
+ it('should translate response.headers', () => {
+ const code = `
+ const resp = pm.response;
+ const headers = resp.headers;
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const headers = res.getHeaders();
+ `);
+ });
+
+ it('should translate pm.response.statusText', () => {
+ const code = `
+ const resp = pm.response;
+ const statusText = resp.statusText;
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const statusText = res.statusText;
+ `);
+ });
+
+ it('should translate multiple response methods in one block', () => {
+ const code = `
+ const resp = pm.response;
+ const statusCode = resp.code;
+ const statusText = resp.statusText;
+ const jsonData = resp.json();
+ const responseText = resp.text();
+ const time = resp.responseTime;
+ resp.to.have.status(200);
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const statusCode = res.getStatus();
+ const statusText = res.statusText;
+ const jsonData = res.getBody();
+ const responseText = JSON.stringify(res.getBody());
+ const time = res.getResponseTime();
+ expect(res.getStatus()).to.equal(200);
+ `);
+ });
+
+ it('should handle accessing nested properties on response objects', () => {
+ const code = `
+ const resp = pm.response;
+ const data = resp.json();
+ if (data && data.user && data.user.id) {
+ pm.environment.set("userId", data.user.id);
+ }
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).not.toContain('const resp = pm.response;');
+ expect(translatedCode).toContain('const data = res.getBody();');
+ expect(translatedCode).toContain('bru.setEnvVar("userId", data.user.id);');
+ });
+
+ it('should handle all response property methods together', () => {
+ const code = `
+ // All response property methods
+ const statusCode = pm.response.code;
+ const responseBody = pm.response.json();
+ const responseText = pm.response.text();
+ const statusText = pm.response.statusText;
+ const responseTime = pm.response.responseTime;
+
+ pm.test("Response is valid", function() {
+ pm.response.to.have.status(200);
+ pm.expect(responseBody).to.be.an('object');
+ pm.expect(responseTime).to.be.below(1000);
+ pm.expect(statusText).to.equal('OK');
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const statusCode = res.getStatus();');
+ expect(translatedCode).toContain('const responseBody = res.getBody();');
+ expect(translatedCode).toContain('const responseText = JSON.stringify(res.getBody());');
+ expect(translatedCode).toContain('const responseTime = res.getResponseTime();');
+ expect(translatedCode).toContain('const statusText = res.statusText;');
+ expect(translatedCode).toContain('test("Response is valid", function() {');
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(200);');
+ expect(translatedCode).toContain('expect(responseBody).to.be.an(\'object\');');
+ expect(translatedCode).toContain('expect(responseTime).to.be.below(1000);');
+ expect(translatedCode).toContain('expect(statusText).to.equal(\'OK\');');
+ });
+
+ it('should handle pm objects with array access on response', () => {
+ const code = `
+ const items = pm.response.json().items;
+ for (let i = 0; i < items.length; i++) {
+ pm.collectionVariables.set("item_" + i, items[i].id);
+ }
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const items = res.getBody().items;');
+ expect(translatedCode).toContain('bru.setVar("item_" + i, items[i].id);');
+ });
+
+ it('should handle response JSON with optional chaining and nullish coalescing', () => {
+ const code = `
+ const userId = pm.response.json()?.user?.id ?? "anonymous";
+ const items = pm.response.json()?.data?.items || [];
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const userId = res.getBody()?.user?.id ?? "anonymous";');
+ expect(translatedCode).toContain('const items = res.getBody()?.data?.items || [];');
+ });
+
+ it('should handle response headers with different access patterns', () => {
+ // will need to handle get, set methods, bruno does not support this yet
+ const code = `
+ const contentType = pm.response.headers.get('Content-Type');
+ const contentLength = pm.response.headers.get('Content-Length');
+ console.log("contentType", contentType);
+ console.log("contentLength", contentLength);
+
+ pm.test("Headers are correct", function() {
+ pm.response.to.have.header('Content-Type');
+ pm.response.to.have.header('Content-Length');
+ pm.expect(contentType).to.include('application/json');
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ // Check how header access is translated
+ expect(translatedCode).toContain('const contentType = res.getHeader(\'Content-Type\');');
+ expect(translatedCode).toContain('const contentLength = res.getHeader(\'Content-Length\');');
+ expect(translatedCode).toContain('console.log("contentType", contentType);');
+ expect(translatedCode).toContain('console.log("contentLength", contentLength);');
+ expect(translatedCode).not.toContain('pm.test')
+ expect(translatedCode).toContain('expect(res.getHeaders()).to.have.property(\'Content-Type\'.toLowerCase())');
+ expect(translatedCode).toContain('expect(res.getHeaders()).to.have.property(\'Content-Length\'.toLowerCase())');
+ expect(translatedCode).toContain('expect(contentType).to.include(\'application/json\')');
+ });
+
+ it('should transform response data with array destructuring', () => {
+ const code = `
+ const { id, name, items } = pm.response.json();
+ const [first, second] = items;
+ pm.environment.set("userId", id);
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const { id, name, items } = res.getBody();');
+ expect(translatedCode).toContain('const [first, second] = items;');
+ expect(translatedCode).toContain('bru.setEnvVar("userId", id);');
+ });
+
+ it('should handle response in complex conditionals', () => {
+ const code = `
+ if (pm.response.code >= 200 && pm.response.code < 300) {
+ if (pm.response.headers.get('Content-Type').includes('application/json')) {
+ const data = pm.response.json();
+
+ if (data.success === true && data.token) {
+ pm.environment.set("authToken", data.token);
+ } else if (data.error) {
+ console.error("API error:", data.error);
+ }
+ }
+ } else if (pm.response.code === 404) {
+ console.log("Resource not found");
+ } else {
+ console.error("Request failed with status:", pm.response.code);
+ }
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('if (res.getStatus() >= 200 && res.getStatus() < 300) {');
+ expect(translatedCode).toContain('if (res.getHeader(\'Content-Type\').includes(\'application/json\')) {');
+ expect(translatedCode).toContain('const data = res.getBody();');
+ expect(translatedCode).toContain('bru.setEnvVar("authToken", data.token);');
+ expect(translatedCode).toContain('} else if (res.getStatus() === 404) {');
+ expect(translatedCode).toContain('console.error("Request failed with status:", res.getStatus());');
+ });
+
+ it('should handle response processing with try-catch', () => {
+ const code = `
+ try {
+ const data = pm.response.json();
+ pm.environment.set("userData", JSON.stringify(data.user));
+ } catch (error) {
+ console.error("Failed to parse response:", error);
+ const text = pm.response.text();
+ pm.environment.set("rawResponse", text);
+ }
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const data = res.getBody();');
+ expect(translatedCode).toContain('bru.setEnvVar("userData", JSON.stringify(data.user));');
+ expect(translatedCode).toContain('const text = JSON.stringify(res.getBody());');
+ expect(translatedCode).toContain('bru.setEnvVar("rawResponse", text);');
+ });
+
+ it('should handle JSON path style access to response data', () => {
+ const code = `
+ const data = pm.response.json();
+ const userId = data.user.id;
+ const userEmail = data.user.contact.email;
+ const firstItem = data.items[0];
+
+ pm.environment.set("userId", userId);
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const data = res.getBody();');
+ expect(translatedCode).toContain('const userId = data.user.id;');
+ expect(translatedCode).toContain('const userEmail = data.user.contact.email;');
+ expect(translatedCode).toContain('const firstItem = data.items[0];');
+ expect(translatedCode).toContain('bru.setEnvVar("userId", userId);');
+ });
+
+ it('should handle template literals with response data', () => {
+ const code = `
+ const data = pm.response.json();
+ const welcomeMessage = \`Hello, \${data.user.name}! Your ID is \${data.user.id}.\`;
+
+ pm.environment.set("welcomeMessage", welcomeMessage);
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const data = res.getBody();');
+ expect(translatedCode).toContain('const welcomeMessage = `Hello, ${data.user.name}! Your ID is ${data.user.id}.`;');
+ expect(translatedCode).toContain('bru.setEnvVar("welcomeMessage", welcomeMessage);');
+ });
+
+ it('should handle response processing in arrow functions', () => {
+ const code = `
+ const processItems = () => {
+ const items = pm.response.json().items;
+ return items.map(item => item.id);
+ };
+
+ const itemIds = processItems();
+ pm.environment.set("itemIds", JSON.stringify(itemIds));
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const items = res.getBody().items;');
+ expect(translatedCode).toContain('return items.map(item => item.id);');
+ expect(translatedCode).toContain('const itemIds = processItems();');
+ expect(translatedCode).toContain('bru.setEnvVar("itemIds", JSON.stringify(itemIds));');
+ });
+
+ it('should handle complex inline operations with response data', () => {
+ const code = `
+ const items = pm.response.json().items;
+ const totalValue = items.reduce((sum, item) => sum + item.price, 0);
+ const highValueItems = items.filter(item => item.price > 100);
+ const itemNames = items.map(item => item.name);
+
+ pm.environment.set("totalValue", totalValue);
+ pm.environment.set("highValueItemCount", highValueItems.length);
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const items = res.getBody().items;');
+ expect(translatedCode).toContain('const totalValue = items.reduce((sum, item) => sum + item.price, 0);');
+ expect(translatedCode).toContain('const highValueItems = items.filter(item => item.price > 100);');
+ expect(translatedCode).toContain('const itemNames = items.map(item => item.name);');
+ expect(translatedCode).toContain('bru.setEnvVar("totalValue", totalValue);');
+ expect(translatedCode).toContain('bru.setEnvVar("highValueItemCount", highValueItems.length);');
+ });
+
+ it('should handle complex test structure with pm.response.to.have.header', () => {
+ const code = `
+ pm.test("Response headers validation", function() {
+ pm.response.to.have.header("Content-Type", "application/json");
+ pm.response.to.have.header("Cache-Control");
+
+ const responseTime = pm.response.responseTime;
+ pm.expect(responseTime).to.be.below(1000);
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ // Check for test function conversion
+ expect(translatedCode).toContain('test("Response headers validation", function() {');
+
+ // Check for header assertions inside the test callback
+ expect(translatedCode).toContain('expect(res.getHeaders()).to.have.property("Content-Type".toLowerCase(), "application/json");');
+ expect(translatedCode).toContain('expect(res.getHeaders()).to.have.property("Cache-Control".toLowerCase())');
+
+ // Check that other test assertions are preserved
+ expect(translatedCode).toContain('const responseTime = res.getResponseTime();');
+ expect(translatedCode).toContain('expect(responseTime).to.be.below(1000);');
+ });
+
+ it('should handle dynamic header names in pm.response.to.have.header', () => {
+ const code = `
+ function checkHeaderPresent(headerName) {
+ pm.response.to.have.header(headerName);
+ }
+
+ function validateHeader(headerName, expectedValue) {
+ pm.response.to.have.header(headerName, expectedValue);
+ }
+
+ checkHeaderPresent("Authorization");
+ validateHeader("Content-Type", "application/json");
+ `;
+ const translatedCode = translateCode(code);
+
+ // Check function transformations
+ expect(translatedCode).toContain('function checkHeaderPresent(headerName) {');
+ expect(translatedCode).toContain('expect(res.getHeaders()).to.have.property(headerName.toLowerCase())');
+
+ expect(translatedCode).toContain('function validateHeader(headerName, expectedValue) {');
+ expect(translatedCode).toContain('expect(res.getHeaders()).to.have.property(headerName.toLowerCase(), expectedValue);');
+
+ // Check function calls
+ expect(translatedCode).toContain('checkHeaderPresent("Authorization");');
+ expect(translatedCode).toContain('validateHeader("Content-Type", "application/json");');
+ });
+
+ it('should transform pm.response.to.have.body with string literal', () => {
+ const code = 'pm.response.to.have.body("Expected response body");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('expect(res.getBody()).to.equal("Expected response body");');
+ });
+
+ it('should transform pm.response.to.have.body with variable parameter', () => {
+ const code = `
+ const expectedBody = {"status": "success", "data": [1, 2, 3]};
+ pm.response.to.have.body(expectedBody);
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain('const expectedBody = {"status": "success", "data": [1, 2, 3]};');
+ expect(translatedCode).toContain('expect(res.getBody()).to.equal(expectedBody);');
+ });
+
+ it('should transform pm.response.to.have.body with JSON object', () => {
+ const code = `pm.response.to.have.body({"status": "success", "message": "Operation completed"});`;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('expect(res.getBody()).to.equal({"status": "success", "message": "Operation completed"});');
+ });
+
+ it('should transform pm.response.to.have.body inside test function', () => {
+ const code = `
+ pm.test("Response body validation", function() {
+ const expectedResponse = {"result": true};
+ pm.response.to.have.body(expectedResponse);
+ });
+ `;
+ const translatedCode = translateCode(code);
+ const expectedOutput = `
+ test("Response body validation", function() {
+ const expectedResponse = {"result": true};
+ expect(res.getBody()).to.equal(expectedResponse);
+ });
+ `
+ expect(translatedCode).toBe(expectedOutput);
+ });
+
+ it('should transform pm.response.to.have.body with response alias', () => {
+ const code = `
+ const resp = pm.response;
+ resp.to.have.body({"status": "ok"});
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ expect(res.getBody()).to.equal({"status": "ok"});
+ `);
+ });
+
+ // --- getSize translations ---------------------------
+ it('should translate pm.response.size()', () => {
+ const code = 'const size = pm.response.size();';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const size = res.getSize();');
+ });
+
+ it('should translate pm.response.size().body', () => {
+ const code = 'const bodySize = pm.response.size().body;';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const bodySize = res.getSize().body;');
+ });
+
+ it('should translate pm.response.size().header', () => {
+ const code = 'const headerSize = pm.response.size().header;';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const headerSize = res.getSize().header;');
+ });
+
+ it('should translate pm.response.size().total', () => {
+ const code = 'const totalSize = pm.response.size().total;';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const totalSize = res.getSize().total;');
+ });
+
+ it('should translate pm.response.responseSize alias', () => {
+ const code = 'const responseSize = pm.response.responseSize;';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('const responseSize = res.getSize().body;');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/scoped-variables.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/scoped-variables.test.js
new file mode 100644
index 000000000..9ed5ed700
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/scoped-variables.test.js
@@ -0,0 +1,51 @@
+import translateCode from '../../../../src/utils/jscode-shift-translator';
+
+describe('Scoped Variables', () => {
+ it.skip('should handle scoped variables correctly', () => {
+ const code = `
+ const response = pm.response;
+ const status = response.status;
+
+ function test() {
+ const response = delta.response;
+ const status = response.status;
+ console.log(status);
+ }
+ `
+ const result = translateCode(code);
+ console.log(result);
+ expect(result).toBe(`
+ const status = res.statusText;
+
+ function test() {
+ const response = delta.response;
+ const status = response.status;
+ console.log(status);
+ }
+ `)
+ })
+
+ it.skip('should handle scoped variables correctly', () => {
+ const code = `
+ const response = delta.response;
+ const status = response.status;
+
+ function test() {
+ const response = pm.response;
+ const status = response.status;
+ console.log(status);
+ }
+ `
+ const result = translateCode(code);
+ console.log(result);
+ expect(result).toBe(`
+ const response = delta.response;
+ const status = response.status;
+
+ function test() {
+ const status = res.statusText;
+ console.log(status);
+ }
+ `)
+ })
+})
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/testing-framework.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/testing-framework.test.js
new file mode 100644
index 000000000..fc3988f1f
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/testing-framework.test.js
@@ -0,0 +1,399 @@
+import translateCode from '../../../../src/utils/jscode-shift-translator';
+
+describe('Testing Framework Translation', () => {
+ // Basic testing framework translations
+ it('should translate pm.test', () => {
+ const code = 'pm.test("Status code is 200", function() { pm.response.to.have.status(200); });';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('test("Status code is 200", function() { expect(res.getStatus()).to.equal(200); });');
+ });
+
+ it('should translate pm.expect', () => {
+ const code = 'pm.expect(jsonData.success).to.be.true;';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('expect(jsonData.success).to.be.true;');
+ });
+
+ it('should translate pm.expect.fail', () => {
+ const code = 'if (!isValid) pm.expect.fail("Data is invalid");';
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe('if (!isValid) expect.fail("Data is invalid");');
+ });
+
+ // Tests with response assertions
+ it('should translate pm.response.to.have.status in tests', () => {
+ const code = `
+ pm.test("Check environment and call successful", function () {
+ pm.expect(pm.environment.name).to.equal("ENVIRONMENT_NAME");
+ pm.response.to.have.status(200);
+ });`;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ test("Check environment and call successful", function () {
+ expect(bru.getEnvName()).to.equal("ENVIRONMENT_NAME");
+ expect(res.getStatus()).to.equal(200);
+ });`);
+ });
+
+ // Test aliases
+ it('should handle test aliases', () => {
+ const code = `
+ const { test, expect } = pm;
+
+ test("Status code is 200", function () {
+ expect(pm.response.code).to.equal(200);
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).not.toContain('const { test, expect } = pm');
+ expect(translatedCode).toContain('test("Status code is 200", function () {');
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(200);');
+ });
+
+ // Tests inside different code structures
+ it('should translate pm commands inside tests with nested functions', () => {
+ const code = `
+ pm.test("Auth flow works", function() {
+ const response = pm.response.json();
+ pm.expect(response.authenticated).to.be.true;
+ pm.environment.set("userId", response.user.id);
+ pm.collectionVariables.set("sessionId", response.session.id);
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("Auth flow works", function() {');
+ expect(translatedCode).toContain('const response = res.getBody();');
+ expect(translatedCode).toContain('expect(response.authenticated).to.be.true;');
+ expect(translatedCode).toContain('bru.setEnvVar("userId", response.user.id);');
+ expect(translatedCode).toContain('bru.setVar("sessionId", response.session.id);');
+ });
+
+ it('should translate pm.test with arrow functions', () => {
+ const code = `
+ pm.test("Status code is 200", () => {
+ pm.expect(pm.response.code).to.eql(200);
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("Status code is 200", () => {');
+ expect(translatedCode).toContain('expect(res.getStatus()).to.eql(200);');
+ });
+
+ it('should handle multiple test assertions in one function', () => {
+ const code = `
+ pm.test("The response has all properties", () => {
+ const responseJson = pm.response.json();
+ pm.expect(responseJson.type).to.eql('vip');
+ pm.expect(responseJson.name).to.be.a('string');
+ pm.expect(responseJson.id).to.have.lengthOf(1);
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("The response has all properties", () => {');
+ expect(translatedCode).toContain('const responseJson = res.getBody();');
+ expect(translatedCode).toContain('expect(responseJson.type).to.eql(\'vip\');');
+ expect(translatedCode).toContain('expect(responseJson.name).to.be.a(\'string\');');
+ expect(translatedCode).toContain('expect(responseJson.id).to.have.lengthOf(1);');
+ });
+
+ // Test with aliased variables
+ it('should translate aliases within test functions', () => {
+ const code = `
+ const tempRes = pm.response;
+ const tempTest = pm.test;
+ const tempExpect = pm.expect;
+
+ tempTest("Status code is 200", function() {
+ tempExpect(tempRes.code).to.equal(200);
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).not.toContain('const tempRes = pm.response;');
+ expect(translatedCode).not.toContain('const tempTest = pm.test;');
+ expect(translatedCode).not.toContain('const tempExpect = pm.expect;');
+ expect(translatedCode).toContain('test("Status code is 200", function() {');
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(200);');
+ });
+
+ // Additional robust tests for testing framework
+ it('should handle nested test functions', () => {
+ const code = `
+ pm.test("Main test group", function() {
+ const responseJson = pm.response.json();
+
+ pm.test("User data validation", function() {
+ pm.expect(responseJson.user).to.be.an('object');
+ pm.expect(responseJson.user.id).to.be.a('string');
+ });
+
+ pm.test("Settings validation", function() {
+ pm.expect(responseJson.settings).to.be.an('object');
+ pm.expect(responseJson.settings.notifications).to.be.a('boolean');
+ });
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("Main test group", function() {');
+ expect(translatedCode).toContain('const responseJson = res.getBody();');
+ expect(translatedCode).toContain('test("User data validation", function() {');
+ expect(translatedCode).toContain('expect(responseJson.user).to.be.an(\'object\');');
+ expect(translatedCode).toContain('test("Settings validation", function() {');
+ expect(translatedCode).toContain('expect(responseJson.settings.notifications).to.be.a(\'boolean\');');
+ });
+
+ it('should handle test with dynamic test names', () => {
+ const code = `
+ const endpoint = pm.variables.get("currentEndpoint");
+
+ pm.test(\`\${endpoint} returns correct data\`, function() {
+ const responseJson = pm.response.json();
+ pm.expect(responseJson).to.be.an('object');
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const endpoint = bru.getVar("currentEndpoint");');
+ expect(translatedCode).toContain('test(`${endpoint} returns correct data`, function() {');
+ expect(translatedCode).toContain('const responseJson = res.getBody();');
+ expect(translatedCode).toContain('expect(responseJson).to.be.an(\'object\');');
+ });
+
+ it('should handle test with conditional execution', () => {
+ const code = `
+ const responseJson = pm.response.json();
+
+ if (responseJson.type === 'user') {
+ pm.test("User validation", function() {
+ pm.expect(responseJson.name).to.be.a('string');
+ pm.expect(responseJson.email).to.be.a('string');
+ });
+ } else if (responseJson.type === 'admin') {
+ pm.test("Admin validation", function() {
+ pm.expect(responseJson.accessLevel).to.be.above(5);
+ pm.expect(responseJson.permissions).to.be.an('array');
+ });
+ }
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const responseJson = res.getBody();');
+ expect(translatedCode).toContain('if (responseJson.type === \'user\') {');
+ expect(translatedCode).toContain('test("User validation", function() {');
+ expect(translatedCode).toContain('expect(responseJson.name).to.be.a(\'string\');');
+ expect(translatedCode).toContain('} else if (responseJson.type === \'admin\') {');
+ expect(translatedCode).toContain('test("Admin validation", function() {');
+ expect(translatedCode).toContain('expect(responseJson.accessLevel).to.be.above(5);');
+ });
+
+ it('should handle assertions with logical operators', () => {
+ const code = `
+ pm.test("Response has valid structure", function() {
+ const data = pm.response.json();
+
+ pm.expect(data.id && data.name).to.be.ok;
+ pm.expect(data.active || data.pending).to.be.true;
+ pm.expect(!data.deleted).to.be.true;
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("Response has valid structure", function() {');
+ expect(translatedCode).toContain('const data = res.getBody();');
+ expect(translatedCode).toContain('expect(data.id && data.name).to.be.ok;');
+ expect(translatedCode).toContain('expect(data.active || data.pending).to.be.true;');
+ expect(translatedCode).toContain('expect(!data.deleted).to.be.true;');
+ });
+
+ it('should handle array and object assertions', () => {
+ const code = `
+ pm.test("Array and object validations", function() {
+ const data = pm.response.json();
+
+ // Array validations
+ pm.expect(data.items).to.be.an('array');
+ pm.expect(data.items).to.have.lengthOf.at.least(1);
+ pm.expect(data.items[0]).to.have.property('id');
+
+ // Object validations
+ pm.expect(data.user).to.be.an('object');
+ pm.expect(data.user).to.have.all.keys('id', 'name', 'email');
+ pm.expect(data.user).to.include({active: true});
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("Array and object validations", function() {');
+ expect(translatedCode).toContain('const data = res.getBody();');
+ expect(translatedCode).toContain('expect(data.items).to.be.an(\'array\');');
+ expect(translatedCode).toContain('expect(data.items).to.have.lengthOf.at.least(1);');
+ expect(translatedCode).toContain('expect(data.items[0]).to.have.property(\'id\');');
+ expect(translatedCode).toContain('expect(data.user).to.be.an(\'object\');');
+ expect(translatedCode).toContain('expect(data.user).to.have.all.keys(\'id\', \'name\', \'email\');');
+ expect(translatedCode).toContain('expect(data.user).to.include({active: true});');
+ });
+
+ it('should handle chai assertions with deep equality', () => {
+ const code = `
+ pm.test("Deep equality checks", function() {
+ const data = pm.response.json();
+
+ pm.expect(data.config).to.deep.equal({
+ version: "1.0",
+ active: true,
+ features: ["search", "export"]
+ });
+
+ pm.expect(data.tags).to.have.members(['api', 'test']);
+ pm.expect(data.meta).to.deep.include({format: 'json'});
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("Deep equality checks", function() {');
+ expect(translatedCode).toContain('const data = res.getBody();');
+ expect(translatedCode).toContain('expect(data.config).to.deep.equal({');
+ expect(translatedCode).toContain('version: "1.0",');
+ expect(translatedCode).toContain('active: true,');
+ expect(translatedCode).toContain('features: ["search", "export"]');
+ expect(translatedCode).toContain('expect(data.tags).to.have.members([\'api\', \'test\']);');
+ expect(translatedCode).toContain('expect(data.meta).to.deep.include({format: \'json\'});');
+ });
+
+ it('should handle chai assertions with string comparisons', () => {
+ const code = `
+ pm.test("String validations", function() {
+ const data = pm.response.json();
+
+ pm.expect(data.id).to.be.a('string');
+ pm.expect(data.name).to.match(/^[A-Za-z\\s]+$/);
+ pm.expect(data.description).to.include('API');
+ pm.expect(data.url).to.have.string('api/v1');
+ pm.expect(data.code).to.have.lengthOf(8);
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("String validations", function() {');
+ expect(translatedCode).toContain('const data = res.getBody();');
+ expect(translatedCode).toContain('expect(data.id).to.be.a(\'string\');');
+ expect(translatedCode).toContain('expect(data.name).to.match(/^[A-Za-z\\s]+$/);');
+ expect(translatedCode).toContain('expect(data.description).to.include(\'API\');');
+ expect(translatedCode).toContain('expect(data.url).to.have.string(\'api/v1\');');
+ expect(translatedCode).toContain('expect(data.code).to.have.lengthOf(8);');
+ });
+
+ it('should handle assertions with numeric comparisons', () => {
+ const code = `
+ pm.test("Numeric validations", function() {
+ const data = pm.response.json();
+
+ pm.expect(data.count).to.be.a('number');
+ pm.expect(data.count).to.be.above(0);
+ pm.expect(data.price).to.be.within(10, 100);
+ pm.expect(data.discount).to.be.at.most(25);
+ pm.expect(data.quantity * data.price).to.equal(data.total);
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("Numeric validations", function() {');
+ expect(translatedCode).toContain('const data = res.getBody();');
+ expect(translatedCode).toContain('expect(data.count).to.be.a(\'number\');');
+ expect(translatedCode).toContain('expect(data.count).to.be.above(0);');
+ expect(translatedCode).toContain('expect(data.price).to.be.within(10, 100);');
+ expect(translatedCode).toContain('expect(data.discount).to.be.at.most(25);');
+ expect(translatedCode).toContain('expect(data.quantity * data.price).to.equal(data.total);');
+ });
+
+ it('should handle pm.expect.fail with conditions', () => {
+ const code = `
+ pm.test("Validate critical fields", function() {
+ const data = pm.response.json();
+
+ if (!data.id) {
+ pm.expect.fail("Missing ID field");
+ }
+
+ if (data.status !== 'active' && data.status !== 'pending') {
+ pm.expect.fail("Invalid status: " + data.status);
+ }
+
+ // Continue with normal assertions
+ pm.expect(data.name).to.be.a('string');
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('test("Validate critical fields", function() {');
+ expect(translatedCode).toContain('const data = res.getBody();');
+ expect(translatedCode).toContain('if (!data.id) {');
+ expect(translatedCode).toContain('expect.fail("Missing ID field");');
+ expect(translatedCode).toContain('if (data.status !== \'active\' && data.status !== \'pending\') {');
+ expect(translatedCode).toContain('expect.fail("Invalid status: " + data.status);');
+ expect(translatedCode).toContain('expect(data.name).to.be.a(\'string\');');
+ });
+
+ it('should handle complex test compositions', () => {
+ const code = `
+ // Helper function
+ function validateUserObject(user) {
+ pm.expect(user).to.be.an('object');
+ pm.expect(user.id).to.be.a('string');
+ pm.expect(user.name).to.be.a('string');
+ return user.id && user.name;
+ }
+
+ pm.test("Response validation", function() {
+ const response = pm.response.json();
+ const validUsers = [];
+
+ // Test status code
+ pm.response.to.have.status(200);
+
+ // Test main user
+ if (response.user) {
+ const isValid = validateUserObject(response.user);
+ if (isValid) {
+ validUsers.push(response.user);
+ }
+ }
+
+ // Test related users
+ if (response.relatedUsers && Array.isArray(response.relatedUsers)) {
+ pm.test("Related users validation", function() {
+ response.relatedUsers.forEach((user, index) => {
+ pm.test(\`User at index \${index}\`, function() {
+ const isValid = validateUserObject(user);
+ if (isValid) {
+ validUsers.push(user);
+ }
+ });
+ });
+ });
+ }
+
+ // Set the valid users for later use
+ if (validUsers.length > 0) {
+ pm.environment.set("validUsers", JSON.stringify(validUsers));
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+
+ // Test key transformations
+ expect(translatedCode).toContain('function validateUserObject(user) {');
+ expect(translatedCode).toContain('expect(user).to.be.an(\'object\');');
+ expect(translatedCode).toContain('test("Response validation", function() {');
+ expect(translatedCode).toContain('const response = res.getBody();');
+ expect(translatedCode).toContain('expect(res.getStatus()).to.equal(200);');
+ expect(translatedCode).toContain('test("Related users validation", function() {');
+ expect(translatedCode).toContain('test(`User at index ${index}`, function() {');
+ expect(translatedCode).toContain('bru.setEnvVar("validUsers", JSON.stringify(validUsers));');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/transformers/send-request.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/transformers/send-request.test.js
new file mode 100644
index 000000000..68ac426d4
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/transformers/send-request.test.js
@@ -0,0 +1,806 @@
+import translateCode from '../../../../../src/utils/jscode-shift-translator';
+
+describe('Send Request Translation', () => {
+ describe('Raw Body Mode', () => {
+ it('should transform raw JSON string body', () => {
+ const code = `
+ pm.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ header: {
+ 'Accept': 'application/json',
+ 'Content-Type': 'application/json',
+ },
+ body: {
+ mode: 'raw',
+ raw: JSON.stringify({
+ "x": 1
+ })
+ }
+ }, async function (error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.json();
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ headers: {
+ 'Accept': 'application/json',
+ 'Content-Type': 'application/json',
+ },
+ data: JSON.stringify({
+ "x": 1
+ })
+ }, async function(error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.data;
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `);
+ });
+
+ it('should transform raw JSON object body', () => {
+ const code = `
+ pm.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ header: {
+ 'Accept': 'application/json',
+ 'Content-Type': 'application/json',
+ },
+ body: {
+ mode: 'raw',
+ raw: {
+ "x": 1
+ }
+ }
+ }, function (error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.json();
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ headers: {
+ 'Accept': 'application/json',
+ 'Content-Type': 'application/json',
+ },
+ data: {
+ "x": 1
+ }
+ }, async function(error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.data;
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `);
+ });
+
+ it('should transform raw text body', () => {
+ const code = `
+ pm.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ header: {
+ 'Content-Type': 'text/plain',
+ },
+ body: {
+ mode: 'raw',
+ raw: 'Hello World'
+ }
+ }, function (error, response) {
+ console.log(response.text());
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ headers: {
+ 'Content-Type': 'text/plain',
+ },
+ data: 'Hello World'
+ }, async function(error, response) {
+ console.log(response.data);
+ });
+ `);
+ });
+ });
+
+ describe('URL-encoded Body Mode', () => {
+ it('should transform urlencoded body with single key-value pair', () => {
+ const code = `
+ pm.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ header: {
+ 'Accept': 'application/json',
+ 'Content-Type': 'application/x-www-form-urlencoded',
+ },
+ body: {
+ mode: 'urlencoded',
+ urlencoded: [
+ { key: "key", value: "value" }
+ ]
+ }
+ }, function (error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.json();
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ headers: {
+ 'Accept': 'application/json',
+ "Content-Type": "application/x-www-form-urlencoded",
+ },
+ data: {
+ "key": "value"
+ }
+ }, async function(error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.data;
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `);
+ });
+
+ it('should transform urlencoded body with multiple key-value pairs', () => {
+ const code = `
+ pm.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ header: {},
+ body: {
+ mode: 'urlencoded',
+ urlencoded: [
+ { key: "firstName", value: "John" },
+ { key: "lastName", value: "Doe" },
+ { key: "email", value: "john.doe@example.com" }
+ ]
+ }
+ }, function (error, response) {
+ console.log(response.json());
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ headers: {
+ "Content-Type": "application/x-www-form-urlencoded"
+ },
+ data: {
+ "firstName": "John",
+ "lastName": "Doe",
+ "email": "john.doe@example.com"
+ }
+ }, async function(error, response) {
+ console.log(response.data);
+ });
+ `);
+ });
+
+ it('should transform urlencoded body when no Content-Type header exists', () => {
+ const code = `
+ pm.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ body: {
+ mode: 'urlencoded',
+ urlencoded: [
+ { key: "key1", value: "value1" },
+ { key: "key2", value: "value2" }
+ ]
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+
+ data: {
+ "key1": "value1",
+ "key2": "value2"
+ },
+
+ headers: {
+ "Content-Type": "application/x-www-form-urlencoded"
+ }
+ });
+ `);
+ });
+
+ it('should transform urlencoded body with incorrect Content-Type header', () => {
+ const code = `
+ pm.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ headers: {
+ "Content-Type": "text/plain"
+ },
+ body: {
+ mode: 'urlencoded',
+ urlencoded: [
+ { key: "key1", value: "value1" },
+ { key: "key2", value: "value2" }
+ ]
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ headers: {
+ "Content-Type": "application/x-www-form-urlencoded"
+ },
+ data: {
+ "key1": "value1",
+ "key2": "value2"
+ }
+ });
+ `);
+ });
+ });
+
+ describe('Multi-part Form Data Body Mode', () => {
+ it('should transform formdata body with single key-value pair', () => {
+ const code = `
+ pm.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ header: {
+ 'Content-Type': 'multipart/form-data',
+ },
+ body: {
+ mode: 'formdata',
+ formdata: [
+ { key: "key", value: "value" }
+ ]
+ }
+ }, function (error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.json();
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ headers: {
+ "Content-Type": "multipart/form-data",
+ },
+ data: {
+ "key": "value"
+ }
+ }, async function(error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.data;
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `);
+ });
+
+ it('should transform formdata body with multiple key-value pair', () => {
+ const code = `
+ pm.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ header: {
+ 'Content-Type': 'multipart/form-data',
+ },
+ body: {
+ mode: 'formdata',
+ formdata: [
+ { key: "firstName", value: "John" },
+ { key: "lastName", value: "Doe" },
+ { key: "email", value: "john.doe@example.com" }
+ ]
+ }
+ }, function (error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.json();
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ headers: {
+ "Content-Type": "multipart/form-data",
+ },
+ data: {
+ "firstName": "John",
+ "lastName": "Doe",
+ "email": "john.doe@example.com"
+ }
+ }, async function(error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.data;
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `);
+ });
+
+ it('should transform formdata body when no Content-Type header exists', () => {
+ const code = `
+ pm.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ body: {
+ mode: 'formdata',
+ formdata: [
+ { key: "firstName", value: "John" },
+ { key: "lastName", value: "Doe" },
+ { key: "email", value: "john.doe@example.com" }
+ ]
+ }
+ }, function (error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.json();
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+
+ data: {
+ "firstName": "John",
+ "lastName": "Doe",
+ "email": "john.doe@example.com"
+ },
+
+ headers: {
+ "Content-Type": "multipart/form-data"
+ }
+ }, async function(error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.data;
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `);
+ });
+
+ it('should transform formdata body with incorrect Content-Type header', () => {
+ const code = `
+ pm.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ headers: {
+ "Content-Type": "text/plain"
+ },
+ body: {
+ mode: 'formdata',
+ formdata: [
+ { key: "firstName", value: "John" },
+ { key: "lastName", value: "Doe" },
+ { key: "email", value: "john.doe@example.com" }
+ ]
+ }
+ }, function (error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.json();
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ headers: {
+ "Content-Type": "multipart/form-data"
+ },
+ data: {
+ "firstName": "John",
+ "lastName": "Doe",
+ "email": "john.doe@example.com"
+ }
+ }, async function(error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.data;
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `);
+ });
+ });
+
+ describe('Headers and Content-Type Handling', () => {
+ it('should rename header property to headers', () => {
+ const code = `
+ pm.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'GET',
+ header: {
+ 'X-Custom-Header': 'custom-value',
+ 'Authorization': 'Bearer token'
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'GET',
+ headers: {
+ 'X-Custom-Header': 'custom-value',
+ 'Authorization': 'Bearer token'
+ }
+ });
+ `);
+ });
+
+ it('should handle header array format', () => {
+ const code = `
+ pm.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'GET',
+ header: [
+ { key: 'X-Custom-Header', value: 'custom-value' },
+ { key: 'Authorization', value: 'Bearer token' }
+ ]
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'GET',
+ headers: {
+ "X-Custom-Header": 'custom-value',
+ "Authorization": 'Bearer token'
+ }
+ });
+ `);
+ });
+ });
+
+ describe('Response Handling', () => {
+ it('should transform response property access', () => {
+ const code = `
+ pm.sendRequest('https://echo.usebruno.com', function (error, response) {
+ const status = response.code;
+ const statusText = response.status;
+ const headers = response.headers;
+ const body = response.json();
+ const responseTime = response.responseTime;
+ const text = response.text();
+
+ if (status === 200) {
+ console.log('Success!');
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toContain(`const status = response.status;
+ const statusText = response.statusText;`);
+ expect(translatedCode).toContain('const headers = response.headers');
+ expect(translatedCode).toContain('const body = response.data');
+ expect(translatedCode).toContain('const responseTime = response.responseTime');
+ expect(translatedCode).toContain('const text = response.data');
+ });
+ });
+
+ describe('Async/Await', () => {
+ it('Should not add await if already present', () => {
+ const code = `
+ try {
+ const response = await pm.sendRequest({
+ url: "https://echo.usebruno.com",
+ method: "GET"
+ });
+
+ console.log(response.json());
+ } catch (err) {
+ console.error(err);
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ try {
+ const response = await bru.sendRequest({
+ url: "https://echo.usebruno.com",
+ method: "GET"
+ });
+
+ console.log(response.json());
+ } catch (err) {
+ console.error(err);
+ }
+ `);
+ });
+
+ it('Should handle arrow function callbacks', () => {
+ const code = `
+ try {
+ pm.sendRequest({
+ url: "https://echo.usebruno.com",
+ method: "GET"
+ }, (error, response) => {
+ console.log(response.json());
+ });
+ } catch (err) {
+ console.error(err);
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ try {
+ await bru.sendRequest({
+ url: "https://echo.usebruno.com",
+ method: "GET"
+ }, async function(error, response) {
+ console.log(response.data);
+ });
+ } catch (err) {
+ console.error(err);
+ }
+ `);
+ });
+
+ it('Should handle async arrow function callbacks', () => {
+ const code = `
+ try {
+ pm.sendRequest({
+ url: "https://echo.usebruno.com",
+ method: "GET"
+ }, async (error, response) => {
+ await new Promise(resolve => {
+ setTimeout(() => {
+ resolve();
+ }, 1000)
+ });
+ console.log(response.json());
+ });
+ } catch (err) {
+ console.error(err);
+ }
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ try {
+ await bru.sendRequest({
+ url: "https://echo.usebruno.com",
+ method: "GET"
+ }, async function(error, response) {
+ await new Promise(resolve => {
+ setTimeout(() => {
+ resolve();
+ }, 1000)
+ });
+ console.log(response.data);
+ });
+ } catch (err) {
+ console.error(err);
+ }
+ `);
+ });
+ });
+
+ describe('requestConfig variables', () => {
+ it('requestConfig passed as a variable', () => {
+ const code = `
+ const requestConfig = {
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ header: {
+ 'Accept': 'application/json',
+ 'Content-Type': 'application/json',
+ },
+ body: {
+ mode: 'raw',
+ raw: JSON.stringify({
+ "x": 1
+ })
+ }
+ };
+ pm.sendRequest(requestConfig, async function (error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.json();
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const requestConfig = {
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ headers: {
+ 'Accept': 'application/json',
+ 'Content-Type': 'application/json',
+ },
+ data: JSON.stringify({
+ "x": 1
+ })
+ };
+ await bru.sendRequest(requestConfig, async function(error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.data;
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `);
+ });
+
+ it('requestConfig passed as a variable with multi-level references', () => {
+ const code = `
+ const requestConfig = {
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ header: {
+ 'Accept': 'application/json',
+ 'Content-Type': 'application/json',
+ },
+ body: {
+ mode: 'raw',
+ raw: JSON.stringify({
+ "x": 1
+ })
+ }
+ };
+ const requestConfig1 = requestConfig;
+ const requestConfig2 = requestConfig1;
+ const requestConfig3 = requestConfig2;
+ pm.sendRequest(requestConfig3, async function (error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.json();
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `;
+ const translatedCode = translateCode(code);
+ expect(translatedCode).toBe(`
+ const requestConfig = {
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ headers: {
+ 'Accept': 'application/json',
+ 'Content-Type': 'application/json',
+ },
+ data: JSON.stringify({
+ "x": 1
+ })
+ };
+ const requestConfig1 = requestConfig;
+ const requestConfig2 = requestConfig1;
+ const requestConfig3 = requestConfig2;
+ await bru.sendRequest(requestConfig3, async function(error, response) {
+ if (error) {
+ const errorCode = error.code;
+ console.log(errorCode);
+ }
+ if (response) {
+ const response_body = response.data;
+ const response_headers = response.headers;
+ console.log(response_body, response_headers);
+ }
+ });
+ `);
+ });
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/variable-chaining.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/variable-chaining.test.js
new file mode 100644
index 000000000..3c700000e
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/variable-chaining.test.js
@@ -0,0 +1,91 @@
+import translateCode from '../../../../src/utils/jscode-shift-translator';
+
+describe('Variable Chaining Resolution', () => {
+ test('should resolve a simple variable chain (variable pointing to another variable)', () => {
+ const code = `
+ const original = pm.response;
+ const alias = original;
+ const data = alias.json();
+ `;
+
+ const translatedCode = translateCode(code);
+
+ // Check that alias.json() was properly resolved to res.getBody()
+ expect(translatedCode).toContain('const data = res.getBody();');
+ // The original variable declarations should be removed
+ expect(translatedCode).not.toContain('const original =');
+ expect(translatedCode).not.toContain('const alias =');
+ });
+
+ test('should handle mixed variable references correctly', () => {
+ const code = `
+ const respVar = pm.response;
+ const envVar = pm.environment;
+ const respAlias = respVar;
+
+ // These should be replaced
+ const statusCode = respAlias.code;
+ const envValue = envVar.get("key");
+
+ // This should not be replaced
+ const unrelatedVar = "some value";
+ `;
+
+ const translatedCode = translateCode(code);
+
+ // Check correct replacements
+ expect(translatedCode).not.toContain('const respVar');
+ expect(translatedCode).not.toContain('const envVar');
+ expect(translatedCode).toContain('const statusCode = res.getStatus();');
+ expect(translatedCode).toContain('const envValue = bru.getEnvVar("key");');
+
+ // Check that unrelated variables are preserved
+ expect(translatedCode).toContain('const unrelatedVar = "some value";');
+ });
+
+ /**
+ * This test verifies that when multiple variables are declared in a single statement,
+ * only the ones referencing Postman objects are removed and the others are preserved.
+ *
+ * For example, in a statement like:
+ * const response = pm.response, counter = 5, helper = "test";
+ *
+ * Only 'response' should be removed, resulting in:
+ * const counter = 5, helper = "test";
+ */
+ test('should handle multiple variables in one declaration statement', () => {
+ const code = `
+ // Multiple variables in one declaration, with a mix of Postman objects and regular variables
+ const response = pm.response, counter = 5, helper = "test";
+
+ // Using both the Postman reference (should be replaced) and regular values (should be preserved)
+ const statusCode = response.code;
+ console.log("Counter value:", counter);
+ console.log("Helper string:", helper);
+
+ // Another example with different Postman object
+ let env = pm.environment, timeout = 1000, isValid = true;
+ const baseUrl = env.get("baseUrl");
+ `;
+
+ const translatedCode = translateCode(code);
+
+ // Postman references should be replaced
+ expect(translatedCode).not.toContain('response = pm.response');
+ expect(translatedCode).not.toContain('env = pm.environment');
+
+ // Regular variables should be preserved
+ expect(translatedCode).toContain('const counter = 5');
+ expect(translatedCode).toContain('helper = "test"');
+ expect(translatedCode).toContain('timeout = 1000');
+ expect(translatedCode).toContain('isValid = true');
+
+ // References to Postman objects should be properly translated
+ expect(translatedCode).toContain('const statusCode = res.getStatus();');
+ expect(translatedCode).toContain('const baseUrl = bru.getEnvVar("baseUrl");');
+
+ // Console logs with regular variables should be preserved
+ expect(translatedCode).toContain('console.log("Counter value:", counter);');
+ expect(translatedCode).toContain('console.log("Helper string:", helper);');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/variables.test.js b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/variables.test.js
new file mode 100644
index 000000000..fe0f80593
--- /dev/null
+++ b/packages/bruno-converters/tests/postman/postman-translations/transpiler-tests/variables.test.js
@@ -0,0 +1,207 @@
+import translateCode from '../../../../src/utils/jscode-shift-translator';
+
+describe('Variables Translation', () => {
+ // Regular variables tests
+ it('should translate pm.variables.get', () => {
+ const code = 'pm.variables.get("test");';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('bru.getVar("test");');
+ });
+
+ it('should translate pm.variables.set', () => {
+ const code = 'pm.variables.set("test", "value");';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('bru.setVar("test", "value");');
+ });
+
+ it('should translate pm.variables.has', () => {
+ const code = 'pm.variables.has("userId");';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('bru.hasVar("userId");');
+ });
+
+ it('should translate pm.variables.replaceIn', () => {
+ const code = 'pm.variables.replaceIn("Hello {{name}}");';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('bru.interpolate("Hello {{name}}");');
+ });
+
+ it('should translate pm.variables.replaceIn with variables and expressions', () => {
+ const code = 'const greeting = pm.variables.replaceIn("Hello {{name}}, your user id is {{userId}}");';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('const greeting = bru.interpolate("Hello {{name}}, your user id is {{userId}}");');
+ });
+
+ it('should translate pm.variables.replaceIn within complex expressions', () => {
+ const code = 'const url = baseUrl + pm.variables.replaceIn("/users/{{userId}}/profile");';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('const url = baseUrl + bru.interpolate("/users/{{userId}}/profile");');
+ });
+
+ it('should translate pm.variables.replaceIn with multiple nested variable references', () => {
+ const code = 'const template = pm.variables.replaceIn("{{prefix}}-{{env}}-{{suffix}}");';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('const template = bru.interpolate("{{prefix}}-{{env}}-{{suffix}}");');
+ });
+
+ it('should translate aliased variables.replaceIn', () => {
+ const code = `
+ const variables = pm.variables;
+ const message = variables.replaceIn("Welcome, {{username}}!");
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe(`
+ const message = bru.interpolate("Welcome, {{username}}!");
+ `);
+ });
+
+ // Collection variables tests
+ it('should translate pm.collectionVariables.get', () => {
+ const code = 'pm.collectionVariables.get("apiUrl");';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('bru.getVar("apiUrl");');
+ });
+
+ it('should translate pm.collectionVariables.set', () => {
+ const code = 'pm.collectionVariables.set("token", jsonData.token);';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('bru.setVar("token", jsonData.token);');
+ });
+
+ it('should translate pm.collectionVariables.has', () => {
+ const code = 'pm.collectionVariables.has("authToken");';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('bru.hasVar("authToken");');
+ });
+
+ it('should translate pm.collectionVariables.unset', () => {
+ const code = 'pm.collectionVariables.unset("tempVar");';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('bru.deleteVar("tempVar");');
+ });
+
+ it('should handle pm.globals.get', () => {
+ const code = 'pm.globals.get("test");';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('bru.getGlobalEnvVar("test");');
+ });
+
+ it('should handle pm.globals.set', () => {
+ const code = 'pm.globals.set("test", "value");';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('bru.setGlobalEnvVar("test", "value");');
+ });
+
+ // Alias tests for variables
+ it('should handle variables aliases', () => {
+ const code = `
+ const vars = pm.variables;
+ const has = vars.has("test");
+ const set = vars.set("test", "value");
+ const get = vars.get("test");
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe(`
+ const has = bru.hasVar("test");
+ const set = bru.setVar("test", "value");
+ const get = bru.getVar("test");
+ `);
+ });
+
+ // Alias tests for collection variables
+ it('should handle collection variables aliases', () => {
+ const code = `
+ const collVars = pm.collectionVariables;
+ const has = collVars.has("test");
+ const set = collVars.set("test", "value");
+ const get = collVars.get("test");
+ const unset = collVars.unset("test");
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe(`
+ const has = bru.hasVar("test");
+ const set = bru.setVar("test", "value");
+ const get = bru.getVar("test");
+ const unset = bru.deleteVar("test");
+ `);
+ });
+
+ it('should handle pm.globals aliases', () => {
+ const code = `
+ const globals = pm.globals;
+ const get = globals.get("test");
+ const set = globals.set("test", "value");
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe(`
+ const get = bru.getGlobalEnvVar("test");
+ const set = bru.setGlobalEnvVar("test", "value");
+ `);
+ })
+
+ // Combined tests
+ it('should handle conditional expressions with variable calls', () => {
+ const code = 'const userStatus = pm.variables.has("userId") ? "logged-in" : "guest";';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('const userStatus = bru.hasVar("userId") ? "logged-in" : "guest";');
+ });
+
+ it('should handle all variable methods together', () => {
+ const code = `
+ // All variable methods
+ const hasUserId = pm.variables.has("userId");
+ const userId = pm.variables.get("userId");
+ pm.variables.set("requestTime", new Date().toISOString());
+
+ console.log(\`Has userId: \${hasUserId}, User ID: \${userId}\`);
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const hasUserId = bru.hasVar("userId");');
+ expect(translatedCode).toContain('const userId = bru.getVar("userId");');
+ expect(translatedCode).toContain('bru.setVar("requestTime", new Date().toISOString());');
+ });
+
+ it('should handle all collection variable methods together', () => {
+ const code = `
+ // All collection variable methods
+ const hasApiUrl = pm.collectionVariables.has("apiUrl");
+ const apiUrl = pm.collectionVariables.get("apiUrl");
+ pm.collectionVariables.set("requestTime", new Date().toISOString());
+ pm.collectionVariables.unset("tempVar");
+
+ console.log(\`Has API URL: \${hasApiUrl}, API URL: \${apiUrl}\`);
+ `;
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toContain('const hasApiUrl = bru.hasVar("apiUrl");');
+ expect(translatedCode).toContain('const apiUrl = bru.getVar("apiUrl");');
+ expect(translatedCode).toContain('bru.setVar("requestTime", new Date().toISOString());');
+ expect(translatedCode).toContain('bru.deleteVar("tempVar");');
+ });
+
+ it('should handle more complex nested expressions with variables', () => {
+ const code = 'pm.collectionVariables.set("fullPath", pm.environment.get("baseUrl") + pm.variables.get("endpoint"));';
+ const translatedCode = translateCode(code);
+
+ expect(translatedCode).toBe('bru.setVar("fullPath", bru.getEnvVar("baseUrl") + bru.getVar("endpoint"));');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tests/utils/getMemberExpressionString.test.js b/packages/bruno-converters/tests/utils/getMemberExpressionString.test.js
new file mode 100644
index 000000000..f5dd69f09
--- /dev/null
+++ b/packages/bruno-converters/tests/utils/getMemberExpressionString.test.js
@@ -0,0 +1,53 @@
+import { describe, it, expect } from '@jest/globals';
+import { getMemberExpressionString } from '../../src/utils/jscode-shift-translator';
+const j = require('jscodeshift');
+
+describe('getMemberExpressionString', () => {
+ it('should correctly convert simple member expressions to strings', () => {
+ // Create a simple member expression: pm.environment.get
+ const memberExpr = j.memberExpression(
+ j.memberExpression(
+ j.identifier('pm'),
+ j.identifier('environment')
+ ),
+ j.identifier('get')
+ );
+
+ const result = getMemberExpressionString(memberExpr);
+ expect(result).toBe('pm.environment.get');
+ });
+
+ it('should handle computed properties with string literals', () => {
+ // Create a computed member expression: pm["environment"]["get"]
+ const memberExpr = j.memberExpression(
+ j.memberExpression(
+ j.identifier('pm'),
+ j.literal('environment'),
+ true // computed
+ ),
+ j.literal('get'),
+ true // computed
+ );
+
+ const result = getMemberExpressionString(memberExpr);
+ expect(result).toBe('pm.environment.get');
+ });
+
+ it('should mark non-string computed properties as [computed]', () => {
+ // Create a computed member expression with variable: obj[varName]
+ const memberExpr = j.memberExpression(
+ j.identifier('obj'),
+ j.identifier('varName'),
+ true // computed
+ );
+
+ const result = getMemberExpressionString(memberExpr);
+ expect(result).toBe('obj.[computed]');
+ });
+
+ it('should handle basic identifiers', () => {
+ const identifier = j.identifier('pm');
+ const result = getMemberExpressionString(identifier);
+ expect(result).toBe('pm');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-converters/tsconfig.json b/packages/bruno-converters/tsconfig.json
new file mode 100644
index 000000000..57a8bcc74
--- /dev/null
+++ b/packages/bruno-converters/tsconfig.json
@@ -0,0 +1,19 @@
+{
+ "compilerOptions": {
+ "target": "ES6",
+ "esModuleInterop": true,
+ "strict": true,
+ "skipLibCheck": true,
+ "jsx": "react",
+ "module": "ESNext",
+ "declaration": true,
+ "declarationDir": "types",
+ "sourceMap": true,
+ "outDir": "dist",
+ "moduleResolution": "node",
+ "emitDeclarationOnly": true,
+ "allowSyntheticDefaultImports": true,
+ "forceConsistentCasingInFileNames": true
+ },
+ "exclude": ["dist", "node_modules", "tests"]
+}
diff --git a/packages/bruno-converters/types/common.d.ts b/packages/bruno-converters/types/common.d.ts
new file mode 100644
index 000000000..2e7608adb
--- /dev/null
+++ b/packages/bruno-converters/types/common.d.ts
@@ -0,0 +1,6 @@
+export declare const uuid: () => string;
+export declare const normalizeFileName: (name: string) => string;
+export declare const validateSchema: (collection?: {}) => Promise;
+export declare const updateUidsInCollection: (_collection: any) => any;
+export declare const transformItemsInCollection: (collection: any) => any;
+export declare const hydrateSeqInCollection: (collection: any) => any;
diff --git a/packages/bruno-docs/package.json b/packages/bruno-docs/package.json
index fc144d697..77aa04c0f 100644
--- a/packages/bruno-docs/package.json
+++ b/packages/bruno-docs/package.json
@@ -8,4 +8,4 @@
],
"dependencies": {
}
-}
+}
\ No newline at end of file
diff --git a/packages/bruno-electron/electron-builder-config.js b/packages/bruno-electron/electron-builder-config.js
index 57d3f6a0d..ea3acf6f3 100644
--- a/packages/bruno-electron/electron-builder-config.js
+++ b/packages/bruno-electron/electron-builder-config.js
@@ -3,7 +3,7 @@ require('dotenv').config({ path: process.env.DOTENV_PATH });
const config = {
appId: 'com.usebruno.app',
productName: 'Bruno',
- electronVersion: '33.2.1',
+ electronVersion: '37.2.6',
directories: {
buildResources: 'resources',
output: 'out'
@@ -34,11 +34,39 @@ const config = {
icon: 'resources/icons/png',
target: ['AppImage', 'deb', 'snap', 'rpm']
},
+ deb: {
+ // Docs: https://www.electron.build/configuration/linux#debian-package-options
+ depends: [
+ 'libgtk-3-0',
+ 'libnotify4',
+ 'libnss3',
+ 'libxss1',
+ 'libxtst6',
+ 'xdg-utils',
+ 'libatspi2.0-0',
+ 'libuuid1',
+ 'libsecret-1-0',
+ 'libasound2' // #1036
+ ]
+ },
win: {
artifactName: '${name}_${version}_${arch}_win.${ext}',
- icon: 'resources/icons/png',
- certificateFile: `${process.env.WIN_CERT_FILEPATH}`,
- certificatePassword: `${process.env.WIN_CERT_PASSWORD}`
+ icon: 'resources/icons/win/icon.ico',
+ target: [
+ {
+ target: 'nsis',
+ arch: ['x64']
+ }
+ ],
+ sign: null,
+ publisherName: 'Bruno Software Inc'
+ },
+ nsis: {
+ oneClick: false,
+ allowToChangeInstallationDirectory: true,
+ allowElevation: true,
+ createDesktopShortcut: true,
+ createStartMenuShortcut: true
}
};
diff --git a/packages/bruno-electron/package.json b/packages/bruno-electron/package.json
index 16a032b3a..3e0defb81 100644
--- a/packages/bruno-electron/package.json
+++ b/packages/bruno-electron/package.json
@@ -1,14 +1,19 @@
{
- "version": "v1.38.1",
+ "version": "2.0.0",
"name": "bruno",
"description": "Opensource API Client for Exploring and Testing APIs",
"homepage": "https://www.usebruno.com",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/usebruno/bruno.git"
+ },
"private": true,
"main": "src/index.js",
"author": "Anoop M D (https://helloanoop.com/)",
"scripts": {
"clean": "rimraf dist",
"dev": "electron .",
+ "debug": "electron . --inspect=9229",
"dist:mac": "electron-builder --mac --config electron-builder-config.js",
"dist:win": "electron-builder --win --config electron-builder-config.js",
"dist:linux": "electron-builder --linux AppImage --config electron-builder-config.js",
@@ -24,16 +29,21 @@
]
},
"dependencies": {
- "@aws-sdk/credential-providers": "3.658.1",
+ "@aws-sdk/credential-providers": "3.750.0",
+ "@grpc/grpc-js": "^1.13.2",
+ "@grpc/proto-loader": "^0.7.13",
"@usebruno/common": "0.1.0",
+ "@usebruno/converters": "^0.1.0",
+ "@usebruno/filestore": "^0.1.0",
"@usebruno/js": "0.12.0",
"@usebruno/lang": "0.12.0",
"@usebruno/node-machine-id": "^2.0.0",
+ "@usebruno/requests": "^0.1.0",
"@usebruno/schema": "0.7.0",
"@usebruno/vm2": "^3.9.13",
"about-window": "^1.15.2",
"aws4-axios": "^3.3.0",
- "axios": "1.7.5",
+ "axios": "^1.8.3",
"axios-ntlm": "^1.4.2",
"chai": "^4.3.7",
"chokidar": "^3.5.3",
@@ -57,7 +67,7 @@
"nanoid": "3.3.8",
"qs": "^6.11.0",
"socks-proxy-agent": "^8.0.2",
- "tough-cookie": "^4.1.3",
+ "tough-cookie": "^6.0.0",
"uuid": "^9.0.0",
"yup": "^0.32.11"
},
@@ -65,8 +75,8 @@
"dmg-license": "^1.0.11"
},
"devDependencies": {
- "electron": "33.2.1",
- "electron-builder": "25.1.8",
+ "electron": "~37.2.6",
+ "electron-builder": "^24.13.3",
"electron-devtools-installer": "^4.0.0"
}
}
diff --git a/packages/bruno-electron/src/app/about-bruno.js b/packages/bruno-electron/src/app/about-bruno.js
new file mode 100644
index 000000000..484a062be
--- /dev/null
+++ b/packages/bruno-electron/src/app/about-bruno.js
@@ -0,0 +1,176 @@
+module.exports = function aboutBruno({version}) {
+ return `
+
+
+
+ About Bruno
+
+
+
+
+
+
+
+
+
+
+
+ Bruno ${version}
+
+
+
+ `;
+};
\ No newline at end of file
diff --git a/packages/bruno-electron/src/app/watcher.js b/packages/bruno-electron/src/app/collection-watcher.js
similarity index 61%
rename from packages/bruno-electron/src/app/watcher.js
rename to packages/bruno-electron/src/app/collection-watcher.js
index 43d01153d..665792cdb 100644
--- a/packages/bruno-electron/src/app/watcher.js
+++ b/packages/bruno-electron/src/app/collection-watcher.js
@@ -2,17 +2,27 @@ const _ = require('lodash');
const fs = require('fs');
const path = require('path');
const chokidar = require('chokidar');
-const { hasBruExtension, isWSLPath, normalizeAndResolvePath, normalizeWslPath } = require('../utils/filesystem');
-const { bruToEnvJson, bruToJson, collectionBruToJson } = require('../bru');
-const { dotenvToJson } = require('@usebruno/lang');
+const { hasBruExtension, isWSLPath, normalizeAndResolvePath, sizeInMB } = require('../utils/filesystem');
+const {
+ parseEnvironment,
+ parseRequest,
+ parseRequestViaWorker,
+ parseCollection,
+ parseFolder
+} = require('@usebruno/filestore');
+const { parseDotEnv } = require('@usebruno/filestore');
const { uuid } = require('../utils/common');
const { getRequestUid } = require('../cache/requestUids');
-const { decryptString } = require('../utils/encryption');
+const { decryptStringSafe } = require('../utils/encryption');
const { setDotEnvVars } = require('../store/process-env');
const { setBrunoConfig } = require('../store/bruno-config');
const EnvironmentSecretsStore = require('../store/env-secrets');
const UiStateSnapshot = require('../store/ui-state-snapshot');
+const { parseBruFileMeta, hydrateRequestWithUuid } = require('../utils/collection');
+const { parseLargeRequestWithRedaction } = require('../utils/parse');
+
+const MAX_FILE_SIZE = 2.5 * 1024 * 1024;
const environmentSecretsStore = new EnvironmentSecretsStore();
@@ -44,28 +54,6 @@ const isCollectionRootBruFile = (pathname, collectionPath) => {
return dirname === collectionPath && basename === 'collection.bru';
};
-const hydrateRequestWithUuid = (request, pathname) => {
- request.uid = getRequestUid(pathname);
-
- const params = _.get(request, 'request.params', []);
- const headers = _.get(request, 'request.headers', []);
- const requestVars = _.get(request, 'request.vars.req', []);
- const responseVars = _.get(request, 'request.vars.res', []);
- const assertions = _.get(request, 'request.assertions', []);
- const bodyFormUrlEncoded = _.get(request, 'request.body.formUrlEncoded', []);
- const bodyMultipartForm = _.get(request, 'request.body.multipartForm', []);
-
- params.forEach((param) => (param.uid = uuid()));
- headers.forEach((header) => (header.uid = uuid()));
- requestVars.forEach((variable) => (variable.uid = uuid()));
- responseVars.forEach((variable) => (variable.uid = uuid()));
- assertions.forEach((assertion) => (assertion.uid = uuid()));
- bodyFormUrlEncoded.forEach((param) => (param.uid = uuid()));
- bodyMultipartForm.forEach((param) => (param.uid = uuid()));
-
- return request;
-};
-
const hydrateBruCollectionFileWithUuid = (collectionRoot) => {
const params = _.get(collectionRoot, 'request.params', []);
const headers = _.get(collectionRoot, 'request.headers', []);
@@ -99,7 +87,7 @@ const addEnvironmentFile = async (win, pathname, collectionUid, collectionPath)
let bruContent = fs.readFileSync(pathname, 'utf8');
- file.data = bruToEnvJson(bruContent);
+ file.data = await parseEnvironment(bruContent);
file.data.name = basename.substring(0, basename.length - 4);
file.data.uid = getRequestUid(pathname);
@@ -111,14 +99,15 @@ const addEnvironmentFile = async (win, pathname, collectionUid, collectionPath)
_.each(envSecrets, (secret) => {
const variable = _.find(file.data.variables, (v) => v.name === secret.name);
if (variable && secret.value) {
- variable.value = decryptString(secret.value);
+ const decryptionResult = decryptStringSafe(secret.value);
+ variable.value = decryptionResult.value;
}
});
}
win.webContents.send('main:collection-tree-updated', 'addEnvironmentFile', file);
} catch (err) {
- console.error(err);
+ console.error('Error processing environment file: ', err);
}
};
@@ -134,7 +123,7 @@ const changeEnvironmentFile = async (win, pathname, collectionUid, collectionPat
};
const bruContent = fs.readFileSync(pathname, 'utf8');
- file.data = bruToEnvJson(bruContent);
+ file.data = await parseEnvironment(bruContent);
file.data.name = basename.substring(0, basename.length - 4);
file.data.uid = getRequestUid(pathname);
_.each(_.get(file, 'data.variables', []), (variable) => (variable.uid = uuid()));
@@ -145,7 +134,8 @@ const changeEnvironmentFile = async (win, pathname, collectionUid, collectionPat
_.each(envSecrets, (secret) => {
const variable = _.find(file.data.variables, (v) => v.name === secret.name);
if (variable && secret.value) {
- variable.value = decryptString(secret.value);
+ const decryptionResult = decryptStringSafe(secret.value);
+ variable.value = decryptionResult.value;
}
});
}
@@ -179,7 +169,7 @@ const unlinkEnvironmentFile = async (win, pathname, collectionUid) => {
}
};
-const add = async (win, pathname, collectionUid, collectionPath) => {
+const add = async (win, pathname, collectionUid, collectionPath, useWorkerThread, watcher) => {
console.log(`watcher add: ${pathname}`);
if (isBrunoConfigFile(pathname, collectionPath)) {
@@ -196,7 +186,7 @@ const add = async (win, pathname, collectionUid, collectionPath) => {
if (isDotEnvFile(pathname, collectionPath)) {
try {
const content = fs.readFileSync(pathname, 'utf8');
- const jsonData = dotenvToJson(content);
+ const jsonData = parseDotEnv(content);
setDotEnvVars(collectionUid, jsonData);
const payload = {
@@ -228,7 +218,7 @@ const add = async (win, pathname, collectionUid, collectionPath) => {
try {
let bruContent = fs.readFileSync(pathname, 'utf8');
- file.data = collectionBruToJson(bruContent);
+ file.data = await parseCollection(bruContent);
hydrateBruCollectionFileWithUuid(file.data);
win.webContents.send('main:collection-tree-updated', 'addFile', file);
@@ -239,9 +229,7 @@ const add = async (win, pathname, collectionUid, collectionPath) => {
}
}
- // Is this a folder.bru file?
if (path.basename(pathname) === 'folder.bru') {
- console.log('folder.bru file detected');
const file = {
meta: {
collectionUid,
@@ -254,7 +242,7 @@ const add = async (win, pathname, collectionUid, collectionPath) => {
try {
let bruContent = fs.readFileSync(pathname, 'utf8');
- file.data = collectionBruToJson(bruContent);
+ file.data = await parseCollection(bruContent);
hydrateBruCollectionFileWithUuid(file.data);
win.webContents.send('main:collection-tree-updated', 'addFile', file);
@@ -266,6 +254,8 @@ const add = async (win, pathname, collectionUid, collectionPath) => {
}
if (hasBruExtension(pathname)) {
+ watcher.addFileToProcessing(collectionUid, pathname);
+
const file = {
meta: {
collectionUid,
@@ -274,33 +264,110 @@ const add = async (win, pathname, collectionUid, collectionPath) => {
}
};
+ const fileStats = fs.statSync(pathname);
+ let bruContent = fs.readFileSync(pathname, 'utf8');
+ // If worker thread is not used, we can directly parse the file
+ if (!useWorkerThread) {
+ try {
+ file.data = await parseRequest(bruContent);
+ file.partial = false;
+ file.loading = false;
+ file.size = sizeInMB(fileStats?.size);
+ hydrateRequestWithUuid(file.data, pathname);
+ win.webContents.send('main:collection-tree-updated', 'addFile', file);
+
+ } catch (error) {
+ console.error(error);
+ } finally {
+ watcher.markFileAsProcessed(win, collectionUid, pathname);
+ }
+ return;
+ }
+
try {
- let bruContent = fs.readFileSync(pathname, 'utf8');
-
- file.data = bruToJson(bruContent);
+ // we need to send a partial file info to the UI
+ // so that the UI can display the file in the collection tree
+ file.data = {
+ name: path.basename(pathname),
+ type: 'http-request'
+ };
+ const metaJson = parseBruFileMeta(bruContent);
+ file.data = metaJson;
+ file.partial = true;
+ file.loading = false;
+ file.size = sizeInMB(fileStats?.size);
hydrateRequestWithUuid(file.data, pathname);
win.webContents.send('main:collection-tree-updated', 'addFile', file);
- } catch (err) {
- console.error(err);
+
+ if (fileStats.size < MAX_FILE_SIZE) {
+ // This is to update the loading indicator in the UI
+ file.data = metaJson;
+ file.partial = false;
+ file.loading = true;
+ hydrateRequestWithUuid(file.data, pathname);
+ win.webContents.send('main:collection-tree-updated', 'addFile', file);
+
+ // This is to update the file info in the UI
+ file.data = await parseRequestViaWorker(bruContent);
+ file.partial = false;
+ file.loading = false;
+ hydrateRequestWithUuid(file.data, pathname);
+ win.webContents.send('main:collection-tree-updated', 'addFile', file);
+ }
+ } catch(error) {
+ file.data = {
+ name: path.basename(pathname),
+ type: 'http-request'
+ };
+ file.error = {
+ message: error?.message
+ };
+ file.partial = true;
+ file.loading = false;
+ file.size = sizeInMB(fileStats?.size);
+ hydrateRequestWithUuid(file.data, pathname);
+ win.webContents.send('main:collection-tree-updated', 'addFile', file);
+ } finally {
+ watcher.markFileAsProcessed(win, collectionUid, pathname);
}
}
};
-const addDirectory = (win, pathname, collectionUid, collectionPath) => {
+const addDirectory = async (win, pathname, collectionUid, collectionPath) => {
const envDirectory = path.join(collectionPath, 'environments');
if (pathname === envDirectory) {
return;
}
+ let name = path.basename(pathname);
+ let seq;
+ const folderBruFilePath = path.join(pathname, `folder.bru`);
+
+ try {
+ if (fs.existsSync(folderBruFilePath)) {
+ let folderBruFileContent = fs.readFileSync(folderBruFilePath, 'utf8');
+ let folderBruData = await parseFolder(folderBruFileContent);
+ name = folderBruData?.meta?.name || name;
+ seq = folderBruData?.meta?.seq;
+ }
+ }
+ catch(error) {
+ console.error('Error occured while parsing folder.bru file!');
+ console.error(error);
+ }
+
const directory = {
meta: {
collectionUid,
pathname,
- name: path.basename(pathname)
+ name,
+ seq,
+ uid: getRequestUid(pathname)
}
};
+
win.webContents.send('main:collection-tree-updated', 'addDir', directory);
};
@@ -325,7 +392,7 @@ const change = async (win, pathname, collectionUid, collectionPath) => {
if (isDotEnvFile(pathname, collectionPath)) {
try {
const content = fs.readFileSync(pathname, 'utf8');
- const jsonData = dotenvToJson(content);
+ const jsonData = parseDotEnv(content);
setDotEnvVars(collectionUid, jsonData);
const payload = {
@@ -357,7 +424,31 @@ const change = async (win, pathname, collectionUid, collectionPath) => {
try {
let bruContent = fs.readFileSync(pathname, 'utf8');
- file.data = collectionBruToJson(bruContent);
+ file.data = await parseCollection(bruContent);
+ hydrateBruCollectionFileWithUuid(file.data);
+ win.webContents.send('main:collection-tree-updated', 'change', file);
+ return;
+ } catch (err) {
+ console.error(err);
+ return;
+ }
+ }
+
+ if (path.basename(pathname) === 'folder.bru') {
+ const file = {
+ meta: {
+ collectionUid,
+ pathname,
+ name: path.basename(pathname),
+ folderRoot: true
+ }
+ };
+
+ try {
+ let bruContent = fs.readFileSync(pathname, 'utf8');
+
+ file.data = await parseCollection(bruContent);
+
hydrateBruCollectionFileWithUuid(file.data);
win.webContents.send('main:collection-tree-updated', 'change', file);
return;
@@ -378,10 +469,20 @@ const change = async (win, pathname, collectionUid, collectionPath) => {
};
const bru = fs.readFileSync(pathname, 'utf8');
- file.data = bruToJson(bru);
+ const fileStats = fs.statSync(pathname);
- hydrateRequestWithUuid(file.data, pathname);
- win.webContents.send('main:collection-tree-updated', 'change', file);
+ if (fileStats.size >= MAX_FILE_SIZE) {
+ const parsedData = await parseLargeRequestWithRedaction(bru);
+ file.data = parsedData;
+ file.size = sizeInMB(fileStats?.size);
+ hydrateRequestWithUuid(file.data, pathname);
+ win.webContents.send('main:collection-tree-updated', 'change', file);
+ } else {
+ file.data = await parseRequest(bru);
+ file.size = sizeInMB(fileStats?.size);
+ hydrateRequestWithUuid(file.data, pathname);
+ win.webContents.send('main:collection-tree-updated', 'change', file);
+ }
} catch (err) {
console.error(err);
}
@@ -407,52 +508,138 @@ const unlink = (win, pathname, collectionUid, collectionPath) => {
}
};
-const unlinkDir = (win, pathname, collectionUid, collectionPath) => {
+const unlinkDir = async (win, pathname, collectionUid, collectionPath) => {
const envDirectory = path.join(collectionPath, 'environments');
if (pathname === envDirectory) {
return;
}
+
+ const folderBruFilePath = path.join(pathname, `folder.bru`);
+
+ let name = path.basename(pathname);
+
+ if (fs.existsSync(folderBruFilePath)) {
+ let folderBruFileContent = fs.readFileSync(folderBruFilePath, 'utf8');
+ let folderBruData = await parseFolder(folderBruFileContent);
+ name = folderBruData?.meta?.name || name;
+ }
+
const directory = {
meta: {
collectionUid,
pathname,
- name: path.basename(pathname)
+ name
}
};
win.webContents.send('main:collection-tree-updated', 'unlinkDir', directory);
};
-const onWatcherSetupComplete = (win, collectionPath) => {
+const onWatcherSetupComplete = (win, watchPath, collectionUid, watcher) => {
+ // Mark discovery as complete
+ watcher.completeCollectionDiscovery(win, collectionUid);
+
const UiStateSnapshotStore = new UiStateSnapshot();
const collectionsSnapshotState = UiStateSnapshotStore.getCollections();
- const collectionSnapshotState = collectionsSnapshotState?.find(c => c?.pathname == collectionPath);
+ const collectionSnapshotState = collectionsSnapshotState?.find(c => c?.pathname == watchPath);
win.webContents.send('main:hydrate-app-with-ui-state-snapshot', collectionSnapshotState);
};
-class Watcher {
+class CollectionWatcher {
constructor() {
this.watchers = {};
+ this.loadingStates = {};
}
- addWatcher(win, watchPath, collectionUid, brunoConfig, forcePolling = false) {
+ // Initialize loading state tracking for a collection
+ initializeLoadingState(collectionUid) {
+ if (!this.loadingStates[collectionUid]) {
+ this.loadingStates[collectionUid] = {
+ isDiscovering: false, // Initial discovery phase
+ isProcessing: false, // Processing discovered files
+ pendingFiles: new Set(), // Files that need processing
+ };
+ }
+ }
+
+ startCollectionDiscovery(win, collectionUid) {
+ this.initializeLoadingState(collectionUid);
+ const state = this.loadingStates[collectionUid];
+
+ state.isDiscovering = true;
+ state.pendingFiles.clear();
+
+ win.webContents.send('main:collection-loading-state-updated', {
+ collectionUid,
+ isLoading: true
+ });
+ }
+
+ addFileToProcessing(collectionUid, filepath) {
+ this.initializeLoadingState(collectionUid);
+ const state = this.loadingStates[collectionUid];
+ state.pendingFiles.add(filepath);
+ }
+
+ markFileAsProcessed(win, collectionUid, filepath) {
+ if (!this.loadingStates[collectionUid]) return;
+
+ const state = this.loadingStates[collectionUid];
+ state.pendingFiles.delete(filepath);
+
+ // If discovery is complete and no pending files, mark as not loading
+ if (!state.isDiscovering && state.pendingFiles.size === 0 && state.isProcessing) {
+ state.isProcessing = false;
+ win.webContents.send('main:collection-loading-state-updated', {
+ collectionUid,
+ isLoading: false
+ });
+ }
+ }
+
+ completeCollectionDiscovery(win, collectionUid) {
+ if (!this.loadingStates[collectionUid]) return;
+
+ const state = this.loadingStates[collectionUid];
+ state.isDiscovering = false;
+
+ // If there are pending files, start processing phase
+ if (state.pendingFiles.size > 0) {
+ state.isProcessing = true;
+ } else {
+ // No pending files, collection is fully loaded
+ win.webContents.send('main:collection-loading-state-updated', {
+ collectionUid,
+ isLoading: false
+ });
+ }
+ }
+
+ cleanupLoadingState(collectionUid) {
+ delete this.loadingStates[collectionUid];
+ }
+
+ addWatcher(win, watchPath, collectionUid, brunoConfig, forcePolling = false, useWorkerThread) {
if (this.watchers[watchPath]) {
this.watchers[watchPath].close();
}
+ this.initializeLoadingState(collectionUid);
+
+ this.startCollectionDiscovery(win, collectionUid);
+
const ignores = brunoConfig?.ignore || [];
setTimeout(() => {
const watcher = chokidar.watch(watchPath, {
ignoreInitial: false,
- usePolling: watchPath.startsWith('\\\\') || forcePolling ? true : false,
+ usePolling: isWSLPath(watchPath) || forcePolling ? true : false,
ignored: (filepath) => {
- const normalizedPath = isWSLPath(filepath) ? normalizeWslPath(filepath) : normalizeAndResolvePath(filepath);
+ const normalizedPath = normalizeAndResolvePath(filepath);
const relativePath = path.relative(watchPath, normalizedPath);
return ignores.some((ignorePattern) => {
- const normalizedIgnorePattern = isWSLPath(ignorePattern) ? normalizeWslPath(ignorePattern) : ignorePattern.replace(/\\/g, '/');
- return relativePath === normalizedIgnorePattern || relativePath.startsWith(normalizedIgnorePattern);
+ return relativePath === ignorePattern || relativePath.startsWith(ignorePattern);
});
},
persistent: true,
@@ -461,13 +648,14 @@ class Watcher {
stabilityThreshold: 80,
pollInterval: 10
},
- depth: 20
+ depth: 20,
+ disableGlobbing: true
});
let startedNewWatcher = false;
watcher
- .on('ready', () => onWatcherSetupComplete(win, watchPath))
- .on('add', (pathname) => add(win, pathname, collectionUid, watchPath))
+ .on('ready', () => onWatcherSetupComplete(win, watchPath, collectionUid, this))
+ .on('add', (pathname) => add(win, pathname, collectionUid, watchPath, useWorkerThread, this))
.on('addDir', (pathname) => addDirectory(win, pathname, collectionUid, watchPath))
.on('change', (pathname) => change(win, pathname, collectionUid, watchPath))
.on('unlink', (pathname) => unlink(win, pathname, collectionUid, watchPath))
@@ -485,10 +673,10 @@ class Watcher {
`\nCould not start watcher for ${watchPath}:`,
'ENOSPC: System limit for number of file watchers reached!',
'Trying again with polling, this will be slower!\n',
- 'Update you system config to allow more concurrently watched files with:',
+ 'Update your system config to allow more concurrently watched files with:',
'"echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p"'
);
- this.addWatcher(win, watchPath, collectionUid, brunoConfig, true);
+ this.addWatcher(win, watchPath, collectionUid, brunoConfig, true, useWorkerThread);
} else {
console.error(`An error occurred in the watcher for: ${watchPath}`, error);
}
@@ -502,11 +690,15 @@ class Watcher {
return this.watchers[watchPath];
}
- removeWatcher(watchPath, win) {
+ removeWatcher(watchPath, win, collectionUid) {
if (this.watchers[watchPath]) {
this.watchers[watchPath].close();
this.watchers[watchPath] = null;
}
+
+ if (collectionUid) {
+ this.cleanupLoadingState(collectionUid);
+ }
}
getWatcherByItemPath(itemPath) {
@@ -535,6 +727,14 @@ class Watcher {
watcher?.add?.(itemPath);
}
}
+
+ getAllWatcherPaths() {
+ return Object.entries(this.watchers)
+ .filter(([path, watcher]) => !!watcher)
+ .map(([path, _watcher]) => path);
+ }
}
-module.exports = Watcher;
+const collectionWatcher = new CollectionWatcher();
+
+module.exports = collectionWatcher;
diff --git a/packages/bruno-electron/src/app/collections.js b/packages/bruno-electron/src/app/collections.js
index 5c9889e13..a6b7a178c 100644
--- a/packages/bruno-electron/src/app/collections.js
+++ b/packages/bruno-electron/src/app/collections.js
@@ -2,7 +2,7 @@ const fs = require('fs');
const path = require('path');
const { dialog, ipcMain } = require('electron');
const Yup = require('yup');
-const { isDirectory, normalizeAndResolvePath } = require('../utils/filesystem');
+const { isDirectory, normalizeAndResolvePath, getCollectionStats } = require('../utils/filesystem');
const { generateUidBasedOnHash } = require('../utils/common');
// todo: bruno.json config schema validation errors must be propagated to the UI
@@ -45,9 +45,8 @@ const openCollectionDialog = async (win, watcher) => {
const { filePaths } = await dialog.showOpenDialog(win, {
properties: ['openDirectory', 'createDirectory']
});
-
if (filePaths && filePaths[0]) {
- const resolvedPath = normalizeAndResolvePath(filePaths[0]);
+ const resolvedPath = path.resolve(filePaths[0]);
if (isDirectory(resolvedPath)) {
openCollection(win, watcher, resolvedPath);
} else {
@@ -59,7 +58,7 @@ const openCollectionDialog = async (win, watcher) => {
const openCollection = async (win, watcher, collectionPath, options = {}) => {
if (!watcher.hasWatcher(collectionPath)) {
try {
- const brunoConfig = await getCollectionConfigFile(collectionPath);
+ let brunoConfig = await getCollectionConfigFile(collectionPath);
const uid = generateUidBasedOnHash(collectionPath);
if (!brunoConfig.ignore || brunoConfig.ignore.length === 0) {
@@ -70,6 +69,10 @@ const openCollection = async (win, watcher, collectionPath, options = {}) => {
brunoConfig.ignore = ['node_modules', '.git'];
}
+ const { size, filesCount } = await getCollectionStats(collectionPath);
+ brunoConfig.size = size;
+ brunoConfig.filesCount = filesCount;
+
win.webContents.send('main:collection-opened', collectionPath, uid, brunoConfig);
ipcMain.emit('main:collection-opened', win, collectionPath, uid, brunoConfig);
} catch (err) {
diff --git a/packages/bruno-electron/src/app/menu-template.js b/packages/bruno-electron/src/app/menu-template.js
index e662336ae..f2b4c82aa 100644
--- a/packages/bruno-electron/src/app/menu-template.js
+++ b/packages/bruno-electron/src/app/menu-template.js
@@ -1,7 +1,8 @@
const { ipcMain } = require('electron');
const os = require('os');
-const openAboutWindow = require('about-window').default;
-const { join } = require('path');
+const { BrowserWindow } = require('electron');
+const { version } = require('../../package.json');
+const aboutBruno = require('./about-bruno');
const template = [
{
@@ -77,14 +78,16 @@ const template = [
submenu: [
{
label: 'About Bruno',
- click: () =>
- openAboutWindow({
- product_name: 'Bruno',
- icon_path: join(__dirname, '../about/256x256.png'),
- css_path: join(__dirname, '../about/about.css'),
- homepage: 'https://www.usebruno.com/',
- package_json_dir: join(__dirname, '../..')
- })
+ click: () => {
+ const aboutWindow = new BrowserWindow({
+ width: 350,
+ height: 250,
+ webPreferences: {
+ nodeIntegration: true,
+ },
+ });
+ aboutWindow.loadURL(`data:text/html;charset=utf-8,${encodeURIComponent(aboutBruno({version}))}`);
+ }
},
{ label: 'Documentation', click: () => ipcMain.emit('main:open-docs') }
]
diff --git a/packages/bruno-electron/src/bru/index.js b/packages/bruno-electron/src/bru/index.js
deleted file mode 100644
index 7fe43218a..000000000
--- a/packages/bruno-electron/src/bru/index.js
+++ /dev/null
@@ -1,208 +0,0 @@
-const _ = require('lodash');
-const {
- bruToJsonV2,
- jsonToBruV2,
- bruToEnvJsonV2,
- envJsonToBruV2,
- collectionBruToJson: _collectionBruToJson,
- jsonToCollectionBru: _jsonToCollectionBru
-} = require('@usebruno/lang');
-
-const collectionBruToJson = (bru) => {
- try {
- const json = _collectionBruToJson(bru);
-
- const transformedJson = {
- request: {
- headers: _.get(json, 'headers', []),
- auth: _.get(json, 'auth', {}),
- script: _.get(json, 'script', {}),
- vars: _.get(json, 'vars', {}),
- tests: _.get(json, 'tests', '')
- },
- docs: _.get(json, 'docs', '')
- };
-
- // add meta if it exists
- // this is only for folder bru file
- // in the future, all of this will be replaced by standard bru lang
- if (json.meta) {
- transformedJson.meta = {
- name: json.meta.name
- };
- }
-
- return transformedJson;
- } catch (error) {
- return Promise.reject(error);
- }
-};
-
-const jsonToCollectionBru = (json, isFolder) => {
- try {
- const collectionBruJson = {
- headers: _.get(json, 'request.headers', []),
- script: {
- req: _.get(json, 'request.script.req', ''),
- res: _.get(json, 'request.script.res', '')
- },
- vars: {
- req: _.get(json, 'request.vars.req', []),
- res: _.get(json, 'request.vars.res', [])
- },
- tests: _.get(json, 'request.tests', ''),
- docs: _.get(json, 'docs', '')
- };
-
- // add meta if it exists
- // this is only for folder bru file
- // in the future, all of this will be replaced by standard bru lang
- if (json?.meta) {
- collectionBruJson.meta = {
- name: json.meta.name
- };
- }
-
- if (!isFolder) {
- collectionBruJson.auth = _.get(json, 'request.auth', {});
- }
-
- return _jsonToCollectionBru(collectionBruJson);
- } catch (error) {
- return Promise.reject(error);
- }
-};
-
-const bruToEnvJson = (bru) => {
- try {
- const json = bruToEnvJsonV2(bru);
-
- // the app env format requires each variable to have a type
- // this need to be evaluated and safely removed
- // i don't see it being used in schema validation
- if (json && json.variables && json.variables.length) {
- _.each(json.variables, (v) => (v.type = 'text'));
- }
-
- return json;
- } catch (error) {
- return Promise.reject(error);
- }
-};
-
-const envJsonToBru = (json) => {
- try {
- const bru = envJsonToBruV2(json);
- return bru;
- } catch (error) {
- return Promise.reject(error);
- }
-};
-
-/**
- * The transformer function for converting a BRU file to JSON.
- *
- * We map the json response from the bru lang and transform it into the DSL
- * format that the app uses
- *
- * @param {string} bru The BRU file content.
- * @returns {object} The JSON representation of the BRU file.
- */
-const bruToJson = (bru) => {
- try {
- const json = bruToJsonV2(bru);
-
- let requestType = _.get(json, 'meta.type');
- if (requestType === 'http') {
- requestType = 'http-request';
- } else if (requestType === 'graphql') {
- requestType = 'graphql-request';
- } else {
- requestType = 'http-request';
- }
-
- const sequence = _.get(json, 'meta.seq');
- const transformedJson = {
- type: requestType,
- name: _.get(json, 'meta.name'),
- seq: !isNaN(sequence) ? Number(sequence) : 1,
- request: {
- method: _.upperCase(_.get(json, 'http.method')),
- url: _.get(json, 'http.url'),
- params: _.get(json, 'params', []),
- headers: _.get(json, 'headers', []),
- auth: _.get(json, 'auth', {}),
- body: _.get(json, 'body', {}),
- script: _.get(json, 'script', {}),
- vars: _.get(json, 'vars', {}),
- assertions: _.get(json, 'assertions', []),
- tests: _.get(json, 'tests', ''),
- docs: _.get(json, 'docs', '')
- }
- };
-
- transformedJson.request.auth.mode = _.get(json, 'http.auth', 'none');
- transformedJson.request.body.mode = _.get(json, 'http.body', 'none');
-
- return transformedJson;
- } catch (e) {
- return Promise.reject(e);
- }
-};
-/**
- * The transformer function for converting a JSON to BRU file.
- *
- * We map the json response from the app and transform it into the DSL
- * format that the bru lang understands
- *
- * @param {object} json The JSON representation of the BRU file.
- * @returns {string} The BRU file content.
- */
-const jsonToBru = (json) => {
- let type = _.get(json, 'type');
- if (type === 'http-request') {
- type = 'http';
- } else if (type === 'graphql-request') {
- type = 'graphql';
- } else {
- type = 'http';
- }
-
- const sequence = _.get(json, 'seq');
- const bruJson = {
- meta: {
- name: _.get(json, 'name'),
- type: type,
- seq: !isNaN(sequence) ? Number(sequence) : 1
- },
- http: {
- method: _.lowerCase(_.get(json, 'request.method')),
- url: _.get(json, 'request.url'),
- auth: _.get(json, 'request.auth.mode', 'none'),
- body: _.get(json, 'request.body.mode', 'none')
- },
- params: _.get(json, 'request.params', []),
- headers: _.get(json, 'request.headers', []),
- auth: _.get(json, 'request.auth', {}),
- body: _.get(json, 'request.body', {}),
- script: _.get(json, 'request.script', {}),
- vars: {
- req: _.get(json, 'request.vars.req', []),
- res: _.get(json, 'request.vars.res', [])
- },
- assertions: _.get(json, 'request.assertions', []),
- tests: _.get(json, 'request.tests', ''),
- docs: _.get(json, 'request.docs', '')
- };
-
- return jsonToBruV2(bruJson);
-};
-
-module.exports = {
- bruToJson,
- jsonToBru,
- bruToEnvJson,
- envJsonToBru,
- collectionBruToJson,
- jsonToCollectionBru
-};
diff --git a/packages/bruno-electron/src/cache/requestUids.js b/packages/bruno-electron/src/cache/requestUids.js
index 55f7fc291..c6c3bfe7c 100644
--- a/packages/bruno-electron/src/cache/requestUids.js
+++ b/packages/bruno-electron/src/cache/requestUids.js
@@ -6,7 +6,7 @@
* In the past, we used to generate unique ids based on the
* pathname of the request, but we faced problems when implementing
* functionality where the user can move the request to a different
- * location. In that case, the uid would change, and the we would
+ * location. In that case, the uid would change, and we would
* lose the request's draft state if the user has made some changes
*/
diff --git a/packages/bruno-electron/src/index.js b/packages/bruno-electron/src/index.js
index 4b6494b2f..0d2e92cbd 100644
--- a/packages/bruno-electron/src/index.js
+++ b/packages/bruno-electron/src/index.js
@@ -11,28 +11,39 @@ if (isDev) {
}
const { format } = require('url');
-const { BrowserWindow, app, session, Menu, ipcMain } = require('electron');
+const { BrowserWindow, app, session, Menu, globalShortcut, ipcMain } = require('electron');
const { setContentSecurityPolicy } = require('electron-util');
+if (isDev && process.env.ELECTRON_USER_DATA_PATH) {
+ console.debug("`ELECTRON_USER_DATA_PATH` found, modifying `userData` path: \n"
+ + `\t${app.getPath("userData")} -> ${process.env.ELECTRON_USER_DATA_PATH}`);
+
+ app.setPath('userData', process.env.ELECTRON_USER_DATA_PATH);
+}
+
const menuTemplate = require('./app/menu-template');
const { openCollection } = require('./app/collections');
const LastOpenedCollections = require('./store/last-opened-collections');
const registerNetworkIpc = require('./ipc/network');
const registerCollectionsIpc = require('./ipc/collection');
+const registerFilesystemIpc = require('./ipc/filesystem');
const registerPreferencesIpc = require('./ipc/preferences');
-const Watcher = require('./app/watcher');
+const collectionWatcher = require('./app/collection-watcher');
const { loadWindowState, saveBounds, saveMaximized } = require('./utils/window');
const registerNotificationsIpc = require('./ipc/notifications');
const registerGlobalEnvironmentsIpc = require('./ipc/global-environments');
+const { safeParseJSON, safeStringifyJSON } = require('./utils/common');
+const { getDomainsWithCookies } = require('./utils/cookies');
+const { cookiesStore } = require('./store/cookies');
const lastOpenedCollections = new LastOpenedCollections();
// Reference: https://content-security-policy.com/
const contentSecurityPolicy = [
"default-src 'self'",
- "script-src * 'unsafe-inline' 'unsafe-eval'",
- "connect-src * 'unsafe-inline'",
- "font-src 'self' https:",
+ "connect-src 'self' https://*.posthog.com",
+ "font-src 'self' https: data:;",
+ "frame-src data:",
// this has been commented out to make oauth2 work
// "form-action 'none'",
// we make an exception and allow http for images so that
@@ -47,7 +58,6 @@ setContentSecurityPolicy(contentSecurityPolicy.join(';') + ';');
const menu = Menu.buildFromTemplate(menuTemplate);
let mainWindow;
-let watcher;
// Prepare the renderer once the app is ready
app.on('ready', async () => {
@@ -123,7 +133,6 @@ app.on('ready', async () => {
);
}
});
- watcher = new Watcher();
const handleBoundsChange = () => {
if (!mainWindow.isMaximized()) {
@@ -159,19 +168,59 @@ app.on('ready', async () => {
}
return { action: 'deny' };
});
+
+ // Quick fix for Electron issue #29996: https://github.com/electron/electron/issues/29996
+ globalShortcut.register('Ctrl+=', () => {
+ mainWindow.webContents.setZoomLevel(mainWindow.webContents.getZoomLevel() + 1);
+ });
+
+ globalShortcut.register('CommandOrControl+M', () => {
+ mainWindow.minimize();
+ });
+
+ globalShortcut.register('CommandOrControl+H', () => {
+ mainWindow.minimize();
+ });
+
+ mainWindow.webContents.on('did-finish-load', async () => {
+ let ogSend = mainWindow.webContents.send;
+ mainWindow.webContents.send = function(channel, ...args) {
+ return ogSend.apply(this, [channel, ...args?.map(_ => {
+ // todo: replace this with @msgpack/msgpack encode/decode
+ return safeParseJSON(safeStringifyJSON(_));
+ })]);
+ }
+ // Send cookies list after renderer is ready
+ try {
+ cookiesStore.initializeCookies();
+ const cookiesList = await getDomainsWithCookies();
+ mainWindow.webContents.send('main:cookies-update', cookiesList);
+ } catch (err) {
+ console.error('Failed to load cookies for renderer', err);
+ }
+ });
// register all ipc handlers
registerNetworkIpc(mainWindow);
registerGlobalEnvironmentsIpc(mainWindow);
- registerCollectionsIpc(mainWindow, watcher, lastOpenedCollections);
- registerPreferencesIpc(mainWindow, watcher, lastOpenedCollections);
- registerNotificationsIpc(mainWindow, watcher);
+ registerCollectionsIpc(mainWindow, collectionWatcher, lastOpenedCollections);
+ registerPreferencesIpc(mainWindow, collectionWatcher, lastOpenedCollections);
+ registerNotificationsIpc(mainWindow, collectionWatcher);
+ registerFilesystemIpc(mainWindow);
});
// Quit the app once all windows are closed
+app.on('before-quit', () => {
+ try {
+ cookiesStore.saveCookieJar(true);
+ } catch (err) {
+ console.warn('Failed to flush cookies on quit', err);
+ }
+});
+
app.on('window-all-closed', app.quit);
// Open collection from Recent menu (#1521)
app.on('open-file', (event, path) => {
- openCollection(mainWindow, watcher, path);
+ openCollection(mainWindow, collectionWatcher, path);
});
diff --git a/packages/bruno-electron/src/ipc/collection.js b/packages/bruno-electron/src/ipc/collection.js
index 898324892..30cf11111 100644
--- a/packages/bruno-electron/src/ipc/collection.js
+++ b/packages/bruno-electron/src/ipc/collection.js
@@ -1,13 +1,28 @@
const _ = require('lodash');
const fs = require('fs');
+const fsPromises = require('fs/promises');
const fsExtra = require('fs-extra');
const os = require('os');
const path = require('path');
const { ipcMain, shell, dialog, app } = require('electron');
-const { envJsonToBru, bruToJson, jsonToBru, jsonToCollectionBru } = require('../bru');
+const {
+ parseRequest,
+ stringifyRequest,
+ parseRequestViaWorker,
+ stringifyRequestViaWorker,
+ parseCollection,
+ stringifyCollection,
+ parseFolder,
+ stringifyFolder,
+ parseEnvironment,
+ stringifyEnvironment
+} = require('@usebruno/filestore');
+const brunoConverters = require('@usebruno/converters');
+const { postmanToBruno } = brunoConverters;
+const { cookiesStore } = require('../store/cookies');
+const { parseLargeRequestWithRedaction } = require('../utils/parse');
const {
- isValidPathname,
writeFile,
hasBruExtension,
isDirectory,
@@ -15,62 +30,73 @@ const {
browseFiles,
createDirectory,
searchForBruFiles,
- sanitizeDirectoryName,
+ sanitizeName,
isWSLPath,
- normalizeWslPath,
- normalizeAndResolvePath,
safeToRename,
- sanitizeCollectionName,
isWindowsOS,
- isValidFilename,
+ validateName,
hasSubDirectories,
+ getCollectionStats,
+ sizeInMB,
+ safeWriteFileSync,
+ copyPath,
+ removePath,
+ getPaths
} = require('../utils/filesystem');
const { openCollectionDialog } = require('../app/collections');
const { generateUidBasedOnHash, stringifyJson, safeParseJSON, safeStringifyJSON } = require('../utils/common');
const { moveRequestUid, deleteRequestUid } = require('../cache/requestUids');
-const { deleteCookiesForDomain, getDomainsWithCookies } = require('../utils/cookies');
+const { deleteCookiesForDomain, getDomainsWithCookies, addCookieForDomain, modifyCookieForDomain, parseCookieString, createCookieString, deleteCookie } = require('../utils/cookies');
const EnvironmentSecretsStore = require('../store/env-secrets');
const CollectionSecurityStore = require('../store/collection-security');
const UiStateSnapshotStore = require('../store/ui-state-snapshot');
+const interpolateVars = require('./network/interpolate-vars');
+const { getEnvVars, getTreePathFromCollectionToItem, mergeVars, parseBruFileMeta, hydrateRequestWithUuid, transformRequestToSaveToFilesystem } = require('../utils/collection');
+const { getProcessEnvVars } = require('../store/process-env');
+const { getOAuth2TokenUsingAuthorizationCode, getOAuth2TokenUsingClientCredentials, getOAuth2TokenUsingPasswordCredentials, getOAuth2TokenUsingImplicitGrant, refreshOauth2Token } = require('../utils/oauth2');
+const { getCertsAndProxyConfig } = require('./network/cert-utils');
+const collectionWatcher = require('../app/collection-watcher');
const environmentSecretsStore = new EnvironmentSecretsStore();
const collectionSecurityStore = new CollectionSecurityStore();
const uiStateSnapshotStore = new UiStateSnapshotStore();
+// size and file count limits to determine whether the bru files in the collection should be loaded asynchronously or not.
+const MAX_COLLECTION_SIZE_IN_MB = 20;
+const MAX_SINGLE_FILE_SIZE_IN_COLLECTION_IN_MB = 5;
+const MAX_COLLECTION_FILES_COUNT = 2000;
+
const envHasSecrets = (environment = {}) => {
const secrets = _.filter(environment.variables, (v) => v.secret);
return secrets && secrets.length > 0;
};
+const validatePathIsInsideCollection = (filePath, lastOpenedCollections) => {
+ const openCollectionPaths = collectionWatcher.getAllWatcherPaths();
+ const lastOpenedPaths = lastOpenedCollections ? lastOpenedCollections.getAll() : [];
+
+ // Combine both currently watched collections and last opened collections
+ // todo: remove the lastOpenedPaths from the list
+ // todo: have a proper way to validate the path without the active watcher logic
+ const allCollectionPaths = [...new Set([...openCollectionPaths, ...lastOpenedPaths])];
+
+ const isValid = allCollectionPaths.some((collectionPath) => {
+ return filePath.startsWith(collectionPath + path.sep) || filePath === collectionPath;
+ });
+
+ if (!isValid) {
+ throw new Error(`Path: ${filePath} should be inside a collection`);
+ }
+}
+
const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollections) => {
- // browse directory
- ipcMain.handle('renderer:browse-directory', async (event, pathname, request) => {
- try {
- return await browseDirectory(mainWindow);
- } catch (error) {
- return Promise.reject(error);
- }
- });
-
- // browse directory for file
- ipcMain.handle('renderer:browse-files', async (event, pathname, request, filters) => {
- try {
- const filePaths = await browseFiles(mainWindow, filters);
-
- return filePaths;
- } catch (error) {
- return Promise.reject(error);
- }
- });
-
// create collection
ipcMain.handle(
'renderer:create-collection',
async (event, collectionName, collectionFolderName, collectionLocation) => {
try {
- collectionFolderName = sanitizeDirectoryName(collectionFolderName);
- collectionName = sanitizeCollectionName(collectionName);
+ collectionFolderName = sanitizeName(collectionFolderName);
const dirPath = path.join(collectionLocation, collectionFolderName);
if (fs.existsSync(dirPath)) {
const files = fs.readdirSync(dirPath);
@@ -79,7 +105,8 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
throw new Error(`collection: ${dirPath} already exists and is not empty`);
}
}
- if (!isValidPathname(path.basename(dirPath))) {
+
+ if (!validateName(path.basename(dirPath))) {
throw new Error(`collection: invalid pathname - ${dirPath}`);
}
@@ -97,6 +124,10 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
const content = await stringifyJson(brunoConfig);
await writeFile(path.join(dirPath, 'bruno.json'), content);
+ const { size, filesCount } = await getCollectionStats(dirPath);
+ brunoConfig.size = size;
+ brunoConfig.filesCount = filesCount;
+
mainWindow.webContents.send('main:collection-opened', dirPath, uid, brunoConfig);
ipcMain.emit('main:collection-opened', mainWindow, dirPath, uid, brunoConfig);
} catch (error) {
@@ -108,13 +139,13 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
ipcMain.handle(
'renderer:clone-collection',
async (event, collectionName, collectionFolderName, collectionLocation, previousPath) => {
- collectionFolderName = sanitizeCollectionName(collectionFolderName);
+ collectionFolderName = sanitizeName(collectionFolderName);
const dirPath = path.join(collectionLocation, collectionFolderName);
if (fs.existsSync(dirPath)) {
throw new Error(`collection: ${dirPath} already exists`);
}
- if (!isValidPathname(path.basename(dirPath))) {
+ if (!validateName(path.basename(dirPath))) {
throw new Error(`collection: invalid pathname - ${dirPath}`);
}
@@ -126,15 +157,15 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
const brunoJsonFilePath = path.join(previousPath, 'bruno.json');
const content = fs.readFileSync(brunoJsonFilePath, 'utf8');
- //Change new name of collection
- let json = JSON.parse(content);
- json.name = collectionName;
- const cont = await stringifyJson(json);
+ // Change new name of collection
+ let brunoConfig = JSON.parse(content);
+ brunoConfig.name = collectionName;
+ const cont = await stringifyJson(brunoConfig);
// write the bruno.json to new dir
await writeFile(path.join(dirPath, 'bruno.json'), cont);
- // Now copy all the files with extension name .bru along with there dir
+ // Now copy all the files with extension name .bru along with the dir
const files = searchForBruFiles(previousPath);
for (const sourceFilePath of files) {
@@ -147,14 +178,17 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
fs.copyFileSync(sourceFilePath, newFilePath);
}
- mainWindow.webContents.send('main:collection-opened', dirPath, uid, json);
+ const { size, filesCount } = await getCollectionStats(dirPath);
+ brunoConfig.size = size;
+ brunoConfig.filesCount = filesCount;
+
+ mainWindow.webContents.send('main:collection-opened', dirPath, uid, brunoConfig);
ipcMain.emit('main:collection-opened', mainWindow, dirPath, uid);
}
);
// rename collection
ipcMain.handle('renderer:rename-collection', async (event, newName, collectionPathname) => {
try {
- newName = sanitizeCollectionName(newName);
const brunoJsonFilePath = path.join(collectionPathname, 'bruno.json');
const content = fs.readFileSync(brunoJsonFilePath, 'utf8');
const json = JSON.parse(content);
@@ -177,17 +211,16 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
ipcMain.handle('renderer:save-folder-root', async (event, folder) => {
try {
- const { name: folderName, root: folderRoot, pathname: folderPathname } = folder;
+ const { name: folderName, root: folderRoot = {}, pathname: folderPathname } = folder;
const folderBruFilePath = path.join(folderPathname, 'folder.bru');
- folderRoot.meta = {
- name: folderName
- };
+ if (!folderRoot.meta) {
+ folderRoot.meta = {
+ name: folderName
+ };
+ }
- const content = jsonToCollectionBru(
- folderRoot,
- true // isFolder
- );
+ const content = await stringifyFolder(folderRoot);
await writeFile(folderBruFilePath, content);
} catch (error) {
return Promise.reject(error);
@@ -197,7 +230,7 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
try {
const collectionBruFilePath = path.join(collectionPathname, 'collection.bru');
- const content = jsonToCollectionBru(collectionRoot);
+ const content = await stringifyCollection(collectionRoot);
await writeFile(collectionBruFilePath, content);
} catch (error) {
return Promise.reject(error);
@@ -210,10 +243,12 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
if (fs.existsSync(pathname)) {
throw new Error(`path: ${pathname} already exists`);
}
- if (!isValidFilename(request.name)) {
- throw new Error(`path: ${request.name}.bru is not a valid filename`);
+ // For the actual filename part, we want to be strict
+ if (!validateName(request?.filename)) {
+ throw new Error(`${request.filename}.bru is not a valid filename`);
}
- const content = jsonToBru(request);
+ validatePathIsInsideCollection(pathname, lastOpenedCollections);
+ const content = await stringifyRequestViaWorker(request);
await writeFile(pathname, content);
} catch (error) {
return Promise.reject(error);
@@ -227,7 +262,7 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
throw new Error(`path: ${pathname} does not exist`);
}
- const content = jsonToBru(request);
+ const content = await stringifyRequestViaWorker(request);
await writeFile(pathname, content);
} catch (error) {
return Promise.reject(error);
@@ -245,7 +280,7 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
throw new Error(`path: ${pathname} does not exist`);
}
- const content = jsonToBru(request);
+ const content = await stringifyRequestViaWorker(request);
await writeFile(pathname, content);
}
} catch (error) {
@@ -275,7 +310,7 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
environmentSecretsStore.storeEnvSecrets(collectionPathname, environment);
}
- const content = envJsonToBru(environment);
+ const content = await stringifyEnvironment(environment);
await writeFile(envFilePath, content);
} catch (error) {
@@ -300,7 +335,7 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
environmentSecretsStore.storeEnvSecrets(collectionPathname, environment);
}
- const content = envJsonToBru(environment);
+ const content = await stringifyEnvironment(environment);
await writeFile(envFilePath, content);
} catch (error) {
return Promise.reject(error);
@@ -347,18 +382,54 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
});
// rename item
- ipcMain.handle('renderer:rename-item', async (event, oldPath, newPath, newName) => {
- const tempDir = path.join(os.tmpdir(), `temp-folder-${Date.now()}`);
- // const parentDir = path.dirname(oldPath);
- const isWindowsOSAndNotWSLAndItemHasSubDirectories = isDirectory(oldPath) && isWindowsOS() && !isWSLPath(oldPath) && hasSubDirectories(oldPath);
- // let parentDirUnwatched = false;
- // let parentDirRewatched = false;
-
+ ipcMain.handle('renderer:rename-item-name', async (event, { itemPath, newName }) => {
try {
- // Normalize paths if they are WSL paths
- oldPath = isWSLPath(oldPath) ? normalizeWslPath(oldPath) : normalizeAndResolvePath(oldPath);
- newPath = isWSLPath(newPath) ? normalizeWslPath(newPath) : normalizeAndResolvePath(newPath);
+ if (!fs.existsSync(itemPath)) {
+ throw new Error(`path: ${itemPath} does not exist`);
+ }
+
+ if (isDirectory(itemPath)) {
+ const folderBruFilePath = path.join(itemPath, 'folder.bru');
+ let folderBruFileJsonContent;
+ if (fs.existsSync(folderBruFilePath)) {
+ const oldFolderBruFileContent = await fs.promises.readFile(folderBruFilePath, 'utf8');
+ folderBruFileJsonContent = await parseFolder(oldFolderBruFileContent);
+ folderBruFileJsonContent.meta.name = newName;
+ } else {
+ folderBruFileJsonContent = {
+ meta: {
+ name: newName
+ }
+ };
+ }
+
+ const folderBruFileContent = await stringifyFolder(folderBruFileJsonContent);
+ await writeFile(folderBruFilePath, folderBruFileContent);
+
+ return;
+ }
+
+ const isBru = hasBruExtension(itemPath);
+ if (!isBru) {
+ throw new Error(`path: ${itemPath} is not a bru file`);
+ }
+
+ const data = fs.readFileSync(itemPath, 'utf8');
+ const jsonData = parseRequest(data);
+ jsonData.name = newName;
+ const content = stringifyRequest(jsonData);
+ await writeFile(itemPath, content);
+ } catch (error) {
+ return Promise.reject(error);
+ }
+ });
+
+ // rename item
+ ipcMain.handle('renderer:rename-item-filename', async (event, { oldPath, newPath, newName, newFilename }) => {
+ const tempDir = path.join(os.tmpdir(), `temp-folder-${Date.now()}`);
+ const isWindowsOSAndNotWSLPathAndItemHasSubDirectories = isDirectory(oldPath) && isWindowsOS() && !isWSLPath(oldPath) && hasSubDirectories(oldPath);
+ try {
// Check if the old path exists
if (!fs.existsSync(oldPath)) {
throw new Error(`path: ${oldPath} does not exist`);
@@ -369,6 +440,23 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
}
if (isDirectory(oldPath)) {
+ const folderBruFilePath = path.join(oldPath, 'folder.bru');
+ let folderBruFileJsonContent;
+ if (fs.existsSync(folderBruFilePath)) {
+ const oldFolderBruFileContent = await fs.promises.readFile(folderBruFilePath, 'utf8');
+ folderBruFileJsonContent = await parseFolder(oldFolderBruFileContent);
+ folderBruFileJsonContent.meta.name = newName;
+ } else {
+ folderBruFileJsonContent = {
+ meta: {
+ name: newName
+ }
+ };
+ }
+
+ const folderBruFileContent = await stringifyFolder(folderBruFileJsonContent);
+ await writeFile(folderBruFilePath, folderBruFileContent);
+
const bruFilesAtSource = await searchForBruFiles(oldPath);
for (let bruFile of bruFilesAtSource) {
@@ -376,19 +464,16 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
moveRequestUid(bruFile, newBruFilePath);
}
- // watcher.unlinkItemPathInWatcher(parentDir);
- // parentDirUnwatched = true;
-
/**
* If it is windows OS
- * And it is not WSL path (meaning its not linux running on windows using WSL)
+ * And it is not a WSL path (meaning it is not running in WSL (linux pathtype))
* And it has sub directories
* Only then we need to use the temp dir approach to rename the folder
- *
+ *
* Windows OS would sometimes throw error when renaming a folder with sub directories
- * This is a alternative approach to avoid that error
+ * This is an alternative approach to avoid that error
*/
- if (isWindowsOSAndNotWSLAndItemHasSubDirectories) {
+ if (isWindowsOSAndNotWSLPathAndItemHasSubDirectories) {
await fsExtra.copy(oldPath, tempDir);
await fsExtra.remove(oldPath);
await fsExtra.move(tempDir, newPath, { overwrite: true });
@@ -396,8 +481,6 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
} else {
await fs.renameSync(oldPath, newPath);
}
- // watcher.addItemPathInWatcher(parentDir);
- // parentDirRewatched = true;
return newPath;
}
@@ -406,31 +489,25 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
throw new Error(`path: ${oldPath} is not a bru file`);
}
- if (!isValidFilename(newName)) {
- throw new Error(`path: ${newName} is not a valid filename`);
+ if (!validateName(newFilename)) {
+ throw new Error(`path: ${newFilename} is not a valid filename`);
}
// update name in file and save new copy, then delete old copy
const data = await fs.promises.readFile(oldPath, 'utf8'); // Use async read
- const jsonData = bruToJson(data);
+ const jsonData = parseRequest(data);
jsonData.name = newName;
moveRequestUid(oldPath, newPath);
- const content = jsonToBru(jsonData);
+ const content = stringifyRequest(jsonData);
await fs.promises.unlink(oldPath);
await writeFile(newPath, content);
return newPath;
} catch (error) {
- // in case an error occurs during the rename file operations after unlinking the parent dir
- // and the rewatch fails, we need to add it back to watcher
- // if (parentDirUnwatched && !parentDirRewatched) {
- // watcher.addItemPathInWatcher(parentDir);
- // }
-
// in case the rename file operations fails, and we see that the temp dir exists
// and the old path does not exist, we need to restore the data from the temp dir to the old path
- if (isWindowsOSAndNotWSLAndItemHasSubDirectories) {
+ if (isWindowsOSAndNotWSLPathAndItemHasSubDirectories) {
if (fsExtra.pathExistsSync(tempDir) && !fsExtra.pathExistsSync(oldPath)) {
try {
await fsExtra.copy(tempDir, oldPath);
@@ -446,12 +523,15 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
});
// new folder
- ipcMain.handle('renderer:new-folder', async (event, pathname) => {
- const resolvedFolderName = sanitizeDirectoryName(path.basename(pathname));
+ ipcMain.handle('renderer:new-folder', async (event, { pathname, folderBruJsonData }) => {
+ const resolvedFolderName = sanitizeName(path.basename(pathname));
pathname = path.join(path.dirname(pathname), resolvedFolderName);
try {
if (!fs.existsSync(pathname)) {
fs.mkdirSync(pathname);
+ const folderBruFilePath = path.join(pathname, 'folder.bru');
+ const content = await stringifyFolder(folderBruJsonData);
+ await writeFile(folderBruFilePath, content);
} else {
return Promise.reject(new Error('The directory already exists'));
}
@@ -475,7 +555,7 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
}
fs.rmSync(pathname, { recursive: true, force: true });
- } else if (['http-request', 'graphql-request'].includes(type)) {
+ } else if (['http-request', 'graphql-request', 'grpc-request'].includes(type)) {
if (!fs.existsSync(pathname)) {
return Promise.reject(new Error('The file does not exist'));
}
@@ -497,17 +577,21 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
}
});
- ipcMain.handle('renderer:remove-collection', async (event, collectionPath) => {
+ ipcMain.handle('renderer:remove-collection', async (event, collectionPath, collectionUid) => {
if (watcher && mainWindow) {
console.log(`watcher stopWatching: ${collectionPath}`);
- watcher.removeWatcher(collectionPath, mainWindow);
+ watcher.removeWatcher(collectionPath, mainWindow, collectionUid);
lastOpenedCollections.remove(collectionPath);
}
});
+ ipcMain.handle('renderer:update-collection-paths', async (_, collectionPaths) => {
+ lastOpenedCollections.update(collectionPaths);
+ })
+
ipcMain.handle('renderer:import-collection', async (event, collection, collectionLocation) => {
try {
- let collectionName = sanitizeCollectionName(collection.name);
+ let collectionName = sanitizeName(collection.name);
let collectionPath = path.join(collectionLocation, collectionName);
if (fs.existsSync(collectionPath)) {
@@ -516,24 +600,23 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
// Recursive function to parse the collection items and create files/folders
const parseCollectionItems = (items = [], currentPath) => {
- items.forEach((item) => {
- if (['http-request', 'graphql-request'].includes(item.type)) {
- const content = jsonToBru(item);
- const filePath = path.join(currentPath, `${item.name}.bru`);
- fs.writeFileSync(filePath, content);
+ items.forEach(async (item) => {
+ if (['http-request', 'graphql-request', 'grpc-request'].includes(item.type)) {
+ let sanitizedFilename = sanitizeName(item?.filename || `${item.name}.bru`);
+ const content = await stringifyRequestViaWorker(item);
+ const filePath = path.join(currentPath, sanitizedFilename);
+ safeWriteFileSync(filePath, content);
}
if (item.type === 'folder') {
- item.name = sanitizeDirectoryName(item.name);
- const folderPath = path.join(currentPath, item.name);
+ let sanitizedFolderName = sanitizeName(item?.filename || item?.name);
+ const folderPath = path.join(currentPath, sanitizedFolderName);
fs.mkdirSync(folderPath);
if (item?.root?.meta?.name) {
const folderBruFilePath = path.join(folderPath, 'folder.bru');
- const folderContent = jsonToCollectionBru(
- item.root,
- true // isFolder
- );
- fs.writeFileSync(folderBruFilePath, folderContent);
+ item.root.meta.seq = item.seq;
+ const folderContent = await stringifyFolder(item.root);
+ safeWriteFileSync(folderBruFilePath, folderContent);
}
if (item.items && item.items.length) {
@@ -542,8 +625,9 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
}
// Handle items of type 'js'
if (item.type === 'js') {
- const filePath = path.join(currentPath, `${item.name}.js`);
- fs.writeFileSync(filePath, item.fileContent);
+ let sanitizedFilename = sanitizeName(item?.filename || `${item.name}.js`);
+ const filePath = path.join(currentPath, sanitizedFilename);
+ safeWriteFileSync(filePath, item.fileContent);
}
});
};
@@ -554,10 +638,11 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
fs.mkdirSync(envDirPath);
}
- environments.forEach((env) => {
- const content = envJsonToBru(env);
- const filePath = path.join(envDirPath, `${env.name}.bru`);
- fs.writeFileSync(filePath, content);
+ environments.forEach(async (env) => {
+ const content = await stringifyEnvironment(env);
+ let sanitizedEnvFilename = sanitizeName(`${env.name}.bru`);
+ const filePath = path.join(envDirPath, sanitizedEnvFilename);
+ safeWriteFileSync(filePath, content);
});
};
@@ -579,15 +664,19 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
await createDirectory(collectionPath);
const uid = generateUidBasedOnHash(collectionPath);
- const brunoConfig = getBrunoJsonConfig(collection);
+ let brunoConfig = getBrunoJsonConfig(collection);
const stringifiedBrunoConfig = await stringifyJson(brunoConfig);
// Write the Bruno configuration to a file
await writeFile(path.join(collectionPath, 'bruno.json'), stringifiedBrunoConfig);
- const collectionContent = jsonToCollectionBru(collection.root);
+ const collectionContent = await stringifyCollection(collection.root);
await writeFile(path.join(collectionPath, 'collection.bru'), collectionContent);
+ const { size, filesCount } = await getCollectionStats(collectionPath);
+ brunoConfig.size = size;
+ brunoConfig.filesCount = filesCount;
+
mainWindow.webContents.send('main:collection-opened', collectionPath, uid, brunoConfig);
ipcMain.emit('main:collection-opened', mainWindow, collectionPath, uid, brunoConfig);
@@ -609,22 +698,23 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
// Recursive function to parse the folder and create files/folders
const parseCollectionItems = (items = [], currentPath) => {
- items.forEach((item) => {
+ items.forEach(async (item) => {
if (['http-request', 'graphql-request'].includes(item.type)) {
- const content = jsonToBru(item);
- const filePath = path.join(currentPath, `${item.name}.bru`);
- fs.writeFileSync(filePath, content);
+ const content = await stringifyRequestViaWorker(item);
+ const filePath = path.join(currentPath, item.filename);
+ safeWriteFileSync(filePath, content);
}
if (item.type === 'folder') {
- const folderPath = path.join(currentPath, item.name);
+ const folderPath = path.join(currentPath, item.filename);
fs.mkdirSync(folderPath);
// If folder has a root element, then I should write its folder.bru file
if (item.root) {
- const folderContent = jsonToCollectionBru(item.root, true);
+ const folderContent = await stringifyFolder(item.root);
+ folderContent.name = item.name;
if (folderContent) {
const bruFolderPath = path.join(folderPath, `folder.bru`);
- fs.writeFileSync(bruFolderPath, folderContent);
+ safeWriteFileSync(bruFolderPath, folderContent);
}
}
@@ -639,10 +729,10 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
// If initial folder has a root element, then I should write its folder.bru file
if (itemFolder.root) {
- const folderContent = jsonToCollectionBru(itemFolder.root, true);
+ const folderContent = await stringifyFolder(itemFolder.root);
if (folderContent) {
const bruFolderPath = path.join(collectionPath, `folder.bru`);
- fs.writeFileSync(bruFolderPath, folderContent);
+ safeWriteFileSync(bruFolderPath, folderContent);
}
}
@@ -656,16 +746,41 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
ipcMain.handle('renderer:resequence-items', async (event, itemsToResequence) => {
try {
for (let item of itemsToResequence) {
- const bru = fs.readFileSync(item.pathname, 'utf8');
- const jsonData = bruToJson(bru);
-
- if (jsonData.seq !== item.seq) {
- jsonData.seq = item.seq;
- const content = jsonToBru(jsonData);
- await writeFile(item.pathname, content);
+ if (item?.type === 'folder') {
+ const folderRootPath = path.join(item.pathname, 'folder.bru');
+ let folderBruJsonData = {
+ meta: {
+ name: path.basename(item.pathname),
+ seq: item.seq
+ }
+ };
+ if (fs.existsSync(folderRootPath)) {
+ const bru = fs.readFileSync(folderRootPath, 'utf8');
+ folderBruJsonData = await parseCollection(bru);
+ if (!folderBruJsonData?.meta) {
+ folderBruJsonData.meta = {
+ name: path.basename(item.pathname),
+ seq: item.seq
+ };
+ }
+ if (folderBruJsonData?.meta?.seq === item.seq) {
+ continue;
+ }
+ folderBruJsonData.meta.seq = item.seq;
+ }
+ const content = await stringifyFolder(folderBruJsonData);
+ await writeFile(folderRootPath, content);
+ } else {
+ if (fs.existsSync(item.pathname)) {
+ const itemToSave = transformRequestToSaveToFilesystem(item);
+ const content = await stringifyRequestViaWorker(itemToSave);
+ await writeFile(item.pathname, content);
+ }
}
}
+ return true;
} catch (error) {
+ console.error('Error in resequence-items:', error);
return Promise.reject(error);
}
});
@@ -678,7 +793,25 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
moveRequestUid(itemPath, newItemPath);
fs.unlinkSync(itemPath);
- fs.writeFileSync(newItemPath, itemContent);
+ safeWriteFileSync(newItemPath, itemContent);
+ } catch (error) {
+ return Promise.reject(error);
+ }
+ });
+
+ ipcMain.handle('renderer:move-item', async (event, { targetDirname, sourcePathname }) => {
+ try {
+ if (fs.existsSync(targetDirname)) {
+ const sourceDirname = path.dirname(sourcePathname);
+ const pathnamesBefore = await getPaths(sourcePathname);
+ const pathnamesAfter = pathnamesBefore?.map(p => p?.replace(sourceDirname, targetDirname));
+ await copyPath(sourcePathname, targetDirname);
+ await removePath(sourcePathname);
+ // move the request uids of the previous file/folders to the new file/folder items
+ pathnamesAfter?.forEach((_, index) => {
+ moveRequestUid(pathnamesBefore[index], pathnamesAfter[index]);
+ });
+ }
} catch (error) {
return Promise.reject(error);
}
@@ -740,12 +873,65 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
}
});
+ const updateCookiesAndNotify = async () => {
+ const domainsWithCookies = await getDomainsWithCookies();
+ mainWindow.webContents.send(
+ 'main:cookies-update',
+ safeParseJSON(safeStringifyJSON(domainsWithCookies))
+ );
+ cookiesStore.saveCookieJar();
+ };
+
+ // Delete all cookies for a domain
ipcMain.handle('renderer:delete-cookies-for-domain', async (event, domain) => {
try {
await deleteCookiesForDomain(domain);
+ await updateCookiesAndNotify();
+ } catch (error) {
+ return Promise.reject(error);
+ }
+ });
- const domainsWithCookies = await getDomainsWithCookies();
- mainWindow.webContents.send('main:cookies-update', safeParseJSON(safeStringifyJSON(domainsWithCookies)));
+ ipcMain.handle('renderer:delete-cookie', async (event, domain, path, cookieKey) => {
+ try {
+ await deleteCookie(domain, path, cookieKey);
+ await updateCookiesAndNotify();
+ } catch (error) {
+ return Promise.reject(error);
+ }
+ });
+
+ // add cookie
+ ipcMain.handle('renderer:add-cookie', async (event, domain, cookie) => {
+ try {
+ await addCookieForDomain(domain, cookie);
+ await updateCookiesAndNotify();
+ } catch (error) {
+ return Promise.reject(error);
+ }
+ });
+
+ // modify cookie
+ ipcMain.handle('renderer:modify-cookie', async (event, domain, oldCookie, cookie) => {
+ try {
+ await modifyCookieForDomain(domain, oldCookie, cookie);
+ await updateCookiesAndNotify();
+ } catch (error) {
+ return Promise.reject(error);
+ }
+ });
+
+ ipcMain.handle('renderer:get-parsed-cookie', async (event, cookieStr) => {
+ try {
+ return parseCookieString(cookieStr);
+ } catch (error) {
+ return Promise.reject(error);
+ }
+ });
+
+ ipcMain.handle('renderer:create-cookie-string', async (event, cookie) => {
+ try {
+ return createCookieString(cookie);
} catch (error) {
return Promise.reject(error);
}
@@ -776,6 +962,307 @@ const registerRendererEventHandlers = (mainWindow, watcher, lastOpenedCollection
throw new Error(error.message);
}
});
+
+ ipcMain.handle('renderer:fetch-oauth2-credentials', async (event, { itemUid, request, collection }) => {
+ try {
+ if (request.oauth2) {
+ let requestCopy = _.cloneDeep(request);
+ const { uid: collectionUid, pathname: collectionPath, runtimeVariables, environments = [], activeEnvironmentUid } = collection;
+ const environment = _.find(environments, (e) => e.uid === activeEnvironmentUid);
+ const envVars = getEnvVars(environment);
+ const processEnvVars = getProcessEnvVars(collectionUid);
+ const partialItem = { uid: itemUid };
+ const requestTreePath = getTreePathFromCollectionToItem(collection, partialItem);
+ mergeVars(collection, requestCopy, requestTreePath);
+
+ interpolateVars(requestCopy, envVars, runtimeVariables, processEnvVars);
+ const certsAndProxyConfig = await getCertsAndProxyConfig({
+ collectionUid,
+ request: requestCopy,
+ envVars,
+ runtimeVariables,
+ processEnvVars,
+ collectionPath
+ });
+ const { oauth2: { grantType }} = requestCopy || {};
+
+ const handleOAuth2Response = (response) => {
+ if (response.error && !response.debugInfo) {
+ throw new Error(response.error);
+ }
+ return response;
+ };
+
+ switch (grantType) {
+ case 'authorization_code':
+ interpolateVars(requestCopy, envVars, runtimeVariables, processEnvVars);
+ return await getOAuth2TokenUsingAuthorizationCode({
+ request: requestCopy,
+ collectionUid,
+ forceFetch: true,
+ certsAndProxyConfig
+ }).then(handleOAuth2Response);
+
+ case 'client_credentials':
+ interpolateVars(requestCopy, envVars, runtimeVariables, processEnvVars);
+ return await getOAuth2TokenUsingClientCredentials({
+ request: requestCopy,
+ collectionUid,
+ forceFetch: true,
+ certsAndProxyConfig
+ }).then(handleOAuth2Response);
+
+ case 'password':
+ interpolateVars(requestCopy, envVars, runtimeVariables, processEnvVars);
+ return await getOAuth2TokenUsingPasswordCredentials({
+ request: requestCopy,
+ collectionUid,
+ forceFetch: true,
+ certsAndProxyConfig
+ }).then(handleOAuth2Response);
+
+ case 'implicit':
+ interpolateVars(requestCopy, envVars, runtimeVariables, processEnvVars);
+ return await getOAuth2TokenUsingImplicitGrant({
+ request: requestCopy,
+ collectionUid,
+ forceFetch: true
+ }).then(handleOAuth2Response);
+
+ default:
+ return {
+ error: `Unsupported grant type: ${grantType}`,
+ credentials: null,
+ url: null,
+ collectionUid,
+ credentialsId: null
+ };
+ }
+ }
+ } catch (error) {
+ return Promise.reject(error);
+ }
+ });
+
+ // todo: could be removed
+ ipcMain.handle('renderer:load-request-via-worker', async (event, { collectionUid, pathname }) => {
+ let fileStats;
+ try {
+ fileStats = fs.statSync(pathname);
+ if (hasBruExtension(pathname)) {
+ const file = {
+ meta: {
+ collectionUid,
+ pathname,
+ name: path.basename(pathname)
+ }
+ };
+ let bruContent = fs.readFileSync(pathname, 'utf8');
+ const metaJson = parseBruFileMeta(bruContent);
+ file.data = metaJson;
+ file.loading = true;
+ file.partial = true;
+ file.size = sizeInMB(fileStats?.size);
+ hydrateRequestWithUuid(file.data, pathname);
+ mainWindow.webContents.send('main:collection-tree-updated', 'addFile', file);
+ file.data = await parseRequestViaWorker(bruContent);
+ file.partial = false;
+ file.loading = true;
+ file.size = sizeInMB(fileStats?.size);
+ hydrateRequestWithUuid(file.data, pathname);
+ mainWindow.webContents.send('main:collection-tree-updated', 'addFile', file);
+ }
+ } catch (error) {
+ if (hasBruExtension(pathname)) {
+ const file = {
+ meta: {
+ collectionUid,
+ pathname,
+ name: path.basename(pathname)
+ }
+ };
+ let bruContent = fs.readFileSync(pathname, 'utf8');
+ const metaJson = parseBruFileMeta(bruContent);
+ file.data = metaJson;
+ file.partial = true;
+ file.loading = false;
+ file.size = sizeInMB(fileStats?.size);
+ hydrateRequestWithUuid(file.data, pathname);
+ mainWindow.webContents.send('main:collection-tree-updated', 'addFile', file);
+ }
+ return Promise.reject(error);
+ }
+ });
+
+ ipcMain.handle('renderer:refresh-oauth2-credentials', async (event, { itemUid, request, collection }) => {
+ try {
+ if (request.oauth2) {
+ let requestCopy = _.cloneDeep(request);
+ const { uid: collectionUid, pathname: collectionPath, runtimeVariables, environments = [], activeEnvironmentUid } = collection;
+ const environment = _.find(environments, (e) => e.uid === activeEnvironmentUid);
+ const envVars = getEnvVars(environment);
+ const processEnvVars = getProcessEnvVars(collectionUid);
+ const partialItem = { uid: itemUid };
+ const requestTreePath = getTreePathFromCollectionToItem(collection, partialItem);
+ mergeVars(collection, requestCopy, requestTreePath);
+ interpolateVars(requestCopy, envVars, runtimeVariables, processEnvVars);
+
+ const certsAndProxyConfig = await getCertsAndProxyConfig({
+ collectionUid,
+ request: requestCopy,
+ envVars,
+ runtimeVariables,
+ processEnvVars,
+ collectionPath
+ });
+
+ let { credentials, url, credentialsId, debugInfo } = await refreshOauth2Token({ requestCopy, collectionUid, certsAndProxyConfig });
+ return { credentials, url, collectionUid, credentialsId, debugInfo };
+ }
+ } catch (error) {
+ return Promise.reject(error);
+ }
+ });
+
+ // todo: could be removed
+ ipcMain.handle('renderer:load-request', async (event, { collectionUid, pathname }) => {
+ let fileStats;
+ try {
+ fileStats = fs.statSync(pathname);
+ if (hasBruExtension(pathname)) {
+ const file = {
+ meta: {
+ collectionUid,
+ pathname,
+ name: path.basename(pathname)
+ }
+ };
+ let bruContent = fs.readFileSync(pathname, 'utf8');
+ const metaJson = parseBruFileMeta(bruContent);
+ file.data = metaJson;
+ file.loading = true;
+ file.partial = true;
+ file.size = sizeInMB(fileStats?.size);
+ hydrateRequestWithUuid(file.data, pathname);
+ mainWindow.webContents.send('main:collection-tree-updated', 'addFile', file);
+ file.data = parseRequest(bruContent);
+ file.partial = false;
+ file.loading = true;
+ file.size = sizeInMB(fileStats?.size);
+ hydrateRequestWithUuid(file.data, pathname);
+ mainWindow.webContents.send('main:collection-tree-updated', 'addFile', file);
+ }
+ } catch (error) {
+ if (hasBruExtension(pathname)) {
+ const file = {
+ meta: {
+ collectionUid,
+ pathname,
+ name: path.basename(pathname)
+ }
+ };
+ let bruContent = fs.readFileSync(pathname, 'utf8');
+ const metaJson = parseBruFileMeta(bruContent);
+ file.data = metaJson;
+ file.partial = true;
+ file.loading = false;
+ file.size = sizeInMB(fileStats?.size);
+ hydrateRequestWithUuid(file.data, pathname);
+ mainWindow.webContents.send('main:collection-tree-updated', 'addFile', file);
+ }
+ return Promise.reject(error);
+ }
+ });
+
+ ipcMain.handle('renderer:load-large-request', async (event, { collectionUid, pathname }) => {
+ let fileStats;
+ if (!hasBruExtension(pathname)) {
+ return;
+ }
+
+ const file = {
+ meta: {
+ collectionUid,
+ pathname,
+ name: path.basename(pathname)
+ }
+ };
+
+ try {
+ fileStats = fs.statSync(pathname);
+
+ const bruContent = fs.readFileSync(pathname, 'utf8');
+ const metaJson = parseBruFileMeta(bruContent);
+
+ file.data = metaJson;
+ file.partial = false;
+ file.loading = true;
+ file.size = sizeInMB(fileStats?.size);
+ hydrateRequestWithUuid(file.data, pathname);
+ await mainWindow.webContents.send('main:collection-tree-updated', 'addFile', file);
+
+ try {
+ const parsedData = await parseLargeRequestWithRedaction(bruContent);
+
+ file.data = parsedData;
+ file.loading = false;
+ file.partial = false;
+ file.size = sizeInMB(fileStats?.size);
+ hydrateRequestWithUuid(file.data, pathname);
+ await mainWindow.webContents.send('main:collection-tree-updated', 'addFile', file);
+ } catch (parseError) {
+ file.data = metaJson;
+ file.partial = true;
+ file.loading = false;
+ file.size = sizeInMB(fileStats?.size);
+ hydrateRequestWithUuid(file.data, pathname);
+ await mainWindow.webContents.send('main:collection-tree-updated', 'addFile', file);
+ throw parseError;
+ }
+ } catch (error) {
+ return Promise.reject(error);
+ }
+ });
+
+ ipcMain.handle('renderer:mount-collection', async (event, { collectionUid, collectionPathname, brunoConfig }) => {
+ const {
+ size,
+ filesCount,
+ maxFileSize
+ } = await getCollectionStats(collectionPathname);
+
+ const shouldLoadCollectionAsync =
+ (size > MAX_COLLECTION_SIZE_IN_MB) ||
+ (filesCount > MAX_COLLECTION_FILES_COUNT) ||
+ (maxFileSize > MAX_SINGLE_FILE_SIZE_IN_COLLECTION_IN_MB);
+
+ watcher.addWatcher(mainWindow, collectionPathname, collectionUid, brunoConfig, false, shouldLoadCollectionAsync);
+ });
+
+ ipcMain.handle('renderer:show-in-folder', async (event, filePath) => {
+ try {
+ if (!filePath) {
+ throw new Error('File path is required');
+ }
+ shell.showItemInFolder(filePath);
+ } catch (error) {
+ console.error('Error in show-in-folder: ', error);
+ throw error;
+ }
+ });
+
+ // Implement the Postman to Bruno conversion handler
+ ipcMain.handle('renderer:convert-postman-to-bruno', async (event, postmanCollection) => {
+ try {
+ // Convert Postman collection to Bruno format
+ const brunoCollection = await postmanToBruno(postmanCollection, { useWorkers: true});
+
+ return brunoCollection;
+ } catch (error) {
+ console.error('Error converting Postman to Bruno:', error);
+ return Promise.reject(error);
+ }
+ });
};
const registerMainEventHandlers = (mainWindow, watcher, lastOpenedCollections) => {
@@ -790,8 +1277,7 @@ const registerMainEventHandlers = (mainWindow, watcher, lastOpenedCollections) =
shell.openExternal(docsURL);
});
- ipcMain.on('main:collection-opened', (win, pathname, uid, brunoConfig) => {
- watcher.addWatcher(win, pathname, uid, brunoConfig);
+ ipcMain.on('main:collection-opened', async (win, pathname, uid, brunoConfig) => {
lastOpenedCollections.add(pathname);
app.addRecentDocument(pathname);
});
diff --git a/packages/bruno-electron/src/ipc/filesystem.js b/packages/bruno-electron/src/ipc/filesystem.js
new file mode 100644
index 000000000..5ba62466f
--- /dev/null
+++ b/packages/bruno-electron/src/ipc/filesystem.js
@@ -0,0 +1,53 @@
+const { ipcMain } = require('electron');
+const fs = require('fs');
+const fsPromises = require('fs/promises');
+const path = require('node:path');
+
+const {
+ browseDirectory,
+ browseFiles,
+ normalizeAndResolvePath,
+ isFile
+} = require('../utils/filesystem');
+
+const registerFilesystemIpc = (mainWindow) => {
+ // Browse directory
+ ipcMain.handle('renderer:browse-directory', async (event, pathname, request) => {
+ try {
+ return await browseDirectory(mainWindow);
+ } catch (error) {
+ return Promise.reject(error);
+ }
+ });
+
+ // Browse files
+ ipcMain.handle('renderer:browse-files', async (_, filters, properties) => {
+ try {
+ return await browseFiles(mainWindow, filters, properties);
+ } catch (error) {
+ throw error;
+ }
+ });
+
+ // Check if file exists
+ ipcMain.handle('renderer:exists-sync', async (_, filePath) => {
+ try {
+ const normalizedPath = normalizeAndResolvePath(filePath);
+ return isFile(normalizedPath);
+ } catch (error) {
+ return false;
+ }
+ });
+
+ // Resolve path
+ ipcMain.handle('renderer:resolve-path', async (_, relativePath, basePath) => {
+ try {
+ const resolvedPath = path.resolve(basePath, relativePath);
+ return normalizeAndResolvePath(resolvedPath);
+ } catch (error) {
+ return relativePath;
+ }
+ });
+};
+
+module.exports = registerFilesystemIpc;
\ No newline at end of file
diff --git a/packages/bruno-electron/src/ipc/network/authorize-user-in-window.js b/packages/bruno-electron/src/ipc/network/authorize-user-in-window.js
index 8e4abf4bb..4c671fb62 100644
--- a/packages/bruno-electron/src/ipc/network/authorize-user-in-window.js
+++ b/packages/bruno-electron/src/ipc/network/authorize-user-in-window.js
@@ -5,15 +5,18 @@ const matchesCallbackUrl = (url, callbackUrl) => {
return url ? url.href.startsWith(callbackUrl.href) : false;
};
-const authorizeUserInWindow = ({ authorizeUrl, callbackUrl, session }) => {
+const authorizeUserInWindow = ({ authorizeUrl, callbackUrl, session, additionalHeaders = {}, grantType = 'authorization_code' }) => {
return new Promise(async (resolve, reject) => {
let finalUrl = null;
+ let debugInfo = {
+ data: []
+ };
+ let currentMainRequest = null;
let allOpenWindows = BrowserWindow.getAllWindows();
- // main window id is '1'
- // get all other windows
- let windowsExcludingMain = allOpenWindows.filter((w) => w.id != 1);
+ // Close all windows except the main window (assumed to have id 1)
+ let windowsExcludingMain = allOpenWindows.filter((w) => w.id !== 1);
windowsExcludingMain.forEach((w) => {
w.close();
});
@@ -27,26 +30,112 @@ const authorizeUserInWindow = ({ authorizeUrl, callbackUrl, session }) => {
});
window.on('ready-to-show', window.show.bind(window));
- // We want browser window to comply with "SSL/TLS Certificate Verification" toggle in Preferences
+ // Ensure the browser window complies with "SSL/TLS Certificate Verification" preference
window.webContents.on('certificate-error', (event, url, error, certificate, callback) => {
event.preventDefault();
callback(!preferencesUtil.shouldVerifyTls());
});
- function onWindowRedirect(url) {
- // check if the redirect is to the callback URL and if it contains an authorization code
- if (matchesCallbackUrl(new URL(url), new URL(callbackUrl))) {
- if (!new URL(url).searchParams.has('code')) {
- reject(new Error('Invalid Callback URL: Does not contain an authorization code'));
+ const { session: webSession } = window.webContents;
+
+ // Intercept request events and gather data
+ webSession.webRequest.onBeforeRequest((details, callback) => {
+ const { id: requestId, url, method, resourceType, frameId } = details;
+ if (resourceType === 'mainFrame') {
+ // This is a main frame request
+ currentMainRequest = {
+ requestId,
+ resourceType,
+ frameId,
+ request: {
+ url,
+ method,
+ headers: {},
+ error: null
+ },
+ response: {
+ headers: {},
+ status: null,
+ statusText: null,
+ error: null
+ },
+ fromCache: false,
+ completed: true,
+ requests: [], // No sub-requests in this context
+ };
+ // Add to mainRequests
+
+ // pushing the currentMainRequest to debugInfo
+ // the currentMainRequest will be further updated by object reference
+ debugInfo.data.push(currentMainRequest);
+ }
+
+ callback({ cancel: false });
+ });
+
+ webSession.webRequest.onBeforeSendHeaders((details, callback) => {
+ const { id: requestId, requestHeaders, method, url } = details;
+
+ if (details.resourceType === 'mainFrame' && Object.keys(additionalHeaders).length > 0) {
+ // Add our custom headers
+ for (const [name, value] of Object.entries(additionalHeaders)) {
+ requestHeaders[name] = value;
}
+ }
+
+ if (currentMainRequest?.requestId === requestId) {
+ currentMainRequest.request = {
+ url,
+ headers: requestHeaders,
+ method
+ };
+ }
+ callback({ cancel: false, requestHeaders });
+ });
+
+ webSession.webRequest.onHeadersReceived((details, callback) => {
+ const { id: requestId, url, statusCode, responseHeaders, method } = details;
+ if (currentMainRequest?.requestId === requestId) {
+ currentMainRequest.response = {
+ url,
+ method,
+ status: statusCode,
+ headers: responseHeaders
+ };
+ }
+ callback({ cancel: false, responseHeaders });
+ });
+
+ webSession.webRequest.onCompleted((details) => {
+ const { id: requestId, fromCache } = details;
+ if (currentMainRequest?.requestId === requestId) {
+ currentMainRequest.completed = true;
+ currentMainRequest.fromCache = fromCache;
+ }
+ });
+
+ webSession.webRequest.onErrorOccurred((details) => {
+ const { id: requestId, error } = details;
+ if (currentMainRequest?.requestId === requestId) {
+ currentMainRequest.response.error = error;
+ }
+ });
+
+ function onWindowRedirect(url) {
+ // Handle redirects as needed
+
+ // Check if redirect is to the callback URL and contains an authorization code
+ if (matchesCallbackUrl(new URL(url), new URL(callbackUrl))) {
finalUrl = url;
window.close();
}
- if (url.match(/(error=).*/) || url.match(/(error_description=).*/) || url.match(/(error_uri=).*/)) {
- const _url = new URL(url);
- const error = _url.searchParams.get('error');
- const errorDescription = _url.searchParams.get('error_description');
- const errorUri = _url.searchParams.get('error_uri');
+
+ // Handle OAuth error responses
+ const urlObj = new URL(url);
+ if (urlObj.searchParams.has('error')) {
+ const error = urlObj.searchParams.get('error');
+ const errorDescription = urlObj.searchParams.get('error_description');
+ const errorUri = urlObj.searchParams.get('error_uri');
let errorData = {
message: 'Authorization Failed!',
error,
@@ -58,13 +147,56 @@ const authorizeUserInWindow = ({ authorizeUrl, callbackUrl, session }) => {
}
}
+ // Update currentMainRequest when navigation occurs
+ window.webContents.on('did-start-navigation', (event, url, isInPlace, isMainFrame) => {
+ if (isMainFrame) {
+ // Reset currentMainRequest since a new navigation is starting
+ currentMainRequest = null;
+ }
+ });
+
+ window.webContents.on('did-navigate', (event, url) => {
+ onWindowRedirect(url);
+ });
+
+ window.webContents.on('will-redirect', (event, url) => {
+ onWindowRedirect(url);
+ });
+
window.on('close', () => {
+ // Clean up listeners to prevent memory leaks
+ window.webContents.removeAllListeners();
+ webSession.webRequest.onBeforeRequest(null);
+ webSession.webRequest.onBeforeSendHeaders(null);
+ webSession.webRequest.onHeadersReceived(null);
+ webSession.webRequest.onCompleted(null);
+ webSession.webRequest.onErrorOccurred(null);
+
if (finalUrl) {
try {
- const callbackUrlWithCode = new URL(finalUrl);
- const authorizationCode = callbackUrlWithCode.searchParams.get('code');
-
- return resolve({ authorizationCode });
+ // Handle different grant types differently
+ if (grantType === 'implicit') {
+ // For implicit flow, tokens are in the URL hash fragment
+ const urlWithHash = new URL(finalUrl);
+ const hash = urlWithHash.hash.substring(1); // Remove the leading #
+ const hashParams = new URLSearchParams(hash);
+
+ // Extract tokens from hash fragment
+ const implicitTokens = {
+ access_token: hashParams.get('access_token'),
+ token_type: hashParams.get('token_type'),
+ expires_in: hashParams.get('expires_in'),
+ state: hashParams.get('state'),
+ scope: hashParams.get('scope')
+ };
+
+ return resolve({ implicitTokens, debugInfo });
+ } else {
+ // Default case - authorization code flow
+ const callbackUrlWithCode = new URL(finalUrl);
+ const authorizationCode = callbackUrlWithCode.searchParams.get('code');
+ return resolve({ authorizationCode, debugInfo });
+ }
} catch (error) {
return reject(error);
}
@@ -73,20 +205,10 @@ const authorizeUserInWindow = ({ authorizeUrl, callbackUrl, session }) => {
}
});
- // wait for the window to navigate to the callback url
- const didNavigateListener = (_, url) => {
- onWindowRedirect(url);
- };
- window.webContents.on('did-navigate', didNavigateListener);
- const willRedirectListener = (_, authorizeUrl) => {
- onWindowRedirect(authorizeUrl);
- };
- window.webContents.on('will-redirect', willRedirectListener);
-
try {
await window.loadURL(authorizeUrl);
} catch (error) {
- // If browser redirects before load finished, loadURL throws an error with code ERR_ABORTED. This should be ignored.
+ // Ignore ERR_ABORTED errors that occur during redirects
if (error.code === 'ERR_ABORTED') {
console.debug('Ignoring ERR_ABORTED during authorizeUserInWindow');
return;
diff --git a/packages/bruno-electron/src/ipc/network/awsv4auth-helper.js b/packages/bruno-electron/src/ipc/network/awsv4auth-helper.js
index 4a2ff5aa2..a95a45124 100644
--- a/packages/bruno-electron/src/ipc/network/awsv4auth-helper.js
+++ b/packages/bruno-electron/src/ipc/network/awsv4auth-helper.js
@@ -9,10 +9,11 @@ async function resolveAwsV4Credentials(request) {
const awsv4 = request.awsv4config;
if (isStrPresent(awsv4.profileName)) {
try {
- credentialsProvider = fromIni({
- profile: awsv4.profileName
+ const credentialsProvider = fromIni({
+ profile: awsv4.profileName,
+ ignoreCache: true
});
- credentials = await credentialsProvider();
+ const credentials = await credentialsProvider();
awsv4.accessKeyId = credentials.accessKeyId;
awsv4.secretAccessKey = credentials.secretAccessKey;
awsv4.sessionToken = credentials.sessionToken;
diff --git a/packages/bruno-electron/src/ipc/network/axios-instance.js b/packages/bruno-electron/src/ipc/network/axios-instance.js
index 4f7f9f8f6..3b3cc2b14 100644
--- a/packages/bruno-electron/src/ipc/network/axios-instance.js
+++ b/packages/bruno-electron/src/ipc/network/axios-instance.js
@@ -3,11 +3,32 @@ const Socket = require('net').Socket;
const axios = require('axios');
const connectionCache = new Map(); // Cache to store checkConnection() results
const electronApp = require("electron");
+const { setupProxyAgents } = require('../../utils/proxy-util');
+const { addCookieToJar, getCookieStringForUrl } = require('../../utils/cookies');
+const { preferencesUtil } = require('../../store/preferences');
+const { safeStringifyJSON } = require('../../utils/common');
const LOCAL_IPV6 = '::1';
const LOCAL_IPV4 = '127.0.0.1';
const LOCALHOST = 'localhost';
-const version = electronApp?.app?.getVersion()?.substring(1) ?? "";
+const version = electronApp?.app?.getVersion() ?? "";
+const redirectResponseCodes = [301, 302, 303, 307, 308];
+
+const saveCookies = (url, headers) => {
+ if (preferencesUtil.shouldStoreCookies()) {
+ let setCookieHeaders = [];
+ if (headers['set-cookie']) {
+ setCookieHeaders = Array.isArray(headers['set-cookie'])
+ ? headers['set-cookie']
+ : [headers['set-cookie']];
+ for (let setCookieHeader of setCookieHeaders) {
+ if (typeof setCookieHeader === 'string' && setCookieHeader.length) {
+ addCookieToJar(setCookieHeader, url);
+ }
+ }
+ }
+ }
+}
const getTld = (hostname) => {
if (!hostname) {
@@ -49,13 +70,16 @@ const checkConnection = (host, port) =>
* @see https://github.com/axios/axios/issues/695
* @returns {axios.AxiosInstance}
*/
-function makeAxiosInstance() {
+function makeAxiosInstance({
+ proxyMode = 'off',
+ proxyConfig = {},
+ requestMaxRedirects = 5,
+ httpsAgentRequestFields = {},
+ interpolationOptions = {}
+} = {}) {
/** @type {axios.AxiosInstance} */
const instance = axios.create({
transformRequest: function transformRequest(data, headers) {
- // doesn't apply the default transformRequest if the data is a string, so that axios doesn't add quotes see :
- // https://github.com/usebruno/bruno/issues/2043
- // https://github.com/axios/axios/issues/4034
const contentType = headers?.['Content-Type'] || headers?.['content-type'] || '';
const hasJSONContentType = contentType.includes('json');
if (typeof data === 'string' && hasJSONContentType) {
@@ -68,6 +92,7 @@ function makeAxiosInstance() {
return data;
},
proxy: false,
+ maxRedirects: 0,
headers: {
"User-Agent": `bruno-runtime/${version}`
}
@@ -75,6 +100,48 @@ function makeAxiosInstance() {
instance.interceptors.request.use(async (config) => {
const url = URL.parse(config.url);
+ config.metadata = config.metadata || {};
+ config.metadata.startTime = new Date().getTime();
+ const timeline = config.metadata.timeline || [];
+ // Add initial request details to the timeline
+ timeline.push({
+ timestamp: new Date(),
+ type: 'separator'
+ });
+ timeline.push({
+ timestamp: new Date(),
+ type: 'info',
+ message: `Preparing request to ${config.url}`,
+ });
+ timeline.push({
+ timestamp: new Date(),
+ type: 'info',
+ message: `Current time is ${new Date().toISOString()}`,
+ });
+
+ // Add request method and headers
+ timeline.push({
+ timestamp: new Date(),
+ type: 'request',
+ message: `${config.method.toUpperCase()} ${config.url}`,
+ });
+ Object.entries(config.headers).forEach(([key, value]) => {
+ timeline.push({
+ timestamp: new Date(),
+ type: 'requestHeader',
+ message: `${key}: ${value}`,
+ });
+ });
+
+ // Add request data if available
+ if (config.data) {
+ let requestData = typeof config.data === 'string' ? config.data : JSON.stringify(config.data, null, 2);
+ timeline.push({
+ timestamp: new Date(),
+ type: 'requestData',
+ message: requestData,
+ });
+ }
// Resolve all *.localhost to localhost and check if it should use IPv6 or IPv4
// RFC: 6761 section 6.3 (https://tools.ietf.org/html/rfc6761#section-6.3)
@@ -91,21 +158,264 @@ function makeAxiosInstance() {
}
config.headers['request-start-time'] = Date.now();
+
+ const agentOptions = {
+ ...httpsAgentRequestFields,
+ keepAlive: true,
+ };
+
+ try {
+ // Now call setupProxyAgents and pass the timeline
+ setupProxyAgents({
+ requestConfig: config,
+ proxyMode: proxyMode, // 'on', 'off', or 'system', depending on your settings
+ proxyConfig: proxyConfig,
+ httpsAgentRequestFields: agentOptions,
+ interpolationOptions: interpolationOptions, // Provide your interpolation options
+ timeline,
+ });
+ }
+ catch(err) {
+ if (err.timeline) {
+ timeline = err.timeline;
+ }
+ timeline.push({
+ timestamp: new Date(),
+ type: 'error',
+ message: `Error setting up proxy agents: ${err?.message}`,
+ });
+ }
+ config.metadata.timeline = timeline;
return config;
});
+ let redirectCount = 0
+
instance.interceptors.response.use(
(response) => {
+ let timeline;
const end = Date.now();
const start = response.config.headers['request-start-time'];
response.headers['request-duration'] = end - start;
+ redirectCount = 0;
+
+ const config = response.config;
+ timeline = config?.metadata?.timeline || []
+ const duration = end - config?.metadata.startTime;
+
+ const httpVersion = response?.request?.res?.httpVersion || response?.httpVersion;
+ if (httpVersion?.startsWith('2')) {
+ timeline.push({
+ timestamp: new Date(),
+ type: 'info',
+ message: `Using HTTP/2, server supports multiplexing`,
+ });
+ }
+ timeline.push({
+ timestamp: new Date(),
+ type: 'response',
+ message: `HTTP/${httpVersion || '1.1'} ${response.status} ${response.statusText}`,
+ });
+
+ Object.entries(response.headers).forEach(([key, value]) => {
+ timeline.push({
+ timestamp: new Date(),
+ type: 'responseHeader',
+ message: `${key}: ${value}`,
+ });
+ });
+
+ timeline.push({
+ timestamp: new Date(),
+ type: 'info',
+ message: `Request completed in ${duration} ms`,
+ });
+ response.timeline = timeline;
return response;
},
(error) => {
+ const config = error.config;
+ const timeline = config?.metadata?.timeline || [];
+ timeline?.push({
+ timestamp: new Date(),
+ type: 'error',
+ message: 'there was an error executing the request!'
+ });
if (error.response) {
const end = Date.now();
const start = error.config.headers['request-start-time'];
error.response.headers['request-duration'] = end - start;
+ const duration = end - config?.metadata?.startTime;
+ if (error.response && redirectResponseCodes.includes(error.response.status)) {
+ timeline.push({
+ timestamp: new Date(),
+ type: 'response',
+ message: `HTTP/${error.response.httpVersion || '1.1'} ${error.response.status} ${error.response.statusText}`,
+ });
+ Object.entries(error.response.headers).forEach(([key, value]) => {
+ timeline.push({
+ timestamp: new Date(),
+ type: 'responseHeader',
+ message: `${key}: ${value}`,
+ });
+ });
+ timeline.push({
+ timestamp: new Date(),
+ type: 'info',
+ message: `Request completed in ${duration} ms`,
+ });
+
+ // Attach the timeline to the response
+ error.response.timeline = timeline;
+
+ if (redirectCount >= requestMaxRedirects) {
+ const errorResponseData = error.response.data;
+ timeline?.push({
+ timestamp: new Date(),
+ type: 'error',
+ message: safeStringifyJSON(errorResponseData?.toString?.())
+ });
+ return Promise.reject(error);
+ }
+
+ // Increase redirect count
+ redirectCount++;
+
+ const locationHeader = error.response.headers.location;
+ let redirectUrl = locationHeader;
+
+ // Handle relative URLs by resolving them against the original request URL
+ if (locationHeader && !locationHeader.match(/^https?:\/\//i)) {
+ // It's a relative URL, resolve it against the original URL
+ redirectUrl = URL.resolve(error.config.url, locationHeader);
+
+ timeline.push({
+ timestamp: new Date(),
+ type: 'info',
+ message: `Resolving relative redirect URL: ${locationHeader} → ${redirectUrl}`,
+ });
+ }
+
+ if (preferencesUtil.shouldStoreCookies()) {
+ saveCookies(error.config.url, error.response.headers);
+ }
+
+ // Create a new request config for the redirect
+ const requestConfig = {
+ ...error.config,
+ url: redirectUrl,
+ headers: {
+ ...error.config.headers,
+ },
+ };
+
+ // Apply proper HTTP redirect behavior based on status code
+ const statusCode = error.response.status;
+ const originalMethod = (error.config.method || 'get').toLowerCase();
+
+ // For 301, 302, 303: change method to GET unless it was HEAD
+ if ([301, 302, 303].includes(statusCode) && originalMethod !== 'head') {
+ requestConfig.method = 'get';
+ requestConfig.data = undefined;
+ delete requestConfig.headers['content-length'];
+ delete requestConfig.headers['Content-Length'];
+
+ delete requestConfig.headers['content-type'];
+ delete requestConfig.headers['Content-Type'];
+
+ timeline.push({
+ timestamp: new Date(),
+ type: 'info',
+ message: `Changed method from ${originalMethod.toUpperCase()} to GET for ${statusCode} redirect and removed request body`,
+ });
+ }
+
+ if (preferencesUtil.shouldSendCookies()) {
+ const cookieString = getCookieStringForUrl(redirectUrl);
+ if (cookieString && typeof cookieString === 'string' && cookieString.length) {
+ requestConfig.headers['cookie'] = cookieString;
+ }
+ }
+
+ try {
+ setupProxyAgents({
+ requestConfig,
+ proxyMode,
+ proxyConfig,
+ httpsAgentRequestFields,
+ interpolationOptions,
+ timeline
+ });
+ }
+ catch(err) {
+ if (err.timeline) {
+ timeline = err.timeline;
+ }
+ timeline.push({
+ timestamp: new Date(),
+ type: 'error',
+ message: `Error setting up proxy agents: ${err?.message}`,
+ });
+ }
+
+ requestConfig.metadata.timeline = timeline;
+ // Make the redirected request
+ return instance(requestConfig);
+ }
+ else {
+ const errorResponseData = error.response.data;
+ timeline.push({
+ timestamp: new Date(),
+ type: 'response',
+ message: `HTTP/${error.response.httpVersion || '1.1'} ${error.response.status} ${error.response.statusText}`,
+ });
+ Object.entries(error?.response?.headers || {}).forEach(([key, value]) => {
+ timeline.push({
+ timestamp: new Date(),
+ type: 'responseHeader',
+ message: `${key}: ${value}`,
+ });
+ });
+ timeline?.push({
+ timestamp: new Date(),
+ type: 'error',
+ message: safeStringifyJSON(errorResponseData?.toString?.())
+ });
+ error?.cause && timeline?.push({
+ timestamp: new Date(),
+ type: 'error',
+ message: safeStringifyJSON(error?.cause)
+ });
+ error?.errors && timeline?.push({
+ timestamp: new Date(),
+ type: 'error',
+ message: safeStringifyJSON(error?.errors)
+ });
+ error.response.timeline = timeline;
+ return Promise.reject(error);
+ }
+ }
+ else if (error?.code) {
+ Object.entries(error?.response?.headers || {}).forEach(([key, value]) => {
+ timeline.push({
+ timestamp: new Date(),
+ type: 'responseHeader',
+ message: `${key}: ${value}`,
+ });
+ });
+ timeline?.push({
+ timestamp: new Date(),
+ type: 'error',
+ message: safeStringifyJSON(error?.cause)
+ });
+ timeline?.push({
+ timestamp: new Date(),
+ type: 'error',
+ message: safeStringifyJSON(error?.errors)
+ });
+ error.timeline = timeline;
+ error.statusText = error.code;
+ return Promise.reject(error);
}
return Promise.reject(error);
}
diff --git a/packages/bruno-electron/src/ipc/network/cert-utils.js b/packages/bruno-electron/src/ipc/network/cert-utils.js
new file mode 100644
index 000000000..ecd036fb0
--- /dev/null
+++ b/packages/bruno-electron/src/ipc/network/cert-utils.js
@@ -0,0 +1,114 @@
+const fs = require('fs');
+const tls = require('tls');
+const path = require('path');
+const { get } = require('lodash');
+const { preferencesUtil } = require('../../store/preferences');
+const { getBrunoConfig } = require('../../store/bruno-config');
+const { interpolateString } = require('./interpolate-string');
+
+/**
+ * Gets certificates and proxy configuration for a request
+ */
+const getCertsAndProxyConfig = async ({
+ collectionUid,
+ request,
+ envVars,
+ runtimeVariables,
+ processEnvVars,
+ collectionPath
+}) => {
+ /**
+ * @see https://github.com/usebruno/bruno/issues/211 set keepAlive to true, this should fix socket hang up errors
+ * @see https://github.com/nodejs/node/pull/43522 keepAlive was changed to true globally on Node v19+
+ */
+ const httpsAgentRequestFields = { keepAlive: true };
+ if (!preferencesUtil.shouldVerifyTls()) {
+ httpsAgentRequestFields['rejectUnauthorized'] = false;
+ }
+
+ if (preferencesUtil.shouldUseCustomCaCertificate()) {
+ const caCertFilePath = preferencesUtil.getCustomCaCertificateFilePath();
+ if (caCertFilePath) {
+ let caCertBuffer = fs.readFileSync(caCertFilePath);
+ if (preferencesUtil.shouldKeepDefaultCaCertificates()) {
+ caCertBuffer += '\n' + tls.rootCertificates.join('\n'); // Augment default truststore with custom CA certificates
+ }
+ httpsAgentRequestFields['ca'] = caCertBuffer;
+ }
+ }
+
+ const brunoConfig = getBrunoConfig(collectionUid);
+ const interpolationOptions = {
+ envVars,
+ runtimeVariables,
+ processEnvVars
+ };
+
+ // client certificate config
+ const clientCertConfig = get(brunoConfig, 'clientCertificates.certs', []);
+
+ for (let clientCert of clientCertConfig) {
+ const domain = interpolateString(clientCert?.domain, interpolationOptions);
+ const type = clientCert?.type || 'cert';
+ if (domain) {
+ const hostRegex = '^(https:\\/\\/|grpc:\\/\\/|grpcs:\\/\\/)?' + domain.replaceAll('.', '\\.').replaceAll('*', '.*');
+ const requestUrl = interpolateString(request.url, interpolationOptions);
+ if (requestUrl.match(hostRegex)) {
+ if (type === 'cert') {
+ try {
+ let certFilePath = interpolateString(clientCert?.certFilePath, interpolationOptions);
+ certFilePath = path.isAbsolute(certFilePath) ? certFilePath : path.join(collectionPath, certFilePath);
+ let keyFilePath = interpolateString(clientCert?.keyFilePath, interpolationOptions);
+ keyFilePath = path.isAbsolute(keyFilePath) ? keyFilePath : path.join(collectionPath, keyFilePath);
+
+ httpsAgentRequestFields['cert'] = fs.readFileSync(certFilePath);
+ httpsAgentRequestFields['key'] = fs.readFileSync(keyFilePath);
+ } catch (err) {
+ console.error('Error reading cert/key file', err);
+ throw new Error('Error reading cert/key file' + err);
+ }
+ } else if (type === 'pfx') {
+ try {
+ let pfxFilePath = interpolateString(clientCert?.pfxFilePath, interpolationOptions);
+ pfxFilePath = path.isAbsolute(pfxFilePath) ? pfxFilePath : path.join(collectionPath, pfxFilePath);
+ httpsAgentRequestFields['pfx'] = fs.readFileSync(pfxFilePath);
+ } catch (err) {
+ console.error('Error reading pfx file', err);
+ throw new Error('Error reading pfx file' + err);
+ }
+ }
+ httpsAgentRequestFields['passphrase'] = interpolateString(clientCert.passphrase, interpolationOptions);
+ break;
+ }
+ }
+ }
+
+ /**
+ * Proxy configuration
+ *
+ * Preferences proxyMode has three possible values: on, off, system
+ * Collection proxyMode has three possible values: true, false, global
+ *
+ * When collection proxyMode is true, it overrides the app-level proxy settings
+ * When collection proxyMode is false, it ignores the app-level proxy settings
+ * When collection proxyMode is global, it uses the app-level proxy settings
+ *
+ * Below logic calculates the proxyMode and proxyConfig to be used for the request
+ */
+ let proxyMode = 'off';
+ let proxyConfig = {};
+
+ const collectionProxyConfig = get(brunoConfig, 'proxy', {});
+ const collectionProxyEnabled = get(collectionProxyConfig, 'enabled', 'global');
+ if (collectionProxyEnabled === true) {
+ proxyConfig = collectionProxyConfig;
+ proxyMode = 'on';
+ } else if (collectionProxyEnabled === 'global') {
+ proxyConfig = preferencesUtil.getGlobalProxyConfig();
+ proxyMode = get(proxyConfig, 'mode', 'off');
+ }
+
+ return { proxyMode, proxyConfig, httpsAgentRequestFields, interpolationOptions };
+}
+
+module.exports = { getCertsAndProxyConfig };
\ No newline at end of file
diff --git a/packages/bruno-electron/src/ipc/network/grpc-event-handlers.js b/packages/bruno-electron/src/ipc/network/grpc-event-handlers.js
new file mode 100644
index 000000000..cc3ad9add
--- /dev/null
+++ b/packages/bruno-electron/src/ipc/network/grpc-event-handlers.js
@@ -0,0 +1,575 @@
+// To implement grpc event handlers
+const { ipcMain, app } = require('electron');
+const { GrpcClient } = require("@usebruno/requests")
+const { safeParseJSON, safeStringifyJSON } = require('../../utils/common');
+const { cloneDeep, each, get } = require('lodash');
+const interpolateVars = require('./interpolate-vars');
+const { preferencesUtil } = require('../../store/preferences');
+const { getCertsAndProxyConfig } = require('./cert-utils');
+const { getEnvVars, getTreePathFromCollectionToItem, mergeHeaders, mergeScripts, mergeVars, mergeAuth, getFormattedCollectionOauth2Credentials } = require('../../utils/collection');
+const { getProcessEnvVars } = require('../../store/process-env');
+const { getOAuth2TokenUsingPasswordCredentials, getOAuth2TokenUsingClientCredentials, getOAuth2TokenUsingAuthorizationCode } = require('../../utils/oauth2');
+const { interpolateString } = require('./interpolate-string');
+const path = require('node:path');
+
+const setGrpcAuthHeaders = (grpcRequest, request, collectionRoot) => {
+ const collectionAuth = get(collectionRoot, 'request.auth');
+ if (collectionAuth && request.auth?.mode === 'inherit') {
+ if (collectionAuth.mode === 'basic') {
+ grpcRequest.basicAuth = {
+ username: get(collectionAuth, 'basic.username'),
+ password: get(collectionAuth, 'basic.password')
+ };
+ }
+
+ if (collectionAuth.mode === 'bearer') {
+ grpcRequest.headers['Authorization'] = `Bearer ${get(collectionAuth, 'bearer.token')}`;
+ }
+
+ if (collectionAuth.mode === 'apikey') {
+ grpcRequest.headers[collectionAuth.apikey?.key] = collectionAuth.apikey?.value;
+
+ }
+
+ if (collectionAuth.mode === 'oauth2') {
+ const grantType = get(collectionAuth, 'oauth2.grantType');
+
+ if (grantType === 'client_credentials') {
+ grpcRequest.oauth2 = {
+ grantType,
+ accessTokenUrl: get(collectionAuth, 'oauth2.accessTokenUrl'),
+ clientId: get(collectionAuth, 'oauth2.clientId'),
+ clientSecret: get(collectionAuth, 'oauth2.clientSecret'),
+ scope: get(collectionAuth, 'oauth2.scope'),
+ credentialsPlacement: get(collectionAuth, 'oauth2.credentialsPlacement'),
+ tokenPlacement: get(collectionAuth, 'oauth2.tokenPlacement'),
+ tokenHeaderPrefix: get(collectionAuth, 'oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(collectionAuth, 'oauth2.tokenQueryKey')
+ };
+ } else if (grantType === 'password') {
+ grpcRequest.oauth2 = {
+ grantType,
+ accessTokenUrl: get(collectionAuth, 'oauth2.accessTokenUrl'),
+ username: get(collectionAuth, 'oauth2.username'),
+ password: get(collectionAuth, 'oauth2.password'),
+ clientId: get(collectionAuth, 'oauth2.clientId'),
+ clientSecret: get(collectionAuth, 'oauth2.clientSecret'),
+ scope: get(collectionAuth, 'oauth2.scope'),
+ credentialsPlacement: get(collectionAuth, 'oauth2.credentialsPlacement'),
+ tokenPlacement: get(collectionAuth, 'oauth2.tokenPlacement'),
+ tokenHeaderPrefix: get(collectionAuth, 'oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(collectionAuth, 'oauth2.tokenQueryKey')
+ };
+ }
+ }
+
+ }
+
+ if (request.auth && request.auth.mode !== 'inherit') {
+ if (request.auth.mode === 'basic') {
+ grpcRequest.basicAuth = {
+ username: get(request, 'auth.basic.username'),
+ password: get(request, 'auth.basic.password')
+ };
+ }
+
+ if (request.auth.mode === 'bearer') {
+ grpcRequest.headers['Authorization'] = `Bearer ${get(request, 'auth.bearer.token')}`;
+ }
+
+ if (request.auth.mode === 'oauth2') {
+ const grantType = get(request, 'auth.oauth2.grantType');
+
+
+ if (grantType === 'client_credentials') {
+ grpcRequest.oauth2 = {
+ grantType,
+ clientId: get(request, 'auth.oauth2.clientId'),
+ clientSecret: get(request, 'auth.oauth2.clientSecret'),
+ scope: get(request, 'auth.oauth2.scope'),
+ accessTokenUrl: get(request, 'auth.oauth2.accessTokenUrl'),
+ tokenPlacement: get(request, 'auth.oauth2.tokenPlacement'),
+ credentialsPlacement: get(request, 'auth.oauth2.credentialsPlacement'),
+ tokenHeaderPrefix: get(request, 'auth.oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(request, 'auth.oauth2.tokenQueryKey')
+ };
+ } else if (grantType === 'password') {
+ grpcRequest.oauth2 = {
+ grantType,
+ username: get(request, 'auth.oauth2.username'),
+ password: get(request, 'auth.oauth2.password'),
+ clientId: get(request, 'auth.oauth2.clientId'),
+ clientSecret: get(request, 'auth.oauth2.clientSecret'),
+ scope: get(request, 'auth.oauth2.scope'),
+ accessTokenUrl: get(request, 'auth.oauth2.accessTokenUrl'),
+ tokenPlacement: get(request, 'auth.oauth2.tokenPlacement'),
+ credentialsPlacement: get(request, 'auth.oauth2.credentialsPlacement'),
+ tokenHeaderPrefix: get(request, 'auth.oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(request, 'auth.oauth2.tokenQueryKey')
+ };
+ } else if (grantType === 'authorization_code') {
+ grpcRequest.oauth2 = {
+ grantType,
+ ...get(request, 'auth.oauth2')
+ };
+ }
+ }
+
+ if (request.auth.mode === 'apikey') {
+ grpcRequest.headers[request.auth.apikey?.key] = request.auth.apikey?.value;
+ }
+ }
+
+
+ return grpcRequest;
+}
+
+const prepareRequest = async (item, collection, environment, runtimeVariables, certsAndProxyConfig = {}) => {
+ const request = item.draft ? item.draft.request : item.request;
+ const collectionRoot = collection?.draft ? get(collection, 'draft', {}) : get(collection, 'root', {});
+ const headers = {};
+ const url = request.url;
+ let contentTypeDefined = false;
+
+ each(get(collectionRoot, 'request.headers', []), (h) => {
+ if (h.enabled && h.name?.toLowerCase() === 'content-type') {
+ contentTypeDefined = true;
+ return false;
+ }
+ });
+
+ const scriptFlow = collection?.brunoConfig?.scripts?.flow ?? 'sandwich';
+ const requestTreePath = getTreePathFromCollectionToItem(collection, item);
+ if (requestTreePath && requestTreePath.length > 0) {
+ mergeAuth(collection, request, requestTreePath);
+ mergeHeaders(collection, request, requestTreePath);
+ mergeScripts(collection, request, requestTreePath, scriptFlow);
+ mergeVars(collection, request, requestTreePath);
+ request.globalEnvironmentVariables = collection?.globalEnvironmentVariables;
+ request.oauth2CredentialVariables = getFormattedCollectionOauth2Credentials({ oauth2Credentials: collection?.oauth2Credentials });
+ }
+
+ each(get(request, 'headers', []), (h) => {
+ if (h.enabled && h.name.length > 0) {
+ headers[h.name] = h.value;
+ if (h.name.toLowerCase() === 'content-type') {
+ contentTypeDefined = true;
+ }
+ }
+ });
+
+ const processEnvVars = getProcessEnvVars(collection.uid);
+ const envVars = getEnvVars(environment);
+
+ let grpcRequest = {
+ uid: item.uid,
+ mode: request.body.mode,
+ method: request.method,
+ methodType: request.methodType,
+ url,
+ headers,
+ processEnvVars,
+ envVars,
+ runtimeVariables,
+ body: request.body,
+ protoPath: request.protoPath,
+ // Add variable properties for interpolation
+ vars: request.vars,
+ collectionVariables: request.collectionVariables,
+ folderVariables: request.folderVariables,
+ requestVariables: request.requestVariables,
+ globalEnvironmentVariables: request.globalEnvironmentVariables,
+ oauth2CredentialVariables: request.oauth2CredentialVariables,
+ }
+
+ grpcRequest = setGrpcAuthHeaders(grpcRequest, request, collectionRoot);
+
+ if (grpcRequest.oauth2) {
+ let requestCopy = cloneDeep(grpcRequest);
+ const { oauth2: { grantType, tokenPlacement, tokenHeaderPrefix, tokenQueryKey } = {} } = requestCopy || {};
+ let credentials, credentialsId, oauth2Url, debugInfo;
+ switch (grantType) {
+ case 'authorization_code':
+ interpolateVars(requestCopy, envVars, runtimeVariables, processEnvVars);
+ ({ credentials, url: oauth2Url, credentialsId, debugInfo } = await getOAuth2TokenUsingAuthorizationCode({ request: requestCopy, collectionUid: collection.uid, certsAndProxyConfig }));
+ grpcRequest.oauth2Credentials = { credentials, url: oauth2Url, collectionUid: collection.uid, credentialsId, debugInfo, folderUid: request.oauth2Credentials?.folderUid };
+ if (tokenPlacement == 'header') {
+ grpcRequest.headers['Authorization'] = `${tokenHeaderPrefix} ${credentials?.access_token}`;
+ }
+ else {
+ try {
+ const url = new URL(request.url);
+ url?.searchParams?.set(tokenQueryKey, credentials?.access_token);
+ request.url = url?.toString();
+ }
+ catch(error) {}
+ }
+ break;
+ case 'client_credentials':
+ interpolateVars(requestCopy, envVars, runtimeVariables, processEnvVars);
+ ({ credentials, url: oauth2Url, credentialsId, debugInfo } = await getOAuth2TokenUsingClientCredentials({ request: requestCopy, collectionUid: collection.uid, certsAndProxyConfig }));
+ grpcRequest.oauth2Credentials = { credentials, url: oauth2Url, collectionUid: collection.uid, credentialsId, debugInfo, folderUid: request.oauth2Credentials?.folderUid };
+ if (tokenPlacement == 'header') {
+ grpcRequest.headers['Authorization'] = `${tokenHeaderPrefix} ${credentials?.access_token}`;
+ }
+ else {
+ try {
+ const url = new URL(request.url);
+ url?.searchParams?.set(tokenQueryKey, credentials?.access_token);
+ request.url = url?.toString();
+ }
+ catch(error) {}
+ }
+ break;
+ case 'password':
+ interpolateVars(requestCopy, envVars, runtimeVariables, processEnvVars);
+ ({ credentials, url: oauth2Url, credentialsId, debugInfo } = await getOAuth2TokenUsingPasswordCredentials({ request: requestCopy, collectionUid: collection.uid, certsAndProxyConfig }));
+ grpcRequest.oauth2Credentials = { credentials, url: oauth2Url, collectionUid: collection.uid, credentialsId, debugInfo, folderUid: request.oauth2Credentials?.folderUid };
+ if (tokenPlacement == 'header') {
+ grpcRequest.headers['Authorization'] = `${tokenHeaderPrefix} ${credentials?.access_token}`;
+ }
+ else {
+ try {
+ const url = new URL(request.url);
+ url?.searchParams?.set(tokenQueryKey, credentials?.access_token);
+ request.url = url?.toString();
+ }
+ catch(error) {}
+ }
+ break;
+ }
+ }
+
+ interpolateVars(grpcRequest, envVars, runtimeVariables, processEnvVars);
+
+ return grpcRequest;
+}
+
+// Creating grpcClient at module level so it can be accessed from window-all-closed event
+let grpcClient;
+
+/**
+ * Register IPC handlers for gRPC
+ */
+const registerGrpcEventHandlers = (window) => {
+ const sendEvent = (eventName, ...args) => {
+ if (window && window.webContents) {
+ window.webContents.send(eventName, ...args);
+ } else {
+ console.warn(`Unable to send message "${eventName}": Window not available`);
+ }
+ };
+
+ grpcClient = new GrpcClient(sendEvent);
+
+ ipcMain.handle('connections-changed', (event) => {
+ sendEvent('grpc:connections-changed', event);
+ });
+
+ // Start a new gRPC connection
+ ipcMain.handle('grpc:start-connection', async (event, { request, collection, environment, runtimeVariables }) => {
+
+ try {
+ const requestCopy = cloneDeep(request);
+
+
+ const preparedRequest = await prepareRequest(requestCopy, collection, environment, runtimeVariables, {});
+
+ // Get certificates and proxy configuration
+ const certsAndProxyConfig = await getCertsAndProxyConfig({
+ collectionUid: collection.uid,
+ request: requestCopy.request,
+ envVars: preparedRequest.envVars,
+ runtimeVariables,
+ processEnvVars: preparedRequest.processEnvVars,
+ collectionPath: collection.pathname
+ });
+
+
+ // Extract certificate information from the config
+ const { httpsAgentRequestFields } = certsAndProxyConfig;
+
+ // Configure verify options
+ const verifyOptions = {
+ rejectUnauthorized: preferencesUtil.shouldVerifyTls()
+ };
+
+ // Extract certificate information
+ const rootCertificate = httpsAgentRequestFields.ca;
+ const privateKey = httpsAgentRequestFields.key;
+ const certificateChain = httpsAgentRequestFields.cert;
+ const passphrase = httpsAgentRequestFields.passphrase;
+ const pfx = httpsAgentRequestFields.pfx;
+
+ const requestSent = {
+ type: "request",
+ url: preparedRequest.url,
+ method: preparedRequest.method,
+ methodType: preparedRequest.methodType,
+ headers: preparedRequest.headers,
+ body: preparedRequest.body,
+ timestamp: Date.now()
+ }
+ // Start gRPC connection with the processed request and certificates
+ await grpcClient.startConnection({
+ request: preparedRequest,
+ collection,
+ rootCertificate,
+ privateKey,
+ certificateChain,
+ passphrase,
+ pfx,
+ verifyOptions
+ });
+
+ sendEvent('grpc:request', preparedRequest.uid, collection.uid, requestSent);
+
+ // Send OAuth credentials update if available
+ if (preparedRequest?.oauth2Credentials) {
+ window.webContents.send('main:credentials-update', {
+ credentials: preparedRequest.oauth2Credentials?.credentials,
+ url: preparedRequest.oauth2Credentials?.url,
+ collectionUid: collection.uid,
+ credentialsId: preparedRequest.oauth2Credentials?.credentialsId,
+ ...(preparedRequest.oauth2Credentials?.folderUid ? { folderUid: preparedRequest.oauth2Credentials.folderUid } : { itemUid: preparedRequest.uid }),
+ debugInfo: preparedRequest.oauth2Credentials.debugInfo,
+ });
+ }
+
+ return { success: true };
+ } catch (error) {
+ console.error('Error starting gRPC connection:', error);
+ if (error instanceof Error) {
+ throw error;
+ }
+ sendEvent('grpc:error', request.uid, collection.uid, { error: error.message });
+ return { success: false, error: error.message };
+ }
+ });
+
+ // Get all active connection IDs
+ ipcMain.handle('grpc:get-active-connections', (event) => {
+ try {
+ const activeConnectionIds = grpcClient.getActiveConnectionIds();
+ return { success: true, activeConnectionIds };
+ } catch (error) {
+ console.error('Error getting active connections:', error);
+ return { success: false, error: error.message, activeConnectionIds: [] };
+ }
+ });
+
+ // Send a message to an existing stream
+ ipcMain.handle('grpc:send-message', (event, requestId, collectionUid, message) => {
+ try {
+ grpcClient.sendMessage(requestId, collectionUid, message);
+ sendEvent('grpc:message', requestId, collectionUid, message);
+ return { success: true };
+ } catch (error) {
+ console.error('Error sending gRPC message:', error);
+ return { success: false, error: error.message };
+ }
+ });
+
+ // End a streaming request
+ ipcMain.handle('grpc:end-request', (event, params) => {
+ try {
+ const { requestId } = params || {};
+ if (!requestId) {
+ throw new Error('Request ID is required');
+ }
+ grpcClient.end(requestId);
+ return { success: true };
+ } catch (error) {
+ console.error('Error ending gRPC stream:', error);
+ return { success: false, error: error.message };
+ }
+ });
+
+ // Cancel a request
+ ipcMain.handle('grpc:cancel-request', (event, params) => {
+ try {
+ const { requestId } = params || {};
+ if (!requestId) {
+ throw new Error('Request ID is required');
+ }
+ grpcClient.cancel(requestId);
+ return { success: true };
+ } catch (error) {
+ console.error('Error cancelling gRPC request:', error);
+ return { success: false, error: error.message };
+ }
+ });
+
+ // Load methods from server reflection
+ ipcMain.handle('grpc:load-methods-reflection', async (event, { request, collection, environment, runtimeVariables }) => {
+ try {
+ const requestCopy = cloneDeep(request);
+ const preparedRequest = await prepareRequest(requestCopy, collection, environment, runtimeVariables);
+
+ // Get certificates and proxy configuration
+ const certsAndProxyConfig = await getCertsAndProxyConfig({
+ collectionUid: collection.uid,
+ request: requestCopy.request,
+ envVars: preparedRequest.envVars,
+ runtimeVariables,
+ processEnvVars: preparedRequest.processEnvVars,
+ collectionPath: collection.pathname
+ });
+
+ // Extract certificate information from the config
+ const { httpsAgentRequestFields } = certsAndProxyConfig;
+
+ // Configure verify options
+ const verifyOptions = {
+ rejectUnauthorized: preferencesUtil.shouldVerifyTls()
+ };
+
+ // Extract certificate information
+ const rootCertificate = httpsAgentRequestFields.ca;
+ const privateKey = httpsAgentRequestFields.key;
+ const certificateChain = httpsAgentRequestFields.cert;
+ const passphrase = httpsAgentRequestFields.passphrase;
+ const pfx = httpsAgentRequestFields.pfx;
+
+
+ // Send OAuth credentials update if available
+ if (preparedRequest?.oauth2Credentials) {
+ window.webContents.send('main:credentials-update', {
+ credentials: preparedRequest.oauth2Credentials?.credentials,
+ url: preparedRequest.oauth2Credentials?.url,
+ collectionUid: collection.uid,
+ credentialsId: preparedRequest.oauth2Credentials?.credentialsId,
+ ...(preparedRequest.oauth2Credentials?.folderUid ? { folderUid: preparedRequest.oauth2Credentials.folderUid } : { itemUid: preparedRequest.uid }),
+ debugInfo: preparedRequest.oauth2Credentials.debugInfo,
+ });
+ }
+
+
+ const methods = await grpcClient.loadMethodsFromReflection({
+ request: preparedRequest,
+ collectionUid: collection.uid,
+ rootCertificate,
+ privateKey,
+ certificateChain,
+ passphrase,
+ pfx,
+ verifyOptions,
+ sendEvent
+ });
+
+ return { success: true, methods: safeParseJSON(safeStringifyJSON(methods))};
+ } catch (error) {
+ console.error('Error loading gRPC methods from reflection:', error);
+ return { success: false, error: error.message };
+ }
+ });
+
+ // Load methods from proto file
+ ipcMain.handle('grpc:load-methods-proto', async (event, { filePath, includeDirs }) => {
+ try {
+ const methods = await grpcClient.loadMethodsFromProtoFile(filePath, includeDirs);
+ return { success: true, methods: safeParseJSON(safeStringifyJSON(methods))};
+ } catch (error) {
+ console.error('Error loading gRPC methods from proto file:', error);
+ return { success: false, error: error.message };
+ }
+ });
+
+ // Generate a sample gRPC message based on method path
+ ipcMain.handle('grpc:generate-sample-message', async (event, { methodPath, existingMessage, options = {} }) => {
+ try {
+ // Generate the sample message
+ const result = grpcClient.generateSampleMessage(methodPath, {
+ ...options,
+ // Parse existing message if provided
+ existingMessage: existingMessage ? safeParseJSON(existingMessage) : null
+ });
+
+ if (!result.success) {
+ return {
+ success: false,
+ error: result.error || 'Failed to generate sample message'
+ };
+ }
+
+ // Convert the message to a JSON string for safe transfer through IPC
+ return {
+ success: true,
+ message: JSON.stringify(result.message, null, 2)
+ };
+ } catch (error) {
+ console.error('Error generating gRPC sample message:', error);
+ return {
+ success: false,
+ error: error.message || 'Failed to generate sample message'
+ };
+ }
+ });
+
+ // Generate grpcurl command for a request
+ ipcMain.handle('grpc:generate-grpcurl', async (event, { request, collection, environment, runtimeVariables }) => {
+ try {
+ const requestCopy = cloneDeep(request);
+ const preparedRequest = await prepareRequest(requestCopy, collection, environment, runtimeVariables, {});
+ const interpolationOptions = {
+ envVars: preparedRequest.envVars,
+ runtimeVariables,
+ processEnvVars: preparedRequest.processEnvVars
+ };
+ let caCertFilePath, certFilePath, keyFilePath;
+
+ if(preferencesUtil.shouldUseCustomCaCertificate()) {
+ caCertFilePath = preferencesUtil.getCustomCaCertificateFilePath();
+ }
+
+ const clientCertConfig = get(collection, 'brunoConfig.clientCertificates.certs', []);
+
+ for (let clientCert of clientCertConfig) {
+ const domain = interpolateString(clientCert?.domain, interpolationOptions);
+ const type = clientCert?.type || 'cert';
+ if (domain) {
+ const hostRegex = '^(https:\\/\\/|grpc:\\/\\/|grpcs:\\/\\/)' + domain.replaceAll('.', '\\.').replaceAll('*', '.*');
+ const requestUrl = interpolateString(preparedRequest.url, interpolationOptions);
+ if (requestUrl.match(hostRegex)) {
+ if (type === 'cert') {
+ certFilePath = interpolateString(clientCert?.certFilePath, interpolationOptions);
+ certFilePath = path.isAbsolute(certFilePath) ? certFilePath : path.join(collection.pathname, certFilePath);
+ keyFilePath = interpolateString(clientCert?.keyFilePath, interpolationOptions);
+ keyFilePath = path.isAbsolute(keyFilePath) ? keyFilePath : path.join(collection.pathname, keyFilePath);
+ }
+ }
+ }
+ }
+ // Generate the grpcurl command
+ const command = grpcClient.generateGrpcurlCommand({
+ request: preparedRequest,
+ collectionPath: collection.pathname,
+ certificates: {
+ ca: caCertFilePath,
+ cert: certFilePath,
+ key: keyFilePath
+ }
+ });
+
+ return { success: true, command };
+ } catch (error) {
+ console.error('Error generating grpcurl command:', error);
+ return { success: false, error: error.message };
+ }
+ });
+};
+
+// Clean up gRPC connections when all windows are closed
+if (app && typeof app.on === 'function') {
+ app.on('window-all-closed', () => {
+ if (grpcClient && typeof grpcClient.clearAllConnections === 'function') {
+ try {
+ grpcClient.clearAllConnections();
+ } catch (error) {
+ console.error('Error clearing gRPC connections:', error);
+ }
+ }
+});
+}
+
+module.exports = registerGrpcEventHandlers
diff --git a/packages/bruno-electron/src/ipc/network/helper.js b/packages/bruno-electron/src/ipc/network/helper.js
deleted file mode 100644
index d4e49688f..000000000
--- a/packages/bruno-electron/src/ipc/network/helper.js
+++ /dev/null
@@ -1,76 +0,0 @@
-const { each, filter } = require('lodash');
-
-const sortCollection = (collection) => {
- const items = collection.items || [];
- let folderItems = filter(items, (item) => item.type === 'folder');
- let requestItems = filter(items, (item) => item.type !== 'folder');
-
- folderItems = folderItems.sort((a, b) => a.name.localeCompare(b.name));
- requestItems = requestItems.sort((a, b) => a.seq - b.seq);
-
- collection.items = folderItems.concat(requestItems);
-
- each(folderItems, (item) => {
- sortCollection(item);
- });
-};
-
-const sortFolder = (folder = {}) => {
- const items = folder.items || [];
- let folderItems = filter(items, (item) => item.type === 'folder');
- let requestItems = filter(items, (item) => item.type !== 'folder');
-
- folderItems = folderItems.sort((a, b) => a.name.localeCompare(b.name));
- requestItems = requestItems.sort((a, b) => a.seq - b.seq);
-
- folder.items = folderItems.concat(requestItems);
-
- each(folderItems, (item) => {
- sortFolder(item);
- });
-
- return folder;
-};
-
-const findItemInCollection = (collection, itemId) => {
- let item = null;
-
- if (collection.uid === itemId) {
- return collection;
- }
-
- if (collection.items && collection.items.length) {
- collection.items.forEach((item) => {
- if (item.uid === itemId) {
- item = item;
- } else if (item.type === 'folder') {
- item = findItemInCollection(item, itemId);
- }
- });
- }
-
- return item;
-};
-
-const getAllRequestsInFolderRecursively = (folder = {}) => {
- let requests = [];
-
- if (folder.items && folder.items.length) {
- folder.items.forEach((item) => {
- if (item.type !== 'folder') {
- requests.push(item);
- } else {
- requests = requests.concat(getAllRequestsInFolderRecursively(item));
- }
- });
- }
-
- return requests;
-};
-
-module.exports = {
- sortCollection,
- sortFolder,
- findItemInCollection,
- getAllRequestsInFolderRecursively
-};
diff --git a/packages/bruno-electron/src/ipc/network/index.js b/packages/bruno-electron/src/ipc/network/index.js
index 218fadf38..37fd9bd3a 100644
--- a/packages/bruno-electron/src/ipc/network/index.js
+++ b/packages/bruno-electron/src/ipc/network/index.js
@@ -1,90 +1,38 @@
-const os = require('os');
-const fs = require('fs');
const qs = require('qs');
const https = require('https');
-const tls = require('tls');
const axios = require('axios');
const path = require('path');
const decomment = require('decomment');
const contentDispositionParser = require('content-disposition');
const mime = require('mime-types');
+const FormData = require('form-data');
const { ipcMain } = require('electron');
-const { isUndefined, isNull, each, get, compact, cloneDeep, forOwn, extend } = require('lodash');
+const { each, get, extend, cloneDeep, merge } = require('lodash');
+const { NtlmClient } = require('axios-ntlm');
const { VarsRuntime, AssertRuntime, ScriptRuntime, TestRuntime } = require('@usebruno/js');
-const prepareRequest = require('./prepare-request');
-const prepareCollectionRequest = require('./prepare-collection-request');
-const prepareGqlIntrospectionRequest = require('./prepare-gql-introspection-request');
-const { cancelTokens, saveCancelToken, deleteCancelToken } = require('../../utils/cancel-token');
-const { uuid } = require('../../utils/common');
-const interpolateVars = require('./interpolate-vars');
+const { encodeUrl } = require('@usebruno/common').utils;
const { interpolateString } = require('./interpolate-string');
-const { sortFolder, getAllRequestsInFolderRecursively } = require('./helper');
+const { resolveAwsV4Credentials, addAwsV4Interceptor } = require('./awsv4auth-helper');
+const { addDigestInterceptor } = require('@usebruno/requests');
+const prepareGqlIntrospectionRequest = require('./prepare-gql-introspection-request');
+const { prepareRequest } = require('./prepare-request');
+const interpolateVars = require('./interpolate-vars');
+const { makeAxiosInstance } = require('./axios-instance');
+const { cancelTokens, saveCancelToken, deleteCancelToken } = require('../../utils/cancel-token');
+const { uuid, safeStringifyJSON, safeParseJSON, parseDataFromResponse, parseDataFromRequest } = require('../../utils/common');
+const { chooseFileToSave, writeBinaryFile, writeFile } = require('../../utils/filesystem');
+const { addCookieToJar, getDomainsWithCookies, getCookieStringForUrl } = require('../../utils/cookies');
+const { createFormData } = require('../../utils/form-data');
+const { findItemInCollectionByPathname, sortFolder, getAllRequestsInFolderRecursively, getEnvVars, getTreePathFromCollectionToItem, mergeVars, sortByNameThenSequence } = require('../../utils/collection');
+const { getOAuth2TokenUsingAuthorizationCode, getOAuth2TokenUsingClientCredentials, getOAuth2TokenUsingPasswordCredentials, getOAuth2TokenUsingImplicitGrant } = require('../../utils/oauth2');
const { preferencesUtil } = require('../../store/preferences');
const { getProcessEnvVars } = require('../../store/process-env');
const { getBrunoConfig } = require('../../store/bruno-config');
-const { HttpProxyAgent } = require('http-proxy-agent');
-const { SocksProxyAgent } = require('socks-proxy-agent');
-const { makeAxiosInstance } = require('./axios-instance');
-const { addAwsV4Interceptor, resolveAwsV4Credentials } = require('./awsv4auth-helper');
-const { addDigestInterceptor } = require('./digestauth-helper');
-const { shouldUseProxy, PatchedHttpsProxyAgent } = require('../../utils/proxy-util');
-const { chooseFileToSave, writeBinaryFile, writeFile } = require('../../utils/filesystem');
-const { getCookieStringForUrl, addCookieToJar, getDomainsWithCookies } = require('../../utils/cookies');
-const {
- resolveOAuth2AuthorizationCodeAccessToken,
- transformClientCredentialsRequest,
- transformPasswordCredentialsRequest
-} = require('./oauth2-helper');
const Oauth2Store = require('../../store/oauth2');
-const iconv = require('iconv-lite');
-const FormData = require('form-data');
-const { createFormData } = require('../../utils/form-data');
-const { findItemInCollectionByPathname } = require('../../utils/collection');
-const { NtlmClient } = require('axios-ntlm');
-
-const safeStringifyJSON = (data) => {
- try {
- return JSON.stringify(data);
- } catch (e) {
- return data;
- }
-};
-
-const safeParseJSON = (data) => {
- try {
- return JSON.parse(data);
- } catch (e) {
- return data;
- }
-};
-
-const getEnvVars = (environment = {}) => {
- const variables = environment.variables;
- if (!variables || !variables.length) {
- return {
- __name__: environment.name
- };
- }
-
- const envVars = {};
- each(variables, (variable) => {
- if (variable.enabled) {
- envVars[variable.name] = variable.value;
- }
- });
-
- return {
- ...envVars,
- __name__: environment.name
- };
-};
-
-const getJsSandboxRuntime = (collection) => {
- const securityConfig = get(collection, 'securityConfig', {});
- return securityConfig.jsSandboxMode === 'safe' ? 'quickjs' : 'vm2';
-};
-
-const protocolRegex = /^([-+\w]{1,25})(:?\/\/|:)/;
+const { isRequestTagsIncluded } = require('@usebruno/common');
+const { cookiesStore } = require('../../store/cookies');
+const registerGrpcEventHandlers = require('./grpc-event-handlers');
+const { getCertsAndProxyConfig } = require('./cert-utils');
const saveCookies = (url, headers) => {
if (preferencesUtil.shouldStoreCookies()) {
@@ -102,6 +50,11 @@ const saveCookies = (url, headers) => {
}
}
+const getJsSandboxRuntime = (collection) => {
+ const securityConfig = get(collection, 'securityConfig', {});
+ return securityConfig.jsSandboxMode === 'safe' ? 'quickjs' : 'vm2';
+};
+
const configureRequest = async (
collectionUid,
request,
@@ -110,209 +63,110 @@ const configureRequest = async (
processEnvVars,
collectionPath
) => {
+ const protocolRegex = /^([-+\w]{1,25})(:?\/\/|:)/;
if (!protocolRegex.test(request.url)) {
request.url = `http://${request.url}`;
}
- /**
- * @see https://github.com/usebruno/bruno/issues/211 set keepAlive to true, this should fix socket hang up errors
- * @see https://github.com/nodejs/node/pull/43522 keepAlive was changed to true globally on Node v19+
- */
- const httpsAgentRequestFields = { keepAlive: true };
- if (!preferencesUtil.shouldVerifyTls()) {
- httpsAgentRequestFields['rejectUnauthorized'] = false;
- }
-
- if (preferencesUtil.shouldUseCustomCaCertificate()) {
- const caCertFilePath = preferencesUtil.getCustomCaCertificateFilePath();
- if (caCertFilePath) {
- let caCertBuffer = fs.readFileSync(caCertFilePath);
- if (preferencesUtil.shouldKeepDefaultCaCertificates()) {
- caCertBuffer += '\n' + tls.rootCertificates.join('\n'); // Augment default truststore with custom CA certificates
- }
- httpsAgentRequestFields['ca'] = caCertBuffer;
- }
- }
-
- const brunoConfig = getBrunoConfig(collectionUid);
- const interpolationOptions = {
+ const certsAndProxyConfig = await getCertsAndProxyConfig({
+ collectionUid,
+ request,
envVars,
runtimeVariables,
- processEnvVars
- };
+ processEnvVars,
+ collectionPath
+ });
- // client certificate config
- const clientCertConfig = get(brunoConfig, 'clientCertificates.certs', []);
-
- for (let clientCert of clientCertConfig) {
- const domain = interpolateString(clientCert?.domain, interpolationOptions);
- const type = clientCert?.type || 'cert';
- if (domain) {
- const hostRegex = '^https:\\/\\/' + domain.replaceAll('.', '\\.').replaceAll('*', '.*');
- if (request.url.match(hostRegex)) {
- if (type === 'cert') {
- try {
- let certFilePath = interpolateString(clientCert?.certFilePath, interpolationOptions);
- certFilePath = path.isAbsolute(certFilePath) ? certFilePath : path.join(collectionPath, certFilePath);
- let keyFilePath = interpolateString(clientCert?.keyFilePath, interpolationOptions);
- keyFilePath = path.isAbsolute(keyFilePath) ? keyFilePath : path.join(collectionPath, keyFilePath);
-
- httpsAgentRequestFields['cert'] = fs.readFileSync(certFilePath);
- httpsAgentRequestFields['key'] = fs.readFileSync(keyFilePath);
- } catch (err) {
- console.error('Error reading cert/key file', err);
- throw new Error('Error reading cert/key file' + err);
- }
- } else if (type === 'pfx') {
- try {
- let pfxFilePath = interpolateString(clientCert?.pfxFilePath, interpolationOptions);
- pfxFilePath = path.isAbsolute(pfxFilePath) ? pfxFilePath : path.join(collectionPath, pfxFilePath);
- httpsAgentRequestFields['pfx'] = fs.readFileSync(pfxFilePath);
- } catch (err) {
- console.error('Error reading pfx file', err);
- throw new Error('Error reading pfx file' + err);
- }
- }
- httpsAgentRequestFields['passphrase'] = interpolateString(clientCert.passphrase, interpolationOptions);
- break;
- }
- }
- }
-
- /**
- * Proxy configuration
- *
- * Preferences proxyMode has three possible values: on, off, system
- * Collection proxyMode has three possible values: true, false, global
- *
- * When collection proxyMode is true, it overrides the app-level proxy settings
- * When collection proxyMode is false, it ignores the app-level proxy settings
- * When collection proxyMode is global, it uses the app-level proxy settings
- *
- * Below logic calculates the proxyMode and proxyConfig to be used for the request
- */
- let proxyMode = 'off';
- let proxyConfig = {};
-
- const collectionProxyConfig = get(brunoConfig, 'proxy', {});
- const collectionProxyEnabled = get(collectionProxyConfig, 'enabled', 'global');
- if (collectionProxyEnabled === true) {
- proxyConfig = collectionProxyConfig;
- proxyMode = 'on';
- } else if (collectionProxyEnabled === 'global') {
- proxyConfig = preferencesUtil.getGlobalProxyConfig();
- proxyMode = get(proxyConfig, 'mode', 'off');
- }
-
- if (proxyMode === 'on') {
- const shouldProxy = shouldUseProxy(request.url, get(proxyConfig, 'bypassProxy', ''));
- if (shouldProxy) {
- const proxyProtocol = interpolateString(get(proxyConfig, 'protocol'), interpolationOptions);
- const proxyHostname = interpolateString(get(proxyConfig, 'hostname'), interpolationOptions);
- const proxyPort = interpolateString(get(proxyConfig, 'port'), interpolationOptions);
- const proxyAuthEnabled = get(proxyConfig, 'auth.enabled', false);
- const socksEnabled = proxyProtocol.includes('socks');
- let uriPort = isUndefined(proxyPort) || isNull(proxyPort) ? '' : `:${proxyPort}`;
- let proxyUri;
- if (proxyAuthEnabled) {
- const proxyAuthUsername = interpolateString(get(proxyConfig, 'auth.username'), interpolationOptions);
- const proxyAuthPassword = interpolateString(get(proxyConfig, 'auth.password'), interpolationOptions);
-
- proxyUri = `${proxyProtocol}://${proxyAuthUsername}:${proxyAuthPassword}@${proxyHostname}${uriPort}`;
- } else {
- proxyUri = `${proxyProtocol}://${proxyHostname}${uriPort}`;
- }
- if (socksEnabled) {
- request.httpsAgent = new SocksProxyAgent(
- proxyUri,
- Object.keys(httpsAgentRequestFields).length > 0 ? { ...httpsAgentRequestFields } : undefined
- );
- request.httpAgent = new SocksProxyAgent(proxyUri);
- } else {
- request.httpsAgent = new PatchedHttpsProxyAgent(
- proxyUri,
- Object.keys(httpsAgentRequestFields).length > 0 ? { ...httpsAgentRequestFields } : undefined
- );
- request.httpAgent = new HttpProxyAgent(proxyUri);
- }
- } else {
- request.httpsAgent = new https.Agent({
- ...httpsAgentRequestFields
- });
- }
- } else if (proxyMode === 'system') {
- const { http_proxy, https_proxy, no_proxy } = preferencesUtil.getSystemProxyEnvVariables();
- const shouldUseSystemProxy = shouldUseProxy(request.url, no_proxy || '');
- if (shouldUseSystemProxy) {
- try {
- if (http_proxy?.length) {
- new URL(http_proxy);
- request.httpAgent = new HttpProxyAgent(http_proxy);
- }
- } catch (error) {
- throw new Error('Invalid system http_proxy');
- }
- try {
- if (https_proxy?.length) {
- new URL(https_proxy);
- request.httpsAgent = new PatchedHttpsProxyAgent(
- https_proxy,
- Object.keys(httpsAgentRequestFields).length > 0 ? { ...httpsAgentRequestFields } : undefined
- );
- }
- } catch (error) {
- throw new Error('Invalid system https_proxy');
- }
- } else {
- request.httpsAgent = new https.Agent({
- ...httpsAgentRequestFields
- });
- }
- } else if (Object.keys(httpsAgentRequestFields).length > 0) {
- request.httpsAgent = new https.Agent({
- ...httpsAgentRequestFields
- });
- }
-
-
- let axiosInstance = makeAxiosInstance();
+ let requestMaxRedirects = request.maxRedirects
+ request.maxRedirects = 0
+ // Set default value for requestMaxRedirects if not explicitly set
+ if (requestMaxRedirects === undefined) {
+ requestMaxRedirects = 5; // Default to 5 redirects
+ }
+
+ let { proxyMode, proxyConfig, httpsAgentRequestFields, interpolationOptions } = certsAndProxyConfig;
+ let axiosInstance = makeAxiosInstance({
+ proxyMode,
+ proxyConfig,
+ requestMaxRedirects,
+ httpsAgentRequestFields,
+ interpolationOptions
+ });
+
if (request.ntlmConfig) {
axiosInstance=NtlmClient(request.ntlmConfig,axiosInstance.defaults)
delete request.ntlmConfig;
}
-
if (request.oauth2) {
let requestCopy = cloneDeep(request);
- switch (request?.oauth2?.grantType) {
+ const { oauth2: { grantType, tokenPlacement, tokenHeaderPrefix, tokenQueryKey } = {} } = requestCopy || {};
+ let credentials, credentialsId, oauth2Url, debugInfo;
+ switch (grantType) {
case 'authorization_code':
interpolateVars(requestCopy, envVars, runtimeVariables, processEnvVars);
- const { data: authorizationCodeData, url: authorizationCodeAccessTokenUrl } =
- await resolveOAuth2AuthorizationCodeAccessToken(requestCopy, collectionUid);
- request.method = 'POST';
- request.headers['content-type'] = 'application/x-www-form-urlencoded';
- request.data = authorizationCodeData;
- request.url = authorizationCodeAccessTokenUrl;
+ ({ credentials, url: oauth2Url, credentialsId, debugInfo } = await getOAuth2TokenUsingAuthorizationCode({ request: requestCopy, collectionUid, certsAndProxyConfig }));
+ request.oauth2Credentials = { credentials, url: oauth2Url, collectionUid, credentialsId, debugInfo, folderUid: request.oauth2Credentials?.folderUid };
+ if (tokenPlacement == 'header' && credentials?.access_token) {
+ request.headers['Authorization'] = `${tokenHeaderPrefix} ${credentials.access_token}`.trim();
+ }
+ else {
+ try {
+ const url = new URL(request.url);
+ url?.searchParams?.set(tokenQueryKey, credentials?.access_token);
+ request.url = url?.toString();
+ }
+ catch(error) {}
+ }
+ break;
+ case 'implicit':
+ interpolateVars(requestCopy, envVars, runtimeVariables, processEnvVars);
+ ({ credentials, url: oauth2Url, credentialsId, debugInfo } = await getOAuth2TokenUsingImplicitGrant({ request: requestCopy, collectionUid }));
+ request.oauth2Credentials = { credentials, url: oauth2Url, collectionUid, credentialsId, debugInfo, folderUid: request.oauth2Credentials?.folderUid };
+ if (tokenPlacement == 'header') {
+ request.headers['Authorization'] = `${tokenHeaderPrefix} ${credentials?.access_token}`;
+ }
+ else {
+ try {
+ const url = new URL(request.url);
+ url?.searchParams?.set(tokenQueryKey, credentials?.access_token);
+ request.url = url?.toString();
+ }
+ catch(error) {}
+ }
break;
case 'client_credentials':
interpolateVars(requestCopy, envVars, runtimeVariables, processEnvVars);
- const { data: clientCredentialsData, url: clientCredentialsAccessTokenUrl } =
- await transformClientCredentialsRequest(requestCopy);
- request.method = 'POST';
- request.headers['content-type'] = 'application/x-www-form-urlencoded';
- request.data = clientCredentialsData;
- request.url = clientCredentialsAccessTokenUrl;
+ ({ credentials, url: oauth2Url, credentialsId, debugInfo } = await getOAuth2TokenUsingClientCredentials({ request: requestCopy, collectionUid, certsAndProxyConfig }));
+ request.oauth2Credentials = { credentials, url: oauth2Url, collectionUid, credentialsId, debugInfo, folderUid: request.oauth2Credentials?.folderUid };
+ if (tokenPlacement == 'header' && credentials?.access_token) {
+ request.headers['Authorization'] = `${tokenHeaderPrefix} ${credentials.access_token}`.trim();
+ }
+ else {
+ try {
+ const url = new URL(request.url);
+ url?.searchParams?.set(tokenQueryKey, credentials?.access_token);
+ request.url = url?.toString();
+ }
+ catch(error) {}
+ }
break;
case 'password':
interpolateVars(requestCopy, envVars, runtimeVariables, processEnvVars);
- const { data: passwordData, url: passwordAccessTokenUrl } = await transformPasswordCredentialsRequest(
- requestCopy
- );
- request.method = 'POST';
- request.headers['content-type'] = 'application/x-www-form-urlencoded';
- request.data = passwordData;
- request.url = passwordAccessTokenUrl;
+ ({ credentials, url: oauth2Url, credentialsId, debugInfo } = await getOAuth2TokenUsingPasswordCredentials({ request: requestCopy, collectionUid, certsAndProxyConfig }));
+ request.oauth2Credentials = { credentials, url: oauth2Url, collectionUid, credentialsId, debugInfo, folderUid: request.oauth2Credentials?.folderUid };
+ if (tokenPlacement == 'header' && credentials?.access_token) {
+ request.headers['Authorization'] = `${tokenHeaderPrefix} ${credentials.access_token}`.trim();
+ }
+ else {
+ try {
+ const url = new URL(request.url);
+ url?.searchParams?.set(tokenQueryKey, credentials?.access_token);
+ request.url = url?.toString();
+ }
+ catch(error) {}
+ }
break;
}
}
@@ -333,7 +187,30 @@ const configureRequest = async (
if (preferencesUtil.shouldSendCookies()) {
const cookieString = getCookieStringForUrl(request.url);
if (cookieString && typeof cookieString === 'string' && cookieString.length) {
- request.headers['cookie'] = cookieString;
+ const existingCookieHeaderName = Object.keys(request.headers).find(
+ name => name.toLowerCase() === 'cookie'
+ );
+ const existingCookieString = existingCookieHeaderName ? request.headers[existingCookieHeaderName] : '';
+
+ // Helper function to parse cookies into an object
+ const parseCookies = (str) => str.split(';').reduce((cookies, cookie) => {
+ const [name, ...rest] = cookie.split('=');
+ if (name && name.trim()) {
+ cookies[name.trim()] = rest.join('=').trim();
+ }
+ return cookies;
+ }, {});
+
+ const mergedCookies = {
+ ...parseCookies(existingCookieString),
+ ...parseCookies(cookieString),
+ };
+
+ const combinedCookieString = Object.entries(mergedCookies)
+ .map(([name, value]) => `${name}=${value}`)
+ .join('; ');
+
+ request.headers[existingCookieHeaderName || 'Cookie'] = combinedCookieString;
}
}
@@ -358,34 +235,75 @@ const configureRequest = async (
return axiosInstance;
};
-const parseDataFromResponse = (response, disableParsingResponseJson = false) => {
- // Parse the charset from content type: https://stackoverflow.com/a/33192813
- const charsetMatch = /charset=([^()<>@,;:"/[\]?.=\s]*)/i.exec(response.headers['content-type'] || '');
- // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/exec#using_exec_with_regexp_literals
- const charsetValue = charsetMatch?.[1];
- const dataBuffer = Buffer.from(response.data);
- // Overwrite the original data for backwards compatibility
- let data;
- if (iconv.encodingExists(charsetValue)) {
- data = iconv.decode(dataBuffer, charsetValue);
- } else {
- data = iconv.decode(dataBuffer, 'utf-8');
- }
- // Try to parse response to JSON, this can quietly fail
+const fetchGqlSchemaHandler = async (event, endpoint, environment, _request, collection) => {
try {
- // Filter out ZWNBSP character
- // https://gist.github.com/antic183/619f42b559b78028d1fe9e7ae8a1352d
- data = data.replace(/^\uFEFF/, '');
+ const requestTreePath = getTreePathFromCollectionToItem(collection, _request);
+ // Create a clone of the request to avoid mutating the original
+ const resolvedRequest = cloneDeep(_request);
+ // mergeVars modifies the request in place, but we'll assign it to ensure consistency
+ mergeVars(collection, resolvedRequest, requestTreePath);
+ const envVars = getEnvVars(environment);
- // If the response is a string and starts and ends with double quotes, it's a stringified JSON and should not be parsed
- if ( !disableParsingResponseJson && ! (typeof data === 'string' && data.startsWith("\"") && data.endsWith("\""))) {
- data = JSON.parse(data);
+ const globalEnvironmentVars = collection.globalEnvironmentVariables;
+ const folderVars = resolvedRequest.folderVariables;
+ const requestVariables = resolvedRequest.requestVariables;
+ const collectionVariables = resolvedRequest.collectionVariables;
+ const runtimeVars = collection.runtimeVariables;
+
+ // Precedence: runtimeVars > requestVariables > folderVars > envVars > collectionVariables > globalEnvironmentVars
+ const resolvedVars = merge(
+ {},
+ globalEnvironmentVars,
+ collectionVariables,
+ envVars,
+ folderVars,
+ requestVariables,
+ runtimeVars
+ );
+
+ const collectionRoot = get(collection, 'root', {});
+ const request = prepareGqlIntrospectionRequest(endpoint, resolvedVars, _request, collectionRoot);
+
+ request.timeout = preferencesUtil.getRequestTimeout();
+
+ if (!preferencesUtil.shouldVerifyTls()) {
+ request.httpsAgent = new https.Agent({
+ rejectUnauthorized: false
+ });
}
- } catch {
- console.log('Failed to parse response data as JSON');
- }
- return { data, dataBuffer };
+ const collectionPath = collection.pathname;
+ const processEnvVars = getProcessEnvVars(collection.uid);
+
+ const axiosInstance = await configureRequest(
+ collection.uid,
+ request,
+ envVars,
+ collection.runtimeVariables,
+ processEnvVars,
+ collectionPath
+ );
+
+ const response = await axiosInstance(request);
+
+ return {
+ status: response.status,
+ statusText: response.statusText,
+ headers: response.headers,
+ data: response.data
+ };
+ } catch (error) {
+ if (error.response) {
+ return {
+ status: error.response.status,
+ statusText: error.response.statusText,
+ headers: error.response.headers,
+ data: error.response.data
+ };
+ }
+
+ return Promise.reject(error);
+ }
};
const registerNetworkIpc = (mainWindow) => {
@@ -398,12 +316,25 @@ const registerNetworkIpc = (mainWindow) => {
});
};
+ const notifyScriptExecution = ({
+ channel, // 'main:run-request-event' | 'main:run-folder-event'
+ basePayload, // request-level or runner-level identifiers
+ scriptType, // 'pre-request' | 'post-response' | 'test'
+ error // optional Error
+ }) => {
+ mainWindow.webContents.send(channel, {
+ type: `${scriptType}-script-execution`,
+ ...basePayload,
+ errorMessage: error ? (error.message || `An error occurred in ${scriptType.replace('-', ' ')} script`) : null
+ });
+ };
+
const runPreRequest = async (
request,
requestUid,
envVars,
collectionPath,
- collectionRoot,
+ collection,
collectionUid,
runtimeVariables,
processEnvVars,
@@ -412,6 +343,7 @@ const registerNetworkIpc = (mainWindow) => {
) => {
// run pre-request script
let scriptResult;
+ const collectionName = collection?.name
const requestScript = get(request, 'script.req');
if (requestScript?.length) {
const scriptRuntime = new ScriptRuntime({ runtime: scriptingConfig?.runtime });
@@ -424,7 +356,8 @@ const registerNetworkIpc = (mainWindow) => {
onConsoleLog,
processEnvVars,
scriptingConfig,
- runRequestByItemPathname
+ runRequestByItemPathname,
+ collectionName
);
mainWindow.webContents.send('main:script-environment-update', {
@@ -434,14 +367,28 @@ const registerNetworkIpc = (mainWindow) => {
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;
+
+ const domainsWithCookies = await getDomainsWithCookies();
+ mainWindow.webContents.send('main:cookies-update', safeParseJSON(safeStringifyJSON(domainsWithCookies)));
}
// interpolate variables inside request
interpolateVars(request, envVars, runtimeVariables, processEnvVars);
+ if (request.settings?.encodeUrl) {
+ request.url = encodeUrl(request.url);
+ }
+
// if this is a graphql request, parse the variables, only after interpolation
// https://github.com/usebruno/bruno/issues/884
if (request.mode === 'graphql') {
@@ -450,7 +397,7 @@ const registerNetworkIpc = (mainWindow) => {
// stringify the request url encoded params
if (request.headers['content-type'] === 'application/x-www-form-urlencoded') {
- request.data = qs.stringify(request.data);
+ request.data = qs.stringify(request.data, { arrayFormat: 'repeat' });
}
if (request.headers['content-type'] === 'multipart/form-data') {
@@ -470,7 +417,7 @@ const registerNetworkIpc = (mainWindow) => {
requestUid,
envVars,
collectionPath,
- collectionRoot,
+ collection,
collectionUid,
runtimeVariables,
processEnvVars,
@@ -499,19 +446,29 @@ const registerNetworkIpc = (mainWindow) => {
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;
}
if (result?.error) {
mainWindow.webContents.send('main:display-error', result.error);
}
+
+ collection.globalEnvironmentVariables = result.globalEnvironmentVariables;
}
// run post-response script
const responseScript = get(request, 'script.res');
let scriptResult;
+ const collectionName = collection?.name
if (responseScript?.length) {
const scriptRuntime = new ScriptRuntime({ runtime: scriptingConfig?.runtime });
scriptResult = await scriptRuntime.runResponseScript(
@@ -524,7 +481,8 @@ const registerNetworkIpc = (mainWindow) => {
onConsoleLog,
processEnvVars,
scriptingConfig,
- runRequestByItemPathname
+ runRequestByItemPathname,
+ collectionName
);
mainWindow.webContents.send('main:script-environment-update', {
@@ -534,18 +492,29 @@ const registerNetworkIpc = (mainWindow) => {
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;
+
+ const domainsWithCookiesPost = await getDomainsWithCookies();
+ mainWindow.webContents.send('main:cookies-update', safeParseJSON(safeStringifyJSON(domainsWithCookiesPost)));
}
return scriptResult;
};
- const runRequest = async ({ item, collection, environment, runtimeVariables, runInBackground = false }) => {
+ const runRequest = async ({ item, collection, envVars, processEnvVars, runtimeVariables, runInBackground = false }) => {
const collectionUid = collection.uid;
const collectionPath = collection.pathname;
const cancelTokenUid = uuid();
- const requestUid = uuid();
+ // requestUid is passed when a request is triggered; defaults to uuid() if not provided (e.g., bru.runRequest())
+ const requestUid = item.requestUid || uuid();
const runRequestByItemPathname = async (relativeItemPathname) => {
return new Promise(async (resolve, reject) => {
@@ -553,9 +522,9 @@ const registerNetworkIpc = (mainWindow) => {
if (itemPathname && !itemPathname?.endsWith('.bru')) {
itemPathname = `${itemPathname}.bru`;
}
- const _item = findItemInCollectionByPathname(collection, itemPathname);
+ const _item = cloneDeep(findItemInCollectionByPathname(collection, itemPathname));
if(_item) {
- const res = await runRequest({ item: _item, collection, environment, runtimeVariables, runInBackground: true });
+ const res = await runRequest({ item: _item, collection, envVars, processEnvVars, runtimeVariables, runInBackground: true });
resolve(res);
}
reject(`bru.runRequest: invalid request path - ${itemPathname}`);
@@ -570,33 +539,56 @@ const registerNetworkIpc = (mainWindow) => {
cancelTokenUid
});
- const collectionRoot = get(collection, 'root', {});
- const request = prepareRequest(item, collection);
+ const abortController = new AbortController();
+ const request = await prepareRequest(item, collection, abortController);
request.__bruno__executionMode = 'standalone';
- const envVars = getEnvVars(environment);
- const processEnvVars = getProcessEnvVars(collectionUid);
const brunoConfig = getBrunoConfig(collectionUid);
const scriptingConfig = get(brunoConfig, 'scripts', {});
scriptingConfig.runtime = getJsSandboxRuntime(collection);
try {
- const controller = new AbortController();
- request.signal = controller.signal;
- saveCancelToken(cancelTokenUid, controller);
+ request.signal = abortController.signal;
+ saveCancelToken(cancelTokenUid, abortController);
- await runPreRequest(
- request,
- requestUid,
- envVars,
- collectionPath,
- collectionRoot,
- collectionUid,
- runtimeVariables,
- processEnvVars,
- scriptingConfig,
- runRequestByItemPathname
- );
+ let preRequestScriptResult = null;
+ let preRequestError = null;
+ try {
+ preRequestScriptResult = await runPreRequest(
+ request,
+ requestUid,
+ envVars,
+ collectionPath,
+ collection,
+ collectionUid,
+ runtimeVariables,
+ processEnvVars,
+ scriptingConfig,
+ runRequestByItemPathname
+ );
+ } catch (error) {
+ preRequestError = error;
+ }
+ if (preRequestScriptResult?.results) {
+ mainWindow.webContents.send('main:run-request-event', {
+ type: 'test-results-pre-request',
+ results: preRequestScriptResult.results,
+ itemUid: item.uid,
+ requestUid,
+ collectionUid
+ });
+ }
+
+ !runInBackground && notifyScriptExecution({
+ channel: 'main:run-request-event',
+ basePayload: { requestUid, collectionUid, itemUid: item.uid },
+ scriptType: 'pre-request',
+ error: preRequestError
+ });
+
+ if (preRequestError) {
+ return Promise.reject(preRequestError);
+ }
const axiosInstance = await configureRequest(
collectionUid,
request,
@@ -606,21 +598,35 @@ const registerNetworkIpc = (mainWindow) => {
collectionPath
);
+ const { data: requestData, dataBuffer: requestDataBuffer } = parseDataFromRequest(request);
+ let requestSent = {
+ url: request.url,
+ method: request.method,
+ headers: request.headers,
+ data: requestData,
+ dataBuffer: requestDataBuffer
+ }
+
!runInBackground && mainWindow.webContents.send('main:run-request-event', {
type: 'request-sent',
- requestSent: {
- url: request.url,
- method: request.method,
- headers: request.headers,
- data: safeParseJSON(safeStringifyJSON(request.data)),
- timestamp: Date.now()
- },
+ requestSent,
collectionUid,
itemUid: item.uid,
requestUid,
cancelTokenUid
});
+ if (request?.oauth2Credentials) {
+ mainWindow.webContents.send('main:credentials-update', {
+ credentials: request?.oauth2Credentials?.credentials,
+ url: request?.oauth2Credentials?.url,
+ collectionUid,
+ credentialsId: request?.oauth2Credentials?.credentialsId,
+ ...(request?.oauth2Credentials?.folderUid ? { folderUid: request.oauth2Credentials.folderUid } : { itemUid: item.uid }),
+ debugInfo: request?.oauth2Credentials?.debugInfo,
+ });
+ }
+
let response, responseTime;
try {
/** @type {import('axios').AxiosResponse} */
@@ -634,11 +640,15 @@ const registerNetworkIpc = (mainWindow) => {
// if it's a cancel request, don't continue
if (axios.isCancel(error)) {
- let error = new Error('Request cancelled');
- error.isCancel = true;
- return Promise.reject(error);
+ // we are not rejecting the promise here and instead returning a response object with `error` which is handled in the `send-http-request` invocation
+ // timeline prop won't be accessible in the usual way in the renderer process if we reject the promise
+ return {
+ statusText: 'REQUEST_CANCELLED',
+ isCancel: true,
+ error: 'REQUEST_CANCELLED',
+ timeline: error.timeline
+ };
}
-
if (error?.response) {
response = error.response;
@@ -646,8 +656,16 @@ const registerNetworkIpc = (mainWindow) => {
responseTime = response.headers.get('request-duration');
response.headers.delete('request-duration');
} else {
+ await executeRequestOnFailHandler(request, error);
+
// if it's not a network error, don't continue
- return Promise.reject(error);
+ // we are not rejecting the promise here and instead returning a response object with `error` which is handled in the `send-http-request` invocation
+ // timeline prop won't be accessible in the usual way in the renderer process if we reject the promise
+ return {
+ statusText: error.statusText,
+ error: error.message || 'Error occured while executing the request!',
+ timeline: error.timeline
+ }
}
}
@@ -655,6 +673,7 @@ const registerNetworkIpc = (mainWindow) => {
const { data, dataBuffer } = parseDataFromResponse(response, request.__brunoDisableParsingResponseJson);
response.data = data;
+ response.dataBuffer = dataBuffer;
response.responseTime = responseTime;
@@ -667,20 +686,45 @@ const registerNetworkIpc = (mainWindow) => {
const domainsWithCookies = await getDomainsWithCookies();
mainWindow.webContents.send('main:cookies-update', safeParseJSON(safeStringifyJSON(domainsWithCookies)));
+ cookiesStore.saveCookieJar();
- await runPostResponse(
- request,
- response,
- requestUid,
- envVars,
- collectionPath,
- collectionRoot,
- collectionUid,
- runtimeVariables,
- processEnvVars,
- scriptingConfig,
- runRequestByItemPathname
- );
+ let postResponseScriptResult = null;
+ let postResponseError = null;
+ try {
+ postResponseScriptResult = await runPostResponse(
+ request,
+ response,
+ requestUid,
+ envVars,
+ collectionPath,
+ collection,
+ collectionUid,
+ runtimeVariables,
+ processEnvVars,
+ scriptingConfig,
+ runRequestByItemPathname
+ );
+ } catch (error) {
+ console.error('Post-response script error:', error);
+ postResponseError = error;
+ }
+
+ if (postResponseScriptResult?.results) {
+ mainWindow.webContents.send('main:run-request-event', {
+ type: 'test-results-post-response',
+ results: postResponseScriptResult.results,
+ itemUid: item.uid,
+ requestUid,
+ collectionUid
+ });
+ }
+
+ !runInBackground && notifyScriptExecution({
+ channel: 'main:run-request-event',
+ basePayload: { requestUid, collectionUid, itemUid: item.uid },
+ scriptType: 'post-response',
+ error: postResponseError
+ });
// run assertions
const assertions = get(request, 'assertions');
@@ -705,20 +749,42 @@ const registerNetworkIpc = (mainWindow) => {
}
const testFile = get(request, 'tests');
+ const collectionName = collection?.name
if (typeof testFile === 'string') {
const testRuntime = new TestRuntime({ runtime: scriptingConfig?.runtime });
- const testResults = await testRuntime.runTests(
- decomment(testFile),
- request,
- response,
- envVars,
- runtimeVariables,
- collectionPath,
- onConsoleLog,
- processEnvVars,
- scriptingConfig,
- runRequestByItemPathname
- );
+ let testResults = null;
+ let testError = null;
+
+ try {
+ testResults = await testRuntime.runTests(
+ decomment(testFile),
+ request,
+ response,
+ envVars,
+ runtimeVariables,
+ collectionPath,
+ onConsoleLog,
+ processEnvVars,
+ scriptingConfig,
+ runRequestByItemPathname,
+ collectionName
+ );
+ } catch (error) {
+ testError = error;
+
+ if (error.partialResults) {
+ testResults = error.partialResults;
+ } else {
+ testResults = {
+ request,
+ envVariables: envVars,
+ runtimeVariables,
+ globalEnvironmentVariables: request?.globalEnvironmentVariables || {},
+ results: [],
+ nextRequestName: null
+ };
+ }
+ }
!runInBackground && mainWindow.webContents.send('main:run-request-event', {
type: 'test-results',
@@ -735,9 +801,27 @@ const registerNetworkIpc = (mainWindow) => {
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;
+
+ !runInBackground && notifyScriptExecution({
+ channel: 'main:run-request-event',
+ basePayload: { requestUid, collectionUid, itemUid: item.uid },
+ scriptType: 'test',
+ error: testError
+ });
+
+ const domainsWithCookiesTest = await getDomainsWithCookies();
+ mainWindow.webContents.send('main:cookies-update', safeParseJSON(safeStringifyJSON(domainsWithCookiesTest)));
+ cookiesStore.saveCookieJar();
}
return {
@@ -745,102 +829,38 @@ const registerNetworkIpc = (mainWindow) => {
statusText: response.statusText,
headers: response.headers,
data: response.data,
- dataBuffer: dataBuffer.toString('base64'),
- size: Buffer.byteLength(dataBuffer),
- duration: responseTime ?? 0
+ dataBuffer: response.dataBuffer.toString('base64'),
+ size: Buffer.byteLength(response.dataBuffer),
+ duration: responseTime ?? 0,
+ url: response.request ? response.request.protocol + '//' + response.request.host + response.request.path : null,
+ timeline: response.timeline
};
} catch (error) {
deleteCancelToken(cancelTokenUid);
- return Promise.reject(error);
+ // we are not rejecting the promise here and instead returning a response object with `error` which is handled in the `send-http-request` invocation
+ // timeline prop won't be accessible in the usual way in the renderer process if we reject the promise
+ return {
+ status: error?.status,
+ error: error?.message || 'Error occured while executing the request!',
+ timeline: error?.timeline
+ };
}
}
// handler for sending http request
ipcMain.handle('send-http-request', async (event, item, collection, environment, runtimeVariables) => {
- return await runRequest({ item, collection, environment, runtimeVariables });
+ const collectionUid = collection.uid;
+ const envVars = getEnvVars(environment);
+ const processEnvVars = getProcessEnvVars(collectionUid);
+ return await runRequest({ item, collection, envVars, processEnvVars, runtimeVariables, runInBackground: false });
});
- ipcMain.handle('send-collection-oauth2-request', async (event, collection, environment, runtimeVariables) => {
- try {
- const collectionUid = collection.uid;
- const collectionPath = collection.pathname;
- const requestUid = uuid();
-
- const collectionRoot = get(collection, 'root', {});
- const _request = collectionRoot?.request;
- const request = prepareCollectionRequest(_request, collection, collectionPath);
- request.__bruno__executionMode = 'standalone';
- const envVars = getEnvVars(environment);
- const processEnvVars = getProcessEnvVars(collectionUid);
- const brunoConfig = getBrunoConfig(collectionUid);
- const scriptingConfig = get(brunoConfig, 'scripts', {});
- scriptingConfig.runtime = getJsSandboxRuntime(collection);
-
- await runPreRequest(
- request,
- requestUid,
- envVars,
- collectionPath,
- collectionRoot,
- collectionUid,
- runtimeVariables,
- processEnvVars,
- scriptingConfig
- );
-
- interpolateVars(request, envVars, collection.runtimeVariables, processEnvVars);
- const axiosInstance = await configureRequest(
- collection.uid,
- request,
- envVars,
- collection.runtimeVariables,
- processEnvVars,
- collectionPath
- );
-
- try {
- response = await axiosInstance(request);
- } catch (error) {
- if (error?.response) {
- response = error.response;
- } else {
- return Promise.reject(error);
- }
- }
-
- const { data } = parseDataFromResponse(response, request.__brunoDisableParsingResponseJson);
- response.data = data;
-
- await runPostResponse(
- request,
- response,
- requestUid,
- envVars,
- collectionPath,
- collectionRoot,
- collectionUid,
- runtimeVariables,
- processEnvVars,
- scriptingConfig
- );
-
- return {
- status: response.status,
- statusText: response.statusText,
- headers: response.headers,
- data: response.data
- };
- } catch (error) {
- return Promise.reject(error);
- }
- });
-
- ipcMain.handle('clear-oauth2-cache', async (event, uid) => {
+ ipcMain.handle('clear-oauth2-cache', async (event, uid, url, credentialsId) => {
return new Promise((resolve, reject) => {
try {
const oauth2Store = new Oauth2Store();
- oauth2Store.clearSessionIdOfCollection(uid);
+ oauth2Store.clearSessionIdOfCollection({ collectionUid: uid, url, credentialsId });
resolve();
} catch (err) {
reject(new Error('Could not clear oauth2 cache'));
@@ -860,88 +880,12 @@ const registerNetworkIpc = (mainWindow) => {
});
});
- ipcMain.handle('fetch-gql-schema', async (event, endpoint, environment, _request, collection) => {
- try {
- const envVars = getEnvVars(environment);
- const collectionRoot = get(collection, 'root', {});
- const request = prepareGqlIntrospectionRequest(endpoint, envVars, _request, collectionRoot);
-
- request.timeout = preferencesUtil.getRequestTimeout();
-
- if (!preferencesUtil.shouldVerifyTls()) {
- request.httpsAgent = new https.Agent({
- rejectUnauthorized: false
- });
- }
-
- const requestUid = uuid();
- const collectionPath = collection.pathname;
- const collectionUid = collection.uid;
- const runtimeVariables = collection.runtimeVariables;
- const processEnvVars = getProcessEnvVars(collectionUid);
- const brunoConfig = getBrunoConfig(collection.uid);
- const scriptingConfig = get(brunoConfig, 'scripts', {});
- scriptingConfig.runtime = getJsSandboxRuntime(collection);
-
- await runPreRequest(
- request,
- requestUid,
- envVars,
- collectionPath,
- collectionRoot,
- collectionUid,
- runtimeVariables,
- processEnvVars,
- scriptingConfig
- );
-
- interpolateVars(request, envVars, collection.runtimeVariables, processEnvVars);
- const axiosInstance = await configureRequest(
- collection.uid,
- request,
- envVars,
- collection.runtimeVariables,
- processEnvVars,
- collectionPath
- );
- const response = await axiosInstance(request);
-
- await runPostResponse(
- request,
- response,
- requestUid,
- envVars,
- collectionPath,
- collectionRoot,
- collectionUid,
- runtimeVariables,
- processEnvVars,
- scriptingConfig
- );
-
- return {
- status: response.status,
- statusText: response.statusText,
- headers: response.headers,
- data: response.data
- };
- } catch (error) {
- if (error.response) {
- return {
- status: error.response.status,
- statusText: error.response.statusText,
- headers: error.response.headers,
- data: error.response.data
- };
- }
-
- return Promise.reject(error);
- }
- });
+ // handler for fetch-gql-schema
+ ipcMain.handle('fetch-gql-schema', fetchGqlSchemaHandler)
ipcMain.handle(
'renderer:run-collection-folder',
- async (event, folder, collection, environment, runtimeVariables, recursive, delay) => {
+ async (event, folder, collection, environment, runtimeVariables, recursive, delay, tags) => {
const collectionUid = collection.uid;
const collectionPath = collection.pathname;
const folderUid = folder ? folder.uid : null;
@@ -949,7 +893,8 @@ const registerNetworkIpc = (mainWindow) => {
const brunoConfig = getBrunoConfig(collectionUid);
const scriptingConfig = get(brunoConfig, 'scripts', {});
scriptingConfig.runtime = getJsSandboxRuntime(collection);
- const collectionRoot = get(collection, 'root', {});
+ const envVars = getEnvVars(environment);
+ const processEnvVars = getProcessEnvVars(collectionUid);
let stopRunnerExecution = false;
const abortController = new AbortController();
@@ -961,9 +906,9 @@ const registerNetworkIpc = (mainWindow) => {
if (itemPathname && !itemPathname?.endsWith('.bru')) {
itemPathname = `${itemPathname}.bru`;
}
- const _item = findItemInCollectionByPathname(collection, itemPathname);
+ const _item = cloneDeep(findItemInCollectionByPathname(collection, itemPathname));
if(_item) {
- const res = await runRequest({ item: _item, collection, environment, runtimeVariables, runInBackground: true });
+ const res = await runRequest({ item: _item, collection, envVars, processEnvVars, runtimeVariables, runInBackground: true });
resolve(res);
}
reject(`bru.runRequest: invalid request path - ${itemPathname}`);
@@ -983,7 +928,6 @@ const registerNetworkIpc = (mainWindow) => {
});
try {
- const envVars = getEnvVars(environment);
let folderRequests = [];
if (recursive) {
@@ -996,9 +940,18 @@ const registerNetworkIpc = (mainWindow) => {
}
});
+
// sort requests by seq property
- folderRequests.sort((a, b) => {
- return a.seq - b.seq;
+ folderRequests = sortByNameThenSequence(folderRequests)
+ }
+
+ // Filter requests based on tags
+ if (tags && tags.include && tags.exclude) {
+ const includeTags = tags.include ? tags.include : [];
+ const excludeTags = tags.exclude ? tags.exclude : [];
+ folderRequests = folderRequests.filter(({ tags: requestTags = [], draft }) => {
+ requestTags = draft?.tags || requestTags || [];
+ return isRequestTagsIncluded(requestTags, includeTags, excludeTags)
});
}
@@ -1031,25 +984,71 @@ const registerNetworkIpc = (mainWindow) => {
...eventData
});
- const request = prepareRequest(item, collection);
+ // Skip gRPC requests
+ if (item.type === 'grpc-request') {
+ mainWindow.webContents.send('main:run-folder-event', {
+ type: 'runner-request-skipped',
+ error: 'gRPC requests are skipped in folder/collection runs',
+ responseReceived: {
+ status: 'skipped',
+ statusText: 'gRPC request skipped',
+ data: null,
+ responseTime: 0,
+ headers: null
+ },
+ ...eventData
+ });
+ currentRequestIndex++;
+ continue;
+ }
+
+ const request = await prepareRequest(item, collection, abortController);
request.__bruno__executionMode = 'runner';
const requestUid = uuid();
- const processEnvVars = getProcessEnvVars(collectionUid);
try {
- const preRequestScriptResult = await runPreRequest(
- request,
- requestUid,
- envVars,
- collectionPath,
- collectionRoot,
- collectionUid,
- runtimeVariables,
- processEnvVars,
- scriptingConfig,
- runRequestByItemPathname
- );
+ let preRequestScriptResult;
+ let preRequestError = null;
+ try {
+ preRequestScriptResult = await runPreRequest(
+ request,
+ requestUid,
+ envVars,
+ collectionPath,
+ collection,
+ collectionUid,
+ runtimeVariables,
+ processEnvVars,
+ scriptingConfig,
+ runRequestByItemPathname
+ );
+ } catch (error) {
+ console.error('Pre-request script error:', error);
+ preRequestError = error;
+ }
+
+ if (preRequestScriptResult?.results) {
+ mainWindow.webContents.send('main:run-folder-event', {
+ type: 'test-results-pre-request',
+ preRequestTestResults: preRequestScriptResult.results,
+ ...eventData
+ });
+ }
+
+ notifyScriptExecution({
+ channel: 'main:run-folder-event',
+ basePayload: eventData,
+ scriptType: 'pre-request',
+ error: preRequestError
+ });
+
+ const domainsWithCookiesPreRequest = await getDomainsWithCookies();
+ mainWindow.webContents.send('main:cookies-update', safeParseJSON(safeStringifyJSON(domainsWithCookiesPreRequest)));
+
+ if (preRequestError) {
+ throw preRequestError;
+ }
if (preRequestScriptResult?.nextRequestName !== undefined) {
nextRequestName = preRequestScriptResult.nextRequestName;
@@ -1066,7 +1065,9 @@ const registerNetworkIpc = (mainWindow) => {
responseReceived: {
status: 'skipped',
statusText: 'request skipped via pre-request script',
- data: null
+ data: null,
+ responseTime: 0,
+ headers: null
},
...eventData
});
@@ -1074,17 +1075,21 @@ const registerNetworkIpc = (mainWindow) => {
continue;
}
+ const { data: requestData, dataBuffer: requestDataBuffer } = parseDataFromRequest(request);
+ let requestSent = {
+ url: request.url,
+ method: request.method,
+ headers: request.headers,
+ data: requestData,
+ dataBuffer: requestDataBuffer
+ }
+
// todo:
// i have no clue why electron can't send the request object
// without safeParseJSON(safeStringifyJSON(request.data))
mainWindow.webContents.send('main:run-folder-event', {
type: 'request-sent',
- requestSent: {
- url: request.url,
- method: request.method,
- headers: request.headers,
- data: safeParseJSON(safeStringifyJSON(request.data))
- },
+ requestSent,
...eventData
});
@@ -1098,6 +1103,17 @@ const registerNetworkIpc = (mainWindow) => {
collectionPath
);
+ if (request?.oauth2Credentials) {
+ mainWindow.webContents.send('main:credentials-update', {
+ credentials: request?.oauth2Credentials?.credentials,
+ url: request?.oauth2Credentials?.url,
+ collectionUid,
+ credentialsId: request?.oauth2Credentials?.credentialsId,
+ ...(request?.oauth2Credentials?.folderUid ? { folderUid: request.oauth2Credentials.folderUid } : { itemUid: item.uid }),
+ debugInfo: request?.oauth2Credentials?.debugInfo,
+ });
+ }
+
timeStart = Date.now();
let response, responseTime;
try {
@@ -1119,7 +1135,9 @@ const registerNetworkIpc = (mainWindow) => {
const { data, dataBuffer } = parseDataFromResponse(response, request.__brunoDisableParsingResponseJson);
response.data = data;
+ response.dataBuffer = dataBuffer;
response.responseTime = response.headers.get('request-duration');
+ response.headers.delete('request-duration');
// save cookies
if (preferencesUtil.shouldStoreCookies()) {
@@ -1141,14 +1159,24 @@ const registerNetworkIpc = (mainWindow) => {
dataBuffer: dataBuffer.toString('base64'),
size: Buffer.byteLength(dataBuffer),
data: response.data,
- responseTime: response.headers.get('request-duration')
+ responseTime: response.responseTime,
+ timeline: response.timeline,
+ url: response.request ? response.request.protocol + '//' + response.request.host + response.request.path : null
},
...eventData
});
} catch (error) {
- if (error?.response && !axios.isCancel(error)) {
+ // Skip further processing if request was cancelled
+ if (axios.isCancel(error)) {
+ throw error;
+ }
+
+ if (error?.response) {
const { data, dataBuffer } = parseDataFromResponse(error.response);
+ error.response.responseTime = error.response.headers.get('request-duration');
+ error.response.headers.delete('request-duration');
error.response.data = data;
+ error.response.dataBuffer = dataBuffer;
timeEnd = Date.now();
response = {
@@ -1159,7 +1187,8 @@ const registerNetworkIpc = (mainWindow) => {
dataBuffer: dataBuffer.toString('base64'),
size: Buffer.byteLength(dataBuffer),
data: error.response.data,
- responseTime: error.response.headers.get('request-duration')
+ responseTime: error.response.responseTime,
+ timeline: error.response.timeline,
};
// if we get a response from the server, we consider it as a success
@@ -1170,33 +1199,61 @@ const registerNetworkIpc = (mainWindow) => {
...eventData
});
} else {
+ await executeRequestOnFailHandler(request, error);
+
// if it's not a network error, don't continue
- throw Promise.reject(error);
+ throw error;
}
}
- const postRequestScriptResult = await runPostResponse(
- request,
- response,
- requestUid,
- envVars,
- collectionPath,
- collectionRoot,
- collectionUid,
- runtimeVariables,
- processEnvVars,
- scriptingConfig,
- runRequestByItemPathname
- );
-
- if (postRequestScriptResult?.nextRequestName !== undefined) {
- nextRequestName = postRequestScriptResult.nextRequestName;
+ let postResponseScriptResult;
+ let postResponseError = null;
+ try {
+ postResponseScriptResult = await runPostResponse(
+ request,
+ response,
+ requestUid,
+ envVars,
+ collectionPath,
+ collection,
+ collectionUid,
+ runtimeVariables,
+ processEnvVars,
+ scriptingConfig,
+ runRequestByItemPathname
+ );
+ } catch (error) {
+ console.error('Post-response script error:', error);
+ postResponseError = error;
}
- if (postRequestScriptResult?.stopExecution) {
+ notifyScriptExecution({
+ channel: 'main:run-folder-event',
+ basePayload: eventData,
+ scriptType: 'post-response',
+ error: postResponseError
+ });
+
+ const domainsWithCookiesPostResponse = await getDomainsWithCookies();
+ mainWindow.webContents.send('main:cookies-update', safeParseJSON(safeStringifyJSON(domainsWithCookiesPostResponse)));
+
+ if (postResponseScriptResult?.nextRequestName !== undefined) {
+ nextRequestName = postResponseScriptResult.nextRequestName;
+ }
+
+ if (postResponseScriptResult?.stopExecution) {
stopRunnerExecution = true;
}
+ // Send post-response test results if available
+ if (postResponseScriptResult?.results) {
+ mainWindow.webContents.send('main:run-folder-event', {
+ type: 'test-results-post-response',
+ postResponseTestResults: postResponseScriptResult.results,
+ ...eventData
+ });
+ }
+
// run assertions
const assertions = get(item, 'request.assertions');
if (assertions) {
@@ -1219,20 +1276,42 @@ const registerNetworkIpc = (mainWindow) => {
}
const testFile = get(request, 'tests');
+ const collectionName = collection?.name
if (typeof testFile === 'string') {
- const testRuntime = new TestRuntime({ runtime: scriptingConfig?.runtime });
- const testResults = await testRuntime.runTests(
- decomment(testFile),
- request,
- response,
- envVars,
- runtimeVariables,
- collectionPath,
- onConsoleLog,
- processEnvVars,
- scriptingConfig,
- runRequestByItemPathname
- );
+ let testResults = null;
+ let testError = null;
+
+ try {
+ const testRuntime = new TestRuntime({ runtime: scriptingConfig?.runtime });
+ testResults = await testRuntime.runTests(
+ decomment(testFile),
+ request,
+ response,
+ envVars,
+ runtimeVariables,
+ collectionPath,
+ onConsoleLog,
+ processEnvVars,
+ scriptingConfig,
+ runRequestByItemPathname,
+ collectionName
+ );
+ } catch (error) {
+ testError = error;
+
+ if (error.partialResults) {
+ testResults = error.partialResults;
+ } else {
+ testResults = {
+ request,
+ envVariables: envVars,
+ runtimeVariables,
+ globalEnvironmentVariables: request?.globalEnvironmentVariables || {},
+ results: [],
+ nextRequestName: null
+ };
+ }
+ }
if (testResults?.nextRequestName !== undefined) {
nextRequestName = testResults.nextRequestName;
@@ -1253,6 +1332,18 @@ const registerNetworkIpc = (mainWindow) => {
mainWindow.webContents.send('main:global-environment-variables-update', {
globalEnvironmentVariables: testResults.globalEnvironmentVariables
});
+
+ collection.globalEnvironmentVariables = testResults.globalEnvironmentVariables;
+
+ notifyScriptExecution({
+ channel: 'main:run-folder-event',
+ basePayload: eventData,
+ scriptType: 'test',
+ error: testError
+ });
+
+ const domainsWithCookiesTest = await getDomainsWithCookies();
+ mainWindow.webContents.send('main:cookies-update', safeParseJSON(safeStringifyJSON(domainsWithCookiesTest)));
}
} catch (error) {
mainWindow.webContents.send('main:run-folder-event', {
@@ -1301,6 +1392,7 @@ const registerNetworkIpc = (mainWindow) => {
folderUid
});
} catch (error) {
+ console.log("error", error);
deleteCancelToken(cancelTokenUid);
mainWindow.webContents.send('main:run-folder-event', {
type: 'testrun-ended',
@@ -1367,7 +1459,7 @@ const registerNetworkIpc = (mainWindow) => {
if (encoding === 'utf-8') {
await writeFile(filePath, data);
} else {
- await writeBinaryFile(filePath, data);
+ await writeFile(filePath, data, true);
}
}
} catch (error) {
@@ -1376,5 +1468,33 @@ const registerNetworkIpc = (mainWindow) => {
});
};
-module.exports = registerNetworkIpc;
+/**
+ * Executes the custom error handler if it exists on the request
+ * @param {Object} request - The request object that may contain an onFailHandler
+ * @param {Error} error - The error that occurred
+ */
+const executeRequestOnFailHandler = async (request, error) => {
+ if (!request || typeof request.onFailHandler !== 'function') {
+ return;
+ }
+
+ try {
+ await request.onFailHandler(error);
+ } catch (handlerError) {
+ console.error('Error executing onFail handler', handlerError);
+ // @TODO: This is a temporary solution to display the error message in the response pane. Revisit and handle properly.
+ error.message = `1. Request failed: ${error.message || 'Error occured while executing the request!'}\n2. Error executing onFail handler: ${handlerError.message || 'Unknown error'}`;
+ }
+};
+
+
+const registerAllNetworkIpc = (mainWindow) => {
+ registerNetworkIpc(mainWindow);
+ registerGrpcEventHandlers(mainWindow);
+}
+
+module.exports = registerAllNetworkIpc
module.exports.configureRequest = configureRequest;
+module.exports.getCertsAndProxyConfig = getCertsAndProxyConfig;
+module.exports.fetchGqlSchemaHandler = fetchGqlSchemaHandler;
+module.exports.executeRequestOnFailHandler = executeRequestOnFailHandler;
diff --git a/packages/bruno-electron/src/ipc/network/interpolate-vars.js b/packages/bruno-electron/src/ipc/network/interpolate-vars.js
index 2b46327af..4aef1e73f 100644
--- a/packages/bruno-electron/src/ipc/network/interpolate-vars.js
+++ b/packages/bruno-electron/src/ipc/network/interpolate-vars.js
@@ -15,6 +15,7 @@ const getContentType = (headers = {}) => {
const interpolateVars = (request, envVariables = {}, runtimeVariables = {}, processEnvVars = {}) => {
const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
+ const oauth2CredentialVariables = request?.oauth2CredentialVariables || {};
const collectionVariables = request?.collectionVariables || {};
const folderVariables = request?.folderVariables || {};
const requestVariables = request?.requestVariables || {};
@@ -27,13 +28,12 @@ const interpolateVars = (request, envVariables = {}, runtimeVariables = {}, proc
envVariables[key] = interpolate(value, {
process: {
env: {
- ...processEnvVars
}
}
});
});
- const _interpolate = (str) => {
+ const _interpolate = (str, { escapeJSONStrings } = {}) => {
if (!str || !str.length || typeof str !== 'string') {
return str;
}
@@ -45,6 +45,7 @@ const interpolateVars = (request, envVariables = {}, runtimeVariables = {}, proc
...envVariables,
...folderVariables,
...requestVariables,
+ ...oauth2CredentialVariables,
...runtimeVariables,
process: {
env: {
@@ -53,7 +54,9 @@ const interpolateVars = (request, envVariables = {}, runtimeVariables = {}, proc
}
};
- return interpolate(str, combinedVars);
+ return interpolate(str, combinedVars, {
+ escapeJSONStrings
+ });
};
request.url = _interpolate(request.url);
@@ -64,38 +67,57 @@ const interpolateVars = (request, envVariables = {}, runtimeVariables = {}, proc
});
const contentType = getContentType(request.headers);
+ const isGrpcBody = request.mode === 'grpc';
- if (contentType.includes('json')) {
- if (typeof request.data === 'string') {
- if (request.data.length) {
- request.data = _interpolate(request.data);
- }
- } else if (typeof request.data === 'object') {
- try {
- let parsed = JSON.stringify(request.data);
- parsed = _interpolate(parsed);
- request.data = JSON.parse(parsed);
- } catch (err) {}
- }
- } else if (contentType === 'application/x-www-form-urlencoded') {
- if (typeof request.data === 'object') {
- try {
- forOwn(request?.data, (value, key) => {
- request.data[key] = _interpolate(value);
+ if (isGrpcBody) {
+ const jsonDoc = JSON.stringify(request.body);
+ const parsed = _interpolate(jsonDoc, {
+ escapeJSONStrings: true
+ });
+ request.body = JSON.parse(parsed);
+ }
+
+ if (typeof contentType === 'string') {
+ /*
+ We explicitly avoid interpolating buffer values because the file content is read as a buffer object in raw body mode.
+ Even if the selected file's content type is JSON, this prevents the buffer object from being interpolated.
+ */
+ if (contentType.includes('json') && !Buffer.isBuffer(request.data)) {
+ if (typeof request.data === 'string') {
+ if (request.data.length) {
+ request.data = _interpolate(request.data, {
+ escapeJSONStrings: true
});
- } catch (err) {}
+ }
+ } else if (typeof request.data === 'object') {
+ try {
+ const jsonDoc = JSON.stringify(request.data);
+ const parsed = _interpolate(jsonDoc, {
+ escapeJSONStrings: true
+ });
+ request.data = JSON.parse(parsed);
+ } catch (err) {}
+ }
+ } else if (contentType === 'application/x-www-form-urlencoded') {
+ if (typeof request.data === 'object') {
+ try {
+ forOwn(request?.data, (value, key) => {
+ request.data[key] = _interpolate(value);
+ });
+ } catch (err) {}
+ }
+ } else if (contentType === 'multipart/form-data') {
+ if (Array.isArray(request?.data) && !(request.data instanceof FormData)) {
+ try {
+ request.data = request?.data?.map(d => ({
+ ...d,
+ value: _interpolate(d?.value)
+ }));
+ } catch (err) {}
+ }
+ } else {
+ request.data = _interpolate(request.data);
}
- } else if (contentType === 'multipart/form-data') {
- if (Array.isArray(request?.data) && !(request.data instanceof FormData)) {
- try {
- request.data = request?.data?.map(d => ({
- ...d,
- value: _interpolate(d?.value)
- }));
- } catch (err) {}
- }
- } else {
- request.data = _interpolate(request.data);
}
each(request.pathParams, (param) => {
@@ -147,66 +169,113 @@ const interpolateVars = (request, envVariables = {}, runtimeVariables = {}, proc
// todo: we have things happening in two places w.r.t basic auth
// need to refactor this in the future
// the request.auth (basic auth) object gets set inside the prepare-request.js file
- if (request.auth) {
- const username = _interpolate(request.auth.username) || '';
- const password = _interpolate(request.auth.password) || '';
+ if (request.basicAuth) {
+ const username = _interpolate(request.basicAuth.username) || '';
+ const password = _interpolate(request.basicAuth.password) || '';
// use auth header based approach and delete the request.auth object
request.headers['Authorization'] = `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`;
- delete request.auth;
+ delete request.basicAuth;
}
if (request?.oauth2?.grantType) {
let username, password, scope, clientId, clientSecret;
switch (request.oauth2.grantType) {
case 'password':
- username = _interpolate(request.oauth2.username) || '';
- password = _interpolate(request.oauth2.password) || '';
- clientId = _interpolate(request.oauth2.clientId) || '';
- clientSecret = _interpolate(request.oauth2.clientSecret) || '';
- scope = _interpolate(request.oauth2.scope) || '';
request.oauth2.accessTokenUrl = _interpolate(request.oauth2.accessTokenUrl) || '';
- request.oauth2.username = username;
- request.oauth2.password = password;
- request.oauth2.clientId = clientId;
- request.oauth2.clientSecret = clientSecret;
- request.oauth2.scope = scope;
- request.data = {
- grant_type: 'password',
- username,
- password,
- client_id: clientId,
- client_secret: clientSecret,
- scope
- };
+ request.oauth2.refreshTokenUrl = _interpolate(request.oauth2.refreshTokenUrl) || '';
+ request.oauth2.username = _interpolate(request.oauth2.username) || '';
+ request.oauth2.password = _interpolate(request.oauth2.password) || '';
+ request.oauth2.clientId = _interpolate(request.oauth2.clientId) || '';
+ request.oauth2.clientSecret = _interpolate(request.oauth2.clientSecret) || '';
+ request.oauth2.scope = _interpolate(request.oauth2.scope) || '';
+ request.oauth2.credentialsPlacement = _interpolate(request.oauth2.credentialsPlacement) || '';
+ request.oauth2.credentialsId = _interpolate(request.oauth2.credentialsId) || '';
+ request.oauth2.tokenPlacement = _interpolate(request.oauth2.tokenPlacement) || '';
+ request.oauth2.tokenHeaderPrefix = _interpolate(request.oauth2.tokenHeaderPrefix) || '';
+ request.oauth2.tokenQueryKey = _interpolate(request.oauth2.tokenQueryKey) || '';
+ request.oauth2.autoFetchToken = _interpolate(request.oauth2.autoFetchToken);
+ request.oauth2.autoRefreshToken = _interpolate(request.oauth2.autoRefreshToken);
+ break;
+ case 'implicit':
+ request.oauth2.callbackUrl = _interpolate(request.oauth2.callbackUrl) || '';
+ request.oauth2.authorizationUrl = _interpolate(request.oauth2.authorizationUrl) || '';
+ request.oauth2.clientId = _interpolate(request.oauth2.clientId) || '';
+ request.oauth2.scope = _interpolate(request.oauth2.scope) || '';
+ request.oauth2.state = _interpolate(request.oauth2.state) || '';
+ request.oauth2.credentialsId = _interpolate(request.oauth2.credentialsId) || '';
+ request.oauth2.tokenPlacement = _interpolate(request.oauth2.tokenPlacement) || '';
+ request.oauth2.tokenHeaderPrefix = _interpolate(request.oauth2.tokenHeaderPrefix) || '';
+ request.oauth2.tokenQueryKey = _interpolate(request.oauth2.tokenQueryKey) || '';
+ request.oauth2.autoFetchToken = _interpolate(request.oauth2.autoFetchToken);
break;
case 'authorization_code':
request.oauth2.callbackUrl = _interpolate(request.oauth2.callbackUrl) || '';
request.oauth2.authorizationUrl = _interpolate(request.oauth2.authorizationUrl) || '';
request.oauth2.accessTokenUrl = _interpolate(request.oauth2.accessTokenUrl) || '';
+ request.oauth2.refreshTokenUrl = _interpolate(request.oauth2.refreshTokenUrl) || '';
request.oauth2.clientId = _interpolate(request.oauth2.clientId) || '';
request.oauth2.clientSecret = _interpolate(request.oauth2.clientSecret) || '';
request.oauth2.scope = _interpolate(request.oauth2.scope) || '';
request.oauth2.state = _interpolate(request.oauth2.state) || '';
request.oauth2.pkce = _interpolate(request.oauth2.pkce) || false;
+ request.oauth2.credentialsPlacement = _interpolate(request.oauth2.credentialsPlacement) || '';
+ request.oauth2.credentialsId = _interpolate(request.oauth2.credentialsId) || '';
+ request.oauth2.tokenPlacement = _interpolate(request.oauth2.tokenPlacement) || '';
+ request.oauth2.tokenHeaderPrefix = _interpolate(request.oauth2.tokenHeaderPrefix) || '';
+ request.oauth2.tokenQueryKey = _interpolate(request.oauth2.tokenQueryKey) || '';
+ request.oauth2.autoFetchToken = _interpolate(request.oauth2.autoFetchToken);
+ request.oauth2.autoRefreshToken = _interpolate(request.oauth2.autoRefreshToken);
break;
case 'client_credentials':
- clientId = _interpolate(request.oauth2.clientId) || '';
- clientSecret = _interpolate(request.oauth2.clientSecret) || '';
- scope = _interpolate(request.oauth2.scope) || '';
request.oauth2.accessTokenUrl = _interpolate(request.oauth2.accessTokenUrl) || '';
- request.oauth2.clientId = clientId;
- request.oauth2.clientSecret = clientSecret;
- request.oauth2.scope = scope;
- request.data = {
- grant_type: 'client_credentials',
- client_id: clientId,
- client_secret: clientSecret,
- scope
- };
+ request.oauth2.refreshTokenUrl = _interpolate(request.oauth2.refreshTokenUrl) || '';
+ request.oauth2.clientId = _interpolate(request.oauth2.clientId) || '';
+ request.oauth2.clientSecret = _interpolate(request.oauth2.clientSecret) || '';
+ request.oauth2.scope = _interpolate(request.oauth2.scope) || '';
+ request.oauth2.credentialsPlacement = _interpolate(request.oauth2.credentialsPlacement) || '';
+ request.oauth2.credentialsId = _interpolate(request.oauth2.credentialsId) || '';
+ request.oauth2.tokenPlacement = _interpolate(request.oauth2.tokenPlacement) || '';
+ request.oauth2.tokenHeaderPrefix = _interpolate(request.oauth2.tokenHeaderPrefix) || '';
+ request.oauth2.tokenQueryKey = _interpolate(request.oauth2.tokenQueryKey) || '';
+ request.oauth2.autoFetchToken = _interpolate(request.oauth2.autoFetchToken);
+ request.oauth2.autoRefreshToken = _interpolate(request.oauth2.autoRefreshToken);
break;
default:
break;
}
+
+ // Interpolate additional parameters for all OAuth2 grant types
+ if (request.oauth2.additionalParameters) {
+ // Interpolate authorization parameters
+ if (Array.isArray(request.oauth2.additionalParameters.authorization)) {
+ request.oauth2.additionalParameters.authorization.forEach(param => {
+ if (param && param.enabled !== false) {
+ param.name = _interpolate(param.name) || '';
+ param.value = _interpolate(param.value) || '';
+ }
+ });
+ }
+
+ // Interpolate token parameters
+ if (Array.isArray(request.oauth2.additionalParameters.token)) {
+ request.oauth2.additionalParameters.token.forEach(param => {
+ if (param && param.enabled !== false) {
+ param.name = _interpolate(param.name) || '';
+ param.value = _interpolate(param.value) || '';
+ }
+ });
+ }
+
+ // Interpolate refresh parameters
+ if (Array.isArray(request.oauth2.additionalParameters.refresh)) {
+ request.oauth2.additionalParameters.refresh.forEach(param => {
+ if (param && param.enabled !== false) {
+ param.name = _interpolate(param.name) || '';
+ param.value = _interpolate(param.value) || '';
+ }
+ });
+ }
+ }
}
// interpolate vars for aws sigv4 auth
@@ -231,7 +300,6 @@ const interpolateVars = (request, envVariables = {}, runtimeVariables = {}, proc
request.wsse.password = _interpolate(request.wsse.password) || '';
}
-
// interpolate vars for ntlmConfig auth
if (request.ntlmConfig) {
request.ntlmConfig.username = _interpolate(request.ntlmConfig.username) || '';
@@ -239,6 +307,8 @@ const interpolateVars = (request, envVariables = {}, runtimeVariables = {}, proc
request.ntlmConfig.domain = _interpolate(request.ntlmConfig.domain) || '';
}
+ if(request?.auth) delete request.auth;
+
return request;
};
diff --git a/packages/bruno-electron/src/ipc/network/oauth2-helper.js b/packages/bruno-electron/src/ipc/network/oauth2-helper.js
deleted file mode 100644
index 144542418..000000000
--- a/packages/bruno-electron/src/ipc/network/oauth2-helper.js
+++ /dev/null
@@ -1,129 +0,0 @@
-const { get, cloneDeep } = require('lodash');
-const crypto = require('crypto');
-const { authorizeUserInWindow } = require('./authorize-user-in-window');
-const Oauth2Store = require('../../store/oauth2');
-
-const generateCodeVerifier = () => {
- return crypto.randomBytes(22).toString('hex');
-};
-
-const generateCodeChallenge = (codeVerifier) => {
- const hash = crypto.createHash('sha256');
- hash.update(codeVerifier);
- const base64Hash = hash.digest('base64');
- return base64Hash.replace(/\+/g, '-').replace(/\//g, '_').replace(/=/g, '');
-};
-
-// AUTHORIZATION CODE
-
-const resolveOAuth2AuthorizationCodeAccessToken = async (request, collectionUid) => {
- let codeVerifier = generateCodeVerifier();
- let codeChallenge = generateCodeChallenge(codeVerifier);
-
- let requestCopy = cloneDeep(request);
- const { authorizationCode } = await getOAuth2AuthorizationCode(requestCopy, codeChallenge, collectionUid);
- const oAuth = get(requestCopy, 'oauth2', {});
- const { clientId, clientSecret, callbackUrl, scope, pkce } = oAuth;
- const data = {
- grant_type: 'authorization_code',
- code: authorizationCode,
- redirect_uri: callbackUrl,
- client_id: clientId,
- client_secret: clientSecret
- };
- if (pkce) {
- data['code_verifier'] = codeVerifier;
- }
-
- const url = requestCopy?.oauth2?.accessTokenUrl;
- return {
- data,
- url
- };
-};
-
-const getOAuth2AuthorizationCode = (request, codeChallenge, collectionUid) => {
- return new Promise(async (resolve, reject) => {
- const { oauth2 } = request;
- const { callbackUrl, clientId, authorizationUrl, scope, state, pkce } = oauth2;
-
- const authorizationUrlWithQueryParams = new URL(authorizationUrl);
- authorizationUrlWithQueryParams.searchParams.append('response_type', 'code');
- authorizationUrlWithQueryParams.searchParams.append('client_id', clientId);
- if (callbackUrl) {
- authorizationUrlWithQueryParams.searchParams.append('redirect_uri', callbackUrl);
- }
- if (scope) {
- authorizationUrlWithQueryParams.searchParams.append('scope', scope);
- }
- if (pkce) {
- authorizationUrlWithQueryParams.searchParams.append('code_challenge', codeChallenge);
- authorizationUrlWithQueryParams.searchParams.append('code_challenge_method', 'S256');
- }
- if (state) {
- authorizationUrlWithQueryParams.searchParams.append('state', state);
- }
- try {
- const oauth2Store = new Oauth2Store();
- const { authorizationCode } = await authorizeUserInWindow({
- authorizeUrl: authorizationUrlWithQueryParams.toString(),
- callbackUrl,
- session: oauth2Store.getSessionIdOfCollection(collectionUid)
- });
- resolve({ authorizationCode });
- } catch (err) {
- reject(err);
- }
- });
-};
-
-// CLIENT CREDENTIALS
-
-const transformClientCredentialsRequest = async (request) => {
- let requestCopy = cloneDeep(request);
- const oAuth = get(requestCopy, 'oauth2', {});
- const { clientId, clientSecret, scope } = oAuth;
- const data = {
- grant_type: 'client_credentials',
- client_id: clientId,
- client_secret: clientSecret
- };
- if (scope) {
- data.scope = scope;
- }
- const url = requestCopy?.oauth2?.accessTokenUrl;
- return {
- data,
- url
- };
-};
-
-// PASSWORD CREDENTIALS
-
-const transformPasswordCredentialsRequest = async (request) => {
- let requestCopy = cloneDeep(request);
- const oAuth = get(requestCopy, 'oauth2', {});
- const { username, password, clientId, clientSecret, scope } = oAuth;
- const data = {
- grant_type: 'password',
- username,
- password,
- client_id: clientId,
- client_secret: clientSecret
- };
- if (scope) {
- data.scope = scope;
- }
- const url = requestCopy?.oauth2?.accessTokenUrl;
- return {
- data,
- url
- };
-};
-
-module.exports = {
- resolveOAuth2AuthorizationCodeAccessToken,
- getOAuth2AuthorizationCode,
- transformClientCredentialsRequest,
- transformPasswordCredentialsRequest
-};
diff --git a/packages/bruno-electron/src/ipc/network/prepare-collection-request.js b/packages/bruno-electron/src/ipc/network/prepare-collection-request.js
deleted file mode 100644
index e4d06c625..000000000
--- a/packages/bruno-electron/src/ipc/network/prepare-collection-request.js
+++ /dev/null
@@ -1,52 +0,0 @@
-const { get, each } = require('lodash');
-const { setAuthHeaders } = require('./prepare-request');
-
-const prepareCollectionRequest = (request, collection) => {
- const collectionRoot = get(collection, 'root', {});
- const headers = {};
- let contentTypeDefined = false;
- let url = request.url;
-
- // collection headers
- each(get(collectionRoot, 'request.headers', []), (h) => {
- if (h.enabled) {
- headers[h.name] = h.value;
- if (h.name.toLowerCase() === 'content-type') {
- contentTypeDefined = true;
- }
- }
- });
-
- each(request.headers, (h) => {
- if (h.enabled) {
- headers[h.name] = h.value;
- if (h.name.toLowerCase() === 'content-type') {
- contentTypeDefined = true;
- }
- }
- });
-
- let axiosRequest = {
- mode: request?.body?.mode,
- method: request.method,
- url,
- headers,
- responseType: 'arraybuffer'
- };
-
- axiosRequest = setAuthHeaders(axiosRequest, request, collectionRoot);
-
- axiosRequest.globalEnvironmentVariables = collection?.globalEnvironmentVariables;
-
- if (request.script) {
- axiosRequest.script = request.script;
- }
-
- axiosRequest.vars = request.vars;
-
- axiosRequest.method = 'POST';
-
- return axiosRequest;
-};
-
-module.exports = prepareCollectionRequest;
diff --git a/packages/bruno-electron/src/ipc/network/prepare-gql-introspection-request.js b/packages/bruno-electron/src/ipc/network/prepare-gql-introspection-request.js
index c137c4b33..158a71dc6 100644
--- a/packages/bruno-electron/src/ipc/network/prepare-gql-introspection-request.js
+++ b/packages/bruno-electron/src/ipc/network/prepare-gql-introspection-request.js
@@ -3,9 +3,9 @@ const { interpolate } = require('@usebruno/common');
const { getIntrospectionQuery } = require('graphql');
const { setAuthHeaders } = require('./prepare-request');
-const prepareGqlIntrospectionRequest = (endpoint, envVars, request, collectionRoot) => {
+const prepareGqlIntrospectionRequest = (endpoint, resolvedVars, request, collectionRoot) => {
if (endpoint && endpoint.length) {
- endpoint = interpolate(endpoint, envVars);
+ endpoint = interpolate(endpoint, resolvedVars);
}
const queryParams = {
@@ -16,7 +16,7 @@ const prepareGqlIntrospectionRequest = (endpoint, envVars, request, collectionRo
method: 'POST',
url: endpoint,
headers: {
- ...mapHeaders(request.headers, get(collectionRoot, 'request.headers', [])),
+ ...mapHeaders(request.headers, get(collectionRoot, 'request.headers', []), resolvedVars),
Accept: 'application/json',
'Content-Type': 'application/json'
},
@@ -26,19 +26,20 @@ const prepareGqlIntrospectionRequest = (endpoint, envVars, request, collectionRo
return setAuthHeaders(axiosRequest, request, collectionRoot);
};
-const mapHeaders = (requestHeaders, collectionHeaders) => {
+const mapHeaders = (requestHeaders, collectionHeaders, resolvedVars) => {
const headers = {};
- each(requestHeaders, (h) => {
+ // Add collection headers first
+ each(collectionHeaders, (h) => {
if (h.enabled) {
- headers[h.name] = h.value;
+ headers[h.name] = interpolate(h.value, resolvedVars);
}
});
- // collection headers
- each(collectionHeaders, (h) => {
+ // Then add request headers, which will overwrite if names overlap
+ each(requestHeaders, (h) => {
if (h.enabled) {
- headers[h.name] = h.value;
+ headers[h.name] = interpolate(h.value, resolvedVars);
}
});
diff --git a/packages/bruno-electron/src/ipc/network/prepare-request.js b/packages/bruno-electron/src/ipc/network/prepare-request.js
index 6c7672e7d..375422164 100644
--- a/packages/bruno-electron/src/ipc/network/prepare-request.js
+++ b/packages/bruno-electron/src/ipc/network/prepare-request.js
@@ -1,11 +1,12 @@
-const { get, each, filter } = require('lodash');
+const { get, each, filter, find } = require('lodash');
const decomment = require('decomment');
const crypto = require('node:crypto');
-const { getTreePathFromCollectionToItem, mergeHeaders, mergeScripts, mergeVars } = require('../../utils/collection');
-const { buildFormUrlEncodedPayload, createFormData } = require('../../utils/form-data');
+const fs = require('node:fs/promises');
+const { getTreePathFromCollectionToItem, mergeHeaders, mergeScripts, mergeVars, getFormattedCollectionOauth2Credentials, mergeAuth } = require('../../utils/collection');
+const { buildFormUrlEncodedPayload } = require('../../utils/form-data');
+const path = require('node:path');
const setAuthHeaders = (axiosRequest, request, collectionRoot) => {
-
const collectionAuth = get(collectionRoot, 'request.auth');
if (collectionAuth && request.auth.mode === 'inherit') {
switch (collectionAuth.mode) {
@@ -20,13 +21,13 @@ const setAuthHeaders = (axiosRequest, request, collectionRoot) => {
};
break;
case 'basic':
- axiosRequest.auth = {
+ axiosRequest.basicAuth = {
username: get(collectionAuth, 'basic.username'),
password: get(collectionAuth, 'basic.password')
};
break;
case 'bearer':
- axiosRequest.headers['Authorization'] = `Bearer ${get(collectionAuth, 'bearer.token')}`;
+ axiosRequest.headers['Authorization'] = `Bearer ${get(collectionAuth, 'bearer.token', '')}`;
break;
case 'digest':
axiosRequest.digestConfig = {
@@ -40,7 +41,7 @@ const setAuthHeaders = (axiosRequest, request, collectionRoot) => {
password: get(collectionAuth, 'ntlm.password'),
domain: get(collectionAuth, 'ntlm.domain')
};
- break;
+ break;
case 'wsse':
const username = get(request, 'auth.wsse.username', '');
const password = get(request, 'auth.wsse.password', '');
@@ -60,6 +61,7 @@ const setAuthHeaders = (axiosRequest, request, collectionRoot) => {
break;
case 'apikey':
const apiKeyAuth = get(collectionAuth, 'apikey');
+ if (apiKeyAuth.key.length === 0) break;
if (apiKeyAuth.placement === 'header') {
axiosRequest.headers[apiKeyAuth.key] = apiKeyAuth.value;
} else if (apiKeyAuth.placement === 'queryparams') {
@@ -67,6 +69,87 @@ const setAuthHeaders = (axiosRequest, request, collectionRoot) => {
axiosRequest.apiKeyAuthValueForQueryParams = apiKeyAuth;
}
break;
+ case 'oauth2':
+ const grantType = get(collectionAuth, 'oauth2.grantType');
+ switch (grantType) {
+ case 'password':
+ axiosRequest.oauth2 = {
+ grantType: grantType,
+ accessTokenUrl: get(collectionAuth, 'oauth2.accessTokenUrl'),
+ refreshTokenUrl: get(collectionAuth, 'oauth2.refreshTokenUrl'),
+ username: get(collectionAuth, 'oauth2.username'),
+ password: get(collectionAuth, 'oauth2.password'),
+ clientId: get(collectionAuth, 'oauth2.clientId'),
+ clientSecret: get(collectionAuth, 'oauth2.clientSecret'),
+ scope: get(collectionAuth, 'oauth2.scope'),
+ credentialsPlacement: get(collectionAuth, 'oauth2.credentialsPlacement'),
+ credentialsId: get(collectionAuth, 'oauth2.credentialsId'),
+ tokenPlacement: get(collectionAuth, 'oauth2.tokenPlacement'),
+ tokenHeaderPrefix: get(collectionAuth, 'oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(collectionAuth, 'oauth2.tokenQueryKey'),
+ autoFetchToken: get(collectionAuth, 'oauth2.autoFetchToken'),
+ autoRefreshToken: get(collectionAuth, 'oauth2.autoRefreshToken'),
+ additionalParameters: get(collectionAuth, 'oauth2.additionalParameters', { authorization: [], token: [], refresh: [] })
+ };
+ break;
+ case 'authorization_code':
+ axiosRequest.oauth2 = {
+ grantType: grantType,
+ callbackUrl: get(collectionAuth, 'oauth2.callbackUrl'),
+ authorizationUrl: get(collectionAuth, 'oauth2.authorizationUrl'),
+ accessTokenUrl: get(collectionAuth, 'oauth2.accessTokenUrl'),
+ refreshTokenUrl: get(collectionAuth, 'oauth2.refreshTokenUrl'),
+ clientId: get(collectionAuth, 'oauth2.clientId'),
+ clientSecret: get(collectionAuth, 'oauth2.clientSecret'),
+ scope: get(collectionAuth, 'oauth2.scope'),
+ state: get(collectionAuth, 'oauth2.state'),
+ pkce: get(collectionAuth, 'oauth2.pkce'),
+ credentialsPlacement: get(collectionAuth, 'oauth2.credentialsPlacement'),
+ credentialsId: get(collectionAuth, 'oauth2.credentialsId'),
+ tokenPlacement: get(collectionAuth, 'oauth2.tokenPlacement'),
+ tokenHeaderPrefix: get(collectionAuth, 'oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(collectionAuth, 'oauth2.tokenQueryKey'),
+ autoFetchToken: get(collectionAuth, 'oauth2.autoFetchToken'),
+ autoRefreshToken: get(collectionAuth, 'oauth2.autoRefreshToken'),
+ additionalParameters: get(collectionAuth, 'oauth2.additionalParameters', { authorization: [], token: [], refresh: [] })
+ };
+ break;
+ case 'implicit':
+ axiosRequest.oauth2 = {
+ grantType: grantType,
+ callbackUrl: get(collectionAuth, 'oauth2.callbackUrl'),
+ authorizationUrl: get(collectionAuth, 'oauth2.authorizationUrl'),
+ clientId: get(collectionAuth, 'oauth2.clientId'),
+ scope: get(collectionAuth, 'oauth2.scope'),
+ state: get(collectionAuth, 'oauth2.state'),
+ credentialsId: get(collectionAuth, 'oauth2.credentialsId'),
+ tokenPlacement: get(collectionAuth, 'oauth2.tokenPlacement'),
+ tokenHeaderPrefix: get(collectionAuth, 'oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(collectionAuth, 'oauth2.tokenQueryKey'),
+ autoFetchToken: get(collectionAuth, 'oauth2.autoFetchToken'),
+ additionalParameters: get(collectionAuth, 'oauth2.additionalParameters', { authorization: [], token: [], refresh: [] })
+ };
+ break;
+ case 'client_credentials':
+ axiosRequest.oauth2 = {
+ grantType: grantType,
+ accessTokenUrl: get(collectionAuth, 'oauth2.accessTokenUrl'),
+ refreshTokenUrl: get(collectionAuth, 'oauth2.refreshTokenUrl'),
+ clientId: get(collectionAuth, 'oauth2.clientId'),
+ clientSecret: get(collectionAuth, 'oauth2.clientSecret'),
+ scope: get(collectionAuth, 'oauth2.scope'),
+ credentialsPlacement: get(collectionAuth, 'oauth2.credentialsPlacement'),
+ credentialsId: get(collectionAuth, 'oauth2.credentialsId'),
+ tokenPlacement: get(collectionAuth, 'oauth2.tokenPlacement'),
+ tokenHeaderPrefix: get(collectionAuth, 'oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(collectionAuth, 'oauth2.tokenQueryKey'),
+ autoFetchToken: get(collectionAuth, 'oauth2.autoFetchToken'),
+ autoRefreshToken: get(collectionAuth, 'oauth2.autoRefreshToken'),
+ additionalParameters: get(collectionAuth, 'oauth2.additionalParameters', { authorization: [], token: [], refresh: [] })
+ };
+ break;
+ }
+ break;
}
}
@@ -83,13 +166,13 @@ const setAuthHeaders = (axiosRequest, request, collectionRoot) => {
};
break;
case 'basic':
- axiosRequest.auth = {
+ axiosRequest.basicAuth = {
username: get(request, 'auth.basic.username'),
password: get(request, 'auth.basic.password')
};
break;
case 'bearer':
- axiosRequest.headers['Authorization'] = `Bearer ${get(request, 'auth.bearer.token')}`;
+ axiosRequest.headers['Authorization'] = `Bearer ${get(request, 'auth.bearer.token', '')}`;
break;
case 'digest':
axiosRequest.digestConfig = {
@@ -103,7 +186,6 @@ const setAuthHeaders = (axiosRequest, request, collectionRoot) => {
password: get(request, 'auth.ntlm.password'),
domain: get(request, 'auth.ntlm.domain')
};
- break;
case 'oauth2':
const grantType = get(request, 'auth.oauth2.grantType');
switch (grantType) {
@@ -111,11 +193,20 @@ const setAuthHeaders = (axiosRequest, request, collectionRoot) => {
axiosRequest.oauth2 = {
grantType: grantType,
accessTokenUrl: get(request, 'auth.oauth2.accessTokenUrl'),
+ refreshTokenUrl: get(collectionAuth, 'oauth2.refreshTokenUrl'),
username: get(request, 'auth.oauth2.username'),
password: get(request, 'auth.oauth2.password'),
clientId: get(request, 'auth.oauth2.clientId'),
clientSecret: get(request, 'auth.oauth2.clientSecret'),
- scope: get(request, 'auth.oauth2.scope')
+ scope: get(request, 'auth.oauth2.scope'),
+ credentialsPlacement: get(request, 'auth.oauth2.credentialsPlacement'),
+ credentialsId: get(request, 'auth.oauth2.credentialsId'),
+ tokenPlacement: get(request, 'auth.oauth2.tokenPlacement'),
+ tokenHeaderPrefix: get(request, 'auth.oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(request, 'auth.oauth2.tokenQueryKey'),
+ autoFetchToken: get(request, 'auth.oauth2.autoFetchToken'),
+ autoRefreshToken: get(request, 'auth.oauth2.autoRefreshToken'),
+ additionalParameters: get(request, 'auth.oauth2.additionalParameters', { authorization: [], token: [], refresh: [] })
};
break;
case 'authorization_code':
@@ -124,20 +215,54 @@ const setAuthHeaders = (axiosRequest, request, collectionRoot) => {
callbackUrl: get(request, 'auth.oauth2.callbackUrl'),
authorizationUrl: get(request, 'auth.oauth2.authorizationUrl'),
accessTokenUrl: get(request, 'auth.oauth2.accessTokenUrl'),
+ refreshTokenUrl: get(collectionAuth, 'oauth2.refreshTokenUrl'),
clientId: get(request, 'auth.oauth2.clientId'),
clientSecret: get(request, 'auth.oauth2.clientSecret'),
scope: get(request, 'auth.oauth2.scope'),
state: get(request, 'auth.oauth2.state'),
- pkce: get(request, 'auth.oauth2.pkce')
+ pkce: get(request, 'auth.oauth2.pkce'),
+ credentialsPlacement: get(request, 'auth.oauth2.credentialsPlacement'),
+ credentialsId: get(request, 'auth.oauth2.credentialsId'),
+ tokenPlacement: get(request, 'auth.oauth2.tokenPlacement'),
+ tokenHeaderPrefix: get(request, 'auth.oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(request, 'auth.oauth2.tokenQueryKey'),
+ autoFetchToken: get(request, 'auth.oauth2.autoFetchToken'),
+ autoRefreshToken: get(request, 'auth.oauth2.autoRefreshToken'),
+ additionalParameters: get(request, 'auth.oauth2.additionalParameters', { authorization: [], token: [], refresh: [] })
+ };
+ break;
+ case 'implicit':
+ axiosRequest.oauth2 = {
+ grantType: grantType,
+ callbackUrl: get(request, 'auth.oauth2.callbackUrl'),
+ authorizationUrl: get(request, 'auth.oauth2.authorizationUrl'),
+ clientId: get(request, 'auth.oauth2.clientId'),
+ scope: get(request, 'auth.oauth2.scope'),
+ state: get(request, 'auth.oauth2.state'),
+ credentialsId: get(request, 'auth.oauth2.credentialsId'),
+ tokenPlacement: get(request, 'auth.oauth2.tokenPlacement'),
+ tokenHeaderPrefix: get(request, 'auth.oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(request, 'auth.oauth2.tokenQueryKey'),
+ autoFetchToken: get(request, 'auth.oauth2.autoFetchToken'),
+ additionalParameters: get(request, 'auth.oauth2.additionalParameters', { authorization: [], token: [], refresh: [] })
};
break;
case 'client_credentials':
axiosRequest.oauth2 = {
grantType: grantType,
accessTokenUrl: get(request, 'auth.oauth2.accessTokenUrl'),
+ refreshTokenUrl: get(collectionAuth, 'oauth2.refreshTokenUrl'),
clientId: get(request, 'auth.oauth2.clientId'),
clientSecret: get(request, 'auth.oauth2.clientSecret'),
- scope: get(request, 'auth.oauth2.scope')
+ scope: get(request, 'auth.oauth2.scope'),
+ credentialsPlacement: get(request, 'auth.oauth2.credentialsPlacement'),
+ credentialsId: get(request, 'auth.oauth2.credentialsId'),
+ tokenPlacement: get(request, 'auth.oauth2.tokenPlacement'),
+ tokenHeaderPrefix: get(request, 'auth.oauth2.tokenHeaderPrefix'),
+ tokenQueryKey: get(request, 'auth.oauth2.tokenQueryKey'),
+ autoFetchToken: get(request, 'auth.oauth2.autoFetchToken'),
+ autoRefreshToken: get(request, 'auth.oauth2.autoRefreshToken'),
+ additionalParameters: get(request, 'auth.oauth2.additionalParameters', { authorization: [], token: [], refresh: [] })
};
break;
}
@@ -161,6 +286,7 @@ const setAuthHeaders = (axiosRequest, request, collectionRoot) => {
break;
case 'apikey':
const apiKeyAuth = get(request, 'auth.apikey');
+ if (apiKeyAuth.key.length === 0) break;
if (apiKeyAuth.placement === 'header') {
axiosRequest.headers[apiKeyAuth.key] = apiKeyAuth.value;
} else if (apiKeyAuth.placement === 'queryparams') {
@@ -174,10 +300,11 @@ const setAuthHeaders = (axiosRequest, request, collectionRoot) => {
return axiosRequest;
};
-const prepareRequest = (item, collection) => {
+const prepareRequest = async (item, collection = {}, abortController) => {
const request = item.draft ? item.draft.request : item.request;
- const collectionRoot = get(collection, 'root', {});
- const collectionPath = collection.pathname;
+ const settings = item.draft?.settings ?? item.settings;
+ const collectionRoot = collection?.draft ? get(collection, 'draft', {}) : get(collection, 'root', {});
+ const collectionPath = collection?.pathname;
const headers = {};
let contentTypeDefined = false;
let url = request.url;
@@ -189,13 +316,15 @@ const prepareRequest = (item, collection) => {
}
});
- const scriptFlow = collection.brunoConfig?.scripts?.flow ?? 'sandwich';
+ const scriptFlow = collection?.brunoConfig?.scripts?.flow ?? 'sandwich';
const requestTreePath = getTreePathFromCollectionToItem(collection, item);
if (requestTreePath && requestTreePath.length > 0) {
mergeHeaders(collection, request, requestTreePath);
mergeScripts(collection, request, requestTreePath, scriptFlow);
mergeVars(collection, request, requestTreePath);
+ mergeAuth(collection, request, requestTreePath);
request.globalEnvironmentVariables = collection?.globalEnvironmentVariables;
+ request.oauth2CredentialVariables = getFormattedCollectionOauth2Credentials({ oauth2Credentials: collection?.oauth2Credentials });
}
@@ -213,7 +342,9 @@ const prepareRequest = (item, collection) => {
method: request.method,
url,
headers,
- pathParams: request?.params?.filter((param) => param.type === 'path'),
+ name: item.name,
+ pathParams: request.params?.filter((param) => param.type === 'path'),
+ settings,
responseType: 'arraybuffer'
};
@@ -251,6 +382,31 @@ const prepareRequest = (item, collection) => {
axiosRequest.data = request.body.sparql;
}
+ if (request.body.mode === 'file') {
+ if (!contentTypeDefined) {
+ axiosRequest.headers['content-type'] = 'application/octet-stream'; // Default headers for binary file uploads
+ }
+
+ const bodyFile = find(request.body.file, (param) => param.selected);
+ if (bodyFile) {
+ let { filePath, contentType } = bodyFile;
+
+ axiosRequest.headers['content-type'] = contentType;
+ if (filePath) {
+ if (!path.isAbsolute(filePath)) {
+ filePath = path.join(collectionPath, filePath);
+ }
+
+ try {
+ const fileContent = await fs.readFile(filePath);
+ axiosRequest.data = fileContent;
+ } catch (error) {
+ console.error('Error reading file:', error);
+ }
+ }
+ }
+ }
+
if (request.body.mode === 'formUrlEncoded') {
if (!contentTypeDefined) {
axiosRequest.headers['content-type'] = 'application/x-www-form-urlencoded';
@@ -279,6 +435,13 @@ const prepareRequest = (item, collection) => {
axiosRequest.data = graphqlQuery;
}
+ // if the mode is 'none' then set the content-type header to false. #1693
+ if (request.body.mode === 'none' && request.auth.mode !== 'awsv4') {
+ if(!contentTypeDefined) {
+ axiosRequest.headers['content-type'] = false;
+ }
+ }
+
if (request.script) {
axiosRequest.script = request.script;
}
@@ -292,10 +455,14 @@ const prepareRequest = (item, collection) => {
axiosRequest.folderVariables = request.folderVariables;
axiosRequest.requestVariables = request.requestVariables;
axiosRequest.globalEnvironmentVariables = request.globalEnvironmentVariables;
+ axiosRequest.oauth2CredentialVariables = request.oauth2CredentialVariables;
axiosRequest.assertions = request.assertions;
+ axiosRequest.oauth2Credentials = request.oauth2Credentials;
return axiosRequest;
};
-module.exports = prepareRequest;
-module.exports.setAuthHeaders = setAuthHeaders;
+module.exports = {
+ prepareRequest,
+ setAuthHeaders
+}
\ No newline at end of file
diff --git a/packages/bruno-electron/src/ipc/preferences.js b/packages/bruno-electron/src/ipc/preferences.js
index 4c9c34d99..3cf95c6f4 100644
--- a/packages/bruno-electron/src/ipc/preferences.js
+++ b/packages/bruno-electron/src/ipc/preferences.js
@@ -15,11 +15,17 @@ const registerPreferencesIpc = (mainWindow, watcher, lastOpenedCollections) => {
const { http_proxy, https_proxy, no_proxy } = systemProxyVars || {};
mainWindow.webContents.send('main:load-system-proxy-env', { http_proxy, https_proxy, no_proxy });
- // load global environments
- const globalEnvironments = globalEnvironmentsStore.getGlobalEnvironments();
- let activeGlobalEnvironmentUid = globalEnvironmentsStore.getActiveGlobalEnvironmentUid();
- activeGlobalEnvironmentUid = globalEnvironments?.find(env => env?.uid == activeGlobalEnvironmentUid) ? activeGlobalEnvironmentUid : null;
- mainWindow.webContents.send('main:load-global-environments', { globalEnvironments, activeGlobalEnvironmentUid });
+ try {
+ // load global environments
+ const globalEnvironments = globalEnvironmentsStore.getGlobalEnvironments();
+ let activeGlobalEnvironmentUid = globalEnvironmentsStore.getActiveGlobalEnvironmentUid();
+ activeGlobalEnvironmentUid = globalEnvironments?.find(env => env?.uid == activeGlobalEnvironmentUid) ? activeGlobalEnvironmentUid : null;
+ mainWindow.webContents.send('main:load-global-environments', { globalEnvironments, activeGlobalEnvironmentUid });
+ }
+ catch(error) {
+ console.error("Error occured while fetching global environements!");
+ console.error(error);
+ }
// reload last opened collections
const lastOpened = lastOpenedCollections.getAll();
diff --git a/packages/bruno-electron/src/preload.js b/packages/bruno-electron/src/preload.js
index 83dfcada8..d89a2dab6 100644
--- a/packages/bruno-electron/src/preload.js
+++ b/packages/bruno-electron/src/preload.js
@@ -11,8 +11,8 @@ contextBridge.exposeInMainWorld('ipcRenderer', {
ipcRenderer.removeListener(channel, subscription);
};
},
- getFilePath (file) {
- const path = webUtils.getPathForFile(file)
+ getFilePath(file) {
+ const path = webUtils.getPathForFile(file);
return path;
}
});
diff --git a/packages/bruno-electron/src/store/bruno-config.js b/packages/bruno-electron/src/store/bruno-config.js
index a092e9357..8942dd833 100644
--- a/packages/bruno-electron/src/store/bruno-config.js
+++ b/packages/bruno-electron/src/store/bruno-config.js
@@ -4,7 +4,7 @@
const config = {};
-// collectionUid is a hash based on the collection path)
+// collectionUid is a hash based on the collection path
const getBrunoConfig = (collectionUid) => {
return config[collectionUid] || {};
};
diff --git a/packages/bruno-electron/src/store/cookies.js b/packages/bruno-electron/src/store/cookies.js
new file mode 100644
index 000000000..3b6953991
--- /dev/null
+++ b/packages/bruno-electron/src/store/cookies.js
@@ -0,0 +1,194 @@
+const Store = require('electron-store');
+const { cookies: cookiesModule } = require('@usebruno/requests');
+const { cookieJar } = cookiesModule;
+const { Cookie } = require('tough-cookie');
+const { createCookieString } = cookiesModule;
+const crypto = require('crypto');
+const { encryptString, decryptString } = require('../utils/encryption');
+
+const DEBOUNCE_MS = 5000; // Debounce duration (ms) for persisting cookie jar
+class CookiesStore {
+ #saveTimerId = null;
+ #debounceStart = null; // Track first debounce time
+ #passkey = null;
+
+ constructor() {
+ this.store = new Store({
+ name: 'cookies',
+ clearInvalidConfig: true,
+ defaults: {
+ encryptedPasskey: null,
+ cookies: {}
+ }
+ });
+ }
+
+ #generatePasskey() {
+ // Generate 32 bytes (256 bits) of random data and convert to hex
+ return crypto.randomBytes(32).toString('hex');
+ }
+
+ initializeEncryption() {
+ try {
+ let encryptedPasskey = this.store.get('encryptedPasskey');
+ if (!encryptedPasskey) {
+ // Generate cryptographically secure random passkey
+ const passkey = this.#generatePasskey();
+ encryptedPasskey = encryptString(passkey);
+ if (!encryptedPasskey) {
+ console.warn('Failed to encrypt new passkey, falling back to unencrypted cookies');
+ this.#passkey = null;
+ return;
+ }
+ this.store.set('encryptedPasskey', encryptedPasskey);
+ }
+ this.#passkey = decryptString(encryptedPasskey);
+ if (!this.#passkey) {
+ console.warn('Failed to decrypt passkey, falling back to unencrypted cookies');
+ }
+ } catch (err) {
+ console.warn('Failed to initialize encryption, falling back to unencrypted cookies:', err);
+ this.#passkey = null;
+ }
+ }
+
+ getCookies() {
+ const cookieStore = this.store.get('cookies', {});
+ const decryptedCookies = [];
+
+ // Filter and decrypt cookies
+ Object.values(cookieStore).forEach(domainCookies => {
+ if (!Array.isArray(domainCookies)) return;
+
+ domainCookies.forEach(cookie => {
+ try {
+
+ // Create cookie with decrypted value
+ const decryptedCookie = {
+ ...cookie,
+ value: decryptString(cookie.value, this.#passkey)
+ };
+ decryptedCookies.push(decryptedCookie);
+ } catch (err) {
+ console.warn('Failed to process cookie:', cookie?.key, err);
+ // Still add the cookie but with empty value if processing fails
+ decryptedCookies.push({
+ ...cookie,
+ value: ''
+ });
+ }
+ });
+ });
+
+ return decryptedCookies;
+ }
+
+ setCookies(cookies) {
+ try {
+ // Organize cookies by domain
+ const cookiesByDomain = {};
+ cookies.cookies.forEach(cookie => {
+ try {
+ if (!cookiesByDomain[cookie.domain]) {
+ cookiesByDomain[cookie.domain] = [];
+ }
+
+ cookiesByDomain[cookie.domain].push({
+ ...cookie,
+ value: encryptString(cookie.value, this.#passkey)
+ });
+ } catch (err) {
+ console.warn('Failed to process cookie for storage:', cookie?.key, err);
+ // Still store the cookie but with original value if encryption fails
+ if (!cookiesByDomain[cookie.domain]) {
+ cookiesByDomain[cookie.domain] = [];
+ }
+ cookiesByDomain[cookie.domain].push(cookie);
+ }
+ });
+
+ return this.store.set('cookies', cookiesByDomain);
+ } catch (err) {
+ console.warn('Failed to set cookies:', err);
+ }
+ }
+
+ // Initialize cookies from store into cookie jar
+ initializeCookies() {
+ if (this.#passkey === null) {
+ this.initializeEncryption();
+ }
+ try {
+ const storedCookies = this.getCookies();
+
+ if (Array.isArray(storedCookies) && storedCookies.length) {
+ storedCookies.forEach((cookie) => this.loadCookieIntoJar(cookie));
+ }
+ } catch (err) {
+ console.warn('Failed to initialize cookies:', err);
+ }
+ }
+
+ // Load a single cookie into the cookie jar
+ loadCookieIntoJar(rawCookie) {
+ try {
+ const cookie = Cookie.fromJSON(rawCookie);
+ if (!cookie) return;
+
+ // Re-assemble request URL for tough-cookie
+ const protocol = cookie.secure ? 'https' : 'http';
+ const domain = cookie.domain.startsWith('.') ? cookie.domain.slice(1) : cookie.domain;
+ const url = `${protocol}://${domain}${cookie.path || '/'}`;
+ const setCookieHeader = createCookieString(cookie);
+
+ cookieJar.setCookieSync(setCookieHeader, url, { ignoreError: true });
+ } catch (err) {
+ console.warn('Failed to load cookie:', rawCookie?.key, err?.message);
+ }
+ }
+
+ // Save current cookie jar state to store with debouncing
+ writeCookieJar() {
+ try {
+ const serialized = cookieJar.serializeSync();
+ this.setCookies(serialized);
+
+ } catch (err) {
+ console.warn('Failed to save cookie jar:', err);
+ } finally {
+ this.#debounceStart = null;
+ }
+ }
+
+ saveCookieJar(immediate = false) {
+ // Debounced write to avoid excessive disk I/O during rapid request bursts
+ if (immediate) {
+ if (this.#saveTimerId) {
+ clearTimeout(this.#saveTimerId);
+ this.#saveTimerId = null;
+ }
+ return this.writeCookieJar();
+ }
+
+ if (!this.#debounceStart) {
+ this.#debounceStart = Date.now();
+ }
+
+ if (this.#saveTimerId) {
+ clearTimeout(this.#saveTimerId);
+ }
+ this.#saveTimerId = setTimeout(() => {
+ this.writeCookieJar();
+ this.#saveTimerId = null;
+ }, DEBOUNCE_MS);
+ }
+
+}
+
+// Create singleton instance
+const cookiesStore = new CookiesStore();
+
+module.exports = {
+ cookiesStore,
+ CookiesStore
+};
\ No newline at end of file
diff --git a/packages/bruno-electron/src/store/env-secrets.js b/packages/bruno-electron/src/store/env-secrets.js
index 8ded05ae9..1b962cdbd 100644
--- a/packages/bruno-electron/src/store/env-secrets.js
+++ b/packages/bruno-electron/src/store/env-secrets.js
@@ -1,6 +1,6 @@
const _ = require('lodash');
const Store = require('electron-store');
-const { encryptString } = require('../utils/encryption');
+const { encryptStringSafe } = require('../utils/encryption');
/**
* Sample secrets store file
@@ -27,17 +27,13 @@ class EnvironmentSecretsStore {
});
}
- isValidValue(val) {
- return typeof val === 'string' && val.length >= 0;
- }
-
storeEnvSecrets(collectionPathname, environment) {
const envVars = [];
_.each(environment.variables, (v) => {
if (v.secret) {
envVars.push({
name: v.name,
- value: this.isValidValue(v.value) ? encryptString(v.value) : ''
+ value: encryptStringSafe(v.value).value
});
}
});
diff --git a/packages/bruno-electron/src/store/global-environments.js b/packages/bruno-electron/src/store/global-environments.js
index e8c03c434..57367fd23 100644
--- a/packages/bruno-electron/src/store/global-environments.js
+++ b/packages/bruno-electron/src/store/global-environments.js
@@ -1,6 +1,6 @@
const _ = require('lodash');
const Store = require('electron-store');
-const { encryptString, decryptString } = require('../utils/encryption');
+const { encryptStringSafe, decryptStringSafe } = require('../utils/encryption');
class GlobalEnvironmentsStore {
constructor() {
@@ -10,15 +10,11 @@ class GlobalEnvironmentsStore {
});
}
- isValidValue(val) {
- return typeof val === 'string' && val.length >= 0;
- }
-
encryptGlobalEnvironmentVariables({ globalEnvironments }) {
return globalEnvironments?.map(env => {
const variables = env.variables?.map(v => ({
...v,
- value: v?.secret ? (this.isValidValue(v.value) ? encryptString(v.value) : '') : v?.value
+ value: v?.secret ? encryptStringSafe(v.value).value : v?.value
})) || [];
return {
@@ -32,7 +28,7 @@ class GlobalEnvironmentsStore {
return globalEnvironments?.map(env => {
const variables = env.variables?.map(v => ({
...v,
- value: v?.secret ? (this.isValidValue(v.value) ? decryptString(v.value) : '') : v?.value
+ value: v?.secret ? decryptStringSafe(v.value).value : v?.value
})) || [];
return {
@@ -45,6 +41,18 @@ class GlobalEnvironmentsStore {
getGlobalEnvironments() {
let globalEnvironments = this.store.get('environments', []);
globalEnvironments = this.decryptGlobalEnvironmentVariables({ globalEnvironments });
+
+ // Previously, a bug caused environment variables to be saved without a type.
+ // Since that issue is now fixed, this code ensures that anyone who imported
+ // data before the fix will have the missing types added retroactively.
+ globalEnvironments?.forEach(env => {
+ env?.variables?.forEach(v => {
+ if (!v.type) {
+ v.type = 'text';
+ }
+ });
+ });
+
return globalEnvironments;
}
diff --git a/packages/bruno-electron/src/store/last-opened-collections.js b/packages/bruno-electron/src/store/last-opened-collections.js
index 546b73b57..72452eef3 100644
--- a/packages/bruno-electron/src/store/last-opened-collections.js
+++ b/packages/bruno-electron/src/store/last-opened-collections.js
@@ -16,18 +16,20 @@ class LastOpenedCollections {
}
add(collectionPath) {
- const collections = this.store.get('lastOpenedCollections') || [];
+ const collections = this.getAll();
- if (isDirectory(collectionPath)) {
- if (!collections.includes(collectionPath)) {
- collections.push(collectionPath);
- this.store.set('lastOpenedCollections', collections);
- }
+ if (isDirectory(collectionPath) && !collections.includes(collectionPath)) {
+ collections.push(collectionPath);
+ this.store.set('lastOpenedCollections', collections);
}
}
+ update(collectionPaths) {
+ this.store.set('lastOpenedCollections', collectionPaths);
+ }
+
remove(collectionPath) {
- let collections = this.store.get('lastOpenedCollections') || [];
+ let collections = this.getAll();
if (collections.includes(collectionPath)) {
collections = _.filter(collections, (c) => c !== collectionPath);
@@ -36,7 +38,7 @@ class LastOpenedCollections {
}
removeAll() {
- return this.store.set('lastOpenedCollections', []);
+ this.store.set('lastOpenedCollections', []);
}
}
diff --git a/packages/bruno-electron/src/store/oauth2.js b/packages/bruno-electron/src/store/oauth2.js
index b0a2255b5..d85573bc8 100644
--- a/packages/bruno-electron/src/store/oauth2.js
+++ b/packages/bruno-electron/src/store/oauth2.js
@@ -1,24 +1,42 @@
const _ = require('lodash');
const Store = require('electron-store');
-const { uuid } = require('../utils/common');
+const { uuid, safeStringifyJSON, safeParseJSON } = require('../utils/common');
+const { encryptStringSafe, decryptStringSafe } = require('../utils/encryption');
+
+/**
+ * Sample secrets store file
+ *
+ * {
+ * "collections": [{
+ * "path": "/Users/anoop/Code/acme-acpi-collection",
+ * "environments" : [{
+ * "name": "Local",
+ * "secrets": [{
+ * "name": "token",
+ * "value": "abracadabra"
+ * }]
+ * }]
+ * }]
+ * }
+ */
class Oauth2Store {
constructor() {
this.store = new Store({
- name: 'preferences',
+ name: 'oauth2',
clearInvalidConfig: true
});
}
// Get oauth2 data for all collections
getAllOauth2Data() {
- let oauth2Data = this.store.get('oauth2');
+ let oauth2Data = this.store.get('collections');
if (!Array.isArray(oauth2Data)) oauth2Data = [];
return oauth2Data;
}
// Get oauth2 data for a collection
- getOauth2DataOfCollection(collectionUid) {
+ getOauth2DataOfCollection({ collectionUid, url }) {
let oauth2Data = this.getAllOauth2Data();
let oauth2DataForCollection = oauth2Data.find((d) => d?.collectionUid == collectionUid);
@@ -28,7 +46,7 @@ class Oauth2Store {
collectionUid
};
let updatedOauth2Data = [...oauth2Data, newOauth2DataForCollection];
- this.store.set('oauth2', updatedOauth2Data);
+ this.store.set('collections', updatedOauth2Data);
return newOauth2DataForCollection;
}
@@ -37,18 +55,18 @@ class Oauth2Store {
}
// Update oauth2 data of a collection
- updateOauth2DataOfCollection(collectionUid, data) {
+ updateOauth2DataOfCollection({ collectionUid, url, data }) {
let oauth2Data = this.getAllOauth2Data();
let updatedOauth2Data = oauth2Data.filter((d) => d.collectionUid !== collectionUid);
updatedOauth2Data.push({ ...data });
- this.store.set('oauth2', updatedOauth2Data);
+ this.store.set('collections', updatedOauth2Data);
}
// Create a new oauth2 Session Id for a collection
- createNewOauth2SessionIdForCollection(collectionUid) {
- let oauth2DataForCollection = this.getOauth2DataOfCollection(collectionUid);
+ createNewOauth2SessionIdForCollection({ collectionUid, url }) {
+ let oauth2DataForCollection = this.getOauth2DataOfCollection({ collectionUid, url });
let newSessionId = uuid();
@@ -57,21 +75,21 @@ class Oauth2Store {
sessionId: newSessionId
};
- this.updateOauth2DataOfCollection(collectionUid, newOauth2DataForCollection);
+ this.updateOauth2DataOfCollection({ collectionUid, data: newOauth2DataForCollection });
return newOauth2DataForCollection;
}
// Get session id of a collection
- getSessionIdOfCollection(collectionUid) {
+ getSessionIdOfCollection({ collectionUid, url }) {
try {
- let oauth2DataForCollection = this.getOauth2DataOfCollection(collectionUid);
+ let oauth2DataForCollection = this.getOauth2DataOfCollection({ collectionUid, url });
if (oauth2DataForCollection?.sessionId && typeof oauth2DataForCollection.sessionId === 'string') {
return oauth2DataForCollection.sessionId;
}
- let newOauth2DataForCollection = this.createNewOauth2SessionIdForCollection(collectionUid);
+ let newOauth2DataForCollection = this.createNewOauth2SessionIdForCollection({ collectionUid, url });
return newOauth2DataForCollection?.sessionId;
} catch (err) {
console.log('error retrieving session id from cache', err);
@@ -79,21 +97,73 @@ class Oauth2Store {
}
// clear session id of a collection
- clearSessionIdOfCollection(collectionUid) {
+ clearSessionIdOfCollection({ collectionUid, url }) {
try {
let oauth2Data = this.getAllOauth2Data();
- let oauth2DataForCollection = this.getOauth2DataOfCollection(collectionUid);
+ let oauth2DataForCollection = this.getOauth2DataOfCollection({ collectionUid, url });
delete oauth2DataForCollection.sessionId;
+ delete oauth2DataForCollection.credentials;
let updatedOauth2Data = oauth2Data.filter((d) => d.collectionUid !== collectionUid);
updatedOauth2Data.push({ ...oauth2DataForCollection });
- this.store.set('oauth2', updatedOauth2Data);
+ this.store.set('collections', updatedOauth2Data);
} catch (err) {
console.log('error while clearing the oauth2 session cache', err);
}
}
+
+ getCredentialsForCollection({ collectionUid, url, credentialsId }) {
+ try {
+ let oauth2DataForCollection = this.getOauth2DataOfCollection({ collectionUid, url });
+ let credentials = oauth2DataForCollection?.credentials?.find(c => (c?.url == url) && (c?.credentialsId == credentialsId));
+ if (!credentials?.data) return null;
+ const decryptionResult = decryptStringSafe(credentials?.data);
+ const decryptedCredentialsData = safeParseJSON(decryptionResult.value);
+ return decryptedCredentialsData;
+ } catch (err) {
+ console.log('error retrieving oauth2 credentials from cache', err);
+ }
+ }
+
+ updateCredentialsForCollection({ collectionUid, url, credentialsId, credentials = {} }) {
+ try {
+ const encryptionResult = encryptStringSafe(safeStringifyJSON(credentials));
+ const encryptedCredentialsData = encryptionResult.value;
+ let oauth2DataForCollection = this.getOauth2DataOfCollection({ collectionUid, url });
+ let filteredCredentials = oauth2DataForCollection?.credentials?.filter(c => (c?.url !== url) || (c?.credentialsId !== credentialsId));
+ if (!filteredCredentials) filteredCredentials = [];
+ filteredCredentials.push({
+ url,
+ data: encryptedCredentialsData,
+ credentialsId
+ });
+ let newOauth2DataForCollection = {
+ ...oauth2DataForCollection,
+ credentials: filteredCredentials
+ };
+ this.updateOauth2DataOfCollection({ collectionUid, data: newOauth2DataForCollection });
+ return newOauth2DataForCollection;
+ } catch (err) {
+ console.log('error updating oauth2 credentials from cache', err);
+ }
+ }
+
+ clearCredentialsForCollection({ collectionUid, url, credentialsId }) {
+ try {
+ let oauth2DataForCollection = this.getOauth2DataOfCollection({ collectionUid, url });
+ let filteredCredentials = oauth2DataForCollection?.credentials?.filter(c => (c?.url !== url) || (c?.credentialsId !== credentialsId));
+ let newOauth2DataForCollection = {
+ ...oauth2DataForCollection,
+ credentials: filteredCredentials
+ };
+ this.updateOauth2DataOfCollection({ collectionUid, data: newOauth2DataForCollection });
+ return newOauth2DataForCollection;
+ } catch (err) {
+ console.log('error clearing oauth2 credentials from cache', err);
+ }
+ }
}
module.exports = Oauth2Store;
diff --git a/packages/bruno-electron/src/store/preferences.js b/packages/bruno-electron/src/store/preferences.js
index 33d7a02f8..e711e5309 100644
--- a/packages/bruno-electron/src/store/preferences.js
+++ b/packages/bruno-electron/src/store/preferences.js
@@ -37,6 +37,12 @@ const defaultPreferences = {
password: ''
},
bypassProxy: ''
+ },
+ layout: {
+ responsePaneOrientation: 'horizontal'
+ },
+ beta: {
+ grpc: false
}
};
@@ -69,6 +75,12 @@ const preferencesSchema = Yup.object().shape({
password: Yup.string().max(1024)
}).optional(),
bypassProxy: Yup.string().optional().max(1024)
+ }),
+ layout: Yup.object({
+ responsePaneOrientation: Yup.string().oneOf(['horizontal', 'vertical'])
+ }),
+ beta: Yup.object({
+ grpc: Yup.boolean()
})
});
@@ -149,6 +161,9 @@ const preferencesUtil = {
shouldSendCookies: () => {
return get(getPreferences(), 'request.sendCookies', true);
},
+ getResponsePaneOrientation: () => {
+ return get(getPreferences(), 'layout.responsePaneOrientation', 'horizontal');
+ },
getSystemProxyEnvVariables: () => {
const { http_proxy, HTTP_PROXY, https_proxy, HTTPS_PROXY, no_proxy, NO_PROXY } = process.env;
return {
@@ -156,6 +171,9 @@ const preferencesUtil = {
https_proxy: https_proxy || HTTPS_PROXY,
no_proxy: no_proxy || NO_PROXY
};
+ },
+ isBetaFeatureEnabled: (featureName) => {
+ return get(getPreferences(), `beta.${featureName}`, false);
}
};
diff --git a/packages/bruno-electron/src/store/process-env.js b/packages/bruno-electron/src/store/process-env.js
index 578d8df71..084187d2d 100644
--- a/packages/bruno-electron/src/store/process-env.js
+++ b/packages/bruno-electron/src/store/process-env.js
@@ -11,7 +11,7 @@
const dotEnvVars = {};
-// collectionUid is a hash based on the collection path)
+// collectionUid is a hash based on the collection path
const getProcessEnvVars = (collectionUid) => {
// if there are no .env vars for this collection, return the process.env
if (!dotEnvVars[collectionUid]) {
diff --git a/packages/bruno-electron/src/utils/collection.js b/packages/bruno-electron/src/utils/collection.js
index 15d5574e2..1ab774211 100644
--- a/packages/bruno-electron/src/utils/collection.js
+++ b/packages/bruno-electron/src/utils/collection.js
@@ -1,4 +1,7 @@
-const { get, each, find, compact } = require('lodash');
+const { get, each, find, compact, isString, filter } = require('lodash');
+const fs = require('fs');
+const { getRequestUid } = require('../cache/requestUids');
+const { uuid } = require('./common');
const os = require('os');
const mergeHeaders = (collection, request, requestTreePath) => {
@@ -7,9 +10,10 @@ const mergeHeaders = (collection, request, requestTreePath) => {
let collectionHeaders = get(collection, 'root.request.headers', []);
collectionHeaders.forEach((header) => {
if (header.enabled) {
- headers.set(header.name, header.value);
- if (header?.name?.toLowerCase() === 'content-type') {
- contentTypeDefined = true;
+ if (header?.name?.toLowerCase?.() === 'content-type') {
+ headers.set('content-type', header.value);
+ } else {
+ headers.set(header.name, header.value);
}
}
});
@@ -19,14 +23,22 @@ const mergeHeaders = (collection, request, requestTreePath) => {
let _headers = get(i, 'root.request.headers', []);
_headers.forEach((header) => {
if (header.enabled) {
- headers.set(header.name, header.value);
+ if (header.name.toLowerCase() === 'content-type') {
+ headers.set('content-type', header.value);
+ } else {
+ headers.set(header.name, header.value);
+ }
}
});
} else {
const _headers = i?.draft ? get(i, 'draft.request.headers', []) : get(i, 'request.headers', []);
_headers.forEach((header) => {
if (header.enabled) {
- headers.set(header.name, header.value);
+ if (header.name.toLowerCase() === 'content-type') {
+ headers.set('content-type', header.value);
+ } else {
+ headers.set(header.name, header.value);
+ }
}
});
}
@@ -35,7 +47,7 @@ const mergeHeaders = (collection, request, requestTreePath) => {
request.headers = Array.from(headers, ([name, value]) => ({ name, value, enabled: true }));
};
-const mergeVars = (collection, request, requestTreePath) => {
+const mergeVars = (collection, request, requestTreePath = []) => {
let reqVars = new Map();
let collectionRequestVars = get(collection, 'root.request.vars.req', []);
let collectionVariables = {};
@@ -193,6 +205,14 @@ const findParentItemInCollection = (collection, itemUid) => {
});
};
+const findParentItemInCollectionByPathname = (collection, pathname) => {
+ let flattenedItems = flattenItems(collection.items);
+
+ return find(flattenedItems, (item) => {
+ return item.items && find(item.items, (i) => i.pathname === pathname);
+ });
+};
+
const getTreePathFromCollectionToItem = (collection, _item) => {
let path = [];
let item = findItemInCollection(collection, _item.uid);
@@ -203,16 +223,90 @@ const getTreePathFromCollectionToItem = (collection, _item) => {
return path;
};
-const slash = (path) => {
- const isExtendedLengthPath = /^\\\\\?\\/.test(path);
- if (isExtendedLengthPath) {
- return path;
+const parseBruFileMeta = (data) => {
+ try {
+ const metaRegex = /meta\s*{\s*([\s\S]*?)\s*}/;
+ const match = data?.match?.(metaRegex);
+ if (match) {
+ const metaContent = match[1].trim();
+ const lines = metaContent.replace(/\r\n/g, '\n').split('\n');
+ const metaJson = {};
+ lines.forEach(line => {
+ const [key, value] = line.split(':').map(str => str.trim());
+ if (key && value) {
+ metaJson[key] = isNaN(value) ? value : Number(value);
+ }
+ });
+
+ // Transform to the format expected by bruno-app
+ let requestType = metaJson.type;
+ if (requestType === 'http') {
+ requestType = 'http-request';
+ } else if (requestType === 'graphql') {
+ requestType = 'graphql-request';
+ } else {
+ requestType = 'http-request';
+ }
+
+ const sequence = metaJson.seq;
+ const transformedJson = {
+ type: requestType,
+ name: metaJson.name,
+ seq: !isNaN(sequence) ? Number(sequence) : 1,
+ settings: {},
+ tags: metaJson.tags || [],
+ request: {
+ method: '',
+ url: '',
+ params: [],
+ headers: [],
+ auth: { mode: 'none' },
+ body: { mode: 'none' },
+ script: {},
+ vars: {},
+ assertions: [],
+ tests: '',
+ docs: ''
+ }
+ };
+
+ return transformedJson;
+ } else {
+ console.log('No "meta" block found in the file.');
+ return null;
+ }
+ } catch (err) {
+ console.error('Error reading file:', err);
+ return null;
}
- return path?.replace?.(/\\/g, '/');
+}
+
+const hydrateRequestWithUuid = (request, pathname) => {
+ request.uid = getRequestUid(pathname);
+
+ const params = get(request, 'request.params', []);
+ const headers = get(request, 'request.headers', []);
+ const requestVars = get(request, 'request.vars.req', []);
+ const responseVars = get(request, 'request.vars.res', []);
+ const assertions = get(request, 'request.assertions', []);
+ const bodyFormUrlEncoded = get(request, 'request.body.formUrlEncoded', []);
+ const bodyMultipartForm = get(request, 'request.body.multipartForm', []);
+ const file = get(request, 'request.body.file', []);
+
+ params.forEach((param) => (param.uid = uuid()));
+ headers.forEach((header) => (header.uid = uuid()));
+ requestVars.forEach((variable) => (variable.uid = uuid()));
+ responseVars.forEach((variable) => (variable.uid = uuid()));
+ assertions.forEach((assertion) => (assertion.uid = uuid()));
+ bodyFormUrlEncoded.forEach((param) => (param.uid = uuid()));
+ bodyMultipartForm.forEach((param) => (param.uid = uuid()));
+ file.forEach((param) => (param.uid = uuid()));
+
+ return request;
};
const findItemByPathname = (items = [], pathname) => {
- return find(items, (i) => slash(i.pathname) === slash(pathname));
+ return find(items, (i) => i.pathname === pathname);
};
const findItemInCollectionByPathname = (collection, pathname) => {
@@ -221,13 +315,274 @@ const findItemInCollectionByPathname = (collection, pathname) => {
return findItemByPathname(flattenedItems, pathname);
};
+const replaceTabsWithSpaces = (str, numSpaces = 2) => {
+ if (!str || !str.length || !isString(str)) {
+ return '';
+ }
+
+ return str.replaceAll('\t', ' '.repeat(numSpaces));
+};
+
+const transformRequestToSaveToFilesystem = (item) => {
+ const _item = item.draft ? item.draft : item;
+ const itemToSave = {
+ uid: _item.uid,
+ type: _item.type,
+ name: _item.name,
+ seq: _item.seq,
+ settings: _item.settings,
+ request: {
+ method: _item.request.method,
+ url: _item.request.url,
+ params: [],
+ headers: [],
+ auth: _item.request.auth,
+ body: _item.request.body,
+ script: _item.request.script,
+ vars: _item.request.vars,
+ assertions: _item.request.assertions,
+ tests: _item.request.tests,
+ docs: _item.request.docs
+ }
+ };
+
+ if (_item.type === 'grpc-request') {
+ itemToSave.request.methodType = _item.request.methodType;
+ itemToSave.request.protoPath = _item.request.protoPath;
+ delete itemToSave.request.params
+ }
+
+ // Only process params for non-gRPC requests
+ if (_item.type !== 'grpc-request') {
+ each(_item.request.params, (param) => {
+ itemToSave.request.params.push({
+ uid: param.uid,
+ name: param.name,
+ value: param.value,
+ description: param.description,
+ type: param.type,
+ enabled: param.enabled
+ });
+ });
+ }
+
+ each(_item.request.headers, (header) => {
+ itemToSave.request.headers.push({
+ uid: header.uid,
+ name: header.name,
+ value: header.value,
+ description: header.description,
+ enabled: header.enabled
+ });
+ });
+
+ if (itemToSave.request.body.mode === 'json') {
+ itemToSave.request.body = {
+ ...itemToSave.request.body,
+ json: replaceTabsWithSpaces(itemToSave.request.body.json)
+ };
+ }
+
+ if (itemToSave.request.body.mode === 'grpc') {
+ itemToSave.request.body = {
+ ...itemToSave.request.body,
+ grpc: itemToSave.request.body.grpc.map(({name, content}, index) => ({
+ name: name ? name : `message ${index + 1}`,
+ content: replaceTabsWithSpaces(content)
+ }))
+ };
+ }
+
+ return itemToSave;
+}
+
+const sortCollection = (collection) => {
+ const items = collection.items || [];
+ let folderItems = filter(items, (item) => item.type === 'folder');
+ let requestItems = filter(items, (item) => item.type !== 'folder');
+
+ folderItems = sortByNameThenSequence(folderItems);
+ requestItems = requestItems.sort((a, b) => a.seq - b.seq);
+
+ collection.items = folderItems.concat(requestItems);
+
+ each(folderItems, (item) => {
+ sortCollection(item);
+ });
+};
+
+const sortFolder = (folder = {}) => {
+ const items = folder.items || [];
+ let folderItems = filter(items, (item) => item.type === 'folder');
+ let requestItems = filter(items, (item) => item.type !== 'folder');
+
+ folderItems = sortByNameThenSequence(folderItems);
+ requestItems = requestItems.sort((a, b) => a.seq - b.seq);
+
+ folder.items = folderItems.concat(requestItems);
+
+ each(folderItems, (item) => {
+ sortFolder(item);
+ });
+
+ return folder;
+};
+
+const getAllRequestsInFolderRecursively = (folder = {}) => {
+ let requests = [];
+
+ if (folder.items && folder.items.length) {
+ folder.items.forEach((item) => {
+ if (item.type !== 'folder') {
+ requests.push(item);
+ } else {
+ requests = requests.concat(getAllRequestsInFolderRecursively(item));
+ }
+ });
+ }
+
+ return requests;
+};
+
+const getEnvVars = (environment = {}) => {
+ const variables = environment.variables;
+ if (!variables || !variables.length) {
+ return {
+ __name__: environment.name
+ };
+ }
+
+ const envVars = {};
+ each(variables, (variable) => {
+ if (variable.enabled) {
+ envVars[variable.name] = variable.value;
+ }
+ });
+
+ return {
+ ...envVars,
+ __name__: environment.name
+ };
+};
+
+const getFormattedCollectionOauth2Credentials = ({ oauth2Credentials = [] }) => {
+ let credentialsVariables = {};
+ oauth2Credentials.forEach(({ credentialsId, credentials }) => {
+ if (credentials) {
+ Object.entries(credentials).forEach(([key, value]) => {
+ credentialsVariables[`$oauth2.${credentialsId}.${key}`] = value;
+ });
+ }
+ });
+ return credentialsVariables;
+};
+
+const mergeAuth = (collection, request, requestTreePath) => {
+ // Start with collection level auth (always consider collection auth as base)
+ let collectionAuth = get(collection, 'root.request.auth', { mode: 'none' });
+ let effectiveAuth = collectionAuth;
+ let lastFolderWithAuth = null;
+
+ // Traverse through the path to find the closest auth configuration
+ for (let i of requestTreePath) {
+ if (i.type === 'folder') {
+ const folderAuth = get(i, 'root.request.auth');
+ // Only consider folders that have a valid auth mode
+ if (folderAuth && folderAuth.mode && folderAuth.mode !== 'none' && folderAuth.mode !== 'inherit') {
+ effectiveAuth = folderAuth;
+ lastFolderWithAuth = i;
+ }
+ }
+ }
+
+ // If request is set to inherit, use the effective auth from collection/folders
+ if (request.auth.mode === 'inherit') {
+ request.auth = effectiveAuth;
+
+ // For OAuth2, we need to handle credentials properly
+ if (effectiveAuth.mode === 'oauth2') {
+ if (lastFolderWithAuth) {
+ // If auth is from folder, add folderUid and clear itemUid
+ request.oauth2Credentials = {
+ ...request.oauth2Credentials,
+ folderUid: lastFolderWithAuth.uid,
+ itemUid: null,
+ mode: request.auth.mode
+ };
+ } else {
+ // If auth is from collection, ensure no folderUid and no itemUid
+ request.oauth2Credentials = {
+ ...request.oauth2Credentials,
+ folderUid: null,
+ itemUid: null,
+ mode: request.auth.mode
+ };
+ }
+ }
+ }
+};
+
+const sortByNameThenSequence = items => {
+ const isSeqValid = seq => Number.isFinite(seq) && Number.isInteger(seq) && seq > 0;
+
+ // Sort folders alphabetically by name
+ const alphabeticallySorted = [...items].sort((a, b) => a.name && b.name && a.name.localeCompare(b.name));
+
+ // Extract folders without 'seq'
+ const withoutSeq = alphabeticallySorted.filter(f => !isSeqValid(f['seq']));
+
+ // Extract folders with 'seq' and sort them by 'seq'
+ const withSeq = alphabeticallySorted.filter(f => isSeqValid(f['seq'])).sort((a, b) => a.seq - b.seq);
+
+ const sortedItems = withoutSeq;
+
+ // Insert folders with 'seq' at their specified positions
+ withSeq.forEach((item) => {
+ const position = item.seq - 1;
+ const existingItem = withoutSeq[position];
+
+ // Check if there's already an item with the same sequence number
+ const hasItemWithSameSeq = Array.isArray(existingItem)
+ ? existingItem?.[0]?.seq === item.seq
+ : existingItem?.seq === item.seq;
+
+ if (hasItemWithSameSeq) {
+ // If there's a conflict, group items with same sequence together
+ const newGroup = Array.isArray(existingItem)
+ ? [...existingItem, item]
+ : [existingItem, item];
+
+ withoutSeq.splice(position, 1, newGroup);
+ } else {
+ // Insert item at the specified position
+ withoutSeq.splice(position, 0, item);
+ }
+ });
+
+ // return flattened sortedItems
+ return sortedItems.flat();
+};
module.exports = {
mergeHeaders,
mergeVars,
mergeScripts,
+ mergeAuth,
getTreePathFromCollectionToItem,
- slash,
+ flattenItems,
+ findItem,
+ findItemInCollection,
findItemByPathname,
- findItemInCollectionByPathname
-}
\ No newline at end of file
+ findItemInCollectionByPathname,
+ findParentItemInCollection,
+ findParentItemInCollectionByPathname,
+ parseBruFileMeta,
+ hydrateRequestWithUuid,
+ transformRequestToSaveToFilesystem,
+ sortCollection,
+ sortFolder,
+ getAllRequestsInFolderRecursively,
+ getEnvVars,
+ getFormattedCollectionOauth2Credentials,
+ sortByNameThenSequence
+};
\ No newline at end of file
diff --git a/packages/bruno-electron/src/utils/common.js b/packages/bruno-electron/src/utils/common.js
index 50b17bb38..a855e5523 100644
--- a/packages/bruno-electron/src/utils/common.js
+++ b/packages/bruno-electron/src/utils/common.js
@@ -1,4 +1,6 @@
const { customAlphabet } = require('nanoid');
+const iconv = require('iconv-lite');
+const { cloneDeep } = require('lodash');
// a customized version of nanoid without using _ and -
const uuid = () => {
@@ -25,10 +27,24 @@ const parseJson = async (obj) => {
}
};
-const safeStringifyJSON = (data) => {
+const getCircularReplacer = () => {
+ const seen = new WeakSet();
+ return (key, value) => {
+ if (typeof value === "object" && value !== null) {
+ if (seen.has(value)) return "[Circular]";
+ seen.add(value);
+ }
+ return value;
+ };
+};
+
+const safeStringifyJSON = (data, indent = null) => {
+ if (data === undefined) return undefined;
try {
- return JSON.stringify(data);
+ // getCircularReplacer - removes circular references that cause an error when stringifying
+ return JSON.stringify(data, getCircularReplacer(), indent);
} catch (e) {
+ console.warn('Failed to stringify data:', e.message);
return data;
}
};
@@ -85,6 +101,42 @@ const flattenDataForDotNotation = (data) => {
return result;
};
+const parseDataFromResponse = (response, disableParsingResponseJson = false) => {
+ // Parse the charset from content type: https://stackoverflow.com/a/33192813
+ const charsetMatch = /charset=([^()<>@,;:"/[\]?.=\s]*)/i.exec(response.headers['content-type'] || '');
+ // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/exec#using_exec_with_regexp_literals
+ const charsetValue = charsetMatch?.[1];
+ const dataBuffer = Buffer.from(response.data);
+ // Overwrite the original data for backwards compatibility
+ let data;
+ if (iconv.encodingExists(charsetValue)) {
+ data = iconv.decode(dataBuffer, charsetValue);
+ } else {
+ data = iconv.decode(dataBuffer, 'utf-8');
+ }
+ // Try to parse response to JSON, this can quietly fail
+ try {
+ // Filter out ZWNBSP character
+ // https://gist.github.com/antic183/619f42b559b78028d1fe9e7ae8a1352d
+ data = data.replace(/^\uFEFF/, '');
+ if (!disableParsingResponseJson) {
+ data = JSON.parse(data);
+ }
+ } catch { }
+
+ return { data, dataBuffer };
+};
+
+const parseDataFromRequest = (request) => {
+ const requestDataString = request.mode == 'file'? "": (typeof request?.data === 'string' ? request?.data : safeStringifyJSON(request?.data));
+ const requestCopy = cloneDeep(request);
+ if (!requestCopy.data) {
+ return { data: null, dataBuffer: null };
+ }
+ requestCopy.data = requestDataString;
+ return parseDataFromResponse(requestCopy);
+};
+
module.exports = {
uuid,
stringifyJson,
@@ -93,5 +145,7 @@ module.exports = {
safeParseJSON,
simpleHash,
generateUidBasedOnHash,
- flattenDataForDotNotation
+ flattenDataForDotNotation,
+ parseDataFromResponse,
+ parseDataFromRequest
};
diff --git a/packages/bruno-electron/src/utils/cookies.js b/packages/bruno-electron/src/utils/cookies.js
index 5b4d7fc7c..9e160a784 100644
--- a/packages/bruno-electron/src/utils/cookies.js
+++ b/packages/bruno-electron/src/utils/cookies.js
@@ -1,85 +1 @@
-const { Cookie, CookieJar } = require('tough-cookie');
-const each = require('lodash/each');
-
-const cookieJar = new CookieJar();
-
-const addCookieToJar = (setCookieHeader, requestUrl) => {
- const cookie = Cookie.parse(setCookieHeader, { loose: true });
- cookieJar.setCookieSync(cookie, requestUrl, {
- ignoreError: true // silently ignore things like parse errors and invalid domains
- });
-};
-
-const getCookiesForUrl = (url) => {
- return cookieJar.getCookiesSync(url);
-};
-
-const getCookieStringForUrl = (url) => {
- const cookies = getCookiesForUrl(url);
-
- if (!Array.isArray(cookies) || !cookies.length) {
- return '';
- }
-
- const validCookies = cookies.filter((cookie) => !cookie.expires || cookie.expires > Date.now());
-
- return validCookies.map((cookie) => cookie.cookieString()).join('; ');
-};
-
-const getDomainsWithCookies = () => {
- return new Promise((resolve, reject) => {
- const domainCookieMap = {};
-
- cookieJar.store.getAllCookies((err, cookies) => {
- if (err) {
- return reject(err);
- }
-
- cookies.forEach((cookie) => {
- if (!domainCookieMap[cookie.domain]) {
- domainCookieMap[cookie.domain] = [cookie];
- } else {
- domainCookieMap[cookie.domain].push(cookie);
- }
- });
-
- const domains = Object.keys(domainCookieMap);
- const domainsWithCookies = [];
-
- each(domains, (domain) => {
- const cookies = domainCookieMap[domain];
- const validCookies = cookies.filter((cookie) => !cookie.expires || cookie.expires > Date.now());
-
- if (validCookies.length) {
- domainsWithCookies.push({
- domain,
- cookies: validCookies,
- cookieString: validCookies.map((cookie) => cookie.cookieString()).join('; ')
- });
- }
- });
-
- resolve(domainsWithCookies);
- });
- });
-};
-
-const deleteCookiesForDomain = (domain) => {
- return new Promise((resolve, reject) => {
- cookieJar.store.removeCookies(domain, null, (err) => {
- if (err) {
- return reject(err);
- }
-
- return resolve();
- });
- });
-};
-
-module.exports = {
- addCookieToJar,
- getCookiesForUrl,
- getCookieStringForUrl,
- getDomainsWithCookies,
- deleteCookiesForDomain
-};
+module.exports = require('@usebruno/requests').cookies;
diff --git a/packages/bruno-electron/src/utils/encryption.js b/packages/bruno-electron/src/utils/encryption.js
index 36c53e7ef..54c1a7cc9 100644
--- a/packages/bruno-electron/src/utils/encryption.js
+++ b/packages/bruno-electron/src/utils/encryption.js
@@ -29,8 +29,8 @@ function deriveKeyAndIv(password, keyLength, ivLength) {
return { key, iv };
}
-function aes256Encrypt(data) {
- const rawKey = machineIdSync();
+function aes256Encrypt(data, passkey = null) {
+ const rawKey = passkey || machineIdSync();
const iv = Buffer.alloc(16, 0); // Default IV for new encryption
const key = crypto.createHash('sha256').update(rawKey).digest(); // Derive a 32-byte key
const cipher = crypto.createCipheriv('aes-256-cbc', key, iv);
@@ -40,8 +40,8 @@ function aes256Encrypt(data) {
return encrypted;
}
-function aes256Decrypt(data) {
- const rawKey = machineIdSync();
+function aes256Decrypt(data, passkey = null) {
+ const rawKey = passkey || machineIdSync();
// Attempt to decrypt using new method first
const iv = Buffer.alloc(16, 0); // Default IV for new encryption
@@ -54,11 +54,16 @@ function aes256Decrypt(data) {
return decrypted;
} catch (err) {
// If decryption fails, fall back to old key derivation
- const { key: oldKey, iv: oldIv } = deriveKeyAndIv(rawKey, 32, 16);
- const decipher = crypto.createDecipheriv('aes-256-cbc', oldKey, oldIv);
- let decrypted = decipher.update(data, 'hex', 'utf8');
- decrypted += decipher.final('utf8');
- return decrypted;
+ try {
+ const { key: oldKey, iv: oldIv } = deriveKeyAndIv(rawKey, 32, 16);
+ const decipher = crypto.createDecipheriv('aes-256-cbc', oldKey, oldIv);
+ const decrypted = decipher.update(data, 'hex', 'utf8');
+ decrypted += decipher.final('utf8');
+ return decrypted;
+ } catch (fallbackErr) {
+ console.error('AES256 decryption failed with both methods:', err, fallbackErr);
+ throw new Error('AES256 decryption failed: ' + fallbackErr.message);
+ }
}
}
@@ -73,40 +78,62 @@ function safeStorageEncrypt(str) {
return encryptedString;
}
function safeStorageDecrypt(str) {
- // Convert the hexadecimal string to a buffer
- const encryptedStringBuffer = Buffer.from(str, 'hex');
+ try {
+ // Convert the hexadecimal string to a buffer
+ const encryptedStringBuffer = Buffer.from(str, 'hex');
- // Decrypt the buffer
- const decryptedStringBuffer = safeStorage.decryptString(encryptedStringBuffer);
+ // Decrypt the buffer
+ const decryptedStringBuffer = safeStorage.decryptString(encryptedStringBuffer);
- // Convert the decrypted buffer to a string
- const decryptedString = decryptedStringBuffer.toString();
+ // Convert the decrypted buffer to a string
+ const decryptedString = decryptedStringBuffer.toString();
- return decryptedString;
+ return decryptedString;
+ } catch (err) {
+ console.error('SafeStorage decryption failed:', err);
+ throw new Error('SafeStorage decryption failed: ' + err.message);
+ }
}
-function encryptString(str) {
+function encryptString(str, passkey = null) {
if (typeof str !== 'string') {
throw new Error('Encrypt failed: invalid string');
}
+ if (str.length === 0) {
+ return '';
+ }
- let encryptedString = '';
+ // If a passkey is provided (from cookies store), we must use it for encryption.
+ if (passkey !== null && passkey !== undefined) {
+ if (typeof passkey !== 'string' || passkey.length === 0) {
+ // Corrupted / empty passkey -> do not encrypt, return empty value
+ return '';
+ }
+ try {
+ const encryptedString = aes256Encrypt(str, passkey);
+ return `$${AES256_ALGO}:${encryptedString}`;
+ } catch (err) {
+ // Any error indicates the passkey is unusable; return empty string
+ return '';
+ }
+ }
if (safeStorage && safeStorage.isEncryptionAvailable()) {
- encryptedString = safeStorageEncrypt(str);
+ const encryptedString = safeStorageEncrypt(str);
return `$${ELECTRONSAFESTORAGE_ALGO}:${encryptedString}`;
}
- // fallback to aes256
- encryptedString = aes256Encrypt(str);
-
+ const encryptedString = aes256Encrypt(str);
return `$${AES256_ALGO}:${encryptedString}`;
}
-function decryptString(str) {
- if (!str) {
+function decryptString(str, passkey = null) {
+ if (typeof str !== 'string') {
throw new Error('Decrypt failed: unrecognized string format');
}
+ if (str.length === 0) {
+ return '';
+ }
// Find the index of the first colon
const colonIndex = str.indexOf(':');
@@ -132,11 +159,34 @@ function decryptString(str) {
}
if (algo === AES256_ALGO) {
- return aes256Decrypt(encryptedString);
+ return aes256Decrypt(encryptedString, passkey || null);
+ }
+ throw new Error('Decrypt failed: Invalid algo');
+}
+
+function decryptStringSafe(str) {
+ try {
+ const result = decryptString(str);
+ return { success: true, value: result };
+ } catch (err) {
+ console.error('Decryption failed:', err.message);
+ return { success: false, error: err.message, value: '' };
+ }
+}
+
+function encryptStringSafe(str) {
+ try {
+ const result = encryptString(str);
+ return { success: true, value: result };
+ } catch (err) {
+ console.error('Encryption failed:', err.message);
+ return { success: false, error: err.message, value: '' };
}
}
module.exports = {
encryptString,
- decryptString
+ encryptStringSafe,
+ decryptString,
+ decryptStringSafe
};
diff --git a/packages/bruno-electron/src/utils/filesystem.js b/packages/bruno-electron/src/utils/filesystem.js
index d2f74d10e..28b479013 100644
--- a/packages/bruno-electron/src/utils/filesystem.js
+++ b/packages/bruno-electron/src/utils/filesystem.js
@@ -44,6 +44,11 @@ const hasSubDirectories = (dir) => {
};
const normalizeAndResolvePath = (pathname) => {
+
+ if (isWSLPath(pathname)) {
+ return normalizeWSLPath(pathname);
+ }
+
if (isSymbolicLink(pathname)) {
const absPath = path.dirname(pathname);
const targetPath = path.resolve(absPath, fs.readlinkSync(pathname));
@@ -59,29 +64,24 @@ const normalizeAndResolvePath = (pathname) => {
function isWSLPath(pathname) {
// Check if the path starts with the WSL prefix
// eg. "\\wsl.localhost\Ubuntu\home\user\bruno\collection\scripting\api\req\getHeaders.bru"
- return pathname.startsWith('/wsl.localhost/') || pathname.startsWith('\\wsl.localhost\\');
+ return pathname.startsWith('\\\\') || pathname.startsWith('//') || pathname.startsWith('/wsl.localhost/') || pathname.startsWith('\\wsl.localhost');
+
}
-function normalizeWslPath(pathname) {
+function normalizeWSLPath(pathname) {
// Replace the WSL path prefix and convert forward slashes to backslashes
// This is done to achieve WSL paths (linux style) to Windows UNC equivalent (Universal Naming Conversion)
return pathname.replace(/^\/wsl.localhost/, '\\\\wsl.localhost').replace(/\//g, '\\');
}
-const writeFile = async (pathname, content) => {
+
+const writeFile = async (pathname, content, isBinary = false) => {
try {
- fs.writeFileSync(pathname, content, {
- encoding: 'utf8'
+ await safeWriteFile(pathname, content, {
+ encoding: !isBinary ? "utf-8" : null
});
} catch (err) {
- return Promise.reject(err);
- }
-};
-
-const writeBinaryFile = async (pathname, content) => {
- try {
- fs.writeFileSync(pathname, content);
- } catch (err) {
+ console.error(`Error writing file at ${pathname}:`, err);
return Promise.reject(err);
}
};
@@ -117,13 +117,13 @@ const browseDirectory = async (win) => {
return false;
}
- const resolvedPath = normalizeAndResolvePath(filePaths[0]);
+ const resolvedPath = path.resolve(filePaths[0]);
return isDirectory(resolvedPath) ? resolvedPath : false;
};
-const browseFiles = async (win, filters) => {
+const browseFiles = async (win, filters = [], properties = []) => {
const { filePaths } = await dialog.showOpenDialog(win, {
- properties: ['openFile', 'multiSelections'],
+ properties: ['openFile', ...properties],
filters
});
@@ -131,7 +131,7 @@ const browseFiles = async (win, filters) => {
return [];
}
- return filePaths.map((path) => normalizeAndResolvePath(path)).filter((path) => isFile(path));
+ return filePaths.map((filePath) => path.resolve(filePath)).filter((filePath) => isFile(filePath));
};
const chooseFileToSave = async (win, preferredFileName = '') => {
@@ -161,32 +161,37 @@ const searchForBruFiles = (dir) => {
return searchForFiles(dir, '.bru');
};
-const sanitizeCollectionName = (name) => {
- return name.trim();
-}
-
-const sanitizeDirectoryName = (name) => {
- return name.replace(/[<>:"/\\|?*\x00-\x1F]+/g, '-').trim();
+const sanitizeName = (name) => {
+ const invalidCharacters = /[<>:"/\\|?*\x00-\x1F]/g;
+ name = name
+ .replace(invalidCharacters, '-') // replace invalid characters with hyphens
+ .replace(/^[\s\-]+/, '') // remove leading spaces and hyphens
+ .replace(/[.\s]+$/, ''); // remove trailing dots and spaces
+ return name;
};
const isWindowsOS = () => {
return os.platform() === 'win32';
}
-const isValidFilename = (fileName) => {
- const inValidChars = /[\\/:*?"<>|]/;
+const validateName = (name) => {
+ const invalidCharacters = /[<>:"/\\|?*\x00-\x1F]/g; // keeping this for informational purpose
+ const reservedDeviceNames = /^(CON|PRN|AUX|NUL|COM[0-9]|LPT[0-9])$/i;
+ const firstCharacter = /^[^\s\-<>:"/\\|?*\x00-\x1F]/; // no space, hyphen and `invalidCharacters`
+ const middleCharacters = /^[^<>:"/\\|?*\x00-\x1F]*$/; // no `invalidCharacters`
+ const lastCharacter = /[^.\s<>:"/\\|?*\x00-\x1F]$/; // no dot, space and `invalidCharacters`
+ if (name.length > 255) return false; // max name length
- if (!fileName || inValidChars.test(fileName)) {
- return false;
- }
+ if (reservedDeviceNames.test(name)) return false; // windows reserved names
- if (fileName.endsWith(' ') || fileName.endsWith('.') || fileName.startsWith('.')) {
- return false;
- }
-
- return true;
+ return (
+ firstCharacter.test(name) &&
+ middleCharacters.test(name) &&
+ lastCharacter.test(name)
+ );
};
+
const safeToRename = (oldPath, newPath) => {
try {
// If the new path doesn't exist, it's safe to rename
@@ -211,6 +216,134 @@ const safeToRename = (oldPath, newPath) => {
}
};
+const getCollectionStats = async (directoryPath) => {
+ let size = 0;
+ let filesCount = 0;
+ let maxFileSize = 0;
+
+ async function calculateStats(directory) {
+ const entries = await fsPromises.readdir(directory, { withFileTypes: true });
+
+ const tasks = entries.map(async (entry) => {
+ const fullPath = path.join(directory, entry.name);
+
+ if (entry.isDirectory()) {
+ if (['node_modules', '.git'].includes(entry.name)) {
+ return;
+ }
+
+ await calculateStats(fullPath);
+ }
+
+ if (path.extname(fullPath) === '.bru') {
+ const stats = await fsPromises.stat(fullPath);
+ size += stats?.size;
+ if (maxFileSize < stats?.size) {
+ maxFileSize = stats?.size;
+ }
+ filesCount += 1;
+ }
+ });
+
+ await Promise.all(tasks);
+ }
+
+ await calculateStats(directoryPath);
+
+ size = sizeInMB(size);
+ maxFileSize = sizeInMB(maxFileSize);
+
+ return { size, filesCount, maxFileSize };
+}
+
+const sizeInMB = (size) => {
+ return size / (1024 * 1024);
+}
+
+const getSafePathToWrite = (filePath) => {
+ const MAX_FILENAME_LENGTH = 255; // Common limit on most filesystems
+ let dir = path.dirname(filePath);
+ let ext = path.extname(filePath);
+ let base = path.basename(filePath, ext);
+ if (base.length + ext.length > MAX_FILENAME_LENGTH) {
+ base = sanitizeName(base);
+ base = base.slice(0, MAX_FILENAME_LENGTH - ext.length);
+ }
+ let safePath = path.join(dir, base + ext);
+ return safePath;
+}
+
+async function safeWriteFile(filePath, data, options) {
+ const safePath = getSafePathToWrite(filePath);
+ await fs.writeFile(safePath, data, options);
+}
+
+function safeWriteFileSync(filePath, data) {
+ const safePath = getSafePathToWrite(filePath);
+ fs.writeFileSync(safePath, data);
+}
+
+// Recursively copies a source to a destination .
+const copyPath = async (source, destination) => {
+ let targetPath = `${destination}/${path.basename(source)}`;
+
+ const targetPathExists = await fsPromises.access(targetPath).then(() => true).catch(() => false);
+ if (targetPathExists) {
+ throw new Error(`Cannot copy, ${path.basename(source)} already exists in ${path.basename(destination)}`);
+ }
+
+ const copy = async (source, destination) => {
+ const stat = await fsPromises.lstat(source);
+ if (stat.isDirectory()) {
+ await fsPromises.mkdir(destination, { recursive: true });
+ const entries = await fsPromises.readdir(source);
+ for (const entry of entries) {
+ const srcPath = path.join(source, entry);
+ const destPath = path.join(destination, entry);
+ await copy(srcPath, destPath);
+ }
+ } else {
+ await fsPromises.copyFile(source, destination);
+ }
+ }
+
+ await copy(source, targetPath);
+}
+
+// Recursively removes a source .
+const removePath = async (source) => {
+ const stat = await fsPromises.lstat(source);
+ if (stat.isDirectory()) {
+ const entries = await fsPromises.readdir(source);
+ for (const entry of entries) {
+ const entryPath = path.join(source, entry);
+ await removePath(entryPath);
+ }
+ await fsPromises.rmdir(source);
+ } else {
+ await fsPromises.unlink(source);
+ }
+}
+
+// Recursively gets paths.
+const getPaths = async (source) => {
+ let paths = [];
+ const _getPaths = async (source) => {
+ const stat = await fsPromises.lstat(source);
+ paths.push(source);
+ if (stat.isDirectory()) {
+ const entries = await fsPromises.readdir(source);
+ for (const entry of entries) {
+ const entryPath = path.join(source, entry);
+ await _getPaths(entryPath);
+ }
+ }
+ }
+ await _getPaths(source);
+ return paths;
+}
+
+
module.exports = {
isValidPathname,
exists,
@@ -219,9 +352,8 @@ module.exports = {
isDirectory,
normalizeAndResolvePath,
isWSLPath,
- normalizeWslPath,
+ normalizeWSLPath,
writeFile,
- writeBinaryFile,
hasJsonExtension,
hasBruExtension,
createDirectory,
@@ -230,10 +362,16 @@ module.exports = {
chooseFileToSave,
searchForFiles,
searchForBruFiles,
- sanitizeDirectoryName,
- sanitizeCollectionName,
+ sanitizeName,
isWindowsOS,
safeToRename,
- isValidFilename,
- hasSubDirectories
+ validateName,
+ hasSubDirectories,
+ getCollectionStats,
+ sizeInMB,
+ safeWriteFile,
+ safeWriteFileSync,
+ copyPath,
+ removePath,
+ getPaths
};
diff --git a/packages/bruno-electron/src/utils/filesystem.test.js b/packages/bruno-electron/src/utils/filesystem.test.js
index 62d7b502f..a0f0f018d 100644
--- a/packages/bruno-electron/src/utils/filesystem.test.js
+++ b/packages/bruno-electron/src/utils/filesystem.test.js
@@ -1,26 +1,88 @@
-const { sanitizeDirectoryName } = require('./filesystem.js');
+const { sanitizeName, isWSLPath, normalizeWSLPath, normalizeAndResolvePath } = require('./filesystem.js');
-describe('sanitizeDirectoryName', () => {
+describe('sanitizeName', () => {
it('should replace invalid characters with hyphens', () => {
- const input = '<>:"/\\|?*\x00-\x1F';
- const expectedOutput = '---';
- expect(sanitizeDirectoryName(input)).toEqual(expectedOutput);
+ expect(sanitizeName(
+ 'valid<>:"/\|?*\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F'
+ )).toEqual('valid----------------------------------------');
+
+ expect(sanitizeName(
+ '<>:"/\|?*\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1Fvalid<>:"/\|?*\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F'
+ )).toEqual('valid----------------------------------------');
});
it('should not modify valid directory names', () => {
const input = 'my-directory';
- expect(sanitizeDirectoryName(input)).toEqual(input);
+ expect(sanitizeName(input)).toEqual(input);
});
it('should replace multiple invalid characters with a single hyphen', () => {
const input = 'my<>invalid?directory';
- const expectedOutput = 'my-invalid-directory';
- expect(sanitizeDirectoryName(input)).toEqual(expectedOutput);
+ const expectedOutput = 'my--invalid-directory';
+ expect(sanitizeName(input)).toEqual(expectedOutput);
});
it('should handle names with slashes', () => {
const input = 'my/invalid/directory';
const expectedOutput = 'my-invalid-directory';
- expect(sanitizeDirectoryName(input)).toEqual(expectedOutput);
+ expect(sanitizeName(input)).toEqual(expectedOutput);
+ });
+});
+
+describe('WSL Path Utilities', () => {
+ describe('isWSLPath', () => {
+ it('should identify WSL paths starting with double backslash', () => {
+ expect(isWSLPath('\\\\wsl.localhost\\Ubuntu\\home\\user')).toBe(true);
+ });
+
+ it('should identify WSL paths starting with double forward slash', () => {
+ expect(isWSLPath('//wsl.localhost/Ubuntu/home/user')).toBe(true);
+ });
+
+ it('should identify WSL paths starting with /wsl.localhost/', () => {
+ expect(isWSLPath('/wsl.localhost/Ubuntu/home/user')).toBe(true);
+ });
+
+ it('should identify WSL paths starting with \\wsl.localhost', () => {
+ expect(isWSLPath('\\wsl.localhost\\Ubuntu\\home\\user')).toBe(true);
+ });
+
+ it('should return false for non-WSL paths', () => {
+ expect(isWSLPath('C:\\Users\\user\\Documents')).toBe(false);
+ expect(isWSLPath('/home/user/documents')).toBe(false);
+ expect(isWSLPath('relative/path')).toBe(false);
+ });
+ });
+
+ describe('normalizeWSLPath', () => {
+ it('should convert forward slash WSL paths to backslash format', () => {
+ const input = '/wsl.localhost/Ubuntu/home/user/file.txt';
+ const expected = '\\\\wsl.localhost\\Ubuntu\\home\\user\\file.txt';
+ expect(normalizeWSLPath(input)).toBe(expected);
+ });
+
+ it('should handle paths already in backslash format', () => {
+ const input = '\\\\wsl.localhost\\Ubuntu\\home\\user\\file.txt';
+ expect(normalizeWSLPath(input)).toBe(input);
+ });
+
+ it('should convert mixed slash formats to backslash format', () => {
+ const input = '/wsl.localhost\\Ubuntu/home\\user/file.txt';
+ const expected = '\\\\wsl.localhost\\Ubuntu\\home\\user\\file.txt';
+ expect(normalizeWSLPath(input)).toBe(expected);
+ });
+ });
+
+ describe('normalizeAndResolvePath with WSL paths', () => {
+ it('should normalize WSL paths', () => {
+ const input = '/wsl.localhost/Ubuntu/home/user/file.txt';
+ const expected = '\\\\wsl.localhost\\Ubuntu\\home\\user\\file.txt';
+ expect(normalizeAndResolvePath(input)).toBe(expected);
+ });
+
+ it('should handle already normalized WSL paths', () => {
+ const input = '\\\\wsl.localhost\\Ubuntu\\home\\user\\file.txt';
+ expect(normalizeAndResolvePath(input)).toBe(input);
+ });
});
});
diff --git a/packages/bruno-electron/src/utils/form-data.js b/packages/bruno-electron/src/utils/form-data.js
index f20371128..dc27b2577 100644
--- a/packages/bruno-electron/src/utils/form-data.js
+++ b/packages/bruno-electron/src/utils/form-data.js
@@ -5,7 +5,7 @@ const path = require('path');
/**
* @param {Array.} params The request body Array
- * @returns {object} Returns an obj with repeating key as a array of values
+ * @returns {object} Returns an obj with repeating key as an array of values
* {item: 2, item: 3, item1: 4} becomes {item: [2,3], item1: 4}
*/
const buildFormUrlEncodedPayload = (params) => {
diff --git a/packages/bruno-electron/src/utils/oauth2.js b/packages/bruno-electron/src/utils/oauth2.js
new file mode 100644
index 000000000..61d3d80c3
--- /dev/null
+++ b/packages/bruno-electron/src/utils/oauth2.js
@@ -0,0 +1,908 @@
+const { get, cloneDeep } = require('lodash');
+const crypto = require('crypto');
+const { authorizeUserInWindow } = require('../ipc/network/authorize-user-in-window');
+const Oauth2Store = require('../store/oauth2');
+const { makeAxiosInstance } = require('../ipc/network/axios-instance');
+const { safeParseJSON, safeStringifyJSON } = require('./common');
+const qs = require('qs');
+
+const oauth2Store = new Oauth2Store();
+
+const persistOauth2Credentials = ({ collectionUid, url, credentials, credentialsId }) => {
+ if (credentials?.error || !credentials?.access_token) return;
+ const enhancedCredentials = {
+ ...credentials,
+ created_at: Date.now(),
+ };
+ oauth2Store.updateCredentialsForCollection({ collectionUid, url, credentials: enhancedCredentials, credentialsId });
+};
+
+const clearOauth2Credentials = ({ collectionUid, url, credentialsId }) => {
+ oauth2Store.clearCredentialsForCollection({ collectionUid, url, credentialsId });
+};
+
+const getStoredOauth2Credentials = ({ collectionUid, url, credentialsId }) => {
+ try {
+ const credentials = oauth2Store.getCredentialsForCollection({ collectionUid, url, credentialsId });
+ return credentials;
+ }
+ catch (error) {
+ return null;
+ }
+};
+
+const isTokenExpired = (credentials) => {
+ if (!credentials?.access_token) {
+ return true;
+ }
+ if (!credentials?.expires_in || !credentials.created_at) {
+ return false;
+ }
+ const expiryTime = credentials.created_at + credentials.expires_in * 1000;
+ return Date.now() > expiryTime;
+};
+
+const safeParseJSONBuffer = (data) => {
+ return safeParseJSON(Buffer.isBuffer(data) ? data.toString() : data);
+}
+
+const getCredentialsFromTokenUrl = async ({ requestConfig, certsAndProxyConfig }) => {
+ const { proxyMode, proxyConfig, httpsAgentRequestFields, interpolationOptions } = certsAndProxyConfig;
+ const axiosInstance = makeAxiosInstance({ proxyMode, proxyConfig, httpsAgentRequestFields, interpolationOptions });
+ let requestDetails, parsedResponseData;
+ try {
+ const response = await axiosInstance(requestConfig);
+ const { url: responseUrl, headers: responseHeaders, status: responseStatus, statusText: responseStatusText, data: responseData, timeline, config } = response || {};
+ const { url: requestUrl, headers: requestHeaders, data: requestData } = config || {};
+ parsedResponseData = safeParseJSONBuffer(responseData);
+ requestDetails = {
+ request: {
+ url: requestUrl,
+ headers: requestHeaders,
+ data: requestData,
+ method: 'POST'
+ },
+ response: {
+ url: responseUrl,
+ headers: responseHeaders,
+ data: parsedResponseData,
+ status: responseStatus,
+ statusText: responseStatusText,
+ timeline
+ }
+ }
+ }
+ catch (error) {
+ if (error.response) {
+ const { response, config } = error;
+ const { url: responseUrl, headers: responseHeaders, status: responseStatus, statusText: responseStatusText, data: responseData, timeline } = response || {};
+ const { url: requestUrl, headers: requestHeaders, data: requestData } = config || {};
+ const errorResponseData = safeStringifyJSON(safeParseJSONBuffer(responseData))
+ requestDetails = {
+ request: {
+ url: requestUrl,
+ headers: requestHeaders,
+ data: requestData,
+ method: 'POST'
+ },
+ response: {
+ url: responseUrl,
+ headers: responseHeaders,
+ data: errorResponseData,
+ status: responseStatus,
+ statusText: responseStatusText,
+ timeline,
+ error: errorResponseData,
+ timestamp: Date.now()
+ }
+ };
+ }
+ else if (error?.code) {
+ // error.config is not available here
+ const { url: requestUrl, headers: requestHeaders, data: requestData } = requestConfig;
+ requestDetails = {
+ request: {
+ url: requestUrl,
+ headers: requestHeaders,
+ data: requestData
+ },
+ response: {
+ status: '-',
+ statusText: error?.code,
+ headers: {},
+ data: safeStringifyJSON(error?.errors),
+ timeline: error?.response?.timeline
+ }
+ };
+ }
+ }
+
+ // Add the axios request and response info as a main request in debugInfo
+ requestDetails = {
+ ...requestDetails,
+ requestId: Date.now().toString(),
+ fromCache: false,
+ completed: true,
+ requests: [], // No sub-requests in this context
+ };
+
+ return { credentials: parsedResponseData, requestDetails };
+}
+
+// AUTHORIZATION CODE
+
+const getOAuth2TokenUsingAuthorizationCode = async ({ request, collectionUid, forceFetch = false, certsAndProxyConfig }) => {
+ let codeVerifier = generateCodeVerifier();
+ let codeChallenge = generateCodeChallenge(codeVerifier);
+
+ let requestCopy = cloneDeep(request);
+ const oAuth = get(requestCopy, 'oauth2', {});
+ const {
+ clientId,
+ clientSecret,
+ callbackUrl,
+ scope,
+ pkce,
+ credentialsPlacement,
+ authorizationUrl,
+ credentialsId,
+ autoRefreshToken,
+ autoFetchToken,
+ additionalParameters,
+ } = oAuth;
+ const url = requestCopy?.oauth2?.accessTokenUrl;
+
+ // Validate required fields
+ if (!authorizationUrl) {
+ return {
+ error: 'Authorization URL is required for OAuth2 authorization code flow',
+ credentials: null,
+ url,
+ credentialsId
+ };
+ }
+
+ if (!url) {
+ return {
+ error: 'Access Token URL is required for OAuth2 authorization code flow',
+ credentials: null,
+ url: authorizationUrl,
+ credentialsId
+ };
+ }
+
+ if (!callbackUrl) {
+ return {
+ error: 'Callback URL is required for OAuth2 authorization code flow',
+ credentials: null,
+ url,
+ credentialsId
+ };
+ }
+
+ if (!clientId) {
+ return {
+ error: 'Client ID is required for OAuth2 authorization code flow',
+ credentials: null,
+ url,
+ credentialsId
+ };
+ }
+
+ if (!forceFetch) {
+ const storedCredentials = getStoredOauth2Credentials({ collectionUid, url, credentialsId });
+
+ if (storedCredentials) {
+ // Token exists
+ if (!isTokenExpired(storedCredentials)) {
+ // Token is valid, use it
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ } else {
+ // Token is expired
+ if (autoRefreshToken && storedCredentials.refresh_token) {
+ // Try to refresh token
+ try {
+ const refreshedCredentialsData = await refreshOauth2Token({ requestCopy, collectionUid, certsAndProxyConfig });
+ return { collectionUid, url, credentials: refreshedCredentialsData.credentials, credentialsId };
+ } catch (error) {
+ // Refresh failed
+ clearOauth2Credentials({ collectionUid, url, credentialsId });
+ if (autoFetchToken) {
+ // Proceed to fetch new token
+ } else {
+ // Proceed with expired token
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ }
+ }
+ } else if (autoRefreshToken && !storedCredentials.refresh_token) {
+ // Cannot refresh; try autoFetchToken
+ if (autoFetchToken) {
+ // Proceed to fetch new token
+ clearOauth2Credentials({ collectionUid, url, credentialsId });
+ } else {
+ // Proceed with expired token
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ }
+ } else if (!autoRefreshToken && autoFetchToken) {
+ // Proceed to fetch new token
+ clearOauth2Credentials({ collectionUid, url, credentialsId });
+ } else {
+ // Proceed with expired token
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ }
+ }
+ } else {
+ // No stored credentials
+ if (autoFetchToken && !storedCredentials) {
+ // Proceed to fetch new token
+ } else {
+ // Proceed without token
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ }
+ }
+ }
+
+ // Fetch new token process
+ let { authorizationCode, debugInfo } = await getOAuth2AuthorizationCode(requestCopy, codeChallenge, collectionUid);
+
+ let axiosRequestConfig = {};
+ axiosRequestConfig.method = 'POST';
+ axiosRequestConfig.headers = {
+ 'content-type': 'application/x-www-form-urlencoded',
+ 'Accept': 'application/json',
+ };
+ if (credentialsPlacement === "basic_auth_header") {
+ axiosRequestConfig.headers['Authorization'] = `Basic ${Buffer.from(`${encodeURIComponent(clientId)}:${encodeURIComponent(clientSecret)}`).toString('base64')}`;
+ }
+ const data = {
+ grant_type: 'authorization_code',
+ code: authorizationCode,
+ redirect_uri: callbackUrl,
+ };
+ if (credentialsPlacement !== "basic_auth_header") {
+ data.client_id = clientId;
+ }
+ if (clientSecret && clientSecret.trim() !== '' && credentialsPlacement !== "basic_auth_header") {
+ data.client_secret = clientSecret;
+ }
+ if (pkce) {
+ data['code_verifier'] = codeVerifier;
+ }
+
+ axiosRequestConfig.url = url;
+ axiosRequestConfig.responseType = 'arraybuffer';
+ // Apply additional parameters to token request
+ if (additionalParameters?.token?.length) {
+ applyAdditionalParameters(axiosRequestConfig, data, additionalParameters.token);
+ }
+ axiosRequestConfig.data = qs.stringify(data);
+ try {
+ const { credentials, requestDetails } = await getCredentialsFromTokenUrl({ requestConfig: axiosRequestConfig, certsAndProxyConfig });
+
+ // Ensure debugInfo.data is initialized
+ if (!debugInfo) {
+ debugInfo = { data: [] };
+ } else if (!debugInfo.data) {
+ debugInfo.data = [];
+ }
+
+ debugInfo.data.push(requestDetails);
+ credentials && persistOauth2Credentials({ collectionUid, url, credentials, credentialsId });
+ return { collectionUid, url, credentials, credentialsId, debugInfo };
+ } catch (error) {
+ return Promise.reject(error);
+ }
+};
+
+const getOAuth2AuthorizationCode = (request, codeChallenge, collectionUid) => {
+ return new Promise(async (resolve, reject) => {
+ const { oauth2 } = request;
+ const { callbackUrl, clientId, authorizationUrl, scope, state, pkce, accessTokenUrl, additionalParameters } = oauth2;
+
+ const authorizationUrlWithQueryParams = new URL(authorizationUrl);
+ authorizationUrlWithQueryParams.searchParams.append('response_type', 'code');
+ authorizationUrlWithQueryParams.searchParams.append('client_id', clientId);
+ if (callbackUrl) {
+ authorizationUrlWithQueryParams.searchParams.append('redirect_uri', callbackUrl);
+ }
+ if (scope) {
+ authorizationUrlWithQueryParams.searchParams.append('scope', scope);
+ }
+ if (pkce) {
+ authorizationUrlWithQueryParams.searchParams.append('code_challenge', codeChallenge);
+ authorizationUrlWithQueryParams.searchParams.append('code_challenge_method', 'S256');
+ }
+ if (state) {
+ authorizationUrlWithQueryParams.searchParams.append('state', state);
+ }
+ if (additionalParameters?.authorization?.length) {
+ additionalParameters.authorization.forEach(param => {
+ if (param.enabled && param.name) {
+ if (param.sendIn === 'queryparams') {
+ authorizationUrlWithQueryParams.searchParams.append(param.name, param.value || '');
+ }
+ }
+ });
+ }
+
+ try {
+ const authorizeUrl = authorizationUrlWithQueryParams.toString();
+ const { authorizationCode, debugInfo } = await authorizeUserInWindow({
+ authorizeUrl,
+ callbackUrl,
+ session: oauth2Store.getSessionIdOfCollection({ collectionUid, url: accessTokenUrl }),
+ additionalHeaders: getAdditionalHeaders(additionalParameters?.authorization)
+ });
+ resolve({ authorizationCode, debugInfo });
+ } catch (err) {
+ reject(err);
+ }
+ });
+};
+
+const getAdditionalHeaders = (params) => {
+ if (!params || !params.length) {
+ return {};
+ }
+
+ const headers = {};
+ params.forEach(param => {
+ if (param.enabled && param.name && param.sendIn === 'headers') {
+ headers[param.name] = param.value || '';
+ }
+ });
+
+ return headers;
+};
+
+// CLIENT CREDENTIALS
+
+const getOAuth2TokenUsingClientCredentials = async ({ request, collectionUid, forceFetch = false, certsAndProxyConfig }) => {
+ let requestCopy = cloneDeep(request);
+ const oAuth = get(requestCopy, 'oauth2', {});
+ const {
+ clientId,
+ clientSecret,
+ scope,
+ credentialsPlacement,
+ credentialsId,
+ autoRefreshToken,
+ autoFetchToken,
+ additionalParameters,
+ } = oAuth;
+
+ const url = requestCopy?.oauth2?.accessTokenUrl;
+
+ // Validate required fields
+ if (!url) {
+ return {
+ error: 'Access Token URL is required for OAuth2 client credentials flow',
+ credentials: null,
+ url,
+ credentialsId
+ };
+ }
+
+ if (!clientId) {
+ return {
+ error: 'Client ID is required for OAuth2 client credentials flow',
+ credentials: null,
+ url,
+ credentialsId
+ };
+ }
+
+ if (!forceFetch) {
+ const storedCredentials = getStoredOauth2Credentials({ collectionUid, url, credentialsId });
+
+ if (storedCredentials) {
+ // Token exists
+ if (!isTokenExpired(storedCredentials)) {
+ // Token is valid, use it
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ } else {
+ // Token is expired
+ if (autoRefreshToken && storedCredentials.refresh_token) {
+ // Try to refresh token
+ try {
+ const refreshedCredentialsData = await refreshOauth2Token({ requestCopy, collectionUid, certsAndProxyConfig });
+ return { collectionUid, url, credentials: refreshedCredentialsData.credentials, credentialsId };
+ } catch (error) {
+ clearOauth2Credentials({ collectionUid, url, credentialsId });
+ if (autoFetchToken) {
+ // Proceed to fetch new token
+ } else {
+ // Proceed with expired token
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ }
+ }
+ } else if (autoRefreshToken && !storedCredentials.refresh_token) {
+ if (autoFetchToken) {
+ // Proceed to fetch new token
+ clearOauth2Credentials({ collectionUid, url, credentialsId });
+ } else {
+ // Proceed with expired token
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ }
+ } else if (!autoRefreshToken && autoFetchToken) {
+ // Proceed to fetch new token
+ clearOauth2Credentials({ collectionUid, url, credentialsId });
+ } else {
+ // Proceed with expired token
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ }
+ }
+ } else {
+ // No stored credentials
+ if (autoFetchToken && !storedCredentials) {
+ // Proceed to fetch new token
+ } else {
+ // Proceed without token
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ }
+ }
+ }
+
+ // Fetch new token process
+ let axiosRequestConfig = {};
+ axiosRequestConfig.method = 'POST';
+ axiosRequestConfig.headers = {
+ 'content-type': 'application/x-www-form-urlencoded',
+ 'Accept': 'application/json',
+ };
+ if (credentialsPlacement === "basic_auth_header" && clientSecret && clientSecret.trim() !== '') {
+ axiosRequestConfig.headers['Authorization'] = `Basic ${Buffer.from(`${encodeURIComponent(clientId)}:${encodeURIComponent(clientSecret)}`).toString('base64')}`;
+ }
+ const data = {
+ grant_type: 'client_credentials',
+ };
+ if (credentialsPlacement !== "basic_auth_header") {
+ data.client_id = clientId;
+ }
+ if (clientSecret && clientSecret.trim() !== '' && credentialsPlacement !== "basic_auth_header") {
+ data.client_secret = clientSecret;
+ }
+ if (scope && scope.trim() !== '') {
+ data.scope = scope;
+ }
+ axiosRequestConfig.url = url;
+ axiosRequestConfig.responseType = 'arraybuffer';
+ if (additionalParameters?.token?.length) {
+ applyAdditionalParameters(axiosRequestConfig, data, additionalParameters.token);
+ }
+ axiosRequestConfig.data = qs.stringify(data);
+ let debugInfo = { data: [] };
+ try {
+ const { credentials, requestDetails } = await getCredentialsFromTokenUrl({ requestConfig: axiosRequestConfig, certsAndProxyConfig });
+ debugInfo.data.push(requestDetails);
+ credentials && persistOauth2Credentials({ collectionUid, url, credentials, credentialsId });
+ return { collectionUid, url, credentials, credentialsId, debugInfo };
+ } catch (error) {
+ return Promise.reject(safeStringifyJSON(error?.response?.data));
+ }
+};
+
+// PASSWORD CREDENTIALS
+
+const getOAuth2TokenUsingPasswordCredentials = async ({ request, collectionUid, forceFetch = false, certsAndProxyConfig }) => {
+ let requestCopy = cloneDeep(request);
+ const oAuth = get(requestCopy, 'oauth2', {});
+ const {
+ username,
+ password,
+ clientId,
+ clientSecret,
+ scope,
+ credentialsPlacement,
+ credentialsId,
+ autoRefreshToken,
+ autoFetchToken,
+ additionalParameters,
+ } = oAuth;
+ const url = requestCopy?.oauth2?.accessTokenUrl;
+
+ // Validate required fields
+ if (!url) {
+ return {
+ error: 'Access Token URL is required for OAuth2 password credentials flow',
+ credentials: null,
+ url,
+ credentialsId
+ };
+ }
+
+ if (!username) {
+ return {
+ error: 'Username is required for OAuth2 password credentials flow',
+ credentials: null,
+ url,
+ credentialsId
+ };
+ }
+
+ if (!password) {
+ return {
+ error: 'Password is required for OAuth2 password credentials flow',
+ credentials: null,
+ url,
+ credentialsId
+ };
+ }
+
+ if (!clientId) {
+ return {
+ error: 'Client ID is required for OAuth2 password credentials flow',
+ credentials: null,
+ url,
+ credentialsId
+ };
+ }
+
+ if (!forceFetch) {
+ const storedCredentials = getStoredOauth2Credentials({ collectionUid, url, credentialsId });
+
+ if (storedCredentials) {
+ // Token exists
+ if (!isTokenExpired(storedCredentials)) {
+ // Token is valid, use it
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ } else {
+ // Token is expired
+ if (autoRefreshToken && storedCredentials.refresh_token) {
+ // Try to refresh token
+ try {
+ const refreshedCredentialsData = await refreshOauth2Token({ requestCopy, collectionUid, certsAndProxyConfig });
+ return { collectionUid, url, credentials: refreshedCredentialsData.credentials, credentialsId };
+ } catch (error) {
+ clearOauth2Credentials({ collectionUid, url, credentialsId });
+ if (autoFetchToken) {
+ // Proceed to fetch new token
+ } else {
+ // Proceed with expired token
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ }
+ }
+ } else if (autoRefreshToken && !storedCredentials.refresh_token) {
+ // Cannot refresh; try autoFetchToken
+ if (autoFetchToken) {
+ // Proceed to fetch new token
+ clearOauth2Credentials({ collectionUid, url, credentialsId });
+ } else {
+ // Proceed with expired token
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ }
+ } else if (!autoRefreshToken && autoFetchToken) {
+ // Proceed to fetch new token
+ clearOauth2Credentials({ collectionUid, url, credentialsId });
+ } else {
+ // Proceed with expired token
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ }
+ }
+ } else {
+ // No stored credentials
+ if (autoFetchToken && !storedCredentials) {
+ // Proceed to fetch new token
+ } else {
+ // Proceed without token
+ return { collectionUid, url, credentials: storedCredentials, credentialsId };
+ }
+ }
+ }
+
+ // Fetch new token process
+ let axiosRequestConfig = {};
+ axiosRequestConfig.method = 'POST';
+ axiosRequestConfig.headers = {
+ 'content-type': 'application/x-www-form-urlencoded',
+ 'Accept': 'application/json',
+ };
+ if (credentialsPlacement === "basic_auth_header" && clientSecret && clientSecret.trim() !== '') {
+ axiosRequestConfig.headers['Authorization'] = `Basic ${Buffer.from(`${encodeURIComponent(clientId)}:${encodeURIComponent(clientSecret)}`).toString('base64')}`;
+ }
+ const data = {
+ grant_type: 'password',
+ username,
+ password,
+ };
+ if (credentialsPlacement !== "basic_auth_header") {
+ data.client_id = clientId;
+ }
+ if (clientSecret && clientSecret.trim() !== '' && credentialsPlacement !== "basic_auth_header") {
+ data.client_secret = clientSecret;
+ }
+ if (scope && scope.trim() !== '') {
+ data.scope = scope;
+ }
+ axiosRequestConfig.url = url;
+ axiosRequestConfig.responseType = 'arraybuffer';
+ if (additionalParameters?.token?.length) {
+ applyAdditionalParameters(axiosRequestConfig, data, additionalParameters.token);
+ }
+ axiosRequestConfig.data = qs.stringify(data);
+ let debugInfo = { data: [] };
+ try {
+ const { credentials, requestDetails } = await getCredentialsFromTokenUrl({ requestConfig: axiosRequestConfig, certsAndProxyConfig });
+ debugInfo.data.push(requestDetails);
+ credentials && persistOauth2Credentials({ collectionUid, url, credentials, credentialsId });
+ return { collectionUid, url, credentials, credentialsId, debugInfo };
+ } catch (error) {
+ return Promise.reject(safeStringifyJSON(error?.response?.data));
+ }
+};
+
+const refreshOauth2Token = async ({ requestCopy, collectionUid, certsAndProxyConfig }) => {
+ const oAuth = get(requestCopy, 'oauth2', {});
+ const { clientId, clientSecret, credentialsId, credentialsPlacement, additionalParameters } = oAuth;
+ const url = oAuth.refreshTokenUrl ? oAuth.refreshTokenUrl : oAuth.accessTokenUrl;
+
+ const credentials = getStoredOauth2Credentials({ collectionUid, url, credentialsId });
+ if (!credentials?.refresh_token) {
+ clearOauth2Credentials({ collectionUid, url, credentialsId });
+ // Proceed without token
+ return { collectionUid, url, credentials: null, credentialsId };
+ } else {
+ const data = {
+ grant_type: 'refresh_token',
+ refresh_token: credentials.refresh_token,
+ };
+ if (credentialsPlacement !== "basic_auth_header") {
+ data.client_id = clientId;
+ }
+ if (clientSecret && clientSecret.trim() !== '' && credentialsPlacement !== "basic_auth_header") {
+ data.client_secret = clientSecret;
+ }
+ let axiosRequestConfig = {};
+ axiosRequestConfig.method = 'POST';
+ axiosRequestConfig.headers = {
+ 'content-type': 'application/x-www-form-urlencoded',
+ 'Accept': 'application/json'
+ };
+ if (credentialsPlacement === "basic_auth_header") {
+ axiosRequestConfig.headers['Authorization'] = `Basic ${Buffer.from(`${encodeURIComponent(clientId)}:${encodeURIComponent(clientSecret)}`).toString('base64')}`;
+ }
+ axiosRequestConfig.url = url;
+ axiosRequestConfig.responseType = 'arraybuffer';
+ if (additionalParameters?.refresh?.length) {
+ applyAdditionalParameters(axiosRequestConfig, data, additionalParameters.refresh);
+ }
+ axiosRequestConfig.data = qs.stringify(data);
+ let debugInfo = { data: [] };
+ try {
+ const { credentials, requestDetails } = await getCredentialsFromTokenUrl({ requestConfig: axiosRequestConfig, certsAndProxyConfig });
+ debugInfo.data.push(requestDetails);
+ if (!credentials || credentials?.error) {
+ clearOauth2Credentials({ collectionUid, url, credentialsId });
+ return { collectionUid, url, credentials: null, credentialsId, debugInfo };
+ }
+ credentials && persistOauth2Credentials({ collectionUid, url, credentials, credentialsId });
+ return { collectionUid, url, credentials, credentialsId, debugInfo };
+ } catch (error) {
+ clearOauth2Credentials({ collectionUid, url, credentialsId });
+ // Proceed without token
+ return { collectionUid, url, credentials: null, credentialsId, debugInfo };
+ }
+ }
+};
+
+// HELPER FUNCTIONS
+
+const generateCodeVerifier = () => {
+ return crypto.randomBytes(22).toString('hex');
+};
+
+const generateCodeChallenge = (codeVerifier) => {
+ const hash = crypto.createHash('sha256');
+ hash.update(codeVerifier);
+ const base64Hash = hash.digest('base64')
+ .replace(/\+/g, '-')
+ .replace(/\//g, '_')
+ .replace(/=/g, '');
+ return base64Hash;
+};
+
+// Apply additional parameters to a request
+const applyAdditionalParameters = (requestCopy, data, params = []) => {
+ params.forEach(param => {
+ if (!param.enabled || !param.name) {
+ return;
+ }
+
+ switch (param.sendIn) {
+ case 'headers':
+ requestCopy.headers[param.name] = param.value || '';
+ break;
+ case 'queryparams':
+ // For query params, add to URL
+ try {
+ let url = new URL(requestCopy.url);
+ url.searchParams.append(param.name, param.value || '');
+ requestCopy.url = url.href;
+ }
+ catch (error) {
+ console.error('invalid token/refresh url', requestCopy.url);
+ }
+ break;
+ case 'body':
+ // For body, add to data object
+ data[param.name] = param.value || '';
+ break;
+ }
+ });
+}
+
+const getOAuth2TokenUsingImplicitGrant = async ({ request, collectionUid, forceFetch = false }) => {
+ const { oauth2 = {} } = request;
+ const {
+ authorizationUrl,
+ clientId,
+ scope,
+ state = '',
+ callbackUrl,
+ credentialsId = 'credentials',
+ autoFetchToken = true,
+ additionalParameters
+ } = oauth2;
+
+ // Validate required fields
+ if (!authorizationUrl) {
+ return {
+ error: 'Authorization URL is required for OAuth2 implicit flow',
+ credentials: null,
+ url: authorizationUrl,
+ credentialsId
+ };
+ }
+
+ if (!callbackUrl) {
+ return {
+ error: 'Callback URL is required for OAuth2 implicit flow',
+ credentials: null,
+ url: authorizationUrl,
+ credentialsId
+ };
+ }
+
+ // Check if we already have valid credentials
+ if (!forceFetch) {
+ try {
+ const storedCredentials = getStoredOauth2Credentials({
+ collectionUid,
+ url: authorizationUrl,
+ credentialsId
+ });
+
+ if (storedCredentials) {
+ // Token exists
+ if (!isTokenExpired(storedCredentials)) {
+ // Token is valid, use it
+ return {
+ collectionUid,
+ credentials: storedCredentials,
+ url: authorizationUrl,
+ credentialsId
+ };
+ } else {
+ // Token is expired - unlike other grant types, implicit flow doesn't support refresh tokens
+ if (autoFetchToken) {
+ // Proceed to fetch new token
+ clearOauth2Credentials({ collectionUid, url: authorizationUrl, credentialsId });
+ } else {
+ // Proceed with expired token
+ return {
+ collectionUid,
+ credentials: storedCredentials,
+ url: authorizationUrl,
+ credentialsId
+ };
+ }
+ }
+ } else {
+ // No stored credentials
+ if (!autoFetchToken) {
+ // Don't fetch token if autoFetchToken is disabled
+ return {
+ collectionUid,
+ credentials: null,
+ url: authorizationUrl,
+ credentialsId
+ };
+ }
+ // Otherwise proceed to fetch new token
+ }
+ } catch (error) {
+ console.error('Error retrieving oauth2 credentials from cache', error);
+ clearOauth2Credentials({ collectionUid, url: authorizationUrl, credentialsId });
+ }
+ }
+
+ const authorizationUrlWithQueryParams = new URL(authorizationUrl);
+ authorizationUrlWithQueryParams.searchParams.append('response_type', 'token');
+ authorizationUrlWithQueryParams.searchParams.append('client_id', clientId);
+ authorizationUrlWithQueryParams.searchParams.append('redirect_uri', callbackUrl);
+ if (scope) {
+ authorizationUrlWithQueryParams.searchParams.append('scope', scope);
+ }
+ if (state) {
+ authorizationUrlWithQueryParams.searchParams.append('state', state);
+ }
+ if (additionalParameters?.authorization?.length) {
+ additionalParameters.authorization.forEach(param => {
+ if (param.enabled && param.name) {
+ if (param.sendIn === 'queryparams') {
+ authorizationUrlWithQueryParams.searchParams.append(param.name, param.value || '');
+ }
+ }
+ });
+ }
+
+ const authorizeUrl = authorizationUrlWithQueryParams.toString();
+
+ try {
+ const { implicitTokens, debugInfo } = await authorizeUserInWindow({
+ authorizeUrl,
+ callbackUrl,
+ session: oauth2Store.getSessionIdOfCollection({ collectionUid, url: authorizationUrl }),
+ grantType: 'implicit',
+ additionalHeaders: getAdditionalHeaders(additionalParameters?.authorization)
+ });
+
+ if (!implicitTokens || !implicitTokens.access_token) {
+ return {
+ error: 'No access token received from authorization server',
+ credentials: null,
+ url: authorizationUrl,
+ credentialsId,
+ debugInfo
+ };
+ }
+
+ const credentials = {
+ access_token: implicitTokens.access_token,
+ token_type: implicitTokens.token_type || 'Bearer',
+ state: implicitTokens.state || '',
+ ...(implicitTokens.expires_in ? { expires_in: parseInt(implicitTokens.expires_in) } : {}),
+ created_at: Date.now()
+ };
+
+ if (implicitTokens.scope) {
+ credentials.scope = implicitTokens.scope;
+ }
+
+ // Store the credentials
+ persistOauth2Credentials({
+ collectionUid,
+ url: authorizationUrl,
+ credentials,
+ credentialsId
+ });
+
+ return {
+ collectionUid,
+ credentials,
+ url: authorizationUrl,
+ credentialsId,
+ debugInfo
+ };
+ } catch (error) {
+ return {
+ error: error.message || 'Failed to obtain token',
+ credentials: null,
+ url: authorizationUrl,
+ credentialsId
+ };
+ }
+};
+
+module.exports = {
+ persistOauth2Credentials,
+ clearOauth2Credentials,
+ getStoredOauth2Credentials,
+ getOAuth2TokenUsingAuthorizationCode,
+ getOAuth2TokenUsingClientCredentials,
+ getOAuth2TokenUsingPasswordCredentials,
+ getOAuth2TokenUsingImplicitGrant,
+ refreshOauth2Token,
+ generateCodeVerifier,
+ generateCodeChallenge
+};
\ No newline at end of file
diff --git a/packages/bruno-electron/src/utils/parse.js b/packages/bruno-electron/src/utils/parse.js
new file mode 100644
index 000000000..655b9e6f7
--- /dev/null
+++ b/packages/bruno-electron/src/utils/parse.js
@@ -0,0 +1,42 @@
+const { parseRequestAndRedactBody, parseRequestViaWorker } = require('@usebruno/filestore');
+
+/**
+ * Parses a large BRU request string by redacting body blocks, parsing the remainder,
+ * and then reinserting extracted body content into the parsed structure.
+ * @param {string} bruContent
+ * @returns {Promise} parsed request JSON
+ */
+async function parseLargeRequestWithRedaction(bruContent) {
+ const { bruFileStringWithRedactedBody, extractedBodyContent } = parseRequestAndRedactBody(bruContent);
+ const parsedData = await parseRequestViaWorker(bruFileStringWithRedactedBody);
+
+ if (!parsedData.request) {
+ parsedData.request = {};
+ }
+ if (!parsedData.request.body) {
+ parsedData.request.body = {};
+ }
+
+ if (extractedBodyContent.json) {
+ parsedData.request.body.json = extractedBodyContent.json;
+ }
+ if (extractedBodyContent.text) {
+ parsedData.request.body.text = extractedBodyContent.text;
+ }
+ if (extractedBodyContent.xml) {
+ parsedData.request.body.xml = extractedBodyContent.xml;
+ }
+ if (extractedBodyContent.sparql) {
+ parsedData.request.body.sparql = extractedBodyContent.sparql;
+ }
+ if (extractedBodyContent.graphql) {
+ if (!parsedData.request.body.graphql) {
+ parsedData.request.body.graphql = {};
+ }
+ parsedData.request.body.graphql.query = extractedBodyContent.graphql;
+ }
+
+ return parsedData;
+}
+
+module.exports = { parseLargeRequestWithRedaction };
\ No newline at end of file
diff --git a/packages/bruno-electron/src/utils/proxy-util.js b/packages/bruno-electron/src/utils/proxy-util.js
index ef64d37ad..f611ea1f6 100644
--- a/packages/bruno-electron/src/utils/proxy-util.js
+++ b/packages/bruno-electron/src/utils/proxy-util.js
@@ -1,6 +1,11 @@
const parseUrl = require('url').parse;
-const { isEmpty } = require('lodash');
+const https = require('https');
const { HttpsProxyAgent } = require('https-proxy-agent');
+const { interpolateString } = require('../ipc/network/interpolate-string');
+const { SocksProxyAgent } = require('socks-proxy-agent');
+const { HttpProxyAgent } = require('http-proxy-agent');
+const { preferencesUtil } = require('../store/preferences');
+const { isEmpty, get, isUndefined, isNull } = require('lodash');
const DEFAULT_PORTS = {
ftp: 21,
@@ -79,7 +84,310 @@ class PatchedHttpsProxyAgent extends HttpsProxyAgent {
}
}
+function createTimelineAgentClass(BaseAgentClass) {
+ return class extends BaseAgentClass {
+ constructor(options, timeline) {
+ // For proxy agents, the first argument is the proxy URI and the second is options
+ if (options?.proxy) {
+ const { proxy: proxyUri, ...agentOptions } = options;
+ // Ensure TLS options are properly set
+ const tlsOptions = {
+ ...agentOptions,
+ rejectUnauthorized: agentOptions.rejectUnauthorized ?? true,
+ };
+ super(proxyUri, tlsOptions);
+ this.timeline = Array.isArray(timeline) ? timeline : [];
+ this.alpnProtocols = tlsOptions.ALPNProtocols || ['h2', 'http/1.1'];
+ this.caProvided = !!tlsOptions.ca;
+
+ // Log TLS verification status
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'info',
+ message: `SSL validation: ${tlsOptions.rejectUnauthorized ? 'enabled' : 'disabled'}`,
+ });
+
+ // Log the proxy details
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'info',
+ message: `Using proxy: ${proxyUri}`,
+ });
+ } else {
+ // This is a regular HTTPS agent case
+ const tlsOptions = {
+ ...options,
+ rejectUnauthorized: options.rejectUnauthorized ?? true,
+ };
+ super(tlsOptions);
+ this.timeline = Array.isArray(timeline) ? timeline : [];
+ this.alpnProtocols = options.ALPNProtocols || ['h2', 'http/1.1'];
+ this.caProvided = !!options.ca;
+
+ // Log TLS verification status
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'info',
+ message: `SSL validation: ${tlsOptions.rejectUnauthorized ? 'enabled' : 'disabled'}`,
+ });
+ }
+ }
+
+
+ createConnection(options, callback) {
+ const { host, port } = options;
+
+ // Log ALPN protocols offered
+ if (this.alpnProtocols && this.alpnProtocols.length > 0) {
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'tls',
+ message: `ALPN: offers ${this.alpnProtocols.join(', ')}`,
+ });
+ }
+
+ // Log CAfile and CApath (if possible)
+ if (this.caProvided) {
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'tls',
+ message: `CA certificates provided`,
+ });
+ } else {
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'tls',
+ message: `Using system default CA certificates`,
+ });
+ }
+
+ // Log "Trying host:port..."
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'info',
+ message: `Trying ${host}:${port}...`,
+ });
+
+ let socket;
+ try {
+ socket = super.createConnection(options, callback);
+ } catch (error) {
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'error',
+ message: `Error creating connection: ${error.message}`,
+ });
+ error.timeline = this.timeline;
+ throw error;
+ }
+
+ // Attach event listeners to the socket
+ socket?.on('lookup', (err, address, family, host) => {
+ if (err) {
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'error',
+ message: `DNS lookup error for ${host}: ${err.message}`,
+ });
+ } else {
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'info',
+ message: `DNS lookup: ${host} -> ${address}`,
+ });
+ }
+ });
+
+ socket?.on('connect', () => {
+ const address = socket.remoteAddress || host;
+ const remotePort = socket.remotePort || port;
+
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'info',
+ message: `Connected to ${host} (${address}) port ${remotePort}`,
+ });
+ });
+
+ socket?.on('secureConnect', () => {
+ const protocol = socket.getProtocol() || 'SSL/TLS';
+ const cipher = socket.getCipher();
+ const cipherSuite = cipher ? `${cipher.name} (${cipher.version})` : 'Unknown cipher';
+
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'tls',
+ message: `SSL connection using ${protocol} / ${cipherSuite}`,
+ });
+
+ // ALPN protocol
+ const alpnProtocol = socket.alpnProtocol || 'None';
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'tls',
+ message: `ALPN: server accepted ${alpnProtocol}`,
+ });
+
+ // Server certificate
+ const cert = socket.getPeerCertificate(true);
+ if (cert) {
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'tls',
+ message: `Server certificate:`,
+ });
+ if (cert.subject) {
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'tls',
+ message: ` subject: ${Object.entries(cert.subject).map(([k, v]) => `${k}=${v}`).join(', ')}`,
+ });
+ }
+ if (cert.valid_from) {
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'tls',
+ message: ` start date: ${cert.valid_from}`,
+ });
+ }
+ if (cert.valid_to) {
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'tls',
+ message: ` expire date: ${cert.valid_to}`,
+ });
+ }
+ if (cert.subjectaltname) {
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'tls',
+ message: ` subjectAltName: ${cert.subjectaltname}`,
+ });
+ }
+ if (cert.issuer) {
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'tls',
+ message: ` issuer: ${Object.entries(cert.issuer).map(([k, v]) => `${k}=${v}`).join(', ')}`,
+ });
+ }
+
+ // SSL certificate verify ok
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'tls',
+ message: `SSL certificate verify ok.`,
+ });
+ }
+ });
+
+ socket?.on('error', (err) => {
+ this.timeline.push({
+ timestamp: new Date(),
+ type: 'error',
+ message: `Socket error: ${err.message}`,
+ });
+ });
+
+ return socket;
+ }
+ };
+}
+
+function setupProxyAgents({
+ requestConfig,
+ proxyMode = 'off',
+ proxyConfig,
+ httpsAgentRequestFields,
+ interpolationOptions,
+ timeline,
+}) {
+ // Ensure TLS options are properly set
+ const tlsOptions = {
+ ...httpsAgentRequestFields,
+ // Enable all secure protocols by default
+ secureProtocol: undefined,
+ // Allow Node.js to choose the protocol
+ minVersion: 'TLSv1',
+ rejectUnauthorized: httpsAgentRequestFields.rejectUnauthorized !== undefined ? httpsAgentRequestFields.rejectUnauthorized : true,
+ };
+
+ if (proxyMode === 'on') {
+ const shouldProxy = shouldUseProxy(requestConfig.url, get(proxyConfig, 'bypassProxy', ''));
+ if (shouldProxy) {
+ const proxyProtocol = interpolateString(get(proxyConfig, 'protocol'), interpolationOptions);
+ const proxyHostname = interpolateString(get(proxyConfig, 'hostname'), interpolationOptions);
+ const proxyPort = interpolateString(get(proxyConfig, 'port'), interpolationOptions);
+ const proxyAuthEnabled = get(proxyConfig, 'auth.enabled', false);
+ const socksEnabled = proxyProtocol.includes('socks');
+
+ let uriPort = isUndefined(proxyPort) || isNull(proxyPort) ? '' : `:${proxyPort}`;
+ let proxyUri;
+ if (proxyAuthEnabled) {
+ const proxyAuthUsername = encodeURIComponent(interpolateString(get(proxyConfig, 'auth.username'), interpolationOptions));
+ const proxyAuthPassword = encodeURIComponent(interpolateString(get(proxyConfig, 'auth.password'), interpolationOptions));
+ proxyUri = `${proxyProtocol}://${proxyAuthUsername}:${proxyAuthPassword}@${proxyHostname}${uriPort}`;
+ } else {
+ proxyUri = `${proxyProtocol}://${proxyHostname}${uriPort}`;
+ }
+
+ if (socksEnabled) {
+ const TimelineSocksProxyAgent = createTimelineAgentClass(SocksProxyAgent);
+ requestConfig.httpAgent = new TimelineSocksProxyAgent({ proxy: proxyUri }, timeline);
+ requestConfig.httpsAgent = new TimelineSocksProxyAgent({ proxy: proxyUri, ...tlsOptions }, timeline);
+ } else {
+ const TimelineHttpsProxyAgent = createTimelineAgentClass(PatchedHttpsProxyAgent);
+ requestConfig.httpAgent = new HttpProxyAgent(proxyUri); // For http, no need for timeline
+ requestConfig.httpsAgent = new TimelineHttpsProxyAgent(
+ { proxy: proxyUri, ...tlsOptions },
+ timeline
+ );
+ }
+ } else {
+ // If proxy should not be used, set default HTTPS agent
+ const TimelineHttpsAgent = createTimelineAgentClass(https.Agent);
+ requestConfig.httpsAgent = new TimelineHttpsAgent(tlsOptions, timeline);
+ }
+ } else if (proxyMode === 'system') {
+ const { http_proxy, https_proxy, no_proxy } = preferencesUtil.getSystemProxyEnvVariables();
+ const shouldUseSystemProxy = shouldUseProxy(requestConfig.url, no_proxy || '');
+ if (shouldUseSystemProxy) {
+ try {
+ if (http_proxy?.length) {
+ new URL(http_proxy);
+ requestConfig.httpAgent = new HttpProxyAgent(http_proxy);
+ }
+ } catch (error) {
+ throw new Error('Invalid system http_proxy');
+ }
+ try {
+ if (https_proxy?.length) {
+ new URL(https_proxy);
+ const TimelineHttpsProxyAgent = createTimelineAgentClass(PatchedHttpsProxyAgent);
+ requestConfig.httpsAgent = new TimelineHttpsProxyAgent(
+ { proxy: https_proxy,...tlsOptions },
+ timeline
+ );
+ } else {
+ const TimelineHttpsAgent = createTimelineAgentClass(https.Agent);
+ requestConfig.httpsAgent = new TimelineHttpsAgent(tlsOptions, timeline);
+ }
+ } catch (error) {
+ throw new Error('Invalid system https_proxy');
+ }
+ } else {
+ const TimelineHttpsAgent = createTimelineAgentClass(https.Agent);
+ requestConfig.httpsAgent = new TimelineHttpsAgent(tlsOptions, timeline);
+ }
+ } else {
+ const TimelineHttpsAgent = createTimelineAgentClass(https.Agent);
+ requestConfig.httpsAgent = new TimelineHttpsAgent(tlsOptions, timeline);
+ }
+}
+
+
module.exports = {
shouldUseProxy,
- PatchedHttpsProxyAgent
+ PatchedHttpsProxyAgent,
+ setupProxyAgents
};
diff --git a/packages/bruno-electron/src/utils/tests/filesystem/index.spec.js b/packages/bruno-electron/src/utils/tests/filesystem/index.spec.js
new file mode 100644
index 000000000..60add1b57
--- /dev/null
+++ b/packages/bruno-electron/src/utils/tests/filesystem/index.spec.js
@@ -0,0 +1,116 @@
+const path = require('path');
+const fs = require('fs/promises');
+const os = require('os');
+const { copyPath, removePath } = require('../../filesystem');
+const { initialCollectionStructure, finalCollectionStructure } = require('../fixtures/filesystem/copypath-removepath');
+
+describe('File System Operations', () => {
+ let tempDir;
+
+ beforeAll(async () => {
+ // Create a temporary directory for each test
+ tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'bruno-test-'));
+ await createFilesAndFolders(tempDir, initialCollectionStructure);
+ const result = await verifyFilesAndFolders(tempDir, initialCollectionStructure);
+ expect(result).toBe(true);
+ });
+
+ afterAll(async () => {
+ // clean up after each test
+ await fs.rm(tempDir, { recursive: true, force: true });
+ // confirm the temp directory is deleted
+ expect(await fs.access(tempDir).then(() => true).catch(() => false)).toBe(false);
+ });
+
+ describe('copyPath and removePath', () => {
+ it('should move files and folder items multiple times', async () => {
+
+ {
+ const sourcePath = path.join(tempDir, 'folder_1', 'file_2.bru');
+ const destDir = path.join(tempDir, 'folder_1', 'folder_1_1');
+ await copyPath(sourcePath, destDir);
+ await removePath(sourcePath);
+ }
+
+ {
+ const sourcePath = path.join(tempDir, 'folder_2');
+ const destDir = path.join(tempDir, 'folder_1', 'folder_1_1');
+ await copyPath(sourcePath, destDir);
+ await removePath(sourcePath);
+ }
+
+ {
+ const sourcePath = path.join(tempDir, 'folder_1', 'folder_1_1', 'folder_2', 'file_2_2.bru');
+ const destDir = path.join(tempDir, 'folder_1');
+ await copyPath(sourcePath, destDir);
+ await removePath(sourcePath);
+ }
+
+ {
+ const sourcePath = path.join(tempDir, 'folder_1', 'folder_1_1', 'folder_2', 'folder_2_1');
+ const destDir = path.join(tempDir);
+ await copyPath(sourcePath, destDir);
+ await removePath(sourcePath);
+ }
+
+ const result = await verifyFilesAndFolders(tempDir, finalCollectionStructure);
+ expect(result).toBe(true);
+ });
+
+
+ it('should throw an error move file/folder if the destination has the same filename', async () => {
+ {
+ const sourcePath = path.join(tempDir, 'folder_1', 'file_dup.bru');
+ const destDir = path.join(tempDir, 'folder_1');
+ await expect(copyPath(sourcePath, destDir)).rejects.toThrow();
+ }
+ });
+
+ });
+});
+
+
+// create folders and files recursively based on the defined json structure
+const createFilesAndFolders = async (dir, filesAndFolders) => {
+ for (const item of filesAndFolders) {
+ const itemPath = path.join(dir, item.name);
+ if (item.type === 'folder') {
+ await fs.mkdir(itemPath, { recursive: true });
+ await createFilesAndFolders(itemPath, item.files);
+ } else {
+ await fs.writeFile(itemPath, item.content);
+ }
+ }
+}
+
+// if a file/folder doesnt exist, return false
+// should only contain files and folders that are defined in the json structure
+const verifyFilesAndFolders = async (dir, filesAndFolders) => {
+ const verify = async (dir, filesAndFolders) => {
+ const files = await fs.readdir(dir);
+ if (files.length !== filesAndFolders.length) {
+ return false;
+ }
+ for (const file of files) {
+ const itemPath = path.join(dir, file);
+ const item = filesAndFolders.find(f => f.name === file);
+ if (!item) {
+ return false;
+ }
+ if (item.type === 'folder') {
+ return await verify(itemPath, item.files);
+ } else {
+ return await fs.readFile(itemPath, 'utf8').then(content => content === item.content);
+ }
+ }
+ return true;
+ }
+
+ try {
+ const verified = await verify(dir, filesAndFolders);
+ return verified;
+ } catch (error) {
+ console.error(error);
+ return false;
+ }
+}
\ No newline at end of file
diff --git a/packages/bruno-electron/src/utils/tests/fixtures/filesystem/copypath-removepath.js b/packages/bruno-electron/src/utils/tests/fixtures/filesystem/copypath-removepath.js
new file mode 100644
index 000000000..ea08f8d25
--- /dev/null
+++ b/packages/bruno-electron/src/utils/tests/fixtures/filesystem/copypath-removepath.js
@@ -0,0 +1,155 @@
+const initialCollectionStructure = [
+ {
+ "name": "folder_1",
+ "type": "folder",
+ "files": [
+ {
+ "name": "file_1.bru",
+ "type": "file",
+ "content": "file_1_content"
+ },
+ {
+ "name": "file_2.bru",
+ "type": "file",
+ "content": "file_2_content"
+ },
+ {
+ "name": "folder_1_1",
+ "type": "folder",
+ "files": [
+ {
+ "name": "file_1_1.bru",
+ "type": "file",
+ "content": "file_1_1_content"
+ },
+ {
+ "name": "file_1_2.bru",
+ "type": "file",
+ "content": "file_1_2_content"
+ }
+ ]
+ },
+ {
+ "name": "file_1_3.bru",
+ "type": "file",
+ "content": "file_1_3_content"
+ },
+ {
+ "name": "file_dup.bru",
+ "type": "file",
+ "content": "file_dup_content"
+ }
+ ],
+ },
+ {
+ "name": "folder_2",
+ "type": "folder",
+ "files": [
+ {
+ "name": "file_2_1.bru",
+ "type": "file",
+ "content": "file_2_1_content"
+ },
+ {
+ "name": "file_2_2.bru",
+ "type": "file",
+ "content": "file_2_2_content"
+ },
+ {
+ "name": "folder_2_1",
+ "type": "folder",
+ "files": [
+ {
+ "name": "file_2_1_1.bru",
+ "type": "file",
+ "content": "file_2_1_1_content"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "name": "file_dup.bru",
+ "type": "file",
+ "content": "file_dup_content"
+ }
+];
+
+const finalCollectionStructure = [
+ {
+ "name": "folder_1",
+ "type": "folder",
+ "files": [
+ {
+ "name": "file_1.bru",
+ "type": "file",
+ "content": "file_1_content"
+ },
+ {
+ "name": "folder_1_1",
+ "type": "folder",
+ "files": [
+ {
+ "name": "file_1_1.bru",
+ "type": "file",
+ "content": "file_1_1_content"
+ },
+ {
+ "name": "file_1_2.bru",
+ "type": "file",
+ "content": "file_1_2_content"
+ },
+ {
+ "name": "file_2.bru",
+ "type": "file",
+ "content": "file_2_content"
+ },
+ {
+ "name": "folder_2",
+ "type": "folder",
+ "files": [
+ {
+ "name": "file_2_1.bru",
+ "type": "file",
+ "content": "file_2_1_content"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "name": "file_1_3.bru",
+ "type": "file",
+ "content": "file_1_3_content"
+ },
+ {
+ "name": "file_2_2.bru",
+ "type": "file",
+ "content": "file_2_2_content"
+ },
+ {
+ "name": "file_dup.bru",
+ "type": "file",
+ "content": "file_dup_content"
+ }
+ ],
+ },
+ {
+ "name": "folder_2_1",
+ "type": "folder",
+ "files": [
+ {
+ "name": "file_2_1_1.bru",
+ "type": "file",
+ "content": "file_2_1_1_content"
+ }
+ ]
+ },
+ {
+ "name": "file_dup.bru",
+ "type": "file",
+ "content": "file_dup_content"
+ }
+];
+
+module.exports = { initialCollectionStructure, finalCollectionStructure };
\ No newline at end of file
diff --git a/packages/bruno-electron/tests/cookies-store.test.js b/packages/bruno-electron/tests/cookies-store.test.js
new file mode 100644
index 000000000..12b859e07
--- /dev/null
+++ b/packages/bruno-electron/tests/cookies-store.test.js
@@ -0,0 +1,71 @@
+const path = require('path');
+
+const mockEncrypt = (str) => (str.length ? `$enc:${str}` : '');
+const mockDecrypt = (str) => str.replace(/^\$enc:/, '');
+
+jest.mock('../src/utils/encryption', () => ({
+ encryptString: jest.fn(mockEncrypt),
+ decryptString: jest.fn(mockDecrypt)
+}));
+
+jest.mock('electron-store', () => {
+ return jest.fn().mockImplementation((opts = {}) => {
+ const data = { ...(opts.defaults || {}) };
+ return {
+ get: (key, fallback) => (key in data ? data[key] : fallback),
+ set: (key, value) => {
+ data[key] = value;
+ }
+ };
+ });
+});
+
+const { CookiesStore } = require(path.join('..', 'src', 'store', 'cookies'));
+
+function createFreshStore() {
+ return new CookiesStore();
+}
+
+describe('CookiesStore', () => {
+ test('setCookies encrypts values and getCookies returns decrypted values', () => {
+ const store = createFreshStore();
+
+ const cookie = {
+ domain: 'example.com',
+ key: 'auth',
+ value: 'token',
+ path: '/',
+ secure: true,
+ httpOnly: true
+ };
+
+ store.setCookies({ cookies: [cookie] });
+
+ // Raw persisted value should be encrypted
+ const raw = store.store.get('cookies');
+ expect(raw['example.com'][0].value).toBe(`$enc:${cookie.value}`);
+
+ // API should return decrypted value
+ const retrieved = store.getCookies();
+ expect(retrieved[0].value).toBe(cookie.value);
+ });
+
+ test('getCookies leaves plain-text cookie values untouched', () => {
+ const store = createFreshStore();
+
+ const plainCookie = {
+ domain: 'example.com',
+ key: 'sid',
+ value: 'plaintext',
+ path: '/',
+ secure: false,
+ httpOnly: false
+ };
+
+ // Manually inject to the underlying store to simulate legacy/plain data
+ store.store.set('cookies', { 'example.com': [plainCookie] });
+
+ const cookies = store.getCookies();
+ expect(cookies[0].value).toBe('plaintext');
+ });
+});
diff --git a/packages/bruno-electron/tests/network/execute-request-error-handler.spec.js b/packages/bruno-electron/tests/network/execute-request-error-handler.spec.js
new file mode 100644
index 000000000..3fe168adb
--- /dev/null
+++ b/packages/bruno-electron/tests/network/execute-request-error-handler.spec.js
@@ -0,0 +1,112 @@
+const { executeRequestOnFailHandler } = require('../../src/ipc/network/index');
+const axios = require('axios');
+
+describe('executeRequestOnFailHandler', () => {
+ let consoleSpy;
+
+ beforeEach(() => {
+ consoleSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
+ });
+
+ afterEach(() => {
+ consoleSpy.mockRestore();
+ });
+
+ it('should do nothing when request is null', async () => {
+ const error = new Error('Test error');
+
+ await executeRequestOnFailHandler(null, error);
+
+ expect(consoleSpy).not.toHaveBeenCalled();
+ });
+
+ it('should do nothing when request is undefined', async () => {
+ const error = new Error('Test error');
+
+ await executeRequestOnFailHandler(undefined, error);
+
+ expect(consoleSpy).not.toHaveBeenCalled();
+ });
+
+ it('should do nothing when onFailHandler is not a function', async () => {
+ const request = { onFailHandler: 'not a function' };
+ const error = new Error('Test error');
+
+ await executeRequestOnFailHandler(request, error);
+
+ expect(consoleSpy).not.toHaveBeenCalled();
+ });
+
+ it('should call onFailHandler when it exists and is a function', async () => {
+ const mockHandler = jest.fn();
+ const request = { onFailHandler: mockHandler };
+ const error = new Error('Test error');
+
+ await executeRequestOnFailHandler(request, error);
+
+ expect(mockHandler).toHaveBeenCalledWith(error);
+ expect(mockHandler).toHaveBeenCalledTimes(1);
+ expect(consoleSpy).not.toHaveBeenCalled();
+ });
+
+ it('should handle errors when onFailHandler fails by mutating the error message', async () => {
+ const handlerError = new Error('Handler failed');
+ const mockHandler = jest.fn(() => {
+ throw handlerError;
+ });
+ const request = { onFailHandler: mockHandler };
+ const error = new Error('Original error');
+
+ await executeRequestOnFailHandler(request, error);
+
+ expect(mockHandler).toHaveBeenCalledWith(error);
+ expect(error.message).toContain('1. Request failed: Original error');
+ expect(error.message).toContain('2. Error executing onFail handler: Handler failed');
+ });
+
+ it('should pass the correct hard error object to the handler for DNS failure', async () => {
+ const mockHandler = jest.fn();
+ const request = { onFailHandler: mockHandler };
+
+ let error;
+ try {
+ await axios.get('https://this-domain-definitely-does-not-exist-12345.com/api/test', {
+ timeout: 5000
+ });
+ } catch (err) {
+ error = err;
+ }
+
+ // Verify this is actually a hard error (no response)
+ expect(error.response).toBeUndefined();
+
+ await executeRequestOnFailHandler(request, error);
+
+ expect(mockHandler).toHaveBeenCalledWith(error);
+ expect(error.message).toContain('ENOTFOUND'); // DNS resolution failed
+ });
+
+ it('should pass the correct hard error object to the handler for connection timeout', async () => {
+ const mockHandler = jest.fn();
+ const request = { onFailHandler: mockHandler };
+
+ let error;
+ try {
+ await axios.get('http://192.168.255.255:9999/api/test', {
+ timeout: 100
+ });
+ } catch (err) {
+ error = err;
+ }
+
+ // Verify this is actually a hard error (no response)
+ expect(error.response).toBeUndefined();
+
+ await executeRequestOnFailHandler(request, error);
+
+ expect(mockHandler).toHaveBeenCalledWith(error);
+ const passedError = mockHandler.mock.calls[0][0];
+ expect(passedError.response).toBeUndefined(); // Should be undefined for hard errors
+ expect(passedError.code).toBe('ECONNABORTED'); // Connection aborted due to timeout
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-electron/tests/network/fetch-gql-schema-handler.spec.js b/packages/bruno-electron/tests/network/fetch-gql-schema-handler.spec.js
new file mode 100644
index 000000000..8831ba48b
--- /dev/null
+++ b/packages/bruno-electron/tests/network/fetch-gql-schema-handler.spec.js
@@ -0,0 +1,371 @@
+const prepareGqlIntrospectionRequest = require('../../src/ipc/network/prepare-gql-introspection-request');
+const { fetchGqlSchemaHandler } = require('../../src/ipc/network');
+
+// Mock only the prepare-gql-introspection-request to avoid network calls
+jest.mock('../../src/ipc/network/prepare-gql-introspection-request', () => {
+ return jest.fn().mockImplementation((endpoint, vars, request, root) => {
+ return {
+ url: endpoint,
+ method: 'POST',
+ headers: request?.headers || {},
+ data: {
+ query: '{ __schema { types { name } } }'
+ }
+ };
+ });
+});
+
+describe('fetchGqlSchemaHandler - variable precedence', () => {
+ beforeEach(() => {
+ jest.clearAllMocks();
+ });
+
+ afterEach(() => {
+ jest.restoreAllMocks();
+ });
+
+ it('should override global environment variables with environment variables', async () => {
+ const endpoint = 'https://example.com/';
+ const environment = {
+ variables: [
+ { name: 'SHARED_VAR', value: 'env-value', enabled: true }
+ ]
+ };
+ const request = {
+ uid: 'test-request',
+ vars: {
+ req: [] // No request variables
+ }
+ };
+ const collection = {
+ uid: 'test-collection',
+ pathname: '/test',
+ runtimeVariables: {},
+ globalEnvironmentVariables: {
+ SHARED_VAR: 'global-value'
+ },
+ items: [
+ {
+ uid: 'test-request',
+ request: {
+ vars: {
+ req: [] // No request variables
+ }
+ }
+ }
+ ],
+ root: {
+ request: {
+ headers: [],
+ vars: {
+ req: [] // No collection variables
+ }
+ }
+ }
+ };
+
+ await fetchGqlSchemaHandler(null, endpoint, environment, request, collection);
+
+ expect(prepareGqlIntrospectionRequest).toHaveBeenCalledWith(
+ endpoint,
+ expect.objectContaining({
+ SHARED_VAR: 'env-value'
+ }),
+ request,
+ collection.root
+ );
+ });
+
+ it('should override environment variables with folder-level variables', async () => {
+ const endpoint = 'https://example.com/';
+ const environment = {
+ variables: [
+ { name: 'SHARED_VAR', value: 'env-value', enabled: true }
+ ]
+ };
+ const request = {
+ uid: 'test-request',
+ vars: {
+ req: [] // No request variables
+ }
+ };
+ const collection = {
+ uid: 'test-collection',
+ pathname: '/test',
+ runtimeVariables: {},
+ globalEnvironmentVariables: {},
+ items: [
+ {
+ uid: 'test-folder',
+ type: 'folder',
+ root: {
+ request: {
+ vars: {
+ req: [
+ { name: 'SHARED_VAR', value: 'folder-value', enabled: true }
+ ]
+ }
+ }
+ },
+ items: [
+ {
+ uid: 'test-request',
+ request: {
+ vars: {
+ req: [] // No request variables
+ }
+ }
+ }
+ ]
+ }
+ ],
+ root: {
+ request: {
+ headers: [],
+ vars: {
+ req: [] // No collection variables
+ }
+ }
+ }
+ };
+
+ await fetchGqlSchemaHandler(null, endpoint, environment, request, collection);
+
+ expect(prepareGqlIntrospectionRequest).toHaveBeenCalledWith(
+ endpoint,
+ expect.objectContaining({
+ SHARED_VAR: 'folder-value'
+ }),
+ request,
+ collection.root
+ );
+ });
+
+ it('should override folder-level variables with request variables', async () => {
+ const endpoint = 'https://example.com/';
+ const environment = {
+ variables: []
+ };
+ const request = {
+ uid: 'test-request',
+ vars: {
+ req: [
+ { name: 'SHARED_VAR', value: 'request-value', enabled: true }
+ ]
+ }
+ };
+ const collection = {
+ uid: 'test-collection',
+ pathname: '/test',
+ runtimeVariables: {},
+ globalEnvironmentVariables: {},
+ items: [
+ {
+ uid: 'test-folder',
+ type: 'folder',
+ root: {
+ request: {
+ vars: {
+ req: [
+ { name: 'SHARED_VAR', value: 'folder-value', enabled: true }
+ ]
+ }
+ }
+ },
+ items: [
+ {
+ uid: 'test-request',
+ request: {
+ vars: {
+ req: [
+ { name: 'SHARED_VAR', value: 'request-value', enabled: true }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ ],
+ root: {
+ request: {
+ headers: [],
+ vars: {
+ req: [] // No collection variables
+ }
+ }
+ }
+ };
+
+ await fetchGqlSchemaHandler(null, endpoint, environment, request, collection);
+
+ expect(prepareGqlIntrospectionRequest).toHaveBeenCalledWith(
+ endpoint,
+ expect.objectContaining({
+ SHARED_VAR: 'request-value'
+ }),
+ request,
+ collection.root
+ );
+ });
+
+ it('should override global environment variables with collection variables', async () => {
+ const endpoint = 'https://example.com/';
+ const environment = {
+ variables: []
+ };
+ const request = {
+ uid: 'test-request',
+ vars: {
+ req: [] // No request variables
+ }
+ };
+ const collection = {
+ uid: 'test-collection',
+ pathname: '/test',
+ runtimeVariables: {},
+ globalEnvironmentVariables: {
+ SHARED_VAR: 'global-value'
+ },
+ items: [
+ {
+ uid: 'test-request',
+ request: {
+ vars: {
+ req: [] // No request variables
+ }
+ }
+ }
+ ],
+ root: {
+ request: {
+ headers: [],
+ vars: {
+ req: [
+ { name: 'SHARED_VAR', value: 'collection-value', enabled: true }
+ ]
+ }
+ }
+ }
+ };
+
+ await fetchGqlSchemaHandler(null, endpoint, environment, request, collection);
+
+ expect(prepareGqlIntrospectionRequest).toHaveBeenCalledWith(
+ endpoint,
+ expect.objectContaining({
+ SHARED_VAR: 'collection-value'
+ }),
+ request,
+ collection.root
+ );
+ });
+
+ it('should override collection variables with environment variables', async () => {
+ const endpoint = 'https://example.com/';
+ const environment = {
+ variables: [
+ { name: 'SHARED_VAR', value: 'env-value', enabled: true }
+ ]
+ };
+ const request = {
+ uid: 'test-request',
+ vars: {
+ req: [] // No request variables
+ }
+ };
+ const collection = {
+ uid: 'test-collection',
+ pathname: '/test',
+ runtimeVariables: {},
+ globalEnvironmentVariables: {},
+ items: [
+ {
+ uid: 'test-request',
+ request: {
+ vars: {
+ req: [] // No request variables
+ }
+ }
+ }
+ ],
+ root: {
+ request: {
+ headers: [],
+ vars: {
+ req: [
+ { name: 'SHARED_VAR', value: 'collection-value', enabled: true }
+ ]
+ }
+ }
+ }
+ };
+
+ await fetchGqlSchemaHandler(null, endpoint, environment, request, collection);
+
+ expect(prepareGqlIntrospectionRequest).toHaveBeenCalledWith(
+ endpoint,
+ expect.objectContaining({
+ SHARED_VAR: 'env-value'
+ }),
+ request,
+ collection.root
+ );
+ });
+
+ it('should override request variables with runtime variables', async () => {
+ const endpoint = 'https://example.com/';
+ const environment = {
+ variables: []
+ };
+
+ const request = {
+ uid: 'test-request',
+ vars: {
+ req: [
+ { name: 'SHARED_VAR', value: 'request-value', enabled: true }
+ ]
+ }
+ };
+
+ const collection = {
+ uid: 'test-collection',
+ pathname: '/test',
+ runtimeVariables: {
+ SHARED_VAR: 'runtime-value'
+ },
+ items: [
+ {
+ uid: 'test-request',
+ request: {
+ vars: {
+ req: [
+ { name: 'SHARED_VAR', value: 'request-value', enabled: true }
+ ]
+ }
+ }
+ }
+ ],
+ root: {
+ request: {
+ headers: [],
+ vars: {
+ req: [] // No collection variables
+ }
+ }
+ }
+ };
+
+ await fetchGqlSchemaHandler(null, endpoint, environment, request, collection);
+
+ expect(prepareGqlIntrospectionRequest).toHaveBeenCalledWith(
+ endpoint,
+ expect.objectContaining({
+ SHARED_VAR: 'runtime-value'
+ }),
+ request,
+ collection.root
+ );
+ })
+});
+
+
diff --git a/packages/bruno-electron/tests/network/interpolate-vars.spec.js b/packages/bruno-electron/tests/network/interpolate-vars.spec.js
index 7a769ea3a..c288db77f 100644
--- a/packages/bruno-electron/tests/network/interpolate-vars.spec.js
+++ b/packages/bruno-electron/tests/network/interpolate-vars.spec.js
@@ -66,6 +66,62 @@ describe('interpolate-vars: interpolateVars', () => {
expect(result.url).toEqual('test.com');
});
});
+
+ describe('With gRPC requests and all variable types', () => {
+ it('Should interpolate collection variables, global environment variables, etc. in gRPC requests', async () => {
+ const request = {
+ method: '/random.Service/randomMethod',
+ url: '{{baseUrl}}/{{service}}/{{method}}',
+ mode: 'grpc',
+ body: {
+ json: '{"message": "{{message}}", "id": {{id}}}'
+ },
+ // Set variable properties on the request object
+ globalEnvironmentVariables: {},
+ collectionVariables: { service: 'greeter' },
+ folderVariables: { method: 'SayHello' },
+ requestVariables: { message: 'Hello World' },
+ oauth2CredentialVariables: {}
+ };
+
+ const result = interpolateVars(
+ request,
+ { baseUrl: 'grpc://localhost:50051' }, // envVars
+ { id: 123 }, // runtimeVariables
+ {} // processEnvVars
+ );
+
+ expect(result.url).toEqual('grpc://localhost:50051/greeter/SayHello');
+ expect(result.body.json).toEqual('{"message": "Hello World", "id": 123}');
+ });
+
+ it('Should handle gRPC requests with global environment variables', async () => {
+ const request = {
+ method: '/random.Service/randomMethod',
+ url: '{{globalBaseUrl}}/{{service}}',
+ mode: 'grpc',
+ body: {
+ json: '{"token": "{{globalToken}}"}'
+ },
+ // Set variable properties on the request object
+ globalEnvironmentVariables: { globalBaseUrl: 'grpcs://api.example.com', globalToken: 'abc123' },
+ collectionVariables: { service: 'auth' },
+ folderVariables: {},
+ requestVariables: {},
+ oauth2CredentialVariables: {}
+ };
+
+ const result = interpolateVars(
+ request,
+ {}, // envVars
+ {}, // runtimeVariables
+ {} // processEnvVars
+ );
+
+ expect(result.url).toEqual('grpcs://api.example.com/auth');
+ expect(result.body.json).toEqual('{"token": "abc123"}');
+ });
+ });
});
describe('Does NOT interpolate string', () => {
@@ -100,4 +156,13 @@ describe('interpolate-vars: interpolateVars', () => {
});
});
});
+
+ describe('Handles content-type header set to false', () => {
+ it('Should result empty data', async () => {
+ const request = { method: 'POST', url: 'test', data: undefined, headers: { 'content-type': false } };
+
+ const result = interpolateVars(request, { 'test.url': 'test.com' }, null, null);
+ expect(result.data).toEqual(undefined);
+ });
+ });
});
diff --git a/packages/bruno-electron/tests/network/prepare-gql-introspection-request.spec.js b/packages/bruno-electron/tests/network/prepare-gql-introspection-request.spec.js
new file mode 100644
index 000000000..2eacde679
--- /dev/null
+++ b/packages/bruno-electron/tests/network/prepare-gql-introspection-request.spec.js
@@ -0,0 +1,66 @@
+const prepareGqlIntrospectionRequest = require('../../src/ipc/network/prepare-gql-introspection-request');
+
+describe('prepareGqlIntrospectionRequest', () => {
+ const createBasicSetup = () => ({
+ endpoint: 'https://example.com/',
+ request: {
+ headers: []
+ },
+ collectionRoot: {
+ request: {
+ headers: []
+ }
+ }
+ });
+
+ it('should handle environment variables in headers', () => {
+ const setup = createBasicSetup();
+ setup.request.headers = [
+ { name: 'Authorization', value: 'Bearer {{AUTH_TOKEN}}', enabled: true }
+ ];
+ const vars = {
+ AUTH_TOKEN: 'token-value'
+ };
+
+ const result = prepareGqlIntrospectionRequest(setup.endpoint, vars, setup.request, setup.collectionRoot);
+
+ expect(result.headers['Authorization']).toBe('Bearer token-value');
+ expect(result.method).toBe('POST');
+ expect(result.url).toBe(setup.endpoint);
+ });
+
+ it('should override collection headers with request headers', () => {
+ const setup = createBasicSetup();
+ setup.collectionRoot.request.headers = [
+ { name: 'X-Header', value: 'collection-value', enabled: true }
+ ];
+ setup.request.headers = [
+ { name: 'X-Header', value: 'request-value', enabled: true }
+ ];
+
+ const result = prepareGqlIntrospectionRequest(setup.endpoint, {}, setup.request, setup.collectionRoot);
+
+ expect(result.headers['X-Header']).toBe('request-value');
+ });
+
+ it('should handle enabled and disabled headers', () => {
+ const setup = createBasicSetup();
+ setup.request.headers = [
+ { name: 'X-Enabled', value: 'enabled', enabled: true },
+ { name: 'X-Disabled', value: 'disabled', enabled: false }
+ ];
+
+ const result = prepareGqlIntrospectionRequest(setup.endpoint, {}, setup.request, setup.collectionRoot);
+
+ expect(result.headers['X-Enabled']).toBe('enabled');
+ expect(result.headers['X-Disabled']).toBeUndefined();
+ });
+
+ it('should always include required GraphQL headers', () => {
+ const setup = createBasicSetup();
+ const result = prepareGqlIntrospectionRequest(setup.endpoint, {}, setup.request, setup.collectionRoot);
+ expect(result.headers['Accept']).toBe('application/json');
+ expect(result.headers['Content-Type']).toBe('application/json');
+ });
+
+});
\ No newline at end of file
diff --git a/packages/bruno-electron/tests/network/prepare-request.spec.js b/packages/bruno-electron/tests/network/prepare-request.spec.js
index a624d3ea5..f8c014869 100644
--- a/packages/bruno-electron/tests/network/prepare-request.spec.js
+++ b/packages/bruno-electron/tests/network/prepare-request.spec.js
@@ -1,21 +1,23 @@
const { describe, it, expect } = require('@jest/globals');
-const prepareRequest = require('../../src/ipc/network/prepare-request');
+const { prepareRequest } = require('../../src/ipc/network/prepare-request');
const { buildFormUrlEncodedPayload } = require('../../src/utils/form-data');
describe('prepare-request: prepareRequest', () => {
describe('Decomments request body', () => {
it('If request body is valid JSON', async () => {
const body = { mode: 'json', json: '{\n"test": "{{someVar}}" // comment\n}' };
- const expected = '{\n"test": "{{someVar}}" \n}';
- const result = prepareRequest({ request: { body } }, {});
+ const expected = `{
+\"test\": \"{{someVar}}\"
+}`;
+ const result = await prepareRequest({ request: { body }, collection: { pathname: '' } });
expect(result.data).toEqual(expected);
});
it('If request body is not valid JSON', async () => {
const body = { mode: 'json', json: '{\n"test": {{someVar}} // comment\n}' };
const expected = '{\n"test": {{someVar}} \n}';
- const result = prepareRequest({ request: { body } }, {});
+ const result = await prepareRequest({ request: { body }, collection: { pathname: '' } });
expect(result.data).toEqual(expected);
});
@@ -57,4 +59,23 @@ describe('prepare-request: prepareRequest', () => {
expect(result).toEqual(expected);
});
});
+
+ describe.each(['POST', 'PUT', 'PATCH'])('POST request with no body', (method) => {
+ it('Should set content-type header to false if method is ' + method + ' and there is no data in the body', async () => {
+ const request = { method: method, url: 'test-domain', body: { mode: 'none' }, auth: { mode: 'none' } };
+ const result = await prepareRequest({ request, collection: { pathname: '' } });
+ expect(result.headers['content-type']).toEqual(false);
+ });
+ it('Should respect the content-type header if explicitly set', async () => {
+ const request = {
+ method: method,
+ url: 'test-domain',
+ body: { mode: 'none' },
+ headers: [{ name: 'content-type', value: 'application/json', enabled: true }],
+ auth: { mode: 'none' }
+ };
+ const result = await prepareRequest({ request, collection: { pathname: '' } });
+ expect(result.headers['content-type']).toEqual('application/json');
+ });
+ });
});
\ No newline at end of file
diff --git a/packages/bruno-electron/tests/store/global-environments.test.js b/packages/bruno-electron/tests/store/global-environments.test.js
new file mode 100644
index 000000000..41c59ef51
--- /dev/null
+++ b/packages/bruno-electron/tests/store/global-environments.test.js
@@ -0,0 +1,54 @@
+const { globalEnvironmentsStore } = require('../../src/store/global-environments');
+
+// Previously, a bug caused environment variables to be saved without a type.
+// Since that issue is now fixed, this code ensures that anyone who imported
+// data before the fix will have the missing types added retroactively.
+describe('global environment variable type backward compatibility', () => {
+ beforeEach(() => {
+ globalEnvironmentsStore.store.clear();
+ });
+
+ it('should add type field for existing global environments without type', () => {
+ // Mock global environments without type field
+ const mockGlobalEnvironments = [
+ {
+ uid: "env-1",
+ name: "Test Environment",
+ variables: [
+ {
+ uid: "var-1",
+ name: "regular_var",
+ value: "regular_value",
+ enabled: true,
+ secret: false
+ // Missing: type field
+ },
+ {
+ uid: "var-2",
+ name: "secret_var",
+ value: "secret_value",
+ enabled: true,
+ secret: true
+ // Missing: type field
+ }
+ ]
+ }
+ ];
+
+ globalEnvironmentsStore.store.set('environments', mockGlobalEnvironments);
+
+ const processedEnvironments = globalEnvironmentsStore.getGlobalEnvironments();
+
+ expect(processedEnvironments).toHaveLength(1);
+ expect(processedEnvironments[0].variables).toHaveLength(2);
+
+ const regularVar = processedEnvironments[0].variables.find(v => v.name === 'regular_var');
+ const secretVar = processedEnvironments[0].variables.find(v => v.name === 'secret_var');
+
+ expect(regularVar.name).toBe('regular_var');
+ expect(regularVar.type).toBe('text');
+
+ expect(secretVar.name).toBe('secret_var');
+ expect(secretVar.type).toBe('text');
+ });
+});
diff --git a/packages/bruno-electron/tests/utils/collection.spec.js b/packages/bruno-electron/tests/utils/collection.spec.js
new file mode 100644
index 000000000..363537db6
--- /dev/null
+++ b/packages/bruno-electron/tests/utils/collection.spec.js
@@ -0,0 +1,288 @@
+const { parseBruFileMeta } = require("../../src/utils/collection");
+
+describe('parseBruFileMeta', () => {
+ test('parses valid meta block correctly', () => {
+ const data = `meta {
+ name: 0.2_mb
+ type: http
+ seq: 1
+ }`;
+
+ const result = parseBruFileMeta(data);
+
+ expect(result).toEqual({
+ type: 'http-request',
+ name: '0.2_mb',
+ seq: 1,
+ settings: {},
+ tags: [],
+ request: {
+ method: '',
+ url: '',
+ params: [],
+ headers: [],
+ auth: { mode: 'none' },
+ body: { mode: 'none' },
+ script: {},
+ vars: {},
+ assertions: [],
+ tests: '',
+ docs: ''
+ }
+ });
+ });
+
+ test('returns null for missing meta block', () => {
+ const data = `someOtherBlock {
+ key: value
+ }`;
+
+ const result = parseBruFileMeta(data);
+
+ expect(result).toBeNull();
+ });
+
+ test('handles empty meta block gracefully', () => {
+ const data = `meta {}`;
+
+ const result = parseBruFileMeta(data);
+
+ expect(result).toEqual({
+ type: 'http-request',
+ name: undefined,
+ seq: 1,
+ settings: {},
+ tags: [],
+ request: {
+ method: '',
+ url: '',
+ params: [],
+ headers: [],
+ auth: { mode: 'none' },
+ body: { mode: 'none' },
+ script: {},
+ vars: {},
+ assertions: [],
+ tests: '',
+ docs: ''
+ }
+ });
+ });
+
+ test('ignores invalid lines in meta block', () => {
+ const data = `meta {
+ name: 0.2_mb
+ invalidLine
+ seq: 1
+ }`;
+
+ const result = parseBruFileMeta(data);
+
+ expect(result).toEqual({
+ type: 'http-request',
+ name: '0.2_mb',
+ seq: 1,
+ settings: {},
+ tags: [],
+ request: {
+ method: '',
+ url: '',
+ params: [],
+ headers: [],
+ auth: { mode: 'none' },
+ body: { mode: 'none' },
+ script: {},
+ vars: {},
+ assertions: [],
+ tests: '',
+ docs: ''
+ }
+ });
+ });
+
+ test('handles unexpected input gracefully', () => {
+ const data = null;
+
+ const result = parseBruFileMeta(data);
+
+ expect(result).toBeNull();
+ });
+
+ test('handles missing colon gracefully', () => {
+ const data = `meta {
+ name 0.2_mb
+ seq: 1
+ }`;
+
+ const result = parseBruFileMeta(data);
+
+ expect(result).toEqual({
+ type: 'http-request',
+ name: undefined,
+ seq: 1,
+ settings: {},
+ tags: [],
+ request: {
+ method: '',
+ url: '',
+ params: [],
+ headers: [],
+ auth: { mode: 'none' },
+ body: { mode: 'none' },
+ script: {},
+ vars: {},
+ assertions: [],
+ tests: '',
+ docs: ''
+ }
+ });
+ });
+
+ test('parses numeric values correctly', () => {
+ const data = `meta {
+ numValue: 1234
+ floatValue: 12.34
+ strValue: some_text
+ seq: 5
+ }`;
+
+ const result = parseBruFileMeta(data);
+
+ expect(result).toEqual({
+ type: 'http-request',
+ name: undefined,
+ seq: 5,
+ settings: {},
+ tags: [],
+ request: {
+ method: '',
+ url: '',
+ params: [],
+ headers: [],
+ auth: { mode: 'none' },
+ body: { mode: 'none' },
+ script: {},
+ vars: {},
+ assertions: [],
+ tests: '',
+ docs: ''
+ }
+ });
+ });
+
+ test('handles syntax error in meta block 1', () => {
+ const data = `meta
+ name: 0.2_mb
+ type: http
+ seq: 1
+ }`;
+
+ const result = parseBruFileMeta(data);
+
+ expect(result).toBeNull();
+ });
+
+ test('handles syntax error in meta block 2', () => {
+ const data = `meta {
+ name: 0.2_mb
+ type: http
+ seq: 1
+ `;
+
+ const result = parseBruFileMeta(data);
+
+ expect(result).toBeNull();
+ });
+
+ test('handles graphql type correctly', () => {
+ const data = `meta {
+ name: graphql_query
+ type: graphql
+ seq: 2
+ }`;
+
+ const result = parseBruFileMeta(data);
+
+ expect(result).toEqual({
+ type: 'graphql-request',
+ name: 'graphql_query',
+ seq: 2,
+ settings: {},
+ tags: [],
+ request: {
+ method: '',
+ url: '',
+ params: [],
+ headers: [],
+ auth: { mode: 'none' },
+ body: { mode: 'none' },
+ script: {},
+ vars: {},
+ assertions: [],
+ tests: '',
+ docs: ''
+ }
+ });
+ });
+
+ test('handles unknown type correctly', () => {
+ const data = `meta {
+ name: unknown_request
+ type: unknown
+ seq: 3
+ }`;
+
+ const result = parseBruFileMeta(data);
+
+ expect(result).toEqual({
+ type: 'http-request',
+ name: 'unknown_request',
+ seq: 3,
+ settings: {},
+ tags: [],
+ request: {
+ method: '',
+ url: '',
+ params: [],
+ headers: [],
+ auth: { mode: 'none' },
+ body: { mode: 'none' },
+ script: {},
+ vars: {},
+ assertions: [],
+ tests: '',
+ docs: ''
+ }
+ });
+ });
+
+ test('handles missing seq gracefully', () => {
+ const data = `meta {
+ name: no_seq_request
+ type: http
+ }`;
+
+ const result = parseBruFileMeta(data);
+
+ expect(result).toEqual({
+ type: 'http-request',
+ name: 'no_seq_request',
+ seq: 1, // Default fallback
+ settings: {},
+ tags: [],
+ request: {
+ method: '',
+ url: '',
+ params: [],
+ headers: [],
+ auth: { mode: 'none' },
+ body: { mode: 'none' },
+ script: {},
+ vars: {},
+ assertions: [],
+ tests: '',
+ docs: ''
+ }
+ });
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-electron/tests/utils/encryption.spec.js b/packages/bruno-electron/tests/utils/encryption.spec.js
index 44388fb07..9ddc7f7c5 100644
--- a/packages/bruno-electron/tests/utils/encryption.spec.js
+++ b/packages/bruno-electron/tests/utils/encryption.spec.js
@@ -1,4 +1,4 @@
-const { encryptString, decryptString } = require('../../src/utils/encryption');
+const { encryptString, decryptString, encryptStringSafe, decryptStringSafe } = require('../../src/utils/encryption');
// We can only unit test aes 256 fallback as safeStorage is only available
// in the main process
@@ -12,13 +12,23 @@ describe('Encryption and Decryption Tests', () => {
expect(decrypted).toBe(plaintext);
});
+ it('should handle empty strings in encryptString', () => {
+ const result = encryptString('');
+ expect(result).toBe('');
+ });
+
+ it('should handle empty strings in decryptString', () => {
+ const result = decryptString('');
+ expect(result).toBe('');
+ });
+
it('encrypt should throw an error for invalid string', () => {
expect(() => encryptString(null)).toThrow('Encrypt failed: invalid string');
+ expect(() => encryptString(undefined)).toThrow('Encrypt failed: invalid string');
});
it('decrypt should throw an error for invalid string', () => {
expect(() => decryptString(null)).toThrow('Decrypt failed: unrecognized string format');
- expect(() => decryptString('')).toThrow('Decrypt failed: unrecognized string format');
expect(() => decryptString('garbage')).toThrow('Decrypt failed: unrecognized string format');
});
@@ -35,3 +45,69 @@ describe('Encryption and Decryption Tests', () => {
expect(() => decryptString(invalidAlgo)).toThrow('Decrypt failed: Invalid algo');
});
});
+
+describe('Safe Encryption and Decryption Tests', () => {
+ it('should encrypt and decrypt successfully using encryptStringSafe and decryptStringSafe', () => {
+ const plaintext = 'bruno is awesome';
+ const encryptionResult = encryptStringSafe(plaintext);
+ const decryptionResult = decryptStringSafe(encryptionResult.value);
+
+ expect(encryptionResult.success).toBe(true);
+ expect(decryptionResult.success).toBe(true);
+ expect(decryptionResult.value).toBe(plaintext);
+ });
+
+ it('should handle empty strings in encryptStringSafe', () => {
+ const result = encryptStringSafe('');
+ expect(result.success).toBe(true);
+ expect(result.value).toBe('');
+ });
+
+ it('should handle empty strings in decryptStringSafe', () => {
+ const result = decryptStringSafe('');
+ expect(result.success).toBe(true);
+ expect(result.value).toBe('');
+ });
+
+ it('should handle invalid string format in decryptStringSafe', () => {
+ const result = decryptStringSafe('garbage');
+ expect(result.success).toBe(false);
+ expect(result.error).toBe('Decrypt failed: unrecognized string format');
+ expect(result.value).toBe('');
+ });
+
+ it('should handle invalid algorithm in decryptStringSafe', () => {
+ const invalidAlgo = '$99:abcdefg';
+ const result = decryptStringSafe(invalidAlgo);
+ expect(result.success).toBe(false);
+ expect(result.error).toBe('Decrypt failed: Invalid algo');
+ expect(result.value).toBe('');
+ });
+
+ it('should handle malformed encrypted string in decryptStringSafe', () => {
+ const malformedString = '$01:invalid-hex-string';
+ const result = decryptStringSafe(malformedString);
+ expect(result.success).toBe(false);
+ expect(result.error).toContain('AES256 decryption failed');
+ expect(result.value).toBe('');
+ });
+
+ it('should handle special characters in encryptStringSafe and decryptStringSafe', () => {
+ const specialText = 'bruno@#$%^&*()_+-=[]{}|;:,.<>?';
+ const encryptionResult = encryptStringSafe(specialText);
+ const decryptionResult = decryptStringSafe(encryptionResult.value);
+
+ expect(encryptionResult.success).toBe(true);
+ expect(decryptionResult.success).toBe(true);
+ expect(decryptionResult.value).toBe(specialText);
+ });
+
+ it('decrypt-safe should not throw error for invalid inputs', () => {
+ expect(() => decryptStringSafe(null)).not.toThrow();
+ expect(() => decryptStringSafe(undefined)).not.toThrow();
+ expect(() => decryptStringSafe('garbage')).not.toThrow();
+ expect(() => decryptStringSafe(123456789)).not.toThrow();
+ expect(() => decryptStringSafe('aes256:')).not.toThrow();
+ expect(() => decryptStringSafe('aes256:invalid_base64')).not.toThrow();
+ });
+});
diff --git a/packages/bruno-filestore/.gitignore b/packages/bruno-filestore/.gitignore
new file mode 100644
index 000000000..a05291c3a
--- /dev/null
+++ b/packages/bruno-filestore/.gitignore
@@ -0,0 +1,5 @@
+node_modules
+.DS_Store
+*.log
+dist
+coverage
\ No newline at end of file
diff --git a/packages/bruno-filestore/LICENSE.md b/packages/bruno-filestore/LICENSE.md
new file mode 100644
index 000000000..f88e206bb
--- /dev/null
+++ b/packages/bruno-filestore/LICENSE.md
@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2022 Anoop M D, Anusree P S and Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
\ No newline at end of file
diff --git a/packages/bruno-filestore/README.md b/packages/bruno-filestore/README.md
new file mode 100644
index 000000000..8abc92868
--- /dev/null
+++ b/packages/bruno-filestore/README.md
@@ -0,0 +1,50 @@
+# Bruno Filestore
+
+A generic file storage and parsing package for Bruno API client.
+
+## Purpose
+
+This package abstracts the file format operations for Bruno, providing a clean interface for parsing and stringifying Bruno requests, collections, folders, and environments.
+
+## Features
+
+- Format-agnostic APIs for file operations
+- Currently supports Bruno's custom `.bru` format
+- Designed for future extensibility to support YAML and other formats
+
+## Usage
+
+```javascript
+const {
+ parseRequest,
+ stringifyRequest,
+ parseCollection,
+ stringifyCollection,
+ parseEnvironment,
+ stringifyEnvironment,
+ parseDotEnv
+} = require('@usebruno/filestore');
+
+// Parse a .bru request file
+const requestData = parseRequest(bruContent);
+
+// Stringify request data to .bru format
+const bruContent = stringifyRequest(requestData);
+
+// Example with future format support (not yet implemented)
+const requestData = parseRequest(yamlContent, { format: 'yaml' });
+```
+
+## API
+
+The package provides the following functions:
+
+- `parseRequest(content, options = { format: 'bru' })`: Parse request file content
+- `stringifyRequest(requestObj, options = { format: 'bru' })`: Convert request object to file content
+- `parseCollection(content, options = { format: 'bru' })`: Parse collection file content
+- `stringifyCollection(collectionObj, options = { format: 'bru' })`: Convert collection object to file content
+- `parseFolder(content, options = { format: 'bru' })`: Parse folder file content
+- `stringifyFolder(folderObj, options = { format: 'bru' })`: Convert folder object to file content
+- `parseEnvironment(content, options = { format: 'bru' })`: Parse environment file content
+- `stringifyEnvironment(envObj, options = { format: 'bru' })`: Convert environment object to file content
+- `parseDotEnv(content)`: Parse .env file content
\ No newline at end of file
diff --git a/packages/bruno-filestore/babel.config.js b/packages/bruno-filestore/babel.config.js
new file mode 100644
index 000000000..a0b85248b
--- /dev/null
+++ b/packages/bruno-filestore/babel.config.js
@@ -0,0 +1,6 @@
+module.exports = {
+ presets: [
+ ['@babel/preset-env', { targets: { node: 'current' } }],
+ '@babel/preset-typescript',
+ ],
+};
\ No newline at end of file
diff --git a/packages/bruno-filestore/jest.config.js b/packages/bruno-filestore/jest.config.js
new file mode 100644
index 000000000..bf7878c22
--- /dev/null
+++ b/packages/bruno-filestore/jest.config.js
@@ -0,0 +1,13 @@
+module.exports = {
+ testEnvironment: 'node',
+ transform: {
+ '^.+\\.(js|ts)$': 'babel-jest',
+ },
+ moduleFileExtensions: ['js', 'ts'],
+ testMatch: ['**/__tests__/**/*.(js|ts)', '**/*.(test|spec).(js|ts)'],
+ collectCoverageFrom: [
+ 'src/**/*.(js|ts)',
+ '!src/**/*.d.ts',
+ ],
+ setupFilesAfterEnv: [],
+};
\ No newline at end of file
diff --git a/packages/bruno-filestore/package.json b/packages/bruno-filestore/package.json
new file mode 100644
index 000000000..edf79b6f1
--- /dev/null
+++ b/packages/bruno-filestore/package.json
@@ -0,0 +1,47 @@
+{
+ "name": "@usebruno/filestore",
+ "version": "0.1.0",
+ "license": "MIT",
+ "main": "dist/cjs/index.js",
+ "module": "dist/esm/index.js",
+ "types": "dist/index.d.ts",
+ "files": [
+ "dist",
+ "src",
+ "package.json"
+ ],
+ "scripts": {
+ "clean": "rimraf dist",
+ "prebuild": "npm run clean",
+ "build": "rollup -c",
+ "watch": "rollup -c -w",
+ "test": "jest",
+ "test:watch": "jest --watch",
+ "prepack": "npm run test && npm run build"
+ },
+ "devDependencies": {
+ "@babel/preset-env": "^7.22.0",
+ "@babel/preset-typescript": "^7.22.0",
+ "@rollup/plugin-commonjs": "^23.0.2",
+ "@rollup/plugin-node-resolve": "^15.0.1",
+ "@rollup/plugin-typescript": "^9.0.2",
+ "@types/jest": "^29.5.11",
+ "@types/lodash": "^4.14.191",
+ "@types/node": "^24.1.0",
+ "babel-jest": "^29.7.0",
+ "jest": "^29.2.0",
+ "rimraf": "^3.0.2",
+ "rollup": "3.29.5",
+ "rollup-plugin-dts": "^5.0.0",
+ "rollup-plugin-peer-deps-external": "^2.2.4",
+ "rollup-plugin-terser": "^7.0.2",
+ "typescript": "^4.8.4"
+ },
+ "overrides": {
+ "rollup": "3.29.5"
+ },
+ "dependencies": {
+ "@usebruno/lang": "0.12.0",
+ "lodash": "^4.17.21"
+ }
+}
\ No newline at end of file
diff --git a/packages/bruno-filestore/rollup.config.js b/packages/bruno-filestore/rollup.config.js
new file mode 100644
index 000000000..e272dc015
--- /dev/null
+++ b/packages/bruno-filestore/rollup.config.js
@@ -0,0 +1,63 @@
+const { nodeResolve } = require('@rollup/plugin-node-resolve');
+const commonjs = require('@rollup/plugin-commonjs');
+const typescript = require('@rollup/plugin-typescript');
+const dts = require('rollup-plugin-dts');
+const { terser } = require('rollup-plugin-terser');
+const peerDepsExternal = require('rollup-plugin-peer-deps-external');
+
+const packageJson = require('./package.json');
+
+module.exports = [
+ {
+ input: 'src/index.ts',
+ output: [
+ {
+ file: packageJson.main,
+ format: 'cjs',
+ sourcemap: true,
+ exports: 'named'
+ },
+ {
+ file: packageJson.module,
+ format: 'esm',
+ sourcemap: true,
+ exports: 'named'
+ }
+ ],
+ plugins: [
+ peerDepsExternal(),
+ nodeResolve({
+ extensions: ['.js', '.ts', '.tsx', '.json', '.css']
+ }),
+ commonjs(),
+ typescript({ tsconfig: './tsconfig.json' }),
+ terser(),
+ ],
+ external: ['@usebruno/lang', 'lodash', 'worker_threads', 'path']
+ },
+ {
+ input: 'src/workers/worker-script.ts',
+ output: [
+ {
+ file: 'dist/cjs/workers/worker-script.js',
+ format: 'cjs',
+ sourcemap: true
+ },
+ {
+ file: 'dist/esm/workers/worker-script.js',
+ format: 'cjs',
+ sourcemap: true
+ }
+ ],
+ plugins: [
+ peerDepsExternal(),
+ nodeResolve({
+ extensions: ['.js', '.ts', '.tsx', '.json', '.css']
+ }),
+ commonjs(),
+ typescript({ tsconfig: './tsconfig.json' }),
+ terser(),
+ ],
+ external: ['@usebruno/lang', 'lodash', 'worker_threads', 'path']
+ }
+];
\ No newline at end of file
diff --git a/packages/bruno-filestore/src/formats/bru/index.ts b/packages/bruno-filestore/src/formats/bru/index.ts
new file mode 100644
index 000000000..79095e945
--- /dev/null
+++ b/packages/bruno-filestore/src/formats/bru/index.ts
@@ -0,0 +1,295 @@
+import * as _ from 'lodash';
+import {
+ bruToJsonV2,
+ jsonToBruV2,
+ bruToEnvJsonV2,
+ envJsonToBruV2,
+ collectionBruToJson as _collectionBruToJson,
+ jsonToCollectionBru as _jsonToCollectionBru
+} from '@usebruno/lang';
+import { getOauth2AdditionalParameters } from './utils/oauth2-additional-params';
+
+export const bruRequestToJson = (data: string | any, parsed: boolean = false): any => {
+ try {
+ const json = parsed ? data : bruToJsonV2(data);
+
+ let requestType = _.get(json, 'meta.type');
+ switch (requestType) {
+ case 'http':
+ requestType = 'http-request';
+ break;
+ case 'graphql':
+ requestType = 'graphql-request';
+ break;
+ case 'grpc':
+ requestType = 'grpc-request';
+ break;
+ default:
+ requestType = 'http-request';
+ }
+
+ const sequence = _.get(json, 'meta.seq');
+ const transformedJson = {
+ type: requestType,
+ name: _.get(json, 'meta.name'),
+ seq: !_.isNaN(sequence) ? Number(sequence) : 1,
+ settings: _.get(json, 'settings', {}),
+ tags: _.get(json, 'meta.tags', []),
+ request: {
+ method:
+ requestType === 'grpc-request' ? _.get(json, 'grpc.method', '') : _.upperCase(_.get(json, 'http.method')),
+ url: _.get(json, requestType === 'grpc-request' ? 'grpc.url' : 'http.url'),
+ headers: requestType === 'grpc-request' ? _.get(json, 'metadata', []) : _.get(json, 'headers', []),
+ auth: _.get(json, 'auth', {}),
+ body: _.get(json, 'body', {}),
+ script: _.get(json, 'script', {}),
+ vars: _.get(json, 'vars', {}),
+ assertions: _.get(json, 'assertions', []),
+ tests: _.get(json, 'tests', ''),
+ docs: _.get(json, 'docs', '')
+ }
+ };
+
+ // Add request type specific fields
+ if (requestType === 'grpc-request') {
+ const selectedMethodType = _.get(json, 'grpc.methodType');
+ selectedMethodType && ((transformedJson.request as any).methodType = selectedMethodType);
+ const protoPath = _.get(json, 'grpc.protoPath');
+ protoPath && ((transformedJson.request as any).protoPath = protoPath);
+ transformedJson.request.auth.mode = _.get(json, 'grpc.auth', 'none');
+ transformedJson.request.body = _.get(json, 'body', {
+ mode: 'grpc',
+ grpc: _.get(json, 'body.grpc', [
+ {
+ name: 'message 1',
+ content: '{}'
+ }
+ ])
+ });
+ } else {
+ // For HTTP and GraphQL
+ (transformedJson.request as any).params = _.get(json, 'params', []);
+ transformedJson.request.auth.mode = _.get(json, 'http.auth', 'none');
+ transformedJson.request.body.mode = _.get(json, 'http.body', 'none');
+ }
+
+ // add oauth2 additional parameters if they exist
+ const hasOauth2GrantType = json?.auth?.oauth2?.grantType;
+ if (hasOauth2GrantType) {
+ const additionalParameters = getOauth2AdditionalParameters(json);
+ const hasAdditionalParameters = Object.keys(additionalParameters || {}).length > 0;
+ if (hasAdditionalParameters) {
+ transformedJson.request.auth.oauth2.additionalParameters = additionalParameters;
+ }
+ }
+
+ return transformedJson;
+ } catch (error) {
+ throw error;
+ }
+};
+
+export const jsonRequestToBru = (json: any): string => {
+ try {
+ let type = _.get(json, 'type');
+ switch (type) {
+ case 'http-request':
+ type = 'http';
+ break;
+ case 'graphql-request':
+ type = 'graphql';
+ break;
+ case 'grpc-request':
+ type = 'grpc';
+ break;
+ default:
+ type = 'http';
+ }
+
+ const sequence = _.get(json, 'seq');
+
+ // Start with the common meta section
+ const bruJson = {
+ meta: {
+ name: _.get(json, 'name'),
+ type: type,
+ seq: !_.isNaN(sequence) ? Number(sequence) : 1,
+ tags: _.get(json, 'tags', [])
+ }
+ } as any;
+
+ // For HTTP and GraphQL requests, maintain the current structure
+ if (type === 'http' || type === 'graphql') {
+ bruJson.http = {
+ method: _.lowerCase(_.get(json, 'request.method')),
+ url: _.get(json, 'request.url'),
+ auth: _.get(json, 'request.auth.mode', 'none'),
+ body: _.get(json, 'request.body.mode', 'none')
+ };
+ bruJson.params = _.get(json, 'request.params', []);
+ bruJson.body = _.get(json, 'request.body', {
+ mode: 'json',
+ json: '{}'
+ });
+ } // For gRPC, add gRPC-specific structure but maintain field names
+ else if (type === 'grpc') {
+ bruJson.grpc = {
+ url: _.get(json, 'request.url'),
+ auth: _.get(json, 'request.auth.mode', 'none'),
+ body: _.get(json, 'request.body.mode', 'grpc')
+ };
+ // Only add method if it exists
+ const method = _.get(json, 'request.method');
+ const methodType = _.get(json, 'request.methodType');
+ const protoPath = _.get(json, 'request.protoPath');
+ if (method) bruJson.grpc.method = method;
+ if (methodType) bruJson.grpc.methodType = methodType;
+ if (protoPath) bruJson.grpc.protoPath = protoPath;
+ bruJson.body = _.get(json, 'request.body', {
+ mode: 'grpc',
+ grpc: _.get(json, 'request.body.grpc', [
+ {
+ name: 'message 1',
+ content: '{}'
+ }
+ ])
+ });
+ }
+
+ // Common fields for all request types
+ if (type === 'grpc') {
+ bruJson.metadata = _.get(json, 'request.headers', []); // Use metadata for gRPC
+ } else {
+ bruJson.headers = _.get(json, 'request.headers', []); // Use headers for HTTP/GraphQL
+ }
+ bruJson.auth = _.get(json, 'request.auth', {});
+ bruJson.script = _.get(json, 'request.script', {});
+ bruJson.vars = {
+ req: _.get(json, 'request.vars.req', []),
+ res: _.get(json, 'request.vars.res', [])
+ };
+ // should we add assertions and tests for grpc requests?
+ bruJson.assertions = _.get(json, 'request.assertions', []);
+ bruJson.tests = _.get(json, 'request.tests', '');
+ bruJson.settings = _.get(json, 'settings', {});
+ bruJson.docs = _.get(json, 'request.docs', '');
+
+ const bru = jsonToBruV2(bruJson);
+ return bru;
+ } catch (error) {
+ throw error;
+ }
+};
+
+export const bruCollectionToJson = (data: string | any, parsed: boolean = false): any => {
+ try {
+ const json = parsed ? data : _collectionBruToJson(data);
+
+ const transformedJson: any = {
+ request: {
+ headers: _.get(json, 'headers', []),
+ auth: _.get(json, 'auth', {}),
+ script: _.get(json, 'script', {}),
+ vars: _.get(json, 'vars', {}),
+ tests: _.get(json, 'tests', '')
+ },
+ settings: _.get(json, 'settings', {}),
+ docs: _.get(json, 'docs', '')
+ };
+
+ // add meta if it exists
+ // this is only for folder bru file
+ if (json.meta) {
+ transformedJson.meta = {
+ name: json.meta.name
+ };
+
+ // Include seq if it exists
+ if (json.meta.seq !== undefined) {
+ const sequence = json.meta.seq;
+ transformedJson.meta.seq = !isNaN(sequence) ? Number(sequence) : 1;
+ }
+ }
+
+ // add oauth2 additional parameters if they exist
+ const hasOauth2GrantType = json?.auth?.oauth2?.grantType;
+ if (hasOauth2GrantType) {
+ const additionalParameters = getOauth2AdditionalParameters(json);
+ const hasAdditionalParameters = Object.keys(additionalParameters).length > 0;
+ if (hasAdditionalParameters) {
+ transformedJson.request.auth.oauth2.additionalParameters = additionalParameters;
+ }
+ }
+
+ return transformedJson;
+ } catch (error) {
+ return Promise.reject(error);
+ }
+};
+
+export const jsonCollectionToBru = (json: any, isFolder?: boolean): string => {
+ try {
+ const collectionBruJson: any = {
+ headers: _.get(json, 'request.headers', []),
+ script: {
+ req: _.get(json, 'request.script.req', ''),
+ res: _.get(json, 'request.script.res', '')
+ },
+ vars: {
+ req: _.get(json, 'request.vars.req', []),
+ res: _.get(json, 'request.vars.res', [])
+ },
+ tests: _.get(json, 'request.tests', ''),
+ auth: _.get(json, 'request.auth', {}),
+ docs: _.get(json, 'docs', '')
+ };
+
+ // add meta if it exists
+ // this is only for folder bru file
+ if (json?.meta) {
+ collectionBruJson.meta = {
+ name: json.meta.name
+ };
+
+ // Include seq if it exists
+ if (json.meta.seq !== undefined) {
+ const sequence = json.meta.seq;
+ collectionBruJson.meta.seq = !isNaN(sequence) ? Number(sequence) : 1;
+ }
+ }
+
+ if (!isFolder) {
+ collectionBruJson.auth = _.get(json, 'request.auth', {});
+ }
+
+ return _jsonToCollectionBru(collectionBruJson);
+ } catch (error) {
+ throw error;
+ }
+};
+
+export const bruEnvironmentToJson = (bru: string): any => {
+ try {
+ const json = bruToEnvJsonV2(bru);
+
+ // the app env format requires each variable to have a type
+ // this need to be evaluated and safely removed
+ // i don't see it being used in schema validation
+ if (json && json.variables && json.variables.length) {
+ _.each(json.variables, (v: any) => (v.type = 'text'));
+ }
+
+ return json;
+ } catch (error) {
+ return Promise.reject(error);
+ }
+};
+
+export const jsonEnvironmentToBru = (json: any): string => {
+ try {
+ const bru = envJsonToBruV2(json);
+ return bru;
+ } catch (error) {
+ throw error;
+ }
+};
diff --git a/packages/bruno-filestore/src/formats/bru/tests/fixtures/oauth2-additional-params.js b/packages/bruno-filestore/src/formats/bru/tests/fixtures/oauth2-additional-params.js
new file mode 100644
index 000000000..c3498340c
--- /dev/null
+++ b/packages/bruno-filestore/src/formats/bru/tests/fixtures/oauth2-additional-params.js
@@ -0,0 +1,116 @@
+const getBruJsonWithAdditionalParams = (grantType) => ({
+ "meta": {
+ "name": "OAuth2 Additional Params Test",
+ "type": "http",
+ "seq": 1
+ },
+ "http": {
+ "method": "get",
+ "url": "https://api.usebruno.com/protected"
+ },
+ "auth": {
+ "oauth2": {
+ "grantType": grantType,
+ },
+ },
+ "oauth2_additional_parameters_auth_req_headers": [
+ {
+ "name": "auth-header",
+ "value": "auth-header-value",
+ "enabled": true
+ },
+ {
+ "name": "disabled-auth-header",
+ "value": "disabled-auth-header-value",
+ "enabled": false
+ }
+ ],
+ "oauth2_additional_parameters_auth_req_queryparams": [
+ {
+ "name": "auth-query-param",
+ "value": "auth-query-param-value",
+ "enabled": true
+ },
+ {
+ "name": "disabled-auth-query-param",
+ "value": "disabled-auth-query-param-value",
+ "enabled": false
+ }
+ ],
+ "oauth2_additional_parameters_access_token_req_headers": [
+ {
+ "name": "token-header",
+ "value": "token-header-value",
+ "enabled": true
+ },
+ {
+ "name": "disabled-token-header",
+ "value": "disabled-token-header-value",
+ "enabled": false
+ }
+ ],
+ "oauth2_additional_parameters_access_token_req_queryparams": [
+ {
+ "name": "token-query-param",
+ "value": "token-query-param-value",
+ "enabled": true
+ },
+ {
+ "name": "disabled-token-query-param",
+ "value": "disabled-token-query-param-value",
+ "enabled": false
+ }
+ ],
+ "oauth2_additional_parameters_access_token_req_bodyvalues": [
+ {
+ "name": "token-body",
+ "value": "token-body-value",
+ "enabled": true
+ },
+ {
+ "name": "disabled-token-body",
+ "value": "disabled-token-body-value",
+ "enabled": false
+ }
+ ],
+ "oauth2_additional_parameters_refresh_token_req_headers": [
+ {
+ "name": "refresh-header",
+ "value": "refresh-header-value",
+ "enabled": true
+ },
+ {
+ "name": "disabled-refresh-header",
+ "value": "disabled-refresh-header-value",
+ "enabled": false
+ }
+ ],
+ "oauth2_additional_parameters_refresh_token_req_queryparams": [
+ {
+ "name": "refresh-query-param",
+ "value": "refresh-query-param-value",
+ "enabled": true
+ },
+ {
+ "name": "disabled-refresh-query-param",
+ "value": "disabled-refresh-query-param-value",
+ "enabled": false
+ }
+ ],
+ "oauth2_additional_parameters_refresh_token_req_bodyvalues": [
+ {
+ "name": "refresh-body",
+ "value": "refresh-body-value",
+ "enabled": true
+ },
+ {
+ "name": "disabled-refresh-body",
+ "value": "disabled-refresh-body-value",
+ "enabled": false
+ }
+ ]
+})
+
+export {
+ getBruJsonWithAdditionalParams
+};
diff --git a/packages/bruno-filestore/src/formats/bru/tests/fixtures/request-parse-and-redact-body-data/input.bru b/packages/bruno-filestore/src/formats/bru/tests/fixtures/request-parse-and-redact-body-data/input.bru
new file mode 100644
index 000000000..734e10d88
--- /dev/null
+++ b/packages/bruno-filestore/src/formats/bru/tests/fixtures/request-parse-and-redact-body-data/input.bru
@@ -0,0 +1,66 @@
+meta {
+ name: echo request
+ type: http
+ seq: 1
+}
+
+post {
+ url: https://echo.usebruno.com
+ body: json
+ auth: none
+}
+body:json {
+ {
+ "hello": "world"
+ }
+}
+
+body:text {
+ This is a text body
+}
+body:xml {
+
+ John
+ 30
+
+}
+
+body:sparql {
+ SELECT * WHERE {
+ ?subject ?predicate ?object .
+ }
+ LIMIT 10
+}
+body:graphql {
+ {
+ launchesPast {
+ launch_site {
+ site_name
+ }
+ launch_success
+ }
+ }
+}
+
+body:form-urlencoded {
+ apikey: secret
+ numbers: +91998877665
+ ~message: hello
+}
+
+body:multipart-form {
+ apikey: secret
+ numbers: +91998877665
+ ~message: hello
+}
+body:file {
+ file: @file(path/to/file.json) @contentType(application/json)
+ file: @file(path/to/file.json) @contentType(application/json)
+ ~file: @file(path/to/file2.json) @contentType(application/json)
+}
+
+body:graphql:vars {
+ {
+ "limit": 5
+ }
+}
diff --git a/packages/bruno-filestore/src/formats/bru/tests/fixtures/request-parse-and-redact-body-data/output.bru b/packages/bruno-filestore/src/formats/bru/tests/fixtures/request-parse-and-redact-body-data/output.bru
new file mode 100644
index 000000000..ff66a2df8
--- /dev/null
+++ b/packages/bruno-filestore/src/formats/bru/tests/fixtures/request-parse-and-redact-body-data/output.bru
@@ -0,0 +1,35 @@
+meta {
+ name: echo request
+ type: http
+ seq: 1
+}
+
+post {
+ url: https://echo.usebruno.com
+ body: json
+ auth: none
+}
+
+body:form-urlencoded {
+ apikey: secret
+ numbers: +91998877665
+ ~message: hello
+}
+
+body:multipart-form {
+ apikey: secret
+ numbers: +91998877665
+ ~message: hello
+}
+
+body:file {
+ file: @file(path/to/file.json) @contentType(application/json)
+ file: @file(path/to/file.json) @contentType(application/json)
+ ~file: @file(path/to/file2.json) @contentType(application/json)
+}
+
+body:graphql:vars {
+ {
+ "limit": 5
+ }
+}
diff --git a/packages/bruno-filestore/src/formats/bru/tests/oauth2-additional-params.spec.js b/packages/bruno-filestore/src/formats/bru/tests/oauth2-additional-params.spec.js
new file mode 100644
index 000000000..707c6127c
--- /dev/null
+++ b/packages/bruno-filestore/src/formats/bru/tests/oauth2-additional-params.spec.js
@@ -0,0 +1,45 @@
+const { getOauth2AdditionalParameters } = require('../utils/oauth2-additional-params');
+const { bruRequestToJson, bruCollectionToJson } = require('../index');
+const { getBruJsonWithAdditionalParams } = require('./fixtures/oauth2-additional-params');
+
+describe('getOauth2AdditionalParameters', () => {
+ it('authorization_code', () => {
+ const additionalParameters = getOauth2AdditionalParameters(getBruJsonWithAdditionalParams('authorization_code'));
+ expect(additionalParameters.authorization).toHaveLength(4);
+ expect(additionalParameters.token).toHaveLength(6);
+ expect(additionalParameters.refresh).toHaveLength(6);
+
+ expect(additionalParameters.authorization.map(p => p.sendIn).sort()).toEqual(['headers', 'headers', 'queryparams', 'queryparams']);
+ expect(additionalParameters.token.map(p => p.sendIn).sort()).toEqual(['body', 'body', 'headers', 'headers', 'queryparams', 'queryparams']);
+ expect(additionalParameters.refresh.map(p => p.sendIn).sort()).toEqual(['body', 'body', 'headers', 'headers', 'queryparams', 'queryparams']);
+ });
+
+ it('client_credentials', () => {
+ const additionalParameters = getOauth2AdditionalParameters(getBruJsonWithAdditionalParams('client_credentials'));
+ expect(additionalParameters.authorization).toBeUndefined();
+ expect(additionalParameters.token).toHaveLength(6);
+ expect(additionalParameters.refresh).toHaveLength(6);
+
+ expect(additionalParameters.token.map(p => p.sendIn).sort()).toEqual(['body', 'body', 'headers', 'headers', 'queryparams', 'queryparams']);
+ expect(additionalParameters.refresh.map(p => p.sendIn).sort()).toEqual(['body', 'body', 'headers', 'headers', 'queryparams', 'queryparams']);
+ });
+
+ it('password', () => {
+ const additionalParameters = getOauth2AdditionalParameters(getBruJsonWithAdditionalParams('password'));
+ expect(additionalParameters.authorization).toBeUndefined();
+ expect(additionalParameters.token).toHaveLength(6);
+ expect(additionalParameters.refresh).toHaveLength(6);
+
+ expect(additionalParameters.token.map(p => p.sendIn).sort()).toEqual(['body', 'body', 'headers', 'headers', 'queryparams', 'queryparams']);
+ expect(additionalParameters.refresh.map(p => p.sendIn).sort()).toEqual(['body', 'body', 'headers', 'headers', 'queryparams', 'queryparams']);
+ });
+
+ it('implicit', () => {
+ const additionalParameters = getOauth2AdditionalParameters(getBruJsonWithAdditionalParams('implicit'));
+ expect(additionalParameters.authorization).toHaveLength(4);
+ expect(additionalParameters.token).toBeUndefined();
+ expect(additionalParameters.refresh).toBeUndefined();
+
+ expect(additionalParameters.authorization.map(p => p.sendIn).sort()).toEqual(['headers', 'headers', 'queryparams', 'queryparams']);
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-filestore/src/formats/bru/tests/request-parse-and-redact-body-data.spec.js b/packages/bruno-filestore/src/formats/bru/tests/request-parse-and-redact-body-data.spec.js
new file mode 100644
index 000000000..aaed33015
--- /dev/null
+++ b/packages/bruno-filestore/src/formats/bru/tests/request-parse-and-redact-body-data.spec.js
@@ -0,0 +1,44 @@
+const fs = require('node:fs');
+const path = require('node:path');
+const { bruRequestParseAndRedactBodyData } = require("../utils/request-parse-and-redact-body-data");
+
+describe("parse and redact body data", () => {
+ it("should redact body blocks from the bru file string", () => {
+ const fixturesPath = `/fixtures/request-parse-and-redact-body-data`;
+ const inputBruString = fs.readFileSync(path.join(__dirname, fixturesPath, './input.bru'), 'utf8');
+ const expectedOutputBruString = fs.readFileSync(path.join(__dirname, fixturesPath, './output.bru'), 'utf8');
+
+ const res = bruRequestParseAndRedactBodyData(inputBruString);
+ expect(res.bruFileStringWithRedactedBody).toBe(expectedOutputBruString);
+ expect(res.extractedBodyContent).toEqual({
+ graphql: `
+{
+ launchesPast {
+ launch_site {
+ site_name
+ }
+ launch_success
+ }
+}
+ `.trim(),
+ json: `
+{
+ "hello": "world"
+}
+ `.trim(),
+ sparql: `
+SELECT * WHERE {
+ ?subject ?predicate ?object .
+}
+LIMIT 10
+ `.trim(),
+ text: `This is a text body`,
+ xml: `
+
+ John
+ 30
+
+ `.trim()
+ })
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-filestore/src/formats/bru/utils/oauth2-additional-params.ts b/packages/bruno-filestore/src/formats/bru/utils/oauth2-additional-params.ts
new file mode 100644
index 000000000..54a613807
--- /dev/null
+++ b/packages/bruno-filestore/src/formats/bru/utils/oauth2-additional-params.ts
@@ -0,0 +1,141 @@
+type T_Oauth2ParameterType = 'authorization' | 'token' | 'refresh';
+type T_Oauth2ParameterSendInType = 'headers' | 'queryparams' | 'body';
+
+export interface T_OAuth2AdditionalParam {
+ name: string;
+ value: string;
+ enabled: boolean;
+ sendIn: T_Oauth2ParameterSendInType
+}
+
+export interface T_OAuth2AdditionalParameters {
+ authorization?: T_OAuth2AdditionalParam[];
+ token?: T_OAuth2AdditionalParam[];
+ refresh?: T_OAuth2AdditionalParam[];
+}
+
+export interface T_Oauth2Auth {
+ grantType: string;
+ additionalParameters?: T_OAuth2AdditionalParameters;
+}
+
+export interface T_BruJson {
+ auth: {
+ oauth2: T_Oauth2Auth;
+ };
+ oauth2_additional_parameters_auth_req_headers?: any[];
+ oauth2_additional_parameters_auth_req_queryparams?: any[];
+ oauth2_additional_parameters_access_token_req_headers?: any[];
+ oauth2_additional_parameters_access_token_req_queryparams?: any[];
+ oauth2_additional_parameters_access_token_req_bodyvalues?: any[];
+ oauth2_additional_parameters_refresh_token_req_headers?: any[];
+ oauth2_additional_parameters_refresh_token_req_queryparams?: any[];
+ oauth2_additional_parameters_refresh_token_req_bodyvalues?: any[];
+}
+
+interface T_Oauth2ParameterMapping {
+ type: T_Oauth2ParameterType;
+ sendIn: T_Oauth2ParameterSendInType;
+ source: keyof T_BruJson;
+}
+
+const PARAMETER_MAPPINGS: T_Oauth2ParameterMapping[] = [
+ // Authorization parameters (only for authorization_code grant type)
+ { type: 'authorization', sendIn: 'headers', source: 'oauth2_additional_parameters_auth_req_headers' },
+ { type: 'authorization', sendIn: 'queryparams', source: 'oauth2_additional_parameters_auth_req_queryparams' },
+
+ // Token parameters (for all grant types)
+ { type: 'token', sendIn: 'headers', source: 'oauth2_additional_parameters_access_token_req_headers' },
+ { type: 'token', sendIn: 'queryparams', source: 'oauth2_additional_parameters_access_token_req_queryparams' },
+ { type: 'token', sendIn: 'body', source: 'oauth2_additional_parameters_access_token_req_bodyvalues' },
+
+ // Refresh parameters (for grant types that support refresh)
+ { type: 'refresh', sendIn: 'headers', source: 'oauth2_additional_parameters_refresh_token_req_headers' },
+ { type: 'refresh', sendIn: 'queryparams', source: 'oauth2_additional_parameters_refresh_token_req_queryparams' },
+ { type: 'refresh', sendIn: 'body', source: 'oauth2_additional_parameters_refresh_token_req_bodyvalues' },
+];
+
+/**
+ * Maps source parameters to T_OAuth2AdditionalParam format
+ */
+const mapParametersFromSource = (sourceParams: any[], sendIn: T_Oauth2ParameterSendInType): T_OAuth2AdditionalParam[] => {
+ if (!sourceParams?.length) {
+ return [];
+ }
+
+ return sourceParams.map(param => ({
+ ...param,
+ sendIn
+ }));
+};
+
+/**
+ * Checks if a parameter type should be included based on grant type
+ */
+const shouldIncludeParameterType = (type: T_Oauth2ParameterType, grantType: string): boolean => {
+ // Authorization parameters are only valid for authorization_code grant type
+ if (type === 'authorization') {
+ return grantType === 'authorization_code' || grantType === 'implicit';
+ }
+
+ if (type === 'token' || type === 'refresh') {
+ return grantType !== 'implicit';
+ }
+
+ // Token and refresh parameters are valid for all grant types
+ return true;
+};
+
+/**
+ * Collects all parameters for a specific type (authorization, token, or refresh)
+ */
+const collectParametersForType = (
+ json: T_BruJson,
+ type: T_Oauth2ParameterType,
+ grantType: string
+): T_OAuth2AdditionalParam[] => {
+ if (!shouldIncludeParameterType(type, grantType)) {
+ return [];
+ }
+
+ const relevantMappings = PARAMETER_MAPPINGS.filter(mapping => mapping.type === type);
+ const allParams: T_OAuth2AdditionalParam[] = [];
+
+ for (const mapping of relevantMappings) {
+ const sourceParams = json[mapping.source] as any[];
+ const mappedParams = mapParametersFromSource(sourceParams, mapping.sendIn);
+ allParams.push(...mappedParams);
+ }
+
+ return allParams;
+};
+
+/**
+ * This function extracts OAuth2 additional parameters from various sources in the bru json data and organizes
+ * them into a structured format based on their usage context (authorization, token, refresh).
+ *
+ * @param json - json object containing OAuth2 configuration and additional parameters
+ * @returns OAuth2 additional parameters
+ */
+export const getOauth2AdditionalParameters = (json: T_BruJson): T_OAuth2AdditionalParameters => {
+ const grantType = json.auth.oauth2.grantType;
+ const additionalParameters: T_OAuth2AdditionalParameters = {};
+
+ try {
+ // Collect parameters for each type
+ const parameterTypes: T_Oauth2ParameterType[] = ['authorization', 'token', 'refresh'];
+
+ for (const type of parameterTypes) {
+ const params = collectParametersForType(json, type, grantType);
+ if (params.length > 0) {
+ additionalParameters[type] = params;
+ }
+ }
+ }
+ catch(error) {
+ console.error(error);
+ console.error("Error while getting the oauth2 additional parameters!");
+ }
+
+ return additionalParameters;
+};
\ No newline at end of file
diff --git a/packages/bruno-filestore/src/formats/bru/utils/request-parse-and-redact-body-data.ts b/packages/bruno-filestore/src/formats/bru/utils/request-parse-and-redact-body-data.ts
new file mode 100644
index 000000000..6e2313575
--- /dev/null
+++ b/packages/bruno-filestore/src/formats/bru/utils/request-parse-and-redact-body-data.ts
@@ -0,0 +1,77 @@
+/**
+ * Parses a .bru file and extracts body content while redacting it from the main content
+ * @param {string} bruFileContent - The raw content of the .bru file
+ * @returns {Object} Object containing redacted file content and extracted body data
+ */
+export const bruRequestParseAndRedactBodyData = (bruFileContent: string) => {
+ try {
+ // Define the patterns that indicate the start of different body types
+ const bodyTypePatterns = [
+ "body:json {",
+ "body:text {",
+ "body:xml {",
+ "body:sparql {",
+ "body:graphql {"
+ ];
+
+ // Normalize line endings to LF
+ bruFileContent = (bruFileContent || '').replace(/\r\n/g, '\n');
+
+ const EOL = `\n`;
+
+ /**
+ * Removes the leading 2-space indentation from each line of a string
+ * @param {string} indentedString - The string with leading spaces to remove
+ * @returns {string} The string with indentation removed
+ */
+ const removeLeadingIndentation = (indentedString: string) => {
+ if (!indentedString || !indentedString.length) {
+ return indentedString || '';
+ }
+
+ return indentedString
+ .split(EOL)
+ .map((line) => line.replace(/^ /, ''))
+ .join(EOL);
+ };
+
+ // Split the file content into blocks
+ let fileContentBlocks = bruFileContent.split(`${EOL}}${EOL}`);
+ fileContentBlocks = fileContentBlocks.filter(Boolean).map(_ => _.trim());
+
+ // Extract body blocks and their content
+ const extractedBodyBlocks = fileContentBlocks
+ .filter(block => bodyTypePatterns.some(pattern => block.startsWith(pattern)))
+ .reduce((bodyContentMap: Record, bodyBlock) => {
+ // Extract the body type (json, text, xml, etc.) from the first line
+ const firstLine = bodyBlock.split(EOL)[0];
+ const bodyType = firstLine.split(`body:`)[1].split(/\s/)[0];
+
+ // Extract the body content (everything between the opening and closing braces)
+ const bodyContentLines = bodyBlock.split(EOL).slice(1);
+ const rawBodyContent = bodyContentLines.join(EOL);
+
+ // Remove indentation from the body content
+ const cleanBodyContent = removeLeadingIndentation(rawBodyContent);
+
+ bodyContentMap[bodyType] = cleanBodyContent;
+ return bodyContentMap;
+ }, {});
+
+ // Filter out body blocks to get the remaining file content
+ const fileContentWithoutBodyBlocks = fileContentBlocks.filter(block =>
+ !bodyTypePatterns.some(pattern => block.startsWith(pattern))
+ );
+
+ return {
+ bruFileStringWithRedactedBody: fileContentWithoutBodyBlocks.join(`${EOL}}${EOL}${EOL}`).concat(`${EOL}}${EOL}`),
+ extractedBodyContent: extractedBodyBlocks
+ };
+ } catch (error) {
+ console.error('Error parsing and redacting body data:', error);
+ return {
+ bruFileStringWithRedactedBody: bruFileContent,
+ extractedBodyContent: {}
+ };
+ }
+};
\ No newline at end of file
diff --git a/packages/bruno-filestore/src/index.ts b/packages/bruno-filestore/src/index.ts
new file mode 100644
index 000000000..2e1ec26d5
--- /dev/null
+++ b/packages/bruno-filestore/src/index.ts
@@ -0,0 +1,108 @@
+import {
+ bruRequestToJson,
+ jsonRequestToBru,
+ bruCollectionToJson,
+ jsonCollectionToBru,
+ bruEnvironmentToJson,
+ jsonEnvironmentToBru
+} from './formats/bru';
+import { dotenvToJson } from '@usebruno/lang';
+import BruParserWorker from './workers';
+import {
+ ParseOptions,
+ StringifyOptions,
+ ParsedRequest,
+ ParsedCollection,
+ ParsedEnvironment
+} from './types';
+import { bruRequestParseAndRedactBodyData } from './formats/bru/utils/request-parse-and-redact-body-data';
+
+export const parseRequest = (content: string, options: ParseOptions = { format: 'bru' }): any => {
+ if (options.format === 'bru') {
+ return bruRequestToJson(content);
+ }
+ throw new Error(`Unsupported format: ${options.format}`);
+};
+
+export const parseRequestAndRedactBody = (content: string, options: ParseOptions = { format: 'bru' }): any => {
+ if (options.format === 'bru') {
+ return bruRequestParseAndRedactBodyData(content);
+ }
+ throw new Error(`Unsupported format: ${options.format}`);
+};
+
+export const stringifyRequest = (requestObj: ParsedRequest, options: StringifyOptions = { format: 'bru' }): string => {
+ if (options.format === 'bru') {
+ return jsonRequestToBru(requestObj);
+ }
+ throw new Error(`Unsupported format: ${options.format}`);
+};
+
+let globalWorkerInstance: BruParserWorker | null = null;
+
+const getWorkerInstance = (): BruParserWorker => {
+ if (!globalWorkerInstance) {
+ globalWorkerInstance = new BruParserWorker();
+ }
+ return globalWorkerInstance;
+};
+
+export const parseRequestViaWorker = async (content: string): Promise => {
+ const fileParserWorker = getWorkerInstance();
+ return await fileParserWorker.parseRequest(content);
+};
+
+export const stringifyRequestViaWorker = async (requestObj: any): Promise => {
+ const fileParserWorker = getWorkerInstance();
+ return await fileParserWorker.stringifyRequest(requestObj);
+};
+
+export const parseCollection = (content: string, options: ParseOptions = { format: 'bru' }): any => {
+ if (options.format === 'bru') {
+ return bruCollectionToJson(content);
+ }
+ throw new Error(`Unsupported format: ${options.format}`);
+};
+
+export const stringifyCollection = (collectionObj: ParsedCollection, options: StringifyOptions = { format: 'bru' }): string => {
+ if (options.format === 'bru') {
+ return jsonCollectionToBru(collectionObj, false);
+ }
+ throw new Error(`Unsupported format: ${options.format}`);
+};
+
+export const parseFolder = (content: string, options: ParseOptions = { format: 'bru' }): any => {
+ if (options.format === 'bru') {
+ return bruCollectionToJson(content);
+ }
+ throw new Error(`Unsupported format: ${options.format}`);
+};
+
+export const stringifyFolder = (folderObj: any, options: StringifyOptions = { format: 'bru' }): string => {
+ if (options.format === 'bru') {
+ return jsonCollectionToBru(folderObj, true);
+ }
+ throw new Error(`Unsupported format: ${options.format}`);
+};
+
+export const parseEnvironment = (content: string, options: ParseOptions = { format: 'bru' }): any => {
+ if (options.format === 'bru') {
+ return bruEnvironmentToJson(content);
+ }
+ throw new Error(`Unsupported format: ${options.format}`);
+};
+
+export const stringifyEnvironment = (envObj: ParsedEnvironment, options: StringifyOptions = { format: 'bru' }): string => {
+ if (options.format === 'bru') {
+ return jsonEnvironmentToBru(envObj);
+ }
+ throw new Error(`Unsupported format: ${options.format}`);
+};
+
+
+export const parseDotEnv = (content: string): Record => {
+ return dotenvToJson(content);
+};
+
+export { BruParserWorker };
+export * from './types';
\ No newline at end of file
diff --git a/packages/bruno-filestore/src/types.ts b/packages/bruno-filestore/src/types.ts
new file mode 100644
index 000000000..6c0564b4e
--- /dev/null
+++ b/packages/bruno-filestore/src/types.ts
@@ -0,0 +1,141 @@
+export interface ParseOptions {
+ format?: 'bru' | 'yaml';
+}
+
+export interface StringifyOptions {
+ format?: 'bru' | 'yaml';
+}
+
+export interface RequestBody {
+ mode?: string;
+ raw?: string;
+ formUrlEncoded?: Array<{ name: string; value: string; enabled: boolean }>;
+ multipartForm?: Array<{ name: string; value: string; type: string; enabled: boolean }>;
+ json?: string;
+ xml?: string;
+ sparql?: string;
+ graphql?: {
+ query?: string;
+ variables?: string;
+ };
+}
+
+export interface AuthConfig {
+ mode?: string;
+ basic?: {
+ username?: string;
+ password?: string;
+ };
+ bearer?: {
+ token?: string;
+ };
+ apikey?: {
+ key?: string;
+ value?: string;
+ placement?: string;
+ };
+ awsv4?: {
+ accessKeyId?: string;
+ secretAccessKey?: string;
+ sessionToken?: string;
+ service?: string;
+ region?: string;
+ profileName?: string;
+ };
+ oauth2?: {
+ grantType?: string;
+ callbackUrl?: string;
+ authorizationUrl?: string;
+ accessTokenUrl?: string;
+ clientId?: string;
+ clientSecret?: string;
+ scope?: string;
+ state?: string;
+ pkce?: boolean;
+ };
+}
+
+export interface RequestParam {
+ name: string;
+ value: string;
+ enabled: boolean;
+}
+
+export interface RequestHeader {
+ name: string;
+ value: string;
+ enabled: boolean;
+}
+
+export interface RequestAssertion {
+ name: string;
+ value: string;
+ enabled: boolean;
+}
+
+export interface RequestVars {
+ req?: Array<{ name: string; value: string; enabled: boolean }>;
+ res?: Array<{ name: string; value: string; enabled: boolean }>;
+}
+
+export interface RequestScript {
+ req?: string;
+ res?: string;
+}
+
+export interface RequestSettings {
+ [key: string]: any;
+}
+
+export interface RequestData {
+ method: string;
+ url: string;
+ params: RequestParam[];
+ headers: RequestHeader[];
+ auth: AuthConfig;
+ body: RequestBody;
+ script: RequestScript;
+ vars: RequestVars;
+ assertions: RequestAssertion[];
+ tests: string;
+ docs: string;
+}
+
+export interface ParsedRequest {
+ type: 'http-request' | 'graphql-request';
+ name: string;
+ seq: number;
+ settings: RequestSettings;
+ tags: string[];
+ request: RequestData;
+}
+
+export interface ParsedCollection {
+ name: string;
+ type?: string;
+ version?: string;
+ [key: string]: any;
+}
+
+export interface EnvironmentVariable {
+ name: string;
+ value: string;
+ enabled: boolean;
+}
+
+export interface ParsedEnvironment {
+ variables: EnvironmentVariable[];
+}
+
+export interface WorkerTask {
+ data: any;
+ priority: number;
+ scriptPath: string;
+ taskType?: 'parse' | 'stringify';
+ resolve?: (value: any) => void;
+ reject?: (reason?: any) => void;
+}
+
+export interface Lane {
+ maxSize: number;
+}
\ No newline at end of file
diff --git a/packages/bruno-filestore/src/types/bruno-lang.d.ts b/packages/bruno-filestore/src/types/bruno-lang.d.ts
new file mode 100644
index 000000000..257d6e8a0
--- /dev/null
+++ b/packages/bruno-filestore/src/types/bruno-lang.d.ts
@@ -0,0 +1,9 @@
+declare module '@usebruno/lang' {
+ export function bruToJsonV2(bruContent: string): any;
+ export function jsonToBruV2(jsonData: any): string;
+ export function bruToEnvJsonV2(bruContent: string): any;
+ export function envJsonToBruV2(jsonData: any): string;
+ export function collectionBruToJson(bruContent: string): any;
+ export function jsonToCollectionBru(jsonData: any): string;
+ export function dotenvToJson(envContent: string): Record;
+}
\ No newline at end of file
diff --git a/packages/bruno-filestore/src/workers/WorkerQueue/index.ts b/packages/bruno-filestore/src/workers/WorkerQueue/index.ts
new file mode 100644
index 000000000..bb248ee3f
--- /dev/null
+++ b/packages/bruno-filestore/src/workers/WorkerQueue/index.ts
@@ -0,0 +1,114 @@
+import { Worker } from 'node:worker_threads';
+
+interface QueuedTask {
+ priority: number;
+ scriptPath: string;
+ data: any;
+ taskType: 'parse' | 'stringify';
+ resolve?: (value: any) => void;
+ reject?: (reason?: any) => void;
+}
+
+class WorkerQueue {
+ private queue: QueuedTask[];
+ private isProcessing: boolean;
+ private workers: Record;
+
+ constructor() {
+ this.queue = [];
+ this.isProcessing = false;
+ this.workers = {};
+ }
+
+ async getWorkerForScriptPath(scriptPath: string) {
+ if (!this.workers) this.workers = {};
+ let worker = this.workers[scriptPath];
+ if (!worker || worker.threadId === -1) {
+ this.workers[scriptPath] = worker = new Worker(scriptPath);
+ }
+ return worker;
+ }
+
+ async enqueue(task: QueuedTask) {
+ const { priority, scriptPath, data, taskType } = task;
+
+ return new Promise((resolve, reject) => {
+ this.queue.push({ priority, scriptPath, data, taskType, resolve, reject });
+ this.queue?.sort((taskX, taskY) => taskX?.priority - taskY?.priority);
+ this.processQueue();
+ });
+ }
+
+ async processQueue() {
+ if (this.isProcessing || this.queue.length === 0){
+ return;
+ }
+
+ this.isProcessing = true;
+ const { scriptPath, data, taskType, resolve, reject } = this.queue.shift() as QueuedTask;
+
+ try {
+ const result = await this.runWorker({ scriptPath, data, taskType });
+ resolve?.(result);
+ } catch (error) {
+ reject?.(error);
+ } finally {
+ this.isProcessing = false;
+ this.processQueue();
+ }
+ }
+
+ async runWorker({ scriptPath, data, taskType }: { scriptPath: string; data: any; taskType: 'parse' | 'stringify' }) {
+ return new Promise(async (resolve, reject) => {
+ let worker = await this.getWorkerForScriptPath(scriptPath);
+
+ const messageHandler = (data: any) => {
+ worker.off('message', messageHandler);
+ worker.off('error', errorHandler);
+ worker.off('exit', exitHandler);
+
+ if (data?.error) {
+ reject(new Error(data?.error));
+ } else {
+ resolve(data);
+ }
+ };
+
+ const errorHandler = (error: Error) => {
+ worker.off('message', messageHandler);
+ worker.off('error', errorHandler);
+ worker.off('exit', exitHandler);
+ reject(error);
+ };
+
+ const exitHandler = (code: number) => {
+ worker.off('message', messageHandler);
+ worker.off('error', errorHandler);
+ worker.off('exit', exitHandler);
+ // Remove dead worker from cache
+ delete this.workers[scriptPath];
+ reject(new Error(`Worker stopped with exit code ${code}`));
+ };
+
+ worker.on('message', messageHandler);
+ worker.on('error', errorHandler);
+ worker.on('exit', exitHandler);
+
+ worker.postMessage({ taskType, data });
+ });
+ }
+
+ async cleanup() {
+ const promises = Object.values(this.workers).map(worker => {
+ if (worker.threadId !== -1) {
+ return worker.terminate();
+ }
+ return Promise.resolve();
+ });
+
+ await Promise.allSettled(promises);
+ this.workers = {};
+ }
+}
+
+export default WorkerQueue;
\ No newline at end of file
diff --git a/packages/bruno-filestore/src/workers/index.ts b/packages/bruno-filestore/src/workers/index.ts
new file mode 100644
index 000000000..af66ea107
--- /dev/null
+++ b/packages/bruno-filestore/src/workers/index.ts
@@ -0,0 +1,86 @@
+import WorkerQueue from './WorkerQueue';
+import { Lane } from '../types';
+import path from 'node:path';
+
+const sizeInMB = (size: number): number => {
+ return size / (1024 * 1024);
+}
+
+const getSize = (data: any): number => {
+ return sizeInMB(typeof data === 'string' ? Buffer.byteLength(data, 'utf8') : Buffer.byteLength(JSON.stringify(data), 'utf8'));
+}
+
+/**
+ * Lanes are used to determine which worker queue to use based on the size of the data.
+ *
+ * The first lane is for smaller files (<0.1MB), the second lane is for larger files (>=0.1MB).
+ * This helps with parsing performance.
+ */
+const LANES: Lane[] = [{
+ maxSize: 0.005
+},{
+ maxSize: 0.1
+},{
+ maxSize: 1
+},{
+ maxSize: 10
+},{
+ maxSize: 100
+}];
+
+interface WorkerQueueWithSize {
+ maxSize: number;
+ workerQueue: WorkerQueue;
+
+}
+
+class BruParserWorker {
+ private workerQueues: WorkerQueueWithSize[];
+
+ constructor() {
+ this.workerQueues = LANES?.map(lane => ({
+ maxSize: lane?.maxSize,
+ workerQueue: new WorkerQueue()
+ }));
+ }
+
+ private getWorkerQueue(size: number): WorkerQueue {
+ // Find the first queue that can handle the given size
+ // or fallback to the last queue for largest files
+ const queueForSize = this.workerQueues.find((queue) =>
+ queue.maxSize >= size
+ );
+
+ return queueForSize?.workerQueue ?? this.workerQueues[this.workerQueues.length - 1].workerQueue;
+ }
+
+ private async enqueueTask({ data, taskType }: { data: any; taskType: 'parse' | 'stringify' }): Promise {
+ const size = getSize(data);
+ const workerQueue = this.getWorkerQueue(size);
+ const workerScriptPath = path.join(__dirname, './workers/worker-script.js');
+
+ return workerQueue.enqueue({
+ data,
+ priority: size,
+ scriptPath: workerScriptPath,
+ taskType,
+ });
+ }
+
+ async parseRequest(data: any): Promise {
+ return this.enqueueTask({ data, taskType: 'parse' });
+ }
+
+ async stringifyRequest(data: any): Promise {
+ return this.enqueueTask({ data, taskType: 'stringify' });
+ }
+
+ async cleanup(): Promise {
+ const cleanupPromises = this.workerQueues.map(({ workerQueue }) =>
+ workerQueue.cleanup()
+ );
+ await Promise.allSettled(cleanupPromises);
+ }
+}
+
+export default BruParserWorker;
\ No newline at end of file
diff --git a/packages/bruno-filestore/src/workers/worker-script.ts b/packages/bruno-filestore/src/workers/worker-script.ts
new file mode 100644
index 000000000..7a6529aab
--- /dev/null
+++ b/packages/bruno-filestore/src/workers/worker-script.ts
@@ -0,0 +1,27 @@
+import { parentPort } from 'node:worker_threads';
+import { bruRequestToJson, jsonRequestToBru } from '../formats/bru';
+
+interface WorkerMessage {
+ taskType: 'parse' | 'stringify';
+ data: any;
+}
+
+parentPort?.on('message', async (message: WorkerMessage) => {
+ try {
+ const { taskType, data } = message;
+ let result: any;
+
+ if (taskType === 'parse') {
+ result = bruRequestToJson(data);
+ } else if (taskType === 'stringify') {
+ result = jsonRequestToBru(data);
+ } else {
+ throw new Error(`Unknown task type: ${taskType}`);
+ }
+
+ parentPort?.postMessage(result);
+ } catch (error: any) {
+ console.error('Worker error:', error);
+ parentPort?.postMessage({ error: error?.message });
+ }
+});
\ No newline at end of file
diff --git a/packages/bruno-filestore/tsconfig.json b/packages/bruno-filestore/tsconfig.json
new file mode 100644
index 000000000..22385164b
--- /dev/null
+++ b/packages/bruno-filestore/tsconfig.json
@@ -0,0 +1,24 @@
+{
+ "compilerOptions": {
+ "target": "ES2020",
+ "module": "ESNext",
+ "strict": true,
+ "esModuleInterop": true,
+ "skipLibCheck": true,
+ "forceConsistentCasingInFileNames": true,
+ "outDir": "./dist",
+ "rootDir": "./src",
+ "resolveJsonModule": true,
+ "allowSyntheticDefaultImports": true,
+ "moduleResolution": "node",
+ "declaration": true,
+ "declarationDir": "./dist/types",
+ "allowJs": true,
+ "checkJs": false,
+ "types": ["node"],
+ "lib": ["ES2020"],
+ "typeRoots": ["./node_modules/@types", "./src/types"]
+ },
+ "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.js", "src/**/*.d.ts"],
+ "exclude": ["node_modules", "dist"]
+}
\ No newline at end of file
diff --git a/packages/bruno-graphql-docs/package.json b/packages/bruno-graphql-docs/package.json
index fde24713b..548f212c9 100644
--- a/packages/bruno-graphql-docs/package.json
+++ b/packages/bruno-graphql-docs/package.json
@@ -9,7 +9,8 @@
"package.json"
],
"scripts": {
- "build": "rollup -c"
+ "build": "rollup -c",
+ "watch": "rollup -c -w"
},
"devDependencies": {
"@rollup/plugin-commonjs": "^23.0.2",
diff --git a/packages/bruno-js/package.json b/packages/bruno-js/package.json
index 8ad1d8e46..ae7749692 100644
--- a/packages/bruno-js/package.json
+++ b/packages/bruno-js/package.json
@@ -21,10 +21,11 @@
"ajv": "^8.12.0",
"ajv-formats": "^2.1.1",
"atob": "^2.1.2",
- "axios": "1.7.5",
+ "axios": "^1.8.3",
"btoa": "^1.2.1",
"chai": "^4.3.7",
"chai-string": "^1.5.0",
+ "cheerio": "^1.0.0",
"crypto-js": "^4.1.1",
"json-query": "^2.2.2",
"lodash": "^4.17.21",
@@ -34,14 +35,14 @@
"node-vault": "^0.10.2",
"path": "^0.12.7",
"quickjs-emscripten": "^0.29.2",
- "uuid": "^9.0.0"
+ "tv4": "^1.3.0",
+ "uuid": "^9.0.0",
+ "xml2js": "^0.6.2"
},
"devDependencies": {
"@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"
}
-}
+}
\ No newline at end of file
diff --git a/packages/bruno-js/src/bru.js b/packages/bruno-js/src/bru.js
index 9fa9d8f0c..2bcb0a7d9 100644
--- a/packages/bruno-js/src/bru.js
+++ b/packages/bruno-js/src/bru.js
@@ -1,10 +1,12 @@
const { cloneDeep } = require('lodash');
-const { interpolate } = require('@usebruno/common');
+const { interpolate: _interpolate } = require('@usebruno/common');
+const { sendRequest } = require('@usebruno/requests').scripting;
+const { jar: createCookieJar } = require('@usebruno/requests').cookies;
const variableNameRegex = /^[\w-.]*$/;
class Bru {
- constructor(envVariables, runtimeVariables, processEnvVars, collectionPath, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables) {
+ constructor(envVariables, runtimeVariables, processEnvVars, collectionPath, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, collectionName) {
this.envVariables = envVariables || {};
this.runtimeVariables = runtimeVariables || {};
this.processEnvVars = cloneDeep(processEnvVars || {});
@@ -12,7 +14,55 @@ class Bru {
this.folderVariables = folderVariables || {};
this.requestVariables = requestVariables || {};
this.globalEnvironmentVariables = globalEnvironmentVariables || {};
+ this.oauth2CredentialVariables = oauth2CredentialVariables || {};
this.collectionPath = collectionPath;
+ this.collectionName = collectionName;
+ this.sendRequest = sendRequest;
+ this.cookies = {
+ jar: () => {
+ const cookieJar = createCookieJar();
+
+ return {
+ getCookie: (url, cookieName, callback) => {
+ const interpolatedUrl = this.interpolate(url);
+ return cookieJar.getCookie(interpolatedUrl, cookieName, callback);
+ },
+
+ getCookies: (url, callback) => {
+ const interpolatedUrl = this.interpolate(url);
+ return cookieJar.getCookies(interpolatedUrl, callback);
+ },
+
+ setCookie: (url, nameOrCookieObj, valueOrCallback, maybeCallback) => {
+ const interpolatedUrl = this.interpolate(url);
+ return cookieJar.setCookie(interpolatedUrl, nameOrCookieObj, valueOrCallback, maybeCallback);
+ },
+
+ setCookies: (url, cookiesArray, callback) => {
+ const interpolatedUrl = this.interpolate(url);
+ return cookieJar.setCookies(interpolatedUrl, cookiesArray, callback);
+ },
+
+ // Clear entire cookie jar
+ clear: (callback) => {
+ return cookieJar.clear(callback);
+ },
+
+ // Delete cookies for a specific URL/domain
+ deleteCookies: (url, callback) => {
+ const interpolatedUrl = this.interpolate(url);
+ return cookieJar.deleteCookies(interpolatedUrl, callback);
+ },
+
+ deleteCookie: (url, cookieName, callback) => {
+ const interpolatedUrl = this.interpolate(url);
+ return cookieJar.deleteCookie(interpolatedUrl, cookieName, callback);
+ }
+ };
+ }
+ };
+ // Holds variables that are marked as persistent by scripts
+ this.persistentEnvVariables = {};
this.runner = {
skipRequest: () => {
this.skipRequest = true;
@@ -26,10 +76,10 @@ class Bru {
};
}
- _interpolate = (str) => {
- if (!str || !str.length || typeof str !== 'string') {
- return str;
- }
+ interpolate = (strOrObj) => {
+ if (!strOrObj) return strOrObj;
+ const isObj = typeof strOrObj === 'object';
+ const strToInterpolate = isObj ? JSON.stringify(strOrObj) : strOrObj;
const combinedVars = {
...this.globalEnvironmentVariables,
@@ -37,6 +87,7 @@ class Bru {
...this.envVariables,
...this.folderVariables,
...this.requestVariables,
+ ...this.oauth2CredentialVariables,
...this.runtimeVariables,
process: {
env: {
@@ -45,7 +96,8 @@ class Bru {
}
};
- return interpolate(str, combinedVars);
+ const interpolatedStr = _interpolate(strToInterpolate, combinedVars);
+ return isObj ? JSON.parse(interpolatedStr) : interpolatedStr;
};
cwd() {
@@ -65,15 +117,34 @@ class Bru {
}
getEnvVar(key) {
- return this._interpolate(this.envVariables[key]);
+ 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}".`);
+ }
+
this.envVariables[key] = value;
+
+ if (options?.persist) {
+ this.persistentEnvVariables[key] = value;
+ } else {
+ if (this.persistentEnvVariables[key]) {
+ delete this.persistentEnvVariables[key];
+ }
+ }
}
deleteEnvVar(key) {
@@ -81,7 +152,7 @@ class Bru {
}
getGlobalEnvVar(key) {
- return this._interpolate(this.globalEnvironmentVariables[key]);
+ return this.interpolate(this.globalEnvironmentVariables[key]);
}
setGlobalEnvVar(key, value) {
@@ -92,6 +163,10 @@ class Bru {
this.globalEnvironmentVariables[key] = value;
}
+ getOauth2CredentialVar(key) {
+ return this.interpolate(this.oauth2CredentialVariables[key]);
+ }
+
hasVar(key) {
return Object.hasOwn(this.runtimeVariables, key);
}
@@ -104,7 +179,7 @@ class Bru {
if (variableNameRegex.test(key) === false) {
throw new Error(
`Variable name: "${key}" contains invalid characters!` +
- ' Names must only contain alpha-numeric characters, "-", "_", "."'
+ ' Names must only contain alpha-numeric characters, "-", "_", "."'
);
}
@@ -115,11 +190,11 @@ class Bru {
if (variableNameRegex.test(key) === false) {
throw new Error(
`Variable name: "${key}" contains invalid characters!` +
- ' Names must only contain alpha-numeric characters, "-", "_", "."'
+ ' Names must only contain alpha-numeric characters, "-", "_", "."'
);
}
- return this._interpolate(this.runtimeVariables[key]);
+ return this.interpolate(this.runtimeVariables[key]);
}
deleteVar(key) {
@@ -135,15 +210,15 @@ class Bru {
}
getCollectionVar(key) {
- return this._interpolate(this.collectionVariables[key]);
+ return this.interpolate(this.collectionVariables[key]);
}
getFolderVar(key) {
- return this._interpolate(this.folderVariables[key]);
+ return this.interpolate(this.folderVariables[key]);
}
getRequestVar(key) {
- return this._interpolate(this.requestVariables[key]);
+ return this.interpolate(this.requestVariables[key]);
}
setNextRequest(nextRequest) {
@@ -153,6 +228,10 @@ class Bru {
sleep(ms) {
return new Promise((resolve) => setTimeout(resolve, ms));
}
+
+ getCollectionName() {
+ return this.collectionName;
+ }
}
module.exports = Bru;
diff --git a/packages/bruno-js/src/bruno-request.js b/packages/bruno-js/src/bruno-request.js
index 32e40c19e..b08e6515d 100644
--- a/packages/bruno-js/src/bruno-request.js
+++ b/packages/bruno-js/src/bruno-request.js
@@ -17,7 +17,7 @@ class BrunoRequest {
this.method = req.method;
this.headers = req.headers;
this.timeout = req.timeout;
-
+ this.name = req.name;
/**
* We automatically parse the JSON body if the content type is JSON
* This is to make it easier for the user to access the body directly
@@ -148,6 +148,14 @@ class BrunoRequest {
this.timeout = timeout;
this.req.timeout = timeout;
}
+
+ onFail(callback) {
+ if (typeof callback === 'function') {
+ this.req.onFailHandler = callback;
+ } else if (callback) {
+ throw new Error(`${callback} is not a function`);
+ }
+ }
__safeParseJSON(str) {
try {
@@ -177,6 +185,10 @@ class BrunoRequest {
getExecutionMode() {
return this.req.__bruno__executionMode;
}
+
+ getName() {
+ return this.req.name;
+ }
}
module.exports = BrunoRequest;
diff --git a/packages/bruno-js/src/bruno-response.js b/packages/bruno-js/src/bruno-response.js
index 9e68045d9..2a482c5e7 100644
--- a/packages/bruno-js/src/bruno-response.js
+++ b/packages/bruno-js/src/bruno-response.js
@@ -1,3 +1,6 @@
+const { get } = require('@usebruno/query');
+const _ = require('lodash');
+
class BrunoResponse {
constructor(res) {
this.res = res;
@@ -6,12 +9,24 @@ class BrunoResponse {
this.headers = res ? res.headers : null;
this.body = res ? res.data : null;
this.responseTime = res ? res.responseTime : null;
+ this.url = res?.request ? res.request.protocol + '//' + res.request.host + res.request.path : null;
+
+ // Make the instance callable
+ const callable = (...args) => get(this.body, ...args);
+ Object.setPrototypeOf(callable, this.constructor.prototype);
+ Object.assign(callable, this);
+
+ return callable;
}
getStatus() {
return this.res ? this.res.status : null;
}
+ getStatusText() {
+ return this.res ? this.res.statusText : null;
+ }
+
getHeader(name) {
return this.res && this.res.headers ? this.res.headers[name] : null;
}
@@ -28,13 +43,62 @@ class BrunoResponse {
return this.res ? this.res.responseTime : null;
}
+ getUrl() {
+ return this.res ? this.url : null;
+ }
+
setBody(data) {
if (!this.res) {
return;
}
- this.body = data;
- this.res.data = data;
+ const clonedData = _.cloneDeep(data);
+ this.res.data = clonedData;
+ this.body = clonedData;
+ }
+
+ // TODO: Refactor: dataBuffer size calculation should be handled in a shared utility so it can be passed and reused across the application
+ getSize() {
+ if (!this.res) {
+ return { header: 0, body: 0, total: 0 };
+ }
+
+ const { data, dataBuffer, headers } = this.res;
+ let bodySize = 0;
+
+ // Use raw received bytes
+ if (Buffer.isBuffer(dataBuffer)) {
+ bodySize = dataBuffer.length;
+ } else {
+ // Use server-reported Content-Length
+ const contentLength = headers && (headers['content-length'] || headers['Content-Length']);
+ if (contentLength && !isNaN(contentLength)) {
+ bodySize = parseInt(contentLength, 10);
+ } else if (data != null) {
+ // Manual calculation
+ const raw = typeof data === 'string' ? data : JSON.stringify(data);
+ bodySize = Buffer.byteLength(raw);
+ }
+ }
+
+ const headerLines = [
+ `HTTP/1.1 ${this.res.status} ${this.res.statusText}`,
+ ...Object.entries(this.res.headers || {}).flatMap(([key, value]) =>
+ Array.isArray(value)
+ ? value.map((v) => `${key}: ${v}`)
+ : [`${key}: ${value}`]
+ ),
+ '',
+ ''
+ ];
+ const headerSize = Buffer.byteLength(headerLines.join('\r\n'));
+
+ return { header: headerSize, body: bodySize, total: headerSize + bodySize };
+
+ }
+
+ getDataBuffer() {
+ return this.res ? this.res.dataBuffer : null;
}
}
diff --git a/packages/bruno-js/src/runtime/assert-runtime.js b/packages/bruno-js/src/runtime/assert-runtime.js
index 558dcaba1..4e997d314 100644
--- a/packages/bruno-js/src/runtime/assert-runtime.js
+++ b/packages/bruno-js/src/runtime/assert-runtime.js
@@ -246,6 +246,7 @@ class AssertRuntime {
runAssertions(assertions, request, response, envVariables, runtimeVariables, processEnvVars) {
const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
+ const oauth2CredentialVariables = request?.oauth2CredentialVariables || {};
const collectionVariables = request?.collectionVariables || {};
const folderVariables = request?.folderVariables || {};
const requestVariables = request?.requestVariables || {};
@@ -279,6 +280,7 @@ class AssertRuntime {
...envVariables,
...folderVariables,
...requestVariables,
+ ...oauth2CredentialVariables,
...runtimeVariables,
...processEnvVars,
...bruContext
diff --git a/packages/bruno-js/src/runtime/script-runtime.js b/packages/bruno-js/src/runtime/script-runtime.js
index dcde3f27c..7a9b1a5bc 100644
--- a/packages/bruno-js/src/runtime/script-runtime.js
+++ b/packages/bruno-js/src/runtime/script-runtime.js
@@ -13,6 +13,7 @@ const Bru = require('../bru');
const BrunoRequest = require('../bruno-request');
const BrunoResponse = require('../bruno-response');
const { cleanJson } = require('../utils');
+const { createBruTestResultMethods } = require('../utils/results');
// Inbuilt Library Support
const ajv = require('ajv');
@@ -28,6 +29,9 @@ const fetch = require('node-fetch');
const chai = require('chai');
const CryptoJS = require('crypto-js');
const NodeVault = require('node-vault');
+const xml2js = require('xml2js');
+const cheerio = require('cheerio');
+const tv4 = require('tv4');
const { executeQuickJsVmAsync } = require('../sandbox/quickjs');
class ScriptRuntime {
@@ -46,13 +50,16 @@ class ScriptRuntime {
onConsoleLog,
processEnvVars,
scriptingConfig,
- runRequestByItemPathname
+ runRequestByItemPathname,
+ collectionName
) {
const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
+ const oauth2CredentialVariables = request?.oauth2CredentialVariables || {};
const collectionVariables = request?.collectionVariables || {};
const folderVariables = request?.folderVariables || {};
const requestVariables = request?.requestVariables || {};
- const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables);
+ const assertionResults = request?.assertionResults || [];
+ const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, collectionName);
const req = new BrunoRequest(request);
const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
@@ -73,9 +80,16 @@ class ScriptRuntime {
}
}
+ // extend bru with result getter methods
+ const { __brunoTestResults, test } = createBruTestResultMethods(bru, assertionResults, chai);
+
const context = {
bru,
- req
+ req,
+ test,
+ expect: chai.expect,
+ assert: chai.assert,
+ __brunoTestResults: __brunoTestResults
};
if (onConsoleLog && typeof onConsoleLog === 'function') {
@@ -93,7 +107,7 @@ class ScriptRuntime {
};
}
- if(runRequestByItemPathname) {
+ if (runRequestByItemPathname) {
context.bru.runRequest = runRequestByItemPathname;
}
@@ -108,7 +122,9 @@ class ScriptRuntime {
request,
envVariables: cleanJson(envVariables),
runtimeVariables: cleanJson(runtimeVariables),
+ persistentEnvVariables: bru.persistentEnvVariables,
globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+ results: cleanJson(__brunoTestResults.getResults()),
nextRequestName: bru.nextRequest,
skipRequest: bru.skipRequest,
stopExecution: bru.stopExecution
@@ -120,6 +136,7 @@ class ScriptRuntime {
sandbox: context,
require: {
context: 'sandbox',
+ builtin: [ "*" ],
external: true,
root: [collectionPath, ...additionalContextRootsAbsolute],
mock: {
@@ -145,6 +162,9 @@ class ScriptRuntime {
chai,
'node-fetch': fetch,
'crypto-js': CryptoJS,
+ xml2js: xml2js,
+ cheerio,
+ tv4,
...whitelistedModules,
fs: allowScriptFilesystemAccess ? fs : undefined,
'node-vault': NodeVault
@@ -158,7 +178,9 @@ class ScriptRuntime {
request,
envVariables: cleanJson(envVariables),
runtimeVariables: cleanJson(runtimeVariables),
+ persistentEnvVariables: bru.persistentEnvVariables,
globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+ results: cleanJson(__brunoTestResults.getResults()),
nextRequestName: bru.nextRequest,
skipRequest: bru.skipRequest,
stopExecution: bru.stopExecution
@@ -175,17 +197,25 @@ class ScriptRuntime {
onConsoleLog,
processEnvVars,
scriptingConfig,
- runRequestByItemPathname
+ runRequestByItemPathname,
+ collectionName
) {
const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
+ const oauth2CredentialVariables = request?.oauth2CredentialVariables || {};
const collectionVariables = request?.collectionVariables || {};
const folderVariables = request?.folderVariables || {};
const requestVariables = request?.requestVariables || {};
- const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables);
+ const assertionResults = request?.assertionResults || [];
+ const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables, collectionName);
const req = new BrunoRequest(request);
const res = new BrunoResponse(response);
const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
const moduleWhitelist = get(scriptingConfig, 'moduleWhitelist', []);
+ const additionalContextRoots = get(scriptingConfig, 'additionalContextRoots', []);
+ const additionalContextRootsAbsolute = lodash
+ .chain(additionalContextRoots)
+ .map((acr) => (acr.startsWith('/') ? acr : path.join(collectionPath, acr)))
+ .value();
const whitelistedModules = {};
@@ -198,10 +228,17 @@ class ScriptRuntime {
}
}
+ // extend bru with result getter methods
+ const { __brunoTestResults, test } = createBruTestResultMethods(bru, assertionResults, chai);
+
const context = {
bru,
req,
- res
+ res,
+ test,
+ expect: chai.expect,
+ assert: chai.assert,
+ __brunoTestResults: __brunoTestResults
};
if (onConsoleLog && typeof onConsoleLog === 'function') {
@@ -219,7 +256,7 @@ class ScriptRuntime {
};
}
- if(runRequestByItemPathname) {
+ if (runRequestByItemPathname) {
context.bru.runRequest = runRequestByItemPathname;
}
@@ -233,8 +270,10 @@ class ScriptRuntime {
return {
response,
envVariables: cleanJson(envVariables),
+ persistentEnvVariables: cleanJson(bru.persistentEnvVariables),
runtimeVariables: cleanJson(runtimeVariables),
globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+ results: cleanJson(__brunoTestResults.getResults()),
nextRequestName: bru.nextRequest,
skipRequest: bru.skipRequest,
stopExecution: bru.stopExecution
@@ -246,8 +285,9 @@ class ScriptRuntime {
sandbox: context,
require: {
context: 'sandbox',
+ builtin: [ "*" ],
external: true,
- root: [collectionPath],
+ root: [collectionPath, ...additionalContextRootsAbsolute],
mock: {
// node libs
path,
@@ -270,6 +310,9 @@ class ScriptRuntime {
axios,
'node-fetch': fetch,
'crypto-js': CryptoJS,
+ 'xml2js': xml2js,
+ cheerio,
+ tv4,
...whitelistedModules,
fs: allowScriptFilesystemAccess ? fs : undefined,
'node-vault': NodeVault
@@ -283,8 +326,10 @@ class ScriptRuntime {
return {
response,
envVariables: cleanJson(envVariables),
+ persistentEnvVariables: cleanJson(bru.persistentEnvVariables),
runtimeVariables: cleanJson(runtimeVariables),
globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+ results: cleanJson(__brunoTestResults.getResults()),
nextRequestName: bru.nextRequest,
skipRequest: bru.skipRequest,
stopExecution: bru.stopExecution
diff --git a/packages/bruno-js/src/runtime/test-runtime.js b/packages/bruno-js/src/runtime/test-runtime.js
index 71db9d83e..ae4e2c963 100644
--- a/packages/bruno-js/src/runtime/test-runtime.js
+++ b/packages/bruno-js/src/runtime/test-runtime.js
@@ -16,6 +16,7 @@ const BrunoResponse = require('../bruno-response');
const Test = require('../test');
const TestResults = require('../test-results');
const { cleanJson } = require('../utils');
+const { createBruTestResultMethods } = require('../utils/results');
// Inbuilt Library Support
const ajv = require('ajv');
@@ -30,27 +31,11 @@ const axios = require('axios');
const fetch = require('node-fetch');
const CryptoJS = require('crypto-js');
const NodeVault = require('node-vault');
+const xml2js = require('xml2js');
+const cheerio = require('cheerio');
+const tv4 = require('tv4');
const { executeQuickJsVmAsync } = require('../sandbox/quickjs');
-const getResultsSummary = (results) => {
- const summary = {
- total: results.length,
- passed: 0,
- failed: 0,
- skipped: 0,
- };
-
- results.forEach((r) => {
- const passed = r.status === "pass";
- if (passed) summary.passed += 1;
- else if (r.status === "fail") summary.failed += 1;
- else summary.skipped += 1;
- });
-
- return summary;
-}
-
-
class TestRuntime {
constructor(props) {
this.runtime = props?.runtime || 'vm2';
@@ -66,14 +51,15 @@ class TestRuntime {
onConsoleLog,
processEnvVars,
scriptingConfig,
- runRequestByItemPathname
+ runRequestByItemPathname,
+ collectionName
) {
const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
const collectionVariables = request?.collectionVariables || {};
const folderVariables = request?.folderVariables || {};
const requestVariables = request?.requestVariables || {};
const assertionResults = request?.assertionResults || [];
- const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables);
+ const bru = new Bru(envVariables, runtimeVariables, processEnvVars, collectionPath, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, {}, collectionName);
const req = new BrunoRequest(request);
const res = new BrunoResponse(response);
const allowScriptFilesystemAccess = get(scriptingConfig, 'filesystemAccess.allow', false);
@@ -95,9 +81,8 @@ class TestRuntime {
}
}
- const __brunoTestResults = new TestResults();
-
- const test = Test(__brunoTestResults, chai);
+ // extend bru with result getter methods
+ const { __brunoTestResults, test } = createBruTestResultMethods(bru, assertionResults, chai);
if (!testsFile || !testsFile.length) {
return {
@@ -110,36 +95,6 @@ class TestRuntime {
};
}
- bru.getTestResults = async () => {
- let results = await __brunoTestResults.getResults();
- const summary = getResultsSummary(results);
- return {
- summary,
- results: results?.map?.(r => ({
- status: r?.status,
- description: r?.description,
- expected: r?.expected,
- actual: r?.actual,
- error: r?.error
- }))
- };
- }
- bru.getAssertionResults = async () => {
- let results = assertionResults;
- const summary = getResultsSummary(results);
- return {
- summary,
- results: results?.map?.(r => ({
- status: r?.status,
- lhsExpr: r?.lhsExpr,
- rhsExpr: r?.rhsExpr,
- operator: r?.operator,
- rhsOperand: r?.rhsOperand,
- error: r?.error
- }))
- };
- }
-
const context = {
test,
bru,
@@ -169,60 +124,77 @@ class TestRuntime {
context.bru.runRequest = runRequestByItemPathname;
}
- if (this.runtime === 'quickjs') {
- await executeQuickJsVmAsync({
- script: testsFile,
- context: context
- });
- } else {
- // default runtime is vm2
- const vm = new NodeVM({
- sandbox: context,
- require: {
- context: 'sandbox',
- external: true,
- root: [collectionPath, ...additionalContextRootsAbsolute],
- mock: {
- // node libs
- path,
- stream,
- util,
- url,
- http,
- https,
- punycode,
- zlib,
- // 3rd party libs
- ajv,
- 'ajv-formats': addFormats,
- btoa,
- atob,
- lodash,
- moment,
- uuid,
- nanoid,
- axios,
- chai,
- 'node-fetch': fetch,
- 'crypto-js': CryptoJS,
- ...whitelistedModules,
- fs: allowScriptFilesystemAccess ? fs : undefined,
- 'node-vault': NodeVault
+ let scriptError = null;
+
+ try {
+ if (this.runtime === 'quickjs') {
+ await executeQuickJsVmAsync({
+ script: testsFile,
+ context: context
+ });
+ } else {
+ // default runtime is vm2
+ const vm = new NodeVM({
+ sandbox: context,
+ require: {
+ context: 'sandbox',
+ external: true,
+ root: [collectionPath, ...additionalContextRootsAbsolute],
+ mock: {
+ // node libs
+ path,
+ stream,
+ util,
+ url,
+ http,
+ https,
+ punycode,
+ zlib,
+ // 3rd party libs
+ ajv,
+ 'ajv-formats': addFormats,
+ btoa,
+ atob,
+ lodash,
+ moment,
+ uuid,
+ nanoid,
+ axios,
+ chai,
+ 'node-fetch': fetch,
+ 'crypto-js': CryptoJS,
+ 'xml2js': xml2js,
+ cheerio,
+ tv4,
+ ...whitelistedModules,
+ fs: allowScriptFilesystemAccess ? fs : undefined,
+ 'node-vault': NodeVault
+ }
}
- }
- });
- const asyncVM = vm.run(`module.exports = async () => { ${testsFile}}`, path.join(collectionPath, 'vm.js'));
- await asyncVM();
+ });
+ const asyncVM = vm.run(`module.exports = async () => { ${testsFile}}`, path.join(collectionPath, 'vm.js'));
+ await asyncVM();
+ }
+ } catch (error) {
+ scriptError = error;
}
- return {
+ const result = {
request,
envVariables: cleanJson(envVariables),
runtimeVariables: cleanJson(runtimeVariables),
globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+ persistentEnvVariables: cleanJson(bru.persistentEnvVariables),
results: cleanJson(__brunoTestResults.getResults()),
nextRequestName: bru.nextRequest
};
+
+ if (scriptError) {
+ scriptError.partialResults = result;
+ throw scriptError;
+ }
+
+ return result;
}
}
diff --git a/packages/bruno-js/src/runtime/vars-runtime.js b/packages/bruno-js/src/runtime/vars-runtime.js
index 94e45f46e..05f502c2d 100644
--- a/packages/bruno-js/src/runtime/vars-runtime.js
+++ b/packages/bruno-js/src/runtime/vars-runtime.js
@@ -2,6 +2,7 @@ const _ = require('lodash');
const Bru = require('../bru');
const BrunoRequest = require('../bruno-request');
const { evaluateJsExpression, createResponseParser } = require('../utils');
+const { cleanJson } = require('../utils');
const { executeQuickJsVm } = require('../sandbox/quickjs');
@@ -25,12 +26,16 @@ class VarsRuntime {
runPostResponseVars(vars, request, response, envVariables, runtimeVariables, collectionPath, processEnvVars) {
const requestVariables = request?.requestVariables || {};
+ const globalEnvironmentVariables = request?.globalEnvironmentVariables || {};
+ const oauth2CredentialVariables = request?.oauth2CredentialVariables || {};
+ const collectionVariables = request?.collectionVariables || {};
+ const folderVariables = request?.folderVariables || {};
const enabledVars = _.filter(vars, (v) => v.enabled);
if (!enabledVars.length) {
return;
}
- const bru = new Bru(envVariables, runtimeVariables, processEnvVars, undefined, requestVariables);
+ const bru = new Bru(envVariables, runtimeVariables, processEnvVars, undefined, collectionVariables, folderVariables, requestVariables, globalEnvironmentVariables, oauth2CredentialVariables);
const req = new BrunoRequest(request);
const res = createResponseParser(response);
@@ -68,6 +73,8 @@ class VarsRuntime {
return {
envVariables,
runtimeVariables,
+ globalEnvironmentVariables: cleanJson(globalEnvironmentVariables),
+ persistentEnvVariables: cleanJson(bru.persistentEnvVariables),
error
};
}
diff --git a/packages/bruno-js/src/sandbox/bundle-libraries.js b/packages/bruno-js/src/sandbox/bundle-libraries.js
index 30d6c7c03..1545ef5cd 100644
--- a/packages/bruno-js/src/sandbox/bundle-libraries.js
+++ b/packages/bruno-js/src/sandbox/bundle-libraries.js
@@ -12,6 +12,7 @@ const bundleLibraries = async () => {
import btoa from "btoa";
import atob from "atob";
import * as CryptoJS from "@usebruno/crypto-js";
+ import tv4 from "tv4";
globalThis.expect = expect;
globalThis.assert = assert;
globalThis.moment = moment;
@@ -19,6 +20,7 @@ const bundleLibraries = async () => {
globalThis.atob = atob;
globalThis.Buffer = Buffer;
globalThis.CryptoJS = CryptoJS;
+ globalThis.tv4 = tv4;
globalThis.requireObject = {
...(globalThis.requireObject || {}),
'chai': { expect, assert },
@@ -26,7 +28,8 @@ const bundleLibraries = async () => {
'buffer': { Buffer },
'btoa': btoa,
'atob': atob,
- 'crypto-js': CryptoJS
+ 'crypto-js': CryptoJS,
+ 'tv4': tv4
};
`;
diff --git a/packages/bruno-js/src/sandbox/quickjs/index.js b/packages/bruno-js/src/sandbox/quickjs/index.js
index 58ccd885d..d1340e92d 100644
--- a/packages/bruno-js/src/sandbox/quickjs/index.js
+++ b/packages/bruno-js/src/sandbox/quickjs/index.js
@@ -22,6 +22,12 @@ const toNumber = (value) => {
return Number.isInteger(num) ? parseInt(value, 10) : parseFloat(value);
};
+const removeQuotes = (str) => {
+ if ((str.startsWith('"') && str.endsWith('"')) || (str.startsWith("'") && str.endsWith("'"))) {
+ return str.slice(1, -1);
+ }
+ return str;
+};
const executeQuickJsVm = ({ script: externalScript, context: externalContext, scriptType = 'template-literal' }) => {
if (!externalScript?.length || typeof externalScript !== 'string') {
@@ -29,16 +35,26 @@ const executeQuickJsVm = ({ script: externalScript, context: externalContext, sc
}
externalScript = externalScript?.trim();
- if (!isNaN(Number(externalScript))) {
- return Number(externalScript);
+ if(scriptType === 'template-literal') {
+ if (!isNaN(Number(externalScript))) {
+ const number = Number(externalScript);
+
+ // Check if the number is too high. Too high number might get altered, see #1000
+ if (number > Number.MAX_SAFE_INTEGER) {
+ return externalScript;
+ }
+
+ return toNumber(externalScript);
+ }
+
+ if (externalScript === 'true') return true;
+ if (externalScript === 'false') return false;
+ if (externalScript === 'null') return null;
+ if (externalScript === 'undefined') return undefined;
+
+ externalScript = removeQuotes(externalScript);
}
- if (externalScript === 'true') return true;
- if (externalScript === 'false') return false;
- if (externalScript === 'null') return null;
- if (externalScript === 'undefined') return undefined;
-
-
const vm = QuickJSSyncContext;
try {
@@ -78,16 +94,6 @@ const executeQuickJsVmAsync = async ({ script: externalScript, context: external
}
externalScript = externalScript?.trim();
- if (!isNaN(Number(externalScript))) {
- return toNumber(externalScript);
- }
-
- if (externalScript === 'true') return true;
- if (externalScript === 'false') return false;
- if (externalScript === 'null') return null;
- if (externalScript === 'undefined') return undefined;
-
-
try {
const module = await newQuickJSWASMModule();
const vm = module.newContext();
@@ -136,10 +142,10 @@ const executeQuickJsVmAsync = async ({ script: externalScript, context: external
const { bru, req, res, test, __brunoTestResults, console: consoleFn } = externalContext;
+ consoleFn && addConsoleShimToContext(vm, consoleFn);
bru && addBruShimToContext(vm, bru);
req && addBrunoRequestShimToContext(vm, req);
res && addBrunoResponseShimToContext(vm, res);
- consoleFn && addConsoleShimToContext(vm, consoleFn);
addLocalModuleLoaderShimToContext(vm, collectionPath);
addPathShimToContext(vm);
diff --git a/packages/bruno-js/src/sandbox/quickjs/shims/bru.js b/packages/bruno-js/src/sandbox/quickjs/shims/bru.js
index fa4cbf341..4a67a80f8 100644
--- a/packages/bruno-js/src/sandbox/quickjs/shims/bru.js
+++ b/packages/bruno-js/src/sandbox/quickjs/shims/bru.js
@@ -1,4 +1,4 @@
-const { cleanJson } = require('../../../utils');
+const { cleanJson, cleanCircularJson } = require('../../../utils');
const { marshallToVm } = require('../utils');
const addBruShimToContext = (vm, bru) => {
@@ -17,12 +17,24 @@ const addBruShimToContext = (vm, bru) => {
vm.setProp(bruObject, 'getEnvName', getEnvName);
getEnvName.dispose();
+ let getCollectionName = vm.newFunction('getCollectionName', function () {
+ return marshallToVm(bru.getCollectionName(), vm);
+ });
+ vm.setProp(bruObject, 'getCollectionName', getCollectionName);
+ getCollectionName.dispose();
+
let getProcessEnv = vm.newFunction('getProcessEnv', function (key) {
return marshallToVm(bru.getProcessEnv(vm.dump(key)), vm);
});
vm.setProp(bruObject, 'getProcessEnv', getProcessEnv);
getProcessEnv.dispose();
+ let interpolate = vm.newFunction('interpolate', function (str) {
+ return marshallToVm(bru.interpolate(vm.dump(str)), vm);
+ });
+ vm.setProp(bruObject, 'interpolate', interpolate);
+ interpolate.dispose();
+
let hasEnvVar = vm.newFunction('hasEnvVar', function (key) {
return marshallToVm(bru.hasEnvVar(vm.dump(key)), vm);
});
@@ -35,8 +47,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();
@@ -53,6 +65,12 @@ const addBruShimToContext = (vm, bru) => {
vm.setProp(bruObject, 'getGlobalEnvVar', getGlobalEnvVar);
getGlobalEnvVar.dispose();
+ let getOauth2CredentialVar = vm.newFunction('getOauth2CredentialVar', function (key) {
+ return marshallToVm(bru.getOauth2CredentialVar(vm.dump(key)), vm);
+ });
+ vm.setProp(bruObject, 'getOauth2CredentialVar', getOauth2CredentialVar);
+ getOauth2CredentialVar.dispose();
+
let setGlobalEnvVar = vm.newFunction('setGlobalEnvVar', function (key, value) {
bru.setGlobalEnvVar(vm.dump(key), vm.dump(value));
});
@@ -145,7 +163,8 @@ const addBruShimToContext = (vm, bru) => {
let getTestResults = vm.newFunction('getTestResults', () => {
const promise = vm.newPromise();
- bru.getTestResults()
+ bru
+ .getTestResults()
.then((results) => {
promise.resolve(marshallToVm(cleanJson(results), vm));
})
@@ -166,7 +185,8 @@ const addBruShimToContext = (vm, bru) => {
let getAssertionResults = vm.newFunction('getAssertionResults', () => {
const promise = vm.newPromise();
- bru.getAssertionResults()
+ bru
+ .getAssertionResults()
.then((results) => {
promise.resolve(marshallToVm(cleanJson(results), vm));
})
@@ -187,10 +207,10 @@ const addBruShimToContext = (vm, bru) => {
let runRequestHandle = vm.newFunction('runRequest', (args) => {
const promise = vm.newPromise();
- bru.runRequest(vm.dump(args))
+ bru
+ .runRequest(vm.dump(args))
.then((response) => {
- const { status, headers, data, dataBuffer, size } = response || {};
- promise.resolve(marshallToVm(cleanJson({ status, headers, data, dataBuffer, size }), vm));
+ promise.resolve(marshallToVm(cleanCircularJson(response), vm));
})
.catch((err) => {
promise.resolve(
@@ -207,6 +227,26 @@ const addBruShimToContext = (vm, bru) => {
});
runRequestHandle.consume((handle) => vm.setProp(bruObject, 'runRequest', handle));
+ let sendRequestHandle = vm.newFunction('_sendRequest', (args) => {
+ const promise = vm.newPromise();
+ bru
+ .sendRequest(vm.dump(args))
+ .then((response) => {
+ promise.resolve(marshallToVm(cleanCircularJson(response), vm));
+ })
+ .catch((err) => {
+ promise.reject(
+ marshallToVm(
+ cleanJson(err),
+ vm
+ )
+ );
+ });
+ promise.settled.then(vm.runtime.executePendingJobs);
+ return promise.handle;
+ });
+ sendRequestHandle.consume((handle) => vm.setProp(bruObject, '_sendRequest', handle));
+
const sleep = vm.newFunction('sleep', (timer) => {
const t = vm.getString(timer);
const promise = vm.newPromise();
@@ -218,9 +258,196 @@ const addBruShimToContext = (vm, bru) => {
});
sleep.consume((handle) => vm.setProp(bruObject, 'sleep', handle));
+ let bruCookiesObject = vm.newObject();
+
+ const _jarFn = vm.newFunction('_jar', () => {
+ const nativeJar = bru.cookies.jar();
+ const jarObj = vm.newObject();
+
+ const _getCookieFn = vm.newFunction('_getCookie', (url, cookieName) => {
+ const promise = vm.newPromise();
+ nativeJar.getCookie(vm.dump(url), vm.dump(cookieName), (err, cookie) => {
+ if (err) {
+ promise.reject(marshallToVm(cleanJson(err), vm));
+ } else {
+ promise.resolve(marshallToVm(cleanCircularJson(cookie), vm));
+ }
+ });
+ promise.settled.then(vm.runtime.executePendingJobs);
+ return promise.handle;
+ });
+ _getCookieFn.consume((handle) => vm.setProp(jarObj, '_getCookie', handle));
+
+ const _getCookiesFn = vm.newFunction('_getCookies', (url) => {
+ const promise = vm.newPromise();
+ nativeJar.getCookies(vm.dump(url), (err, cookies) => {
+ if (err) {
+ promise.reject(marshallToVm(cleanJson(err), vm));
+ } else {
+ promise.resolve(marshallToVm(cleanCircularJson(cookies), vm));
+ }
+ });
+ promise.settled.then(vm.runtime.executePendingJobs);
+ return promise.handle;
+ });
+ _getCookiesFn.consume((handle) => vm.setProp(jarObj, '_getCookies', handle));
+
+ const _setCookieFn = vm.newFunction('_setCookie', (url, nameOrCookieObj, value) => {
+ const promise = vm.newPromise();
+ const dumpedUrl = vm.dump(url);
+ const dumpedNameOrObj = vm.dump(nameOrCookieObj);
+
+ // Check if the second argument is an object (cookie object case)
+ if (typeof dumpedNameOrObj === 'object' && dumpedNameOrObj !== null) {
+ // Cookie object case: setCookie(url, cookieObject, callback)
+ nativeJar.setCookie(dumpedUrl, dumpedNameOrObj, (err) => {
+ if (err) {
+ promise.reject(marshallToVm(cleanJson(err), vm));
+ } else {
+ promise.resolve(vm.undefined);
+ }
+ });
+ } else {
+ // Name/value case: setCookie(url, name, value, callback)
+ const dumpedValue = value ? vm.dump(value) : '';
+ nativeJar.setCookie(dumpedUrl, dumpedNameOrObj, dumpedValue, (err) => {
+ if (err) {
+ promise.reject(marshallToVm(cleanJson(err), vm));
+ } else {
+ promise.resolve(vm.undefined);
+ }
+ });
+ }
+
+ promise.settled.then(vm.runtime.executePendingJobs);
+ return promise.handle;
+ });
+ _setCookieFn.consume((handle) => vm.setProp(jarObj, '_setCookie', handle));
+
+ const _setCookiesFn = vm.newFunction('_setCookies', (url, cookiesArray) => {
+ const promise = vm.newPromise();
+
+ nativeJar.setCookies(vm.dump(url), vm.dump(cookiesArray), (err) => {
+ if (err) {
+ promise.reject(marshallToVm(cleanJson(err), vm));
+ } else {
+ promise.resolve(vm.undefined);
+ }
+ });
+ promise.settled.then(vm.runtime.executePendingJobs);
+ return promise.handle;
+ });
+ _setCookiesFn.consume((handle) => vm.setProp(jarObj, '_setCookies', handle));
+
+ const _clearFn = vm.newFunction('_clear', () => {
+ const promise = vm.newPromise();
+ nativeJar.clear((err) => {
+ if (err) {
+ promise.reject(marshallToVm(cleanJson(err), vm));
+ } else {
+ promise.resolve(vm.undefined);
+ }
+ });
+ promise.settled.then(vm.runtime.executePendingJobs);
+ return promise.handle;
+ });
+ _clearFn.consume((handle) => vm.setProp(jarObj, '_clear', handle));
+
+ const _deleteCookiesFn = vm.newFunction('_deleteCookies', (url) => {
+ const promise = vm.newPromise();
+ nativeJar.deleteCookies(vm.dump(url), (err) => {
+ if (err) {
+ promise.reject(marshallToVm(cleanJson(err), vm));
+ } else {
+ promise.resolve(vm.undefined);
+ }
+ });
+ promise.settled.then(vm.runtime.executePendingJobs);
+ return promise.handle;
+ });
+ _deleteCookiesFn.consume((handle) => vm.setProp(jarObj, '_deleteCookies', handle));
+
+ const _deleteCookieFn = vm.newFunction('_deleteCookie', (url, cookieName) => {
+ const promise = vm.newPromise();
+ nativeJar.deleteCookie(vm.dump(url), vm.dump(cookieName), (err) => {
+ if (err) {
+ promise.reject(marshallToVm(cleanJson(err), vm));
+ } else {
+ promise.resolve(vm.undefined);
+ }
+ });
+ promise.settled.then(vm.runtime.executePendingJobs);
+ return promise.handle;
+ });
+ _deleteCookieFn.consume((handle) => vm.setProp(jarObj, '_deleteCookie', handle));
+
+ return jarObj;
+ });
+ _jarFn.consume((handle) => vm.setProp(bruCookiesObject, '_jar', handle));
+
+ vm.setProp(bruObject, 'cookies', bruCookiesObject);
+ bruCookiesObject.dispose();
+
vm.setProp(bruObject, 'runner', bruRunnerObject);
vm.setProp(vm.global, 'bru', bruObject);
bruObject.dispose();
+
+ vm.evalCode(`
+ globalThis.bru.sendRequest = async (requestConfig, callback) => {
+ if (!callback) return await globalThis.bru._sendRequest(requestConfig);
+ try {
+ const response = await globalThis.bru._sendRequest(requestConfig);
+ try {
+ await callback(null, response);
+ }
+ catch(error) {
+ return Promise.reject(error);
+ }
+ }
+ catch(error) {
+ try {
+ await callback(JSON.parse(JSON.stringify(error)), null);
+ }
+ catch(err) {
+ return Promise.reject(err);
+ }
+ }
+ };
+
+ globalThis.bru.cookies.jar = () => {
+ const _jar = globalThis.bru.cookies._jar();
+
+ const callWithCallback = async (promiseFn, callback) => {
+ if (!callback) return await promiseFn();
+ try {
+ const result = await promiseFn();
+ try { await callback(null, result); } catch(cbErr) { return Promise.reject(cbErr); }
+ } catch(err) {
+ try { await callback(err, null); } catch(cbErr) { return Promise.reject(cbErr); }
+ }
+ };
+
+ return {
+ getCookie: (url, name, cb) => callWithCallback(() => _jar._getCookie(url, name), cb),
+ getCookies: (url, cb) => callWithCallback(() => _jar._getCookies(url), cb),
+ setCookie: (url, nameOrCookieObj, valueOrCallback, maybeCallback) => {
+ if (typeof nameOrCookieObj === 'object' && nameOrCookieObj !== null) {
+ const callback = typeof valueOrCallback === 'function' ? valueOrCallback : undefined;
+ return callWithCallback(() => _jar._setCookie(url, nameOrCookieObj), callback);
+ } else {
+ const value = typeof valueOrCallback === 'string' ? valueOrCallback : '';
+ const callback = typeof maybeCallback === 'function' ? maybeCallback :
+ (typeof valueOrCallback === 'function' ? valueOrCallback : undefined);
+ return callWithCallback(() => _jar._setCookie(url, nameOrCookieObj, value), callback);
+ }
+ },
+ setCookies: (url, cookiesArray, cb) => callWithCallback(() => _jar._setCookies(url, cookiesArray), cb),
+ clear: (cb) => callWithCallback(() => _jar._clear(), cb),
+ deleteCookies: (url, cb) => callWithCallback(() => _jar._deleteCookies(url), cb),
+ deleteCookie: (url, name, cb) => callWithCallback(() => _jar._deleteCookie(url, name), cb)
+ };
+ };
+ `);
};
module.exports = addBruShimToContext;
diff --git a/packages/bruno-js/src/sandbox/quickjs/shims/bruno-request.js b/packages/bruno-js/src/sandbox/quickjs/shims/bruno-request.js
index e3f364fe7..4a51ae580 100644
--- a/packages/bruno-js/src/sandbox/quickjs/shims/bruno-request.js
+++ b/packages/bruno-js/src/sandbox/quickjs/shims/bruno-request.js
@@ -8,18 +8,21 @@ const addBrunoRequestShimToContext = (vm, req) => {
const headers = marshallToVm(req.getHeaders(), vm);
const body = marshallToVm(req.getBody(), vm);
const timeout = marshallToVm(req.getTimeout(), vm);
+ const name = marshallToVm(req.getName(), vm);
vm.setProp(reqObject, 'url', url);
vm.setProp(reqObject, 'method', method);
vm.setProp(reqObject, 'headers', headers);
vm.setProp(reqObject, 'body', body);
vm.setProp(reqObject, 'timeout', timeout);
+ vm.setProp(reqObject, 'name', name);
url.dispose();
method.dispose();
headers.dispose();
body.dispose();
timeout.dispose();
+ name.dispose();
let getUrl = vm.newFunction('getUrl', function () {
return marshallToVm(req.getUrl(), vm);
@@ -45,6 +48,12 @@ const addBrunoRequestShimToContext = (vm, req) => {
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 setMethod = vm.newFunction('setMethod', function (method) {
req.setMethod(vm.dump(method));
});
diff --git a/packages/bruno-js/src/sandbox/quickjs/shims/bruno-response.js b/packages/bruno-js/src/sandbox/quickjs/shims/bruno-response.js
index fb2ae6888..df0fabe60 100644
--- a/packages/bruno-js/src/sandbox/quickjs/shims/bruno-response.js
+++ b/packages/bruno-js/src/sandbox/quickjs/shims/bruno-response.js
@@ -6,19 +6,31 @@ const addBrunoResponseShimToContext = (vm, res) => {
});
const status = marshallToVm(res?.status, vm);
+ const statusText = marshallToVm(res?.statusText, vm);
const headers = marshallToVm(res?.headers, vm);
const body = marshallToVm(res?.body, vm);
const responseTime = marshallToVm(res?.responseTime, vm);
+ const url = marshallToVm(res?.url, vm);
vm.setProp(resFn, 'status', status);
+ vm.setProp(resFn, 'statusText', statusText);
vm.setProp(resFn, 'headers', headers);
vm.setProp(resFn, 'body', body);
vm.setProp(resFn, 'responseTime', responseTime);
+ vm.setProp(resFn, 'url', url);
status.dispose();
headers.dispose();
body.dispose();
responseTime.dispose();
+ url.dispose();
+ statusText.dispose();
+
+ let getStatusText = vm.newFunction('getStatusText', function () {
+ return marshallToVm(res.getStatusText(), vm);
+ });
+ vm.setProp(resFn, 'getStatusText', getStatusText);
+ getStatusText.dispose();
let getStatus = vm.newFunction('getStatus', function () {
return marshallToVm(res.getStatus(), vm);
@@ -50,12 +62,24 @@ const addBrunoResponseShimToContext = (vm, res) => {
vm.setProp(resFn, 'getResponseTime', getResponseTime);
getResponseTime.dispose();
+ let getUrl = vm.newFunction('getUrl', function () {
+ return marshallToVm(res.getUrl(), vm);
+ });
+ vm.setProp(resFn, 'getUrl', getUrl);
+ getUrl.dispose();
+
let setBody = vm.newFunction('setBody', function (data) {
res.setBody(vm.dump(data));
});
vm.setProp(resFn, 'setBody', setBody);
setBody.dispose();
+ let getSize = vm.newFunction('getSize', function () {
+ return marshallToVm(res.getSize(), vm);
+ });
+ vm.setProp(resFn, 'getSize', getSize);
+ getSize.dispose();
+
vm.setProp(vm.global, 'res', resFn);
resFn.dispose();
};
diff --git a/packages/bruno-js/src/utils.js b/packages/bruno-js/src/utils.js
index 6b5ecacb5..ca26d6f4d 100644
--- a/packages/bruno-js/src/utils.js
+++ b/packages/bruno-js/src/utils.js
@@ -85,6 +85,14 @@ const evaluateJsTemplateLiteral = (templateLiteral, context) => {
return undefined;
}
+ if (templateLiteral.startsWith('"') && templateLiteral.endsWith('"')) {
+ return templateLiteral.slice(1, -1);
+ }
+
+ if (templateLiteral.startsWith("'") && templateLiteral.endsWith("'")) {
+ return templateLiteral.slice(1, -1);
+ }
+
if (!isNaN(templateLiteral)) {
const number = Number(templateLiteral);
// Check if the number is too high. Too high number might get altered, see #1000
@@ -109,6 +117,7 @@ const createResponseParser = (response = {}) => {
res.headers = response.headers;
res.body = response.data;
res.responseTime = response.responseTime;
+ res.url = response.request ? response.request.protocol + '//' + response.request.host + response.request.path : null;
res.jq = (expr) => {
const output = jsonQuery(expr, { data: response.data });
@@ -136,10 +145,37 @@ const cleanJson = (data) => {
}
};
+const cleanCircularJson = (data) => {
+ try {
+ // Handle circular references by keeping track of seen objects
+ const seen = new WeakSet();
+
+ const replacer = (key, value) => {
+ // Skip non-objects and null
+ if (typeof value !== 'object' || value === null) {
+ return value;
+ }
+
+ // Detect circular reference
+ if (seen.has(value)) {
+ return '[Circular Reference]';
+ }
+
+ seen.add(value);
+ return value;
+ };
+
+ return JSON.parse(JSON.stringify(data, replacer));
+ } catch (e) {
+ return data;
+ }
+};
+
module.exports = {
evaluateJsExpression,
evaluateJsTemplateLiteral,
createResponseParser,
internalExpressionCache,
- cleanJson
+ cleanJson,
+ cleanCircularJson
};
diff --git a/packages/bruno-js/src/utils/results.js b/packages/bruno-js/src/utils/results.js
new file mode 100644
index 000000000..0ed38638a
--- /dev/null
+++ b/packages/bruno-js/src/utils/results.js
@@ -0,0 +1,80 @@
+const TestResults = require('../test-results');
+const Test = require('../test');
+
+// Calculate summary statistics for test results
+const getResultsSummary = (results) => {
+ const summary = {
+ total: results.length,
+ passed: 0,
+ failed: 0,
+ skipped: 0,
+ };
+
+ results.forEach((r) => {
+ const passed = r.status === 'pass';
+ if (passed) summary.passed += 1;
+ else if (r.status === 'fail') summary.failed += 1;
+ else summary.skipped += 1;
+ });
+
+ return summary;
+};
+
+const createBruTestResultMethods = (bru, assertionResults, chai) => {
+ const __brunoTestResults = new TestResults();
+ const test = Test(__brunoTestResults, chai);
+ setupBruTestMethods(bru, __brunoTestResults, assertionResults);
+
+ return { __brunoTestResults, test };
+};
+
+const setupBruTestMethods = (bru, __brunoTestResults, assertionResults) => {
+ const getTestResults = async () => {
+ let results = await __brunoTestResults.getResults();
+ const summary = getResultsSummary(results);
+ return {
+ summary,
+ results: results.map(r => ({
+ status: r.status,
+ description: r.description,
+ expected: r.expected,
+ actual: r.actual,
+ error: r.error
+ }))
+ };
+ };
+
+ const getAssertionResults = async () => {
+ let results = assertionResults;
+ const summary = getResultsSummary(results);
+ return {
+ summary,
+ results: results.map(r => ({
+ status: r.status,
+ lhsExpr: r.lhsExpr,
+ rhsExpr: r.rhsExpr,
+ operator: r.operator,
+ rhsOperand: r.rhsOperand,
+ error: r.error
+ }))
+ };
+ };
+
+ // Set methods on bru object if provided
+ if (bru) {
+ bru.getTestResults = getTestResults;
+ bru.getAssertionResults = getAssertionResults;
+ }
+
+ // Also return the methods for direct use
+ return {
+ getTestResults,
+ getAssertionResults
+ };
+};
+
+module.exports = {
+ getResultsSummary,
+ createBruTestResultMethods,
+ setupBruTestMethods
+};
\ No newline at end of file
diff --git a/packages/bruno-js/tests/runtime.spec.js b/packages/bruno-js/tests/runtime.spec.js
index 766569d03..64f0d2589 100644
--- a/packages/bruno-js/tests/runtime.spec.js
+++ b/packages/bruno-js/tests/runtime.spec.js
@@ -1,6 +1,8 @@
const { describe, it, expect } = require('@jest/globals');
const TestRuntime = require('../src/runtime/test-runtime');
const ScriptRuntime = require('../src/runtime/script-runtime');
+const Bru = require('../src/bru');
+const VarsRuntime = require('../src/runtime/vars-runtime');
describe('runtime', () => {
describe('test-runtime', () => {
@@ -175,4 +177,73 @@ describe('runtime', () => {
});
});
});
+
+ describe('persistent environment variables validation', () => {
+ it('should throw error when trying to persist non-string values', async () => {
+ const script = `bru.setEnvVar('number', 42, {persist: true});`;
+ const runtime = new ScriptRuntime({ runtime: 'vm2' });
+
+ await expect(runtime.runRequestScript(script, {}, {}, {}, '.', null, process.env))
+ .rejects.toThrow('Persistent environment variables must be strings. Received number for key "number".');
+ });
+
+ it('should throw error when trying to persist boolean values', async () => {
+ const script = `bru.setEnvVar('isActive', true, {persist: true});`;
+ const runtime = new ScriptRuntime({ runtime: 'vm2' });
+
+ await expect(runtime.runRequestScript(script, {}, {}, {}, '.', null, process.env))
+ .rejects.toThrow('Persistent environment variables must be strings. Received boolean for key "isActive".');
+ });
+
+ it('should throw error when trying to persist object values', async () => {
+ const script = `bru.setEnvVar('config', {port: 3000}, {persist: true});`;
+ const runtime = new ScriptRuntime({ runtime: 'vm2' });
+
+ await expect(runtime.runRequestScript(script, {}, {}, {}, '.', null, process.env))
+ .rejects.toThrow('Persistent environment variables must be strings. Received object for key "config".');
+ });
+
+ it('should throw error when trying to persist array values', async () => {
+ const script = `bru.setEnvVar('items', ['item1', 'item2'], {persist: true});`;
+ const runtime = new ScriptRuntime({ runtime: 'vm2' });
+
+ await expect(runtime.runRequestScript(script, {}, {}, {}, '.', null, process.env))
+ .rejects.toThrow('Persistent environment variables must be strings. Received object for key "items".');
+ });
+
+ it('should allow string values when persist is true', async () => {
+ const script = `bru.setEnvVar('api_key', 'abc123', {persist: true});`;
+ const runtime = new ScriptRuntime({ runtime: 'vm2' });
+
+ const result = await runtime.runRequestScript(script, {}, {}, {}, '.', null, process.env);
+
+ expect(result.envVariables.api_key).toBe('abc123');
+ });
+
+ it('should allow non-string values when persist is false', async () => {
+ const script = `
+ bru.setEnvVar('number', 42, {persist: false});
+ bru.setEnvVar('boolean', true, {persist: false});
+ bru.setEnvVar('object', {key: 'value'}, {persist: false});
+ bru.setEnvVar('array', [1, 2, 3], {persist: false});
+ `;
+ const runtime = new ScriptRuntime({ runtime: 'vm2' });
+
+ const result = await runtime.runRequestScript(script, {}, {}, {}, '.', null, process.env);
+
+ expect(result.envVariables.number).toBe(42);
+ expect(result.envVariables.boolean).toBe(true);
+ expect(result.envVariables.object).toEqual({key: 'value'});
+ expect(result.envVariables.array).toEqual([1, 2, 3]);
+ });
+
+ it('should allow non-string values when persist is not specified', async () => {
+ const script = `bru.setEnvVar('number', 42);`;
+ const runtime = new ScriptRuntime({ runtime: 'vm2' });
+
+ const result = await runtime.runRequestScript(script, {}, {}, {}, '.', null, process.env);
+
+ expect(result.envVariables.number).toBe(42);
+ });
+ });
});
diff --git a/packages/bruno-js/tests/setEnvVar.spec.js b/packages/bruno-js/tests/setEnvVar.spec.js
new file mode 100644
index 000000000..d1929055c
--- /dev/null
+++ b/packages/bruno-js/tests/setEnvVar.spec.js
@@ -0,0 +1,74 @@
+const Bru = require('../src/bru');
+
+describe('Bru.setEnvVar', () => {
+ const makeBru = () =>
+ new Bru(
+ /* envVariables */ {},
+ /* runtimeVariables */ {},
+ /* processEnvVars */ {},
+ /* collectionPath */ '/',
+ /* historyLogger */ undefined,
+ /* setVisualizations */ undefined,
+ /* secretVariables */ {},
+ /* collectionVariables */ {},
+ /* folderVariables */ {},
+ /* requestVariables */ {},
+ /* globalEnvironmentVariables */ {},
+ /* oauth2CredentialVariables */ {},
+ /* iterationDetails */ {},
+ /* collectionName */ 'Test'
+ );
+
+ test('updates envVariables and does not mark persistent when persist=false', () => {
+ const bru = makeBru();
+ bru.setEnvVar('non_persist', 'value', { persist: false });
+ expect(bru.envVariables.non_persist).toBe('value');
+ expect(bru.persistentEnvVariables.non_persist).toBeUndefined();
+ });
+
+ test('updates envVariables and tracks persistent when persist=true (string only)', () => {
+ const bru = makeBru();
+ bru.setEnvVar('persist_me', 'value', { persist: true });
+ expect(bru.envVariables.persist_me).toBe('value');
+ expect(bru.persistentEnvVariables.persist_me).toBe('value');
+ });
+
+ test('updates envVariables when options are omitted (defaults to non-persistent)', () => {
+ const bru = makeBru();
+ bru.setEnvVar('no_options', 'value');
+ expect(bru.envVariables.no_options).toBe('value');
+ expect(bru.persistentEnvVariables.no_options).toBeUndefined();
+ });
+
+ test('throws when persist=true but value is not a string', () => {
+ const bru = makeBru();
+ expect(() => bru.setEnvVar('persist_me', 123, { persist: true })).toThrow(
+ /Persistent environment variables must be strings/
+ );
+ });
+
+ test('changing existing key to non-persistent removes prior persisted entry', () => {
+ const bru = makeBru();
+ bru.setEnvVar('same_key', 'old', { persist: true });
+ expect(bru.persistentEnvVariables.same_key).toBe('old');
+
+ bru.setEnvVar('same_key', 'new');
+ expect(bru.envVariables.same_key).toBe('new');
+ expect(bru.persistentEnvVariables.same_key).toBeUndefined();
+ });
+
+ test('changing existing key to persistent updates persisted value', () => {
+ const bru = makeBru();
+ bru.setEnvVar('same_key', 'old');
+ expect(bru.persistentEnvVariables.same_key).toBeUndefined();
+
+ bru.setEnvVar('same_key', 'new', { persist: true });
+ expect(bru.envVariables.same_key).toBe('new');
+ expect(bru.persistentEnvVariables.same_key).toBe('new');
+ });
+
+ test('validates key name - invalid characters are rejected', () => {
+ const bru = makeBru();
+ expect(() => bru.setEnvVar('invalid key', 'v')).toThrow(/contains invalid characters/);
+ });
+});
diff --git a/packages/bruno-lang/v2/src/bruToJson.js b/packages/bruno-lang/v2/src/bruToJson.js
index 7633bbf2e..5c03e8ef4 100644
--- a/packages/bruno-lang/v2/src/bruToJson.js
+++ b/packages/bruno-lang/v2/src/bruToJson.js
@@ -1,10 +1,10 @@
const ohm = require('ohm-js');
const _ = require('lodash');
-const { outdentString } = require('../../v1/src/utils');
+const { safeParseJson, outdentString } = require('./utils');
/**
* A Bru file is made up of blocks.
- * There are two types of blocks
+ * There are three types of blocks
*
* 1. Dictionary Blocks - These are blocks that have key value pairs
* ex:
@@ -19,15 +19,28 @@ const { outdentString } = require('../../v1/src/utils');
* "username": "John Nash",
* "password": "governingdynamics
* }
+
+ * 3. List Blocks - These are blocks that have a list of items
+ * ex:
+ * tags [
+ * regression
+ * smoke-test
+ * ]
*
*/
const grammar = ohm.grammar(`Bru {
- BruFile = (meta | http | query | params | headers | auths | bodies | varsandassert | script | tests | docs)*
- auths = authawsv4 | authbasic | authbearer | authdigest | authNTLM | authOAuth2 | authwsse | authapikey
- bodies = bodyjson | bodytext | bodyxml | bodysparql | bodygraphql | bodygraphqlvars | bodyforms | body
- bodyforms = bodyformurlencoded | bodymultipart
+ BruFile = (meta | http | grpc | query | params | headers | metadata | auths | bodies | varsandassert | script | tests | settings | docs)*
+ auths = authawsv4 | authbasic | authbearer | authdigest | authNTLM | authOAuth2 | authwsse | authapikey | authOauth2Configs
+ bodies = bodyjson | bodytext | bodyxml | bodysparql | bodygraphql | bodygraphqlvars | bodyforms | body | bodygrpc
+ bodyforms = bodyformurlencoded | bodymultipart | bodyfile
params = paramspath | paramsquery
-
+
+ // Oauth2 additional parameters
+ authOauth2Configs = oauth2AuthReqConfig | oauth2AccessTokenReqConfig | oauth2RefreshTokenReqConfig
+ oauth2AuthReqConfig = oauth2AuthReqHeaders | oauth2AuthReqQueryParams
+ oauth2AccessTokenReqConfig = oauth2AccessTokenReqHeaders | oauth2AccessTokenReqQueryParams | oauth2AccessTokenReqBody
+ oauth2RefreshTokenReqConfig = oauth2RefreshTokenReqHeaders | oauth2RefreshTokenReqQueryParams | oauth2RefreshTokenReqBody
+
nl = "\\r"? "\\n"
st = " " | "\\t"
stnl = st | nl
@@ -51,7 +64,7 @@ const grammar = ohm.grammar(`Bru {
quoted_key_char = ~(quote_char | esc_quote_char | nl) any
quoted_key = disable_char? quote_char (esc_quote_char | quoted_key_char)* quote_char
key = keychar*
- value = multilinetextblock | valuechar*
+ value = list | multilinetextblock | valuechar*
// Dictionary for Assert Block
assertdictionary = st* "{" assertpairlist? tagend
@@ -65,9 +78,17 @@ const grammar = ohm.grammar(`Bru {
textline = textchar*
textchar = ~nl any
+ // List
+ list = st* "[" nl+ listitems? st* nl+ st* "]"
+ listitems = listitem (nl+ listitem)*
+ listitem = st+ (alnum | "_" | "-")+ st*
+
meta = "meta" dictionary
+ settings = "settings" dictionary
http = get | post | put | delete | patch | options | head | connect | trace
+ grpc = "grpc" dictionary
+
get = "get" dictionary
post = "post" dictionary
put = "put" dictionary
@@ -78,7 +99,9 @@ const grammar = ohm.grammar(`Bru {
connect = "connect" dictionary
trace = "trace" dictionary
+
headers = "headers" dictionary
+ metadata = "metadata" dictionary
query = "query" dictionary
paramspath = "params:path" dictionary
@@ -98,6 +121,15 @@ const grammar = ohm.grammar(`Bru {
authwsse = "auth:wsse" dictionary
authapikey = "auth:apikey" dictionary
+ oauth2AuthReqHeaders = "auth:oauth2:additional_params:auth_req:headers" dictionary
+ oauth2AuthReqQueryParams = "auth:oauth2:additional_params:auth_req:queryparams" dictionary
+ oauth2AccessTokenReqHeaders = "auth:oauth2:additional_params:access_token_req:headers" dictionary
+ oauth2AccessTokenReqQueryParams = "auth:oauth2:additional_params:access_token_req:queryparams" dictionary
+ oauth2AccessTokenReqBody = "auth:oauth2:additional_params:access_token_req:body" dictionary
+ oauth2RefreshTokenReqHeaders = "auth:oauth2:additional_params:refresh_token_req:headers" dictionary
+ oauth2RefreshTokenReqQueryParams = "auth:oauth2:additional_params:refresh_token_req:queryparams" dictionary
+ oauth2RefreshTokenReqBody = "auth:oauth2:additional_params:refresh_token_req:body" dictionary
+
body = "body" st* "{" nl* textblock tagend
bodyjson = "body:json" st* "{" nl* textblock tagend
bodytext = "body:text" st* "{" nl* textblock tagend
@@ -105,10 +137,12 @@ const grammar = ohm.grammar(`Bru {
bodysparql = "body:sparql" st* "{" nl* textblock tagend
bodygraphql = "body:graphql" st* "{" nl* textblock tagend
bodygraphqlvars = "body:graphql:vars" st* "{" nl* textblock tagend
+ bodygrpc = "body:grpc" dictionary
bodyformurlencoded = "body:form-urlencoded" dictionary
bodymultipart = "body:multipart-form" dictionary
-
+ bodyfile = "body:file" dictionary
+
script = scriptreq | scriptres
scriptreq = "script:pre-request" st* "{" nl* textblock tagend
scriptres = "script:post-response" st* "{" nl* textblock tagend
@@ -179,6 +213,19 @@ const multipartExtractContentType = (pair) => {
}
};
+const fileExtractContentType = (pair) => {
+ if (_.isString(pair.value)) {
+ const match = pair.value.match(/^(.*?)\s*@contentType\((.*?)\)\s*$/);
+ if (match && match.length > 2) {
+ pair.value = match[1].trim();
+ pair.contentType = match[2].trim();
+ } else {
+ pair.contentType = '';
+ }
+ }
+};
+
+
const mapPairListToKeyValPairsMultipart = (pairList = [], parseEnabled = true) => {
const pairs = mapPairListToKeyValPairs(pairList, parseEnabled);
@@ -196,6 +243,27 @@ const mapPairListToKeyValPairsMultipart = (pairList = [], parseEnabled = true) =
});
};
+const mapPairListToKeyValPairsFile = (pairList = [], parseEnabled = true) => {
+ const pairs = mapPairListToKeyValPairs(pairList, parseEnabled);
+ return pairs.map((pair) => {
+ fileExtractContentType(pair);
+
+ if (pair.value.startsWith('@file(') && pair.value.endsWith(')')) {
+ let filePath = pair.value.replace(/^@file\(/, '').replace(/\)$/, '');
+ pair.filePath = filePath;
+ pair.selected = pair.enabled
+
+ // Remove pair.value as it only contains the file path reference
+ delete pair.value;
+ // Remove pair.name as it is auto-generated (e.g., file1, file2, file3, etc.)
+ delete pair.name;
+ delete pair.enabled;
+ }
+
+ return pair;
+ });
+};
+
const concatArrays = (objValue, srcValue) => {
if (_.isArray(objValue) && _.isArray(srcValue)) {
return objValue.concat(srcValue);
@@ -232,6 +300,10 @@ const sem = grammar.createSemantics().addAttribute('ast', {
},
pair(_1, key, _2, _3, _4, value, _5) {
let res = {};
+ if (Array.isArray(value.ast)) {
+ res[key.ast] = value.ast;
+ return res;
+ }
res[key.ast] = value.ast ? value.ast.trim() : '';
return res;
},
@@ -247,6 +319,9 @@ const sem = grammar.createSemantics().addAttribute('ast', {
return chars.sourceString ? chars.sourceString.trim() : '';
},
value(chars) {
+ if (chars.ctorName === 'list') {
+ return chars.ast;
+ }
try {
let isMultiline = chars.sourceString?.startsWith(`'''`) && chars.sourceString?.endsWith(`'''`);
if (isMultiline) {
@@ -276,6 +351,15 @@ const sem = grammar.createSemantics().addAttribute('ast', {
assertkey(chars) {
return chars.sourceString ? chars.sourceString.trim() : '';
},
+ list(_1, _2, _3, listitems, _4, _5, _6, _7) {
+ return listitems.ast.flat()
+ },
+ listitems(listitem, _1, rest) {
+ return [listitem.ast, ...rest.ast]
+ },
+ listitem(_1, textchar, _2) {
+ return textchar.sourceString;
+ },
textblock(line, _1, rest) {
return [line.ast, ...rest.ast].join('\n');
},
@@ -297,6 +381,13 @@ const sem = grammar.createSemantics().addAttribute('ast', {
_terminal(){
return this.sourceString;
},
+ multilinetextblockdelimiter(_) {
+ return '';
+ },
+ multilinetextblock(_1, content, _2) {
+ // Join all the content between the triple quotes and trim it
+ return content.sourceString.trim();
+ },
_iter(...elements) {
return elements.map((e) => e.ast);
},
@@ -315,6 +406,20 @@ const sem = grammar.createSemantics().addAttribute('ast', {
meta
};
},
+ settings(_1, dictionary) {
+ let settings = mapPairListToKeyValPair(dictionary.ast);
+
+ return {
+ settings: {
+ encodeUrl: typeof settings.encodeUrl === 'boolean' ? settings.encodeUrl : settings.encodeUrl === 'true'
+ }
+ };
+ },
+ grpc(_1, dictionary) {
+ return {
+ grpc: mapPairListToKeyValPair(dictionary.ast)
+ };
+ },
get(_1, dictionary) {
return {
http: {
@@ -399,6 +504,11 @@ const sem = grammar.createSemantics().addAttribute('ast', {
headers: mapPairListToKeyValPairs(dictionary.ast)
};
},
+ metadata(_1, dictionary) {
+ return {
+ metadata: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
authawsv4(_1, dictionary) {
const auth = mapPairListToKeyValPairs(dictionary.ast, false);
const accessKeyIdKey = _.find(auth, { name: 'accessKeyId' });
@@ -496,11 +606,19 @@ const sem = grammar.createSemantics().addAttribute('ast', {
const callbackUrlKey = _.find(auth, { name: 'callback_url' });
const authorizationUrlKey = _.find(auth, { name: 'authorization_url' });
const accessTokenUrlKey = _.find(auth, { name: 'access_token_url' });
+ const refreshTokenUrlKey = _.find(auth, { name: 'refresh_token_url' });
const clientIdKey = _.find(auth, { name: 'client_id' });
const clientSecretKey = _.find(auth, { name: 'client_secret' });
const scopeKey = _.find(auth, { name: 'scope' });
const stateKey = _.find(auth, { name: 'state' });
const pkceKey = _.find(auth, { name: 'pkce' });
+ const credentialsPlacementKey = _.find(auth, { name: 'credentials_placement' });
+ const credentialsIdKey = _.find(auth, { name: 'credentials_id' });
+ const tokenPlacementKey = _.find(auth, { name: 'token_placement' });
+ const tokenHeaderPrefixKey = _.find(auth, { name: 'token_header_prefix' });
+ const tokenQueryKeyKey = _.find(auth, { name: 'token_query_key' });
+ const autoFetchTokenKey = _.find(auth, { name: 'auto_fetch_token' });
+ const autoRefreshTokenKey = _.find(auth, { name: 'auto_refresh_token' });
return {
auth: {
oauth2:
@@ -508,11 +626,19 @@ const sem = grammar.createSemantics().addAttribute('ast', {
? {
grantType: grantTypeKey ? grantTypeKey.value : '',
accessTokenUrl: accessTokenUrlKey ? accessTokenUrlKey.value : '',
+ refreshTokenUrl: refreshTokenUrlKey ? refreshTokenUrlKey.value : '',
username: usernameKey ? usernameKey.value : '',
password: passwordKey ? passwordKey.value : '',
clientId: clientIdKey ? clientIdKey.value : '',
clientSecret: clientSecretKey ? clientSecretKey.value : '',
- scope: scopeKey ? scopeKey.value : ''
+ scope: scopeKey ? scopeKey.value : '',
+ credentialsPlacement: credentialsPlacementKey?.value ? credentialsPlacementKey.value : 'body',
+ credentialsId: credentialsIdKey?.value ? credentialsIdKey.value : 'credentials',
+ tokenPlacement: tokenPlacementKey?.value ? tokenPlacementKey.value : 'header',
+ tokenHeaderPrefix: tokenHeaderPrefixKey?.value ? tokenHeaderPrefixKey.value : '',
+ tokenQueryKey: tokenQueryKeyKey?.value ? tokenQueryKeyKey.value : 'access_token',
+ autoFetchToken: autoFetchTokenKey ? safeParseJson(autoFetchTokenKey?.value) ?? true : true,
+ autoRefreshToken: autoRefreshTokenKey ? safeParseJson(autoRefreshTokenKey?.value) ?? false : false
}
: grantTypeKey?.value && grantTypeKey?.value == 'authorization_code'
? {
@@ -520,24 +646,94 @@ const sem = grammar.createSemantics().addAttribute('ast', {
callbackUrl: callbackUrlKey ? callbackUrlKey.value : '',
authorizationUrl: authorizationUrlKey ? authorizationUrlKey.value : '',
accessTokenUrl: accessTokenUrlKey ? accessTokenUrlKey.value : '',
+ refreshTokenUrl: refreshTokenUrlKey ? refreshTokenUrlKey.value : '',
clientId: clientIdKey ? clientIdKey.value : '',
clientSecret: clientSecretKey ? clientSecretKey.value : '',
scope: scopeKey ? scopeKey.value : '',
state: stateKey ? stateKey.value : '',
- pkce: pkceKey ? JSON.parse(pkceKey?.value || false) : false
+ pkce: pkceKey ? safeParseJson(pkceKey?.value) ?? false : false,
+ credentialsPlacement: credentialsPlacementKey?.value ? credentialsPlacementKey.value : 'body',
+ credentialsId: credentialsIdKey?.value ? credentialsIdKey.value : 'credentials',
+ tokenPlacement: tokenPlacementKey?.value ? tokenPlacementKey.value : 'header',
+ tokenHeaderPrefix: tokenHeaderPrefixKey?.value ? tokenHeaderPrefixKey.value : '',
+ tokenQueryKey: tokenQueryKeyKey?.value ? tokenQueryKeyKey.value : 'access_token',
+ autoFetchToken: autoFetchTokenKey ? safeParseJson(autoFetchTokenKey?.value) ?? true : true,
+ autoRefreshToken: autoRefreshTokenKey ? safeParseJson(autoRefreshTokenKey?.value) ?? false : false
}
: grantTypeKey?.value && grantTypeKey?.value == 'client_credentials'
? {
grantType: grantTypeKey ? grantTypeKey.value : '',
accessTokenUrl: accessTokenUrlKey ? accessTokenUrlKey.value : '',
+ refreshTokenUrl: refreshTokenUrlKey ? refreshTokenUrlKey.value : '',
clientId: clientIdKey ? clientIdKey.value : '',
clientSecret: clientSecretKey ? clientSecretKey.value : '',
- scope: scopeKey ? scopeKey.value : ''
+ scope: scopeKey ? scopeKey.value : '',
+ credentialsPlacement: credentialsPlacementKey?.value ? credentialsPlacementKey.value : 'body',
+ credentialsId: credentialsIdKey?.value ? credentialsIdKey.value : 'credentials',
+ tokenPlacement: tokenPlacementKey?.value ? tokenPlacementKey.value : 'header',
+ tokenHeaderPrefix: tokenHeaderPrefixKey?.value ? tokenHeaderPrefixKey.value : '',
+ tokenQueryKey: tokenQueryKeyKey?.value ? tokenQueryKeyKey.value : 'access_token',
+ autoFetchToken: autoFetchTokenKey ? safeParseJson(autoFetchTokenKey?.value) ?? true : true,
+ autoRefreshToken: autoRefreshTokenKey ? safeParseJson(autoRefreshTokenKey?.value) ?? false : false
+ }
+ : grantTypeKey?.value && grantTypeKey?.value == 'implicit'
+ ? {
+ grantType: grantTypeKey ? grantTypeKey.value : '',
+ callbackUrl: callbackUrlKey ? callbackUrlKey.value : '',
+ authorizationUrl: authorizationUrlKey ? authorizationUrlKey.value : '',
+ clientId: clientIdKey ? clientIdKey.value : '',
+ scope: scopeKey ? scopeKey.value : '',
+ state: stateKey ? stateKey.value : '',
+ credentialsId: credentialsIdKey?.value ? credentialsIdKey.value : 'credentials',
+ tokenPlacement: tokenPlacementKey?.value ? tokenPlacementKey.value : 'header',
+ tokenHeaderPrefix: tokenHeaderPrefixKey?.value ? tokenHeaderPrefixKey.value : '',
+ tokenQueryKey: tokenQueryKeyKey?.value ? tokenQueryKeyKey.value : 'access_token',
+ autoFetchToken: autoFetchTokenKey ? safeParseJson(autoFetchTokenKey?.value) ?? true : true,
}
: {}
}
};
},
+ oauth2AuthReqHeaders(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_auth_req_headers: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2AuthReqQueryParams(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_auth_req_queryparams: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2AccessTokenReqHeaders(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_access_token_req_headers: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2AccessTokenReqQueryParams(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_access_token_req_queryparams: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2AccessTokenReqBody(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_access_token_req_bodyvalues: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2RefreshTokenReqHeaders(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_refresh_token_req_headers: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2RefreshTokenReqQueryParams(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_refresh_token_req_queryparams: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2RefreshTokenReqBody(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_refresh_token_req_bodyvalues: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
authwsse(_1, dictionary) {
const auth = mapPairListToKeyValPairs(dictionary.ast, false);
@@ -591,6 +787,13 @@ const sem = grammar.createSemantics().addAttribute('ast', {
}
};
},
+ bodyfile(_1, dictionary) {
+ return {
+ body: {
+ file: mapPairListToKeyValPairsFile(dictionary.ast)
+ }
+ };
+ },
body(_1, _2, _3, _4, textblock, _5) {
return {
http: {
@@ -711,6 +914,40 @@ const sem = grammar.createSemantics().addAttribute('ast', {
return {
docs: outdentString(textblock.sourceString)
};
+ },
+ bodygrpc(_1, dictionary) {
+ const pairs = mapPairListToKeyValPairs(dictionary.ast, false);
+ const namePair = _.find(pairs, { name: 'name' });
+ const contentPair = _.find(pairs, { name: 'content' });
+
+ const messageName = namePair ? namePair.value : '';
+ const messageContent = contentPair ? contentPair.value : '';
+
+ try {
+ // Validate JSON by parsing (but don't modify the original string)
+ JSON.parse(messageContent);
+ } catch (error) {
+ console.error("Error validating gRPC message JSON:", error);
+ return {
+ body: {
+ mode: 'grpc',
+ grpc: [{
+ name: messageName,
+ content: '{}'
+ }]
+ }
+ };
+ }
+
+ return {
+ body: {
+ mode: 'grpc',
+ grpc: [{
+ name: messageName,
+ content: messageContent
+ }]
+ }
+ };
}
});
@@ -718,10 +955,12 @@ const parser = (input) => {
const match = grammar.match(input);
if (match.succeeded()) {
- return sem(match).ast;
+ let ast = sem(match).ast
+
+ return ast;
} else {
throw new Error(match.message);
}
};
-module.exports = parser;
+module.exports = parser;
\ No newline at end of file
diff --git a/packages/bruno-lang/v2/src/collectionBruToJson.js b/packages/bruno-lang/v2/src/collectionBruToJson.js
index 61d373d91..f3925ad62 100644
--- a/packages/bruno-lang/v2/src/collectionBruToJson.js
+++ b/packages/bruno-lang/v2/src/collectionBruToJson.js
@@ -1,10 +1,16 @@
const ohm = require('ohm-js');
const _ = require('lodash');
-const { outdentString } = require('../../v1/src/utils');
+const { safeParseJson, outdentString } = require('./utils');
const grammar = ohm.grammar(`Bru {
BruFile = (meta | query | headers | auth | auths | vars | script | tests | docs)*
- auths = authawsv4 | authbasic | authbearer | authdigest | authNTLM |authOAuth2 | authwsse | authapikey
+ auths = authawsv4 | authbasic | authbearer | authdigest | authNTLM |authOAuth2 | authwsse | authapikey | authOauth2Configs
+
+ // Oauth2 additional parameters
+ authOauth2Configs = oauth2AuthReqConfig | oauth2AccessTokenReqConfig | oauth2RefreshTokenReqConfig
+ oauth2AuthReqConfig = oauth2AuthReqHeaders | oauth2AuthReqQueryParams
+ oauth2AccessTokenReqConfig = oauth2AccessTokenReqHeaders | oauth2AccessTokenReqQueryParams | oauth2AccessTokenReqBody
+ oauth2RefreshTokenReqConfig = oauth2RefreshTokenReqHeaders | oauth2RefreshTokenReqQueryParams | oauth2RefreshTokenReqBody
nl = "\\r"? "\\n"
st = " " | "\\t"
@@ -30,6 +36,15 @@ const grammar = ohm.grammar(`Bru {
auth = "auth" dictionary
+ oauth2AuthReqHeaders = "auth:oauth2:additional_params:auth_req:headers" dictionary
+ oauth2AuthReqQueryParams = "auth:oauth2:additional_params:auth_req:queryparams" dictionary
+ oauth2AccessTokenReqHeaders = "auth:oauth2:additional_params:access_token_req:headers" dictionary
+ oauth2AccessTokenReqQueryParams = "auth:oauth2:additional_params:access_token_req:queryparams" dictionary
+ oauth2AccessTokenReqBody = "auth:oauth2:additional_params:access_token_req:body" dictionary
+ oauth2RefreshTokenReqHeaders = "auth:oauth2:additional_params:refresh_token_req:headers" dictionary
+ oauth2RefreshTokenReqQueryParams = "auth:oauth2:additional_params:refresh_token_req:queryparams" dictionary
+ oauth2RefreshTokenReqBody = "auth:oauth2:additional_params:refresh_token_req:body" dictionary
+
headers = "headers" dictionary
query = "query" dictionary
@@ -163,7 +178,7 @@ const sem = grammar.createSemantics().addAttribute('ast', {
return {
auth: {
- mode: auth ? auth.mode : 'none'
+ mode: auth?.mode || 'none'
}
};
},
@@ -274,11 +289,19 @@ const sem = grammar.createSemantics().addAttribute('ast', {
const callbackUrlKey = _.find(auth, { name: 'callback_url' });
const authorizationUrlKey = _.find(auth, { name: 'authorization_url' });
const accessTokenUrlKey = _.find(auth, { name: 'access_token_url' });
+ const refreshTokenUrlKey = _.find(auth, { name: 'refresh_token_url' });
const clientIdKey = _.find(auth, { name: 'client_id' });
const clientSecretKey = _.find(auth, { name: 'client_secret' });
const scopeKey = _.find(auth, { name: 'scope' });
const stateKey = _.find(auth, { name: 'state' });
const pkceKey = _.find(auth, { name: 'pkce' });
+ const credentialsPlacementKey = _.find(auth, { name: 'credentials_placement' });
+ const credentialsIdKey = _.find(auth, { name: 'credentials_id' });
+ const tokenPlacementKey = _.find(auth, { name: 'token_placement' });
+ const tokenHeaderPrefixKey = _.find(auth, { name: 'token_header_prefix' });
+ const tokenQueryKeyKey = _.find(auth, { name: 'token_query_key' });
+ const autoFetchTokenKey = _.find(auth, { name: 'auto_fetch_token' });
+ const autoRefreshTokenKey = _.find(auth, { name: 'auto_refresh_token' });
return {
auth: {
oauth2:
@@ -286,11 +309,19 @@ const sem = grammar.createSemantics().addAttribute('ast', {
? {
grantType: grantTypeKey ? grantTypeKey.value : '',
accessTokenUrl: accessTokenUrlKey ? accessTokenUrlKey.value : '',
+ refreshTokenUrl: refreshTokenUrlKey ? refreshTokenUrlKey.value : '',
username: usernameKey ? usernameKey.value : '',
password: passwordKey ? passwordKey.value : '',
clientId: clientIdKey ? clientIdKey.value : '',
clientSecret: clientSecretKey ? clientSecretKey.value : '',
- scope: scopeKey ? scopeKey.value : ''
+ scope: scopeKey ? scopeKey.value : '',
+ credentialsPlacement: credentialsPlacementKey?.value ? credentialsPlacementKey.value : 'body',
+ credentialsId: credentialsIdKey?.value ? credentialsIdKey.value : 'credentials',
+ tokenPlacement: tokenPlacementKey?.value ? tokenPlacementKey.value : 'header',
+ tokenHeaderPrefix: tokenHeaderPrefixKey?.value ? tokenHeaderPrefixKey.value : '',
+ tokenQueryKey: tokenQueryKeyKey?.value ? tokenQueryKeyKey.value : 'access_token',
+ autoFetchToken: autoFetchTokenKey ? safeParseJson(autoFetchTokenKey?.value) ?? true : true,
+ autoRefreshToken: autoRefreshTokenKey ? safeParseJson(autoRefreshTokenKey?.value) ?? false : false
}
: grantTypeKey?.value && grantTypeKey?.value == 'authorization_code'
? {
@@ -298,24 +329,94 @@ const sem = grammar.createSemantics().addAttribute('ast', {
callbackUrl: callbackUrlKey ? callbackUrlKey.value : '',
authorizationUrl: authorizationUrlKey ? authorizationUrlKey.value : '',
accessTokenUrl: accessTokenUrlKey ? accessTokenUrlKey.value : '',
+ refreshTokenUrl: refreshTokenUrlKey ? refreshTokenUrlKey.value : '',
clientId: clientIdKey ? clientIdKey.value : '',
clientSecret: clientSecretKey ? clientSecretKey.value : '',
scope: scopeKey ? scopeKey.value : '',
state: stateKey ? stateKey.value : '',
- pkce: pkceKey ? JSON.parse(pkceKey?.value || false) : false
+ pkce: pkceKey ? safeParseJson(pkceKey?.value) ?? false : false,
+ credentialsPlacement: credentialsPlacementKey?.value ? credentialsPlacementKey.value : 'body',
+ credentialsId: credentialsIdKey?.value ? credentialsIdKey.value : 'credentials',
+ tokenPlacement: tokenPlacementKey?.value ? tokenPlacementKey.value : 'header',
+ tokenHeaderPrefix: tokenHeaderPrefixKey?.value ? tokenHeaderPrefixKey.value : '',
+ tokenQueryKey: tokenQueryKeyKey?.value ? tokenQueryKeyKey.value : 'access_token',
+ autoFetchToken: autoFetchTokenKey ? safeParseJson(autoFetchTokenKey?.value) ?? true : true,
+ autoRefreshToken: autoRefreshTokenKey ? safeParseJson(autoRefreshTokenKey?.value) ?? false : false
+ }
+ : grantTypeKey?.value && grantTypeKey?.value == 'implicit'
+ ? {
+ grantType: grantTypeKey ? grantTypeKey.value : '',
+ callbackUrl: callbackUrlKey ? callbackUrlKey.value : '',
+ authorizationUrl: authorizationUrlKey ? authorizationUrlKey.value : '',
+ clientId: clientIdKey ? clientIdKey.value : '',
+ scope: scopeKey ? scopeKey.value : '',
+ state: stateKey ? stateKey.value : '',
+ credentialsId: credentialsIdKey?.value ? credentialsIdKey.value : 'credentials',
+ tokenPlacement: tokenPlacementKey?.value ? tokenPlacementKey.value : 'header',
+ tokenHeaderPrefix: tokenHeaderPrefixKey?.value ? tokenHeaderPrefixKey.value : '',
+ tokenQueryKey: tokenQueryKeyKey?.value ? tokenQueryKeyKey.value : 'access_token',
+ autoFetchToken: autoFetchTokenKey ? safeParseJson(autoFetchTokenKey?.value) ?? true : true,
}
: grantTypeKey?.value && grantTypeKey?.value == 'client_credentials'
? {
grantType: grantTypeKey ? grantTypeKey.value : '',
accessTokenUrl: accessTokenUrlKey ? accessTokenUrlKey.value : '',
+ refreshTokenUrl: refreshTokenUrlKey ? refreshTokenUrlKey.value : '',
clientId: clientIdKey ? clientIdKey.value : '',
clientSecret: clientSecretKey ? clientSecretKey.value : '',
- scope: scopeKey ? scopeKey.value : ''
+ scope: scopeKey ? scopeKey.value : '',
+ credentialsPlacement: credentialsPlacementKey?.value ? credentialsPlacementKey.value : 'body',
+ credentialsId: credentialsIdKey?.value ? credentialsIdKey.value : 'credentials',
+ tokenPlacement: tokenPlacementKey?.value ? tokenPlacementKey.value : 'header',
+ tokenHeaderPrefix: tokenHeaderPrefixKey?.value ? tokenHeaderPrefixKey.value : '',
+ tokenQueryKey: tokenQueryKeyKey?.value ? tokenQueryKeyKey.value : 'access_token',
+ autoFetchToken: autoFetchTokenKey ? safeParseJson(autoFetchTokenKey?.value) ?? true : true,
+ autoRefreshToken: autoRefreshTokenKey ? safeParseJson(autoRefreshTokenKey?.value) ?? false : false
}
: {}
}
};
},
+ oauth2AuthReqHeaders(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_auth_req_headers: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2AuthReqQueryParams(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_auth_req_queryparams: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2AccessTokenReqHeaders(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_access_token_req_headers: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2AccessTokenReqQueryParams(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_access_token_req_queryparams: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2AccessTokenReqBody(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_access_token_req_bodyvalues: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2RefreshTokenReqHeaders(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_refresh_token_req_headers: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2RefreshTokenReqQueryParams(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_refresh_token_req_queryparams: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
+ oauth2RefreshTokenReqBody(_1, dictionary) {
+ return {
+ oauth2_additional_parameters_refresh_token_req_bodyvalues: mapPairListToKeyValPairs(dictionary.ast)
+ };
+ },
authwsse(_1, dictionary) {
const auth = mapPairListToKeyValPairs(dictionary.ast, false);
const userKey = _.find(auth, { name: 'username' });
@@ -419,7 +520,9 @@ const parser = (input) => {
const match = grammar.match(input);
if (match.succeeded()) {
- return sem(match).ast;
+ let ast = sem(match).ast;
+
+ return ast;
} else {
throw new Error(match.message);
}
diff --git a/packages/bruno-lang/v2/src/envToJson.js b/packages/bruno-lang/v2/src/envToJson.js
index eef4de375..e88c593c1 100644
--- a/packages/bruno-lang/v2/src/envToJson.js
+++ b/packages/bruno-lang/v2/src/envToJson.js
@@ -68,7 +68,7 @@ const mapArrayListToKeyValPairs = (arrayList = []) => {
return {
name,
- value: null,
+ value: '',
enabled
};
});
diff --git a/packages/bruno-lang/v2/src/jsonToBru.js b/packages/bruno-lang/v2/src/jsonToBru.js
index d041f8d5d..ec046674a 100644
--- a/packages/bruno-lang/v2/src/jsonToBru.js
+++ b/packages/bruno-lang/v2/src/jsonToBru.js
@@ -1,9 +1,9 @@
const _ = require('lodash');
-const { indentString } = require('../../v1/src/utils');
+const { indentString } = require('./utils');
-const enabled = (items = []) => items.filter((item) => item.enabled);
-const disabled = (items = []) => items.filter((item) => !item.enabled);
+const enabled = (items = [], key = "enabled") => items.filter((item) => item[key]);
+const disabled = (items = [], key = "enabled") => items.filter((item) => !item[key]);
const quoteKey = (key) => {
const quotableChars = [':', '"', '{', '}', ' '];
return quotableChars.some(char => key.includes(char)) ? ('"' + key.replaceAll('"', '\\"') + '"') : key;
@@ -34,15 +34,29 @@ const getValueString = (value) => {
};
const jsonToBru = (json) => {
- const { meta, http, params, headers, auth, body, script, tests, vars, assertions, docs } = json;
+ const { meta, http, grpc, params, headers, metadata, auth, body, script, tests, vars, assertions, settings, docs } = json;
+
let bru = '';
if (meta) {
bru += 'meta {\n';
+
+ const tags = meta.tags;
+ delete meta.tags;
+
for (const key in meta) {
bru += ` ${key}: ${meta[key]}\n`;
}
+
+ if (tags && tags.length) {
+ bru += ` tags: [\n`;
+ for (const tag of tags) {
+ bru += ` ${tag}\n`;
+ }
+ bru += ` ]\n`;
+ }
+
bru += '}\n\n';
}
@@ -66,6 +80,42 @@ const jsonToBru = (json) => {
`;
}
+ if(grpc && grpc.url) {
+ bru += `grpc {
+ url: ${grpc.url}`;
+
+ if(grpc.method && grpc.method.length) {
+ bru += `
+ method: ${grpc.method}`;
+ }
+
+ if(grpc.body && grpc.body.length) {
+ bru += `
+ body: ${grpc.body}`;
+ }
+
+ if(grpc.protoPath && grpc.protoPath.length) {
+ bru += `
+ protoPath: ${grpc.protoPath}`;
+ }
+
+ if (grpc.auth && grpc.auth.length) {
+ bru += `
+ auth: ${grpc.auth}`;
+ }
+
+ if (grpc.methodType && grpc.methodType.length) {
+ bru += `
+ methodType: ${grpc.methodType}`;
+ }
+
+ bru += `
+}
+
+`;
+ }
+
+
if (params && params.length) {
const queryParams = params.filter((param) => param.type === 'query');
const pathParams = params.filter((param) => param.type === 'path');
@@ -121,6 +171,27 @@ const jsonToBru = (json) => {
bru += '\n}\n\n';
}
+ if (metadata && metadata.length) {
+ bru += 'metadata {';
+ if (enabled(metadata).length) {
+ bru += `\n${indentString(
+ enabled(metadata)
+ .map((item) => `${item.name}: ${item.value}`)
+ .join('\n')
+ )}`;
+ }
+
+ if (disabled(metadata).length) {
+ bru += `\n${indentString(
+ disabled(metadata)
+ .map((item) => `~${item.name}: ${item.value}`)
+ .join('\n')
+ )}`;
+ }
+
+ bru += '\n}\n\n';
+ }
+
if (auth && auth.awsv4) {
bru += `auth:awsv4 {
${indentString(`accessKeyId: ${auth?.awsv4?.accessKeyId || ''}`)}
@@ -187,11 +258,21 @@ ${indentString(`domain: ${auth?.ntlm?.domain || ''}`)}
bru += `auth:oauth2 {
${indentString(`grant_type: password`)}
${indentString(`access_token_url: ${auth?.oauth2?.accessTokenUrl || ''}`)}
+${indentString(`refresh_token_url: ${auth?.oauth2?.refreshTokenUrl || ''}`)}
${indentString(`username: ${auth?.oauth2?.username || ''}`)}
${indentString(`password: ${auth?.oauth2?.password || ''}`)}
${indentString(`client_id: ${auth?.oauth2?.clientId || ''}`)}
${indentString(`client_secret: ${auth?.oauth2?.clientSecret || ''}`)}
${indentString(`scope: ${auth?.oauth2?.scope || ''}`)}
+${indentString(`credentials_placement: ${auth?.oauth2?.credentialsPlacement || ''}`)}
+${indentString(`credentials_id: ${auth?.oauth2?.credentialsId || ''}`)}
+${indentString(`token_placement: ${auth?.oauth2?.tokenPlacement || ''}`)}${
+ auth?.oauth2?.tokenPlacement == 'header' ? '\n' + indentString(`token_header_prefix: ${auth?.oauth2?.tokenHeaderPrefix || ''}`) : ''
+}${
+ auth?.oauth2?.tokenPlacement !== 'header' ? '\n' + indentString(`token_query_key: ${auth?.oauth2?.tokenQueryKey || ''}`) : ''
+}
+${indentString(`auto_fetch_token: ${(auth?.oauth2?.autoFetchToken ?? true).toString()}`)}
+${indentString(`auto_refresh_token: ${(auth?.oauth2?.autoRefreshToken ?? false).toString()}`)}
}
`;
@@ -202,11 +283,21 @@ ${indentString(`grant_type: authorization_code`)}
${indentString(`callback_url: ${auth?.oauth2?.callbackUrl || ''}`)}
${indentString(`authorization_url: ${auth?.oauth2?.authorizationUrl || ''}`)}
${indentString(`access_token_url: ${auth?.oauth2?.accessTokenUrl || ''}`)}
+${indentString(`refresh_token_url: ${auth?.oauth2?.refreshTokenUrl || ''}`)}
${indentString(`client_id: ${auth?.oauth2?.clientId || ''}`)}
${indentString(`client_secret: ${auth?.oauth2?.clientSecret || ''}`)}
${indentString(`scope: ${auth?.oauth2?.scope || ''}`)}
${indentString(`state: ${auth?.oauth2?.state || ''}`)}
${indentString(`pkce: ${(auth?.oauth2?.pkce || false).toString()}`)}
+${indentString(`credentials_placement: ${auth?.oauth2?.credentialsPlacement || ''}`)}
+${indentString(`credentials_id: ${auth?.oauth2?.credentialsId || ''}`)}
+${indentString(`token_placement: ${auth?.oauth2?.tokenPlacement || ''}`)}${
+ auth?.oauth2?.tokenPlacement == 'header' ? '\n' + indentString(`token_header_prefix: ${auth?.oauth2?.tokenHeaderPrefix || ''}`) : ''
+}${
+ auth?.oauth2?.tokenPlacement !== 'header' ? '\n' + indentString(`token_query_key: ${auth?.oauth2?.tokenQueryKey || ''}`) : ''
+}
+${indentString(`auto_fetch_token: ${(auth?.oauth2?.autoFetchToken ?? true).toString()}`)}
+${indentString(`auto_refresh_token: ${(auth?.oauth2?.autoRefreshToken ?? false).toString()}`)}
}
`;
@@ -215,13 +306,150 @@ ${indentString(`pkce: ${(auth?.oauth2?.pkce || false).toString()}`)}
bru += `auth:oauth2 {
${indentString(`grant_type: client_credentials`)}
${indentString(`access_token_url: ${auth?.oauth2?.accessTokenUrl || ''}`)}
+${indentString(`refresh_token_url: ${auth?.oauth2?.refreshTokenUrl || ''}`)}
${indentString(`client_id: ${auth?.oauth2?.clientId || ''}`)}
${indentString(`client_secret: ${auth?.oauth2?.clientSecret || ''}`)}
${indentString(`scope: ${auth?.oauth2?.scope || ''}`)}
+${indentString(`credentials_placement: ${auth?.oauth2?.credentialsPlacement || ''}`)}
+${indentString(`credentials_id: ${auth?.oauth2?.credentialsId || ''}`)}
+${indentString(`token_placement: ${auth?.oauth2?.tokenPlacement || ''}`)}${
+ auth?.oauth2?.tokenPlacement == 'header' ? '\n' + indentString(`token_header_prefix: ${auth?.oauth2?.tokenHeaderPrefix || ''}`) : ''
+}${
+ auth?.oauth2?.tokenPlacement !== 'header' ? '\n' + indentString(`token_query_key: ${auth?.oauth2?.tokenQueryKey || ''}`) : ''
+}
+${indentString(`auto_fetch_token: ${(auth?.oauth2?.autoFetchToken ?? true).toString()}`)}
+${indentString(`auto_refresh_token: ${(auth?.oauth2?.autoRefreshToken ?? false).toString()}`)}
}
`;
break;
+ case 'implicit':
+ bru += `auth:oauth2 {
+${indentString(`grant_type: implicit`)}
+${indentString(`callback_url: ${auth?.oauth2?.callbackUrl || ''}`)}
+${indentString(`authorization_url: ${auth?.oauth2?.authorizationUrl || ''}`)}
+${indentString(`client_id: ${auth?.oauth2?.clientId || ''}`)}
+${indentString(`scope: ${auth?.oauth2?.scope || ''}`)}
+${indentString(`state: ${auth?.oauth2?.state || ''}`)}
+${indentString(`credentials_id: ${auth?.oauth2?.credentialsId || ''}`)}
+${indentString(`token_placement: ${auth?.oauth2?.tokenPlacement || ''}`)}${
+ auth?.oauth2?.tokenPlacement == 'header' ? '\n' + indentString(`token_header_prefix: ${auth?.oauth2?.tokenHeaderPrefix || ''}`) : ''
+}${
+ auth?.oauth2?.tokenPlacement !== 'header' ? '\n' + indentString(`token_query_key: ${auth?.oauth2?.tokenQueryKey || ''}`) : ''
+}
+${indentString(`auto_fetch_token: ${(auth?.oauth2?.autoFetchToken ?? true).toString()}`)}
+}
+
+`;
+ break;
+ }
+
+ if (auth?.oauth2?.additionalParameters) {
+ const { authorization: authorizationParams, token: tokenParams, refresh: refreshParams } = auth?.oauth2?.additionalParameters;
+ const authorizationHeaders = authorizationParams?.filter(p => p?.sendIn == 'headers');
+ if (authorizationHeaders?.length) {
+ bru += `auth:oauth2:additional_params:auth_req:headers {
+${indentString(
+ authorizationHeaders
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const authorizationQueryParams = authorizationParams?.filter(p => p?.sendIn == 'queryparams');
+ if (authorizationQueryParams?.length) {
+ bru += `auth:oauth2:additional_params:auth_req:queryparams {
+${indentString(
+ authorizationQueryParams
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const tokenHeaders = tokenParams?.filter(p => p?.sendIn == 'headers');
+ if (tokenHeaders?.length) {
+ bru += `auth:oauth2:additional_params:access_token_req:headers {
+${indentString(
+ tokenHeaders
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const tokenQueryParams = tokenParams?.filter(p => p?.sendIn == 'queryparams');
+ if (tokenQueryParams?.length) {
+ bru += `auth:oauth2:additional_params:access_token_req:queryparams {
+${indentString(
+ tokenQueryParams
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const tokenBodyValues = tokenParams?.filter(p => p?.sendIn == 'body');
+ if (tokenBodyValues?.length) {
+ bru += `auth:oauth2:additional_params:access_token_req:body {
+${indentString(
+ tokenBodyValues
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const refreshHeaders = refreshParams?.filter(p => p?.sendIn == 'headers');
+ if (refreshHeaders?.length) {
+ bru += `auth:oauth2:additional_params:refresh_token_req:headers {
+${indentString(
+ refreshHeaders
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const refreshQueryParams = refreshParams?.filter(p => p?.sendIn == 'queryparams');
+ if (refreshQueryParams?.length) {
+ bru += `auth:oauth2:additional_params:refresh_token_req:queryparams {
+${indentString(
+ refreshQueryParams
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const refreshBodyValues = refreshParams?.filter(p => p?.sendIn == 'body');
+ if (refreshBodyValues?.length) {
+ bru += `auth:oauth2:additional_params:refresh_token_req:body {
+${indentString(
+ refreshBodyValues
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
}
}
@@ -304,8 +532,9 @@ ${indentString(body.sparql)}
}
if (item.type === 'file') {
- let filepaths = item.value || [];
- let filestr = filepaths.join('|');
+ const filepaths = Array.isArray(item.value) ? item.value : [];
+ const filestr = filepaths.join('|');
+
const value = `@file(${filestr})`;
return `${enabled}${quoteKey(item.name)}: ${value}${contentType}`;
}
@@ -317,6 +546,30 @@ ${indentString(body.sparql)}
bru += '\n}\n\n';
}
+
+ if (body && body.file && body.file.length) {
+ bru += `body:file {`;
+ const files = enabled(body.file, "selected").concat(disabled(body.file, "selected"));
+
+ if (files.length) {
+ bru += `\n${indentString(
+ files
+ .map((item) => {
+ const selected = item.selected ? '' : '~';
+ const contentType =
+ item.contentType && item.contentType !== '' ? ' @contentType(' + item.contentType + ')' : '';
+ const filePath = item.filePath || '';
+ const value = `@file(${filePath})`;
+ const itemName = "file";
+ return `${selected}${itemName}: ${value}${contentType}`;
+ })
+ .join('\n')
+ )}`;
+ }
+
+ bru += '\n}\n\n';
+ }
+
if (body && body.graphql && body.graphql.query) {
bru += `body:graphql {\n`;
bru += `${indentString(body.graphql.query)}`;
@@ -329,6 +582,26 @@ ${indentString(body.sparql)}
bru += '\n}\n\n';
}
+ if (body && body.grpc) {
+ // Convert each gRPC message to a separate body:grpc block
+ if (Array.isArray(body.grpc)) {
+ body.grpc.forEach((m) => {
+ const {name, content} = m;
+
+ bru += `body:grpc {\n`;
+
+ bru += `${indentString(`name: ${getValueString(name)}`)}\n`;
+
+ // Convert content to JSON string if it's an object
+ let jsonValue = typeof content === 'object' ? JSON.stringify(content, null, 2) : content || '{}';
+
+ // Wrap content with triple quotes for multiline support, without extra indentation
+ bru += `${indentString(`content: '''\n${indentString(jsonValue)}\n'''`)}\n`;
+ bru += '}\n\n';
+ });
+ }
+ }
+
let reqvars = _.get(vars, 'req');
let resvars = _.get(vars, 'res');
if (reqvars && reqvars.length) {
@@ -430,6 +703,14 @@ ${indentString(tests)}
`;
}
+ if (settings && Object.keys(settings).length) {
+ bru += 'settings {\n';
+ for (const key in settings) {
+ bru += ` ${key}: ${settings[key]}\n`;
+ }
+ bru += '}\n\n';
+ }
+
if (docs && docs.length) {
bru += `docs {
${indentString(docs)}
@@ -443,4 +724,4 @@ ${indentString(docs)}
module.exports = jsonToBru;
-// alternative to writing the below code to avoif undefined
+// alternative to writing the below code to avoid undefined
diff --git a/packages/bruno-lang/v2/src/jsonToCollectionBru.js b/packages/bruno-lang/v2/src/jsonToCollectionBru.js
index c2a843dc6..d5aa1c1e0 100644
--- a/packages/bruno-lang/v2/src/jsonToCollectionBru.js
+++ b/packages/bruno-lang/v2/src/jsonToCollectionBru.js
@@ -1,6 +1,6 @@
const _ = require('lodash');
-const { indentString } = require('../../v1/src/utils');
+const { indentString } = require('./utils');
const enabled = (items = []) => items.filter((item) => item.enabled);
const disabled = (items = []) => items.filter((item) => !item.enabled);
@@ -149,11 +149,21 @@ ${indentString(`placement: ${auth?.apikey?.placement || ''}`)}
bru += `auth:oauth2 {
${indentString(`grant_type: password`)}
${indentString(`access_token_url: ${auth?.oauth2?.accessTokenUrl || ''}`)}
+${indentString(`refresh_token_url: ${auth?.oauth2?.refreshTokenUrl || ''}`)}
${indentString(`username: ${auth?.oauth2?.username || ''}`)}
${indentString(`password: ${auth?.oauth2?.password || ''}`)}
${indentString(`client_id: ${auth?.oauth2?.clientId || ''}`)}
${indentString(`client_secret: ${auth?.oauth2?.clientSecret || ''}`)}
${indentString(`scope: ${auth?.oauth2?.scope || ''}`)}
+${indentString(`credentials_placement: ${auth?.oauth2?.credentialsPlacement || ''}`)}
+${indentString(`credentials_id: ${auth?.oauth2?.credentialsId || ''}`)}
+${indentString(`token_placement: ${auth?.oauth2?.tokenPlacement || ''}`)}${
+ auth?.oauth2?.tokenPlacement == 'header' ? '\n' + indentString(`token_header_prefix: ${auth?.oauth2?.tokenHeaderPrefix || ''}`) : ''
+}${
+ auth?.oauth2?.tokenPlacement !== 'header' ? '\n' + indentString(`token_query_key: ${auth?.oauth2?.tokenQueryKey || ''}`) : ''
+}
+${indentString(`auto_fetch_token: ${(auth?.oauth2?.autoFetchToken ?? true).toString()}`)}
+${indentString(`auto_refresh_token: ${(auth?.oauth2?.autoRefreshToken ?? false).toString()}`)}
}
`;
@@ -164,11 +174,40 @@ ${indentString(`grant_type: authorization_code`)}
${indentString(`callback_url: ${auth?.oauth2?.callbackUrl || ''}`)}
${indentString(`authorization_url: ${auth?.oauth2?.authorizationUrl || ''}`)}
${indentString(`access_token_url: ${auth?.oauth2?.accessTokenUrl || ''}`)}
+${indentString(`refresh_token_url: ${auth?.oauth2?.refreshTokenUrl || ''}`)}
${indentString(`client_id: ${auth?.oauth2?.clientId || ''}`)}
${indentString(`client_secret: ${auth?.oauth2?.clientSecret || ''}`)}
${indentString(`scope: ${auth?.oauth2?.scope || ''}`)}
${indentString(`state: ${auth?.oauth2?.state || ''}`)}
${indentString(`pkce: ${(auth?.oauth2?.pkce || false).toString()}`)}
+${indentString(`credentials_placement: ${auth?.oauth2?.credentialsPlacement || ''}`)}
+${indentString(`credentials_id: ${auth?.oauth2?.credentialsId || ''}`)}
+${indentString(`token_placement: ${auth?.oauth2?.tokenPlacement || ''}`)}${
+ auth?.oauth2?.tokenPlacement == 'header' ? '\n' + indentString(`token_header_prefix: ${auth?.oauth2?.tokenHeaderPrefix || ''}`) : ''
+}${
+ auth?.oauth2?.tokenPlacement !== 'header' ? '\n' + indentString(`token_query_key: ${auth?.oauth2?.tokenQueryKey || ''}`) : ''
+}
+${indentString(`auto_fetch_token: ${(auth?.oauth2?.autoFetchToken ?? true).toString()}`)}
+${indentString(`auto_refresh_token: ${(auth?.oauth2?.autoRefreshToken ?? false).toString()}`)}
+}
+
+`;
+ break;
+ case 'implicit':
+ bru += `auth:oauth2 {
+${indentString(`grant_type: implicit`)}
+${indentString(`callback_url: ${auth?.oauth2?.callbackUrl || ''}`)}
+${indentString(`authorization_url: ${auth?.oauth2?.authorizationUrl || ''}`)}
+${indentString(`client_id: ${auth?.oauth2?.clientId || ''}`)}
+${indentString(`scope: ${auth?.oauth2?.scope || ''}`)}
+${indentString(`state: ${auth?.oauth2?.state || ''}`)}
+${indentString(`credentials_id: ${auth?.oauth2?.credentialsId || ''}`)}
+${indentString(`token_placement: ${auth?.oauth2?.tokenPlacement || ''}`)}${
+ auth?.oauth2?.tokenPlacement == 'header' ? '\n' + indentString(`token_header_prefix: ${auth?.oauth2?.tokenHeaderPrefix || ''}`) : ''
+}${
+ auth?.oauth2?.tokenPlacement !== 'header' ? '\n' + indentString(`token_query_key: ${auth?.oauth2?.tokenQueryKey || ''}`) : ''
+}
+${indentString(`auto_fetch_token: ${(auth?.oauth2?.autoFetchToken ?? true).toString()}`)}
}
`;
@@ -177,14 +216,132 @@ ${indentString(`pkce: ${(auth?.oauth2?.pkce || false).toString()}`)}
bru += `auth:oauth2 {
${indentString(`grant_type: client_credentials`)}
${indentString(`access_token_url: ${auth?.oauth2?.accessTokenUrl || ''}`)}
+${indentString(`refresh_token_url: ${auth?.oauth2?.refreshTokenUrl || ''}`)}
${indentString(`client_id: ${auth?.oauth2?.clientId || ''}`)}
${indentString(`client_secret: ${auth?.oauth2?.clientSecret || ''}`)}
${indentString(`scope: ${auth?.oauth2?.scope || ''}`)}
+${indentString(`credentials_placement: ${auth?.oauth2?.credentialsPlacement || ''}`)}
+${indentString(`credentials_id: ${auth?.oauth2?.credentialsId || ''}`)}
+${indentString(`token_placement: ${auth?.oauth2?.tokenPlacement || ''}`)}${
+ auth?.oauth2?.tokenPlacement == 'header' ? '\n' + indentString(`token_header_prefix: ${auth?.oauth2?.tokenHeaderPrefix || ''}`) : ''
+}${
+ auth?.oauth2?.tokenPlacement !== 'header' ? '\n' + indentString(`token_query_key: ${auth?.oauth2?.tokenQueryKey || ''}`) : ''
+}
+${indentString(`auto_fetch_token: ${(auth?.oauth2?.autoFetchToken ?? true).toString()}`)}
+${indentString(`auto_refresh_token: ${(auth?.oauth2?.autoRefreshToken ?? false).toString()}`)}
}
`;
break;
}
+
+ if (auth?.oauth2?.additionalParameters) {
+ const { authorization: authorizationParams, token: tokenParams, refresh: refreshParams } = auth?.oauth2?.additionalParameters;
+ const authorizationHeaders = authorizationParams?.filter(p => p?.sendIn == 'headers');
+ if (authorizationHeaders?.length) {
+ bru += `auth:oauth2:additional_params:auth_req:headers {
+${indentString(
+ authorizationHeaders
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const authorizationQueryParams = authorizationParams?.filter(p => p?.sendIn == 'queryparams');
+ if (authorizationQueryParams?.length) {
+ bru += `auth:oauth2:additional_params:auth_req:queryparams {
+${indentString(
+ authorizationQueryParams
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const tokenHeaders = tokenParams?.filter(p => p?.sendIn == 'headers');
+ if (tokenHeaders?.length) {
+ bru += `auth:oauth2:additional_params:access_token_req:headers {
+${indentString(
+ tokenHeaders
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const tokenQueryParams = tokenParams?.filter(p => p?.sendIn == 'queryparams');
+ if (tokenQueryParams?.length) {
+ bru += `auth:oauth2:additional_params:access_token_req:queryparams {
+${indentString(
+ tokenQueryParams
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const tokenBodyValues = tokenParams?.filter(p => p?.sendIn == 'body');
+ if (tokenBodyValues?.length) {
+ bru += `auth:oauth2:additional_params:access_token_req:body {
+${indentString(
+ tokenBodyValues
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const refreshHeaders = refreshParams?.filter(p => p?.sendIn == 'headers');
+ if (refreshHeaders?.length) {
+ bru += `auth:oauth2:additional_params:refresh_token_req:headers {
+${indentString(
+ refreshHeaders
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const refreshQueryParams = refreshParams?.filter(p => p?.sendIn == 'queryparams');
+ if (refreshQueryParams?.length) {
+ bru += `auth:oauth2:additional_params:refresh_token_req:queryparams {
+${indentString(
+ refreshQueryParams
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ const refreshBodyValues = refreshParams?.filter(p => p?.sendIn == 'body');
+ if (refreshBodyValues?.length) {
+ bru += `auth:oauth2:additional_params:refresh_token_req:body {
+${indentString(
+ refreshBodyValues
+ .filter(item => item?.name?.length)
+ .map((item) => `${item.enabled ? '' : '~'}${item.name}: ${item.value}`)
+ .join('\n')
+ )}
+}
+
+`;
+ }
+ }
}
let reqvars = _.get(vars, 'req');
diff --git a/packages/bruno-lang/v2/src/utils.js b/packages/bruno-lang/v2/src/utils.js
new file mode 100644
index 000000000..454d2099d
--- /dev/null
+++ b/packages/bruno-lang/v2/src/utils.js
@@ -0,0 +1,36 @@
+// safely parse json
+const safeParseJson = (json) => {
+ try {
+ return JSON.parse(json);
+ } catch (e) {
+ return null;
+ }
+};
+
+const indentString = (str) => {
+ if (!str || !str.length) {
+ return str || '';
+ }
+
+ return str
+ .split('\n')
+ .map((line) => ' ' + line)
+ .join('\n');
+};
+
+const outdentString = (str) => {
+ if (!str || !str.length) {
+ return str || '';
+ }
+
+ return str
+ .split('\n')
+ .map((line) => line.replace(/^ /, ''))
+ .join('\n');
+};
+
+module.exports = {
+ safeParseJson,
+ indentString,
+ outdentString
+};
diff --git a/packages/bruno-lang/v2/tests/envToJson.spec.js b/packages/bruno-lang/v2/tests/envToJson.spec.js
index fbb74f2b9..9c97cd1fa 100644
--- a/packages/bruno-lang/v2/tests/envToJson.spec.js
+++ b/packages/bruno-lang/v2/tests/envToJson.spec.js
@@ -185,7 +185,7 @@ vars:secret [
},
{
name: 'token',
- value: null,
+ value: '',
enabled: true,
secret: true
}
@@ -220,19 +220,19 @@ vars:secret [
},
{
name: 'access_token',
- value: null,
+ value: '',
enabled: true,
secret: true
},
{
name: 'access_secret',
- value: null,
+ value: '',
enabled: true,
secret: true
},
{
name: 'access_password',
- value: null,
+ value: '',
enabled: false,
secret: true
}
@@ -262,7 +262,7 @@ vars:secret [access_key]
},
{
name: 'access_key',
- value: null,
+ value: '',
enabled: true,
secret: true
}
@@ -292,19 +292,19 @@ vars:secret [access_key,access_secret, access_password ]
},
{
name: 'access_key',
- value: null,
+ value: '',
enabled: true,
secret: true
},
{
name: 'access_secret',
- value: null,
+ value: '',
enabled: true,
secret: true
},
{
name: 'access_password',
- value: null,
+ value: '',
enabled: true,
secret: true
}
diff --git a/packages/bruno-lang/v2/tests/fixtures/request.bru b/packages/bruno-lang/v2/tests/fixtures/request.bru
index 3f3ce9843..c10982f6e 100644
--- a/packages/bruno-lang/v2/tests/fixtures/request.bru
+++ b/packages/bruno-lang/v2/tests/fixtures/request.bru
@@ -2,6 +2,10 @@ meta {
name: Send Bulk SMS
type: http
seq: 1
+ tags: [
+ foo
+ bar
+ ]
}
get {
@@ -69,11 +73,18 @@ auth:oauth2 {
callback_url: http://localhost:8080/api/auth/oauth2/authorization_code/callback
authorization_url: http://localhost:8080/api/auth/oauth2/authorization_code/authorize
access_token_url: http://localhost:8080/api/auth/oauth2/authorization_code/token
+ refresh_token_url:
client_id: client_id_1
client_secret: client_secret_1
scope: read write
state: 807061d5f0be
pkce: false
+ credentials_placement: body
+ credentials_id: credentials
+ token_placement: header
+ token_header_prefix: Bearer
+ auto_fetch_token: true
+ auto_refresh_token: true
}
body:json {
@@ -122,6 +133,12 @@ body:multipart-form {
~"disabled colon:part": is allowed
}
+body:file {
+ file: @file(path/to/file.json) @contentType(application/json)
+ file: @file(path/to/file.json) @contentType(application/json)
+ ~file: @file(path/to/file2.json) @contentType(application/json)
+}
+
body:graphql {
{
launchesPast {
diff --git a/packages/bruno-lang/v2/tests/fixtures/request.json b/packages/bruno-lang/v2/tests/fixtures/request.json
index 87c36bff3..1b6e66497 100644
--- a/packages/bruno-lang/v2/tests/fixtures/request.json
+++ b/packages/bruno-lang/v2/tests/fixtures/request.json
@@ -2,7 +2,8 @@
"meta": {
"name": "Send Bulk SMS",
"type": "http",
- "seq": "1"
+ "seq": "1",
+ "tags": ["foo", "bar"]
},
"http": {
"method": "get",
@@ -129,15 +130,23 @@
"password": "secret"
},
"oauth2": {
- "grantType": "authorization_code",
+ "accessTokenUrl": "http://localhost:8080/api/auth/oauth2/authorization_code/token",
+ "authorizationUrl": "http://localhost:8080/api/auth/oauth2/authorization_code/authorize",
+ "autoFetchToken": true,
+ "autoRefreshToken": true,
+ "callbackUrl": "http://localhost:8080/api/auth/oauth2/authorization_code/callback",
"clientId": "client_id_1",
"clientSecret": "client_secret_1",
- "authorizationUrl": "http://localhost:8080/api/auth/oauth2/authorization_code/authorize",
- "callbackUrl": "http://localhost:8080/api/auth/oauth2/authorization_code/callback",
- "accessTokenUrl": "http://localhost:8080/api/auth/oauth2/authorization_code/token",
+ "credentialsId": "credentials",
+ "credentialsPlacement": "body",
+ "grantType": "authorization_code",
+ "pkce": false,
+ "refreshTokenUrl": "",
"scope": "read write",
"state": "807061d5f0be",
- "pkce": false
+ "tokenHeaderPrefix": "Bearer",
+ "tokenPlacement": "header",
+ "tokenQueryKey": "access_token"
},
"wsse": {
"username": "john",
@@ -252,6 +261,23 @@
"enabled": false,
"type": "text"
}
+ ],
+ "file" : [
+ {
+ "filePath": "path/to/file.json",
+ "contentType": "application/json",
+ "selected": true
+ },
+ {
+ "filePath": "path/to/file.json",
+ "contentType": "application/json",
+ "selected": true
+ },
+ {
+ "filePath": "path/to/file2.json",
+ "contentType": "application/json",
+ "selected": false
+ }
]
},
"vars": {
diff --git a/packages/bruno-lang/v2/tests/list.spec.js b/packages/bruno-lang/v2/tests/list.spec.js
new file mode 100644
index 000000000..19804779f
--- /dev/null
+++ b/packages/bruno-lang/v2/tests/list.spec.js
@@ -0,0 +1,798 @@
+/**
+ * This test file is used to test list parsing in various BruFile blocks.
+ */
+const parser = require('../src/bruToJson');
+
+describe('List Support in BruFile Blocks', () => {
+
+ describe('Basic List Functionality', () => {
+ describe('Valid List Syntax', () => {
+ it('should parse simple list with proper indentation', () => {
+ const input = `
+meta {
+ tags: [
+ tag_1
+ tag_2
+ ]
+}
+`;
+ const output = parser(input);
+ const expected = {
+ meta: {
+ seq: 1,
+ tags: ['tag_1', 'tag_2'],
+ type: "http"
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse list with mixed properties', () => {
+ const input = `
+meta {
+ name: request_name
+ tags: [
+ regression
+ smoke_test
+ ]
+ type: http
+}
+`;
+ const output = parser(input);
+ const expected = {
+ meta: {
+ seq: 1,
+ name: "request_name",
+ tags: ['regression', 'smoke_test'],
+ type: "http"
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse list with varying indentation inside list', () => {
+ const input = `
+meta {
+ tags: [
+ tag_1
+ tag_2
+ tag_3
+ ]
+}
+`;
+ const output = parser(input);
+ const expected = {
+ meta: {
+ seq: 1,
+ tags: ['tag_1', 'tag_2', 'tag_3'],
+ type: "http"
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse list with alphanumeric, underscore, and hyphen characters', () => {
+ const input = `
+meta {
+ tags: [
+ tag-with-hyphens
+ tag_with_underscores
+ tag123numbers
+ CamelCaseTag
+ ]
+}
+`;
+ const output = parser(input);
+ const expected = {
+ meta: {
+ seq: 1,
+ tags: ['tag-with-hyphens', 'tag_with_underscores', 'tag123numbers', 'CamelCaseTag'],
+ type: "http"
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+ });
+
+ describe('Invalid List Syntax', () => {
+ it('should fail when list items have no indentation', () => {
+ const input = `
+meta {
+ tags: [
+ tag_1
+tag_2
+ ]
+}
+`;
+ expect(() => parser(input)).toThrow();
+ });
+
+ it('should fail when list has empty lines between items', () => {
+ const input = `
+meta {
+ tags: [
+ tag_1
+
+ tag_2
+ ]
+}
+`;
+ expect(() => parser(input)).toThrow();
+ });
+
+ it('should fail when list opening bracket is on same line as first item', () => {
+ const input = `
+meta {
+ tags: [tag_1
+ tag_2
+ ]
+}
+`;
+ expect(() => parser(input)).toThrow();
+ });
+
+ it('should fail when list closing bracket is on same line as last item', () => {
+ const input = `
+meta {
+ tags: [
+ tag_1
+ tag_2]
+}
+`;
+ expect(() => parser(input)).toThrow();
+ });
+
+ it('should fail when list items contain invalid characters - variation 1', () => {
+ const input = `
+meta {
+ tags: [
+ tag*1
+ tag@2
+ ]
+}
+`;
+ expect(() => parser(input)).toThrow();
+ });
+
+ it('should fail when list items contain spaces', () => {
+ const input = `
+meta {
+ tags: [
+ tag with spaces
+ another-tag
+ ]
+}
+`;
+ expect(() => parser(input)).toThrow();
+ });
+
+ it('should fail when list items contain invalid characters - variation 2', () => {
+ const input = `
+meta {
+ tags: [
+ tag_1,
+ tag_2
+ ]
+}
+`;
+ expect(() => parser(input)).toThrow();
+ });
+
+ it('should fail when first list item has no indentation', () => {
+ const input = `
+meta {
+ tags: [ tag_1
+ tag_2
+ ]
+}
+`;
+ expect(() => parser(input)).toThrow();
+ });
+
+ it('should fail when list item are not seperated by atleast one newline', () => {
+ const input = `
+meta {
+ tags: [
+ tag_1
+ tag_2 tag_3
+ ]
+}
+`;
+ expect(() => parser(input)).toThrow();
+ });
+
+ it('should not parse empty list', () => {
+ const input = `
+meta {
+ tags: [
+ ]
+}
+`;
+
+ expect(() => parser(input)).toThrow();
+ });
+ });
+
+ describe('String Values That Look Like Lists', () => {
+ it('should parse inline bracketed strings as regular values', () => {
+ const input = `
+meta {
+ name: [some name]
+ tags: [
+ actual_list_item
+ ]
+}
+`;
+ const output = parser(input);
+ const expected = {
+ meta: {
+ seq: 1,
+ name: "[some name]",
+ tags: ['actual_list_item'],
+ type: "http"
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse bracketed strings with spaces as regular values', () => {
+ const input = `
+meta {
+ name: [ this is the name ]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}
+`;
+ const output = parser(input);
+ const expected = {
+ meta: {
+ seq: 1,
+ name: "[ this is the name ]",
+ tags: ['tag_1', 'tag_2'],
+ type: "http"
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should fail when multiline bracketed strings are malformed', () => {
+ const input = `
+meta {
+ name: [this spans
+ multiple lines
+ ]
+}
+`;
+ expect(() => parser(input)).toThrow();
+ });
+ });
+ });
+
+ describe('Lists in Meta Block', () => {
+ it('should parse tags in meta block', () => {
+ const input = `
+meta {
+ name: API Test
+ tags: [
+ api
+ integration
+ v1
+ ]
+}
+`;
+ const output = parser(input);
+ const expected = {
+ meta: {
+ name: "API Test",
+ tags: ['api', 'integration', 'v1'],
+ seq: 1,
+ type: "http"
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse custom list properties in meta block', () => {
+ const input = `
+meta {
+ categories: [
+ user-management
+ auth
+ ]
+ environments: [
+ staging
+ production
+ ]
+}
+`;
+ const output = parser(input);
+ const expected = {
+ meta: {
+ seq: 1,
+ categories: ['user-management', 'auth'],
+ environments: ['staging', 'production'],
+ type: "http"
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+ });
+
+ describe('Lists type content in Body Blocks', () => {
+ it('should parse bru file with a text body block that has list type values - variation 1', () => {
+ const input = `
+meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}
+body:text {
+ meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+ }
+}
+`;
+ const output = parser(input);
+
+ const expected = {
+ meta: {
+ name: "[name]",
+ tags: [
+ "tag_1",
+ "tag_2"
+ ],
+ seq: 1,
+ type: 'http'
+ },
+ body: {
+ text: `meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}`
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse bru file with a text body block that has list type values - variation 2', () => {
+ const input = `
+meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}
+body:text {
+ meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+ }
+}
+`;
+ const output = parser(input);
+
+ const expected = {
+ meta: {
+ name: "[name]",
+ tags: [
+ "tag_1",
+ "tag_2"
+ ],
+ seq: 1,
+ type: 'http'
+ },
+ body: {
+ text: `meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}`
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse bru file with a json body block that has list type values - variation 1', () => {
+ const input = `
+meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}
+body:json {
+ meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+ }
+}
+`;
+ const output = parser(input);
+
+ const expected = {
+ meta: {
+ name: "[name]",
+ tags: [
+ "tag_1",
+ "tag_2"
+ ],
+ seq: 1,
+ type: 'http'
+ },
+ body: {
+ json: `meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}`
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse bru file with a json body block that has list type values - variation 2', () => {
+ const input = `
+meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}
+body:json {
+ meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+ }
+}
+`;
+ const output = parser(input);
+
+ const expected = {
+ meta: {
+ name: "[name]",
+ tags: [
+ "tag_1",
+ "tag_2"
+ ],
+ seq: 1,
+ type: 'http'
+ },
+ body: {
+ json: `meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}`
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse bru file with a json body block that has array values', () => {
+ const input = `
+meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}
+body:json {
+ {
+ array: [
+ "1",
+ "2",
+ "3"
+ ]
+ }
+}
+`;
+ const output = parser(input);
+
+ const expected = {
+ meta: {
+ name: "[name]",
+ tags: [
+ "tag_1",
+ "tag_2"
+ ],
+ seq: 1,
+ type: 'http'
+ },
+ body: {
+ json: `{
+ array: [
+ "1",
+ "2",
+ "3"
+ ]
+}`
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse bru file with a json body block that has array of objects - variation 1', () => {
+ const input = `
+meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}
+body:json {
+ {
+ array: [
+ {
+ "id": 1
+ },
+ {
+ "id": 2
+ },
+ {
+ "id": 3
+ }
+ ]
+ }
+}
+`;
+ const output = parser(input);
+
+ const expected = {
+ meta: {
+ name: "[name]",
+ tags: [
+ "tag_1",
+ "tag_2"
+ ],
+ seq: 1,
+ type: 'http'
+ },
+ body: {
+ json: `{
+ array: [
+ {
+ "id": 1
+ },
+ {
+ "id": 2
+ },
+ {
+ "id": 3
+ }
+ ]
+}`
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse bru file with a json body block that has array of objects - variation 2', () => {
+ const input = `
+meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}
+body:json {
+ [{
+ "foo": "bar"
+ }]
+}
+`;
+ const output = parser(input);
+
+ const expected = {
+ meta: {
+ name: "[name]",
+ tags: [
+ "tag_1",
+ "tag_2"
+ ],
+ seq: 1,
+ type: 'http'
+ },
+ body: {
+ json: `[{
+ "foo": "bar"
+}]`
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse bru file with a json body block that has array of objects - variation 3', () => {
+ const input = `
+meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}
+body:json {
+ [{"foo": "bar"}]
+}
+`;
+ const output = parser(input);
+
+ const expected = {
+ meta: {
+ name: "[name]",
+ tags: [
+ "tag_1",
+ "tag_2"
+ ],
+ seq: 1,
+ type: 'http'
+ },
+ body: {
+ json: `[{"foo": "bar"}]`
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse bru file with a json body block that has objects and arrays - variation 1', () => {
+ const input = `
+meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}
+body:json {
+ {
+ object: {
+ array: [
+ {
+ "id": 1
+ },
+ {
+ "id": 2
+ },
+ {
+ "id": 3
+ }
+ ]
+ }
+ }
+}
+`;
+ const output = parser(input);
+
+ const expected = {
+ meta: {
+ name: "[name]",
+ tags: [
+ "tag_1",
+ "tag_2"
+ ],
+ seq: 1,
+ type: 'http'
+ },
+ body: {
+ json: `{
+ object: {
+ array: [
+ {
+ "id": 1
+ },
+ {
+ "id": 2
+ },
+ {
+ "id": 3
+ }
+ ]
+ }
+}`
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+
+ it('should parse bru file with a json body block with complex arrays', () => {
+ const input = `
+meta {
+ name: [name]
+ tags: [
+ tag_1
+ tag_2
+ ]
+}
+body:json {
+ [
+ "string",
+ array: [
+ "tag_1",
+ "tag_2"
+ ],
+ object: {
+ array: [
+ {
+ "id": 1
+ },
+ {
+ "id": 2
+ },
+ {
+ "id": 3
+ }
+ ]
+ }
+ ]
+}
+`;
+ const output = parser(input);
+
+ const expected = {
+ meta: {
+ name: "[name]",
+ tags: [
+ "tag_1",
+ "tag_2"
+ ],
+ seq: 1,
+ type: 'http'
+ },
+ body: {
+ json: `[
+ "string",
+ array: [
+ "tag_1",
+ "tag_2"
+ ],
+ object: {
+ array: [
+ {
+ "id": 1
+ },
+ {
+ "id": 2
+ },
+ {
+ "id": 3
+ }
+ ]
+ }
+]`
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-lang/v2/tests/oauth2-additional-params.spec.js b/packages/bruno-lang/v2/tests/oauth2-additional-params.spec.js
new file mode 100644
index 000000000..c38ea7ef0
--- /dev/null
+++ b/packages/bruno-lang/v2/tests/oauth2-additional-params.spec.js
@@ -0,0 +1,329 @@
+const bruToJson = require('../src/bruToJson');
+const collectionBruToJson = require('../src/collectionBruToJson');
+
+describe('OAuth2 Additional Parameters - request level', () => {
+ it('should parse all oauth2 additional parameters config types together', () => {
+ const input = `
+meta {
+ name: OAuth2 Additional Params Test
+ type: http
+}
+
+get {
+ url: https://api.usebruno.com/protected
+}
+
+auth:oauth2 {
+ grant_type: authorization_code
+ client_id: bruno-client-id
+ client_secret: bruno-client-secret
+ authorization_url: https://auth.usebruno.com/oauth/authorize
+ access_token_url: https://auth.usebruno.com/oauth/token
+}
+
+auth:oauth2:additional_params:auth_req:headers {
+ auth-header: auth-header-value
+ ~disabled-auth-header: disabled-auth-header-value
+}
+
+auth:oauth2:additional_params:auth_req:queryparams {
+ auth-query-param: auth-query-param-value
+ ~disabled-auth-query-param: disabled-auth-query-param-value
+}
+
+auth:oauth2:additional_params:access_token_req:headers {
+ token-header: token-header-value
+ ~disabled-token-header: disabled-token-header-value
+}
+
+auth:oauth2:additional_params:access_token_req:queryparams {
+ token-query-param: token-query-param-value
+ ~disabled-token-query-param: disabled-token-query-param-value
+}
+
+auth:oauth2:additional_params:access_token_req:body {
+ token-body: token-body-value
+ ~disabled-token-body: disabled-token-body-value
+}
+
+auth:oauth2:additional_params:refresh_token_req:headers {
+ refresh-header: refresh-header-value
+ ~disabled-refresh-header: disabled-refresh-header-value
+}
+
+auth:oauth2:additional_params:refresh_token_req:queryparams {
+ refresh-query-param: refresh-query-param-value
+ ~disabled-refresh-query-param: disabled-refresh-query-param-value
+}
+
+auth:oauth2:additional_params:refresh_token_req:body {
+ refresh-body: refresh-body-value
+ ~disabled-refresh-body: disabled-refresh-body-value
+}
+ `.trim();
+
+ const result = bruToJson(input);
+
+ // Verify all config types are present
+ expect(result).toHaveProperty('oauth2_additional_parameters_auth_req_headers');
+ expect(result).toHaveProperty('oauth2_additional_parameters_auth_req_queryparams');
+ expect(result).toHaveProperty('oauth2_additional_parameters_access_token_req_headers');
+ expect(result).toHaveProperty('oauth2_additional_parameters_access_token_req_queryparams');
+ expect(result).toHaveProperty('oauth2_additional_parameters_access_token_req_bodyvalues');
+ expect(result).toHaveProperty('oauth2_additional_parameters_refresh_token_req_headers');
+ expect(result).toHaveProperty('oauth2_additional_parameters_refresh_token_req_queryparams');
+ expect(result).toHaveProperty('oauth2_additional_parameters_refresh_token_req_bodyvalues');
+
+ // Verify each has exactly one parameter
+ expect(result.oauth2_additional_parameters_auth_req_headers).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_auth_req_queryparams).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_access_token_req_headers).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_access_token_req_queryparams).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_access_token_req_bodyvalues).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_refresh_token_req_headers).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_refresh_token_req_queryparams).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_refresh_token_req_bodyvalues).toHaveLength(2);
+
+ // Verify parameter values
+ expect(result.oauth2_additional_parameters_auth_req_headers).toEqual([{
+ name: 'auth-header',
+ value: 'auth-header-value',
+ enabled: true
+ }, {
+ name: 'disabled-auth-header',
+ value: 'disabled-auth-header-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_auth_req_queryparams).toEqual([{
+ name: 'auth-query-param',
+ value: 'auth-query-param-value',
+ enabled: true
+ }, {
+ name: 'disabled-auth-query-param',
+ value: 'disabled-auth-query-param-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_access_token_req_headers).toEqual([{
+ name: 'token-header',
+ value: 'token-header-value',
+ enabled: true
+ }, {
+ name: 'disabled-token-header',
+ value: 'disabled-token-header-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_access_token_req_queryparams).toEqual([{
+ name: 'token-query-param',
+ value: 'token-query-param-value',
+ enabled: true
+ }, {
+ name: 'disabled-token-query-param',
+ value: 'disabled-token-query-param-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_access_token_req_bodyvalues).toEqual([{
+ name: 'token-body',
+ value: 'token-body-value',
+ enabled: true
+ }, {
+ name: 'disabled-token-body',
+ value: 'disabled-token-body-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_refresh_token_req_headers).toEqual([{
+ name: 'refresh-header',
+ value: 'refresh-header-value',
+ enabled: true
+ }, {
+ name: 'disabled-refresh-header',
+ value: 'disabled-refresh-header-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_refresh_token_req_queryparams).toEqual([{
+ name: 'refresh-query-param',
+ value: 'refresh-query-param-value',
+ enabled: true
+ }, {
+ name: 'disabled-refresh-query-param',
+ value: 'disabled-refresh-query-param-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_refresh_token_req_bodyvalues).toEqual([{
+ name: 'refresh-body',
+ value: 'refresh-body-value',
+ enabled: true
+ }, {
+ name: 'disabled-refresh-body',
+ value: 'disabled-refresh-body-value',
+ enabled: false
+ }]);
+ });
+});
+
+describe('OAuth2 Additional Parameters - collection/folder level', () => {
+ it('should parse all oauth2 additional parameters config types together', () => {
+ const input = `
+auth {
+ mode: oauth2
+}
+
+auth:oauth2 {
+ grant_type: authorization_code
+ client_id: bruno-client-id
+ client_secret: bruno-client-secret
+ authorization_url: https://auth.usebruno.com/oauth/authorize
+ access_token_url: https://auth.usebruno.com/oauth/token
+}
+
+auth:oauth2:additional_params:auth_req:headers {
+ auth-header: auth-header-value
+ ~disabled-auth-header: disabled-auth-header-value
+}
+
+auth:oauth2:additional_params:auth_req:queryparams {
+ auth-query-param: auth-query-param-value
+ ~disabled-auth-query-param: disabled-auth-query-param-value
+}
+
+auth:oauth2:additional_params:access_token_req:headers {
+ token-header: token-header-value
+ ~disabled-token-header: disabled-token-header-value
+}
+
+auth:oauth2:additional_params:access_token_req:queryparams {
+ token-query-param: token-query-param-value
+ ~disabled-token-query-param: disabled-token-query-param-value
+}
+
+auth:oauth2:additional_params:access_token_req:body {
+ token-body: token-body-value
+ ~disabled-token-body: disabled-token-body-value
+}
+
+auth:oauth2:additional_params:refresh_token_req:headers {
+ refresh-header: refresh-header-value
+ ~disabled-refresh-header: disabled-refresh-header-value
+}
+
+auth:oauth2:additional_params:refresh_token_req:queryparams {
+ refresh-query-param: refresh-query-param-value
+ ~disabled-refresh-query-param: disabled-refresh-query-param-value
+}
+
+auth:oauth2:additional_params:refresh_token_req:body {
+ refresh-body: refresh-body-value
+ ~disabled-refresh-body: disabled-refresh-body-value
+}
+ `.trim();
+
+ const result = collectionBruToJson(input);
+
+ // Verify all config types are present
+ expect(result).toHaveProperty('oauth2_additional_parameters_auth_req_headers');
+ expect(result).toHaveProperty('oauth2_additional_parameters_auth_req_queryparams');
+ expect(result).toHaveProperty('oauth2_additional_parameters_access_token_req_headers');
+ expect(result).toHaveProperty('oauth2_additional_parameters_access_token_req_queryparams');
+ expect(result).toHaveProperty('oauth2_additional_parameters_access_token_req_bodyvalues');
+ expect(result).toHaveProperty('oauth2_additional_parameters_refresh_token_req_headers');
+ expect(result).toHaveProperty('oauth2_additional_parameters_refresh_token_req_queryparams');
+ expect(result).toHaveProperty('oauth2_additional_parameters_refresh_token_req_bodyvalues');
+
+ // Verify each has exactly one parameter
+ expect(result.oauth2_additional_parameters_auth_req_headers).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_auth_req_queryparams).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_access_token_req_headers).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_access_token_req_queryparams).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_access_token_req_bodyvalues).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_refresh_token_req_headers).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_refresh_token_req_queryparams).toHaveLength(2);
+ expect(result.oauth2_additional_parameters_refresh_token_req_bodyvalues).toHaveLength(2);
+
+ // Verify parameter values
+ expect(result.oauth2_additional_parameters_auth_req_headers).toEqual([{
+ name: 'auth-header',
+ value: 'auth-header-value',
+ enabled: true
+ }, {
+ name: 'disabled-auth-header',
+ value: 'disabled-auth-header-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_auth_req_queryparams).toEqual([{
+ name: 'auth-query-param',
+ value: 'auth-query-param-value',
+ enabled: true
+ }, {
+ name: 'disabled-auth-query-param',
+ value: 'disabled-auth-query-param-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_access_token_req_headers).toEqual([{
+ name: 'token-header',
+ value: 'token-header-value',
+ enabled: true
+ }, {
+ name: 'disabled-token-header',
+ value: 'disabled-token-header-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_access_token_req_queryparams).toEqual([{
+ name: 'token-query-param',
+ value: 'token-query-param-value',
+ enabled: true
+ }, {
+ name: 'disabled-token-query-param',
+ value: 'disabled-token-query-param-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_access_token_req_bodyvalues).toEqual([{
+ name: 'token-body',
+ value: 'token-body-value',
+ enabled: true
+ }, {
+ name: 'disabled-token-body',
+ value: 'disabled-token-body-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_refresh_token_req_headers).toEqual([{
+ name: 'refresh-header',
+ value: 'refresh-header-value',
+ enabled: true
+ }, {
+ name: 'disabled-refresh-header',
+ value: 'disabled-refresh-header-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_refresh_token_req_queryparams).toEqual([{
+ name: 'refresh-query-param',
+ value: 'refresh-query-param-value',
+ enabled: true
+ }, {
+ name: 'disabled-refresh-query-param',
+ value: 'disabled-refresh-query-param-value',
+ enabled: false
+ }]);
+
+ expect(result.oauth2_additional_parameters_refresh_token_req_bodyvalues).toEqual([{
+ name: 'refresh-body',
+ value: 'refresh-body-value',
+ enabled: true
+ }, {
+ name: 'disabled-refresh-body',
+ value: 'disabled-refresh-body-value',
+ enabled: false
+ }]);
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-lang/v2/tests/tags.spec.js b/packages/bruno-lang/v2/tests/tags.spec.js
new file mode 100644
index 000000000..58613bca8
--- /dev/null
+++ b/packages/bruno-lang/v2/tests/tags.spec.js
@@ -0,0 +1,33 @@
+/**
+ * This test file is used to test the text parser.
+ */
+const parser = require('../src/bruToJson');
+
+describe('tags parser', () => {
+ it('should parse request tags', () => {
+ const input = `
+meta {
+ name: request
+ type: http
+ seq: 1
+ tags: [
+ tag_1
+ tag_2
+ tag_3
+ tag_4
+ ]
+}
+`;
+
+ const output = parser(input);
+ const expected = {
+ meta: {
+ name: 'request',
+ type: 'http',
+ tags: ['tag_1', 'tag_2', 'tag_3', 'tag_4'],
+ seq: '1'
+ }
+ };
+ expect(output).toEqual(expected);
+ });
+});
diff --git a/packages/bruno-query/package.json b/packages/bruno-query/package.json
index 437513a78..fda74c693 100644
--- a/packages/bruno-query/package.json
+++ b/packages/bruno-query/package.json
@@ -15,6 +15,7 @@
"test": "jest",
"prebuild": "npm run clean",
"build": "rollup -c",
+ "watch": "rollup -c -w",
"prepack": "npm run test && npm run build"
},
"devDependencies": {
diff --git a/packages/bruno-requests/.gitignore b/packages/bruno-requests/.gitignore
new file mode 100644
index 000000000..f6eabff32
--- /dev/null
+++ b/packages/bruno-requests/.gitignore
@@ -0,0 +1,22 @@
+# dependencies
+node_modules
+yarn.lock
+pnpm-lock.yaml
+package-lock.json
+.pnp
+.pnp.js
+
+# testing
+coverage
+
+# production
+dist
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/packages/bruno-requests/babel.config.js b/packages/bruno-requests/babel.config.js
new file mode 100644
index 000000000..d19d38b94
--- /dev/null
+++ b/packages/bruno-requests/babel.config.js
@@ -0,0 +1,6 @@
+module.exports = {
+ presets: [
+ ['@babel/preset-env', { targets: { node: 'current' } }],
+ '@babel/preset-typescript',
+ ],
+};
\ No newline at end of file
diff --git a/packages/bruno-requests/jest.config.js b/packages/bruno-requests/jest.config.js
new file mode 100644
index 000000000..ae522cdc8
--- /dev/null
+++ b/packages/bruno-requests/jest.config.js
@@ -0,0 +1,13 @@
+module.exports = {
+ transform: {
+ '^.+\\.(ts|js)$': 'babel-jest',
+ },
+ transformIgnorePatterns: [
+ '/node_modules/(?!(lodash-es|is-ip|ip-regex|super-regex|function-timeout|time-span|convert-hrtime|clone-regexp|is-regexp)/)'
+ ],
+ testEnvironment: 'node',
+ testMatch: [
+ '**/*.(test|spec).(ts|js)'
+ ],
+ moduleFileExtensions: ['ts', 'js', 'json']
+};
\ No newline at end of file
diff --git a/packages/bruno-requests/package.json b/packages/bruno-requests/package.json
new file mode 100644
index 000000000..266b3b472
--- /dev/null
+++ b/packages/bruno-requests/package.json
@@ -0,0 +1,53 @@
+{
+ "name": "@usebruno/requests",
+ "version": "0.1.0",
+ "license": "MIT",
+ "main": "dist/cjs/index.js",
+ "module": "dist/esm/index.js",
+ "types": "dist/index.d.js",
+ "files": [
+ "dist",
+ "src",
+ "package.json"
+ ],
+ "scripts": {
+ "clean": "rimraf dist",
+ "prebuild": "npm run clean",
+ "build": "rollup -c",
+ "watch": "rollup -c -w",
+ "test": "jest",
+ "test:watch": "jest --watch",
+ "prepack": "npm run test && npm run build"
+ },
+ "dependencies": {
+ "@faker-js/faker": "^9.7.0",
+ "@grpc/grpc-js": "^1.13.3",
+ "@grpc/proto-loader": "^0.7.15",
+ "@types/qs": "^6.9.18",
+ "axios": "^1.9.0",
+ "grpc-reflection-js": "^0.3.0",
+ "is-ip": "^5.0.1",
+ "tough-cookie": "^6.0.0"
+ },
+ "devDependencies": {
+ "@babel/preset-env": "^7.22.0",
+ "@babel/preset-typescript": "^7.22.0",
+ "@rollup/plugin-alias": "^5.1.1",
+ "@rollup/plugin-commonjs": "^23.0.2",
+ "@rollup/plugin-json": "^6.1.0",
+ "@rollup/plugin-node-resolve": "^15.0.1",
+ "@rollup/plugin-typescript": "^9.0.2",
+ "@types/jest": "^29.5.11",
+ "babel-jest": "^29.7.0",
+ "builtin-modules": "^5.0.0",
+ "jest": "^29.2.0",
+ "rollup": "3.29.5",
+ "rollup-plugin-dts": "^5.0.0",
+ "rollup-plugin-peer-deps-external": "^2.2.4",
+ "rollup-plugin-terser": "^7.0.2",
+ "typescript": "^4.8.4"
+ },
+ "overrides": {
+ "rollup": "3.29.5"
+ }
+}
diff --git a/packages/bruno-requests/rollup.config.js b/packages/bruno-requests/rollup.config.js
new file mode 100644
index 000000000..9d8f9513e
--- /dev/null
+++ b/packages/bruno-requests/rollup.config.js
@@ -0,0 +1,44 @@
+const { nodeResolve } = require('@rollup/plugin-node-resolve');
+const commonjs = require('@rollup/plugin-commonjs');
+const typescript = require('@rollup/plugin-typescript');
+const dts = require('rollup-plugin-dts');
+const { terser } = require('rollup-plugin-terser');
+const peerDepsExternal = require('rollup-plugin-peer-deps-external');
+const json = require('@rollup/plugin-json');
+const packageJson = require('./package.json');
+
+
+module.exports = [
+ {
+ input: 'src/index.ts',
+ output: [
+ {
+ file: packageJson.main,
+ format: 'cjs',
+ sourcemap: true,
+ exports: 'named'
+ },
+ {
+ file: packageJson.module,
+ format: 'esm',
+ sourcemap: true,
+ exports: 'named'
+ }
+ ],
+ plugins: [
+ peerDepsExternal(),
+ nodeResolve({
+ extensions: ['.js', '.ts', '.tsx', '.json', '.css'],
+ dedupe: ['@grpc/grpc-js'],
+ preferBuiltins: true
+ }),
+ json(),
+ commonjs({
+ transformMixedEsModules: true
+ }),
+ typescript({ tsconfig: './tsconfig.json' }),
+ terser(),
+ ],
+ external: ['axios', 'qs']
+ }
+];
diff --git a/packages/bruno-electron/src/ipc/network/digestauth-helper.js b/packages/bruno-requests/src/auth/digestauth-helper.js
similarity index 79%
rename from packages/bruno-electron/src/ipc/network/digestauth-helper.js
rename to packages/bruno-requests/src/auth/digestauth-helper.js
index f01ba86df..d6b93b98f 100644
--- a/packages/bruno-electron/src/ipc/network/digestauth-helper.js
+++ b/packages/bruno-requests/src/auth/digestauth-helper.js
@@ -1,5 +1,5 @@
const crypto = require('crypto');
-const { URL } = require('url');
+const { URL } = require('node:url');
function isStrPresent(str) {
return str && str.trim() !== '' && str.trim() !== 'undefined';
@@ -9,6 +9,13 @@ function stripQuotes(str) {
return str.replace(/"/g, '');
}
+function splitAuthHeaderKeyValue(str) {
+ const indexOfEqual = str.indexOf('=');
+ const key = str.substring(0, indexOfEqual).trim();
+ const value = str.substring(indexOfEqual + 1);
+ return [key, value];
+}
+
function containsDigestHeader(response) {
const authHeader = response?.headers?.['www-authenticate'];
return authHeader ? authHeader.trim().toLowerCase().startsWith('digest') : false;
@@ -25,7 +32,7 @@ function md5(input) {
return crypto.createHash('md5').update(input).digest('hex');
}
-function addDigestInterceptor(axiosInstance, request) {
+export function addDigestInterceptor(axiosInstance, request) {
const { username, password } = request.digestConfig;
console.debug('Digest Auth Interceptor Initialized');
@@ -55,7 +62,7 @@ function addDigestInterceptor(axiosInstance, request) {
const authDetails = error.response.headers['www-authenticate']
.split(',')
- .map((pair) => pair.split('=').map((item) => item.trim()).map(stripQuotes))
+ .map((pair) => splitAuthHeaderKeyValue(pair).map((item) => item.trim()).map(stripQuotes))
.reduce((acc, [key, value]) => {
const normalizedKey = key.toLowerCase().replace('digest ', '');
if (normalizedKey && value !== undefined) {
@@ -82,9 +89,16 @@ function addDigestInterceptor(axiosInstance, request) {
authDetails.algorithm = 'MD5';
}
- const uri = new URL(request.url, request.baseURL || 'http://localhost').pathname; // Handle relative URLs
+ // Build full URL from the original request (may include query params and baseURL)
+ const resolvedUrl = new URL(
+ originalRequest.url || request.url,
+ originalRequest.baseURL || request.baseURL || 'http://localhost'
+ );
+ const uri = `${resolvedUrl.pathname}${resolvedUrl.search}`;
+ // Used 'GET' as default method to avoid missing method error
+ const method = (originalRequest.method || request.method || 'GET').toUpperCase();
const HA1 = md5(`${username}:${authDetails.realm}:${password}`);
- const HA2 = md5(`${request.method}:${uri}`);
+ const HA2 = md5(`${method}:${uri}`);
const response = md5(
`${HA1}:${authDetails.nonce}:${nonceCount}:${cnonce}:auth:${HA2}`
);
@@ -122,5 +136,3 @@ function addDigestInterceptor(axiosInstance, request) {
}
);
}
-
-module.exports = { addDigestInterceptor };
diff --git a/packages/bruno-requests/src/auth/digestauth-helper.spec.js b/packages/bruno-requests/src/auth/digestauth-helper.spec.js
new file mode 100644
index 000000000..4eb3a405a
--- /dev/null
+++ b/packages/bruno-requests/src/auth/digestauth-helper.spec.js
@@ -0,0 +1,58 @@
+const axios = require('axios');
+const { addDigestInterceptor } = require('./digestauth-helper');
+
+describe('Digest Auth with query params', () => {
+ test('uri should include path and query string', async () => {
+ const axiosInstance = axios.create();
+
+ let callCount = 0;
+ let capturedAuthorization;
+
+ // Custom adapter to simulate a 401 challenge then a 200 success
+ axiosInstance.defaults.adapter = async (config) => {
+ callCount += 1;
+ if (callCount === 1) {
+ const error = new Error('Unauthorized');
+ error.config = config;
+ error.response = {
+ status: 401,
+ headers: {
+ 'www-authenticate': 'Digest realm="test", nonce="abc", qop="auth"'
+ }
+ };
+ throw error;
+ }
+
+ // Second call should have Authorization header set by interceptor
+ capturedAuthorization = config.headers && (config.headers.Authorization || config.headers.authorization);
+ return {
+ status: 200,
+ statusText: 'OK',
+ headers: {},
+ config,
+ data: { ok: true }
+ };
+ };
+
+ const request = {
+ method: 'GET',
+ url: 'http://example.com/resource?foo=bar&baz=qux',
+ headers: {},
+ digestConfig: { username: 'user', password: 'pass' }
+ };
+
+ addDigestInterceptor(axiosInstance, request);
+
+ const res = await axiosInstance(request);
+ expect(res.status).toBe(200);
+
+ expect(capturedAuthorization).toBeTruthy();
+ // Extract uri="..." from the header
+ const uriMatch = /uri="([^"]+)"/.exec(capturedAuthorization);
+ expect(uriMatch).toBeTruthy();
+ const uri = uriMatch[1];
+
+ // Expected to include both pathname and query
+ expect(uri).toBe('/resource?foo=bar&baz=qux');
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-requests/src/auth/index.ts b/packages/bruno-requests/src/auth/index.ts
new file mode 100644
index 000000000..082ca796b
--- /dev/null
+++ b/packages/bruno-requests/src/auth/index.ts
@@ -0,0 +1,2 @@
+export { addDigestInterceptor } from './digestauth-helper';
+export { getOAuth2Token } from './oauth2-helper';
\ No newline at end of file
diff --git a/packages/bruno-requests/src/auth/oauth2-helper.ts b/packages/bruno-requests/src/auth/oauth2-helper.ts
new file mode 100644
index 000000000..e681a5aef
--- /dev/null
+++ b/packages/bruno-requests/src/auth/oauth2-helper.ts
@@ -0,0 +1,205 @@
+import axios, { AxiosError } from 'axios';
+import qs from 'qs';
+
+export interface TokenStore {
+ saveToken(serviceId: string, account: string, token: any): Promise;
+ getToken(serviceId: string, account: string): Promise;
+ deleteToken(serviceId: string, account: string): Promise;
+}
+
+export interface OAuth2Config {
+ grantType: 'client_credentials' | 'password';
+ accessTokenUrl: string;
+ clientId?: string;
+ clientSecret?: string;
+ username?: string;
+ password?: string;
+ scope?: string;
+ credentialsPlacement?: 'header' | 'body';
+}
+
+interface RequestConfig {
+ headers: {
+ 'Content-Type': string;
+ 'Authorization'?: string;
+ };
+}
+
+interface ClientCredentialsData {
+ grant_type: string;
+ scope?: string;
+ client_id?: string;
+ client_secret?: string;
+}
+
+interface PasswordGrantData {
+ grant_type: string;
+ username: string;
+ password: string;
+ scope?: string;
+ client_id?: string;
+ client_secret?: string;
+}
+
+/**
+ * Fetches an OAuth2 token using client credentials grant
+ */
+const fetchTokenClientCredentials = async (oauth2Config: OAuth2Config) => {
+ const {
+ accessTokenUrl,
+ clientId,
+ clientSecret,
+ scope,
+ credentialsPlacement = 'header'
+ } = oauth2Config;
+
+ if (!accessTokenUrl || !clientId) {
+ throw new Error('Missing required OAuth2 parameters');
+ }
+
+ const data: ClientCredentialsData = {
+ grant_type: 'client_credentials'
+ };
+
+ if (scope && scope.trim() !== '') {
+ data.scope = scope;
+ }
+
+ const config: RequestConfig = {
+ headers: {
+ 'Content-Type': 'application/x-www-form-urlencoded'
+ }
+ };
+
+ // Handle credentials placement
+ if (credentialsPlacement === 'header') {
+ config.headers['Authorization'] = `Basic ${Buffer.from(`${encodeURIComponent(clientId)}:${encodeURIComponent(clientSecret || '')}`).toString('base64')}`;
+ } else {
+ // Credentials in body
+ data.client_id = clientId;
+ if (clientSecret) {
+ data.client_secret = clientSecret;
+ }
+ }
+
+ try {
+ const response = await axios.post(accessTokenUrl, qs.stringify(data), config);
+ return response.data;
+ } catch (error) {
+ if (error instanceof Error) {
+ console.error('CLIENT_CREDENTIALS: Error fetching OAuth2 token:', error.message);
+ }
+ throw error;
+ }
+};
+
+/**
+ * Fetches an OAuth2 token using password grant
+ */
+const fetchTokenPassword = async (oauth2Config: OAuth2Config) => {
+ const {
+ accessTokenUrl,
+ clientId,
+ clientSecret,
+ username,
+ password,
+ scope,
+ credentialsPlacement = 'header'
+ } = oauth2Config;
+
+ if (!accessTokenUrl || !username || !password) {
+ throw new Error('Missing required OAuth2 parameters for password grant');
+ }
+
+ const data: PasswordGrantData = {
+ grant_type: 'password',
+ username,
+ password
+ };
+
+ if (scope && scope.trim() !== '') {
+ data.scope = scope;
+ }
+
+ const config: RequestConfig = {
+ headers: {
+ 'Content-Type': 'application/x-www-form-urlencoded'
+ }
+ };
+
+ // Handle credentials placement
+ if (credentialsPlacement === 'header' && clientId) {
+ config.headers['Authorization'] = `Basic ${Buffer.from(`${encodeURIComponent(clientId)}:${encodeURIComponent(clientSecret || '')}`).toString('base64')}`;
+ } else if (clientId) {
+ // Credentials in body
+ data.client_id = clientId;
+ if (clientSecret) {
+ data.client_secret = clientSecret;
+ }
+ }
+
+ try {
+ const response = await axios.post(accessTokenUrl, qs.stringify(data), config);
+ return response.data;
+ } catch (error) {
+ if (error instanceof AxiosError && error.response) {
+ console.error('PASSWORD_GRANT: Error fetching OAuth2 token:', error.message);
+ console.error('Status:', error.response.status, 'Response:', error.response.data);
+ } else if (error instanceof Error) {
+ console.error('PASSWORD_GRANT: Error fetching OAuth2 token:', error.message);
+ }
+ throw error;
+ }
+};
+
+/**
+ * Manages OAuth2 token retrieval and storage
+ */
+export const getOAuth2Token = async (oauth2Config: OAuth2Config, tokenStore: TokenStore): Promise => {
+ const { grantType, clientId, accessTokenUrl } = oauth2Config;
+
+ if (!grantType || !accessTokenUrl) {
+ throw new Error('Missing required OAuth2 parameters: grantType or accessTokenUrl');
+ }
+
+ const serviceId = accessTokenUrl;
+ const account = clientId || oauth2Config.username || 'default';
+
+ // Check if we already have a token stored
+ const existingToken = await tokenStore.getToken(serviceId, account);
+
+ if (existingToken) {
+ // Check if token is expired
+ if (existingToken.expires_at && existingToken.expires_at > Date.now()) {
+ return existingToken.access_token;
+ }
+ }
+
+ // No valid token found, fetch a new one
+ try {
+ let tokenResponse;
+
+ if (grantType === 'client_credentials') {
+ tokenResponse = await fetchTokenClientCredentials(oauth2Config);
+ } else if (grantType === 'password') {
+ tokenResponse = await fetchTokenPassword(oauth2Config);
+ } else {
+ throw new Error(`Unsupported grant type: ${grantType}`);
+ }
+
+ // Calculate expiry time if expires_in is provided
+ if (tokenResponse.expires_in) {
+ tokenResponse.expires_at = Date.now() + tokenResponse.expires_in * 1000;
+ }
+
+ // Store the token
+ await tokenStore.saveToken(serviceId, account, tokenResponse);
+
+ return tokenResponse.access_token;
+ } catch (error) {
+ if (error instanceof Error) {
+ console.error('Failed to get OAuth2 token:', error.message);
+ }
+ return null;
+ }
+};
\ No newline at end of file
diff --git a/packages/bruno-requests/src/cookies/index.spec.ts b/packages/bruno-requests/src/cookies/index.spec.ts
new file mode 100644
index 000000000..22071828d
--- /dev/null
+++ b/packages/bruno-requests/src/cookies/index.spec.ts
@@ -0,0 +1,234 @@
+import cookiesModule from './index';
+import { Cookie } from 'tough-cookie';
+
+// Provide explicit type for the cookie-jar wrapper returned by cookiesModule.jar()
+type CookieJarWrapper = ReturnType;
+
+const jarFactory = (): CookieJarWrapper => cookiesModule.jar();
+
+describe('Bruno Cookie Jar Wrapper - API Examples', () => {
+ let jar: CookieJarWrapper;
+ const testUrl = 'https://api.example.com';
+
+ beforeEach(() => {
+ jar = jarFactory();
+ // Clear all cookies before each test
+ jar.clear();
+ });
+
+ describe('Basic Cookie Operations', () => {
+ test('setCookie and getCookie - name/value pair', async () => {
+ const cookieName = 'authToken';
+ const cookieValue = 'jwt123';
+
+ // Set a cookie
+ await jar.setCookie(testUrl, cookieName, cookieValue);
+
+ // Get the cookie back
+ const cookie = (await jar.getCookie(testUrl, cookieName))!;
+ expect(cookie.key).toBe(cookieName);
+ expect(cookie.value).toBe(cookieValue);
+ expect(cookie.domain).toBe('api.example.com');
+ });
+
+ test('setCookie with cookie object', async () => {
+ const cookieObj = {
+ key: 'sessionId',
+ value: 'abc123',
+ path: '/api',
+ httpOnly: true,
+ secure: true
+ };
+
+ await jar.setCookie(testUrl, cookieObj);
+
+ const cookie = (await jar.getCookie(testUrl + '/api', 'sessionId'))!;
+ expect(cookie.key).toBe('sessionId');
+ expect(cookie.value).toBe('abc123');
+ expect(cookie.path).toBe('/api');
+ expect(cookie.httpOnly).toBe(true);
+ expect(cookie.secure).toBe(true);
+ });
+
+ test('getCookie returns null for non-existent cookie', async () => {
+ const cookie = await jar.getCookie(testUrl, 'nonexistent');
+ expect(cookie).toBeNull();
+ });
+ });
+
+ describe('Multiple Cookie Operations', () => {
+ test('setCookies with array of cookie objects', async () => {
+ const cookies = [
+ { key: 'cookie1', value: 'value1' },
+ { key: 'cookie2', value: 'value2' },
+ { key: 'cookie3', value: 'value3', httpOnly: true }
+ ];
+
+ await jar.setCookies(testUrl, cookies);
+
+ // Verify all cookies were set
+ const retrievedCookies = (await jar.getCookies(testUrl)) as Cookie[];
+ expect(retrievedCookies).toHaveLength(3);
+
+ const cookieNames = retrievedCookies.map((c: Cookie) => c.key);
+ expect(cookieNames).toContain('cookie1');
+ expect(cookieNames).toContain('cookie2');
+ expect(cookieNames).toContain('cookie3');
+ });
+
+ test('getCookies returns all cookies for URL', async () => {
+ // Set multiple cookies
+ await jar.setCookie(testUrl, 'auth', 'token123');
+ await jar.setCookie(testUrl, 'session', 'sess456');
+ await jar.setCookie(testUrl, 'prefs', 'theme=dark');
+
+ const cookies = (await jar.getCookies(testUrl)) as Cookie[];
+ expect(cookies).toHaveLength(3);
+
+ const cookieMap = (cookies as Cookie[]).reduce>((map, cookie: Cookie) => {
+ map[cookie.key] = cookie.value;
+ return map;
+ }, {} as Record);
+
+ expect(cookieMap.auth).toBe('token123');
+ expect(cookieMap.session).toBe('sess456');
+ expect(cookieMap.prefs).toBe('theme=dark');
+ });
+ });
+
+ describe('Cookie Deletion', () => {
+ test('deleteCookie removes specific cookie', async () => {
+ // Set two cookies
+ await jar.setCookie(testUrl, 'keep', 'keepValue');
+ await jar.setCookie(testUrl, 'remove', 'removeValue');
+
+ // Delete one cookie
+ await jar.deleteCookie(testUrl, 'remove');
+
+ // Verify only one cookie remains
+ const cookies = (await jar.getCookies(testUrl)) as Cookie[];
+ expect(cookies).toHaveLength(1);
+ expect(cookies[0]!.key).toBe('keep');
+ expect(cookies[0]!.value).toBe('keepValue');
+ });
+
+ test('deleteCookies removes all cookies for URL', async () => {
+ // Set multiple cookies
+ await jar.setCookie(testUrl, 'cookie1', 'value1');
+ await jar.setCookie(testUrl, 'cookie2', 'value2');
+
+ // Delete all cookies for the URL
+ await jar.deleteCookies(testUrl);
+
+ // Verify no cookies remain
+ const cookies = (await jar.getCookies(testUrl)) as Cookie[];
+ expect(cookies).toHaveLength(0);
+ });
+
+ test('clear removes all cookies from jar', async () => {
+ // Set cookies for multiple URLs
+ await jar.setCookie('https://site1.com', 'cookie1', 'value1');
+ await jar.setCookie('https://site2.com', 'cookie2', 'value2');
+
+ // Clear entire jar
+ await jar.clear();
+
+ // Verify no cookies remain for any URL
+ const cookies1 = (await jar.getCookies('https://site1.com')) as Cookie[];
+ const cookies2 = (await jar.getCookies('https://site2.com')) as Cookie[];
+
+ expect(cookies1).toHaveLength(0);
+ expect(cookies2).toHaveLength(0);
+ });
+ });
+
+ describe('Error Handling', () => {
+ test('setCookie handles missing URL', async () => {
+ await expect(jar.setCookie('', 'name', 'value')).rejects.toThrow('URL is required');
+ });
+
+ test('getCookie handles missing URL', async () => {
+ await expect(jar.getCookie('', 'name')).rejects.toThrow('URL and cookie name are required');
+ });
+
+ test('setCookies handles invalid input', async () => {
+ await expect(jar.setCookies(testUrl, 'not-an-array' as any)).rejects.toThrow('expects an array');
+ });
+
+ test('setCookie handles missing cookie name in object', async () => {
+ await expect(jar.setCookie(testUrl, { value: 'test' })).rejects.toThrow('key (name) is required');
+ });
+ });
+
+ describe('Real-world Usage Examples', () => {
+ test('Authentication workflow example', async () => {
+ const apiUrl = 'https://api.example.com';
+ const authToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+
+ // Simulate login - set auth cookie
+ await jar.setCookie(apiUrl, 'authToken', authToken);
+
+ // Later in the session - retrieve auth token
+ const cookie = (await jar.getCookie(apiUrl, 'authToken'))!;
+ expect(cookie.value).toBe(authToken);
+
+ // Simulate logout - remove auth cookie
+ await jar.deleteCookie(apiUrl, 'authToken');
+
+ // Verify cookie is gone
+ const deletedCookie = await jar.getCookie(apiUrl, 'authToken');
+ expect(deletedCookie).toBeNull();
+ });
+
+ test('Session management with multiple cookies', async () => {
+ const sessionUrl = 'https://app.example.com';
+
+ // Set session cookies
+ const sessionCookies = [
+ { key: 'sessionId', value: 'sess_123', httpOnly: true },
+ { key: 'csrfToken', value: 'csrf_456' },
+ { key: 'userPrefs', value: JSON.stringify({ theme: 'dark', lang: 'en' }) }
+ ];
+
+ await jar.setCookies(sessionUrl, sessionCookies);
+
+ // Retrieve all session cookies
+ const cookies = (await jar.getCookies(sessionUrl)) as Cookie[];
+ expect(cookies).toHaveLength(3);
+
+ // Find specific cookies
+ const sessionCookie = cookies.find((c: Cookie) => c.key === 'sessionId')!;
+ const csrfCookie = cookies.find((c: Cookie) => c.key === 'csrfToken')!;
+ const prefsCookie = cookies.find((c: Cookie) => c.key === 'userPrefs')!;
+
+ expect(sessionCookie.value).toBe('sess_123');
+ expect(sessionCookie.httpOnly).toBe(true);
+ expect(csrfCookie.value).toBe('csrf_456');
+
+ const prefs = JSON.parse(prefsCookie.value);
+ expect(prefs.theme).toBe('dark');
+ expect(prefs.lang).toBe('en');
+ });
+
+ test('Cookie path handling', async () => {
+ const baseUrl = 'https://example.com';
+
+ // Set cookies with different paths
+ await jar.setCookie(baseUrl, { key: 'global', value: 'global_val', path: '/' });
+ await jar.setCookie(baseUrl, { key: 'api', value: 'api_val', path: '/api' });
+ await jar.setCookie(baseUrl, { key: 'admin', value: 'admin_val', path: '/admin' });
+
+ const rootCookies = (await jar.getCookies(baseUrl + '/')) as Cookie[];
+ const globalCookie = rootCookies.find((c: Cookie) => c.key === 'global')!;
+ expect(globalCookie).toBeTruthy();
+ expect(globalCookie.value).toBe('global_val');
+
+ const apiCookies = (await jar.getCookies(baseUrl + '/api/users')) as Cookie[];
+ expect(apiCookies.length).toBeGreaterThanOrEqual(2);
+
+ const apiCookieNames = apiCookies.map((c: Cookie) => c.key);
+ expect(apiCookieNames).toContain('global');
+ expect(apiCookieNames).toContain('api');
+ });
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-requests/src/cookies/index.ts b/packages/bruno-requests/src/cookies/index.ts
new file mode 100644
index 000000000..dfd9482bc
--- /dev/null
+++ b/packages/bruno-requests/src/cookies/index.ts
@@ -0,0 +1,505 @@
+import { Cookie, CookieJar } from 'tough-cookie';
+import each from 'lodash/each';
+import moment from 'moment';
+import { isPotentiallyTrustworthyOrigin } from '../utils/url-validation';
+
+const cookieJar = new CookieJar();
+
+const addCookieToJar = (setCookieHeader: string, requestUrl: string): void => {
+ const cookie = Cookie.parse(setCookieHeader, { loose: true });
+ if (!cookie) return;
+ cookieJar.setCookieSync(cookie, requestUrl, {
+ ignoreError: true
+ });
+};
+
+const getCookiesForUrl = (url: string) => {
+ return cookieJar.getCookiesSync(url, {
+ secure: isPotentiallyTrustworthyOrigin(url),
+ } as any);
+};
+
+const getCookieStringForUrl = (url: string): string => {
+ const cookies = getCookiesForUrl(url);
+ if (!Array.isArray(cookies) || !cookies.length) return '';
+
+ const validCookies = cookies.filter((cookie: any) => !cookie.expires || (cookie.expires as any) > Date.now());
+ return validCookies.map((cookie) => cookie.cookieString()).join('; ');
+};
+
+const getDomainsWithCookies = (): Promise> => {
+ return new Promise((resolve, reject) => {
+ const domainCookieMap: Record = {};
+
+ (cookieJar as any).store.getAllCookies((err: Error, cookies: Cookie[]) => {
+ if (err) return reject(err);
+
+ cookies.forEach((cookie) => {
+ // Handle null domain by skipping the cookie
+ if (!cookie.domain) return;
+
+ if (!domainCookieMap[cookie.domain]) {
+ domainCookieMap[cookie.domain] = [cookie];
+ } else {
+ domainCookieMap[cookie.domain].push(cookie);
+ }
+ });
+
+ const domains = Object.keys(domainCookieMap);
+ const domainsWithCookies: Array<{ domain: string; cookies: Cookie[]; cookieString: string }> = [];
+
+ each(domains, (domain) => {
+ const cookiesForDomain = domainCookieMap[domain];
+ const validCookies = cookiesForDomain.filter((cookie: any) => !cookie.expires || (cookie.expires as any) > Date.now());
+
+ if (validCookies.length) {
+ domainsWithCookies.push({
+ domain,
+ cookies: validCookies,
+ cookieString: validCookies.map((cookie) => cookie.cookieString()).join('; ')
+ });
+ }
+ });
+
+ resolve(domainsWithCookies);
+ });
+ });
+};
+
+const deleteCookie = (domain: string, path: string, cookieKey: string): Promise => {
+ return new Promise((resolve, reject) => {
+ (cookieJar as any).store.removeCookie(domain, path, cookieKey, (err: Error) => {
+ if (err) return reject(err);
+ resolve();
+ });
+ });
+};
+
+const deleteCookiesForDomain = (domain: string): Promise => {
+ return new Promise((resolve, reject) => {
+ (cookieJar as any).store.removeCookies(domain, null, (err: Error) => {
+ if (err) return reject(err);
+ resolve();
+ });
+ });
+};
+
+const updateCookieObj = (cookieObj: any, oldCookie: Cookie) => {
+ return {
+ ...cookieObj,
+ path: oldCookie.path,
+ key: oldCookie.key,
+ domain: oldCookie.domain,
+ expires: cookieObj?.expires && moment(cookieObj.expires).isValid() ? new Date(cookieObj.expires) : Infinity,
+ creation: oldCookie?.creation && moment(oldCookie.creation).isValid() ? new Date(oldCookie.creation) : new Date(),
+ lastAccessed:
+ oldCookie?.lastAccessed && moment(oldCookie.lastAccessed).isValid()
+ ? new Date(oldCookie.lastAccessed)
+ : new Date()
+ } as any;
+};
+
+const createCookieObj = (cookieObj: any) => {
+ return {
+ ...cookieObj,
+ path: cookieObj.path,
+ expires: cookieObj?.expires && moment(cookieObj.expires).isValid() ? new Date(cookieObj.expires) : Infinity,
+ creation: cookieObj?.creation && moment(cookieObj.creation).isValid() ? new Date(cookieObj.creation) : new Date(),
+ lastAccessed:
+ cookieObj?.lastAccessed && moment(cookieObj.lastAccessed).isValid()
+ ? new Date(cookieObj.lastAccessed)
+ : new Date()
+ } as any;
+};
+
+const addCookieForDomain = (domain: string, cookieObj: any): Promise => {
+ return new Promise((resolve, reject) => {
+ try {
+ const cookie = new Cookie(createCookieObj(cookieObj));
+ (cookieJar as any).store.putCookie(cookie, (err: Error) => {
+ if (err) return reject(err);
+ resolve();
+ });
+ } catch (err) {
+ reject(err);
+ }
+ });
+};
+
+const modifyCookieForDomain = (domain: string, oldCookieObj: any, cookieObj: any): Promise => {
+ return new Promise((resolve, reject) => {
+ try {
+ const oldCookie = new Cookie(createCookieObj(oldCookieObj));
+ const newCookie = new Cookie(updateCookieObj(cookieObj, oldCookie));
+ (cookieJar as any).store.updateCookie(oldCookie, newCookie, (removeErr: Error) => {
+ if (removeErr) return reject(removeErr);
+ resolve();
+ });
+ } catch (err) {
+ reject(err);
+ }
+ });
+};
+
+const parseCookieString = (cookieStr: string): any | null => {
+ try {
+ const cookie = Cookie.parse(cookieStr);
+ if (!cookie) return null;
+ return {
+ ...cookie,
+ expires: cookie.expires === 'Infinity' || (cookie.expires as any) === Infinity ? null : cookie.expires
+ };
+ } catch (err) {
+ throw err;
+ }
+};
+
+const createCookieString = (cookieObj: any): string => {
+ const cookie = new Cookie(createCookieObj(cookieObj));
+ let cookieString = cookie.toString(); // tough-cookie omits domain
+
+ // Manually append domain if cookie is hostOnly but we still want Domain flag
+ if (cookieObj.hostOnly && !cookieString.includes('Domain=')) {
+ cookieString += `; Domain=${cookieObj.domain}`;
+ }
+ return cookieString;
+}
+
+const saveCookies = (url: string, headers: any) => {
+ if (headers['set-cookie']) {
+ let setCookieHeaders = Array.isArray(headers['set-cookie'])
+ ? headers['set-cookie']
+ : [headers['set-cookie']];
+ for (let setCookieHeader of setCookieHeaders) {
+ if (typeof setCookieHeader === 'string' && setCookieHeader.length) {
+ addCookieToJar(setCookieHeader, url);
+ }
+ }
+ }
+};
+
+const cookieJarWrapper = () => {
+ return {
+
+ // Get the full cookie object for the given URL & name.
+ getCookie: function (
+ url: string,
+ cookieName: string,
+ callback?: (err: Error | null | undefined, cookie?: Cookie | null) => void
+ ) {
+ if (!url || !cookieName) {
+ const error = new Error('URL and cookie name are required');
+ if (callback) return callback(error);
+ return Promise.reject(error);
+ }
+
+ if (callback) {
+ // Callback mode
+ return cookieJar.getCookies(url, (err: Error | null, cookies?: Cookie[]) => {
+ if (err) return callback(err);
+ const cookieList = cookies || [];
+ const cookie = cookieList.find((c) => c.key === cookieName);
+ callback(null, cookie || null);
+ });
+ }
+
+ // Promise mode
+ return new Promise((resolve, reject) => {
+ cookieJar.getCookies(url, (err: Error | null, cookies?: Cookie[]) => {
+ if (err) return reject(err);
+ const cookieList = cookies || [];
+ const cookie = cookieList.find((c) => c.key === cookieName);
+ resolve(cookie || null);
+ });
+ });
+ },
+
+ // Get all cookies that would be sent to the given URL.
+ getCookies: function (url: string, callback?: (err: Error | null | undefined, cookies?: Cookie[]) => void) {
+ if (!url) {
+ const error = new Error('URL is required');
+ if (callback) return callback(error);
+ return Promise.reject(error);
+ }
+
+ if (callback) {
+ // Callback mode
+ return cookieJar.getCookies(url, callback as any);
+ }
+
+ // Promise mode
+ return new Promise((resolve, reject) => {
+ cookieJar.getCookies(url, (err: Error | null, cookies?: Cookie[]) => {
+ if (err) return reject(err);
+ resolve(cookies || []);
+ });
+ });
+ },
+
+ setCookie: function (
+ url: string,
+ nameOrCookieObj: string | Record,
+ valueOrCallback?: string | ((err?: Error | undefined) => void),
+ maybeCallback?: (err?: Error | undefined) => void
+ ) {
+ // Determine the callback
+ let callback: ((err?: Error | undefined) => void) | undefined;
+ if (typeof maybeCallback === 'function') {
+ callback = maybeCallback;
+ } else if (typeof valueOrCallback === 'function') {
+ callback = valueOrCallback as (err?: Error | undefined) => void;
+ }
+
+ const executeSetCookie = () => {
+ if (!url) throw new Error('URL is required');
+
+ // CASE 1: name/value pair provided
+ if (typeof nameOrCookieObj === 'string') {
+ const cookieName = nameOrCookieObj;
+ const cookieValue = typeof valueOrCallback === 'string' ? valueOrCallback : '';
+
+ if (!cookieName) throw new Error('Cookie name is required');
+
+ const cookie = new Cookie({
+ key: cookieName,
+ value: cookieValue,
+ domain: new URL(url).hostname,
+ });
+
+ cookieJar.setCookieSync(cookie, url, { ignoreError: true });
+ return;
+ }
+
+ // CASE 2: cookie object provided
+ if (typeof nameOrCookieObj === 'object' && nameOrCookieObj !== null) {
+ const obj = { ...(nameOrCookieObj as any) } as any;
+
+ if (!obj.key && obj.name) obj.key = obj.name;
+ if (!obj.key) throw new Error('cookieObject.key (name) is required');
+
+ const base = {
+ domain: new URL(url).hostname,
+ ...obj,
+ } as any;
+
+ const processedCookie = createCookieObj(base);
+ const cookie = new Cookie(processedCookie);
+ cookieJar.setCookieSync(cookie, url, { ignoreError: true });
+ return;
+ }
+
+ // If we reach here, arguments were invalid
+ throw new Error('Invalid arguments passed to setCookie');
+ };
+
+ if (callback) {
+ // Callback mode
+ try {
+ executeSetCookie();
+ callback(undefined);
+ } catch (err) {
+ callback(err as Error);
+ }
+ return;
+ }
+
+ // Promise mode
+ return new Promise((resolve, reject) => {
+ try {
+ executeSetCookie();
+ resolve();
+ } catch (err) {
+ reject(err);
+ }
+ });
+ },
+
+
+ setCookies: function (
+ url: string,
+ cookiesArray: any[],
+ callback?: (err?: Error | undefined) => void
+ ) {
+ const executeSetCookies = () => {
+ if (!url) throw new Error('URL is required');
+ if (!Array.isArray(cookiesArray)) {
+ throw new Error('setCookies expects an array of cookie objects');
+ }
+
+ for (const cookieObject of cookiesArray) {
+ const obj = { ...(cookieObject as any) } as any;
+
+ if (!obj.key && obj.name) obj.key = obj.name;
+ if (!obj.key) throw new Error('cookieObject.key (name) is required');
+
+ const base = {
+ domain: new URL(url).hostname,
+ ...obj
+ } as any;
+
+ const processedCookie = createCookieObj(base);
+ const cookie = new Cookie(processedCookie);
+ cookieJar.setCookieSync(cookie, url, { ignoreError: true });
+ }
+ };
+
+ if (callback) {
+ // Callback mode
+ try {
+ executeSetCookies();
+ callback(undefined);
+ } catch (err) {
+ callback(err as Error);
+ }
+ return;
+ }
+
+ // Promise mode
+ return new Promise((resolve, reject) => {
+ try {
+ executeSetCookies();
+ resolve();
+ } catch (err) {
+ reject(err);
+ }
+ });
+ },
+
+
+ clear: function (callback?: (err?: Error | undefined) => void) {
+ if (callback) {
+ // Callback mode
+ return (cookieJar as any).store.removeAllCookies(callback);
+ }
+
+ // Promise mode
+ return new Promise((resolve, reject) => {
+ (cookieJar as any).store.removeAllCookies((err?: Error) => {
+ if (err) reject(err);
+ else resolve();
+ });
+ });
+ },
+
+ deleteCookies: function (url: string, callback?: (err?: Error | undefined) => void) {
+ if (!url) {
+ const error = new Error('URL is required');
+ if (callback) return callback(error);
+ return Promise.reject(error);
+ }
+
+ if (callback) {
+ // Callback mode
+ return cookieJar.getCookies(url, (err: Error | null, cookies?: Cookie[]) => {
+ if (err) return callback(err);
+ const cookieList = cookies || [];
+ if (!cookieList.length) return callback(undefined);
+
+ let pending = cookieList.length;
+ const done = (removeErr?: Error) => {
+ if (removeErr) return callback(removeErr);
+ if (--pending === 0) {
+ callback(undefined);
+ }
+ };
+
+ cookieList.forEach((cookie) => {
+ (cookieJar as any).store.removeCookie(cookie.domain, cookie.path, cookie.key, done);
+ });
+ });
+ }
+
+ // Promise mode
+ return new Promise((resolve, reject) => {
+ cookieJar.getCookies(url, (err: Error | null, cookies?: Cookie[]) => {
+ if (err) return reject(err);
+ const cookieList = cookies || [];
+ if (!cookieList.length) return resolve();
+
+ let pending = cookieList.length;
+ const done = (removeErr?: Error) => {
+ if (removeErr) return reject(removeErr);
+ if (--pending === 0) {
+ resolve();
+ }
+ };
+
+ cookieList.forEach((cookie) => {
+ (cookieJar as any).store.removeCookie(cookie.domain, cookie.path, cookie.key, done);
+ });
+ });
+ });
+ },
+
+ deleteCookie: function (url: string, cookieName: string, callback?: (err?: Error | undefined) => void) {
+ if (!url || !cookieName) {
+ const error = new Error('URL and cookie name are required');
+ if (callback) return callback(error);
+ return Promise.reject(error);
+ }
+
+ const executeDelete = (callback: (err?: Error) => void) => {
+ cookieJar.getCookies(url, (err: Error | null, cookies?: Cookie[]) => {
+ if (err) return callback(err);
+
+ // Filter cookies matching key
+ const cookieList = cookies || [];
+ const matchingCookies = cookieList.filter((c) => c.key === cookieName);
+ if (!matchingCookies.length) return callback(undefined);
+
+ const urlPath = new URL(url).pathname || '/';
+
+ // Prioritise a cookie whose path exactly matches the URL path
+ let cookieToDelete = matchingCookies.find((c) => c.path === urlPath);
+
+ // If not found, fall back to the first matching cookie (most specific path first)
+ if (!cookieToDelete) {
+ // tough-cookie sorts cookies by path length desc, preserve that order
+ cookieToDelete = matchingCookies[0];
+ }
+
+ (cookieJar as any).store.removeCookie(
+ cookieToDelete.domain,
+ cookieToDelete.path,
+ cookieToDelete.key,
+ callback
+ );
+ });
+ };
+
+ if (callback) {
+ // Callback mode
+ return executeDelete(callback);
+ }
+
+ // Promise mode
+ return new Promise((resolve, reject) => {
+ executeDelete((err?: Error) => {
+ if (err) reject(err);
+ else resolve();
+ });
+ });
+ }
+ } as const;
+};
+
+
+const cookiesModule = {
+ cookieJar,
+ addCookieToJar,
+ getCookiesForUrl,
+ getCookieStringForUrl,
+ getDomainsWithCookies,
+ deleteCookie,
+ deleteCookiesForDomain,
+ addCookieForDomain,
+ modifyCookieForDomain,
+ parseCookieString,
+ createCookieString,
+ updateCookieObj,
+ createCookieObj,
+ jar: cookieJarWrapper,
+ saveCookies
+};
+
+export default cookiesModule;
\ No newline at end of file
diff --git a/packages/bruno-requests/src/grpc/grpc-client.js b/packages/bruno-requests/src/grpc/grpc-client.js
new file mode 100644
index 000000000..ab4c6cac1
--- /dev/null
+++ b/packages/bruno-requests/src/grpc/grpc-client.js
@@ -0,0 +1,845 @@
+import { makeGenericClientConstructor, ChannelCredentials, Metadata } from '@grpc/grpc-js';
+import * as grpcReflection from 'grpc-reflection-js';
+import * as protoLoader from '@grpc/proto-loader';
+import { generateGrpcSampleMessage } from './grpcMessageGenerator';
+import * as tls from 'tls';
+import { isString } from 'lodash';
+import * as nodePath from 'node:path';
+
+/**
+ * Configuration options for loading and parsing Protocol Buffers definitions.
+ * These options are passed to @grpc/proto-loader and protobufjs.
+ * @type {import('@grpc/proto-loader').Options}
+ */
+const configOptions = {
+ keepCase: true,
+ alternateCommentMode: true,
+ preferTrailingComment: true,
+ /**
+ * Long conversion type.
+ * Valid values are `String` and `Number` (the global types).
+ * Defaults to copy the present value, which is a possibly unsafe number without and a {@link Long} with a long library.
+ *
+ * JavaScript's Number type can only safely represent integers up to 2^53 - 1 (Number.MAX_SAFE_INTEGER).
+ * Since gRPC's int64, uint64, sint64, and fixed64 types can exceed this limit, we convert them to strings
+ * to preserve their full precision.
+ */
+ longs: String,
+ enums: String,
+ bytes: String,
+ defaults: true,
+ arrays: false,
+ objects: false,
+ oneofs: true,
+ json: true
+};
+
+const replaceTabsWithSpaces = (str, numSpaces = 2) => {
+ if (!str || !str.length || !isString(str)) {
+ return '';
+ }
+
+ return str.replaceAll('\t', ' '.repeat(numSpaces)).replaceAll('\n', '');
+};
+
+const ensureBuffer = (data) => {
+ if (Buffer.isBuffer(data)) {
+ return data;
+ }
+ return Buffer.from(data, 'utf-8');
+};
+
+/**
+ * Safely parse JSON string with error handling
+ * @param {string} jsonString - The JSON string to parse
+ * @param {string} context - Context for error messages (e.g., 'message content', 'request body')
+ * @returns {Object} Parsed object or throws error with context
+ * @throws {Error} If JSON parsing fails
+ */
+const safeJsonParse = (jsonString, context = 'JSON string') => {
+ try {
+ return JSON.parse(jsonString);
+ } catch (error) {
+ const errorMessage = `Failed to parse ${context}: ${error.message}`;
+ console.error(errorMessage, { originalString: jsonString, parseError: error });
+ throw new Error(errorMessage);
+ }
+}
+
+const processGrpcMetadata = (metadata) => {
+ return Object.entries(metadata).map(([name, value]) => {
+ if (Array.isArray(value)) {
+ return {
+ name,
+ value: value
+ .map((v) => {
+ if (v && typeof v === 'object' && v.type === 'Buffer' && Array.isArray(v.data)) {
+ return Buffer.from(v.data).toString('base64');
+ }
+ return v.toString();
+ })
+ .join(', ')
+ };
+ }
+ if (value && typeof value === 'object' && value.type === 'Buffer' && Array.isArray(value.data)) {
+ return { name, value: Buffer.from(value.data).toString('base64') };
+ }
+ return { name, value: value.toString() };
+ });
+};
+
+const getParsedGrpcUrlObject = (url) => {
+ const isUnixSocket = (str) => str.startsWith('unix:');
+ //const isXdsUrl = str => str.startsWith('xds:');
+ // By default, secure protocol grpcs is set if not specified, localhost is set to insecure (grpc://)
+ const addProtocolIfMissing = (str) => {
+ if (str.includes('://')) return str;
+
+ // For localhost, default to insecure (grpc://) for local development
+ if (str.includes('localhost') || str.includes('127.0.0.1')) {
+ return `grpc://${str}`;
+ }
+
+ // For other hosts, default to secure
+ return `grpcs://${str}`;
+ };
+ const removeTrailingSlash = (str) => (str.endsWith('/') ? str.slice(0, -1) : str);
+
+ if (!url) return { host: '', path: '' };
+ if (isUnixSocket(url)) return { host: url, path: '' };
+ // if (isXdsUrl(url)) return { host: url, path: '' }; /* TODO: add xds support, https://www.npmjs.com/package/@grpc/grpc-js-xds */
+
+ const urlObj = new URL(addProtocolIfMissing(url.toLowerCase()));
+
+ return {
+ host: urlObj.host,
+ protocol: urlObj.protocol.replace(':', ''),
+ path: removeTrailingSlash(urlObj.pathname)
+ };
+};
+
+/**
+ * Handles gRPC events and forwards them using the provided callback
+ * @param {Function} callback - Callback function to send events
+ * @param {string} requestId - The unique ID of the request
+ * @param {string} collectionUid - The collection UID
+ * @param {Object} rpc - The gRPC object
+ */
+const setupGrpcEventHandlers = (callback, requestId, collectionUid, rpc) => {
+ rpc.on('status', (status, res) => {
+ const statusWithMetadata = {
+ ...status,
+ metadata: processGrpcMetadata(status.metadata.getMap ? status.metadata.getMap() : status.metadata)
+ };
+ callback('grpc:status', requestId, collectionUid, { status: statusWithMetadata, res });
+ });
+
+ rpc.on('error', (error) => {
+ const errorWithMetadata = {
+ ...error,
+ metadata: processGrpcMetadata(error.metadata.getMap ? error.metadata.getMap() : error.metadata)
+ };
+ callback('grpc:error', requestId, collectionUid, { error: errorWithMetadata });
+ });
+
+ rpc.on('end', (res) => {
+ callback('grpc:server-end-stream', requestId, collectionUid, { res });
+ const channel = rpc?.call?.channel;
+ if (channel) channel.close();
+ });
+
+ rpc.on('data', (res) => {
+ callback('grpc:response', requestId, collectionUid, { error: null, res });
+ });
+
+ rpc.on('cancel', (res) => {
+ callback('grpc:server-cancel-stream', requestId, collectionUid, { res });
+
+ const channel = rpc?.call?.channel;
+ if (channel) channel.close();
+ });
+
+ rpc.on('metadata', (metadata) => {
+ const metadataWithProcessed = processGrpcMetadata(metadata.getMap ? metadata.getMap() : metadata);
+ callback('grpc:metadata', requestId, collectionUid, { metadata: metadataWithProcessed });
+ });
+};
+
+class GrpcClient {
+ constructor(eventCallback) {
+ this.activeConnections = new Map();
+ this.methods = new Map();
+ this.eventCallback = eventCallback;
+ }
+
+ /**
+ * Get method type based on streaming configuration
+ */
+ #getMethodType({ requestStream, responseStream }) {
+ if (requestStream && responseStream) return 'bidi-streaming';
+ if (requestStream) return 'client-streaming';
+ if (responseStream) return 'server-streaming';
+ return 'unary';
+ }
+
+ /**
+ * @typedef {(hostname: string, cert: Object) => Error|undefined} CheckServerIdentityCallback
+ * Callback for custom server certificate verification
+ */
+
+ /**
+ * @typedef {Object} VerifyOptions
+ * @property {CheckServerIdentityCallback} [checkServerIdentity] - If set, this callback will be
+ * invoked after the usual hostname verification has been performed on the peer certificate.
+ * @property {boolean} [rejectUnauthorized] - Whether to reject connections if the certificate validation fails
+ */
+
+ /**
+ * Return a new ChannelCredentials instance with a given set of credentials.
+ * The resulting instance can be used to construct a Channel that communicates
+ * over TLS.
+ * @param {string} url - The gRPC server URL
+ * @param {string|null} rootCertificate - The root certificate data (CA certificate)
+ * @param {string|null} privateKey - The client certificate private key, if available
+ * @param {string|null} certificateChain - The client certificate key chain, if available
+ * @param {string|null} passphrase - The passphrase for the private key, if available
+ * @param {string|null} pfx - The PFX/P12 certificate data, if available
+ * @param {VerifyOptions} verifyOptions - Additional options for verifying the server certificate
+ * @returns {import('@grpc/grpc-js').ChannelCredentials} The gRPC channel credentials
+ */
+ #getChannelCredentials({ url, rootCertificate, privateKey, certificateChain, passphrase, pfx, verifyOptions }) {
+ const securedProtocols = ['grpcs', 'https'];
+ try {
+ const { protocol } = getParsedGrpcUrlObject(url);
+ const isSecureConnection = securedProtocols.some((sp) => protocol === sp);
+ if (!isSecureConnection) {
+ return ChannelCredentials.createInsecure();
+ }
+
+ const rootCertBuffer = rootCertificate ? ensureBuffer(rootCertificate) : null;
+ const clientCertBuffer = certificateChain ? ensureBuffer(certificateChain) : null;
+ const privateKeyBuffer = privateKey ? ensureBuffer(privateKey) : null;
+ const pfxBuffer = pfx ? ensureBuffer(pfx) : null;
+
+ // Create proper SSL credentials with correct options
+ const sslOptions = {
+ ...(verifyOptions || {}),
+ // Default to true if not specified
+ rejectUnauthorized: verifyOptions?.rejectUnauthorized !== false
+ };
+
+ const shouldUseSecureContext = pfxBuffer || passphrase;
+
+ if (shouldUseSecureContext) {
+ const secureContext = tls.createSecureContext({
+ ca: rootCertBuffer,
+ key: privateKeyBuffer,
+ cert: clientCertBuffer,
+ pfx: pfxBuffer,
+ passphrase: passphrase
+ });
+ return ChannelCredentials.createFromSecureContext(secureContext, sslOptions);
+ }
+
+ const credentials = ChannelCredentials.createSsl(rootCertBuffer, privateKeyBuffer, clientCertBuffer, sslOptions);
+
+ return credentials;
+ } catch (error) {
+ console.error('Error creating channel credentials:', error);
+ // Default to insecure as fallback
+ return ChannelCredentials.createInsecure();
+ }
+ }
+
+ /**
+ * Get method from the path
+ */
+ #getMethodFromPath(path) {
+ if (this.methods.has(path)) {
+ return this.methods.get(path);
+ }
+ throw new Error(`Method ${path} not found, please refresh the methods`);
+ }
+
+ /**
+ * Refresh methods using reflection or proto file as fallback
+ * @param {Object} options - Options for refreshing methods
+ * @param {string} options.url - The gRPC server URL
+ * @param {Object} options.headers - The request headers/metadata
+ * @param {string} [options.protoPath] - Path to proto file if available
+ * @param {string} [options.collectionPath] - Collection path for proto file resolution
+ * @param {string} [options.collectionUid] - Collection UID
+ * @param {Object} [options.certificates] - Certificate configuration
+ * @param {Object} [options.verifyOptions] - Additional options for verifying the server certificate
+ * @returns {Promise} Whether methods were successfully refreshed
+ * @private
+ */
+ async #refreshMethods({ url, headers, protoPath, collectionPath, collectionUid, certificates = {}, verifyOptions }) {
+ try {
+ // Try reflection first if no proto path is specified
+ if (!protoPath) {
+ await this.loadMethodsFromReflection({
+ request: { url, headers },
+ collectionUid,
+ rootCertificate: certificates.ca,
+ privateKey: certificates.key,
+ certificateChain: certificates.cert,
+ passphrase: certificates.passphrase,
+ pfx: certificates.pfx,
+ verifyOptions,
+ sendEvent: () => {} // No-op for refresh
+ });
+ return true;
+ }
+
+ // Try proto file if available
+ if (protoPath) {
+ const absoluteProtoPath = nodePath.join(collectionPath, protoPath);
+ await this.loadMethodsFromProtoFile(absoluteProtoPath, []);
+ return true;
+ }
+
+ return false;
+ } catch (error) {
+ console.error('Failed to refresh methods:', error);
+ return false;
+ }
+ }
+
+ /**
+ * Handle connection
+ * @param {Object} options - The options for the connection
+ * @param {import('@grpc/grpc-js/src/make-client').ServiceClient} options.client - The client instance
+ * @param {string} options.requestId - The request ID
+ * @param {string} options.collectionUid - The collection UID
+ * @param {string} options.requestPath - The request path
+ * @param {Object} options.method - The method object
+ * @param {Object} options.messages - The messages []
+ * @param {Object} options.metadata - The metadata object
+ */
+ #handleConnection(options) {
+ const methodType = this.#getMethodType(options.method);
+ switch (methodType) {
+ case 'unary':
+ this.#handleUnaryResponse(options);
+ break;
+ case 'client-streaming':
+ this.#handleClientStreamingResponse(options);
+ break;
+ case 'server-streaming':
+ this.#handleServerStreamingResponse(options);
+ break;
+ case 'bidi-streaming':
+ this.#handleBidiStreamingResponse(options);
+ break;
+ default:
+ throw new Error(`Unsupported method type: ${methodType}`);
+ }
+ }
+
+ /**
+ * Handle unary responses
+ */
+ #handleUnaryResponse({ client, requestId, requestPath, method, messages, metadata, collectionUid }) {
+ const rpc = client.makeUnaryRequest(
+ requestPath,
+ method.requestSerialize,
+ method.responseDeserialize,
+ messages[0],
+ metadata,
+ (error, res) => {
+ this.eventCallback('grpc:response', requestId, collectionUid, { error, res });
+ }
+ );
+
+ setupGrpcEventHandlers(this.eventCallback, requestId, collectionUid, rpc);
+ }
+
+ #handleClientStreamingResponse({ client, requestId, requestPath, method, metadata, collectionUid }) {
+ const rpc = client.makeClientStreamRequest(
+ requestPath,
+ method.requestSerialize,
+ method.responseDeserialize,
+ metadata,
+ (error, res) => {
+ this.eventCallback('grpc:response', requestId, collectionUid, { error, res });
+ }
+ );
+ this.#addConnection(requestId, rpc);
+
+ setupGrpcEventHandlers(this.eventCallback, requestId, collectionUid, rpc);
+ }
+
+ #handleServerStreamingResponse({ client, requestId, requestPath, method, messages, metadata, collectionUid }) {
+ const message = messages[0];
+ const rpc = client.makeServerStreamRequest(
+ requestPath,
+ method.requestSerialize,
+ method.responseDeserialize,
+ message,
+ metadata,
+ (error, res) => {
+ this.eventCallback('grpc:response', requestId, collectionUid, { error, res });
+ }
+ );
+ this.#addConnection(requestId, rpc);
+
+ setupGrpcEventHandlers(this.eventCallback, requestId, collectionUid, rpc);
+ }
+
+ #handleBidiStreamingResponse({ client, requestId, requestPath, method, messages, metadata, collectionUid }) {
+ const rpc = client.makeBidiStreamRequest(
+ requestPath,
+ method.requestSerialize,
+ method.responseDeserialize,
+ metadata
+ );
+ this.#addConnection(requestId, rpc);
+
+ setupGrpcEventHandlers(this.eventCallback, requestId, collectionUid, rpc);
+ }
+
+ /**
+ * Starts a gRPC connection and handles the request based on the method type.
+ * This method sets up the connection, creates the client, and initiates the appropriate
+ * request handling based on whether it's unary, server streaming, client streaming, or bidirectional streaming.
+ *
+ * @param {Object} params - The parameters for starting the connection
+ * @param {Object} params.request - The gRPC request object
+ * @param {string} params.request.url - The gRPC server URL (e.g., 'grpc://localhost:50051')
+ * @param {string} params.request.method - The full method path (e.g., '/package.Service/Method')
+ * @param {Object} params.request.body - The request body containing gRPC messages
+ * @param {Object} params.request.headers - The request headers/metadata
+ * @param {Object} params.collection - The collection object containing the request
+ * @param {string} [params.certificateChain] - The client certificate chain for TLS
+ * @param {string} [params.privateKey] - The client private key for TLS
+ * @param {string} [params.rootCertificate] - The root/CA certificate for TLS
+ * @param {string} [params.passphrase] - The passphrase for the private key if encrypted
+ * @param {string} [params.pfx] - The PFX/P12 certificate data
+ * @param {Object} [params.verifyOptions] - Additional options for verifying the server certificate
+ * @param {import('@grpc/grpc-js').ChannelOptions} [params.channelOptions] - Additional options for the gRPC channel
+ */
+ async startConnection({
+ request,
+ collection,
+ certificateChain,
+ privateKey,
+ rootCertificate,
+ passphrase,
+ pfx,
+ verifyOptions,
+ channelOptions = {}
+ }) {
+ const credentials = this.#getChannelCredentials({
+ url: request.url,
+ rootCertificate,
+ privateKey,
+ certificateChain,
+ passphrase,
+ pfx,
+ verifyOptions
+ });
+ const { host, path } = getParsedGrpcUrlObject(request.url);
+ const methodPath = request.method;
+
+ let method;
+ try {
+ method = this.#getMethodFromPath(methodPath);
+ } catch (error) {
+
+ /* Attempt to refresh methods as fallback
+ * In an ideal case, the stored metadata from local storage should be received from the client side,
+ * however, this approach causes serialization failure as the method definition loses its requestSerialize function while saving to local storage
+ * so we are using reflection as a fallback
+ */
+ const refreshSuccess = await this.#refreshMethods({
+ url: request.url,
+ headers: request.headers,
+ protoPath: request.protoPath,
+ collectionPath: collection.pathname,
+ collectionUid: collection.uid,
+ certificates: {
+ ca: rootCertificate,
+ cert: certificateChain,
+ key: privateKey,
+ passphrase,
+ pfx
+ },
+ verifyOptions
+ });
+
+ if (!refreshSuccess) {
+ throw new Error(`Failed to refresh methods and method ${methodPath} not found`);
+ }
+
+ // Try to get the method again after refresh
+ try {
+ method = this.#getMethodFromPath(methodPath);
+ } catch (refreshError) {
+ throw refreshError;
+ }
+ }
+
+ const Client = makeGenericClientConstructor({});
+ const client = new Client(host, credentials, channelOptions);
+ if (!client) {
+ throw new Error('Failed to create client');
+ }
+
+ let messages = request.body.grpc;
+ try {
+ messages = messages.map(({ content }) => safeJsonParse(content, 'message content'));
+ } catch (parseError) {
+ console.error('Failed to parse gRPC message content:', parseError);
+ this.eventCallback('grpc:error', request.uid, collection.uid, {
+ error: parseError
+ });
+ return; // Exit early to prevent sending invalid data
+ }
+
+ const requestPath = path + methodPath;
+ const requestId = request.uid;
+ const collectionUid = collection.uid;
+ const metadata = new Metadata();
+ Object.entries(request.headers).forEach(([name, value]) => {
+ metadata.add(name, value);
+ });
+
+ this.#handleConnection({
+ client,
+ requestId,
+ collectionUid,
+ requestPath,
+ method,
+ messages,
+ metadata
+ });
+ }
+
+ /**
+ * Send a message to an active gRPC connection
+ * @param {string} requestId - The request ID of the active connection
+ * @param {string} collectionUid - The collection UID for the request
+ * @param {Object|string} body - The message body to send, can be a JSON object or a string
+ */
+ sendMessage(requestId, collectionUid, body) {
+ const connection = this.activeConnections.get(requestId);
+
+ if (connection) {
+ let parsedBody;
+
+ // Parse the body if it's a string, with error handling
+ if (typeof body === 'string') {
+ try {
+ parsedBody = safeJsonParse(body, 'request body');
+ } catch (parseError) {
+ // Log the error and notify the client
+ console.error('Failed to parse message body:', parseError);
+ this.eventCallback('grpc:error', requestId, collectionUid, {
+ error: parseError
+ });
+ return; // Exit early to prevent sending invalid data
+ }
+ } else {
+ parsedBody = body;
+ }
+
+ connection.write(parsedBody, (error) => {
+ if (error) {
+ this.eventCallback('grpc:error', requestId, collectionUid, { error });
+ }
+ });
+ }
+ }
+
+ /**
+ * Load methods from server reflection
+ */
+ async loadMethodsFromReflection({
+ request,
+ collectionUid,
+ rootCertificate,
+ privateKey,
+ certificateChain,
+ passphrase,
+ pfx,
+ verifyOptions,
+ sendEvent
+ }) {
+ const credentials = this.#getChannelCredentials({
+ url: request.url,
+ rootCertificate,
+ privateKey,
+ certificateChain,
+ passphrase,
+ pfx,
+ verifyOptions
+ });
+ const { host, path } = getParsedGrpcUrlObject(request.url);
+ const metadata = new Metadata();
+ Object.entries(request.headers).forEach(([name, value]) => {
+ metadata.add(name, value);
+ });
+
+ try {
+ const client = new grpcReflection.Client(host, credentials, {}, metadata);
+
+ const declarations = await client.listServices();
+ const methods = await Promise.all(
+ declarations.map(async (declaration) => {
+ const fileContainingSymbol = await client.fileContainingSymbol(declaration);
+ const descriptor = fileContainingSymbol.toDescriptor('proto3');
+ const protoDefinition = protoLoader.loadFileDescriptorSetFromObject(descriptor, configOptions);
+
+ const serviceDefinition = protoDefinition[declaration];
+ if (!!serviceDefinition?.format) {
+ return [];
+ }
+ const methods = Object.values(serviceDefinition);
+ methods.forEach((method) => {
+ this.methods.set(method.path, method);
+ });
+ return methods;
+ })
+ );
+
+ const methodsWithType = methods.flat().map((method) => ({
+ ...method,
+ type: this.#getMethodType(method)
+ }));
+ return methodsWithType;
+ } catch (error) {
+ console.error('Error in gRPC reflection:', error);
+ sendEvent('grpc:error', request.uid, collectionUid, { error });
+ throw error;
+ }
+ }
+
+ /**
+ * Load methods from proto file
+ */
+ async loadMethodsFromProtoFile(filePath, includeDirs = []) {
+ const protoDefinition = await protoLoader.load(filePath, { ...configOptions, includeDirs });
+ const methods = Object.values(protoDefinition)
+ .filter((definition) => !definition?.format)
+ .flatMap(Object.values);
+ const methodsWithType = methods.map((method) => ({
+ ...method,
+ type: this.#getMethodType(method)
+ }));
+ methods.forEach((method) => {
+ this.methods.set(method.path, method);
+ });
+ return methodsWithType;
+ }
+
+ end(requestId) {
+ const connection = this.activeConnections.get(requestId);
+ if (connection && typeof connection.end === 'function') {
+ connection.end();
+ this.#removeConnection(requestId);
+ }
+ }
+
+ cancel(requestId) {
+ const connection = this.activeConnections.get(requestId);
+ if (connection && typeof connection.cancel === 'function') {
+ connection.cancel();
+ this.#removeConnection(requestId);
+ }
+ }
+
+ /**
+ * Check if a connection is active
+ * @param {string} requestId - The request ID to check
+ * @returns {boolean} - Whether the connection is active
+ */
+ isConnectionActive(requestId) {
+ return this.activeConnections.has(requestId);
+ }
+
+ /**
+ * Clear all active connections
+ */
+ clearAllConnections() {
+ const connectionIds = this.getActiveConnectionIds();
+
+ this.activeConnections.forEach((connection) => {
+ if (typeof connection.cancel === 'function') {
+ connection.cancel();
+ }
+ });
+
+ this.activeConnections.clear();
+
+ // Emit an event with empty active connection IDs
+ if (connectionIds.length > 0) {
+ this.eventCallback('grpc:connections-changed', {
+ type: 'cleared',
+ activeConnectionIds: []
+ });
+ }
+ }
+
+ /**
+ * Generate a sample message for a specific method path
+ * @param {string} methodPath - The full gRPC method path
+ * @param {Object} options - Options for message generation
+ * @returns {Object} A sample message or error
+ */
+ generateSampleMessage(methodPath, options = {}) {
+ try {
+ let method;
+
+ // First, try to use the methodMetadata from options if provided
+ if (options.methodMetadata) {
+ method = options.methodMetadata;
+ } else {
+ // Fall back to checking if the method exists in the cache
+ if (!this.methods.has(methodPath)) {
+ return {
+ success: false,
+ error: `Method ${methodPath} not found in cache, please refresh the methods`
+ };
+ }
+
+ // Get the method definition from cache
+ method = this.methods.get(methodPath);
+ }
+
+ // Generate a sample message using our generator
+ const sampleMessage = generateGrpcSampleMessage(method, options);
+
+ return {
+ success: true,
+ message: sampleMessage
+ };
+ } catch (error) {
+ console.error('Error generating sample gRPC message:', error);
+ return {
+ success: false,
+ error: error.message || 'Failed to generate sample message'
+ };
+ }
+ }
+
+ /**
+ * Get all active connection IDs
+ * @returns {string[]} Array of active connection IDs
+ */
+ getActiveConnectionIds() {
+ return Array.from(this.activeConnections.keys());
+ }
+
+ /**
+ * Add a connection to the active connections map and emit an event
+ * @param {string} requestId - The request ID
+ * @param {Object} connection - The connection object
+ * @private
+ */
+ #addConnection(requestId, connection) {
+ this.activeConnections.set(requestId, connection);
+
+ // Emit an event with all active connection IDs
+ this.eventCallback('grpc:connections-changed', {
+ type: 'added',
+ requestId,
+ activeConnectionIds: this.getActiveConnectionIds()
+ });
+ }
+
+ /**
+ * Remove a connection from the active connections map and emit an event
+ * @param {string} requestId - The request ID
+ * @private
+ */
+ #removeConnection(requestId) {
+ if (this.activeConnections.has(requestId)) {
+ this.activeConnections.delete(requestId);
+
+ // Emit an event with all active connection IDs
+ this.eventCallback('grpc:connections-changed', {
+ type: 'removed',
+ requestId,
+ activeConnectionIds: this.getActiveConnectionIds()
+ });
+ }
+ }
+
+ /**
+ * Generate a grpcurl command for a gRPC request
+ * @param {Object} request - request object
+ * @param {Object} options.certificates - Certificate configuration
+ * @returns {string} The generated grpcurl command
+ */
+ generateGrpcurlCommand({ request, collectionPath = '', shell = 'bash', certificates = {} }) {
+ const { url, method, methodType = 'unary', body, headers, protoPath } = request;
+ const useReflection = !protoPath;
+ const parts = [];
+ const { host, path } = getParsedGrpcUrlObject(url);
+ const { ca, cert, key } = certificates;
+
+ parts.push('grpcurl');
+
+ if (url.startsWith('grpcs://') || url.startsWith('https://')) {
+ if (ca) {
+ /**
+ * Instead of using certificate that relies on CN, use SANs
+ * CN certificates seems to cause verification errors with grpcurl
+ * https://github.com/fullstorydev/grpcurl/issues/320
+ */
+ parts.push(`-cacert ${ca}`);
+ }
+ if (cert && key) {
+ /**
+ * passphrase is not supported by grpcurl, so we need to decrypt the key first
+ * When using key that is encrypted, use the passphrase to decrypt it
+ * openssl rsa -in client.key -out client_decrypted.key
+ * it will ask for passphrase, use the passphrase to decrypt the key
+ * then use the decrypted key for making the request using grpcurl
+ */
+ parts.push(`-cert ${cert}`);
+ parts.push(`-key ${key}`);
+ }
+ } else {
+ parts.push('-plaintext');
+ }
+
+ for (const [key, value] of Object.entries(headers)) {
+ parts.push(`-H "${key}: ${value}"`);
+ }
+
+ if (!useReflection && protoPath) {
+ const absoluteProtoPath = collectionPath ? nodePath.resolve(collectionPath, protoPath) : protoPath;
+ const importPath = nodePath.dirname(absoluteProtoPath);
+ const protoFileName = nodePath.basename(absoluteProtoPath);
+ parts.push(`-import-path ${importPath}`);
+ parts.push(`-proto ${protoFileName}`);
+ }
+
+ const isClientStreaming = methodType === 'client-streaming' || methodType === 'bidi-streaming';
+
+ if (body.grpc.length > 0) {
+ if (isClientStreaming) {
+ parts.push(`-d @`);
+ } else {
+ // For unary and server streaming, send as a single message
+ parts.push(`-d '${replaceTabsWithSpaces(body.grpc[0].content)}'`);
+ }
+ }
+
+ parts.push(host);
+
+ parts.push(path.slice(1) + (path ? '/' : '') + (method.startsWith('/') ? method.slice(1) : method));
+
+ if (isClientStreaming) {
+ const messages = body.grpc.map(({ content }) => replaceTabsWithSpaces(content));
+ const stdinData = messages.join('\n');
+ parts.push(`<< EOF\n${stdinData}\nEOF`);
+ }
+
+ return parts.join(' ');
+ }
+}
+
+export { GrpcClient };
diff --git a/packages/bruno-requests/src/grpc/grpcMessageGenerator.js b/packages/bruno-requests/src/grpc/grpcMessageGenerator.js
new file mode 100644
index 000000000..8b736c498
--- /dev/null
+++ b/packages/bruno-requests/src/grpc/grpcMessageGenerator.js
@@ -0,0 +1,132 @@
+import { faker } from '@faker-js/faker';
+
+/**
+ * Generates a sample message based on method parameter fields
+ * @param {Object} fields - Method parameter fields
+ * @param {Object} options - Generation options
+ * @returns {Object} Generated message
+ */
+const generateSampleMessageFromFields = (fields, options = {}) => {
+ const result = {};
+
+ if (!fields || !Array.isArray(fields)) {
+ return {};
+ }
+
+ fields.forEach(field => {
+ // Generate a value based on field name and type
+ if (field.type === 'TYPE_MESSAGE') {
+ // Handle nested message
+ if (field.messageType && field.messageType.field) {
+ if (field.label === 'LABEL_REPEATED') {
+ // Generate array of nested messages
+ const count = options.arraySize || faker.number.int({ min: 1, max: 3 });
+ result[field.name] = Array.from({ length: count }, () =>
+ generateSampleMessageFromFields(field.messageType.field, options)
+ );
+ } else {
+ // Generate single nested message
+ result[field.name] = generateSampleMessageFromFields(field.messageType.field, options);
+ }
+ } else {
+ // No field info for nested message, generate a simple object
+ result[field.name] = field.label === 'LABEL_REPEATED' ? [{}] : {};
+ }
+ } else if (field.type === 'TYPE_ENUM') {
+ result[field.name] = field.label === 'LABEL_REPEATED' ? [0] : 0;
+ } else {
+ // Generate value based on primitive type and name
+ let value;
+
+ switch (field.type) {
+ case 'TYPE_DOUBLE':
+ case 'TYPE_FLOAT':
+ value = faker.number.float({ min: 0, max: 1000, precision: 0.01 });
+ break;
+ case 'TYPE_INT32':
+ case 'TYPE_INT64':
+ case 'TYPE_SINT32':
+ case 'TYPE_SINT64':
+ case 'TYPE_UINT32':
+ case 'TYPE_UINT64':
+ case 'TYPE_FIXED32':
+ case 'TYPE_FIXED64':
+ value = faker.number.int({ min: 0, max: 1000 });
+ break;
+ case 'TYPE_BOOL':
+ value = faker.datatype.boolean();
+ break;
+ case 'TYPE_STRING':
+ value = faker.lorem.word()
+ break;
+ case 'TYPE_BYTES':
+ value = Buffer.from(faker.string.alpha({ length: { min: 5, max: 10 } })).toString('base64');
+ break;
+ default:
+ value = faker.lorem.word();
+ }
+
+ if (field.label === 'LABEL_REPEATED') {
+ // Generate array of values
+ const count = options.arraySize || faker.number.int({ min: 1, max: 3 });
+ result[field.name] = Array.from({ length: count }, () => value);
+ } else {
+ result[field.name] = value;
+ }
+ }
+ });
+
+ return result;
+};
+
+/**
+ * Extracts field definitions from a method's request type
+ * @param {Object} method - The gRPC method
+ * @returns {Array|null} Array of field definitions or null
+ */
+const getMethodRequestFields = (method) => {
+ try {
+ // Navigate through various potential property paths to find fields
+ if (method.requestType?.type?.field) {
+ return method.requestType.type.field;
+ }
+
+ if (method.requestType?.field) {
+ return method.requestType.field;
+ }
+
+ if (method.requestType?.type) {
+ return method.requestType.type;
+ }
+
+ } catch (error) {
+ console.error('Error extracting method request fields:', error);
+ return null;
+ }
+};
+
+/**
+ * Generates a sample gRPC message based on a method definition
+ * @param {Object} method - gRPC method definition
+ * @param {Object} options - Generation options
+ * @returns {Object} Generated message
+ */
+export const generateGrpcSampleMessage = (method, options = {}) => {
+ try {
+ if (!method) {
+ return {};
+ }
+
+ const fields = getMethodRequestFields(method);
+
+ if (fields) {
+ return generateSampleMessageFromFields(fields, options);
+ }
+
+ // If method exists but no field information could be extracted,
+ // generate a generic message that matches common patterns
+ return {};
+ } catch (error) {
+ console.error('Error generating gRPC sample message:', error);
+ }
+};
\ No newline at end of file
diff --git a/packages/bruno-requests/src/grpc/index.ts b/packages/bruno-requests/src/grpc/index.ts
new file mode 100644
index 000000000..060b54bb6
--- /dev/null
+++ b/packages/bruno-requests/src/grpc/index.ts
@@ -0,0 +1,2 @@
+export { GrpcClient } from './grpc-client';
+export { generateGrpcSampleMessage } from './grpcMessageGenerator';
\ No newline at end of file
diff --git a/packages/bruno-requests/src/index.ts b/packages/bruno-requests/src/index.ts
new file mode 100644
index 000000000..82d596828
--- /dev/null
+++ b/packages/bruno-requests/src/index.ts
@@ -0,0 +1,7 @@
+export { addDigestInterceptor, getOAuth2Token } from './auth';
+export { GrpcClient, generateGrpcSampleMessage } from './grpc';
+export { default as cookies } from './cookies';
+
+export * as network from './network';
+
+export * as scripting from './scripting';
\ No newline at end of file
diff --git a/packages/bruno-requests/src/network/axios-instance.ts b/packages/bruno-requests/src/network/axios-instance.ts
new file mode 100644
index 000000000..6ae868c3f
--- /dev/null
+++ b/packages/bruno-requests/src/network/axios-instance.ts
@@ -0,0 +1,81 @@
+import { default as axios, AxiosRequestConfig, AxiosRequestHeaders, AxiosResponse, InternalAxiosRequestConfig } from 'axios';
+import http from 'node:http';
+import https from 'node:https';
+
+/**
+ *
+ * @param {Object} customRequestConfig options - partial AxiosRequestConfig
+ *
+ * @returns {import('axios').AxiosInstance} Configured Axios instance
+ *
+ * @example
+ * const instance = makeAxiosInstance({
+ * maxRedirects: 0,
+ * proxy: false,
+ * headers: {
+ * "User-Agent": `bruno-runtime/_version_`
+ * },
+ * });
+ */
+
+type ModifiedInternalAxiosRequestConfig = InternalAxiosRequestConfig & {
+ startTime: number;
+}
+
+type ModifiedAxiosResponse = AxiosResponse & {
+ responseTime: number;
+}
+
+const baseRequestConfig: Partial = {
+ proxy: false,
+ httpAgent: new http.Agent({ keepAlive: true }),
+ httpsAgent: new https.Agent({ keepAlive: true }),
+ transformRequest: function transformRequest(data: any, headers: AxiosRequestHeaders) {
+ const contentType = headers.getContentType() || '';
+ const hasJSONContentType = contentType.includes('json');
+ if (typeof data === 'string' && hasJSONContentType) {
+ return data;
+ }
+
+ if (Array.isArray(axios.defaults.transformRequest)) {
+ axios.defaults.transformRequest.forEach((tr) => {
+ data = tr.call(this, data, headers);
+ });
+ }
+
+ return data;
+ }
+}
+
+const makeAxiosInstance = (customRequestConfig?: AxiosRequestConfig) => {
+ customRequestConfig = customRequestConfig || {};
+ const axiosInstance = axios.create({
+ ...baseRequestConfig,
+ ...customRequestConfig
+ });
+
+ axiosInstance.interceptors.request.use((config: InternalAxiosRequestConfig) => {
+ const modifiedConfig: ModifiedInternalAxiosRequestConfig = {
+ ...config,
+ startTime: Date.now()
+ }
+ return modifiedConfig;
+ });
+
+ axiosInstance.interceptors.response.use((response: AxiosResponse) => {
+ const config = response.config as ModifiedInternalAxiosRequestConfig;
+ const startTime = config.startTime;
+ const endTime = Date.now();
+ const modifiedResponse: ModifiedAxiosResponse = {
+ ...response,
+ responseTime: endTime - startTime
+ };
+ return modifiedResponse;
+ });
+
+ return axiosInstance;
+};
+
+export {
+ makeAxiosInstance
+};
diff --git a/packages/bruno-requests/src/network/index.ts b/packages/bruno-requests/src/network/index.ts
new file mode 100644
index 000000000..7d72cb7d1
--- /dev/null
+++ b/packages/bruno-requests/src/network/index.ts
@@ -0,0 +1 @@
+export { makeAxiosInstance } from './axios-instance';
\ No newline at end of file
diff --git a/packages/bruno-requests/src/scripting/index.ts b/packages/bruno-requests/src/scripting/index.ts
new file mode 100644
index 000000000..5ec4ee97b
--- /dev/null
+++ b/packages/bruno-requests/src/scripting/index.ts
@@ -0,0 +1 @@
+export { default as sendRequest } from './send-request';
\ No newline at end of file
diff --git a/packages/bruno-requests/src/scripting/send-request.ts b/packages/bruno-requests/src/scripting/send-request.ts
new file mode 100644
index 000000000..8afedeaf3
--- /dev/null
+++ b/packages/bruno-requests/src/scripting/send-request.ts
@@ -0,0 +1,30 @@
+import { AxiosRequestConfig } from 'axios';
+import { makeAxiosInstance } from '../network';
+
+type T_SendRequestCallback = (error: any, response: any) => void;
+
+const sendRequest = async (requestConfig: AxiosRequestConfig, callback: T_SendRequestCallback) => {
+ const axiosInstance = makeAxiosInstance();
+ if (!callback) {
+ return await axiosInstance(requestConfig);
+ }
+ try {
+ const response = await axiosInstance(requestConfig);
+ try {
+ await callback(null, response);
+ }
+ catch(error) {
+ return Promise.reject(error);
+ }
+ }
+ catch (error) {
+ try {
+ await callback(error, null);
+ }
+ catch(err) {
+ return Promise.reject(err);
+ }
+ }
+};
+
+export default sendRequest;
diff --git a/packages/bruno-requests/src/utils/url-validation.spec.ts b/packages/bruno-requests/src/utils/url-validation.spec.ts
new file mode 100644
index 000000000..b2b35e602
--- /dev/null
+++ b/packages/bruno-requests/src/utils/url-validation.spec.ts
@@ -0,0 +1,133 @@
+import { isPotentiallyTrustworthyOrigin } from './url-validation';
+
+describe('isPotentiallyTrustworthyOrigin', () => {
+ describe('secure schemes', () => {
+ it('should return true for HTTPS URLs', () => {
+ expect(isPotentiallyTrustworthyOrigin('https://example.com')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('https://api.github.com/v1/users')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('https://localhost:3000')).toBe(true);
+ });
+
+ it('should return true for WSS URLs', () => {
+ expect(isPotentiallyTrustworthyOrigin('wss://example.com')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('wss://localhost:8080/ws')).toBe(true);
+ });
+
+ it('should return true for file URLs', () => {
+ expect(isPotentiallyTrustworthyOrigin('file:///path/to/file.html')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('file://localhost/path/to/file.html')).toBe(true);
+ });
+ });
+
+ describe('insecure schemes', () => {
+ it('should return false for HTTP URLs with non-localhost domains', () => {
+ expect(isPotentiallyTrustworthyOrigin('http://example.com')).toBe(false);
+ expect(isPotentiallyTrustworthyOrigin('http://api.github.com')).toBe(false);
+ });
+
+ it('should return false for WS URLs with non-localhost domains', () => {
+ expect(isPotentiallyTrustworthyOrigin('ws://example.com')).toBe(false);
+ expect(isPotentiallyTrustworthyOrigin('ws://api.github.com')).toBe(false);
+ });
+
+ it('should return false for other schemes', () => {
+ expect(isPotentiallyTrustworthyOrigin('ftp://example.com')).toBe(false);
+ expect(isPotentiallyTrustworthyOrigin('ssh://example.com')).toBe(false);
+ });
+
+ it('should return true for HTTP/WS URLs with localhost (localhost is always trustworthy)', () => {
+ expect(isPotentiallyTrustworthyOrigin('http://localhost')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('ws://localhost')).toBe(true);
+ });
+ });
+
+ describe('loopback addresses', () => {
+ describe('IPv4 loopback', () => {
+ it('should return true for 127.0.0.1', () => {
+ expect(isPotentiallyTrustworthyOrigin('http://127.0.0.1')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://127.0.0.1:3000')).toBe(true);
+ });
+
+ it('should return true for other 127.x.x.x addresses', () => {
+ expect(isPotentiallyTrustworthyOrigin('http://127.0.0.0')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://127.255.255.255')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://127.1.2.3')).toBe(true);
+ });
+
+ it('should return false for non-loopback IPv4 addresses', () => {
+ expect(isPotentiallyTrustworthyOrigin('http://192.168.1.1')).toBe(false);
+ expect(isPotentiallyTrustworthyOrigin('http://10.0.0.1')).toBe(false);
+ expect(isPotentiallyTrustworthyOrigin('http://172.16.0.1')).toBe(false);
+ expect(isPotentiallyTrustworthyOrigin('http://8.8.8.8')).toBe(false);
+ });
+ });
+
+ describe('IPv6 loopback', () => {
+ it('should return true for ::1', () => {
+ expect(isPotentiallyTrustworthyOrigin('http://[::1]')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://[::1]:3000')).toBe(true);
+ });
+
+ it('should return false for non-loopback IPv6 addresses', () => {
+ expect(isPotentiallyTrustworthyOrigin('http://[2001:db8::1]')).toBe(false);
+ expect(isPotentiallyTrustworthyOrigin('http://[fe80::1]')).toBe(false);
+ });
+ });
+ });
+
+ describe('localhost hostnames', () => {
+ it('should return true for localhost and *.localhost domains', () => {
+ expect(isPotentiallyTrustworthyOrigin('http://localhost')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://localhost:3000')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://app.localhost')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://api.localhost')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://sub.domain.localhost')).toBe(true);
+ });
+
+ it('should handle case insensitive localhost', () => {
+ expect(isPotentiallyTrustworthyOrigin('http://LOCALHOST')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://LocalHost')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://APP.LOCALHOST')).toBe(true);
+ });
+
+ it('should return false for non-localhost domains', () => {
+ expect(isPotentiallyTrustworthyOrigin('http://api.example.com')).toBe(false);
+ expect(isPotentiallyTrustworthyOrigin('http://localhost.example.com')).toBe(false);
+ });
+ });
+
+ describe('edge cases', () => {
+ it('should handle trailing dots in hostnames', () => {
+ expect(isPotentiallyTrustworthyOrigin('http://localhost.')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://app.localhost.')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://example.com.')).toBe(false);
+ });
+
+ it('should handle URLs with query parameters and fragments', () => {
+ expect(isPotentiallyTrustworthyOrigin('https://example.com/path?query=value#fragment')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://localhost/path?query=value#fragment')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://api.example.com/path?query=value#fragment')).toBe(false);
+ });
+
+ it('should handle URLs with authentication', () => {
+ expect(isPotentiallyTrustworthyOrigin('https://user:pass@example.com')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://user:pass@localhost')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('http://user:pass@api.example.com')).toBe(false);
+ });
+ });
+
+ describe('mixed scenarios', () => {
+ it('should prioritize secure schemes over hostname checks', () => {
+ // Even though example.com is not localhost, HTTPS makes it trustworthy
+ expect(isPotentiallyTrustworthyOrigin('https://example.com')).toBe(true);
+
+ // Even though 192.168.1.1 is not loopback, HTTPS makes it trustworthy
+ expect(isPotentiallyTrustworthyOrigin('https://192.168.1.1')).toBe(true);
+ });
+
+ it('should handle localhost with different schemes', () => {
+ expect(isPotentiallyTrustworthyOrigin('https://localhost')).toBe(true);
+ expect(isPotentiallyTrustworthyOrigin('wss://localhost')).toBe(true);
+ });
+ });
+});
\ No newline at end of file
diff --git a/packages/bruno-requests/src/utils/url-validation.ts b/packages/bruno-requests/src/utils/url-validation.ts
new file mode 100644
index 000000000..1a94bcfdc
--- /dev/null
+++ b/packages/bruno-requests/src/utils/url-validation.ts
@@ -0,0 +1,67 @@
+import { isIPv4, isIPv6, isIP } from 'is-ip';
+
+const hostNoBrackets = (host: string): string => {
+ if (host.length >= 2 && host.startsWith('[') && host.endsWith(']')) {
+ return host.substring(1, host.length - 1);
+ }
+ return host;
+};
+
+const isLoopbackV4 = (address: string): boolean => {
+ const octets = address.split('.');
+ if (octets.length !== 4 || parseInt(octets[0], 10) !== 127) {
+ return false;
+ }
+ return octets.every((octet) => {
+ const n = parseInt(octet, 10);
+ return !Number.isNaN(n) && n >= 0 && n <= 255;
+ });
+};
+
+const isLoopbackV6 = (address: string): boolean => address === '::1';
+
+const isIpLoopback = (address: string): boolean => {
+ if (isIPv4(address)) {
+ return isLoopbackV4(address);
+ }
+ if (isIPv6(address)) {
+ return isLoopbackV6(address);
+ }
+ return false;
+};
+
+const isNormalizedLocalhostTLD = (host: string): boolean => host.toLowerCase().endsWith('.localhost');
+
+const isLocalHostname = (host: string): boolean => {
+ return host.toLowerCase() === 'localhost' || isNormalizedLocalhostTLD(host);
+};
+
+/**
+ * Mirrors Chrome / Secure Contexts spec for "potentially trustworthy origins".
+ */
+const isPotentiallyTrustworthyOrigin = (urlString: string): boolean => {
+ let url: URL;
+ try {
+ url = new URL(urlString);
+ } catch {
+ return false; // invalid URL or opaque origin
+ }
+
+ const scheme = url.protocol.replace(':', '').toLowerCase();
+ const hostname = hostNoBrackets(url.hostname).replace(/\.+$/, '');
+
+ // Secure schemes
+ if (scheme === 'https' || scheme === 'wss' || scheme === 'file') {
+ return true;
+ }
+
+ // IP literals
+ if (isIP(hostname)) {
+ return isIpLoopback(hostname);
+ }
+
+ // localhost / *.localhost
+ return isLocalHostname(hostname);
+};
+
+export { isPotentiallyTrustworthyOrigin };
\ No newline at end of file
diff --git a/packages/bruno-requests/tsconfig.json b/packages/bruno-requests/tsconfig.json
new file mode 100644
index 000000000..6a74f54cf
--- /dev/null
+++ b/packages/bruno-requests/tsconfig.json
@@ -0,0 +1,21 @@
+{
+ "compilerOptions": {
+ "target": "ES2020",
+ "module": "ESNext",
+ "strict": true,
+ "esModuleInterop": true,
+ "skipLibCheck": true,
+ "forceConsistentCasingInFileNames": true,
+ "outDir": "./dist",
+ "rootDir": "./src",
+ "resolveJsonModule": true,
+ "allowSyntheticDefaultImports": true,
+ "moduleResolution": "node",
+ "declaration": true,
+ "declarationDir": "./dist/types",
+ "allowJs": true,
+ "checkJs": false
+ },
+ "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.js"],
+ "exclude": ["node_modules", "dist"]
+}
\ No newline at end of file
diff --git a/packages/bruno-schema/src/collections/index.js b/packages/bruno-schema/src/collections/index.js
index b6e044ae4..ff830ca99 100644
--- a/packages/bruno-schema/src/collections/index.js
+++ b/packages/bruno-schema/src/collections/index.js
@@ -74,9 +74,19 @@ const multipartFormSchema = Yup.object({
.noUnknown(true)
.strict();
+
+const fileSchema = Yup.object({
+ uid: uidSchema,
+ filePath: Yup.string().nullable(),
+ contentType: Yup.string().nullable(),
+ selected: Yup.boolean()
+})
+ .noUnknown(true)
+ .strict();
+
const requestBodySchema = Yup.object({
mode: Yup.string()
- .oneOf(['none', 'json', 'text', 'xml', 'formUrlEncoded', 'multipartForm', 'graphql', 'sparql'])
+ .oneOf(['none', 'json', 'text', 'xml', 'formUrlEncoded', 'multipartForm', 'graphql', 'sparql', 'file'])
.required('mode is required'),
json: Yup.string().nullable(),
text: Yup.string().nullable(),
@@ -84,7 +94,8 @@ const requestBodySchema = Yup.object({
sparql: Yup.string().nullable(),
formUrlEncoded: Yup.array().of(keyValueSchema).nullable(),
multipartForm: Yup.array().of(multipartFormSchema).nullable(),
- graphql: graphqlBodySchema.nullable()
+ graphql: graphqlBodySchema.nullable(),
+ file: Yup.array().of(fileSchema).nullable()
})
.noUnknown(true)
.strict();
@@ -146,9 +157,31 @@ const authApiKeySchema = Yup.object({
.noUnknown(true)
.strict();
+const oauth2AuthorizationAdditionalParametersSchema = Yup.object({
+ name: Yup.string().nullable(),
+ value: Yup.string().nullable(),
+ sendIn: Yup.string()
+ .oneOf(['headers', 'queryparams'])
+ .required('send in property is required'),
+ enabled: Yup.boolean()
+})
+ .noUnknown(true)
+ .strict();
+
+const oauth2AdditionalParametersSchema = Yup.object({
+ name: Yup.string().nullable(),
+ value: Yup.string().nullable(),
+ sendIn: Yup.string()
+ .oneOf(['headers', 'queryparams', 'body'])
+ .required('send in property is required'),
+ enabled: Yup.boolean()
+ })
+ .noUnknown(true)
+ .strict();
+
const oauth2Schema = Yup.object({
grantType: Yup.string()
- .oneOf(['client_credentials', 'password', 'authorization_code'])
+ .oneOf(['client_credentials', 'password', 'authorization_code', 'implicit'])
.required('grantType is required'),
username: Yup.string().when('grantType', {
is: (val) => ['client_credentials', 'password'].includes(val),
@@ -161,12 +194,12 @@ const oauth2Schema = Yup.object({
otherwise: Yup.string().nullable().strip()
}),
callbackUrl: Yup.string().when('grantType', {
- is: (val) => ['authorization_code'].includes(val),
+ is: (val) => ['authorization_code', 'implicit'].includes(val),
then: Yup.string().nullable(),
otherwise: Yup.string().nullable().strip()
}),
authorizationUrl: Yup.string().when('grantType', {
- is: (val) => ['authorization_code'].includes(val),
+ is: (val) => ['authorization_code', 'implicit'].includes(val),
then: Yup.string().nullable(),
otherwise: Yup.string().nullable().strip()
}),
@@ -176,7 +209,7 @@ const oauth2Schema = Yup.object({
otherwise: Yup.string().nullable().strip()
}),
clientId: Yup.string().when('grantType', {
- is: (val) => ['client_credentials', 'password', 'authorization_code'].includes(val),
+ is: (val) => ['client_credentials', 'password', 'authorization_code', 'implicit'].includes(val),
then: Yup.string().nullable(),
otherwise: Yup.string().nullable().strip()
}),
@@ -186,12 +219,12 @@ const oauth2Schema = Yup.object({
otherwise: Yup.string().nullable().strip()
}),
scope: Yup.string().when('grantType', {
- is: (val) => ['client_credentials', 'password', 'authorization_code'].includes(val),
+ is: (val) => ['client_credentials', 'password', 'authorization_code', 'implicit'].includes(val),
then: Yup.string().nullable(),
otherwise: Yup.string().nullable().strip()
}),
state: Yup.string().when('grantType', {
- is: (val) => ['authorization_code'].includes(val),
+ is: (val) => ['authorization_code', 'implicit'].includes(val),
then: Yup.string().nullable(),
otherwise: Yup.string().nullable().strip()
}),
@@ -199,6 +232,57 @@ const oauth2Schema = Yup.object({
is: (val) => ['authorization_code'].includes(val),
then: Yup.boolean().default(false),
otherwise: Yup.boolean()
+ }),
+ credentialsPlacement: Yup.string().when('grantType', {
+ is: (val) => ['client_credentials', 'password', 'authorization_code'].includes(val),
+ then: Yup.string().nullable(),
+ otherwise: Yup.string().nullable().strip()
+ }),
+ credentialsId: Yup.string().when('grantType', {
+ is: (val) => ['client_credentials', 'password', 'authorization_code', 'implicit'].includes(val),
+ then: Yup.string().nullable(),
+ otherwise: Yup.string().nullable().strip()
+ }),
+ tokenPlacement: Yup.string().when('grantType', {
+ is: (val) => ['client_credentials', 'password', 'authorization_code', 'implicit'].includes(val),
+ then: Yup.string().nullable(),
+ otherwise: Yup.string().nullable().strip()
+ }),
+ tokenHeaderPrefix: Yup.string().when(['grantType', 'tokenPlacement'], {
+ is: (grantType, tokenPlacement) =>
+ ['client_credentials', 'password', 'authorization_code', 'implicit'].includes(grantType) && tokenPlacement === 'header',
+ then: Yup.string().nullable(),
+ otherwise: Yup.string().nullable().strip()
+ }),
+ tokenQueryKey: Yup.string().when(['grantType', 'tokenPlacement'], {
+ is: (grantType, tokenPlacement) =>
+ ['client_credentials', 'password', 'authorization_code', 'implicit'].includes(grantType) && tokenPlacement === 'url',
+ then: Yup.string().nullable(),
+ otherwise: Yup.string().nullable().strip()
+ }),
+ refreshTokenUrl: Yup.string().when('grantType', {
+ is: (val) => ['client_credentials', 'password', 'authorization_code'].includes(val),
+ then: Yup.string().nullable(),
+ otherwise: Yup.string().nullable().strip()
+ }),
+ autoRefreshToken: Yup.boolean().when('grantType', {
+ is: (val) => ['client_credentials', 'password', 'authorization_code'].includes(val),
+ then: Yup.boolean().default(false),
+ otherwise: Yup.boolean()
+ }),
+ autoFetchToken: Yup.boolean().when('grantType', {
+ is: (val) => ['authorization_code', 'implicit'].includes(val),
+ then: Yup.boolean().default(true),
+ otherwise: Yup.boolean()
+ }),
+ additionalParameters: Yup.object({
+ authorization: Yup.mixed().when('grantType', {
+ is: 'authorization_code',
+ then: Yup.array().of(oauth2AuthorizationAdditionalParametersSchema).required(),
+ otherwise: Yup.mixed().nullable().optional()
+ }),
+ token: Yup.array().of(oauth2AdditionalParametersSchema).optional(),
+ refresh: Yup.array().of(oauth2AdditionalParametersSchema).optional()
})
})
.noUnknown(true)
@@ -262,6 +346,42 @@ const requestSchema = Yup.object({
.noUnknown(true)
.strict();
+const grpcRequestSchema = Yup.object({
+ url: requestUrlSchema,
+ method: Yup.string().optional(),
+ methodType: Yup.string().oneOf(['unary', 'client-streaming', 'server-streaming', 'bidi-streaming', '']).nullable(),
+ protoPath: Yup.string().nullable(),
+ headers: Yup.array().of(keyValueSchema).required('headers are required'),
+ auth: authSchema,
+ body: Yup.object({
+ mode: Yup.string().oneOf(['grpc']).required('mode is required'),
+ grpc: Yup.array().of(Yup.object({
+ name: Yup.string().nullable(),
+ content: Yup.string().nullable()
+ })).nullable()
+ })
+ .strict()
+ .required('body is required'),
+ script: Yup.object({
+ req: Yup.string().nullable(),
+ res: Yup.string().nullable()
+ })
+ .noUnknown(true)
+ .strict(),
+ vars: Yup.object({
+ req: Yup.array().of(varsSchema).nullable(),
+ res: Yup.array().of(varsSchema).nullable()
+ })
+ .noUnknown(true)
+ .strict()
+ .nullable(),
+ assertions: Yup.array().of(keyValueSchema).nullable(),
+ tests: Yup.string().nullable(),
+ docs: Yup.string().nullable()
+})
+ .noUnknown(true)
+ .strict();
+
const folderRootSchema = Yup.object({
request: Yup.object({
headers: Yup.array().of(keyValueSchema).nullable(),
@@ -287,7 +407,8 @@ const folderRootSchema = Yup.object({
.nullable(),
docs: Yup.string().nullable(),
meta: Yup.object({
- name: Yup.string().nullable()
+ name: Yup.string().nullable(),
+ seq: Yup.number().min(1).nullable()
})
.noUnknown(true)
.strict()
@@ -298,13 +419,24 @@ const folderRootSchema = Yup.object({
const itemSchema = Yup.object({
uid: uidSchema,
- type: Yup.string().oneOf(['http-request', 'graphql-request', 'folder', 'js']).required('type is required'),
+ type: Yup.string().oneOf(['http-request', 'graphql-request', 'folder', 'js', 'grpc-request']).required('type is required'),
seq: Yup.number().min(1),
name: Yup.string().min(1, 'name must be at least 1 character').required('name is required'),
- request: requestSchema.when('type', {
- is: (type) => ['http-request', 'graphql-request'].includes(type),
- then: (schema) => schema.required('request is required when item-type is request')
+ tags: Yup.array().of(Yup.string().matches(/^[\w-]+$/, 'tag must be alphanumeric')),
+ request: Yup.mixed().when('type', {
+ is: (type) => type === 'grpc-request',
+ then: grpcRequestSchema.required('request is required when item-type is grpc-request'),
+ otherwise: requestSchema.when('type', {
+ is: (type) => ['http-request', 'graphql-request'].includes(type),
+ then: (schema) => schema.required('request is required when item-type is request')
+ })
}),
+ settings: Yup.object({
+ encodeUrl: Yup.boolean().nullable()
+ })
+ .noUnknown(true)
+ .strict()
+ .nullable(),
fileContent: Yup.string().when('type', {
// If the type is 'js', the fileContent field is expected to be a string.
// This can include an empty string, indicating that the JS file may not have any content.
diff --git a/packages/bruno-schema/src/collections/index.spec.js b/packages/bruno-schema/src/collections/index.spec.js
index 16b683d08..f15031c4c 100644
--- a/packages/bruno-schema/src/collections/index.spec.js
+++ b/packages/bruno-schema/src/collections/index.spec.js
@@ -71,6 +71,75 @@ describe('Collection Schema Validation', () => {
expect(isValid).toBeTruthy();
});
+ it('collection schema must validate successfully - simple collection, just a gRPC request item', async () => {
+ const collection = {
+ version: '1',
+ uid: uuid(),
+ name: 'My Collection',
+ items: [
+ {
+ uid: uuid(),
+ name: 'Get User',
+ type: 'grpc-request',
+ request: {
+ url: 'grpc://localhost:50051',
+ method: 'GetUser',
+ methodType: 'unary',
+ protoPath: '/path/to/proto/file.proto',
+ headers: [],
+ body: {
+ mode: 'grpc',
+ grpc: [
+ {
+ name: 'message 1',
+ content: '{}'
+ }
+ ]
+ }
+ }
+ }
+ ]
+ };
+
+ const isValid = await collectionSchema.validate(collection);
+ expect(isValid).toBeTruthy();
+ });
+
+ it('collection schema validation must fail - invalid grpc collection item with params', async () => {
+ const collection = {
+ version: '1',
+ uid: uuid(),
+ name: 'My Collection',
+ items: [
+ {
+ uid: uuid(),
+ name: 'Get User',
+ type: 'grpc-request',
+ request: {
+ url: 'grpc://localhost:50051',
+ method: 'GetUser',
+ methodType: 'unary',
+ protoPath: '/path/to/proto/file.proto',
+ headers: [],
+ params: [],
+ body: {
+ mode: 'grpc',
+ grpc: [
+ {
+ name: 'message 1',
+ content: '{}'
+ }
+ ]
+ }
+ }
+ }
+ ]
+ };
+
+ expect(collectionSchema.validate(collection)).rejects.toThrow('items[0].request field has unspecified keys: params');
+ });
+
+
it('collection schema must validate successfully - simple collection, folder inside folder', async () => {
const collection = {
version: '1',
diff --git a/packages/bruno-schema/src/collections/itemSchema.spec.js b/packages/bruno-schema/src/collections/itemSchema.spec.js
index 8c46bed2c..9d52132da 100644
--- a/packages/bruno-schema/src/collections/itemSchema.spec.js
+++ b/packages/bruno-schema/src/collections/itemSchema.spec.js
@@ -7,7 +7,8 @@ describe('Item Schema Validation', () => {
const item = {
uid: uuid(),
name: 'A Folder',
- type: 'folder'
+ type: 'folder',
+ tags: ['smoke-test']
};
const isValid = await itemSchema.validate(item);
diff --git a/packages/bruno-tests/collection/asserts/test-assert-combinations.bru b/packages/bruno-tests/collection/asserts/test-assert-combinations.bru
new file mode 100644
index 000000000..3ad85765a
--- /dev/null
+++ b/packages/bruno-tests/collection/asserts/test-assert-combinations.bru
@@ -0,0 +1,74 @@
+meta {
+ name: test-assert-combinations
+ type: http
+ seq: 1
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "type": "application/json",
+ "contentJSON": {
+ "string": "foo",
+ "stringWithSQuotes": "'foo'",
+ "stringWithDQuotes": "\"foo\"",
+ "number": 123,
+ "numberAsString": "123",
+ "numberAsStringWithSQuotes": "'123'",
+ "numberAsStringWithDQuotes": "\"123\"",
+ "numberAsStringWithLeadingZero": "0123",
+ "numberBig": 9007199254740992000,
+ "numberBigAsString": "9007199254740991999",
+ "null": null,
+ "nullAsString": "null",
+ "nullAsStringWithSQuotes": "'null'",
+ "nullAsStringWithDQuotes": "\"null\"",
+ "true": true,
+ "trueAsString": "true",
+ "trueAsStringWithSQuotes": "'true'",
+ "trueAsStringWithDQuotes": "\"true\"",
+ "false": false,
+ "falseAsString": "false",
+ "falseAsStringWithSQuotes": "'false'",
+ "falseAsStringWithDQuotes": "\"false\"",
+ "stringWithCurlyBraces": "{foo}",
+ "stringWithDoubleCurlyBraces": "{{foobar}}"
+ }
+ }
+}
+
+assert {
+ res.body.string: eq foo
+ res.body.string: eq 'foo'
+ res.body.string: eq "foo"
+ res.body.stringWithSQuotes: eq "'foo'"
+ res.body.stringWithDQuotes: eq '"foo"'
+ res.body.number: eq 123
+ res.body.numberAsString: eq '123'
+ res.body.numberAsString: eq "123"
+ res.body.numberAsStringWithSQuotes: eq "'123'"
+ res.body.numberAsStringWithDQuotes: eq '"123"'
+ res.body.numberAsStringWithLeadingZero: eq "0123"
+ res.body.numberBig.toString(): eq '9007199254740992000'
+ res.body.numberBigAsString: eq "9007199254740991999"
+ res.body.null: eq null
+ res.body.nullAsString: eq "null"
+ res.body.nullAsStringWithSQuotes: eq "'null'"
+ res.body.nullAsStringWithDQuotes: eq '"null"'
+ res.body.true: eq true
+ res.body.trueAsString: eq "true"
+ res.body.trueAsStringWithSQuotes: eq "'true'"
+ res.body.trueAsStringWithDQuotes: eq '"true"'
+ res.body.false: eq false
+ res.body.falseAsString: eq "false"
+ res.body.falseAsStringWithSQuotes: eq "'false'"
+ res.body.falseAsStringWithDQuotes: eq '"false"'
+ res.body.nonexistent: eq undefined
+ res.body.stringWithCurlyBraces: eq "{foo}"
+ res.body.stringWithDoubleCurlyBraces: eq "{{foobar}}"
+}
diff --git a/packages/bruno-tests/collection/auth/bearer/via auth/Bearer Auth undefined.bru b/packages/bruno-tests/collection/auth/bearer/via auth/Bearer Auth undefined.bru
new file mode 100644
index 000000000..43298cfd4
--- /dev/null
+++ b/packages/bruno-tests/collection/auth/bearer/via auth/Bearer Auth undefined.bru
@@ -0,0 +1,27 @@
+meta {
+ name: Bearer Auth undefined
+ type: http
+ seq: 2
+}
+
+get {
+ url: {{host}}/api/auth/bearer/protected
+ body: none
+ auth: bearer
+}
+
+headers {
+ Authorization: Bearer {{bearer_auth_token}}
+}
+
+assert {
+ res.body.message: eq Unauthorized
+ res.status: eq 401
+}
+
+tests {
+ test("selected auth overrides Authorization header always", function() {
+ const authHeader = req.getHeader("Authorization")
+ expect(authHeader).to.eql("Bearer ")
+ })
+}
diff --git a/packages/bruno-tests/collection/auth/bearer/via headers/Bearer Auth 200.bru b/packages/bruno-tests/collection/auth/bearer/via headers/Bearer Auth 200.bru
index a837bdd7e..0989e0fba 100644
--- a/packages/bruno-tests/collection/auth/bearer/via headers/Bearer Auth 200.bru
+++ b/packages/bruno-tests/collection/auth/bearer/via headers/Bearer Auth 200.bru
@@ -11,7 +11,7 @@ get {
}
headers {
- Authorization: Bearer your_secret_token
+ Authorization: Bearer {{bearer_auth_token}}
}
vars:pre-request {
diff --git a/packages/bruno-tests/collection/auth/digest/Digest Auth 200.bru b/packages/bruno-tests/collection/auth/digest/Digest Auth 200.bru
new file mode 100644
index 000000000..7efd6bee0
--- /dev/null
+++ b/packages/bruno-tests/collection/auth/digest/Digest Auth 200.bru
@@ -0,0 +1,21 @@
+meta {
+ name: Digest Auth 200
+ type: http
+ seq: 1
+}
+
+get {
+ url: https://httpbin.org/digest-auth/auth/foo/passwd
+ body: none
+ auth: digest
+}
+
+auth:digest {
+ username: foo
+ password: passwd
+}
+
+assert {
+ res.status: eq 200
+ res.body.authenticated: isTruthy
+}
diff --git a/packages/bruno-tests/collection/auth/digest/Digest Auth 401.bru b/packages/bruno-tests/collection/auth/digest/Digest Auth 401.bru
new file mode 100644
index 000000000..52f3698ae
--- /dev/null
+++ b/packages/bruno-tests/collection/auth/digest/Digest Auth 401.bru
@@ -0,0 +1,20 @@
+meta {
+ name: Digest Auth 401
+ type: http
+ seq: 2
+}
+
+get {
+ url: https://httpbin.org/digest-auth/auth/foo/passw
+ body: none
+ auth: digest
+}
+
+auth:digest {
+ username: foo
+ password: passwd
+}
+
+assert {
+ res.status: eq 401
+}
diff --git a/packages/bruno-tests/collection/auth/digest/folder.bru b/packages/bruno-tests/collection/auth/digest/folder.bru
new file mode 100644
index 000000000..6b16b9610
--- /dev/null
+++ b/packages/bruno-tests/collection/auth/digest/folder.bru
@@ -0,0 +1,3 @@
+meta {
+ name: digest
+}
diff --git a/packages/bruno-tests/collection/bruno.json b/packages/bruno-tests/collection/bruno.json
index ada36145a..d2aa0a97a 100644
--- a/packages/bruno-tests/collection/bruno.json
+++ b/packages/bruno-tests/collection/bruno.json
@@ -28,4 +28,4 @@
"requestType": "http",
"requestUrl": "http://localhost:6000"
}
-}
+}
\ No newline at end of file
diff --git a/packages/bruno-tests/collection/echo/echo headers.bru b/packages/bruno-tests/collection/echo/echo headers.bru
new file mode 100644
index 000000000..9f6571109
--- /dev/null
+++ b/packages/bruno-tests/collection/echo/echo headers.bru
@@ -0,0 +1,22 @@
+meta {
+ name: echo headers
+ type: http
+ seq: 13
+}
+
+post {
+ url: {{echo-host}}
+ body: none
+ auth: inherit
+}
+
+headers {
+ Custom-Header-String: bruno
+}
+
+tests {
+ test("test headers",function() {
+ expect(res.getHeaders()).to.have.property("Custom-Header-String".toLowerCase())
+ expect(res.getHeaders()).to.have.property("Custom-Header-String".toLowerCase(), "bruno")
+ })
+}
diff --git a/packages/bruno-tests/collection/echo/echo json.bru b/packages/bruno-tests/collection/echo/echo json.bru
index 1749eda6b..62137591e 100644
--- a/packages/bruno-tests/collection/echo/echo json.bru
+++ b/packages/bruno-tests/collection/echo/echo json.bru
@@ -43,6 +43,5 @@ tests {
expect(res.getBody()).to.eql({
"hello": "bruno"
});
- });
-
+ });
}
diff --git a/packages/bruno-tests/collection/echo/multiline/echo binary.bru b/packages/bruno-tests/collection/echo/multiline/echo binary.bru
new file mode 100644
index 000000000..704419886
--- /dev/null
+++ b/packages/bruno-tests/collection/echo/multiline/echo binary.bru
@@ -0,0 +1,15 @@
+meta {
+ name: echo binary
+ type: http
+ seq: 1
+}
+
+post {
+ url: {{echo-host}}
+ body: file
+ auth: none
+}
+
+body:file {
+ file: @file(bruno.png) @contentType(image/png)
+}
diff --git a/packages/bruno-tests/collection/echo/test echo any.bru b/packages/bruno-tests/collection/echo/test echo any.bru
new file mode 100644
index 000000000..b78014dd9
--- /dev/null
+++ b/packages/bruno-tests/collection/echo/test echo any.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test echo any
+ type: http
+ seq: 11
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "text/plain" },
+ "content": "hello"
+ }
+}
+
+assert {
+ res.body: eq hello
+}
diff --git a/packages/bruno-tests/collection/echo/test echo-any json.bru b/packages/bruno-tests/collection/echo/test echo-any json.bru
new file mode 100644
index 000000000..2f3a7e5f4
--- /dev/null
+++ b/packages/bruno-tests/collection/echo/test echo-any json.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test echo-any json
+ type: http
+ seq: 12
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "type": "application/json",
+ "contentJSON": {"x": 42}
+ }
+}
+
+assert {
+ res.body.x: eq 42
+}
diff --git a/packages/bruno-tests/collection/environments/Local.bru b/packages/bruno-tests/collection/environments/Local.bru
index 991077d97..a7ac3f541 100644
--- a/packages/bruno-tests/collection/environments/Local.bru
+++ b/packages/bruno-tests/collection/environments/Local.bru
@@ -1,7 +1,14 @@
vars {
host: http://localhost:8080
+ httpfaker: https://www.httpfaker.org
bearer_auth_token: your_secret_token
basic_auth_password: della
+ env.var1: envVar1
+ env-var2: envVar2
+ bark: {{process.env.PROC_ENV_VAR}}
+ foo: bar
+ testSetEnvVar: bruno-29653
+ echo-host: https://echo.usebruno.com
client_id: client_id_1
client_secret: client_secret_1
auth_url: http://localhost:8080/api/auth/oauth2/authorization_code/authorize
diff --git a/packages/bruno-tests/collection/environments/Prod.bru b/packages/bruno-tests/collection/environments/Prod.bru
index ce8fa60cc..f33c1bb05 100644
--- a/packages/bruno-tests/collection/environments/Prod.bru
+++ b/packages/bruno-tests/collection/environments/Prod.bru
@@ -1,5 +1,6 @@
vars {
host: https://testbench-sanity.usebruno.com
+ httpfaker: https://www.httpfaker.org
bearer_auth_token: your_secret_token
basic_auth_password: della
env.var1: envVar1
diff --git a/packages/bruno-tests/collection/file.txt b/packages/bruno-tests/collection/file.txt
new file mode 100644
index 000000000..0a1443d43
--- /dev/null
+++ b/packages/bruno-tests/collection/file.txt
@@ -0,0 +1,3 @@
+file.txt
+
+hello, bruno
diff --git a/packages/bruno-tests/collection/package-lock.json b/packages/bruno-tests/collection/package-lock.json
index b8b4283ae..0f6e06f56 100644
--- a/packages/bruno-tests/collection/package-lock.json
+++ b/packages/bruno-tests/collection/package-lock.json
@@ -10,7 +10,254 @@
"dependencies": {
"@faker-js/faker": "^8.4.0",
"jsonwebtoken": "^9.0.2",
- "lru-map-cache": "^0.1.0"
+ "lru-map-cache": "^0.1.0",
+ "mssql": "^11.0.1"
+ }
+ },
+ "node_modules/@azure/abort-controller": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-2.1.2.tgz",
+ "integrity": "sha512-nBrLsEWm4J2u5LpAPjxADTlq3trDgVZZXHNKabeXZtpq3d3AbN/KGO82R87rdDz5/lYB024rtEf10/q0urNgsA==",
+ "dependencies": {
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/core-auth": {
+ "version": "1.9.0",
+ "resolved": "https://registry.npmjs.org/@azure/core-auth/-/core-auth-1.9.0.tgz",
+ "integrity": "sha512-FPwHpZywuyasDSLMqJ6fhbOK3TqUdviZNF8OqRGA4W5Ewib2lEEZ+pBsYcBa88B2NGO/SEnYPGhyBqNlE8ilSw==",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "@azure/core-util": "^1.11.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/core-client": {
+ "version": "1.9.2",
+ "resolved": "https://registry.npmjs.org/@azure/core-client/-/core-client-1.9.2.tgz",
+ "integrity": "sha512-kRdry/rav3fUKHl/aDLd/pDLcB+4pOFwPPTVEExuMyaI5r+JBbMWqRbCY1pn5BniDaU3lRxO9eaQ1AmSMehl/w==",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "@azure/core-auth": "^1.4.0",
+ "@azure/core-rest-pipeline": "^1.9.1",
+ "@azure/core-tracing": "^1.0.0",
+ "@azure/core-util": "^1.6.1",
+ "@azure/logger": "^1.0.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/core-http-compat": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/@azure/core-http-compat/-/core-http-compat-2.1.2.tgz",
+ "integrity": "sha512-5MnV1yqzZwgNLLjlizsU3QqOeQChkIXw781Fwh1xdAqJR5AA32IUaq6xv1BICJvfbHoa+JYcaij2HFkhLbNTJQ==",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "@azure/core-client": "^1.3.0",
+ "@azure/core-rest-pipeline": "^1.3.0"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/core-lro": {
+ "version": "2.7.2",
+ "resolved": "https://registry.npmjs.org/@azure/core-lro/-/core-lro-2.7.2.tgz",
+ "integrity": "sha512-0YIpccoX8m/k00O7mDDMdJpbr6mf1yWo2dfmxt5A8XVZVVMz2SSKaEbMCeJRvgQ0IaSlqhjT47p4hVIRRy90xw==",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "@azure/core-util": "^1.2.0",
+ "@azure/logger": "^1.0.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/core-paging": {
+ "version": "1.6.2",
+ "resolved": "https://registry.npmjs.org/@azure/core-paging/-/core-paging-1.6.2.tgz",
+ "integrity": "sha512-YKWi9YuCU04B55h25cnOYZHxXYtEvQEbKST5vqRga7hWY9ydd3FZHdeQF8pyh+acWZvppw13M/LMGx0LABUVMA==",
+ "dependencies": {
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/core-rest-pipeline": {
+ "version": "1.18.1",
+ "resolved": "https://registry.npmjs.org/@azure/core-rest-pipeline/-/core-rest-pipeline-1.18.1.tgz",
+ "integrity": "sha512-/wS73UEDrxroUEVywEm7J0p2c+IIiVxyfigCGfsKvCxxCET4V/Hef2aURqltrXMRjNmdmt5IuOgIpl8f6xdO5A==",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "@azure/core-auth": "^1.8.0",
+ "@azure/core-tracing": "^1.0.1",
+ "@azure/core-util": "^1.11.0",
+ "@azure/logger": "^1.0.0",
+ "http-proxy-agent": "^7.0.0",
+ "https-proxy-agent": "^7.0.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/core-tracing": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/@azure/core-tracing/-/core-tracing-1.2.0.tgz",
+ "integrity": "sha512-UKTiEJPkWcESPYJz3X5uKRYyOcJD+4nYph+KpfdPRnQJVrZfk0KJgdnaAWKfhsBBtAf/D58Az4AvCJEmWgIBAg==",
+ "dependencies": {
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/core-util": {
+ "version": "1.11.0",
+ "resolved": "https://registry.npmjs.org/@azure/core-util/-/core-util-1.11.0.tgz",
+ "integrity": "sha512-DxOSLua+NdpWoSqULhjDyAZTXFdP/LKkqtYuxxz1SCN289zk3OG8UOpnCQAz/tygyACBtWp/BoO72ptK7msY8g==",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/identity": {
+ "version": "4.5.0",
+ "resolved": "https://registry.npmjs.org/@azure/identity/-/identity-4.5.0.tgz",
+ "integrity": "sha512-EknvVmtBuSIic47xkOqyNabAme0RYTw52BTMz8eBgU1ysTyMrD1uOoM+JdS0J/4Yfp98IBT3osqq3BfwSaNaGQ==",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "@azure/core-auth": "^1.9.0",
+ "@azure/core-client": "^1.9.2",
+ "@azure/core-rest-pipeline": "^1.17.0",
+ "@azure/core-tracing": "^1.0.0",
+ "@azure/core-util": "^1.11.0",
+ "@azure/logger": "^1.0.0",
+ "@azure/msal-browser": "^3.26.1",
+ "@azure/msal-node": "^2.15.0",
+ "events": "^3.0.0",
+ "jws": "^4.0.0",
+ "open": "^8.0.0",
+ "stoppable": "^1.1.0",
+ "tslib": "^2.2.0"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/identity/node_modules/jwa": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/jwa/-/jwa-2.0.0.tgz",
+ "integrity": "sha512-jrZ2Qx916EA+fq9cEAeCROWPTfCwi1IVHqT2tapuqLEVVDKFDENFw1oL+MwrTvH6msKxsd1YTDVw6uKEcsrLEA==",
+ "dependencies": {
+ "buffer-equal-constant-time": "1.0.1",
+ "ecdsa-sig-formatter": "1.0.11",
+ "safe-buffer": "^5.0.1"
+ }
+ },
+ "node_modules/@azure/identity/node_modules/jws": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/jws/-/jws-4.0.0.tgz",
+ "integrity": "sha512-KDncfTmOZoOMTFG4mBlG0qUIOlc03fmzH+ru6RgYVZhPkyiy/92Owlt/8UEN+a4TXR1FQetfIpJE8ApdvdVxTg==",
+ "dependencies": {
+ "jwa": "^2.0.0",
+ "safe-buffer": "^5.0.1"
+ }
+ },
+ "node_modules/@azure/keyvault-common": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/@azure/keyvault-common/-/keyvault-common-2.0.0.tgz",
+ "integrity": "sha512-wRLVaroQtOqfg60cxkzUkGKrKMsCP6uYXAOomOIysSMyt1/YM0eUn9LqieAWM8DLcU4+07Fio2YGpPeqUbpP9w==",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "@azure/core-auth": "^1.3.0",
+ "@azure/core-client": "^1.5.0",
+ "@azure/core-rest-pipeline": "^1.8.0",
+ "@azure/core-tracing": "^1.0.0",
+ "@azure/core-util": "^1.10.0",
+ "@azure/logger": "^1.1.4",
+ "tslib": "^2.2.0"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/keyvault-keys": {
+ "version": "4.9.0",
+ "resolved": "https://registry.npmjs.org/@azure/keyvault-keys/-/keyvault-keys-4.9.0.tgz",
+ "integrity": "sha512-ZBP07+K4Pj3kS4TF4XdkqFcspWwBHry3vJSOFM5k5ZABvf7JfiMonvaFk2nBF6xjlEbMpz5PE1g45iTMme0raQ==",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "@azure/core-auth": "^1.3.0",
+ "@azure/core-client": "^1.5.0",
+ "@azure/core-http-compat": "^2.0.1",
+ "@azure/core-lro": "^2.2.0",
+ "@azure/core-paging": "^1.1.1",
+ "@azure/core-rest-pipeline": "^1.8.1",
+ "@azure/core-tracing": "^1.0.0",
+ "@azure/core-util": "^1.0.0",
+ "@azure/keyvault-common": "^2.0.0",
+ "@azure/logger": "^1.0.0",
+ "tslib": "^2.2.0"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/logger": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/@azure/logger/-/logger-1.1.4.tgz",
+ "integrity": "sha512-4IXXzcCdLdlXuCG+8UKEwLA1T1NHqUfanhXYHiQTn+6sfWCZXduqbtXDGceg3Ce5QxTGo7EqmbV6Bi+aqKuClQ==",
+ "dependencies": {
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/msal-browser": {
+ "version": "3.28.0",
+ "resolved": "https://registry.npmjs.org/@azure/msal-browser/-/msal-browser-3.28.0.tgz",
+ "integrity": "sha512-1c1qUF6vB52mWlyoMem4xR1gdwiQWYEQB2uhDkbAL4wVJr8WmAcXybc1Qs33y19N4BdPI8/DHI7rPE8L5jMtWw==",
+ "dependencies": {
+ "@azure/msal-common": "14.16.0"
+ },
+ "engines": {
+ "node": ">=0.8.0"
+ }
+ },
+ "node_modules/@azure/msal-common": {
+ "version": "14.16.0",
+ "resolved": "https://registry.npmjs.org/@azure/msal-common/-/msal-common-14.16.0.tgz",
+ "integrity": "sha512-1KOZj9IpcDSwpNiQNjt0jDYZpQvNZay7QAEi/5DLubay40iGYtLzya/jbjRPLyOTZhEKyL1MzPuw2HqBCjceYA==",
+ "engines": {
+ "node": ">=0.8.0"
+ }
+ },
+ "node_modules/@azure/msal-node": {
+ "version": "2.16.2",
+ "resolved": "https://registry.npmjs.org/@azure/msal-node/-/msal-node-2.16.2.tgz",
+ "integrity": "sha512-An7l1hEr0w1HMMh1LU+rtDtqL7/jw74ORlc9Wnh06v7TU/xpG39/Zdr1ZJu3QpjUfKJ+E0/OXMW8DRSWTlh7qQ==",
+ "dependencies": {
+ "@azure/msal-common": "14.16.0",
+ "jsonwebtoken": "^9.0.0",
+ "uuid": "^8.3.0"
+ },
+ "engines": {
+ "node": ">=16"
}
},
"node_modules/@faker-js/faker": {
@@ -28,11 +275,147 @@
"npm": ">=6.14.13"
}
},
+ "node_modules/@js-joda/core": {
+ "version": "5.6.3",
+ "resolved": "https://registry.npmjs.org/@js-joda/core/-/core-5.6.3.tgz",
+ "integrity": "sha512-T1rRxzdqkEXcou0ZprN1q9yDRlvzCPLqmlNt5IIsGBzoEVgLCCYrKEwc84+TvsXuAc95VAZwtWD2zVsKPY4bcA=="
+ },
+ "node_modules/@tediousjs/connection-string": {
+ "version": "0.5.0",
+ "resolved": "https://registry.npmjs.org/@tediousjs/connection-string/-/connection-string-0.5.0.tgz",
+ "integrity": "sha512-7qSgZbincDDDFyRweCIEvZULFAw5iz/DeunhvuxpL31nfntX3P4Yd4HkHBRg9H8CdqY1e5WFN1PZIz/REL9MVQ=="
+ },
+ "node_modules/@types/node": {
+ "version": "22.10.5",
+ "resolved": "https://registry.npmjs.org/@types/node/-/node-22.10.5.tgz",
+ "integrity": "sha512-F8Q+SeGimwOo86fiovQh8qiXfFEh2/ocYv7tU5pJ3EXMSSxk1Joj5wefpFK2fHTf/N6HKGSxIDBT9f3gCxXPkQ==",
+ "dependencies": {
+ "undici-types": "~6.20.0"
+ }
+ },
+ "node_modules/@types/readable-stream": {
+ "version": "4.0.18",
+ "resolved": "https://registry.npmjs.org/@types/readable-stream/-/readable-stream-4.0.18.tgz",
+ "integrity": "sha512-21jK/1j+Wg+7jVw1xnSwy/2Q1VgVjWuFssbYGTREPUBeZ+rqVFl2udq0IkxzPC0ZhOzVceUbyIACFZKLqKEBlA==",
+ "dependencies": {
+ "@types/node": "*",
+ "safe-buffer": "~5.1.1"
+ }
+ },
+ "node_modules/@types/readable-stream/node_modules/safe-buffer": {
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz",
+ "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g=="
+ },
+ "node_modules/abort-controller": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/abort-controller/-/abort-controller-3.0.0.tgz",
+ "integrity": "sha512-h8lQ8tacZYnR3vNQTgibj+tODHI5/+l06Au2Pcriv/Gmet0eaj4TwWH41sO9wnHDiQsEj19q0drzdWdeAHtweg==",
+ "dependencies": {
+ "event-target-shim": "^5.0.0"
+ },
+ "engines": {
+ "node": ">=6.5"
+ }
+ },
+ "node_modules/agent-base": {
+ "version": "7.1.3",
+ "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.3.tgz",
+ "integrity": "sha512-jRR5wdylq8CkOe6hei19GGZnxM6rBGwFl3Bg0YItGDimvjGtAvdZk4Pu6Cl4u4Igsws4a1fd1Vq3ezrhn4KmFw==",
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/base64-js": {
+ "version": "1.5.1",
+ "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz",
+ "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ]
+ },
+ "node_modules/bl": {
+ "version": "6.0.18",
+ "resolved": "https://registry.npmjs.org/bl/-/bl-6.0.18.tgz",
+ "integrity": "sha512-2k76XmWCuvu9HTvu3tFOl5HDdCH0wLZ/jHYva/LBVJmc9oX8yUtNQjxrFmbTdXsCSmIxwVTANZPNDfMQrvHFUw==",
+ "dependencies": {
+ "@types/readable-stream": "^4.0.0",
+ "buffer": "^6.0.3",
+ "inherits": "^2.0.4",
+ "readable-stream": "^4.2.0"
+ }
+ },
+ "node_modules/buffer": {
+ "version": "6.0.3",
+ "resolved": "https://registry.npmjs.org/buffer/-/buffer-6.0.3.tgz",
+ "integrity": "sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "dependencies": {
+ "base64-js": "^1.3.1",
+ "ieee754": "^1.2.1"
+ }
+ },
"node_modules/buffer-equal-constant-time": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/buffer-equal-constant-time/-/buffer-equal-constant-time-1.0.1.tgz",
"integrity": "sha512-zRpUiDwd/xk6ADqPMATG8vc9VPrkck7T07OIx0gnjmJAnHnTVXNQG3vfvWNuiZIkwu9KrKdA1iJKfsfTVxE6NA=="
},
+ "node_modules/commander": {
+ "version": "11.1.0",
+ "resolved": "https://registry.npmjs.org/commander/-/commander-11.1.0.tgz",
+ "integrity": "sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==",
+ "engines": {
+ "node": ">=16"
+ }
+ },
+ "node_modules/debug": {
+ "version": "4.4.0",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.0.tgz",
+ "integrity": "sha512-6WTZ/IxCY/T6BALoZHaE4ctp9xm+Z5kY/pzYaCHRFeyVhojxlrm+46y68HA6hr0TcwEssoxNiDEUJQjfPZ/RYA==",
+ "dependencies": {
+ "ms": "^2.1.3"
+ },
+ "engines": {
+ "node": ">=6.0"
+ },
+ "peerDependenciesMeta": {
+ "supports-color": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/define-lazy-prop": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-2.0.0.tgz",
+ "integrity": "sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
"node_modules/ecdsa-sig-formatter": {
"version": "1.0.11",
"resolved": "https://registry.npmjs.org/ecdsa-sig-formatter/-/ecdsa-sig-formatter-1.0.11.tgz",
@@ -41,6 +424,111 @@
"safe-buffer": "^5.0.1"
}
},
+ "node_modules/event-target-shim": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/event-target-shim/-/event-target-shim-5.0.1.tgz",
+ "integrity": "sha512-i/2XbnSz/uxRCU6+NdVJgKWDTM427+MqYbkQzD321DuCQJUqOuJKIA0IM2+W2xtYHdKOmZ4dR6fExsd4SXL+WQ==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/events": {
+ "version": "3.3.0",
+ "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz",
+ "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==",
+ "engines": {
+ "node": ">=0.8.x"
+ }
+ },
+ "node_modules/http-proxy-agent": {
+ "version": "7.0.2",
+ "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-7.0.2.tgz",
+ "integrity": "sha512-T1gkAiYYDWYx3V5Bmyu7HcfcvL7mUrTWiM6yOfa3PIphViJ/gFPbvidQ+veqSOHci/PxBcDabeUNCzpOODJZig==",
+ "dependencies": {
+ "agent-base": "^7.1.0",
+ "debug": "^4.3.4"
+ },
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/https-proxy-agent": {
+ "version": "7.0.6",
+ "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz",
+ "integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==",
+ "dependencies": {
+ "agent-base": "^7.1.2",
+ "debug": "4"
+ },
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/iconv-lite": {
+ "version": "0.6.3",
+ "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz",
+ "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==",
+ "dependencies": {
+ "safer-buffer": ">= 2.1.2 < 3.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/ieee754": {
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz",
+ "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ]
+ },
+ "node_modules/inherits": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
+ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ=="
+ },
+ "node_modules/is-docker": {
+ "version": "2.2.1",
+ "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-2.2.1.tgz",
+ "integrity": "sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==",
+ "bin": {
+ "is-docker": "cli.js"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/is-wsl": {
+ "version": "2.2.0",
+ "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-2.2.0.tgz",
+ "integrity": "sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==",
+ "dependencies": {
+ "is-docker": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/js-md4": {
+ "version": "0.3.2",
+ "resolved": "https://registry.npmjs.org/js-md4/-/js-md4-0.3.2.tgz",
+ "integrity": "sha512-/GDnfQYsltsjRswQhN9fhv3EMw2sCpUdrdxyWDOUK7eyD++r3gRhzgiQgc/x4MAv2i1iuQ4lxO5mvqM3vj4bwA=="
+ },
"node_modules/jsonwebtoken": {
"version": "9.0.2",
"resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-9.0.2.tgz",
@@ -137,6 +625,74 @@
"resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
"integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA=="
},
+ "node_modules/mssql": {
+ "version": "11.0.1",
+ "resolved": "https://registry.npmjs.org/mssql/-/mssql-11.0.1.tgz",
+ "integrity": "sha512-KlGNsugoT90enKlR8/G36H0kTxPthDhmtNUCwEHvgRza5Cjpjoj+P2X6eMpFUDN7pFrJZsKadL4x990G8RBE1w==",
+ "dependencies": {
+ "@tediousjs/connection-string": "^0.5.0",
+ "commander": "^11.0.0",
+ "debug": "^4.3.3",
+ "rfdc": "^1.3.0",
+ "tarn": "^3.0.2",
+ "tedious": "^18.2.1"
+ },
+ "bin": {
+ "mssql": "bin/mssql"
+ },
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/native-duplexpair": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/native-duplexpair/-/native-duplexpair-1.0.0.tgz",
+ "integrity": "sha512-E7QQoM+3jvNtlmyfqRZ0/U75VFgCls+fSkbml2MpgWkWyz3ox8Y58gNhfuziuQYGNNQAbFZJQck55LHCnCK6CA=="
+ },
+ "node_modules/open": {
+ "version": "8.4.2",
+ "resolved": "https://registry.npmjs.org/open/-/open-8.4.2.tgz",
+ "integrity": "sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ==",
+ "dependencies": {
+ "define-lazy-prop": "^2.0.0",
+ "is-docker": "^2.1.1",
+ "is-wsl": "^2.2.0"
+ },
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/process": {
+ "version": "0.11.10",
+ "resolved": "https://registry.npmjs.org/process/-/process-0.11.10.tgz",
+ "integrity": "sha512-cdGef/drWFoydD1JsMzuFf8100nZl+GT+yacc2bEced5f9Rjk4z+WtFUTBu9PhOi9j/jfmBPu0mMEY4wIdAF8A==",
+ "engines": {
+ "node": ">= 0.6.0"
+ }
+ },
+ "node_modules/readable-stream": {
+ "version": "4.7.0",
+ "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.7.0.tgz",
+ "integrity": "sha512-oIGGmcpTLwPga8Bn6/Z75SVaH1z5dUut2ibSyAMVhmUggWpmDn2dapB0n7f8nwaSiRtepAsfJyfXIO5DCVAODg==",
+ "dependencies": {
+ "abort-controller": "^3.0.0",
+ "buffer": "^6.0.3",
+ "events": "^3.3.0",
+ "process": "^0.11.10",
+ "string_decoder": "^1.3.0"
+ },
+ "engines": {
+ "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
+ }
+ },
+ "node_modules/rfdc": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/rfdc/-/rfdc-1.4.1.tgz",
+ "integrity": "sha512-q1b3N5QkRUWUl7iyylaaj3kOpIT0N2i9MqIEQXP73GVsN9cw3fdx8X63cEmWhJGi2PPCF23Ijp7ktmd39rawIA=="
+ },
"node_modules/safe-buffer": {
"version": "5.2.1",
"resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz",
@@ -156,6 +712,11 @@
}
]
},
+ "node_modules/safer-buffer": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz",
+ "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg=="
+ },
"node_modules/semver": {
"version": "7.6.0",
"resolved": "https://registry.npmjs.org/semver/-/semver-7.6.0.tgz",
@@ -170,6 +731,74 @@
"node": ">=10"
}
},
+ "node_modules/sprintf-js": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.1.3.tgz",
+ "integrity": "sha512-Oo+0REFV59/rz3gfJNKQiBlwfHaSESl1pcGyABQsnnIfWOFt6JNj5gCog2U6MLZ//IGYD+nA8nI+mTShREReaA=="
+ },
+ "node_modules/stoppable": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/stoppable/-/stoppable-1.1.0.tgz",
+ "integrity": "sha512-KXDYZ9dszj6bzvnEMRYvxgeTHU74QBFL54XKtP3nyMuJ81CFYtABZ3bAzL2EdFUaEwJOBOgENyFj3R7oTzDyyw==",
+ "engines": {
+ "node": ">=4",
+ "npm": ">=6"
+ }
+ },
+ "node_modules/string_decoder": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz",
+ "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==",
+ "dependencies": {
+ "safe-buffer": "~5.2.0"
+ }
+ },
+ "node_modules/tarn": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/tarn/-/tarn-3.0.2.tgz",
+ "integrity": "sha512-51LAVKUSZSVfI05vjPESNc5vwqqZpbXCsU+/+wxlOrUjk2SnFTt97v9ZgQrD4YmxYW1Px6w2KjaDitCfkvgxMQ==",
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/tedious": {
+ "version": "18.6.1",
+ "resolved": "https://registry.npmjs.org/tedious/-/tedious-18.6.1.tgz",
+ "integrity": "sha512-9AvErXXQTd6l7TDd5EmM+nxbOGyhnmdbp/8c3pw+tjaiSXW9usME90ET/CRG1LN1Y9tPMtz/p83z4Q97B4DDpw==",
+ "dependencies": {
+ "@azure/core-auth": "^1.7.2",
+ "@azure/identity": "^4.2.1",
+ "@azure/keyvault-keys": "^4.4.0",
+ "@js-joda/core": "^5.6.1",
+ "@types/node": ">=18",
+ "bl": "^6.0.11",
+ "iconv-lite": "^0.6.3",
+ "js-md4": "^0.3.2",
+ "native-duplexpair": "^1.0.0",
+ "sprintf-js": "^1.1.3"
+ },
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/tslib": {
+ "version": "2.8.1",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz",
+ "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w=="
+ },
+ "node_modules/undici-types": {
+ "version": "6.20.0",
+ "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.20.0.tgz",
+ "integrity": "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="
+ },
+ "node_modules/uuid": {
+ "version": "8.3.2",
+ "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
+ "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==",
+ "bin": {
+ "uuid": "dist/bin/uuid"
+ }
+ },
"node_modules/yallist": {
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
diff --git a/packages/bruno-tests/collection/ping.bru b/packages/bruno-tests/collection/ping.bru
index 3abc7a2d4..8f4f3c6f7 100644
--- a/packages/bruno-tests/collection/ping.bru
+++ b/packages/bruno-tests/collection/ping.bru
@@ -9,3 +9,7 @@ get {
body: none
auth: none
}
+
+script:pre-request {
+ bru.runner.stopExecution();
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test JSON false response.bru b/packages/bruno-tests/collection/response-parsing/test JSON false response.bru
new file mode 100644
index 000000000..a507434e5
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test JSON false response.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test JSON false response
+ type: http
+ seq: 11
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "application/json" },
+ "content": "false"
+ }
+}
+
+assert {
+ res.body: eq false
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test JSON null response.bru b/packages/bruno-tests/collection/response-parsing/test JSON null response.bru
new file mode 100644
index 000000000..156aa7fbe
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test JSON null response.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test JSON null response
+ type: http
+ seq: 6
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "application/json" },
+ "content": "null"
+ }
+}
+
+assert {
+ res.body: eq null
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test JSON number response.bru b/packages/bruno-tests/collection/response-parsing/test JSON number response.bru
new file mode 100644
index 000000000..8f995b395
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test JSON number response.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test JSON number response
+ type: http
+ seq: 12
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "application/json" },
+ "content": "3.1"
+ }
+}
+
+assert {
+ res.body: eq 3.1
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test JSON response.bru b/packages/bruno-tests/collection/response-parsing/test JSON response.bru
new file mode 100644
index 000000000..018cce86d
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test JSON response.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test JSON response
+ type: http
+ seq: 2
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "application/json" },
+ "contentJSON": { "message": "hello" }
+ }
+}
+
+assert {
+ res.body.message: eq hello
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test JSON string response.bru b/packages/bruno-tests/collection/response-parsing/test JSON string response.bru
new file mode 100644
index 000000000..18a0e3909
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test JSON string response.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test JSON string response
+ type: http
+ seq: 7
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "application/json" },
+ "content": "\"ok\""
+ }
+}
+
+assert {
+ res.body: eq ok
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test JSON string with quotes response.bru b/packages/bruno-tests/collection/response-parsing/test JSON string with quotes response.bru
new file mode 100644
index 000000000..d262ff084
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test JSON string with quotes response.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test JSON string with quotes response
+ type: http
+ seq: 8
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "application/json" },
+ "contentJSON": "\"ok\""
+ }
+}
+
+assert {
+ res.body: eq '"ok"'
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test JSON true response.bru b/packages/bruno-tests/collection/response-parsing/test JSON true response.bru
new file mode 100644
index 000000000..7f4c0bd65
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test JSON true response.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test JSON true response
+ type: http
+ seq: 10
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "application/json" },
+ "content": "true"
+ }
+}
+
+assert {
+ res.body: eq true
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test JSON unsafe-int response.bru b/packages/bruno-tests/collection/response-parsing/test JSON unsafe-int response.bru
new file mode 100644
index 000000000..db4fe3bcc
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test JSON unsafe-int response.bru
@@ -0,0 +1,26 @@
+meta {
+ name: test JSON unsafe-int response
+ type: http
+ seq: 13
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "application/json" },
+ "content": "90071992547409919876"
+ }
+}
+
+assert {
+ res.body.toString(): eq 90071992547409920000
+}
+
+docs {
+ Note: This test is not perfect, we should match the unparsed raw-response with the expected string version of the unsafe-integer
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test binary response.bru b/packages/bruno-tests/collection/response-parsing/test binary response.bru
new file mode 100644
index 000000000..53e6e3436
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test binary response.bru
@@ -0,0 +1,34 @@
+meta {
+ name: test binary response
+ type: http
+ seq: 4
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "type": "application/octet-stream",
+ "contentBase64": "+Z1P82iH1wmbILfvnhvjQVbVAktP4TzltpxYD74zNyA="
+ }
+}
+
+tests {
+ test("response matches the expectation after utf-8 decoding(needs improvement)", function () {
+ expect(res.getStatus()).to.equal(200);
+ const dataBinary = Buffer.from("+Z1P82iH1wmbILfvnhvjQVbVAktP4TzltpxYD74zNyA=", "base64");
+ expect(res.body).to.equal(dataBinary.toString("utf-8"));
+ });
+}
+
+docs {
+ Note:
+
+ This test is not perfect and needs to be improved by direclty matching expected binary data with raw-response.
+
+ Currently res.body is decoded with `utf-8` by default and looses data in the process. We need some property in `res` which gives access to raw-data/Buffer.
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test html response.bru b/packages/bruno-tests/collection/response-parsing/test html response.bru
new file mode 100644
index 000000000..48bf15310
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test html response.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test html response
+ type: http
+ seq: 5
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "text/html" },
+ "content": "hello "
+ }
+}
+
+assert {
+ res.body: eq hello
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test image response.bru b/packages/bruno-tests/collection/response-parsing/test image response.bru
new file mode 100644
index 000000000..4ca65adab
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test image response.bru
@@ -0,0 +1,18 @@
+meta {
+ name: test image response
+ type: http
+ seq: 3
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "type": "image/png",
+ "contentBase64": "iVBORw0KGgoAAAANSUhEUgAAAGQAAABkAQMAAABKLAcXAAAAIGNIUk0AAHomAACAhAAA+gAAAIDoAAB1MAAA6mAAADqYAAAXcJy6UTwAAAAGUExURQCqAP///59OGOoAAAABYktHRAH/Ai3eAAAAB3RJTUUH6QMHCwUNKHvFmgAAABRJREFUOMtjYBgFo2AUjIJRQE8AAAV4AAEpcbn8AAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDI1LTAzLTA3VDExOjA1OjEzKzAwOjAwQkgGWgAAACV0RVh0ZGF0ZTptb2RpZnkAMjAyNS0wMy0wN1QxMTowNToxMyswMDowMDMVvuYAAAAodEVYdGRhdGU6dGltZXN0YW1wADIwMjUtMDMtMDdUMTE6MDU6MTMrMDA6MDBkAJ85AAAAAElFTkSuQmCC"
+ }
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test invalid JSON response with formatting.bru b/packages/bruno-tests/collection/response-parsing/test invalid JSON response with formatting.bru
new file mode 100644
index 000000000..57e2a6872
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test invalid JSON response with formatting.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test invalid JSON response with formatting
+ type: http
+ seq: 19
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "application/json" },
+ "content": "hello\n\tworld"
+ }
+}
+
+assert {
+ res.body: eq hello\n\tworld
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test plain text response with formatting.bru b/packages/bruno-tests/collection/response-parsing/test plain text response with formatting.bru
new file mode 100644
index 000000000..af9a87144
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test plain text response with formatting.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test plain text response with formatting
+ type: http
+ seq: 18
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "text/plain" },
+ "content": "hello\n\tworld"
+ }
+}
+
+assert {
+ res.body: eq hello\n\tworld
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test plain text response.bru b/packages/bruno-tests/collection/response-parsing/test plain text response.bru
new file mode 100644
index 000000000..fbb884483
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test plain text response.bru
@@ -0,0 +1,23 @@
+meta {
+ name: test plain text response
+ type: http
+ seq: 1
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "text/plain" },
+ "content": "hello"
+ }
+}
+
+assert {
+ res.body: eq hello
+}
+
diff --git a/packages/bruno-tests/collection/response-parsing/test plain text utf16 response.bru b/packages/bruno-tests/collection/response-parsing/test plain text utf16 response.bru
new file mode 100644
index 000000000..096985f0a
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test plain text utf16 response.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test plain text utf16 response
+ type: http
+ seq: 14
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "text/plain; charset=utf-16" },
+ "contentBase64": "dABoAGkAcwAgAGkAcwAgAGUAbgBjAG8AZABlAGQAIAB3AGkAdABoACAAdQB0AGYAMQA2AA=="
+ }
+}
+
+assert {
+ res.body: eq "this is encoded with utf16"
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test plain text utf16-be with BOM response.bru b/packages/bruno-tests/collection/response-parsing/test plain text utf16-be with BOM response.bru
new file mode 100644
index 000000000..cffe54a97
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test plain text utf16-be with BOM response.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test plain text utf16-be with BOM response
+ type: http
+ seq: 15
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "text/plain; charset=utf-16" },
+ "contentBase64": "/v8AdABoAGkAcwAgAGkAcwAgAGUAbgBjAG8AZABlAGQAIAB3AGkAdABoACAAdQB0AGYAMQA2AC0AYgBlACAAdwBpAHQAaAAgAEIATwBN"
+ }
+}
+
+assert {
+ res.body: eq "this is encoded with utf16-be with BOM"
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test plain text utf16-le with BOM response.bru b/packages/bruno-tests/collection/response-parsing/test plain text utf16-le with BOM response.bru
new file mode 100644
index 000000000..5d29a2701
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test plain text utf16-le with BOM response.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test plain text utf16-le with BOM response
+ type: http
+ seq: 16
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "text/plain; charset=utf-16" },
+ "contentBase64": "//50AGgAaQBzACAAaQBzACAAZQBuAGMAbwBkAGUAZAAgAHcAaQB0AGgAIAB1AHQAZgAxADYALQBsAGUAIAB3AGkAdABoACAAQgBPAE0A"
+ }
+}
+
+assert {
+ res.body: eq "this is encoded with utf16-le with BOM"
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test plain text utf8 with BOM response.bru b/packages/bruno-tests/collection/response-parsing/test plain text utf8 with BOM response.bru
new file mode 100644
index 000000000..055386d79
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test plain text utf8 with BOM response.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test plain text utf8 with BOM response
+ type: http
+ seq: 17
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "text/plain; charset=utf8" },
+ "contentBase64": "77u/dGhpcyBpcyB1dGY4IGVuY29kZWQgd2l0aCBCT00sIHdoeSBub3Q/"
+ }
+}
+
+assert {
+ res.body: eq "this is utf8 encoded with BOM, why not?"
+}
diff --git a/packages/bruno-tests/collection/response-parsing/test xml response.bru b/packages/bruno-tests/collection/response-parsing/test xml response.bru
new file mode 100644
index 000000000..5e562ada2
--- /dev/null
+++ b/packages/bruno-tests/collection/response-parsing/test xml response.bru
@@ -0,0 +1,22 @@
+meta {
+ name: test xml response
+ type: http
+ seq: 9
+}
+
+post {
+ url: {{httpfaker}}/api/echo/custom
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "headers": { "content-type": "application/xml" },
+ "content": "hello "
+ }
+}
+
+assert {
+ res.body: eq hello
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/cookies/Redirect Cookie Save.bru b/packages/bruno-tests/collection/scripting/api/bru/cookies/Redirect Cookie Save.bru
new file mode 100644
index 000000000..f120acdfb
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/cookies/Redirect Cookie Save.bru
@@ -0,0 +1,32 @@
+meta {
+ name: Redirect Cookie Save
+ type: http
+ seq: 9
+}
+
+get {
+ url: https://httpbun.com/mix/s=302/c=foo:bar/r=https%3A%2F%2Fhttpbun.org%2Fget
+ body: none
+ auth: inherit
+}
+
+tests {
+ const jar = bru.cookies.jar()
+
+ const cookieData = await jar.getCookie(
+ "https://httpbun.com",
+ "foo"
+ );
+
+ test("should store redirect cookie under initial request domain", function () {
+ expect(cookieData).to.not.be.undefined;
+ expect(cookieData.key).to.equal("foo");
+ expect(cookieData.value).to.equal("bar");
+ });
+
+ jar.clear();
+}
+
+settings {
+ encodeUrl: true
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/cookies/clear.bru b/packages/bruno-tests/collection/scripting/api/bru/cookies/clear.bru
new file mode 100644
index 000000000..2f0000b3d
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/cookies/clear.bru
@@ -0,0 +1,67 @@
+meta {
+ name: clear
+ type: http
+ seq: 6
+}
+
+get {
+ url: {{host}}/ping
+ body: none
+ auth: inherit
+}
+
+script:pre-request {
+ const jar = bru.cookies.jar()
+
+ await jar.setCookies('https://testbench-sanity.usebruno.com', [
+ {
+ key: 'test_cookie_1',
+ value: 'value1',
+ path: '/',
+ secure: true
+ },
+ {
+ key: 'test_cookie_2',
+ value: 'value2',
+ path: '/',
+ secure: true
+ }
+ ]);
+
+ console.log("Test cookies set up for clear test");
+}
+
+script:post-response {
+ const jar = bru.cookies.jar()
+
+ const cookiesBeforeClear = await jar.getCookies('https://testbench-sanity.usebruno.com');
+ console.log(`Found ${cookiesBeforeClear.length} cookies before clearing`);
+
+ test("cookies should exist before clearing", function() {
+ expect(cookiesBeforeClear).to.be.an('array');
+ expect(cookiesBeforeClear.length).to.be.greaterThan(0);
+ });
+
+ await jar.clear();
+ console.log("Cookie jar cleared");
+}
+
+tests {
+ const jar = bru.cookies.jar()
+
+ test("should have no cookies after clearing", async function() {
+ const cookiesAfterClear = await jar.getCookies('https://testbench-sanity.usebruno.com');
+ expect(cookiesAfterClear).to.be.an('array');
+ expect(cookiesAfterClear.length).to.equal(0);
+ });
+
+ jar.clear(function(error) {
+ test("should successfully clear with callback", function() {
+ expect(error).to.be.null;
+ });
+ });
+}
+
+settings {
+ encodeUrl: true
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/cookies/deleteCookie.bru b/packages/bruno-tests/collection/scripting/api/bru/cookies/deleteCookie.bru
new file mode 100644
index 000000000..d1d1da1c2
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/cookies/deleteCookie.bru
@@ -0,0 +1,75 @@
+meta {
+ name: deleteCookie
+ type: http
+ seq: 5
+}
+
+get {
+ url: {{host}}/ping
+ body: none
+ auth: inherit
+}
+
+script:pre-request {
+ const jar = bru.cookies.jar()
+
+ await jar.setCookies('https://testbench-sanity.usebruno.com', [
+ {
+ key: 'cookie_to_delete',
+ value: 'will_be_deleted',
+ path: '/',
+ secure: true
+ },
+ {
+ key: 'cookie_to_keep',
+ value: 'should_remain',
+ path: '/',
+ secure: true
+ }
+ ]);
+
+ console.log("Test cookies set up");
+}
+
+script:post-response {
+ const jar = bru.cookies.jar()
+
+ const cookiesBefore = await jar.getCookies('https://testbench-sanity.usebruno.com');
+ console.log(`Found ${cookiesBefore.length} cookies before deletion`);
+
+ const targetCookie = await jar.getCookie('https://testbench-sanity.usebruno.com', 'cookie_to_delete');
+ test("cookie should exist before deletion", function() {
+ expect(targetCookie).to.not.be.null;
+ expect(targetCookie.key).to.equal('cookie_to_delete');
+ });
+
+ await jar.deleteCookie('https://testbench-sanity.usebruno.com', 'cookie_to_delete');
+ console.log("Cookie deleted");
+}
+
+tests {
+ const jar = bru.cookies.jar()
+
+ test("should have deleted the target cookie", async function() {
+ const deletedCookie = await jar.getCookie('https://testbench-sanity.usebruno.com', 'cookie_to_delete');
+ expect(deletedCookie).to.be.null;
+ });
+
+ test("should keep other cookies intact", async function() {
+ const cookieToKeep = await jar.getCookie('https://testbench-sanity.usebruno.com', 'cookie_to_keep');
+ expect(cookieToKeep).to.not.be.null;
+ expect(cookieToKeep.key).to.equal('cookie_to_keep');
+ });
+
+ jar.deleteCookie("https://testbench-sanity.usebruno.com", "cookie_to_keep", function(error) {
+ test("should successfully delete with callback", function() {
+ expect(error).to.be.null;
+ });
+ });
+
+ jar.clear()
+}
+
+settings {
+ encodeUrl: true
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/cookies/deleteCookies.bru b/packages/bruno-tests/collection/scripting/api/bru/cookies/deleteCookies.bru
new file mode 100644
index 000000000..03e604e8c
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/cookies/deleteCookies.bru
@@ -0,0 +1,106 @@
+meta {
+ name: deleteCookies
+ type: http
+ seq: 7
+}
+
+get {
+ url: {{host}}/ping
+ body: none
+ auth: inherit
+}
+
+script:pre-request {
+ const jar = bru.cookies.jar()
+
+ // Set up test cookies before the request
+ try {
+ await jar.setCookies('https://testbench-sanity.usebruno.com', [
+ {
+ key: 'test_cookie_1',
+ value: 'value1',
+ path: '/',
+ httpOnly: false,
+ secure: true
+ },
+ {
+ key: 'test_cookie_2',
+ value: 'value2',
+ path: '/',
+ httpOnly: true,
+ secure: true
+ },
+ {
+ key: 'test_cookie_3',
+ value: 'value3',
+ path: '/api',
+ httpOnly: false,
+ secure: true
+ }
+ ]);
+
+ console.log("Test cookies set up successfully in pre-request script");
+
+ // Verify cookies were set
+ const cookies = await jar.getCookies('https://testbench-sanity.usebruno.com');
+ console.log(`${cookies.length} cookies set for domain`);
+
+ } catch (error) {
+ console.error("Failed to set up test cookies:", error);
+ throw new Error(`Pre-request cookie setup failed: ${error.message || error}`);
+ }
+}
+
+script:post-response {
+ const jar = bru.cookies.jar()
+
+ // Verify cookies exist before deletion
+ try {
+ const cookiesBeforeDeletion = await jar.getCookies('https://testbench-sanity.usebruno.com');
+
+ test("cookies should exist before clearing", function() {
+ expect(cookiesBeforeDeletion).to.be.an('array');
+ expect(cookiesBeforeDeletion.length).to.be.greaterThan(0);
+ });
+
+
+ if (cookiesBeforeDeletion.length === 0) {
+ throw new Error("No cookies found to delete - setup may have failed");
+ }
+
+ // Delete all cookies for the domain
+ await jar.deleteCookies('https://testbench-sanity.usebruno.com');
+ console.log("deleteCookies operation completed in post-response");
+
+ // Verify deletion worked
+ const cookiesAfterDeletion = await jar.getCookies('https://testbench-sanity.usebruno.com');
+ console.log(`Found ${cookiesAfterDeletion.length} cookies after deletion`);
+
+ } catch (error) {
+ console.error("Delete cookies error in post-response:", error);
+ throw new Error(`Failed to delete cookies in post-response: ${error.message || error}`);
+ }
+}
+
+tests {
+ const jar = bru.cookies.jar()
+
+ jar.getCookies("https://testbench-sanity.usebruno.com", function(error, remainingCookies) {
+ if(error) {
+ console.error("Error checking remaining cookies:", error)
+ throw new Error(`Failed to get remaining cookies: ${error.message || error}`)
+ }
+
+ test("should have no cookies remaining after deletion", function() {
+ expect(remainingCookies).to.be.an('array');
+ expect(remainingCookies.length).to.equal(0);
+ console.log("✓ Confirmed: no cookies remain for domain after deleteCookies");
+ });
+ });
+
+ jar.clear()
+}
+
+settings {
+ encodeUrl: true
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/cookies/folder.bru b/packages/bruno-tests/collection/scripting/api/bru/cookies/folder.bru
new file mode 100644
index 000000000..1ae98288d
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/cookies/folder.bru
@@ -0,0 +1,8 @@
+meta {
+ name: cookies
+ seq: 17
+}
+
+auth {
+ mode: inherit
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/cookies/getCookie.bru b/packages/bruno-tests/collection/scripting/api/bru/cookies/getCookie.bru
new file mode 100644
index 000000000..0e4a2bdf5
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/cookies/getCookie.bru
@@ -0,0 +1,44 @@
+meta {
+ name: getCookie
+ type: http
+ seq: 1
+}
+
+get {
+ url: {{host}}/ping
+ body: none
+ auth: inherit
+}
+
+script:pre-request {
+ const jar = bru.cookies.jar()
+
+ jar.setCookie("https://testbench-sanity.usebruno.com", "name", "value")
+}
+
+tests {
+ const jar = bru.cookies.jar()
+
+ jar.getCookie("https://testbench-sanity.usebruno.com", "name", function(error, data) {
+ if(error) {
+ console.error("Cookie retrieval error:", error)
+ throw new Error(`Failed to get cookie: ${error.message || error}`)
+ }
+
+ test("should successfully retrieve cookie data", function() {
+ expect(data).to.have.property('key');
+ expect(data).to.have.property('value');
+ expect(data.key).to.equal("name");
+ expect(data.value).to.be.a('string');
+ expect(data.value).to.not.be.empty;
+ expect(data.domain).to.include('usebruno.com');
+ console.log("Retrieved cookie:", data);
+ });
+ })
+
+ jar.clear()
+}
+
+settings {
+ encodeUrl: true
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/cookies/getCookies.bru b/packages/bruno-tests/collection/scripting/api/bru/cookies/getCookies.bru
new file mode 100644
index 000000000..7c09371c7
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/cookies/getCookies.bru
@@ -0,0 +1,52 @@
+meta {
+ name: getCookies
+ type: http
+ seq: 3
+}
+
+get {
+ url: {{host}}/ping
+ body: none
+ auth: inherit
+}
+
+tests {
+ const jar = bru.cookies.jar()
+
+ jar.getCookies("https://testbench-sanity.usebruno.com", function(error, data) {
+ if(error) {
+ console.error("Cookies retrieval error:", error)
+ throw new Error(`Failed to get cookies: ${error.message || error}`)
+ }
+
+ test("should successfully retrieve cookies array", function() {
+ expect(error).to.be.null;
+ expect(data).to.not.be.null;
+ expect(data).to.be.an('array');
+ console.log("Retrieved cookies count:", data.length);
+ });
+
+ test("should have valid cookie structure in array", function() {
+ data.forEach((cookie, index) => {
+ expect(cookie).to.have.property('key');
+ expect(cookie).to.have.property('value');
+ expect(cookie.key).to.be.a('string');
+ expect(cookie.value).to.be.a('string');
+ expect(cookie.domain).to.include('usebruno.com');
+ console.log(`Cookie ${index + 1}:`, cookie);
+ });
+ });
+
+ test("should contain expected cookie properties", function() {
+ const cookieKeys = data.map(cookie => cookie.key);
+ expect(cookieKeys).to.be.an('array');
+ console.log("Found cookie keys:", cookieKeys);
+ });
+ })
+
+ jar.clear()
+}
+
+settings {
+ encodeUrl: true
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/cookies/setCookie.bru b/packages/bruno-tests/collection/scripting/api/bru/cookies/setCookie.bru
new file mode 100644
index 000000000..5449a248a
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/cookies/setCookie.bru
@@ -0,0 +1,69 @@
+meta {
+ name: setCookie
+ type: http
+ seq: 2
+}
+
+get {
+ url: {{host}}/ping
+ body: none
+ auth: inherit
+}
+
+script:pre-request {
+ const jar = bru.cookies.jar()
+
+ // Set cookie before the request
+ try {
+ await jar.setCookie("https://testbench-sanity.usebruno.com", {
+ key: "auth",
+ value: "1234",
+ path: "/path"
+ });
+
+ console.log("Cookie set successfully in pre-request script");
+
+ } catch (error) {
+ console.error("Cookie setting error in pre-request:", error);
+ throw new Error(`Pre-request setCookie failed: ${error.message || error}`);
+ }
+}
+
+tests {
+ const jar = bru.cookies.jar()
+
+ test("should have set cookie successfully", function() {
+ console.log("Verifying cookie set in pre-request script");
+ });
+
+ // Test: Verify the cookie was set by retrieving it
+ const cookieData = await jar.getCookie("https://testbench-sanity.usebruno.com/path", "auth");
+
+ test("should retrieve the set cookie with correct properties", function() {
+ expect(cookieData.key).to.equal("auth");
+ expect(cookieData.value).to.equal("1234");
+ expect(cookieData.path).to.equal("/path");
+ expect(cookieData.domain).to.include('usebruno.com');
+ console.log("Retrieved and verified cookie:", cookieData);
+ });
+
+ // Test: Additional verification - check all cookies for the domain
+ const allCookies = await jar.getCookies("https://testbench-sanity.usebruno.com/path");
+
+ test("should find the cookie in domain cookie list", function() {
+ expect(allCookies).to.be.an('array');
+ expect(allCookies.length).to.be.at.least(1);
+
+ const authCookie = allCookies.find(c => c.key === 'auth');
+ expect(authCookie).to.not.be.undefined;
+ expect(authCookie.value).to.equal("1234");
+
+ console.log("All cookies for domain:", allCookies.map(c => ({ key: c.key, value: c.value, path: c.path })));
+ });
+
+ jar.clear()
+}
+
+settings {
+ encodeUrl: true
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/cookies/setCookieHeader.bru b/packages/bruno-tests/collection/scripting/api/bru/cookies/setCookieHeader.bru
new file mode 100644
index 000000000..c388917ba
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/cookies/setCookieHeader.bru
@@ -0,0 +1,40 @@
+meta {
+ name: setCookie header inclusion
+ type: http
+ seq: 6
+}
+
+post {
+ url: {{echo-host}}
+ body: none
+ auth: inherit
+}
+
+script:pre-request {
+ const jar = bru.cookies.jar();
+
+ // Set a cookie that should be sent with the upcoming request
+ await jar.setCookie('https://echo.usebruno.com', {
+ key: 'auth',
+ value: 'token123',
+ path: '/',
+ secure: false
+ });
+}
+
+tests {
+ const cookieHeader = res.getHeader('cookie');
+
+ test('should attach auth cookie in request headers', function () {
+ expect(cookieHeader).to.be.a('string');
+ expect(cookieHeader).to.include('auth=token123');
+ });
+
+ // Clean up the jar so other tests are not affected
+ const jar = bru.cookies.jar();
+ await jar.clear();
+}
+
+settings {
+ encodeUrl: false
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/cookies/setCookies.bru b/packages/bruno-tests/collection/scripting/api/bru/cookies/setCookies.bru
new file mode 100644
index 000000000..87cefde76
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/cookies/setCookies.bru
@@ -0,0 +1,85 @@
+meta {
+ name: setCookies
+ type: http
+ seq: 4
+}
+
+get {
+ url: {{host}}/ping
+ body: none
+ auth: inherit
+}
+
+script:pre-request {
+ const jar = bru.cookies.jar()
+
+ // Set multiple cookies before the request
+ try {
+ await jar.setCookies('https://example.com', [
+ {
+ key: 'auth',
+ value: 'abc123',
+ path: '/path',
+ httpOnly: true,
+ secure: true,
+ expires: new Date(Date.now() + 24 * 60 * 60 * 1000)
+ },
+ {
+ key: 'session',
+ value: 'xyz789',
+ path: '/foo',
+ httpOnly: true,
+ secure: true,
+ }
+ ]);
+
+ console.log("Multiple cookies set successfully in pre-request script");
+
+ } catch (error) {
+ console.error("setCookies operation failed in pre-request:", error);
+ throw new Error(`Pre-request setCookies failed: ${error.message || error}`);
+ }
+}
+
+tests {
+ const jar = bru.cookies.jar()
+
+ test("should have set multiple cookies successfully", function() {
+ console.log("Verifying cookies set in pre-request script");
+ });
+
+ // Test: Verify first cookie was set correctly
+ const authCookie = await jar.getCookie('https://example.com/path', 'auth');
+
+ test("should retrieve first cookie with correct properties", function() {
+ expect(authCookie.key).to.equal("auth");
+ expect(authCookie.value).to.equal("abc123");
+ expect(authCookie.path).to.equal("/path");
+ expect(authCookie.httpOnly).to.be.true;
+ expect(authCookie.secure).to.be.true;
+ expect(authCookie.domain).to.include('example.com');
+ console.log("Auth cookie verified:", authCookie);
+ });
+
+ // Test: Verify second cookie was set correctly
+ const sessionCookie = await jar.getCookie('https://example.com/foo', 'session');
+
+ test("should retrieve second cookie with correct properties", function() {
+ expect(sessionCookie).to.not.be.null;
+ if (sessionCookie) {
+ expect(sessionCookie.key).to.equal("session");
+ expect(sessionCookie.value).to.equal("xyz789");
+ expect(sessionCookie.path).to.equal("/foo");
+ expect(sessionCookie.httpOnly).to.be.true;
+ expect(sessionCookie.secure).to.be.true;
+ expect(sessionCookie.domain).to.include('example.com');
+ console.log("Session cookie verified:", sessionCookie);
+ }
+ });
+
+ jar.clear()
+}
+
+settings {
+ encodeUrl: true
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/getCollectionName.bru b/packages/bruno-tests/collection/scripting/api/bru/getCollectionName.bru
new file mode 100644
index 000000000..3302d38fd
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/getCollectionName.bru
@@ -0,0 +1,17 @@
+meta {
+ name: getCollectionName
+ type: http
+ seq: 13
+}
+
+get {
+ url: {{host}}/ping
+ body: none
+ auth: inherit
+}
+
+tests {
+ test("Check if collection name is bruno-testbench", function () {
+ expect(bru.getCollectionName()).to.eql("bruno-testbench");
+ });
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/interpolate.bru b/packages/bruno-tests/collection/scripting/api/bru/interpolate.bru
new file mode 100644
index 000000000..a8e6dff76
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/interpolate.bru
@@ -0,0 +1,39 @@
+meta {
+ name: interpolate
+ type: http
+ seq: 13
+}
+
+get {
+ url: {{host}}/ping
+ body: none
+ auth: none
+}
+
+tests {
+ test("should interpolate envs", function() {
+ const interpolated = bru.interpolate("url: {{host}}")
+ expect(interpolated).to.equal("url: https://testbench-sanity.usebruno.com");
+ });
+
+ test("should interpolate random variables", function() {
+ const a = bru.interpolate("{{$randomInt}}")
+ const b = bru.interpolate("{{$randomInt}}")
+ expect(a).to.not.equal(b)
+ });
+
+ const randomObj = {
+ host: "{{host}}",
+ int: "{{$randomInt}}",
+ timestamp: "{{$timestamp}}"
+ }
+
+ test("should interpolate objects with vars, random vars", function() {
+ const objA = bru.interpolate(randomObj)
+ const objB = bru.interpolate(randomObj)
+
+ expect(objA).to.be.an("object")
+ expect(objB).to.be.an("object")
+ expect(objA).to.not.deep.eql(objB)
+ });
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/runRequest-1.bru b/packages/bruno-tests/collection/scripting/api/bru/runRequest-1.bru
new file mode 100644
index 000000000..95b87239f
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/runRequest-1.bru
@@ -0,0 +1,60 @@
+meta {
+ name: runRequest-1
+ type: http
+ seq: 10
+}
+
+post {
+ url: {{echo-host}}
+ body: text
+ auth: none
+}
+
+body:text {
+ bruno
+}
+
+script:pre-request {
+ // reset values
+ bru.setVar('run-request-runtime-var', null);
+ bru.setEnvVar('run-request-env-var', null);
+ bru.setGlobalEnvVar('run-request-global-env-var', null);
+
+ // the above vars will be set in the below request
+ const resp = await bru.runRequest('scripting/api/bru/runRequest-2');
+
+ bru.setVar('run-request-resp', {
+ data: resp?.data,
+ statusText: resp?.statusText,
+ status: resp?.status
+ });
+}
+
+tests {
+ test("should get runtime var set in runRequest-2", function() {
+ const val = bru.getVar("run-request-runtime-var");
+ expect(val).to.equal("run-request-runtime-var-value");
+ });
+
+ test("should get env var set in runRequest-2", function() {
+ const val = bru.getEnvVar("run-request-env-var");
+ expect(val).to.equal("run-request-env-var-value");
+ });
+
+ test("should get global env var set in runRequest-2", function() {
+ const val = bru.getGlobalEnvVar("run-request-global-env-var");
+ const executionMode = req.getExecutionMode();
+ if (executionMode == 'runner') {
+ expect(val).to.equal("run-request-global-env-var-value");
+ }
+ });
+
+ test("should get response of runRequest-2", function() {
+ const val = bru.getVar('run-request-resp');
+ expect(JSON.stringify(val)).to.equal(JSON.stringify({
+ "data": "bruno",
+ "statusText": "OK",
+ "status": 200
+ }));
+ });
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/runRequest-2.bru b/packages/bruno-tests/collection/scripting/api/bru/runRequest-2.bru
new file mode 100644
index 000000000..7a5f4d08d
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/runRequest-2.bru
@@ -0,0 +1,21 @@
+meta {
+ name: runRequest-2
+ type: http
+ seq: 11
+}
+
+post {
+ url: {{echo-host}}
+ body: text
+ auth: none
+}
+
+body:text {
+ bruno
+}
+
+script:pre-request {
+ bru.setVar('run-request-runtime-var', 'run-request-runtime-var-value');
+ bru.setEnvVar('run-request-env-var', 'run-request-env-var-value');
+ bru.setGlobalEnvVar('run-request-global-env-var', 'run-request-global-env-var-value');
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/runRequest.bru b/packages/bruno-tests/collection/scripting/api/bru/runRequest.bru
new file mode 100644
index 000000000..7eb0e332c
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/runRequest.bru
@@ -0,0 +1,96 @@
+meta {
+ name: runRequest
+ type: http
+ seq: 2
+}
+
+post {
+ url: {{host}}/api/echo/json
+ body: json
+ auth: none
+}
+
+headers {
+ foo: bar
+}
+
+auth:basic {
+ username: asd
+ password: j
+}
+
+auth:bearer {
+ token:
+}
+
+body:json {
+ {
+ "hello": "bruno"
+ }
+}
+
+assert {
+ res.status: eq 200
+}
+
+script:pre-request {
+ bru.setVar("runRequest-ping-res-1", null);
+ bru.setVar("runRequest-ping-res-2", null);
+ bru.setVar("runRequest-ping-res-3", null);
+
+ let pingRes = await bru.runRequest('ping');
+ bru.setVar('runRequest-ping-res-1', {
+ data: pingRes?.data,
+ statusText: pingRes?.statusText,
+ status: pingRes?.status
+ });
+}
+
+script:post-response {
+ let pingRes = await bru.runRequest('ping');
+ bru.setVar('runRequest-ping-res-2', {
+ data: pingRes?.data,
+ statusText: pingRes?.statusText,
+ status: pingRes?.status
+ });
+}
+
+tests {
+ const pingRes = await bru.runRequest('ping');
+ bru.setVar('runRequest-ping-res-3', {
+ data: pingRes?.data,
+ statusText: pingRes?.statusText,
+ status: pingRes?.status
+ });
+
+ test("should run request and return valid response in pre-request script", function() {
+ const expectedPingRes = {
+ data: "pong",
+ statusText: "OK",
+ status: 200
+ };
+ const pingRes = bru.getVar('runRequest-ping-res-1');
+ expect(pingRes).to.eql(expectedPingRes);
+ });
+
+ test("should run request and return valid response in post-response script", function() {
+ const expectedPingRes = {
+ data: "pong",
+ statusText: "OK",
+ status: 200
+ };
+ const pingRes = bru.getVar('runRequest-ping-res-2');
+ expect(pingRes).to.eql(expectedPingRes);
+ });
+
+ test("should run request and return valid response in tests script", function() {
+ const expectedPingRes = {
+ data: "pong",
+ statusText: "OK",
+ status: 200
+ };
+ const pingRes = bru.getVar('runRequest-ping-res-3');
+ expect(pingRes).to.eql(expectedPingRes);
+ });
+
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/runner/1.bru b/packages/bruno-tests/collection/scripting/api/bru/runner/1.bru
new file mode 100644
index 000000000..97a7edbb6
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/runner/1.bru
@@ -0,0 +1,19 @@
+meta {
+ name: 1
+ type: http
+ seq: 1
+}
+
+post {
+ url: https://echo.usebruno.com
+ body: none
+ auth: none
+}
+
+script:pre-request {
+ bru.setVar('bru-runner-req', 1);
+}
+
+script:post-response {
+ bru.setVar('bru.runner.skipRequest', true);
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/runner/2.bru b/packages/bruno-tests/collection/scripting/api/bru/runner/2.bru
new file mode 100644
index 000000000..b1be74b22
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/runner/2.bru
@@ -0,0 +1,19 @@
+meta {
+ name: 2
+ type: http
+ seq: 2
+}
+
+post {
+ url: https://echo.usebruno.com
+ body: none
+ auth: none
+}
+
+script:pre-request {
+ bru.runner.skipRequest();
+}
+
+script:post-response {
+ bru.setVar('bru.runner.skipRequest', false);
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/runner/3.bru b/packages/bruno-tests/collection/scripting/api/bru/runner/3.bru
new file mode 100644
index 000000000..4abe00b4c
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/runner/3.bru
@@ -0,0 +1,11 @@
+meta {
+ name: 3
+ type: http
+ seq: 3
+}
+
+post {
+ url: https://echo.usebruno.com
+ body: none
+ auth: none
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/send-request/folder.bru b/packages/bruno-tests/collection/scripting/api/bru/send-request/folder.bru
new file mode 100644
index 000000000..02561d36e
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/send-request/folder.bru
@@ -0,0 +1,8 @@
+meta {
+ name: send-request
+ seq: 16
+}
+
+auth {
+ mode: inherit
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/send-request/get-url-string.bru b/packages/bruno-tests/collection/scripting/api/bru/send-request/get-url-string.bru
new file mode 100644
index 000000000..161f6d763
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/send-request/get-url-string.bru
@@ -0,0 +1,18 @@
+meta {
+ name: get-url-string
+ type: http
+ seq: 1
+}
+
+post {
+ url: https://echo.usebruno.com
+ body: none
+ auth: inherit
+}
+
+tests {
+ await test("send request with a get url string", async () => {
+ const res = await bru.sendRequest("https://testbench-sanity.usebruno.com/ping");
+ expect(res.data).to.eql('pong');
+ });
+}
diff --git a/packages/bruno-tests/collection/scripting/api/bru/send-request/usage-patterns.bru b/packages/bruno-tests/collection/scripting/api/bru/send-request/usage-patterns.bru
new file mode 100644
index 000000000..bb80b3346
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/bru/send-request/usage-patterns.bru
@@ -0,0 +1,80 @@
+meta {
+ name: usage-patterns
+ type: http
+ seq: 1
+}
+
+post {
+ url: https://echo.usebruno.com
+ body: none
+ auth: inherit
+}
+
+tests {
+ // pattern 1: using async/await
+ await test("post request with async/await - success case", async () => {
+ const res = await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ data: 'ping'
+ });
+ expect(res.data).to.eql('ping');
+ });
+
+ await test("post request with async/await - error case", async () => {
+ try {
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com/invalid',
+ method: 'POST',
+ data: 'ping'
+ });
+ }
+ catch(err) {
+ expect(err.status).to.eql(404);
+ }
+ });
+
+ // pattern 2: using promise (.then/.catch)
+ await test("post request with promise chain - success case", async () => {
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ data: 'ping'
+ })
+ .then(res => {
+ expect(res.data).to.eql('ping');
+ });
+ });
+
+ await test("post request with promise chain - error case", async () => {
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com/invalid',
+ method: 'POST',
+ data: 'ping'
+ })
+ .catch(err => {
+ expect(err.status).to.eql(404);
+ });
+ });
+
+ // pattern 3: using callbacks
+ await test("post request with callback - success case", async () => {
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com',
+ method: 'POST',
+ data: 'ping'
+ }, function(error, response) {
+ expect(response.data).to.eql('ping');
+ });
+ });
+
+ await test("post request with callback - error case", async () => {
+ await bru.sendRequest({
+ url: 'https://echo.usebruno.com/invalid',
+ method: 'POST',
+ data: 'ping'
+ }, function(error, response) {
+ expect(error.status).to.eql(404);
+ });
+ });
+}
diff --git a/packages/bruno-tests/collection/scripting/api/req/getName.bru b/packages/bruno-tests/collection/scripting/api/req/getName.bru
new file mode 100644
index 000000000..95e0369f5
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/req/getName.bru
@@ -0,0 +1,17 @@
+meta {
+ name: getName
+ type: http
+ seq: 11
+}
+
+get {
+ url: {{host}}/ping
+ body: none
+ auth: inherit
+}
+
+tests {
+ test("Check if request name is getName", function () {
+ expect(req.getName()).to.eql("getName");
+ });
+}
diff --git a/packages/bruno-tests/collection/scripting/api/res/getSize.bru b/packages/bruno-tests/collection/scripting/api/res/getSize.bru
new file mode 100644
index 000000000..2d727ea07
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/res/getSize.bru
@@ -0,0 +1,36 @@
+meta {
+ name: getSize
+ type: http
+ seq: 8
+}
+
+get {
+ url: https://www.httpfaker.org/api/random/json?size=1mb
+ body: none
+ auth: inherit
+}
+
+params:query {
+ size: 1mb
+}
+
+script:post-response {
+ console.log(res.getSize())
+}
+
+tests {
+ test("test body size", function() {
+ const bodySize = res.getSize().body;
+ expect(bodySize === 1048934).to.be.true;
+ });
+
+ test("test header size", function() {
+ const bodySize = res.getSize().header;
+ expect(bodySize === 305).to.be.true;
+ });
+
+ test("test total size", function() {
+ const sizes = res.getSize();
+ expect(sizes.total).to.equal(sizes.header + sizes.body);
+ });
+}
diff --git a/packages/bruno-tests/collection/scripting/api/res/getStatusText.bru b/packages/bruno-tests/collection/scripting/api/res/getStatusText.bru
new file mode 100644
index 000000000..f023d217c
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/res/getStatusText.bru
@@ -0,0 +1,23 @@
+meta {
+ name: getStatusText
+ type: http
+ seq: 6
+}
+
+get {
+ url: {{host}}/ping
+ body: none
+ auth: none
+}
+
+assert {
+ res.statusText: eq OK
+ res.body: eq pong
+}
+
+tests {
+ test("res.getStatusText()", function() {
+ const statusText = res.getStatusText()
+ expect(statusText).to.equal('OK');
+ });
+}
diff --git a/packages/bruno-tests/collection/scripting/api/res/getUrl.bru b/packages/bruno-tests/collection/scripting/api/res/getUrl.bru
new file mode 100644
index 000000000..8329c120b
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/res/getUrl.bru
@@ -0,0 +1,27 @@
+meta {
+ name: getUrl
+ type: http
+ seq: 1
+}
+
+get {
+ url: {{host}}/ping
+ body: none
+ auth: none
+}
+
+assert {
+ res.status: eq 200
+ res.body: eq pong
+}
+
+tests {
+ test("res.url", function() {
+ expect(res.url).to.equal("https://testbench-sanity.usebruno.com/ping");
+ });
+
+ test("res.getUrl()", function() {
+ const url = res.getUrl();
+ expect(url).to.equal("https://testbench-sanity.usebruno.com/ping");
+ });
+}
diff --git a/packages/bruno-tests/collection/scripting/api/res/setBody/array.bru b/packages/bruno-tests/collection/scripting/api/res/setBody/array.bru
new file mode 100644
index 000000000..7e3492abe
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/res/setBody/array.bru
@@ -0,0 +1,45 @@
+meta {
+ name: array
+ type: http
+ seq: 6
+}
+
+post {
+ url: {{host}}/api/echo/json
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "hello": "bruno"
+ }
+}
+
+assert {
+ res.status: eq 200
+}
+
+script:post-response {
+ const obj = {
+ hello : "hello from post-res"
+ }
+ // Safe mode, Dev mode behaves differently, null is getting converted to undefined, although both have null in the response, tests with undefined fails in safe mode, this needs to be investigated,, undefined is not a valid JSON
+ res.setBody(["hello",1, null, undefined, true, obj])
+}
+
+tests {
+ test("res.setBody(array)", function() {
+ const body = res.getBody();
+ expect(body.length).to.eql(6);
+ expect(body[0]).to.eql("hello")
+ expect(body[1]).to.eql(1)
+ expect(body[2]).to.be.null
+ // Safe mode, Dev mode behaves differently, null is getting converted to undefined, although both have null in the response, tests with undefined fails in safe mode, this needs to be investigated,, undefined is not a valid JSON
+ expect(body[3]).to.be.undefined;
+ expect(body[4]).to.eql(true)
+ expect(body[5].hello).to.eql("hello from post-res")
+
+ });
+
+}
diff --git a/packages/bruno-tests/collection/scripting/api/res/setBody/boolean.bru b/packages/bruno-tests/collection/scripting/api/res/setBody/boolean.bru
new file mode 100644
index 000000000..28513d679
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/res/setBody/boolean.bru
@@ -0,0 +1,33 @@
+meta {
+ name: boolean
+ type: http
+ seq: 7
+}
+
+post {
+ url: {{host}}/api/echo/json
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "hello": "bruno"
+ }
+}
+
+assert {
+ res.status: eq 200
+}
+
+script:post-response {
+ res.setBody(true)
+}
+
+tests {
+ test("res.setBody(boolean)", function() {
+ const body = res.getBody();
+ expect(body).to.be.true;
+ });
+
+}
diff --git a/packages/bruno-tests/collection/scripting/api/res/setBody/folder.bru b/packages/bruno-tests/collection/scripting/api/res/setBody/folder.bru
new file mode 100644
index 000000000..4e66417c7
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/res/setBody/folder.bru
@@ -0,0 +1,3 @@
+meta {
+ name: setBody
+}
diff --git a/packages/bruno-tests/collection/scripting/api/res/setBody/null.bru b/packages/bruno-tests/collection/scripting/api/res/setBody/null.bru
new file mode 100644
index 000000000..8d8d2dcf5
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/res/setBody/null.bru
@@ -0,0 +1,33 @@
+meta {
+ name: null
+ type: http
+ seq: 6
+}
+
+post {
+ url: {{host}}/api/echo/json
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "hello": "bruno"
+ }
+}
+
+assert {
+ res.status: eq 200
+}
+
+script:post-response {
+ res.setBody(null)
+}
+
+tests {
+ test("res.setBody(null)", function() {
+ const body = res.getBody();
+ expect(body).to.be.null;
+ });
+
+}
diff --git a/packages/bruno-tests/collection/scripting/api/res/setBody/number.bru b/packages/bruno-tests/collection/scripting/api/res/setBody/number.bru
new file mode 100644
index 000000000..a90aec802
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/res/setBody/number.bru
@@ -0,0 +1,33 @@
+meta {
+ name: number
+ type: http
+ seq: 3
+}
+
+post {
+ url: {{host}}/api/echo/json
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "hello": "bruno"
+ }
+}
+
+assert {
+ res.status: eq 200
+}
+
+script:post-response {
+ res.setBody(2)
+}
+
+tests {
+ test("res.setBody(number)", function() {
+ const body = res.getBody();
+ expect(body).to.eql(2);
+ });
+
+}
diff --git a/packages/bruno-tests/collection/scripting/api/res/setBody/object.bru b/packages/bruno-tests/collection/scripting/api/res/setBody/object.bru
new file mode 100644
index 000000000..02ad78a2e
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/res/setBody/object.bru
@@ -0,0 +1,35 @@
+meta {
+ name: object
+ type: http
+ seq: 1
+}
+
+post {
+ url: {{host}}/api/echo/json
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "hello": "bruno"
+ }
+}
+
+assert {
+ res.status: eq 200
+}
+
+script:post-response {
+ res.setBody({
+ hello : "hello from post-res"
+ })
+}
+
+tests {
+ test("res.setBody(object)", function() {
+ const body = res.getBody();
+ expect(body.hello).to.eql("hello from post-res");
+ });
+
+}
diff --git a/packages/bruno-tests/collection/scripting/api/res/setBody/string.bru b/packages/bruno-tests/collection/scripting/api/res/setBody/string.bru
new file mode 100644
index 000000000..a87e57bd4
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/res/setBody/string.bru
@@ -0,0 +1,33 @@
+meta {
+ name: string
+ type: http
+ seq: 4
+}
+
+post {
+ url: {{host}}/api/echo/json
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "hello": "bruno"
+ }
+}
+
+assert {
+ res.status: eq 200
+}
+
+script:post-response {
+ res.setBody("hello from post-res")
+}
+
+tests {
+ test("res.setBody(string)", function() {
+ const body = res.getBody();
+ expect(body).to.eql("hello from post-res");
+ });
+
+}
diff --git a/packages/bruno-tests/collection/scripting/api/res/setBody/undefined.bru b/packages/bruno-tests/collection/scripting/api/res/setBody/undefined.bru
new file mode 100644
index 000000000..0dc918f1f
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/api/res/setBody/undefined.bru
@@ -0,0 +1,36 @@
+meta {
+ name: undefined
+ type: http
+ seq: 7
+}
+
+post {
+ url: {{host}}/api/echo/json
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "hello": "bruno"
+ }
+}
+
+assert {
+ res.status: eq 200
+}
+
+script:post-response {
+ // if undefined is not passed to res.setBody() the test fails in only safe-mode, needs to check, undefined is not a valid JSON
+ // Safe mode, Dev mode behaves differently, null is getting converted to undefined, although both have null in the response, tests with undefined fails in safe mode, this needs to be investigated, undefined is not a valid JSON
+ res.setBody(undefined)
+}
+
+tests {
+ test("res.setBody(undefined)", function() {
+ const body = res.getBody();
+ // Safe mode, Dev mode behaves differently, null is getting converted to undefined, although both have null in the response, tests with undefined fails in safe mode, this needs to be investigated, undefined is not a valid JSON
+ expect(body).to.be.undefined;
+ });
+
+}
diff --git a/packages/bruno-tests/collection/scripting/inbuilt modules/axios/axios-pre-req-script.bru b/packages/bruno-tests/collection/scripting/inbuilt modules/axios/axios-pre-req-script.bru
index 1998c9665..1420f6208 100644
--- a/packages/bruno-tests/collection/scripting/inbuilt modules/axios/axios-pre-req-script.bru
+++ b/packages/bruno-tests/collection/scripting/inbuilt modules/axios/axios-pre-req-script.bru
@@ -18,6 +18,7 @@ script:pre-request {
"hello": "bruno"
});
+ req.setHeader('Content-Type', 'application/json');
req.setBody(response.data);
req.setMethod("POST");
req.setUrl(url);
diff --git a/packages/bruno-tests/collection/scripting/inbuilt modules/cheerio/cheerio.bru b/packages/bruno-tests/collection/scripting/inbuilt modules/cheerio/cheerio.bru
new file mode 100644
index 000000000..ce7a6346c
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/inbuilt modules/cheerio/cheerio.bru
@@ -0,0 +1,59 @@
+meta {
+ name: cheerio
+ type: http
+ seq: 1
+}
+
+post {
+ url: https://echo.usebruno.com
+ body: text
+ auth: none
+}
+
+body:text {
+ Hello Bruno!
+}
+
+script:pre-request {
+ const cheerio = require('cheerio');
+
+ const $ = cheerio.load('Hello world ');
+
+ $('h2.title').text('Hello pre-request!');
+ $('h2').addClass('welcome');
+
+ bru.setVar("cheerio-test-pre-request", $.html());
+}
+
+script:post-response {
+ const cheerio = require('cheerio');
+
+ const $ = cheerio.load('Hello world ');
+
+ $('h2.title').text('Hello post-response!');
+ $('h2').addClass('welcome');
+
+ bru.setVar("cheerio-test-post-response", $.html());
+}
+
+tests {
+ const cheerio = require('cheerio');
+
+ test("cheerio html - from pre request script", function() {
+ const expected = 'Hello pre-request! ';
+ const html = bru.getVar('cheerio-test-pre-request');
+ expect(html).to.eql(expected);
+ });
+
+ test("cheerio html - from post response script", function() {
+ const expected = 'Hello post-response! ';
+ const html = bru.getVar('cheerio-test-post-response');
+ expect(html).to.eql(expected);
+ });
+
+ test("cheerio html - from tests", function() {
+ const expected = 'Hello Bruno! ';
+ const $ = cheerio.load(res.body);
+ expect($.html()).to.eql(expected);
+ });
+}
diff --git a/packages/bruno-tests/collection/scripting/inbuilt modules/tv4/folder.bru b/packages/bruno-tests/collection/scripting/inbuilt modules/tv4/folder.bru
new file mode 100644
index 000000000..4fd4bb1d2
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/inbuilt modules/tv4/folder.bru
@@ -0,0 +1,3 @@
+meta {
+ name: tv4
+}
diff --git a/packages/bruno-tests/collection/scripting/inbuilt modules/tv4/tv4.bru b/packages/bruno-tests/collection/scripting/inbuilt modules/tv4/tv4.bru
new file mode 100644
index 000000000..820a7a3b8
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/inbuilt modules/tv4/tv4.bru
@@ -0,0 +1,39 @@
+meta {
+ name: tv4
+ type: http
+ seq: 1
+}
+
+post {
+ url: {{host}}/api/echo/json
+ body: json
+ auth: inherit
+}
+
+body:json {
+ {
+ "name": "John",
+ "age": 30
+ }
+}
+
+tests {
+ const tv4 = require("tv4")
+
+ const schema = {
+ type: 'object',
+ properties: {
+ name: { type: 'string' },
+ age: { type: 'number' }
+ }
+ };
+
+ let responseData = res.getBody();
+
+ let isValid = tv4.validate(responseData, schema);
+
+ test("Response body matches expected schema", function () {
+ expect(isValid, tv4.error ? tv4.error.message : "").to.be.true;
+ });
+
+}
diff --git a/packages/bruno-tests/collection/scripting/inbuilt modules/xml2js/xml2js.bru b/packages/bruno-tests/collection/scripting/inbuilt modules/xml2js/xml2js.bru
new file mode 100644
index 000000000..935263117
--- /dev/null
+++ b/packages/bruno-tests/collection/scripting/inbuilt modules/xml2js/xml2js.bru
@@ -0,0 +1,57 @@
+meta {
+ name: xml2js
+ type: http
+ seq: 1
+}
+
+get {
+ url: {{host}}/ping
+ body: none
+ auth: none
+}
+
+script:pre-request {
+ var parseString = require('xml2js').parseString;
+ var xml = "Hello xml2js - pre request! "
+ parseString(xml, function (err, result) {
+ bru.setVar("xml2js-test-result-pre-request", result);
+ });
+}
+
+script:post-response {
+ var parseString = require('xml2js').parseString;
+ var xml = "Hello xml2js - post response! "
+ parseString(xml, function (err, result) {
+ bru.setVar("xml2js-test-result-post-response", result);
+ });
+}
+
+tests {
+ var parseString = require('xml2js').parseString;
+
+ test("xml2js parseString in scripts - pre request", function() {
+ const expected = {
+ root: 'Hello xml2js - pre request!'
+ };
+ const result = bru.getVar('xml2js-test-result-pre-request');
+ expect(result).to.eql(expected);
+ });
+
+ test("xml2js parseString in scripts - post response", function() {
+ const expected = {
+ root: 'Hello xml2js - post response!'
+ };
+ const result = bru.getVar('xml2js-test-result-post-response');
+ expect(result).to.eql(expected);
+ });
+
+ test("xml2js parseString in tests", async function() {
+ var xml = "Hello inside test! "
+ const expected = {
+ root: 'Hello inside test!'
+ };
+ parseString(xml, function (err, result) {
+ expect(result).to.eql(expected);
+ });
+ });
+}
diff --git a/packages/bruno-tests/collection/string interpolation/objects-arrays interpolation.bru b/packages/bruno-tests/collection/string interpolation/objects-arrays interpolation.bru
new file mode 100644
index 000000000..3c47c9d32
--- /dev/null
+++ b/packages/bruno-tests/collection/string interpolation/objects-arrays interpolation.bru
@@ -0,0 +1,81 @@
+meta {
+ name: objects/arrays interpolation
+ type: http
+ seq: 5
+}
+
+post {
+ url: https://echo.usebruno.com
+ body: json
+ auth: none
+}
+
+body:json {
+ {
+ "undefined": "{{obj.undefined}}",
+ "null": {{obj.null}},
+ "number": {{obj.number}},
+ "boolean": {{obj.boolean}},
+ "array": {{arr}},
+ "array[0]": {{arr[0]}},
+ "object": {{obj}},
+ "object.foo": {{obj.foo}},
+ "object.foo.bar": {{obj.foo.bar}},
+ "object.foo.bar.baz": {{obj.foo.bar.baz}}
+ }
+}
+
+script:pre-request {
+ bru.setVar("arr", [1,2,3,4,5]);
+
+ bru.setVar("obj", {
+ "null": null,
+ "number": 1,
+ "boolean": true,
+ "foo": {
+ "bar": {
+ "baz": 1
+ }
+ }
+ });
+}
+
+tests {
+ test("should interpolate arrays and objects in request payload body", () => {
+ const resBody = res.getBody();
+ const expectedOutput = {
+ "undefined": "{{obj.undefined}}",
+ "null": null,
+ "number": 1,
+ "boolean": true,
+ "array": [
+ 1,
+ 2,
+ 3,
+ 4,
+ 5
+ ],
+ "array[0]": 1,
+ "object": {
+ "null": null,
+ "number": 1,
+ "boolean": true,
+ "foo": {
+ "bar": {
+ "baz": 1
+ }
+ }
+ },
+ "object.foo": {
+ "bar": {
+ "baz": 1
+ }
+ },
+ "object.foo.bar": {
+ "baz": 1
+ },
+ "object.foo.bar.baz": 1
+ };
+ expect(resBody).to.be.eql(expectedOutput);
+ })
+}
diff --git a/packages/bruno-tests/collection/string interpolation/runtime vars.bru b/packages/bruno-tests/collection/string interpolation/runtime vars.bru
index 6e70647e8..3bcdef9e9 100644
--- a/packages/bruno-tests/collection/string interpolation/runtime vars.bru
+++ b/packages/bruno-tests/collection/string interpolation/runtime vars.bru
@@ -30,7 +30,7 @@ body:text {
Hi, I am {{rUser.full_name}},
I am {{rUser.age}} years old.
My favorite food is {{rUser.fav-food[0]}} and {{rUser.fav-food[1]}}.
- I like attention: {{rUser.want.attention}}
+ I like attention: {{rUser['want.attention']}}
}
assert {
diff --git a/packages/bruno-tests/collection/url-serialization/Duplicate Keys.bru b/packages/bruno-tests/collection/url-serialization/Duplicate Keys.bru
new file mode 100644
index 000000000..28f3030f4
--- /dev/null
+++ b/packages/bruno-tests/collection/url-serialization/Duplicate Keys.bru
@@ -0,0 +1,27 @@
+meta {
+ name: Duplicate Keys
+ type: http
+ seq: 1
+}
+
+post {
+ url: https://echo.usebruno.com
+ body: formUrlEncoded
+ auth: none
+}
+
+headers {
+ Content-Type: application/x-www-form-urlencoded
+}
+
+body:form-urlencoded {
+ tags: frontend
+ tags: api
+ user: john
+}
+
+script:post-response {
+ test('Response body matches expected value', function () {
+ expect(res.getBody()).to.eql("tags=frontend&tags=api&user=john");
+ });
+}
diff --git a/packages/bruno-tests/collection/url-serialization/folder.bru b/packages/bruno-tests/collection/url-serialization/folder.bru
new file mode 100644
index 000000000..0644be667
--- /dev/null
+++ b/packages/bruno-tests/collection/url-serialization/folder.bru
@@ -0,0 +1,8 @@
+meta {
+ name: url-serialization
+ seq: 13
+}
+
+auth {
+ mode: inherit
+}
diff --git a/packages/bruno-tests/collection_oauth2/bruno.json b/packages/bruno-tests/collection_oauth2/bruno.json
index 66949e685..82816b2b5 100644
--- a/packages/bruno-tests/collection_oauth2/bruno.json
+++ b/packages/bruno-tests/collection_oauth2/bruno.json
@@ -1,9 +1,11 @@
{
"version": "1",
- "name": "collection_oauth2",
+ "name": "OAuth2 Demo",
"type": "collection",
"scripts": {
- "moduleWhitelist": ["crypto"],
+ "moduleWhitelist": [
+ "crypto"
+ ],
"filesystemAccess": {
"allow": true
}
@@ -15,4 +17,4 @@
"presets": {
"requestType": "http"
}
-}
+}
\ No newline at end of file
diff --git a/packages/bruno-tests/keycloak-authorization_code/bruno.json b/packages/bruno-tests/keycloak-authorization_code/bruno.json
new file mode 100644
index 000000000..fce93eac9
--- /dev/null
+++ b/packages/bruno-tests/keycloak-authorization_code/bruno.json
@@ -0,0 +1,9 @@
+{
+ "version": "1",
+ "name": "keycloak-authorization_code",
+ "type": "collection",
+ "ignore": [
+ "node_modules",
+ ".git"
+ ]
+}
\ No newline at end of file
diff --git a/packages/bruno-tests/keycloak-authorization_code/collection.bru b/packages/bruno-tests/keycloak-authorization_code/collection.bru
new file mode 100644
index 000000000..c858dac93
--- /dev/null
+++ b/packages/bruno-tests/keycloak-authorization_code/collection.bru
@@ -0,0 +1,22 @@
+auth {
+ mode: oauth2
+}
+
+auth:oauth2 {
+ grant_type: authorization_code
+ callback_url: {{key-host}}/realms/bruno/account
+ authorization_url: {{key-host}}/realms/bruno/protocol/openid-connect/auth
+ access_token_url: {{key-host}}/realms/bruno/protocol/openid-connect/token
+ refresh_token_url:
+ client_id: account
+ client_secret: {{client_secret}}
+ scope: openid
+ state:
+ pkce: true
+ credentials_placement: body
+ credentials_id: credentials
+ token_placement: header
+ token_header_prefix: Bearer
+ auto_fetch_token: true
+ auto_refresh_token: false
+}
diff --git a/packages/bruno-tests/keycloak-authorization_code/environments/oauth2.bru b/packages/bruno-tests/keycloak-authorization_code/environments/oauth2.bru
new file mode 100644
index 000000000..8d4ce79a8
--- /dev/null
+++ b/packages/bruno-tests/keycloak-authorization_code/environments/oauth2.bru
@@ -0,0 +1,6 @@
+vars {
+ key-host: http://localhost:8080
+}
+vars:secret [
+ client_secret
+]
diff --git a/packages/bruno-tests/keycloak-authorization_code/user_info_coll-auth.bru b/packages/bruno-tests/keycloak-authorization_code/user_info_coll-auth.bru
new file mode 100644
index 000000000..ec838c9fa
--- /dev/null
+++ b/packages/bruno-tests/keycloak-authorization_code/user_info_coll-auth.bru
@@ -0,0 +1,11 @@
+meta {
+ name: user_info_coll-auth
+ type: http
+ seq: 1
+}
+
+get {
+ url: {{key-host}}/realms/bruno/protocol/openid-connect/userinfo
+ body: none
+ auth: inherit
+}
diff --git a/packages/bruno-tests/keycloak-authorization_code/user_info_custom.bru b/packages/bruno-tests/keycloak-authorization_code/user_info_custom.bru
new file mode 100644
index 000000000..c5a757ed0
--- /dev/null
+++ b/packages/bruno-tests/keycloak-authorization_code/user_info_custom.bru
@@ -0,0 +1,15 @@
+meta {
+ name: user_info_custom
+ type: http
+ seq: 2
+}
+
+get {
+ url: {{key-host}}/realms/bruno/protocol/openid-connect/userinfo
+ body: none
+ auth: bearer
+}
+
+auth:bearer {
+ token: {{$oauth2.credentials.access_token}}
+}
diff --git a/packages/bruno-tests/keycloak-authorization_code/user_info_request-auth.bru b/packages/bruno-tests/keycloak-authorization_code/user_info_request-auth.bru
new file mode 100644
index 000000000..eabd03b54
--- /dev/null
+++ b/packages/bruno-tests/keycloak-authorization_code/user_info_request-auth.bru
@@ -0,0 +1,30 @@
+meta {
+ name: user_info_request-auth
+ type: http
+ seq: 3
+}
+
+get {
+ url: {{key-host}}/realms/bruno/protocol/openid-connect/userinfo
+ body: json
+ auth: oauth2
+}
+
+auth:oauth2 {
+ grant_type: authorization_code
+ callback_url: {{key-host}}/realms/bruno/account
+ authorization_url: {{key-host}}/realms/bruno/protocol/openid-connect/auth
+ access_token_url: {{key-host}}/realms/bruno/protocol/openid-connect/token
+ refresh_token_url:
+ client_id: account
+ client_secret: {{client_secret}}
+ scope: openid
+ state:
+ pkce: true
+ credentials_placement: body
+ credentials_id: credentials
+ token_placement: header
+ token_header_prefix: Bearer
+ auto_fetch_token: true
+ auto_refresh_token: true
+}
diff --git a/packages/bruno-tests/keycloak-client-credentials/bruno.json b/packages/bruno-tests/keycloak-client-credentials/bruno.json
new file mode 100644
index 000000000..783e37474
--- /dev/null
+++ b/packages/bruno-tests/keycloak-client-credentials/bruno.json
@@ -0,0 +1,9 @@
+{
+ "version": "1",
+ "name": "keycloak-client-credentials",
+ "type": "collection",
+ "ignore": [
+ "node_modules",
+ ".git"
+ ]
+}
\ No newline at end of file
diff --git a/packages/bruno-tests/keycloak-client-credentials/collection.bru b/packages/bruno-tests/keycloak-client-credentials/collection.bru
new file mode 100644
index 000000000..e488de865
--- /dev/null
+++ b/packages/bruno-tests/keycloak-client-credentials/collection.bru
@@ -0,0 +1,18 @@
+auth {
+ mode: oauth2
+}
+
+auth:oauth2 {
+ grant_type: client_credentials
+ access_token_url: {{key-host}}/realms/bruno/protocol/openid-connect/token
+ refresh_token_url:
+ client_id: account
+ client_secret: {{client_secret}}
+ scope: openid
+ credentials_placement: body
+ credentials_id: credentials
+ token_placement: header
+ token_header_prefix: Bearer
+ auto_fetch_token: true
+ auto_refresh_token: false
+}
diff --git a/packages/bruno-tests/keycloak-client-credentials/environments/oauth2.bru b/packages/bruno-tests/keycloak-client-credentials/environments/oauth2.bru
new file mode 100644
index 000000000..8d4ce79a8
--- /dev/null
+++ b/packages/bruno-tests/keycloak-client-credentials/environments/oauth2.bru
@@ -0,0 +1,6 @@
+vars {
+ key-host: http://localhost:8080
+}
+vars:secret [
+ client_secret
+]
diff --git a/packages/bruno-tests/keycloak-client-credentials/user_info_coll-auth.bru b/packages/bruno-tests/keycloak-client-credentials/user_info_coll-auth.bru
new file mode 100644
index 000000000..ec838c9fa
--- /dev/null
+++ b/packages/bruno-tests/keycloak-client-credentials/user_info_coll-auth.bru
@@ -0,0 +1,11 @@
+meta {
+ name: user_info_coll-auth
+ type: http
+ seq: 1
+}
+
+get {
+ url: {{key-host}}/realms/bruno/protocol/openid-connect/userinfo
+ body: none
+ auth: inherit
+}
diff --git a/packages/bruno-tests/keycloak-client-credentials/user_info_custom.bru b/packages/bruno-tests/keycloak-client-credentials/user_info_custom.bru
new file mode 100644
index 000000000..c5a757ed0
--- /dev/null
+++ b/packages/bruno-tests/keycloak-client-credentials/user_info_custom.bru
@@ -0,0 +1,15 @@
+meta {
+ name: user_info_custom
+ type: http
+ seq: 2
+}
+
+get {
+ url: {{key-host}}/realms/bruno/protocol/openid-connect/userinfo
+ body: none
+ auth: bearer
+}
+
+auth:bearer {
+ token: {{$oauth2.credentials.access_token}}
+}
diff --git a/packages/bruno-tests/keycloak-client-credentials/user_info_request-auth.bru b/packages/bruno-tests/keycloak-client-credentials/user_info_request-auth.bru
new file mode 100644
index 000000000..a8a69792b
--- /dev/null
+++ b/packages/bruno-tests/keycloak-client-credentials/user_info_request-auth.bru
@@ -0,0 +1,26 @@
+meta {
+ name: user_info_request-auth
+ type: http
+ seq: 3
+}
+
+get {
+ url: {{key-host}}/realms/bruno/protocol/openid-connect/userinfo
+ body: none
+ auth: oauth2
+}
+
+auth:oauth2 {
+ grant_type: client_credentials
+ access_token_url: {{key-host}}/realms/bruno/protocol/openid-connect/token
+ refresh_token_url:
+ client_id: account
+ client_secret: {{client_secret}}a
+ scope: openid
+ credentials_placement: body
+ credentials_id: credentials
+ token_placement: header
+ token_header_prefix: Bearer
+ auto_fetch_token: true
+ auto_refresh_token: false
+}
diff --git a/packages/bruno-tests/keycloak-password-credentials/bruno.json b/packages/bruno-tests/keycloak-password-credentials/bruno.json
new file mode 100644
index 000000000..495eacff7
--- /dev/null
+++ b/packages/bruno-tests/keycloak-password-credentials/bruno.json
@@ -0,0 +1,9 @@
+{
+ "version": "1",
+ "name": "keycloak-password-credentials",
+ "type": "collection",
+ "ignore": [
+ "node_modules",
+ ".git"
+ ]
+}
\ No newline at end of file
diff --git a/packages/bruno-tests/keycloak-password-credentials/collection.bru b/packages/bruno-tests/keycloak-password-credentials/collection.bru
new file mode 100644
index 000000000..0bcc69e2d
--- /dev/null
+++ b/packages/bruno-tests/keycloak-password-credentials/collection.bru
@@ -0,0 +1,20 @@
+auth {
+ mode: oauth2
+}
+
+auth:oauth2 {
+ grant_type: password
+ access_token_url: {{key-host}}/realms/bruno/protocol/openid-connect/token
+ refresh_token_url:
+ username: bruno
+ password: bruno
+ client_id: account
+ client_secret: {{client_secret}}
+ scope: openid
+ credentials_placement: body
+ credentials_id: credentials
+ token_placement: header
+ token_header_prefix: Bearer
+ auto_fetch_token: true
+ auto_refresh_token: false
+}
diff --git a/packages/bruno-tests/keycloak-password-credentials/environments/oauth2.bru b/packages/bruno-tests/keycloak-password-credentials/environments/oauth2.bru
new file mode 100644
index 000000000..8d4ce79a8
--- /dev/null
+++ b/packages/bruno-tests/keycloak-password-credentials/environments/oauth2.bru
@@ -0,0 +1,6 @@
+vars {
+ key-host: http://localhost:8080
+}
+vars:secret [
+ client_secret
+]
diff --git a/packages/bruno-tests/keycloak-password-credentials/user_info_coll-auth.bru b/packages/bruno-tests/keycloak-password-credentials/user_info_coll-auth.bru
new file mode 100644
index 000000000..ec838c9fa
--- /dev/null
+++ b/packages/bruno-tests/keycloak-password-credentials/user_info_coll-auth.bru
@@ -0,0 +1,11 @@
+meta {
+ name: user_info_coll-auth
+ type: http
+ seq: 1
+}
+
+get {
+ url: {{key-host}}/realms/bruno/protocol/openid-connect/userinfo
+ body: none
+ auth: inherit
+}
diff --git a/packages/bruno-tests/keycloak-password-credentials/user_info_custom.bru b/packages/bruno-tests/keycloak-password-credentials/user_info_custom.bru
new file mode 100644
index 000000000..c5a757ed0
--- /dev/null
+++ b/packages/bruno-tests/keycloak-password-credentials/user_info_custom.bru
@@ -0,0 +1,15 @@
+meta {
+ name: user_info_custom
+ type: http
+ seq: 2
+}
+
+get {
+ url: {{key-host}}/realms/bruno/protocol/openid-connect/userinfo
+ body: none
+ auth: bearer
+}
+
+auth:bearer {
+ token: {{$oauth2.credentials.access_token}}
+}
diff --git a/packages/bruno-tests/keycloak-password-credentials/user_info_request-auth.bru b/packages/bruno-tests/keycloak-password-credentials/user_info_request-auth.bru
new file mode 100644
index 000000000..c17b6cf0f
--- /dev/null
+++ b/packages/bruno-tests/keycloak-password-credentials/user_info_request-auth.bru
@@ -0,0 +1,28 @@
+meta {
+ name: user_info_request-auth
+ type: http
+ seq: 3
+}
+
+get {
+ url: {{key-host}}/realms/bruno/protocol/openid-connect/userinfo
+ body: none
+ auth: oauth2
+}
+
+auth:oauth2 {
+ grant_type: password
+ access_token_url: {{key-host}}/realms/bruno/protocol/openid-connect/token
+ refresh_token_url:
+ username: admin
+ password: admin
+ client_id: account
+ client_secret: {{client_secret}}
+ scope: openid
+ credentials_placement: body
+ credentials_id: credentials
+ token_placement: header
+ token_header_prefix: Bearer
+ auto_fetch_token: true
+ auto_refresh_token: false
+}
diff --git a/packages/bruno-tests/package.json b/packages/bruno-tests/package.json
index ad819bf1d..75cfde1ae 100644
--- a/packages/bruno-tests/package.json
+++ b/packages/bruno-tests/package.json
@@ -18,13 +18,13 @@
},
"homepage": "https://github.com/usebruno/bruno-testbench#readme",
"dependencies": {
- "axios": "1.7.5",
+ "axios": "^1.8.3",
"body-parser": "1.20.3",
"cookie-parser": "^1.4.6",
"cors": "^2.8.5",
- "express": "4.21.1",
+ "express": "^4.21.2",
"express-basic-auth": "^1.2.1",
- "fast-xml-parser": "^4.5.0",
+ "fast-xml-parser": "^5.0.8",
"http-proxy": "^1.18.1",
"js-yaml": "^4.1.0",
"jsonwebtoken": "^9.0.2",
diff --git a/packages/bruno-tests/src/echo/index.js b/packages/bruno-tests/src/echo/index.js
index ba9b403ae..00b50bd36 100644
--- a/packages/bruno-tests/src/echo/index.js
+++ b/packages/bruno-tests/src/echo/index.js
@@ -19,6 +19,17 @@ router.post('/xml-raw', (req, res) => {
return res.send(req.rawBody);
});
+router.post('/bin', (req, res) => {
+ const rawBody = req.body;
+
+ if (!rawBody || rawBody.length === 0) {
+ return res.status(400).send('No data received');
+ }
+
+ res.set('Content-Type', req.headers['content-type'] || 'application/octet-stream');
+ res.send(rawBody);
+});
+
router.get('/bom-json-test', (req, res) => {
const jsonData = {
message: 'Hello!',
@@ -37,4 +48,30 @@ router.get('/iso-enc', (req, res) => {
return res.send(Buffer.from(responseText, 'latin1'));
});
+router.post("/custom", (req, res) => {
+ const { headers, content, contentBase64, contentJSON, type } = req.body || {};
+
+ res._headers = {};
+
+ if (type) {
+ res.setHeader('Content-Type', type);
+ }
+
+ if (headers && typeof headers === 'object') {
+ Object.entries(headers).forEach(([key, value]) => {
+ res.setHeader(key, value);
+ });
+ }
+
+ if (contentBase64) {
+ res.write(Buffer.from(contentBase64, 'base64'));
+ } else if (contentJSON !== undefined) {
+ res.write(JSON.stringify(contentJSON));
+ } else if (content !== undefined) {
+ res.write(content);
+ }
+
+ return res.end();
+});
+
module.exports = router;
diff --git a/packages/bruno-tests/src/index.js b/packages/bruno-tests/src/index.js
index a09cb434b..735bd929b 100644
--- a/packages/bruno-tests/src/index.js
+++ b/packages/bruno-tests/src/index.js
@@ -8,13 +8,21 @@ const xmlParser = require('./utils/xmlParser');
const multipartRouter = require('./multipart');
const app = new express();
-const port = process.env.PORT || 8080;
+const port = process.env.PORT || 8081;
app.use(cors());
+
+const saveRawBody = (req, res, buf) => {
+ req.rawBuffer = Buffer.from(buf);
+ req.rawBody = buf.toString();
+};
+
+app.use(bodyParser.json({ verify: saveRawBody }));
+app.use(bodyParser.urlencoded({ extended: true, verify: saveRawBody }));
+app.use(bodyParser.text({ verify: saveRawBody }));
app.use(xmlParser());
-app.use(bodyParser.text());
-app.use(bodyParser.json());
-app.use(bodyParser.urlencoded({ extended: true }));
+app.use(express.raw({ type: '*/*', limit: '100mb', verify: saveRawBody }));
+
formDataParser.init(app, express);
app.use('/api/auth', authRouter);
diff --git a/packages/bruno-toml/src/jsonToToml.js b/packages/bruno-toml/src/jsonToToml.js
index c61191ad8..368277115 100644
--- a/packages/bruno-toml/src/jsonToToml.js
+++ b/packages/bruno-toml/src/jsonToToml.js
@@ -47,6 +47,10 @@ const jsonToToml = (json) => {
}
};
+ if (json.tags && json.tags.length) {
+ formattedJson.tags = get(json, 'tags', []);
+ }
+
if (json.headers && json.headers.length) {
const hasDuplicateHeaders = keyValPairHasDuplicateKeys(json.headers);
const hasReservedHeaders = keyValPairHasReservedKeys(json.headers);
@@ -92,6 +96,12 @@ const jsonToToml = (json) => {
}
}
+ if (json.settings && Object.keys(json.settings).length > 0) {
+ formattedJson.settings = {
+ encodeUrl: typeof settings.encodeUrl === 'boolean' ? settings.encodeUrl : settings.encodeUrl === 'true'
+ };
+ }
+
return stringify(formattedJson);
};
diff --git a/packages/bruno-toml/src/tomlToJson.js b/packages/bruno-toml/src/tomlToJson.js
index 37b50ad39..f29fafff1 100644
--- a/packages/bruno-toml/src/tomlToJson.js
+++ b/packages/bruno-toml/src/tomlToJson.js
@@ -24,6 +24,10 @@ const tomlToJson = (toml) => {
}
};
+ if (json.tags && json.tags.length) {
+ formattedJson.tags = get(json, 'tags', []);
+ }
+
if (json.headers) {
formattedJson.headers = [];
@@ -77,6 +81,12 @@ const tomlToJson = (toml) => {
}
}
+ if (json.settings && Object.keys(json.settings).length > 0) {
+ formattedJson.settings = {
+ encodeUrl: typeof settings.encodeUrl === 'boolean' ? settings.encodeUrl : settings.encodeUrl === 'true'
+ };
+ }
+
return formattedJson;
};
diff --git a/packages/bruno-toml/tests/methods/get/request.json b/packages/bruno-toml/tests/methods/get/request.json
index 2fb3955f1..4f37293d2 100644
--- a/packages/bruno-toml/tests/methods/get/request.json
+++ b/packages/bruno-toml/tests/methods/get/request.json
@@ -4,6 +4,7 @@
"type": "http",
"seq": 1
},
+ "tags": ["foo", "bar"],
"http": {
"method": "GET",
"url": "https://reqres.in/api/users"
diff --git a/packages/bruno-toml/tests/methods/get/request.toml b/packages/bruno-toml/tests/methods/get/request.toml
index ae34e0771..66e75af35 100644
--- a/packages/bruno-toml/tests/methods/get/request.toml
+++ b/packages/bruno-toml/tests/methods/get/request.toml
@@ -1,3 +1,5 @@
+tags = [ 'foo', 'bar' ]
+
[meta]
name = 'Get users'
type = 'http'
diff --git a/playwright.config.js b/playwright.config.js
deleted file mode 100644
index 63afd88d4..000000000
--- a/playwright.config.js
+++ /dev/null
@@ -1,110 +0,0 @@
-// @ts-check
-const { devices } = require('@playwright/test');
-
-/**
- * Read environment variables from file.
- * https://github.com/motdotla/dotenv
- */
-// require('dotenv').config();
-
-process.env.PLAYWRIGHT = "1";
-
-/**
- * @see https://playwright.dev/docs/test-configuration
- * @type {import('@playwright/test').PlaywrightTestConfig}
- */
-const config = {
- testDir: './tests',
- /* Maximum time one test can run for. */
- timeout: 30 * 1000,
- expect: {
- /**
- * Maximum time expect() should wait for the condition to be met.
- * For example in `await expect(locator).toHaveText();`
- */
- timeout: 5000
- },
- /* Run tests in files in parallel */
- fullyParallel: true,
- /* Fail the build on CI if you accidentally left test.only in the source code. */
- forbidOnly: !!process.env.CI,
- /* Retry on CI only */
- retries: process.env.CI ? 2 : 0,
- /* Opt out of parallel tests on CI. */
- workers: process.env.CI ? 1 : undefined,
- /* Reporter to use. See https://playwright.dev/docs/test-reporters */
- reporter: 'html',
- /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
- use: {
- /* Maximum time each action such as `click()` can take. Defaults to 0 (no limit). */
- actionTimeout: 0,
- /* Base URL to use in actions like `await page.goto('/')`. */
- baseURL: 'http://localhost:3000',
-
- /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
- trace: 'retain-on-failure',
- },
-
- /* Configure projects for major browsers */
- projects: [
- {
- name: 'chromium',
- use: {
- ...devices['Desktop Chrome'],
- },
- },
-
- {
- name: 'firefox',
- use: {
- ...devices['Desktop Firefox'],
- },
- },
-
- {
- name: 'webkit',
- use: {
- ...devices['Desktop Safari'],
- },
- },
-
- /* Test against mobile viewports. */
- // {
- // name: 'Mobile Chrome',
- // use: {
- // ...devices['Pixel 5'],
- // },
- // },
- // {
- // name: 'Mobile Safari',
- // use: {
- // ...devices['iPhone 12'],
- // },
- // },
-
- /* Test against branded browsers. */
- // {
- // name: 'Microsoft Edge',
- // use: {
- // channel: 'msedge',
- // },
- // },
- // {
- // name: 'Google Chrome',
- // use: {
- // channel: 'chrome',
- // },
- // },
- ],
-
- /* Folder for test artifacts such as screenshots, videos, traces, etc. */
- // outputDir: 'test-results/',
-
- /* Run your local dev server before starting the tests */
- webServer: {
- command: 'npm run dev:web',
- port: 3000,
- },
-};
-
-module.exports = config;
diff --git a/playwright.config.ts b/playwright.config.ts
new file mode 100644
index 000000000..df01a2ec8
--- /dev/null
+++ b/playwright.config.ts
@@ -0,0 +1,39 @@
+import { defineConfig, devices } from '@playwright/test';
+
+const reporter: any[] = [['list'], ['html']];
+
+if (process.env.CI) {
+ reporter.push(['github']);
+}
+
+export default defineConfig({
+ testDir: './e2e-tests',
+ fullyParallel: false,
+ forbidOnly: !!process.env.CI,
+ retries: process.env.CI ? 1 : 0,
+ workers: process.env.CI ? undefined : 1,
+ reporter,
+
+ use: {
+ trace: process.env.CI ? 'on-first-retry' : 'on'
+ },
+
+ projects: [
+ {
+ name: 'Bruno Electron App'
+ }
+ ],
+
+ webServer: [
+ {
+ command: 'npm run dev:web',
+ url: 'http://localhost:3000',
+ reuseExistingServer: !process.env.CI
+ },
+ {
+ command: 'npm start --workspace=packages/bruno-tests',
+ url: 'http://localhost:8081/ping',
+ reuseExistingServer: !process.env.CI
+ }
+ ]
+});
diff --git a/playwright/codegen.ts b/playwright/codegen.ts
new file mode 100644
index 000000000..da2bfcb1f
--- /dev/null
+++ b/playwright/codegen.ts
@@ -0,0 +1,13 @@
+const path = require('path');
+const { startApp } = require('./electron.ts');
+
+async function main() {
+ const { app, context } = await startApp();
+ let outputFile = process.argv[2]?.trim();
+ if (outputFile && !/\.(ts|js)$/.test(outputFile)) {
+ outputFile = path.join(__dirname, '../e2e-tests/', outputFile + '.spec.ts');
+ }
+ await context._enableRecorder({ language: 'playwright-test', mode: 'recording', outputFile });
+}
+
+main();
diff --git a/playwright/electron.ts b/playwright/electron.ts
new file mode 100644
index 000000000..4363f46e0
--- /dev/null
+++ b/playwright/electron.ts
@@ -0,0 +1,17 @@
+const path = require('path');
+const { _electron: electron } = require('playwright');
+
+const electronAppPath = path.join(__dirname, '../packages/bruno-electron');
+
+exports.startApp = async () => {
+ const app = await electron.launch({ args: [electronAppPath] });
+ const context = await app.context();
+
+ app.process().stdout.on('data', (data) => {
+ process.stdout.write(data.toString().replace(/^(?=.)/gm, '[Electron] |'));
+ });
+ app.process().stderr.on('data', (error) => {
+ process.stderr.write(error.toString().replace(/^(?=.)/gm, '[Electron] |'));
+ });
+ return { app, context };
+};
diff --git a/playwright/index.ts b/playwright/index.ts
new file mode 100644
index 000000000..a17809da4
--- /dev/null
+++ b/playwright/index.ts
@@ -0,0 +1,218 @@
+import { test as baseTest, BrowserContext, ElectronApplication, Page } from '@playwright/test';
+import * as path from 'path';
+import * as os from 'os';
+import * as fs from 'fs';
+
+const electronAppPath = path.join(__dirname, '../packages/bruno-electron');
+
+export const test = baseTest.extend<
+ {
+ context: BrowserContext;
+ page: Page;
+ newPage: Page;
+ pageWithUserData: Page;
+ restartApp: (options?: { initUserDataPath?: string }) => Promise;
+ },
+ {
+ createTmpDir: (tag?: string) => Promise;
+ launchElectronApp: (options?: { initUserDataPath?: string; userDataPath?: string }) => Promise;
+ electronApp: ElectronApplication;
+ reuseOrLaunchElectronApp: (options?: { initUserDataPath?: string; userDataPath?: string }) => Promise;
+ }
+>({
+ createTmpDir: [
+ async ({}, use) => {
+ const dirs: string[] = [];
+ await use(async (tag?: string) => {
+ const dir = await fs.promises.mkdtemp(path.join(os.tmpdir(), `pw-${tag || ''}-`));
+ dirs.push(dir);
+ return dir;
+ });
+ await Promise.all(
+ dirs.map((dir) => fs.promises.rm(dir, { recursive: true, force: true, maxRetries: 10 }).catch((e) => e))
+ );
+ },
+ { scope: 'worker' }
+ ],
+
+ launchElectronApp: [
+ async ({ playwright, createTmpDir }, use, workerInfo) => {
+ const apps: ElectronApplication[] = [];
+ await use(async ({ initUserDataPath, userDataPath: providedUserDataPath } = {}) => {
+ const userDataPath = providedUserDataPath || (await createTmpDir('electron-userdata'));
+
+ // Ensure dir exists when caller supplies their own path
+ if (providedUserDataPath) {
+ await fs.promises.mkdir(userDataPath, { recursive: true });
+ }
+
+ if (initUserDataPath) {
+ const replacements = {
+ projectRoot: path.join(__dirname, '..')
+ };
+
+ for (const file of await fs.promises.readdir(initUserDataPath)) {
+ let content = await fs.promises.readFile(path.join(initUserDataPath, file), 'utf-8');
+ content = content.replace(/{{(\w+)}}/g, (_, key) => {
+ if (replacements[key]) {
+ return replacements[key];
+ } else {
+ throw new Error(`\tNo replacement for {{${key}}} in ${path.join(initUserDataPath, file)}`);
+ }
+ });
+ await fs.promises.writeFile(path.join(userDataPath, file), content, 'utf-8');
+ }
+ }
+
+ const app = await playwright._electron.launch({
+ args: [electronAppPath],
+ env: {
+ ...process.env,
+ ELECTRON_USER_DATA_PATH: userDataPath
+ }
+ });
+
+ const { workerIndex } = workerInfo;
+ const electronProcess = app.process();
+ if (electronProcess?.stdout) {
+ electronProcess.stdout.on('data', (data) => {
+ process.stdout.write(data.toString().replace(/^(?=.)/gm, `[Electron #${workerIndex}] |`));
+ });
+ }
+ if (electronProcess?.stderr) {
+ electronProcess.stderr.on('data', (error) => {
+ process.stderr.write(error.toString().replace(/^(?=.)/gm, `[Electron #${workerIndex}] |`));
+ });
+ }
+
+ apps.push(app);
+ return app;
+ });
+ for (const app of apps) {
+ await app.context().close();
+ await app.close();
+ }
+ },
+ { scope: 'worker' }
+ ],
+
+ electronApp: [
+ async ({ launchElectronApp }, use) => {
+ const app = await launchElectronApp();
+ await use(app);
+ },
+ { scope: 'worker' }
+ ],
+
+ context: async ({ electronApp }, use, testInfo) => {
+ const context = await electronApp.context();
+ const tracingOptions = (testInfo as any)._tracing.traceOptions();
+ if (tracingOptions) {
+ try {
+ await context.tracing.start({ screenshots: true, snapshots: true, sources: true });
+ } catch (e) {}
+ }
+ await use(context);
+ },
+
+ page: async ({ electronApp, context }, use, testInfo) => {
+ const page = await electronApp.firstWindow();
+ const tracingOptions = (testInfo as any)._tracing.traceOptions();
+ if (tracingOptions) {
+ const tracePath = testInfo.outputPath(`trace-${testInfo.testId}.zip`);
+ await context.tracing.startChunk();
+ await use(page);
+ await context.tracing.stopChunk({ path: tracePath });
+ await testInfo.attach('trace', { path: tracePath });
+ } else {
+ await use(page);
+ }
+ },
+
+ newPage: async ({ launchElectronApp }, use, testInfo) => {
+ const app = await launchElectronApp();
+ const context = await app.context();
+ const page = await app.firstWindow();
+ const tracingOptions = (testInfo as any)._tracing.traceOptions();
+ if (tracingOptions) {
+ const tracePath = testInfo.outputPath(`trace-${testInfo.testId}.zip`);
+ await context.tracing.start({ screenshots: true, snapshots: true, sources: true });
+ await use(page);
+ await context.tracing.stop({ path: tracePath });
+ await testInfo.attach('trace', { path: tracePath });
+ } else {
+ await use(page);
+ }
+ },
+
+ reuseOrLaunchElectronApp: [
+ async ({ launchElectronApp }, use, testInfo) => {
+ const apps: Record = {};
+ await use(async ({ initUserDataPath, userDataPath } = {}) => {
+ const key = userDataPath || initUserDataPath;
+ if (key && apps[key]) {
+ return apps[key];
+ }
+ const app = await launchElectronApp({ initUserDataPath, userDataPath });
+ if (key) {
+ apps[key] = app;
+ }
+ return app;
+ });
+ },
+ { scope: 'worker' }
+ ],
+
+ restartApp: async ({ launchElectronApp }, use, testInfo) => {
+ const appInstances: Array<{ app: ElectronApplication; initUserDataPath?: string }> = [];
+ await use(async ({ initUserDataPath } = {}) => {
+ // Get the test directory and check for init-user-data folder
+ const testDir = path.dirname(testInfo.file);
+ const defaultInitUserDataPath = path.join(testDir, 'init-user-data');
+
+ // Use provided initUserDataPath, or check if default path exists, or use undefined
+ let userDataPath = initUserDataPath;
+ if (!userDataPath) {
+ const hasInitUserData = await fs.promises.stat(defaultInitUserDataPath).catch(() => false);
+ userDataPath = hasInitUserData ? defaultInitUserDataPath : undefined;
+ }
+
+ const app = await launchElectronApp({ initUserDataPath: userDataPath });
+ appInstances.push({ app, initUserDataPath: userDataPath });
+ return app;
+ });
+
+ // Clean up all app instances
+ for (const { app } of appInstances) {
+ await app.context().close();
+ await app.close();
+ }
+ },
+
+ pageWithUserData: async ({ reuseOrLaunchElectronApp }, use, testInfo) => {
+ const testDir = path.dirname(testInfo.file);
+ const initUserDataPath = path.join(testDir, 'init-user-data');
+
+ const app = await reuseOrLaunchElectronApp(
+ (await fs.promises.stat(initUserDataPath).catch(() => false)) ? { initUserDataPath } : {}
+ );
+
+ const context = await app.context();
+ const page = await app.firstWindow();
+ const tracingOptions = (testInfo as any)._tracing.traceOptions();
+ if (tracingOptions) {
+ const tracePath = testInfo.outputPath(`trace-${testInfo.testId}.zip`);
+ try {
+ await context.tracing.start({ screenshots: true, snapshots: true, sources: true });
+ } catch (e) {}
+ await context.tracing.startChunk();
+ await use(page);
+ await context.tracing.stopChunk({ path: tracePath });
+ await testInfo.attach('trace', { path: tracePath });
+ } else {
+ await use(page);
+ }
+ }
+});
+
+export * from '@playwright/test';
diff --git a/readme.md b/readme.md
index b0c23ecb3..3c800536a 100644
--- a/readme.md
+++ b/readme.md
@@ -56,13 +56,8 @@ You can explore our [paid versions](https://www.usebruno.com/pricing) to see if
- [Features](#features)
- [Run across multiple platforms 🖥️](#run-across-multiple-platforms-%EF%B8%8F)
- [Collaborate via Git 👩💻🧑💻](#collaborate-via-git-)
-- [Sponsors](#sponsors)
- - [Gold Sponsors](#gold-sponsors)
- - [Silver Sponsors](#silver-sponsors)
- - [Bronze Sponsors](#bronze-sponsors)
- [Important Links 📌](#important-links-)
- [Showcase 🎥](#showcase-)
-- [Support ❤️](#support-%EF%B8%8F)
- [Share Testimonials 📣](#share-testimonials-)
- [Publishing to New Package Managers](#publishing-to-new-package-managers)
- [Stay in touch 🌐](#stay-in-touch-)
@@ -99,12 +94,11 @@ flatpak install com.usebruno.Bruno
# On Linux via Apt
sudo mkdir -p /etc/apt/keyrings
-sudo gpg --no-default-keyring --keyring /etc/apt/keyrings/bruno.gpg --keyserver keyserver.ubuntu.com --recv-keys 9FA6017ECABE0266
-
+sudo apt update && sudo apt install gpg curl
+sudo gpg --list-keys
+curl -fsSL "https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x9FA6017ECABE0266" | gpg --dearmor | sudo tee /etc/apt/keyrings/bruno.gpg > /dev/null
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/bruno.gpg] http://debian.usebruno.com/ bruno stable" | sudo tee /etc/apt/sources.list.d/bruno.list
-
-sudo apt update
-sudo apt install bruno
+sudo apt update && sudo apt install bruno
```
## Features
@@ -119,32 +113,15 @@ Or any version control system of your choice
-
-
## Important Links 📌
- [Our Long Term Vision](https://github.com/usebruno/bruno/discussions/269)
-- [Roadmap](https://github.com/usebruno/bruno/discussions/384)
+- [Roadmap](https://www.usebruno.com/roadmap)
- [Documentation](https://docs.usebruno.com)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/bruno)
- [Website](https://www.usebruno.com)
- [Pricing](https://www.usebruno.com/pricing)
- [Download](https://www.usebruno.com/downloads)
-- [GitHub Sponsors](https://github.com/sponsors/helloanoop).
## Showcase 🎥
@@ -152,10 +129,6 @@ Or any version control system of your choice
- [Knowledge Hub](https://github.com/usebruno/bruno/discussions/386)
- [Scriptmania](https://github.com/usebruno/bruno/discussions/385)
-## Support ❤️
-
-If you like Bruno and want to support our opensource work, consider sponsoring us via [GitHub Sponsors](https://github.com/sponsors/helloanoop).
-
## Share Testimonials 📣
If Bruno has helped you at work and your teams, please don't forget to share your [testimonials on our GitHub discussion](https://github.com/usebruno/bruno/discussions/343)
diff --git a/scripts/build-electron.js b/scripts/build-electron.js
index 9825c3a09..6d778ffdf 100644
--- a/scripts/build-electron.js
+++ b/scripts/build-electron.js
@@ -2,6 +2,7 @@ const os = require('os');
const fs = require('fs-extra');
const util = require('util');
const spawn = util.promisify(require('child_process').spawn);
+const path = require('path');
async function deleteFileIfExists(filePath) {
try {
@@ -78,18 +79,34 @@ async function main() {
console.log('The directory has been created successfully!');
// Copy build
- await copyFolderIfExists('packages/bruno-app/out', 'packages/bruno-electron/web');
+ await copyFolderIfExists('packages/bruno-app/dist', 'packages/bruno-electron/web');
- // Change paths in next
+ // Update static paths
const files = await fs.readdir('packages/bruno-electron/web');
for (const file of files) {
if (file.endsWith('.html')) {
let content = await fs.readFile(`packages/bruno-electron/web/${file}`, 'utf8');
- content = content.replace(/\/_next\//g, '_next/');
+ content = content.replace(/\/static/g, './static');
await fs.writeFile(`packages/bruno-electron/web/${file}`, content);
}
}
+ // update font load paths
+ const cssDir = path.join('packages/bruno-electron/web/static/css');
+ try {
+ const cssFiles = await fs.readdir(cssDir);
+ for (const file of cssFiles) {
+ if (file.endsWith('.css')) {
+ const filePath = path.join(cssDir, file);
+ let content = await fs.readFile(filePath, 'utf8');
+ content = content.replace(/\/static\/font/g, '../../static/font');
+ await fs.writeFile(filePath, content);
+ }
+ }
+ } catch (error) {
+ console.error(`Error updating font paths: ${error}`);
+ }
+
// Remove sourcemaps
await removeSourceMapFiles('packages/bruno-electron/web');
diff --git a/scripts/build-electron.sh b/scripts/build-electron.sh
index 42c19a2d8..7f3887c70 100755
--- a/scripts/build-electron.sh
+++ b/scripts/build-electron.sh
@@ -13,8 +13,9 @@ mkdir packages/bruno-electron/web
cp -r packages/bruno-app/dist/* packages/bruno-electron/web
-# Change paths in next
+# Update static paths
sed -i'' -e 's@/static/@static/@g' packages/bruno-electron/web/**.html
+sed -i'' -e 's@/static/font@../../static/font@g' packages/bruno-electron/web/static/css/**.**.css
# Remove sourcemaps
find packages/bruno-electron/web -name '*.map' -type f -delete
diff --git a/scripts/dev-hot-reload.js b/scripts/dev-hot-reload.js
new file mode 100644
index 000000000..7c059a8f5
--- /dev/null
+++ b/scripts/dev-hot-reload.js
@@ -0,0 +1,245 @@
+#!/usr/bin/env node
+
+/**
+# Bruno Development Script
+#
+# This script sets up and runs the Bruno development environment with hot-reloading.
+# It manages concurrent processes for various packages and provides cleanup on exit.
+#
+# Usage:
+# From the root of the project, run:
+# node ./scripts/dev-hot-reload.js [options]
+# or
+# npm run dev:watch -- [options]
+*/
+
+const { execSync } = require('child_process');
+const { readFileSync } = require('fs');
+
+// Get major version from .nvmrc (e.g. v22.1.0 -> v22)
+const NODE_VERSION = readFileSync('.nvmrc', 'utf8').trim().split('.')[0];
+
+// Configuration
+const CONFIG = {
+ NODE_VERSION,
+ ELECTRON_WATCH_PATHS: [
+ 'packages/**/dist/',
+ 'packages/bruno-electron/src/',
+ 'packages/bruno-lang/src/',
+ 'packages/bruno-lang/v2/src/',
+ 'packages/bruno-js/src/',
+ 'packages/bruno-schema/src/'
+ ],
+ ELECTRON_START_DELAY: 10, // seconds
+ NODEMON_WATCH_DELAY: 1000 // milliseconds
+};
+
+const COLORS = {
+ red: '\x1b[0;31m',
+ green: '\x1b[0;32m',
+ yellow: '\x1b[1;33m',
+ blue: '\x1b[0;34m',
+ nc: '\x1b[0m' // No Color
+};
+
+const LOG_LEVELS = {
+ INFO: 'INFO',
+ WARN: 'WARN',
+ ERROR: 'ERROR',
+ DEBUG: 'DEBUG',
+ SUCCESS: 'SUCCESS'
+};
+
+function log(level, msg) {
+ let color = COLORS.nc;
+ switch (level) {
+ case LOG_LEVELS.INFO:
+ case LOG_LEVELS.SUCCESS: color = COLORS.green; break;
+ case LOG_LEVELS.WARN: color = COLORS.yellow; break;
+ case LOG_LEVELS.ERROR: color = COLORS.red; break;
+ case LOG_LEVELS.DEBUG: color = COLORS.blue; break;
+ }
+
+ const output = `${color}[${level}]${COLORS.nc} ${msg}`;
+ if (level === LOG_LEVELS.ERROR) {
+ console.error(output);
+ } else {
+ console.log(output);
+ }
+}
+
+// Show help documentation
+function showHelp() {
+ console.log(`
+ Development Environment Setup for Bruno
+
+ Usage:
+ From the root of the project, run:
+ npm run dev:watch -- [options]
+ or
+ node scripts/dev-hot-reload.js [options]
+
+ Options:
+ -s, --setup Clean all node_modules folders and re-install dependencies before starting
+ -h, --help Show this help message
+
+ Examples:
+ # Start development environment
+ npm run dev:watch
+
+ # Start after cleaning node_modules
+ npm run dev:watch -- --setup
+
+ # Show this help
+ npm run dev:watch -- --help
+`);
+}
+
+function commandExists(command) {
+ try {
+ execSync(`command -v ${command}`, { stdio: 'ignore' });
+ return true;
+ } catch {
+ return false;
+ }
+}
+
+// Install global NPM package if not present
+function ensureGlobalPackage(packageName) {
+ if (!commandExists(packageName)) {
+ log(LOG_LEVELS.INFO, `Installing ${packageName} globally...`);
+ execSync(`npm install -g ${packageName}`, { stdio: 'inherit' });
+ }
+}
+
+// Ensure correct node version
+function ensureNodeVersion(requiredVersion) {
+ const currentVersion = process.version;
+ if (!currentVersion.includes(requiredVersion)) {
+ log(LOG_LEVELS.ERROR, `Node ${requiredVersion} is required but currently installed version is ${currentVersion}`);
+ log(LOG_LEVELS.ERROR, `Please install node ${requiredVersion} and try again.`);
+ log(LOG_LEVELS.ERROR, `You can run 'nvm install ${requiredVersion}' to install it, or 'nvm use ${requiredVersion}' if it's already installed.`);
+
+ process.exit(1);
+ }
+}
+
+function cleanNodeModules() {
+ log(LOG_LEVELS.INFO, 'Removing all node_modules directories...');
+ execSync('find . -name "node_modules" -type d -prune -exec rm -rf {} +', { stdio: 'inherit' });
+ log(LOG_LEVELS.SUCCESS, 'Node modules cleanup completed');
+}
+
+function reinstallDependencies() {
+ log(LOG_LEVELS.INFO, 'Re-installing dependencies...');
+ execSync('npm install --legacy-peer-deps', { stdio: 'inherit' });
+ log(LOG_LEVELS.SUCCESS, 'Dependencies re-installation completed');
+}
+
+// Setup development environment
+function startDevelopment() {
+ log(LOG_LEVELS.INFO, 'Starting development servers...');
+
+ const concurrently = require('concurrently');
+ const watchPaths = CONFIG.ELECTRON_WATCH_PATHS.map(path => `--watch "${path}"`).join(' ');
+
+ // concurrently command objects: { command, name, prefixColor, env, cwd, ipc }
+ const commandObjects = [
+ {
+ command: 'npm run watch --workspace=packages/bruno-common',
+ name: 'common',
+ prefixColor: 'magenta'
+ },
+ {
+ command: 'npm run watch --workspace=packages/bruno-converters',
+ name: 'converters',
+ prefixColor: 'green'
+ },
+ {
+ command: 'npm run watch --workspace=packages/bruno-query',
+ name: 'query',
+ prefixColor: 'blue'
+ },
+ {
+ command: 'npm run watch --workspace=packages/bruno-graphql-docs',
+ name: 'graphql',
+ prefixColor: 'white'
+ },
+ {
+ command: 'npm run watch --workspace=packages/bruno-requests',
+ name: 'requests',
+ prefixColor: 'gray'
+ },
+ {
+ command: 'npm run watch --workspace=packages/bruno-filestore',
+ name: 'filestore',
+ prefixColor: '#FA8072'
+ },
+ {
+ command: 'npm run dev:web',
+ name: 'react',
+ prefixColor: 'cyan'
+ },
+ {
+ command: `sleep ${CONFIG.ELECTRON_START_DELAY} && nodemon ${watchPaths} --ext js,jsx,ts,tsx --delay ${CONFIG.NODEMON_WATCH_DELAY}ms --exec "npm run dev --workspace=packages/bruno-electron"`,
+ name: 'electron',
+ prefixColor: 'yellow',
+ delay: CONFIG.ELECTRON_START_DELAY
+ }
+ ];
+
+ const { result } = concurrently(commandObjects, {
+ prefix: '[{name}: {pid}]',
+ killOthers: ['failure', 'success'],
+ restartTries: 3,
+ restartDelay: 1000
+ });
+
+ result
+ .then(() => log(LOG_LEVELS.SUCCESS, 'All processes completed successfully'))
+ .catch(err => {
+ log(LOG_LEVELS.ERROR, 'Development environment failed to start');
+ console.error(err);
+ process.exit(1);
+ });
+}
+
+// Main function
+(async function main() {
+ const args = process.argv.slice(2);
+ let runSetup = false;
+
+ // Parse command line arguments
+ for (const arg of args) {
+ if (arg === '-s' || arg === '--setup') {
+ runSetup = true;
+ } else if (arg === '-h' || arg === '--help') {
+ showHelp();
+ process.exit(0);
+ } else {
+ log(LOG_LEVELS.ERROR, `Unknown parameter: ${arg}`);
+ showHelp();
+ process.exit(1);
+ }
+ }
+
+ log(LOG_LEVELS.INFO, 'Initializing Bruno development environment...');
+
+ // Ensure required global packages and node version
+ ensureNodeVersion(CONFIG.NODE_VERSION);
+ ensureGlobalPackage('nodemon');
+ ensureGlobalPackage('concurrently');
+
+ // Run setup if requested
+ if (runSetup) {
+ cleanNodeModules();
+ reinstallDependencies();
+ }
+
+ // Start development environment
+ startDevelopment();
+})().catch(err => {
+ log(LOG_LEVELS.ERROR, 'An error occurred:');
+ console.error(err);
+ process.exit(1);
+});
\ No newline at end of file
diff --git a/scripts/setup.js b/scripts/setup.js
index 47d679098..e0a15bdc1 100644
--- a/scripts/setup.js
+++ b/scripts/setup.js
@@ -74,6 +74,9 @@ async function setup() {
execCommand('npm run build:graphql-docs', 'Building graphql-docs');
execCommand('npm run build:bruno-query', 'Building bruno-query');
execCommand('npm run build:bruno-common', 'Building bruno-common');
+ execCommand('npm run build:bruno-converters', 'Building bruno-converters');
+ execCommand('npm run build:bruno-requests', 'Building bruno-requests');
+ execCommand('npm run build:bruno-filestore', 'Building bruno-filestore');
// Bundle JS sandbox libraries
execCommand(
diff --git a/security.md b/security.md
new file mode 100644
index 000000000..32777f531
--- /dev/null
+++ b/security.md
@@ -0,0 +1,23 @@
+## Security
+
+At Bruno, we take security seriously and are committed to providing a safe experience for all users.
+We appreciate responsible disclosure and value contributions that help improve Bruno's security.
+
+
+## Reporting a Vulnerability
+
+To report a security issue, please email us at [security@usebruno.com](mailto:security@usebruno.com)
+
+When reporting a vulnerability, please include as many details as possible to help us investigate:
+
+- **Type of issue** (e.g., cross-site scripting, malicious npm package, etc.).
+- **Full paths of source file(s)** related to the issue.
+- **Location of affected code** (tag, branch, commit, or direct URL).
+- **Any special configuration** required to reproduce the issue.
+- **Step-by-step instructions** to reproduce the issue.
+- **Proof-of-concept or exploit code** (if available).
+- **Potential impact**, including how an attacker might exploit the issue.
+
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
diff --git a/tests/home.spec.js b/tests/home.spec.js
deleted file mode 100644
index 0ab8a5652..000000000
--- a/tests/home.spec.js
+++ /dev/null
@@ -1,48 +0,0 @@
-const { test, expect } = require('@playwright/test');
-const { HomePage } = require('../tests/pages/home.page');
-const { faker } = require('./utils/data-faker');
-
-test.describe('bruno e2e test', () => {
- let homePage;
-
- test.beforeEach(async ({ page }) => {
- homePage = new HomePage(page);
-
- await homePage.open();
- await expect(page).toHaveURL('/');
- await expect(page).toHaveTitle(/bruno/);
- });
-
- test('user should be able to create new collection & new request', async () => {
- await homePage.createNewCollection(faker.randomWords);
- await expect(homePage.createNewCollectionSuccessToast).toBeVisible();
-
- // using fake data to simulate negative case
- await homePage.createNewRequest(faker.randomVerb, faker.randomHttpMethod, faker.randomUrl);
- await expect(homePage.networkErrorToast).toBeVisible();
-
- // using real data to simulate positive case
- await homePage.createNewRequest('Single User', 'GET', 'https://reqres.in/api/users/2');
- await expect(homePage.statusRequestSuccess).toBeVisible();
- });
-
- test('user should be able to load & use sample collection', async () => {
- await homePage.loadSampleCollection();
- await expect(homePage.loadSampleCollectionSuccessToast).toBeVisible();
-
- await homePage.getUsers();
- await expect(homePage.statusRequestSuccess).toBeVisible();
-
- await homePage.getSingleUser();
- await expect(homePage.statusRequestSuccess).toBeVisible();
-
- await homePage.getUserNotFound();
- await expect(homePage.statusRequestNotFound).toBeVisible();
-
- await homePage.createUser();
- await expect(homePage.statusRequestCreated).toBeVisible();
-
- await homePage.updateUser();
- await expect(homePage.statusRequestSuccess).toBeVisible();
- });
-});
diff --git a/tests/pages/home.page.js b/tests/pages/home.page.js
deleted file mode 100644
index 4aff24ce1..000000000
--- a/tests/pages/home.page.js
+++ /dev/null
@@ -1,86 +0,0 @@
-exports.HomePage = class HomePage {
- constructor(page) {
- this.page = page;
-
- // welcome
- this.createCollectionSelector = page.locator('#create-collection');
- this.addCollectionSelector = page.locator('#add-collection');
- this.importCollectionSelector = page.locator('#import-collection');
- this.loadSampleCollectionSelector = page.locator('#load-sample-collection');
-
- // sample collection
- this.loadSampleCollectionSuccessToast = page.getByText('Sample Collection loaded successfully');
- this.sampleCollectionSelector = page.locator('#sidebar-collection-name');
- this.getUsersSelector = page.getByText('Users');
- this.getSingleUserSelector = page.getByText('Single User');
- this.getUserNotFoundSelector = page.getByText('User Not Found');
- this.postCreateSelector = page.getByText('Create');
- this.putUpdateSelector = page.getByText('Update');
-
- // request panel
- this.sendRequestButton = page.locator('#send-request');
- this.statusRequestSuccess = page.getByText('200 OK');
- this.statusRequestNotFound = page.getByText('404 Not Found');
- this.statusRequestCreated = page.getByText('201 Created');
-
- // create collection
- this.collectionNameField = page.locator('#collection-name');
- this.submitButton = page.locator(`button[type='submit']`);
- this.createNewCollectionSuccessToast = page.getByText('Collection created');
- this.createNewTab = page.locator('#create-new-tab');
- this.requestNameField = page.locator('input[name="requestName"]');
- this.methodName = page.locator('#create-new-request-method').first();
- this.requestUrlField = page.locator('#request-url');
- this.networkErrorToast = page.getByText('Network Error');
- }
-
- async open() {
- await this.page.goto('/');
- }
-
- async loadSampleCollection() {
- await this.loadSampleCollectionSelector.click();
- }
-
- async getUsers() {
- await this.sampleCollectionSelector.click();
- await this.getUsersSelector.click();
- await this.sendRequestButton.click();
- }
-
- async getSingleUser() {
- await this.getSingleUserSelector.click();
- await this.sendRequestButton.click();
- }
-
- async getUserNotFound() {
- await this.getUserNotFoundSelector.click();
- await this.sendRequestButton.click();
- }
-
- async createUser() {
- await this.postCreateSelector.click();
- await this.sendRequestButton.click();
- }
-
- async updateUser() {
- await this.putUpdateSelector.click();
- await this.sendRequestButton.click();
- }
-
- async createNewCollection(collectionName) {
- await this.createCollectionSelector.click();
- await this.collectionNameField.fill(collectionName);
- await this.submitButton.click();
- }
-
- async createNewRequest(name, method, endpoint) {
- await this.createNewTab.click();
- await this.requestNameField.fill(name);
- await this.methodName.click();
- await this.page.click(`text=${method}`);
- await this.requestUrlField.fill(endpoint);
- await this.submitButton.click();
- await this.sendRequestButton.click();
- }
-};
diff --git a/tests/utils/data-faker.js b/tests/utils/data-faker.js
deleted file mode 100644
index 2674b6244..000000000
--- a/tests/utils/data-faker.js
+++ /dev/null
@@ -1,6 +0,0 @@
-const { faker } = require('@faker-js/faker');
-
-export let randomWords = faker.random.words();
-export let randomVerb = faker.hacker.verb();
-export let randomHttpMethod = faker.internet.httpMethod();
-export let randomUrl = faker.internet.url();
+
+### ब्रूनो - API इंटरफेस (API) का अन्वेषण और परीक्षण करने के लिए एक ओपन-सोर्स विकास वातावरण।
+
+[](https://badge.fury.io/gh/usebruno%2Fbruno)
+[](https://github.com/usebruno/bruno/actions/workflows/tests.yml)
+[](https://github.com/usebruno/bruno/pulse)
+[](https://twitter.com/use_bruno)
+[](https://www.usebruno.com)
+[](https://www.usebruno.com/downloads)
+
+[English](../../readme.md)
+| [Українська](./readme_ua.md)
+| [Русский](./readme_ru.md)
+| [Türkçe](./readme_tr.md)
+| [Deutsch](./readme_de.md)
+| [Français](./readme_fr.md)
+| [Português (BR)](./readme_pt_br.md)
+| [한국어](./readme_kr.md)
+| [বাংলা](./readme_bn.md)
+| [Español](./readme_es.md)
+| [Italiano](./readme_it.md)
+| [Română](./readme_ro.md)
+| [Polski](./readme_pl.md)
+| [简体中文](./readme_cn.md)
+| [正體中文](./readme_zhtw.md)
+| [العربية](./readme_ar.md)
+| [日本語](./readme_ja.md)
+| [ქართული](./readme_ka.md)
+| **हिन्दी**
+
+ब्रूनो एक नया और अभिनव API क्लाइंट है, जिसका उद्देश्य Postman और अन्य समान उपकरणों द्वारा प्रस्तुत स्थिति को बदलना है।
+
+ब्रूनो आपकी कलेक्शनों को सीधे आपकी फाइल सिस्टम के एक फ़ोल्डर में संग्रहीत करता है। हम API अनुरोधों के बारे में जानकारी सहेजने के लिए एक सामान्य टेक्स्ट मार्कअप भाषा, Bru, का उपयोग करते हैं।
+
+आप अपनी API कलेक्शनों पर सहयोग करने के लिए Git या अपनी पसंद के किसी भी संस्करण नियंत्रण प्रणाली का उपयोग कर सकते हैं।
+
+ब्रूनो केवल ऑफ़लाइन उपयोग के लिए है। ब्रूनो में कभी भी क्लाउड-सिंक जोड़ने की कोई योजना नहीं है। हम आपके डेटा की गोपनीयता को महत्व देते हैं और मानते हैं कि इसे आपके डिवाइस पर ही रहना चाहिए। हमारी दीर्घकालिक दृष्टि [यहाँ](https://github.com/usebruno/bruno/discussions/269) पढ़ें।
+
+📢 हमारे हालिया India FOSS 3.0 सम्मेलन में हमारे वार्तालाप को [यहाँ](https://www.youtube.com/watch?v=7bSMFpbcPiY) देखें।
+
+