Enhancement on API Model#4144
Conversation
WalkthroughThe changes update several parts of the API model management and UI workflow. The default API type in the model selection UI now displays the Swagger description, and file dialog filters have been consolidated. Global parameter creation now prevents duplicates while folder organization for Swagger API models is enhanced, with new error handling. Swagger API processing gains improved tag handling and parameter descriptions using string interpolation, and various methods have been refactored for null safety and consistency. Additionally, file content access methods have been modified for better error handling and functionality. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant M as APIModelWizard
participant G as GlobalParams
participant R as Repository
U->>M: Initiate API model import
M->>G: Check for duplicate global parameters
alt Parameter exists
G-->>M: Return existing parameter
else Parameter missing
M-->>G: Create new global parameter
end
M->>M: Evaluate API type (Swagger) & tags
M->>R: Verify folder existence based on tag
alt Folder exists
R-->>M: Folder found
else Folder missing
R-->>M: Create folder
alt Exception occurs
Note over M,R: Log error
end
end
M->>U: Complete import process
sequenceDiagram
participant O as OpenApiBase
participant S as Solution Tags
participant A as API Model (AAM)
O->>O: GenerateBasicModel()
loop For each tag in Operation.Tags
O->>S: Check tag existence
alt Tag exists
S-->>O: Return tag key
else Tag missing
O->>S: Create new RepositoryItemTag
S-->>O: Return new tag key
end
O->>A: Append tag key to model
end
Possibly related PRs
Poem
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (8)
Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelSelectTypePage.xaml.cs(3 hunks)Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelWizard.cs(3 hunks)Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/OpenApiBase.cs(4 hunks)Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/SwaggerParser.cs(1 hunks)Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/SwaggerVer2.cs(0 hunks)Ginger/GingerCore/GeneralLib/General.cs(1 hunks)Ginger/GingerCoreCommon/Repository/RepositoryFolder.cs(1 hunks)Ginger/GingerCoreNET/WizardLib/WizardBase.cs(1 hunks)
💤 Files with no reviewable changes (1)
- Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/SwaggerVer2.cs
🔇 Additional comments (11)
Ginger/GingerCoreNET/WizardLib/WizardBase.cs (1)
263-263: Good defensive coding practice added to prevent NullReferenceExceptionThe addition of the null-conditional operator (
?.) ensures that theClose()method is only invoked whenmWizardWindowis not null, preventing potential null reference exceptions.Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/SwaggerParser.cs (1)
53-53: Improved code consistency by reusing previously loaded contentThis change reuses the
fileContentvariable that was already loaded and validated on lines 51-52, rather than reloading it with another call toFileContentProvider(FileName). This provides better consistency and potentially improves performance by avoiding duplicate file reads.Ginger/GingerCoreCommon/Repository/RepositoryFolder.cs (1)
784-784: Good defensive coding practice added to prevent NullReferenceExceptionThe addition of the null-conditional operator (
?.) ensures thatFilePathis only accessed whenrepositoryItemis not null, preventing potential null reference exceptions during the deletion process.Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelSelectTypePage.xaml.cs (3)
49-49: Good improvement to the default API type selection!Changing from hardcoded WSDL to Swagger using
GetEnumDescriptionprovides a more user-friendly description in the dropdown and sets Swagger as the default type, which aligns with modern API practices.
443-443: Nice UX improvement for file selection!Consolidating JSON and YAML file types into a single filter option simplifies the user experience while maintaining all the necessary functionality.
710-711: Good use of nameof() operator!Replacing string literals with
nameof()for enum comparison improves type safety. If enum names change in the future, the compiler will catch the errors rather than having them appear at runtime.Also applies to: 715-715
Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelWizard.cs (2)
136-145: Good enhancement to prevent duplicate global parameters!The added logic checks for existing parameters with the same placeholder and URL before creating new ones, which prevents duplication and improves the overall robustness of the code.
192-208: Nice feature for organizing API models by tags!The new code creates subfolders based on API tags when the API type is Swagger, which improves organization of the API models. The proper error handling with try-catch and appropriate logging is also well implemented.
Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/OpenApiBase.cs (3)
110-111: Improved parameter descriptions with source documentation!The enhanced parameter description now includes the original Swagger documentation, making it more informative for users. Good use of string interpolation for improved readability.
122-145: Excellent addition of tag handling for Swagger APIs!This new feature properly associates API tags from Swagger definitions with the solution's tag system, improving organization and discoverability of API models. The implementation includes proper error handling and logging.
203-203: Consistent improvement to parameter descriptions!The parameter descriptions for headers and query parameters now include the original Swagger documentation, maintaining consistency with the URL parameter improvements and enhancing the overall quality of the API model information.
Also applies to: 213-213
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (8)
Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelSelectTypePage.xaml.cs(4 hunks)Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelWizard.cs(5 hunks)Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/ScanAPIModelWizardPage.xaml.cs(1 hunks)Ginger/Ginger/SolutionWindows/TreeViewItems/NewTreeViewItemBase.cs(1 hunks)Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/OpenApiBase.cs(6 hunks)Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/OpenApiVer3.cs(0 hunks)Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/SwaggerParser.cs(2 hunks)Ginger/GingerAutoPilot/GingerAutoPilot.csproj(0 hunks)
💤 Files with no reviewable changes (2)
- Ginger/GingerAutoPilot/GingerAutoPilot.csproj
- Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/OpenApiVer3.cs
🔇 Additional comments (18)
Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/ScanAPIModelWizardPage.xaml.cs (1)
397-397: Improved error handling with empty array instead of null.The change from returning
nullto returning an empty array[]when JSON parsing fails enhances code robustness by preventing potential null reference exceptions downstream.Ginger/Ginger/SolutionWindows/TreeViewItems/NewTreeViewItemBase.cs (1)
741-745: Better variable extraction improves code clarity.Extracting the cast object into the
folderBasevariable improves readability and avoids repeated casting operations in the original code.Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/SwaggerParser.cs (4)
45-45: Improved error handling with empty array instead of null.Returning an empty array instead of null when YAML parsing fails is a better practice that prevents potential null reference exceptions in calling code.
54-54: Using existing validated content instead of re-reading file.This change fixes a potential bug by using the already validated
fileContentvariable instead of re-reading the file, ensuring consistency between validation and processing.
60-60: Consistent error handling with empty array instead of null.Similar to line 45, this change provides consistent error handling by returning an empty array instead of null when JSON parsing fails.
64-64: Added null check to prevent potential NullReferenceException.The null-conditional operator (
?.) ensures the code won't throw an exception ifSwaggerdocis null, improving robustness.Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelWizard.cs (6)
136-145: Prevent duplicate parameters by checking for existing ones.This enhancement checks if a global parameter with the same placeholder and custom URL already exists before creating a new one, preventing duplicates in the system.
167-174: Improved variable naming and parameter handling.The variable name
globalAppModelParameterForUrlis more descriptive than the previous name, and the refactored approach to parameter creation and storage is cleaner.
181-196: Enhanced endpoint URL configuration with global parameters.This section has been improved to properly set up the endpoint URL and link it with the global parameters, using a cleaner and more structured approach.
207-224: Added subfolder creation based on API tags with proper error handling.This new feature creates subfolders based on the first tag in Swagger API models, with appropriate error handling to prevent crashes if the folder creation fails.
239-248: More robust repository item addition logic.The condition for adding the API model to the repository folder has been improved to handle the case where the containing folder might be different from the API model folder.
251-263: New helper method for root folder management.The new
GetOrAddRootFolder()method improves code organization by centralizing the logic for getting or creating a root folder based on the API info title.Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelSelectTypePage.xaml.cs (3)
49-49: Set Swagger API type as default text for combobox.
This change correctly updates the default displayed API type to Swagger. Confirm that any references expecting WSDL as the default have been updated accordingly.
443-443: Consolidate JSON and YAML file selections.
Merging JSON and YAML into a single filter entry improves user experience and reduces confusion.
710-710: Consistent enum-based file filtering.
These checks follow the samenameof(eAPIType...)design, ensuring consistency and readability.Also applies to: 715-715
Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/OpenApiBase.cs (3)
21-21: Added reference toAmdocs.Ginger.Common.WorkSpaceLib.
This import is required forGingerCoreCommonWorkSpaceusage. No issues found.
110-111: Append parameter description in the generated URL parameters.
Using?.Descriptionand string interpolation to include more context is a clear improvement.
518-518: Null-check for definitions inapidoc.
The additional null-check prevents possibleNullReferenceException.
Renamed `getInfoTitle` to `GetInfoTitle` in `SwaggerParser` to follow C# naming conventions. Moved `FileContentProvider` from `APIConfigurationsDocumentParserBase` to `General` in `Amdocs.Ginger.Common.GeneralLib` with enhanced error handling and logging. Updated `SwaggerParser` and `CLIProcessor` to use the new `FileContentProvider` method. Switched `HttpUtilities` to use `HttpClient` instead of `WebClient` for better HTTP request/response handling.
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (3)
Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelSelectTypePage.xaml.cs (3)
239-239: 🧹 Nitpick (assertive)Consider updating remaining string comparisons to use nameof()
While you've improved several enum comparisons with
nameof(), there are still instances like this one using string literals.-if (APITypeComboBox.SelectedValue.ToString() == eAPIType.WSDL.ToString() || APITypeComboBox.SelectedValue.ToString() == eAPIType.Swagger.ToString()) +if (APITypeComboBox.SelectedValue.ToString() == nameof(eAPIType.WSDL) || APITypeComboBox.SelectedValue.ToString() == nameof(eAPIType.Swagger))
276-276: 🧹 Nitpick (assertive)Consider applying nameof() pattern consistently
Similar to line 239, this string comparison could be updated to use
nameof()for consistency.-else if (APITypeComboBox.SelectedValue.ToString() == eAPIType.XMLTemplates.ToString() || APITypeComboBox.SelectedValue.ToString() == eAPIType.JsonTemplate.ToString()) +else if (APITypeComboBox.SelectedValue.ToString() == nameof(eAPIType.XMLTemplates) || APITypeComboBox.SelectedValue.ToString() == nameof(eAPIType.JsonTemplate))
385-385: 🧹 Nitpick (assertive)Consider using a more direct approach for enum comparisons
Instead of converting both the enum and the selected value to strings, consider casting the selected value to the enum type for direct comparison.
-if (!string.IsNullOrEmpty(xURLTextBox.Text) && APITypeComboBox.SelectedValue.ToString() != eAPIType.Swagger.ToString()) +if (!string.IsNullOrEmpty(xURLTextBox.Text) && (eAPIType)APITypeComboBox.SelectedValue != eAPIType.Swagger)Also applies to: 396-396, 410-410, 436-436
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (6)
Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelSelectTypePage.xaml.cs(5 hunks)Ginger/GingerAutoPilot/APIModelLib/APIConfigurationsDocumentParserBase.cs(0 hunks)Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/SwaggerParser.cs(3 hunks)Ginger/GingerCoreCommon/GeneralLib/General.cs(1 hunks)Ginger/GingerCoreCommon/GeneralLib/HttpUtilities.cs(2 hunks)Ginger/GingerCoreNET/RunLib/CLILib/CLIProcessor.cs(1 hunks)
💤 Files with no reviewable changes (1)
- Ginger/GingerAutoPilot/APIModelLib/APIConfigurationsDocumentParserBase.cs
🧰 Additional context used
🧬 Code Definitions (3)
Ginger/GingerCoreCommon/GeneralLib/General.cs (1)
Ginger/GingerCoreCommon/GeneralLib/HttpUtilities.cs (2) (2)
HttpUtilities(27:44)Download(29:43)
Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelSelectTypePage.xaml.cs (4)
Ginger/GingerCoreCommon/GeneralLib/General.cs (1) (1)
General(34:563)Ginger/GingerCore/GeneralLib/General.cs (2) (2)
General(54:1526)GetEnumDescription(282:311)Ginger/GingerCoreCommon/Repository/RepositoryFolder.cs (1) (1)
ToString(87:90)Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelWizard.cs (2) (2)
AddAPIModelWizard(38:264)AddAPIModelWizard(84:97)
Ginger/GingerCoreNET/RunLib/CLILib/CLIProcessor.cs (1)
Ginger/GingerCoreCommon/GeneralLib/General.cs (2) (2)
General(34:563)FileContentProvider(509:554)
🔇 Additional comments (15)
Ginger/GingerCoreCommon/GeneralLib/HttpUtilities.cs (2)
21-22: Added necessary imports for HttpClient implementation.The addition of System.Net.Http and System.Threading.Tasks imports supports the migration from WebClient to HttpClient.
31-35: Good implementation of proxy configuration for HttpClient.The HttpClientHandler is properly configured with system proxy settings, which maintains compatibility with the application's network configuration.
Ginger/GingerCoreCommon/GeneralLib/General.cs (1)
509-554: Well-implemented FileContentProvider method with robust error handling.This method centralizes file content retrieval logic with comprehensive error handling for both local files and remote URLs. The proper separation of file vs URL handling with specific error messages and logging enhances maintainability.
However, a minor improvement could be to add timeout handling for URL downloads to prevent hanging on slow connections:
try { Reporter.ToLog(eLogLevel.DEBUG, $"Downloading {filename}"); - originalJson = Common.GeneralLib.HttpUtilities.Download(url); + // Set a reasonable timeout to prevent hanging + using (var httpClientHandler = new HttpClientHandler { UseProxy = true, Proxy = WebRequest.GetSystemWebProxy() }) + using (var httpClient = new HttpClient(httpClientHandler) { Timeout = TimeSpan.FromSeconds(60) }) + { + originalJson = httpClient.GetStringAsync(url).GetAwaiter().GetResult(); + } if (string.IsNullOrEmpty(originalJson)) { Reporter.ToLog(eLogLevel.ERROR, "Downloaded content is empty: " + filename); throw new Exception("Downloaded content is empty: " + filename); } }Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/SwaggerParser.cs (6)
36-37: Updated to use the centralized FileContentProvider.Good refactoring to use the centralized file content retrieval method for better consistency and error handling.
45-46: Improved error handling with clear return value.Changed from potentially continuing with invalid data to returning an empty array, which is a safer approach.
52-55: Consistent use of centralized file provider and better variable reuse.Good update to use the FileContentProvider and directly passing the retrieved content to SwaggerDocument.FromJsonAsync.
60-61: Consistent error handling pattern.Matching the error handling pattern from the YAML case improves code consistency.
64-64: Added null-check for safer code execution.The null-conditional operator prevents potential NullReferenceException if Swaggerdoc is null.
78-81: Method renamed for C# naming convention compliance and null safety.Updated method name from
getInfoTitle()toGetInfoTitle()for proper Pascal case and added null-conditional operators for better null safety.Ginger/GingerCoreNET/RunLib/CLILib/CLIProcessor.cs (1)
673-673: Simplified ReadFile method using the centralized FileContentProvider.Good refactoring to use the centralized file content retrieval method, which provides consistent error handling and simplifies this method.
Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelSelectTypePage.xaml.cs (5)
49-49: Approve default API type change to SwaggerThe default API type in the UI is now set to display the Swagger description, which aligns with the PR objectives to enhance API selection.
443-443: Improve UX by consolidating file selection filtersCombining JSON and YAML file types into a single filter makes file selection more intuitive for Swagger documents, which can be in either format.
503-503: Approve type-safe enum comparisonsUsing
nameof()for API type comparisons improves type safety and makes the code more resistant to refactoring issues.Also applies to: 508-508, 512-512, 517-517
584-584: Approve capturing Swagger metadataGood addition that extracts the title information from the Swagger document, supporting the PR objective of enhancing folder organization for Swagger API models.
709-709: Approve type-safe enum comparisons in filter selectionConsistent use of
nameof()for API type comparisons in the filter selection logic.Also applies to: 715-715
Improved readability in `AddAPIModelSelectTypePage.xaml.cs` by using `nameof` for enum comparison. Simplified synchronous HTTP GET request in `HttpUtilities.cs` by replacing `Wait` and `Result` with `GetAwaiter().GetResult()`, reducing potential deadlocks and enhancing code clarity.
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (2)
Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelSelectTypePage.xaml.cs (2)
239-239: 🧹 Nitpick (assertive)Inconsistent use of string comparison for enum values.
While many enum comparisons have been updated to use the
nameofoperator, several instances still use string conversion with.ToString(). Consider applying the same pattern consistently throughout the file.- if (APITypeComboBox.SelectedValue.ToString() == eAPIType.WSDL.ToString() || APITypeComboBox.SelectedValue.ToString() == eAPIType.Swagger.ToString()) + if (APITypeComboBox.SelectedValue.ToString() == nameof(eAPIType.WSDL) || APITypeComboBox.SelectedValue.ToString() == nameof(eAPIType.Swagger))Similar changes should be made on lines 248, 276, 385, and 396.
Also applies to: 248-248, 276-276, 385-385, 396-396
183-185: 🧹 Nitpick (assertive)Unreachable code after exception.
The
breakstatement after throwing an exception is unreachable and can be removed.default: throw new Exception("Selected API Type not found."); - break;
♻️ Duplicate comments (1)
Ginger/GingerCoreCommon/GeneralLib/HttpUtilities.cs (1)
30-42:⚠️ Potential issueBlocking call pattern can lead to deadlocks.
While the code has been updated to use
HttpClientinstead ofWebClient, it still uses a blocking call pattern withGetAwaiter().GetResult(). This can lead to deadlocks in UI applications or ASP.NET contexts.Consider implementing the proper async/await pattern as suggested in the previous review:
- public static string Download(Uri url) - { - HttpClientHandler handler = new HttpClientHandler - { - Proxy = WebRequest.GetSystemWebProxy(), - UseProxy = true - }; - - HttpClient httpClient = new HttpClient(handler); - - // Make the request and get the response - var response = httpClient.GetStringAsync(url).GetAwaiter().GetResult(); - return response; - } + public static async Task<string> DownloadAsync(Uri url) + { + HttpClientHandler handler = new HttpClientHandler + { + Proxy = WebRequest.GetSystemWebProxy(), + UseProxy = true + }; + + using (HttpClient httpClient = new HttpClient(handler)) + { + // Make the request and get the response + return await httpClient.GetStringAsync(url); + } + } + + // For backward compatibility + public static string Download(Uri url) + { + try + { + return DownloadAsync(url).GetAwaiter().GetResult(); + } + catch (Exception ex) + { + throw new WebException("Error downloading from URL", ex); + } + }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelSelectTypePage.xaml.cs(6 hunks)Ginger/GingerCoreCommon/GeneralLib/HttpUtilities.cs(2 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelSelectTypePage.xaml.cs (3)
Ginger/GingerCore/GeneralLib/General.cs (4) (4)
General(54:1526)GetEnumDescription(282:311)System(871:875)System(877:881)Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelWizard.cs (2) (2)
AddAPIModelWizard(38:264)AddAPIModelWizard(84:97)Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/SwaggerParser.cs (1) (1)
GetInfoTitle(78:81)
🔇 Additional comments (4)
Ginger/Ginger/ApplicationModelsLib/APIModels/APIModelWizard/AddAPIModelSelectTypePage.xaml.cs (4)
49-49: Improved default API type selection.Changing the default API type from WSDL to Swagger with a user-friendly description enhances the initial experience for users.
410-410: Improved type safety with nameof operator.Using
nameoffor enum comparisons provides compile-time safety and prevents issues if enum member names change.Also applies to: 436-436, 503-503, 508-508, 512-512, 517-517, 710-710, 715-715
443-443: Improved UX by combining JSON and YAML file types.Consolidating JSON and YAML formats into a single filter makes the file selection process more intuitive for users since Swagger documents can be in either format.
584-584: Enhanced metadata capture for Swagger documents.Storing the Swagger document title provides valuable metadata for subsequent operations like folder organization.
Refactored code to include a try-catch block for handling HttpRequestException, providing a more descriptive error message. Ensured proper disposal of HttpClient by using a using statement. Moved HttpClientHandler initialization inside the try block to create it only when necessary.
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
Ginger/GingerCoreCommon/GeneralLib/HttpUtilities.cs(2 hunks)
🧰 Additional context used
🧠 Learnings (1)
Ginger/GingerCoreCommon/GeneralLib/HttpUtilities.cs (1)
Learnt from: Maheshkale447
PR: Ginger-Automation/Ginger#4144
File: Ginger/GingerCoreCommon/GeneralLib/HttpUtilities.cs:0-0
Timestamp: 2025-03-18T14:05:17.049Z
Learning: In the HttpUtilities.Download method, the team prefers using HttpClient with blocking calls (Wait() and Result) instead of the async/await pattern because they experienced issues with tasks getting stuck when using the async approach.
🔇 Additional comments (2)
Ginger/GingerCoreCommon/GeneralLib/HttpUtilities.cs (2)
21-21: Good import usage.
The addition of theSystem.Net.Httpimport is necessary forHttpClient. No issues here.
38-42: Using block ensures proper resource disposal.
Leveraging ausingstatement to handle theHttpClientlifecycle is excellent for preventing socket exhaustion. This blocking pattern is consistent with the team's preference to avoid async-related task lockups.
1 participant
Thank you for your contribution.
Before submitting this PR, please make sure:
Enhancement on API Model
PR Classification
Code cleanup and feature enhancement to improve API handling and error prevention.
PR Summary
This pull request includes updates to improve API type handling, file filtering, and error prevention, along with code cleanup.
APITypeComboBox: Changed default value and improved comparison logic.OpenFileDialog: Combined JSON and YAML file types into a single filter option.SwaggerAPI type.GingerCore.General.GetEnumDescriptionto handle missing description attributes.RepositoryFolderandWizardBaseto prevent potential null reference exceptions.Summary by CodeRabbit
New Features
Bug Fixes