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

Refactor textRows.readRow to improve readability #1123

Closed
wants to merge 4 commits into from

Conversation

dolmen
Copy link
Contributor

@dolmen dolmen commented Jun 2, 2020

Description

Refactor textRows.readRow to improve readability:

  • simplified flow:
    • reduced maximum indent level
    • return error early
    • remove 3 'continue'
  • remove one type cast
  • remove one obsolete comment about readLengthEncodedString
  • -8 lines of code (not counting the 2 added empty lines)

Checklist

  • Code compiles correctly
  • Created tests which fail without the change (if possible)
  • All tests passing
  • Extended the README / documentation, if necessary
  • Added myself / the copyright holder to the AUTHORS file

packets.go Show resolved Hide resolved
Refactor textRows.readRow to improve readability:
* simplified flow:
  * reduced maximum indent level
  * return error early
  * remove 3 'continue'
* remove one type cast
* remove one obsolete comment about readLengthEncodedString
* -6 lines of code
}
return err // err != nil
Copy link
Member

Choose a reason for hiding this comment

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

isn't err ignored now?
Seems like this should also have a test case.

Copy link
Member

Choose a reason for hiding this comment

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

Okay, I just saw the comment above.
This is a semantic change, which I disagree with. We should not introduce any silent fallback behavior. The user requested a parsed time and should receive an error, not something unexpected.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Well, it looks like I misunderstood the original code. And this shows that it must be refactored to make it easier to follow 😉 .

I will fix my code once the test suite is extended to cover that case.

Copy link
Member

Choose a reason for hiding this comment

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

This still must be changed before I can approve this change.

Copy link
Member

@methane methane left a comment

Choose a reason for hiding this comment

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

I prefer one more indent (e.g. put switch statement inside if mc.parseTime {, instead of duplicated dest[i] = b.
But this is matter of taste. The current PR code is OK too.

packets.go Outdated Show resolved Hide resolved
Co-authored-by: Inada Naoki <songofacandy@gmail.com>
}
return err // err != nil
Copy link
Member

Choose a reason for hiding this comment

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

This still must be changed before I can approve this change.

@julienschmidt julienschmidt added this to the v1.6.0 milestone Jun 9, 2020
@julienschmidt julienschmidt modified the milestones: v1.6.0, v1.7.0 Apr 1, 2021
@dolmen
Copy link
Contributor Author

dolmen commented Jan 18, 2023

Refactor finally happened in 75d09ac. See #1230.

So closing.

@dolmen dolmen closed this Jan 18, 2023
@dolmen dolmen deleted the simplify-readRow branch January 18, 2023 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants