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

SDK-320: Replace System.out.println with logger #252

Merged
merged 6 commits into from
Sep 10, 2023

Conversation

wikumChamith
Copy link
Member

Description of what I changed

Replacing System.out.println with org.slf4j.Logger in adherence to the OpenMRS Java Convention.

Issue I worked on

see https://issues.openmrs.org/browse/SDK-320

Checklist: I completed these to help reviewers :)

  • My IDE is configured to follow the code style of this project.

    No? Unsure? -> configure your IDE, format the code and add the changes with git add . && git commit --amend

  • I have added tests to cover my changes. (If you refactored
    existing code that was well tested you do not have to add tests)

    No? -> write tests and add them to this commit git add . && git commit --amend

  • I ran mvn clean install right before creating this pull request and
    added all formatting changes to my commit.

    No? -> execute the above command

  • All new and existing tests passed.

    No? -> figure out why and add the fix to your commit. It is your responsibility to make sure your code works.

  • My pull request is based on the latest changes of the master branch.

    No? Unsure? -> execute command git pull --rebase upstream master

Replacing System.out.println with org.slf4j.Logger in adherence to the OpenMRS Java Convention.
@dkayiwa
Copy link
Member

dkayiwa commented Sep 6, 2023

Did you get a chance to look at this? https://wiki.openmrs.org/display/docs/Java+Conventions#JavaConventions-HowToLog

@wikumChamith wikumChamith changed the title Replace System.out.println with logger SDK-320: Replace System.out.println with logger Sep 6, 2023
Replacing System.out.println with org.slf4j.Logger in adherence to the OpenMRS Java Convention.
@wikumChamith
Copy link
Member Author

wikumChamith commented Sep 6, 2023

Did you get a chance to look at this? https://wiki.openmrs.org/display/docs/Java+Conventions#JavaConventions-HowToLog

I followed it. Are there any changes I should make??

@dkayiwa
Copy link
Member

dkayiwa commented Sep 6, 2023

I followed it. Are there any changes I should make??

Just give it one more look. 😊

Replacing System.out.println with org.slf4j.Logger in adherence to the OpenMRS Java Convention.
@@ -300,7 +304,7 @@ private String runProcessAndGetFirstResponseLine(String command, @Nullable Strin
lines = IOUtils.readLines(process.getInputStream(), StandardCharsets.UTF_8);
process.waitFor();
} catch (InterruptedException | IOException e) {
System.out.println(e.getMessage());
logger.error("Exception: ", e);
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't the first parameter be the exception message?

Copy link
Member Author

Choose a reason for hiding this comment

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

@dkayiwa I changed this

@@ -300,7 +304,7 @@ private String runProcessAndGetFirstResponseLine(String command, @Nullable Strin
lines = IOUtils.readLines(process.getInputStream(), StandardCharsets.UTF_8);
process.waitFor();
} catch (InterruptedException | IOException e) {
System.out.println(e.getMessage());
logger.error(e.getMessage());
Copy link
Member

Choose a reason for hiding this comment

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

It is usually a good practice to pass the exception object as the second parameter.

Files.delete(linkPath);
} else {
return true;
}
} catch (IOException e) {
System.out.printf((CANNOT_CREATE_LINK_MSG) + "%n", link.getAbsolutePath(), e.getMessage());
logger.error(CANNOT_CREATE_LINK_MSG, link.getAbsolutePath(), e.getMessage());
Copy link
Member

Choose a reason for hiding this comment

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

It is usually great to pass the exception object at the end

Copy link
Member Author

Choose a reason for hiding this comment

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

I made the changes

@dkayiwa dkayiwa merged commit b8b00fb into openmrs:master Sep 10, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants