Ginger/GingerAutoPilot/APIModelLib/SwaggerApi/SwaggerParser.cs (3)

36-47: Improved error handling for YAML parsing

The restructured code for YAML parsing is cleaner and easier to follow. The error handling is comprehensive, addressing both logging and user notification, which aligns well with the PR objectives.

Consider making the error message more specific:

- Reporter.ToUser(eUserMsgKey.InvalidYAML);
+ Reporter.ToUser(eUserMsgKey.InvalidYAML, $"Error parsing YAML file: {FileName}");

This change would provide more context to the user about which file caused the error.

---

51-60: Improved error handling for JSON parsing

The restructured code for JSON parsing is consistent with the YAML parsing section, improving overall code clarity and maintainability. The error handling is comprehensive, addressing both logging and user notification.

Consider the following improvements:

1. Make the error message more specific:

- Reporter.ToUser(eUserMsgKey.InvalidJSON);
+ Reporter.ToUser(eUserMsgKey.InvalidJSON, $"Error parsing JSON file: {FileName}");

2. Avoid reading the file content twice:

- string fileContent = FileContentProvider(FileName);
- JToken.Parse(fileContent);  // doing the Jtoken to validate the json file
- Swaggerdoc = SwaggerDocument.FromJsonAsync(FileContentProvider(FileName)).Result;
+ string fileContent = FileContentProvider(FileName);
+ JToken.Parse(fileContent);  // doing the Jtoken to validate the json file
+ Swaggerdoc = SwaggerDocument.FromJsonAsync(fileContent).Result;

These changes would provide more context to the user about which file caused the error and improve performance by avoiding redundant file reads.

---

36-60: Overall improvement in code structure and error handling

The restructuring of the ParseDocument method has significantly improved its readability and maintainability. The separate error handling for YAML and JSON files is clear and consistent. These changes align well with the PR objectives of improving code quality and clarity.

For future improvement, consider extracting the common logic for YAML and JSON parsing into a separate method. This could further reduce code duplication and improve maintainability. Here's a potential refactoring:

private void ParseSwaggerDocument(string fileContent, bool isYaml)
{
    try
    {
        string jsonContent = isYaml ? ConvertYamlToJson(fileContent) : fileContent;
        JToken.Parse(jsonContent); // Validate JSON
        Swaggerdoc = SwaggerDocument.FromJsonAsync(jsonContent).Result;
    }
    catch (Exception ex)
    {
        string fileType = isYaml ? "YAML" : "JSON";
        Reporter.ToLog(eLogLevel.ERROR, $"Error occurred while trying to read provided {fileType} document ", ex);
        Reporter.ToUser(isYaml ? eUserMsgKey.InvalidYAML : eUserMsgKey.InvalidJSON, $"Error parsing {fileType} file: {FileName}");
    }
}

Then, in the ParseDocument method:

string fileContent = FileContentProvider(FileName);
ParseSwaggerDocument(fileContent, IsValidYaml(FileName));

This refactoring would further improve code maintainability and reduce duplication.

Configuration used: CodeRabbit UI
Review profile: CHILL