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

Unstoppable domain (disabled until tested); latest txns cache; bugfixes #22

Merged
merged 11 commits into from
Sep 30, 2023

Conversation

tw0po1nt
Copy link
Collaborator

@tw0po1nt tw0po1nt commented Sep 29, 2023

This code review checklist is intended to serve as a starting point for the author and reviewer, although it may not be appropriate for all types of changes (e.g. fixing a spelling typo in documentation). For more in-depth discussion of how we think about code review, please see Code Review Guidelines.

Author

  • Self-review: Did you review your own code in GitHub's web interface? Code often looks different when reviewing the diff in a browser, making it easier to spot potential bugs.
  • Does the code abide by the Coding Guidelines?
  • Automated tests: Did you add appropriate automated tests for any code changes?
  • Code coverage: Did you check the code coverage report for the automated tests? While we are not looking for perfect coverage, the tool can point out potential cases that have been missed.
  • Documentation: Did you update Docs as appropiate? (E.g README.md, etc.)
  • Run the app: Did you run the app and try the changes?
  • Did you provide Screenshots of what the App looks like before and after your changes as part of the description of this PR? (only applicable to UI Changes)
  • Rebase and squash: Did you pull in the latest changes from the main branch and squash your commits before assigning a reviewer? Having your code up to date and squashed will make it easier for others to review. Use best judgement when squashing commits, as some changes (such as refactoring) might be easier to review as a separate commit.

Reviewer

  • Checklist review: Did you go through the code with the Code Review Guidelines checklist?
  • Ad hoc review: Did you perform an ad hoc review? In addition to a first pass using the code review guidelines, do a second pass using your best judgement and experience which may identify additional questions or comments. Research shows that code review is most effective when done in multiple passes, where reviewers look for different things through each pass.
  • Automated tests: Did you review the automated tests?
  • Manual tests: Did you review the manual tests?You will find manual testing guidelines under our manual testing section
  • How is Code Coverage affected by this PR? We encourage you to compare coverage before and after your changes and when possible, leave it in a better place. Learn More...
  • Documentation: Did you review Docs, README.md, LICENSE.md, and Architecture.md as appropriate?
  • Run the app: Did you run the app and try the changes? While the CI server runs the app to look for build failures or crashes, humans running the app are more likely to notice unexpected log messages, UI inconsistencies, or bad output data.

Copy link
Collaborator Author

@tw0po1nt tw0po1nt left a comment

Choose a reason for hiding this comment

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

Self-review completed

Copy link
Collaborator Author

@tw0po1nt tw0po1nt left a comment

Choose a reason for hiding this comment

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

Self-reviewed latest changes

Copy link
Collaborator

@pacu pacu left a comment

Choose a reason for hiding this comment

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

Left some comments

public var isValidMnemonic = false
public var wordsCount = 0
public var isValidNumberOfWords = false
public var maxWordsCount = 0
public var isValidForm: Bool {
isValidMnemonic &&
(birthdayHeight.data.isEmpty ||
(!birthdayHeight.data.isEmpty && birthdayHeightValue != nil))
(birthdayHeight.isEmpty ||
Copy link
Collaborator

Choose a reason for hiding this comment

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

Consider adding a test for this that serves as documentation and red flag if a change break the expectations, since these kind of statements are really good vectors for form validation bugs in prod.

// validate the seed
try mnemonic.isValid(state.importedSeedPhrase.data)
let cleanedPhrase = trimmedPhraseWords.joined(separator: " ")
try mnemonic.isValid(cleanedPhrase)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why is the cleaning and validation performed again, is there a way of continuing when the form is invalid?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This logic was adjusted to make entering seed phrase a bit more forgiving, particularly around whitespace errors. Previously, if a user entered any extra whitespace between words, this would be considered an error and result in validation failing. This seemed extreme for an issue that could reasonably be compensated for by removing extra whitespace. If this is a security concern, I can revert it. Just seemed like a simple UX enhancement to make.

func validateMnemonic() -> NighthawkTextEditor.ValidationState {
self.isValidMnemonic ? .valid : .invalid(error: L10n.Nighthawk.ImportWallet.invalidMnemonic)
}

func validateBirthday() -> NighthawkTextFieldValidationState {
(self.birthdayHeight.data.isEmpty ||
(!self.birthdayHeight.data.isEmpty && self.birthdayHeightValue != nil))
(self.birthdayHeight.isEmpty ||
Copy link
Collaborator

Choose a reason for hiding this comment

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

Consider adding tests that track changes in the code that break the expectations of these validations. It will help avoiding form errors and time of manual testing

Copy link
Collaborator Author

@tw0po1nt tw0po1nt Sep 29, 2023

Choose a reason for hiding this comment

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

Yes, automated testing is on my to-do list. I will start revamping the test suite in coming PRs

public var isValidMnemonic = false
public var wordsCount = 0
public var isValidNumberOfWords = false
public var maxWordsCount = 0
public var isValidForm: Bool {
isValidMnemonic &&
(birthdayHeight.data.isEmpty ||
(!birthdayHeight.data.isEmpty && birthdayHeightValue != nil))
(birthdayHeight.isEmpty ||
Copy link
Collaborator

Choose a reason for hiding this comment

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

This validation is duplicated on a function below. Also it doesn't seem to actually validate that the data contains a valid string that can be converted to BlockHeight

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If birthdayHeightValue in non-nil, it means we were able to construct a BlockHeight from the string value, so yes, in an indirect sort of way, it is validating that, but I will say that it is not particularly clearly expressed by this implementation, so I think per your other comment, I will make the BlockHeight property a computed property.

As to the duplication, this particular computed property indicates whether the entire form is valid. The other one is validation a single field and is used by the view to show an error state for that one field should it be invalid.

state.birthdayHeight = redactedBirthday

if let birthdayHeight = BlockHeight(state.birthdayHeight.data), birthdayHeight >= saplingActivation {
if let birthdayHeight = BlockHeight(state.birthdayHeight), birthdayHeight >= saplingActivation {
Copy link
Collaborator

Choose a reason for hiding this comment

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

This make me think that it's possible that you want birthdayHeightValue to be a computed property based on state.birthdayHeight.data instead

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, that might make more sense.

nighthawk24
nighthawk24 previously approved these changes Sep 30, 2023
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.

None yet

3 participants