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

QR code image logic refactoring #1732

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

HonzaR
Copy link
Collaborator

@HonzaR HonzaR commented Jan 15, 2025

  • The QR code image logic of the QrCode and Request screens has been refactored to work upon the newer ZashiQr component
  • This is a prerequisite for Allow QR codes colors switching Allow QR codes colors switching #1731
  • Changelog updated

Note
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 your own code in GitHub's web interface1
  • Add automated tests as appropriate
  • Update the manual tests2 as appropriate
  • Check the code coverage3 report for the automated tests
  • Update documentation as appropriate (e.g README.md, Architecture.md, CHANGELOG.md, etc.)
  • Run the app and try the changes
  • Pull in the latest changes from the main branch and squash your commits before assigning a reviewer4

Note
It is good practice to provide before and after UI screenshots in the description of this PR. This is only applicable for changes that modify the UI.

Reviewer

  • Check the code with the Code Review Guidelines checklist
  • Perform an ad hoc review5
  • Review the automated tests
  • Review the manual tests
  • Review the documentation, README.md, Architecture.md, etc. as appropriate
  • Run the app and try the changes6

Footnotes

  1. Code often looks different when reviewing the diff in a browser, making it easier to spot potential bugs.

  2. While we aim for automated testing of the application, some aspects require manual testing. If you had to manually test something during development of this pull request, write those steps down.

  3. While we are not looking for perfect coverage, the tool can point out potential cases that have been missed. Code coverage can be generated with: ./gradlew check for Kotlin modules and ./gradlew connectedCheck -PIS_ANDROID_INSTRUMENTATION_TEST_COVERAGE_ENABLED=true for Android modules.

  4. 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.

  5. 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.

  6. 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. Perform this step last, after verifying the code changes are safe to run locally.

@HonzaR HonzaR requested a review from Milan-Cerovsky January 15, 2025 15:39
The QR code image logic of the `QrCode` and `Request` screens has been refactored to work upon the newer `ZashiQr` component
@HonzaR HonzaR force-pushed the qr-code-logic-refactor branch from 86b2195 to 125302d Compare January 15, 2025 15:45
@@ -3,14 +3,15 @@ package co.electriccoin.zcash.ui.screen.qrcode.model
import androidx.compose.ui.graphics.ImageBitmap
import cash.z.ecc.android.sdk.model.WalletAddress

internal sealed class QrCodeState {
sealed class QrCodeState {
data object Loading : QrCodeState()

data class Prepared(
val qrCodeType: QrCodeType,
val walletAddress: WalletAddress,
val onAddressCopy: (String) -> Unit,
Copy link
Contributor

Choose a reason for hiding this comment

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

possibly we do not need to add String resource to val onAddressCopy: (String) -> Unit

Copy link
Contributor

Choose a reason for hiding this comment

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

also possibly we can leverage the shared QrState here:

data class Prepared(
   val qrCodeType: QrCodeType,
   val walletAddress: WalletAddress,
   val onBack: () -> Unit,
   val qrState: QrState
)

@@ -26,7 +30,10 @@ fun ZashiQr(
qrData: String,
modifier: Modifier = Modifier,
qrSize: Dp = ZashiQrDefaults.width,
colors: QrCodeColors = QrCodeDefaults.colors()
colors: QrCodeColors = QrCodeDefaults.colors(),
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to embed variables into a state. Maybe:

data class QrState(
 val qrData: String,
 val contentDescription: StringResource,
 val onClick: () -> Unit,
@DrawableResource val centerImage: Int // do not use Painter here
)

Copy link
Contributor

Choose a reason for hiding this comment

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

we would end up with 2 overloads of the function for simplicity

fun ZashiQr(
    qrData: String,
    modifier: Modifier = Modifier,
    qrSize: Dp = ZashiQrDefaults.width,
    colors: QrCodeColors = QrCodeDefaults.colors(),
    contentDescription: StringResource? = null,
    onClick: () -> Unit = {},
    @DrawableRes centerImage: Int? = null 
) = ZashiQr(
   modifier = modifier,
   qrSize = qrSize,
   colors = colors,
   state = QrState(
       qrData = qrData,
       contentDescription = contentDescription,
       onClick = onClick,
       centerImage = centerImage,
   )
)

and

fun ZashiQr(
    state: QrState,
    modifier: Modifier = Modifier,
    qrSize: Dp = ZashiQrDefaults.width,
    colors: QrCodeColors = QrCodeDefaults.colors(),

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