robojackets / apiary-mobile Goto Github PK

Read the first 9 digits and take those as the GTID without validating the entire format, as newer Buzzcards won't have the proxID in them

Only allow credit card transactions

I've found myself telling people this anyways so may as well put it as in-app education:

• Align the center of the BuzzCard over the NFC on your phone. If you don't know where the NFC sensor is, search " nfc sensor location" using your preferred search enginer
• You'll probably have to fiddle a little bit to find the best spot
• If you have a particularly thick case or your phone isn't recognizing BuzzCards (usually it should vibrate) at all, try removing your case
• Sometimes someone forgets their BuzzCard or one just won't scan. You can use the Enter GTID manually button and type in their GTID to take their attendance.

Figma mockups

Event/team selection

Before showing the BuzzCard scanning UI, fetch the team list and list of events happening today. Users can toggle between seeing events or visible and attendable (the same list the kiosk shows) teams, with teams being the default. After selecting a team or event, the UI transitions to the BuzzCard scanning mode.

BuzzCard scanning

This screen consists of:

• The result of the last tap (user's name, succcess/failure)
• A status area to indicate when to scan the next BuzzCard. Possible states include:
  • Enable NFC to continue
  • Ready to scan
  • Sending data...
  • Error preventing scan (e.g., NFC error, no connection, etc.)
• Count of total swipes, for fun
• The currently selected team/event and a way to go back and change it

Nice to haves to round out the experience:

• Flash a message if a BuzzCard is tapped while a swipe is already being processed
• Play a sound on success or error

Add notifications to nag and/or force users to update to the latest version of the app. The priority of each release can be set during our CI process.

My proposed update forcing strategy is below. The intent is to limit the number of older releases we have to maintain compatibility with, so this is intentionally aggressive.

• If the app update priority is 5, it has to be installed immediately
• If the app update priority is 4, and the update staleness (days since update was released) is <=1 day, show an optional update prompt. If the update staleness is at least 1 day, immediately install the update.
• If the update priority is 3 and the update staleness is at least 4 days, show an optional update prompt.
• If the update staleness is at least 14 days regardless of priority, show an optional prompt.
• If the update staleness is at least 21 days regardless of priority, immediately install the update.

App update priorities, inspired by Google's suggestions:

• Minor UI improvements: Low-priority update; request neither an optional update nor an immediate update. Update only when the user isn't interacting with your app.
• Performance improvements: Medium-priority update; request an optional update.
• Critical security update: High-priority update; request an immediate update.

• Be sure to update our data collection info on the Play Console after merging this feature: https://developer.android.com/guide/playcore/in-app-updates#in-app_updates

It's set sometimes... but not always, leading to some funky combinations

The Taplinx library crashes if you do anything and NFC is disabled (smh), make it not do that

• Add a section for additional data we collect if you use the mobile app (user agent, Sentry, etc.)
• Clarify that any user may contact us to request deletion of their data

This is definitely not necessary by any means but it would pair nicely with our update prompts.

If the app reads a plastic BuzzCard with both a GTID and access number encoded, provide both values to the attendance API

Server-side support is part of RoboJackets/apiary#4594

Storing in SharedPreferences is not insecure (on non-rooted devices) but it would be better if we used EncryptedSharedPreferences.

https://developer.android.com/topic/security/data#edit-shared-preferences

Currently, the oldest events show first, which is counterintuitive. Also, maybe we should emphasize any events happening on the same day and perhaps even show a (dismissable) warning when taking attendance for an event that's not today

https://issuetracker.google.com/issues/194289155 fixed the bug that was blocking this before, although the Compose Settings library might make the minSdkVersion 23 because the developer of that library just kinda picked that and last I checked, they hadn't reduced it (we could fork it or PR the library, however)

To include:

• Login splash screen
• Handling OAuth2 login process
• Navigating to attendance screen on successful login

Create a general purpose class that can be used to process an NFC data intent for a BuzzCard.

Example implementation from @RossIV

MIFARE TapLinx Android SDK
TapLinx SDK guide

Custom colors not necessary, but it would be nice to be on Material 3 components wherever possible

Seems related to device rotation

Sentry Issue: APIARY-ANDROID-8

IllegalStateException: Service has been disposed and rendered inoperable
    at org.robojackets.apiary.auth.network.AuthHeaderInterceptor$intercept$1.invokeSuspend(AuthHeaderInterceptor.kt:20)
    at org.robojackets.apiary.auth.network.AuthHeaderInterceptor.intercept(AuthHeaderInterceptor.kt:18)
    at org.robojackets.apiary.network.UserAgentInterceptor.intercept(UserAgentInterceptor.kt:45)
...
(17 additional frame(s) were not displayed)

See #6 (comment)

This is mainly to avoid mishaps like recording real attendance in test

Currently, we have multiple modules with dependency versions defined individually in each one. This makes updating dependency versions or adding new dependencies more time consuming and error prone.

This Medium article seems like a good reference.

See also https://github.com/phansier/Clean-multimodel-arch

Sentry isn't catching this, but:

1. Login
2. Record an attendance record by any method
3. Logout

and the app crashes

It's definitely not supposed to be doing this, but apparently something changed and we need to make it not do that (again)

Sentry Issue: APIARY-ANDROID-M

[ApiResponse.Failure.Error-Forbidden](errorResponse=Response{protocol=h2, code=403, message=, url=https://my.robojackets.org/api/v1/attendance?include=attendee})

Sentry Issue: APIARY-ANDROID-1C

RuntimeException: <html>
<head>
  <title>Maintenance in progress</title>
</head>
<body style="font-family: sans-serif;margin:2em">
  <h1>Maintenance in progress</h1>
  <p>MyRoboJackets is currently unavailable due to scheduled maintenance. Please try again in a few hours.</p>
</body>
</html>

    at org.robojackets.apiary.ui.settings.SettingsViewModel$getUser$1.invokeSuspend(SettingsViewModel.kt:122)
...
(8 additional frame(s) were not displayed)

User info API error

Feature work:

• Authentication
  • #21
• Attendance
  • #4
  • #6
• #18

Apiary issues:

• RoboJackets/apiary#1881
• #28

Play Store work:

• #35
• #36

• Make PR build notifications less spammy
• Integrate with Sentry releases
• Consider using deployments for PR build links
• Add automated release notes and automatically release to internal test
• Do not build tagged releases unless they are on main

Required by August 31, 2023

We don't use the prox ID including in BuzzCards but enforce the format of it. It would be better to only check the GTID component of the BuzzCard contents.

Needs to include:

• App version info
• Log out button
• Basic info about logged in user
• top secret fun easter egg

Crashlytics and Sentry Android are both seemingly good options, worth doing more research to decide

Allow merchandise distribution via the app. See Figma for full spec.

The initial implementation should encompass:

• Support for "rapid-fire" mode - pick one merch item, then tap BuzzCards to record distribution or error if already picked up
  • From prototyping on Figma, we decided on a two-stage mode for this. Tap, a dialog with more details (e.g., size) appears, then confirm

The API routes need to be added in Apiary; see RoboJackets/apiary#3072

Sentry Issue: APIARY-ANDROID-T

NoSuchElementException: List contains no element matching the predicate.
    at androidx.navigation.compose.NavHostKt$NavHost$4.invoke(NavHost.kt:181)
    at androidx.navigation.compose.NavHostKt$NavHost$4.invoke(NavHost.kt:141)
    at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:116)
    at androidx.compose.runtime.internal.ComposableLambdaImpl$invoke$1.invoke(ComposableLambda.jvm.kt:127)
    at androidx.compose.runtime.internal.ComposableLambdaImpl$invoke$1.invoke(ComposableLambda.jvm.kt:127)
...
(38 additional frame(s) were not displayed)

Sentry Issue: APIARY-ANDROID-13

IllegalStateException: Restore State failed: destination 2081899864 cannot be found from the current destination Destination(0x98d0beb0) route=settings
    at org.robojackets.apiary.MainActivity.AppNavigation(MainActivity.kt:246)
    at org.robojackets.apiary.MainActivity.access$AppNavigation(MainActivity.kt:81)
    at org.robojackets.apiary.MainActivity$onCreate$1$1$2$1$4$3$1$1.invoke(MainActivity.kt:214)
    at org.robojackets.apiary.MainActivity$onCreate$1$1$2$1$4$3$1$1.invoke(MainActivity.kt:213)
    at org.robojackets.apiary.base.ui.nfc.NfcRequiredKt.NfcRequired(NfcRequired.kt:58)
...
(48 additional frame(s) were not displayed)

Otherwise it just looks like it's version 1.0.0 of the app because of how the versioning process works

This is a new Android-endorsed way for managing dependency versions across modules: https://developer.android.com/build/migrate-to-catalogs

Make a Wish has been removed from the web UI and should be removed from the Android app for consistency.

If the client ID ever changes in production, this would allow the problem to be resolvable without an app update. It would also allow adding a custom environment without rebuilding the app.