Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: generate config returns after logging error #1154

Merged
merged 20 commits into from
Dec 14, 2023

Conversation

officialasishkumar
Copy link
Contributor

Related Issue

The implementation of keploy/pkg/service/generateConfig/generateConfig.go doesn't return in case of error and is subject to nil memory exception.

Closes: #1152

Describe the changes you've made

Added return

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Code style update (formatting, local variables)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Please let us know if any test cases are added

Please describe the tests(if any). Provide instructions how its affecting the coverage.

Describe if there is any unusual behaviour of your code(Write NA if there isn't)

NA

A clear and concise description of it.

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

Screenshots (if any)

Original Updated
original screenshot updated screenshot

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Copy link

sweep-ai bot commented Nov 30, 2023

Apply Sweep Rules to your PR?

  • Apply: All new business logic should have corresponding unit tests.
  • Apply: Refactor large functions to be more modular.
  • Apply: Add docstrings to all functions and file headers.

@officialasishkumar
Copy link
Contributor Author

Hey @shivamsouravjha, Can you please review this PR?

Copy link
Contributor

@shivamsouravjha shivamsouravjha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try installing go extension and fix the code style. The return terminology isn't right(set code style update)

AkashKumar7902 and others added 6 commits November 30, 2023 17:46
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
@officialasishkumar
Copy link
Contributor Author

Hey @shivamsouravjha, can you please review this?

Copy link
Contributor

@shivamsouravjha shivamsouravjha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Quick note on the logging strategy in the code: When we use a logger at the 'fatal' level, the code execution halts automatically at that point. Hence, adding return statements after each 'fatal' logger isn't necessary.

  • Also, on choosing between 'Error' and 'Fatal' for logging: 'Fatal' should be used in situations where the application must stop immediately due to a critical issue. This ensures immediate attention to severe problems and prevents the continuation of processes that could be harmful

@shivamsouravjha
Copy link
Contributor

cc @charankamarapu

@shivamsouravjha
Copy link
Contributor

@officialasishkumar are you working on this issue

@officialasishkumar
Copy link
Contributor Author

I've made the necessary changes. Please take a look @shivamsouravjha

Copy link
Contributor

@shivamsouravjha shivamsouravjha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@officialasishkumar reformat the code as with a reformat only change is the return statement. Are you using vscode or goland for this?

Copy link
Contributor

@shivamsouravjha shivamsouravjha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reformat the code as formatting isssue

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
@officialasishkumar
Copy link
Contributor Author

@shivamsouravjha PTAL

@shivamsouravjha shivamsouravjha merged commit cc84c04 into keploy:main Dec 14, 2023
10 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Dec 14, 2023
@shivamsouravjha
Copy link
Contributor

@officialasishkumar congratulations on the PR merge!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[bug]: GenerateConfig doesn't return after logging error
3 participants