Files
sanish chirayath 68cbb7d9df Feat/add import export support for examples (#5936)
* feat: enhance Bru grammar to support response blocks and examples

- Added new grammar rules for response headers, status, and body types (JSON, XML, text).
- Introduced parsing logic for example blocks, allowing multiple examples with various body types.
- Implemented tests for example parsing, including edge cases and complex examples with authentication.
- Created fixture files for simple and complex examples to validate parsing functionality.

feat: extend jsonToBru functionality to support response handling and examples

- Updated jsonToBru to include parsing for response headers, status, and body types (JSON, XML, text).
- Enhanced example handling to support multiple examples with various body types.
- Added comprehensive tests for example parsing, including edge cases and complex scenarios with authentication.
- Created fixture files for testing the new features and validating parsing functionality.

move: files to fixtures folder

refactor: simplify response body handling in Bru grammar and JSON conversion

- Removed specific body type handling (JSON, XML, text) from grammar and semantics.
- Updated response body parsing in jsonToBru to handle a unified response body format.
- Adjusted tests and fixtures to reflect changes in response body structure, ensuring compatibility with the new format.

feat: add response bookmarking functionality to ResponsePane

- Introduced ResponseBookmark component to allow users to save responses as examples.
- Added NameExampleModal for naming saved examples.
- Updated ResponsePane to include the new bookmarking feature.
- Implemented Redux actions to manage response examples in the collections state.
- Enhanced CollectionItem to display saved examples and allow for expansion.

fix: remove unnecessary padding from ExampleItem component

feat: implement delete and rename functionality for examples in ExampleItem component

- Added DeleteExampleModal for confirming deletion of examples.
- Integrated modal for renaming examples with state management.
- Enhanced ExampleItem to handle example deletion and renaming through modals.
- Updated Redux actions to support example updates and deletions in the collections state.

fix: example writing to  disc properly

fix: example parsing errors

fix: request with example parsing error

fix: handle examples in collections and requests

feat: implement response example functionality in the application

- Added ResponseExample component to handle displaying and editing response examples.
- Integrated ResponseExampleRequestPane and ResponseExampleResponsePane for structured request and response handling.
- Enhanced RequestTabPanel and RequestTab components to support response-example tabs.
- Introduced new styled components for better UI/UX in response examples.
- Updated theme files to include styles for response examples.
- Implemented URL bar for editing request URLs in response examples.
- Added functionality for managing headers and parameters in response examples.
- Improved overall structure and organization of response example components.

add styles for example url bar

feat: add Checkbox component and Table-v2 for enhanced UI

- Introduced a new Checkbox component for better user interaction in forms.
- Added Table-v2 component to improve table rendering and resizing functionality.
- Updated existing components to utilize the new Checkbox and Table-v2 for managing headers and parameters in response examples.
- Enhanced styling for better visual consistency across components.
- Updated theme files to include styles for the new components.

feat: implement custom scrollbar styles for response example components

fix: features

add actions , view more

feat: enhance response example functionality

- Added GenerateCodeItem component for generating code snippets from response examples.
- Integrated modal for code generation within ResponseExample component.
- Updated ResponseExampleTopBar to handle example name and description editing.
- Improved state management for response examples, including new actions for updating names and descriptions.
- Enhanced ResponseExampleRequestPane to support editing and saving request details.
- Refactored URL handling in ResponseExampleUrlBar to utilize example-specific data.
- Improved overall user experience with better UI elements and state management.

feat: enhance response example management and UI components

feat: enhance editing capabilities in response example components

feat: update multipart form parameter handling in response examples

feat: refactor response example parameter handling and enhance UI interactions

feat: introduce RadioButton component and update Checkbox usage in response examples

fix: styles

fix radio button styling

fixed radio button styles

feat: add create example from sidebar

feat: enhance ResponseExample components with layout adjustments and new HeightBoundContainer

feat: add Checkbox and RadioButton components with comprehensive tests for rendering, user interactions, and accessibility

feat: playwright test csaes

rm: comments

fix: linting

fix: tests

refactor: update response example tests and enhance functionality

fix: tests

fix: e2e-tests

refactor: implement hasRequestChanges utility for better change detection

rm: console

rm: consoles

fix: lint

fix: tests

fix: response header disabled by default issue

Feat/with bru example parser (#5892)

* fix: response header disabled by default issue

feat: new parsing logic

fix: change test cases to accomodate new brulang

add: path params features

rm:consoles

six: make tab permanent on double click

fix width

feat: add status editing

feat: review fixes

review fixes

fix: review fixes

fix: post review

mv: test files

fix: review

* fix: lint

* fix: review comments

* fix: icons folder strcuture

fix: tests

fix: lint

fix: unit tests

feat: body mode selector

fix: close all collections

rm: example

feat added tests. lang change

feat: add custom status text

fix: status update

feat: add body mode, update tests

add default name prefilled for example

fix: active tab styles, prefilled name, text fixes

fix : pkg lock

fix: review

fix: review comments

fix: hide cursor when readonly

fix: height

fix: null body

fix: response body parsing

fix: test cases

feat: add method support for examples

fix: reponse parsing

fix: update response body type when content type is updated

rm : commented code

feat: update parser logic

fix: organize files

feat: enhance examples handling in collection export and import

feat: postman imports fro examples

feat: enhance OpenAPI import functionality to support examples

feat: support postman export

fix: postman export import

fix: open api tests, remove requestbody related logic

rm: examples

fix:  move common attributes files

ui fixes

fix: clone issue

fix: create example from request menu

review fixes

more review fixes

mv: files, fix mode req error

organize files

fix:tests

fix: save dot issue

fix: bugs

fix: postman export

fix: import path params

* chore:improve modal handling in environment and response example tests

fix: test issues resolved

* chore: update response example tests to use new fixture files and improve cleanup logic

---------

Co-authored-by: Abhishek S Lal <abhishek@usebruno.com>
Co-authored-by: Bijin Bruno <bijin@usebruno.com>
2025-11-01 05:56:11 +05:30

209 lines
6.4 KiB
JavaScript

import React, { useState, useRef, useEffect } from 'react';
import { useDispatch } from 'react-redux';
import { updateResponseExampleStatusCode, updateResponseExampleStatusText } from 'providers/ReduxStore/slices/collections';
import statusCodePhraseMap from 'components/ResponsePane/StatusCode/get-status-code-phrase';
import StyledWrapper from './StyledWrapper';
const ResponseExampleStatusInput = ({ item, collection, exampleUid, status, statusText }) => {
const dispatch = useDispatch();
const [showSuggestions, setShowSuggestions] = useState(false);
const [filteredSuggestions, setFilteredSuggestions] = useState([]);
const [inputValue, setInputValue] = useState('');
const inputRef = useRef(null);
const suggestionsRef = useRef(null);
// Initialize inputValue from Redux state on mount or when prop changes
useEffect(() => {
const displayValue = () => {
if (status && statusText) {
return `${status} ${statusText}`;
} else if (status) {
return status;
}
return '';
};
setInputValue(displayValue());
}, [status, statusText]);
// Create suggestions from status code map
const suggestions = Object.entries(statusCodePhraseMap).map(([code, phrase]) => ({
code: parseInt(code),
phrase,
display: `${code} ${phrase}`
}));
const handleInputChange = (e) => {
const value = e.target.value;
// Update local state to allow typing freely (including spaces)
setInputValue(value);
if (value.trim()) {
// Filter suggestions based on input
const filtered = suggestions.filter((suggestion) =>
suggestion.display.toLowerCase().includes(value.toLowerCase())
|| suggestion.code.toString().includes(value)
|| suggestion.phrase.toLowerCase().includes(value.toLowerCase()));
setFilteredSuggestions(filtered);
setShowSuggestions(true);
} else {
setShowSuggestions(false);
setFilteredSuggestions([]);
}
};
const handleKeyDown = (e) => {
// Handle Cmd+S to save status to Redux
if ((e.metaKey || e.ctrlKey) && e.key === 's') {
e.preventDefault();
parseAndSaveStatus(inputValue);
}
if (!showSuggestions) return;
switch (e.key) {
case 'Escape':
setShowSuggestions(false);
break;
}
};
const selectSuggestion = (suggestion) => {
setShowSuggestions(false);
// Update local input value
const newValue = `${suggestion.code} ${suggestion.phrase}`;
setInputValue(newValue);
// Save the status and statusText
dispatch(updateResponseExampleStatusCode({
itemUid: item.uid,
collectionUid: collection.uid,
exampleUid: exampleUid,
statusCode: String(suggestion.code)
}));
dispatch(updateResponseExampleStatusText({
itemUid: item.uid,
collectionUid: collection.uid,
exampleUid: exampleUid,
statusText: suggestion.phrase
}));
};
const parseAndSaveStatus = (value) => {
// Find the first space
const firstSpaceIndex = value.indexOf(' ');
let statusCode, statusText;
if (firstSpaceIndex === -1) {
// No space found, treat entire value as status code
statusCode = value;
statusText = '';
} else {
// Split on first space only, preserving all other spaces
statusCode = value.substring(0, firstSpaceIndex);
statusText = value.substring(firstSpaceIndex + 1);
}
// Save both as strings - no validation needed
dispatch(updateResponseExampleStatusCode({
itemUid: item.uid,
collectionUid: collection.uid,
exampleUid: exampleUid,
statusCode: statusCode
}));
dispatch(updateResponseExampleStatusText({
itemUid: item.uid,
collectionUid: collection.uid,
exampleUid: exampleUid,
statusText: statusText
}));
setShowSuggestions(false);
};
const handleBlur = (e) => {
// Check if the blur is caused by clicking on a suggestion
const relatedTarget = e.relatedTarget;
if (relatedTarget && relatedTarget.closest('.status-suggestions')) {
return; // Don't close suggestions if clicking on them
}
// Save the status to Redux
parseAndSaveStatus(inputValue);
// Small delay to allow click events on suggestions
setTimeout(() => {
setShowSuggestions(false);
}, 150);
};
const handleFocus = () => {
if (inputValue.trim()) {
const filtered = suggestions.filter((suggestion) =>
suggestion.display.toLowerCase().includes(inputValue.toLowerCase())
|| suggestion.code.toString().includes(inputValue)
|| suggestion.phrase.toLowerCase().includes(inputValue.toLowerCase()));
setFilteredSuggestions(filtered);
setShowSuggestions(true);
}
};
const getStatusClass = (status) => {
const numStatus = parseInt(status);
if (!isNaN(numStatus)) {
if (numStatus >= 200 && numStatus < 300) return 'text-ok';
if (numStatus >= 300 && numStatus < 400) return 'text-warning';
if (numStatus >= 400) return 'text-error';
}
return 'text-ok';
};
return (
<StyledWrapper className="relative">
<input
ref={inputRef}
type="text"
value={inputValue}
onChange={handleInputChange}
onKeyDown={handleKeyDown}
onBlur={handleBlur}
onFocus={handleFocus}
placeholder="e.g., 200 OK, 404 Unknown, 999 Custom Error"
className={`response-status-input ${getStatusClass(status)}`}
data-testid="response-status-input"
/>
{showSuggestions && filteredSuggestions.length > 0 && (
<div
ref={suggestionsRef}
className="status-suggestions"
data-testid="status-suggestions"
onMouseDown={(e) => e.preventDefault()} // Prevent input blur when clicking on suggestions
>
{filteredSuggestions.map((suggestion) => (
<div
key={suggestion.code}
className="suggestion-item"
onClick={(e) => {
e.preventDefault();
e.stopPropagation();
selectSuggestion(suggestion);
}}
onMouseDown={(e) => e.preventDefault()}
data-testid={`suggestion-${suggestion.code}`}
>
<span className="status">{`${suggestion.code} ${suggestion.phrase}`}</span>
</div>
))}
</div>
)}
</StyledWrapper>
);
};
export default ResponseExampleStatusInput;