-
Notifications
You must be signed in to change notification settings - Fork 181
feat: improve mixpanel flush strategy #960
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
feat: improve mixpanel flush strategy #960
Conversation
WalkthroughAdds a Mixpanel-like NFC analytics integration with queuing and connectivity-aware flushing, extends PassportReader typings and platform/web mocks, wires NFC analytics and flushes across NFC screens, proving flows, ErrorBoundary, and the NFC scanner utility; also adjusts Segment flush policies and build scripts. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor User
participant Screen as PassportNFCScanScreen
participant NFC as nfcScanner
participant PR as PassportReader (NativeModule)
participant Net as NetInfo
participant App as AppState
participant A as Analytics
User->>Screen: Start scan
Screen->>NFC: scan(inputs)
NFC->>NFC: configureNfcAnalytics()
NFC->>PR: configure(token, enableDebug?, flushPolicies?)
Note right of NFC: subscribe AppState / NetInfo for flush triggers
NFC->>PR: scan(...) or NativeModules.PassportReader.scanDocument(...)
PR-->>NFC: result / error
alt success
NFC->>NFC: trackNfcEvent("NFC_SCAN_SUCCESS", props)
NFC->>PR: flush() (conditional)
NFC-->>Screen: result
else error
NFC->>NFC: trackNfcEvent("NFC_SCAN_FAILED", sanitizedError)
Screen->>A: trackEvent(...)
Screen->>NFC: flushAllAnalytics()
NFC-->>Screen: propagate error
end
App-->>NFC: foreground/background
Net-->>NFC: connectivity change
NFC->>PR: flush() (on triggers)
sequenceDiagram
autonumber
participant UI as ErrorBoundary
participant NFC as analytics (trackNfcEvent)
participant A as Segment (analytics)
participant S as Sentry
UI->>UI: componentDidCatch(error, info)
UI->>NFC: trackNfcEvent("error_boundary", {message, stack})
UI->>NFC: flushAllAnalytics()
UI->>A: flushAllAnalytics()
UI->>S: captureException(error, {componentStack, errorBoundary: true})
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 8
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
app/src/screens/passport/PassportNFCScanScreen.tsx (1)
66-69: Android event emitter is bound to an unknown module; switch to RNPassportReaderConstructing NativeEventEmitter with NativeModules.nativeModule likely no-ops on Android, so you won't receive progress events. Bind to RNPassportReader (the Android module name) when available.
Use this initialization instead (outside the changed hunk, shown for clarity):
const passportReaderModule = Platform.OS === 'android' ? (NativeModules.RNPassportReader ?? null) : null; const emitter = Platform.OS === 'android' && passportReaderModule ? new NativeEventEmitter(passportReaderModule) : null;This aligns with the Android module name used by react-native-passport-reader and ensures events are actually received.
🧹 Nitpick comments (4)
app/src/screens/passport/PassportNFCScanScreen.tsx (1)
145-149: Flush placement looks good; consider guarding flushes to avoid redundant calls under rapid retriesMultiple paths flush both analytics streams in quick succession (timeout, parse errors, navigation to settings, cancel). That’s fine, but on flaky networks this can stack up. If you see overhead, consider rate-limiting flushMixpanelEvents and analytics().flush() with a 500–1000ms debounce.
If needed, introduce a module-level debouncedFlush helper and replace direct calls:
let lastFlushAt = 0; const maybeFlush = () => { const now = Date.now(); if (now - lastFlushAt > 800) { lastFlushAt = now; flushAnalytics(); flushMixpanelEvents(); } };Also applies to: 218-221, 264-272, 336-344, 378-380, 406-408
app/src/utils/nfcScanner.ts (3)
74-91: Long-lived listeners: safe to keep, but guard against duplicate registration across hot reloadssetupFlushPolicies() guards with flushTimer but doesn’t store and re-use the AppState/NetInfo subscriptions. In practice that’s fine (it runs once), but if code moves in future, consider storing unsubscribers to prevent duplicated listeners on HMR.
No change required now; flagging for future-proofing.
92-110: Event queue drain on flush is good; consider draining in bounded chunksIf the queue spikes (e.g., offline for long periods), draining in one while-loop could backlog the JS thread. Consider yielding between batches or capping per-flush batch size (e.g., 100) for responsiveness.
Example:
const MAX_PER_FLUSH = 100; for (let i = 0; i < MAX_PER_FLUSH && eventQueue.length > 0; i++) { const evt = eventQueue.shift()!; Reader?.trackEvent?.(evt.name, evt.properties); } Reader?.flush?.();
151-172: Offline queuing looks correct; add a lightweight cap to prevent unbounded growthOn prolonged offline sessions, eventQueue can grow unbounded. Consider a soft cap with drop-oldest behavior to protect memory.
Example:
const MAX_QUEUE = 1000; if (!isConnected) { if (eventQueue.length >= MAX_QUEUE) eventQueue.shift(); eventQueue.push({ name, properties }); return; }
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (8)
app/jest.setup.js(2 hunks)app/src/components/ErrorBoundary.tsx(2 hunks)app/src/screens/passport/PassportNFCScanScreen.tsx(10 hunks)app/src/screens/passport/PassportNFCTroubleScreen.tsx(2 hunks)app/src/screens/prove/ConfirmBelongingScreen.tsx(3 hunks)app/src/screens/prove/QRCodeTroubleScreen.tsx(2 hunks)app/src/types/react-native-passport-reader.d.ts(1 hunks)app/src/utils/nfcScanner.ts(3 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/technical-specification.mdc)
**/*.{ts,tsx}: Define IdentityCommitment with fields: commitment (Poseidon hash), nullifier (domain-separated), timestamp (UTC number), version (circuit version), documentType ('passport' | 'eu_id_card')
Define DSCKeyCommitment with fields: publicKeyHash (Poseidon hash), certificateChain (hashes), revocationStatus (boolean), issuer (country code)
Define VerificationConfig with fields: circuitVersion (semver), complianceRules array, timeWindow (seconds, 24h), clockDrift (±5 min), trustAnchors, revocationRoots, timeSource (NTP), nullifierScope (domain separation)
Files:
app/src/screens/prove/QRCodeTroubleScreen.tsxapp/src/components/ErrorBoundary.tsxapp/src/screens/prove/ConfirmBelongingScreen.tsxapp/src/screens/passport/PassportNFCTroubleScreen.tsxapp/src/types/react-native-passport-reader.d.tsapp/src/screens/passport/PassportNFCScanScreen.tsxapp/src/utils/nfcScanner.ts
app/src/**/*.{ts,tsx,js,jsx}
⚙️ CodeRabbit configuration file
app/src/**/*.{ts,tsx,js,jsx}: Review React Native TypeScript code for:
- Component architecture and reusability
- State management patterns
- Performance optimizations
- TypeScript type safety
- React hooks usage and dependencies
- Navigation patterns
Files:
app/src/screens/prove/QRCodeTroubleScreen.tsxapp/src/components/ErrorBoundary.tsxapp/src/screens/prove/ConfirmBelongingScreen.tsxapp/src/screens/passport/PassportNFCTroubleScreen.tsxapp/src/types/react-native-passport-reader.d.tsapp/src/screens/passport/PassportNFCScanScreen.tsxapp/src/utils/nfcScanner.ts
app/jest.setup.js
📄 CodeRabbit inference engine (.cursor/rules/mobile-sdk-migration.mdc)
Provide comprehensive Jest setup in app/jest.setup.js with required mocks
Files:
app/jest.setup.js
🧠 Learnings (8)
📚 Learning: 2025-08-24T18:52:25.765Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.765Z
Learning: Applies to src/**/*.{tsx} : Implement comprehensive error boundaries in React components
Applied to files:
app/src/components/ErrorBoundary.tsx
📚 Learning: 2025-08-25T14:25:57.541Z
Learnt from: aaronmgdr
PR: selfxyz/self#951
File: app/src/providers/authProvider.web.tsx:17-18
Timestamp: 2025-08-25T14:25:57.541Z
Learning: The selfxyz/mobile-sdk-alpha/constants/analytics import path is properly configured with SDK exports, Metro aliases, and TypeScript resolution. Import changes from @/consts/analytics to this path are part of valid analytics migration, not TypeScript resolution issues.
Applied to files:
app/src/screens/prove/ConfirmBelongingScreen.tsxapp/src/utils/nfcScanner.ts
📚 Learning: 2025-08-24T18:52:25.766Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.766Z
Learning: Use custom hooks for complex state (useModal, useHapticNavigation)
Applied to files:
app/src/screens/prove/ConfirmBelongingScreen.tsx
📚 Learning: 2025-08-24T18:54:04.799Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursor/rules/mobile-sdk-migration.mdc:0-0
Timestamp: 2025-08-24T18:54:04.799Z
Learning: Applies to app/jest.setup.js : Provide comprehensive Jest setup in app/jest.setup.js with required mocks
Applied to files:
app/jest.setup.js
📚 Learning: 2025-08-24T18:52:25.765Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.765Z
Learning: Applies to jest.setup.js : Maintain comprehensive mocks in jest.setup.js for all native modules
Applied to files:
app/jest.setup.js
📚 Learning: 2025-08-24T18:54:04.799Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursor/rules/mobile-sdk-migration.mdc:0-0
Timestamp: 2025-08-24T18:54:04.799Z
Learning: Applies to app/jest.config.cjs : Use Jest in the app with a React Native preset configured in app/jest.config.cjs
Applied to files:
app/jest.setup.js
📚 Learning: 2025-08-24T18:52:25.765Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.765Z
Learning: Applies to native/ios/**/*.{swift} : iOS NFC: implement custom PassportReader as a Swift module
Applied to files:
app/jest.setup.jsapp/src/utils/nfcScanner.ts
📚 Learning: 2025-08-24T18:52:25.765Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.765Z
Learning: Applies to native/android/**/*.{kt,kts} : Android NFC: implement RNPassportReaderModule in Kotlin
Applied to files:
app/src/utils/nfcScanner.ts
🧬 Code graph analysis (7)
app/src/screens/prove/QRCodeTroubleScreen.tsx (1)
app/src/utils/nfcScanner.ts (1)
flushMixpanelEvents(92-110)
app/src/components/ErrorBoundary.tsx (1)
app/src/utils/nfcScanner.ts (2)
trackNfcEvent(151-172)flushMixpanelEvents(92-110)
app/src/screens/prove/ConfirmBelongingScreen.tsx (2)
app/src/utils/nfcScanner.ts (2)
trackNfcEvent(151-172)flushMixpanelEvents(92-110)packages/mobile-sdk-alpha/src/constants/analytics.ts (1)
ProofEvents(105-163)
app/src/screens/passport/PassportNFCTroubleScreen.tsx (1)
app/src/utils/nfcScanner.ts (1)
flushMixpanelEvents(92-110)
app/src/screens/passport/PassportNFCScanScreen.tsx (3)
app/src/utils/nfcScanner.ts (2)
flushMixpanelEvents(92-110)trackNfcEvent(151-172)packages/mobile-sdk-alpha/src/constants/analytics.ts (1)
PassportEvents(83-103)app/src/utils/utils.ts (1)
sanitizeErrorMessage(23-31)
app/jest.setup.js (2)
app/android/react-native-passport-reader/index.android.js (1)
NativeModules(5-5)app/ios/PassportReader.swift (2)
iOS(32-364)scanPassport(78-239)
app/src/utils/nfcScanner.ts (5)
app/env.ts (2)
MIXPANEL_NFC_PROJECT_TOKEN(28-28)ENABLE_DEBUG_LOGS(11-11)app/tests/__setup__/@env.js (4)
MIXPANEL_NFC_PROJECT_TOKEN(18-18)MIXPANEL_NFC_PROJECT_TOKEN(18-18)ENABLE_DEBUG_LOGS(11-11)ENABLE_DEBUG_LOGS(11-11)app/android/react-native-passport-reader/index.android.js (1)
NativeModules(5-5)app/android/react-native-passport-reader/android/src/main/java/io/tradle/nfc/RNPassportReaderModule.kt (1)
scan(198-232)app/src/screens/MainScreen.tsx (2)
Platform(106-115)event(128-130)
🪛 GitHub Actions: Web CI
app/src/utils/nfcScanner.ts
[error] 13-13: "default" is not exported by "../node_modules/react-native-passport-reader/index.android.js", imported by "app/src/utils/nfcScanner.ts".
🪛 GitHub Actions: Mobile CI
app/src/utils/nfcScanner.ts
[error] 13-13: 'default' is not exported by '../node_modules/react-native-passport-reader/index.android.js', imported by 'src/utils/nfcScanner.ts'.
🔇 Additional comments (6)
app/jest.setup.js (1)
11-14: Env mocks: OKProvides deterministic values for tests including Mixpanel token. No issues.
app/src/screens/prove/QRCodeTroubleScreen.tsx (1)
14-14: Good call: flush NFC analytics when landing on the trouble screenTriggering
flushMixpanelEvents()alongside Segment’s flush ensures error-path telemetry is not stranded. Safe guard exists in the util to no-op without token.Also applies to: 55-55
app/src/screens/passport/PassportNFCTroubleScreen.tsx (1)
19-19: Consistent flushing on NFC trouble: looks solidMirrors the QR code trouble screen to ensure Mixpanel and Segment are drained on error context transitions.
Also applies to: 60-60
app/src/screens/prove/ConfirmBelongingScreen.tsx (1)
56-58: Dual-stream tracking on permission request is appropriateLogging to both Segment and Mixpanel NFC streams on a critical UX action is aligned with the PR goal.
app/src/utils/nfcScanner.ts (2)
118-124: configureNfcAnalytics on every scan is fine; ensure it’s idempotent across app lifetimeThe internal guard prevents repetition; this is acceptable and keeps call sites simple.
5-12: Type-only import nit: keep AppStateStatus as type to avoid potential side-effects in toolingYou already used
typefor AppStateStatus—good. No changes needed.
| jest.mock('react-native-passport-reader', () => ({ | ||
| default: { | ||
| initialize: jest.fn(), | ||
| configure: jest.fn(), | ||
| scanPassport: jest.fn(), | ||
| readPassport: jest.fn(), | ||
| cancelPassportRead: jest.fn(), | ||
| trackEvent: jest.fn(), | ||
| flush: jest.fn(), | ||
| reset: jest.fn(), | ||
| }, | ||
| })); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
Mock parity with types: add scan alias to match d.ts and potential callsites
The default export for react-native-passport-reader only exposes scanPassport, while the d.ts (and likely some callsites) reference scan. This will cause test failures or undefined calls in environments that import the default module instead of NativeModules.
Apply this diff to add a scan alias:
jest.mock('react-native-passport-reader', () => ({
default: {
configure: jest.fn(),
- scanPassport: jest.fn(),
+ scanPassport: jest.fn(),
+ // Alias to align with TS types/callsites
+ scan: jest.fn(),
readPassport: jest.fn(),
cancelPassportRead: jest.fn(),
trackEvent: jest.fn(),
flush: jest.fn(),
reset: jest.fn(),
},
}));Run to spot any lingering scanPassport( vs scan( mismatches:
🏁 Script executed:
#!/bin/bash
rg -nP -C2 --type=ts --type=tsx '\bPassportReader\b.*\bscan(Passport)?\s*\('
rg -nP -C2 --type=ts --type=tsx '\bNativeModules\.PassportReader\b.*\bscan(Passport)?\s*\('Length of output: 228
🏁 Script executed:
#!/bin/bash
# Search for both scanPassport and scan callsites across TS/TSX/JS/JSX files
rg -nP -C2 '\bPassportReader\b.*\bscan(?:Passport)?\s*\(' -g '*.ts' -g '*.tsx' -g '*.js' -g '*.jsx'
rg -nP -C2 '\bNativeModules\.PassportReader\b.*\bscan(?:Passport)?\s*\(' -g '*.ts' -g '*.tsx' -g '*.js' -g '*.jsx'Length of output: 1200
Add scan alias to the PassportReader mock to cover Android callsites
Your Android scanner helper calls PassportReader.scan(…) (app/src/utils/nfcScanner.ts line 128), but your Jest setup only mocks scanPassport. Without a scan mock, tests hitting scanAndroid will fail with undefined is not a function.
Apply this diff in app/jest.setup.js (around lines 203–213):
jest.mock('react-native-passport-reader', () => ({
default: {
configure: jest.fn(),
scanPassport: jest.fn(),
+ // Alias to align with TS types/callsites (e.g. scanAndroid)
+ scan: jest.fn(),
readPassport: jest.fn(),
cancelPassportRead: jest.fn(),
trackEvent: jest.fn(),
flush: jest.fn(),
reset: jest.fn(),
},
}));— without this, any PassportReader.scan(...) calls will be unmocked and break your Android tests.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| jest.mock('react-native-passport-reader', () => ({ | |
| default: { | |
| initialize: jest.fn(), | |
| configure: jest.fn(), | |
| scanPassport: jest.fn(), | |
| readPassport: jest.fn(), | |
| cancelPassportRead: jest.fn(), | |
| trackEvent: jest.fn(), | |
| flush: jest.fn(), | |
| reset: jest.fn(), | |
| }, | |
| })); | |
| jest.mock('react-native-passport-reader', () => ({ | |
| default: { | |
| configure: jest.fn(), | |
| scanPassport: jest.fn(), | |
| // Alias to align with TS types/callsites (e.g. scanAndroid) | |
| scan: jest.fn(), | |
| readPassport: jest.fn(), | |
| cancelPassportRead: jest.fn(), | |
| trackEvent: jest.fn(), | |
| flush: jest.fn(), | |
| reset: jest.fn(), | |
| }, | |
| })); |
🤖 Prompt for AI Agents
In app/jest.setup.js around lines 203 to 213, the PassportReader mock only
provides scanPassport/readPassport/etc. but not the Android alias scan, so tests
calling PassportReader.scan(...) will fail; update the mock to add a scan
property that points to the same jest.fn() used by scanPassport (i.e., add scan:
jest.fn() or set scan: mock.scanPassport) so PassportReader.scan(...) is defined
and uses the existing mock behavior.
| const { NativeModules } = require('react-native'); | ||
|
|
||
| NativeModules.PassportReader = { | ||
| configure: jest.fn(), | ||
| scanPassport: jest.fn(), | ||
| trackEvent: jest.fn(), | ||
| flush: jest.fn(), | ||
| }; | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Keep NativeModules mock consistent and complete
NativeModules.PassportReader mirrors only some methods. To avoid drift between the default export and NativeModules, provide a scan alias here too (and, ideally, share the same jest.fn where practical).
Apply this diff:
const { NativeModules } = require('react-native');
NativeModules.PassportReader = {
configure: jest.fn(),
- scanPassport: jest.fn(),
+ scanPassport: jest.fn(),
+ // Alias for parity with d.ts and default export
+ scan: jest.fn(),
trackEvent: jest.fn(),
flush: jest.fn(),
};📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const { NativeModules } = require('react-native'); | |
| NativeModules.PassportReader = { | |
| configure: jest.fn(), | |
| scanPassport: jest.fn(), | |
| trackEvent: jest.fn(), | |
| flush: jest.fn(), | |
| }; | |
| const { NativeModules } = require('react-native'); | |
| NativeModules.PassportReader = { | |
| configure: jest.fn(), | |
| scanPassport: jest.fn(), | |
| // Alias for parity with d.ts and default export | |
| scan: jest.fn(), | |
| trackEvent: jest.fn(), | |
| flush: jest.fn(), | |
| }; |
🤖 Prompt for AI Agents
In app/jest.setup.js around lines 215 to 223, NativeModules.PassportReader
defines configure, scanPassport, trackEvent, and flush but is missing the scan
alias; update the mock to include scan and make it reference the same jest.fn()
as scanPassport (i.e., create one jest.fn for the passport scan and assign it to
both scanPassport and scan) so the mock stays consistent and methods remain in
sync.
| jest.mock('@react-native-community/netinfo', () => ({ | ||
| addEventListener: jest.fn(() => jest.fn()), | ||
| fetch: jest.fn(() => Promise.resolve({ isConnected: true })), | ||
| })); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Duplicate NetInfo mock overrides earlier one (breaks useNetInfo/behavior)
This second jest.mock('@react-native-community/netinfo', ...) overrides the earlier mock (Lines 147–160), dropping useNetInfo and changing method shapes. That can cause test flakiness or crashes.
Apply this diff to remove the duplicate:
-jest.mock('@react-native-community/netinfo', () => ({
- addEventListener: jest.fn(() => jest.fn()),
- fetch: jest.fn(() => Promise.resolve({ isConnected: true })),
-}));Then, update the first NetInfo mock (Lines 147–160) to return an unsubscribe from addEventListener and a resolved value from fetch:
// In the first mock block (existing):
addEventListener: jest.fn(() => jest.fn()), // returns unsubscribe
fetch: jest.fn().mockResolvedValue({ isConnected: true, isInternetReachable: true }),If you want, I can push a combined single mock that covers useNetInfo, addEventListener, and fetch consistently.
🤖 Prompt for AI Agents
In app/jest.setup.js around lines 224–227 there is a duplicate
jest.mock('@react-native-community/netinfo') that overrides the earlier mock and
drops useNetInfo/changes method shapes; remove this second mock block and
instead update the first mock block (around lines 147–160) so addEventListener
returns an unsubscribe function (e.g., jest.fn(() => jest.fn())) and fetch is a
resolved promise (e.g., jest.fn().mockResolvedValue({ isConnected: true,
isInternetReachable: true })), ensuring the single mock covers useNetInfo,
addEventListener, and fetch consistently.
app/src/components/ErrorBoundary.tsx
Outdated
|
|
||
| import { captureException } from '@/Sentry'; | ||
| import analytics from '@/utils/analytics'; | ||
| import { flushMixpanelEvents, trackNfcEvent } from '@/utils/nfcScanner'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sanitize error payloads before sending to analytics to avoid PII leakage
Forwarding raw error.message and full component stack to Mixpanel can inadvertently leak PII or sensitive details. Please sanitize and truncate before tracking. Also safe-guard analytics calls to be no-throw in this path.
Apply this diff to sanitize and bound the payload:
componentDidCatch(error: Error, info: ErrorInfo) {
- trackNfcEvent('error_boundary', {
- message: error.message,
- stack: info.componentStack,
- });
+ try {
+ const safeMessage =
+ typeof error?.message === 'string' ? sanitizeErrorMessage(error.message) : 'unknown';
+ const safeStack =
+ typeof info?.componentStack === 'string'
+ ? info.componentStack.slice(0, 512)
+ : undefined;
+ trackNfcEvent('error_boundary', {
+ message: safeMessage,
+ stack: safeStack,
+ });
+ } catch {
+ // no-op: never let analytics crash the error boundary
+ }
flushMixpanelEvents();Add this import at the top of the file:
import { sanitizeErrorMessage } from '@/utils/utils';Also applies to: 34-39
🤖 Prompt for AI Agents
In app/src/components/ErrorBoundary.tsx around line 11 (and also for the
analytics call area at lines 34-39), add the import "import {
sanitizeErrorMessage } from '@/utils/utils';" then replace direct uses of
error.message and componentStack when calling track/flush Mixpanel functions
with sanitized, truncated versions (e.g. sanitizeErrorMessage(error.message) and
sanitizeErrorMessage(componentStack) or slice to a safe max length), and wrap
the entire analytics call block in a try/catch to ensure any errors in telemetry
do not propagate (log or swallow telemetry errors safely).
| const sanitized = sanitizeErrorMessage(message); | ||
| trackEvent(PassportEvents.NFC_SCAN_FAILED, { | ||
| error: sanitizeErrorMessage(message), | ||
| error: sanitized, | ||
| duration_seconds: parseFloat(scanDurationSeconds), | ||
| }); | ||
| trackNfcEvent(PassportEvents.NFC_SCAN_FAILED, { | ||
| error: sanitized, | ||
| duration_seconds: parseFloat(scanDurationSeconds), | ||
| }); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Use the sanitized message for the error modal to prevent accidental PII exposure
You're sanitizing the message for analytics but still passing the raw message to the user-facing modal. Surface the sanitized version there too to avoid exposing MRZ or other sensitive values.
Apply this change near the existing code:
- const message = e instanceof Error ? e.message : String(e);
- const sanitized = sanitizeErrorMessage(message);
+ const message = e instanceof Error ? e.message : String(e);
+ const sanitized = sanitizeErrorMessage(message);
...
- openErrorModal(message);
+ openErrorModal(sanitized);📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const sanitized = sanitizeErrorMessage(message); | |
| trackEvent(PassportEvents.NFC_SCAN_FAILED, { | |
| error: sanitizeErrorMessage(message), | |
| error: sanitized, | |
| duration_seconds: parseFloat(scanDurationSeconds), | |
| }); | |
| trackNfcEvent(PassportEvents.NFC_SCAN_FAILED, { | |
| error: sanitized, | |
| duration_seconds: parseFloat(scanDurationSeconds), | |
| }); | |
| const message = e instanceof Error ? e.message : String(e); | |
| const sanitized = sanitizeErrorMessage(message); | |
| trackEvent(PassportEvents.NFC_SCAN_FAILED, { | |
| error: sanitized, | |
| duration_seconds: parseFloat(scanDurationSeconds), | |
| }); | |
| trackNfcEvent(PassportEvents.NFC_SCAN_FAILED, { | |
| error: sanitized, | |
| duration_seconds: parseFloat(scanDurationSeconds), | |
| }); | |
| openErrorModal(sanitized); |
🤖 Prompt for AI Agents
In app/src/screens/passport/PassportNFCScanScreen.tsx around lines 358 to 366,
the code logs a sanitized error for analytics but still shows the raw message in
the user-facing modal; replace the raw message with the sanitized variable when
invoking the error modal so the displayed content uses
sanitizeErrorMessage(message) (sanitized) instead of the original message,
ensuring any modal props or state that currently use the raw message are updated
to use sanitized and keeping analytics tracking as-is.
| trackNfcEvent(ProofEvents.PROVING_PROCESS_ERROR, { | ||
| error: message, | ||
| }); | ||
| const { flush: flushAnalytics } = analytics(); | ||
| flushAnalytics(); | ||
| flushMixpanelEvents(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
Sanitize error data before sending to analytics
error.message can contain PII or sensitive details. Shipping raw messages to analytics (Segment + Mixpanel) increases leakage risk. Prefer an error code/category and a bounded, scrubbed message.
Apply this refactor to gate and sanitize payloads:
- trackEvent(ProofEvents.PROVING_PROCESS_ERROR, {
- error: message,
- });
- trackNfcEvent(ProofEvents.PROVING_PROCESS_ERROR, {
- error: message,
- });
+ const safeError = (() => {
+ // Keep a tiny, bounded footprint: code + coarse category
+ const code =
+ error instanceof Error && 'name' in error ? String(error.name) : 'UnknownError';
+ // Avoid sending raw messages; bucketize instead
+ const category =
+ /network|timeout/i.test(message) ? 'network' :
+ /permission|denied/i.test(message) ? 'permission' :
+ /cancel|abort/i.test(message) ? 'cancellation' :
+ 'generic';
+ return { code, category };
+ })();
+ trackEvent(ProofEvents.PROVING_PROCESS_ERROR, safeError);
+ trackNfcEvent(ProofEvents.PROVING_PROCESS_ERROR, safeError);Search for other analytics calls that include raw error, stack, or message and replace with sanitized payloads:
🏁 Script executed:
#!/bin/bash
rg -nP -C2 --type=ts --type=tsx '\btrack(Nfc)?Event\(\s*[^,]+,\s*\{[^}]*\b(error|stack|message)\b' Length of output: 128
I’ll broaden the search to include both .ts and .tsx files without relying on ripgrep’s built-in types:
🏁 Script executed:
#!/bin/bash
# Search all .ts & .tsx for analytics calls sending raw error, stack, or message
rg -nP -C2 -g '*.ts' -g '*.tsx' '\btrack(Nfc)?Event\(\s*[^,]+,\s*\{[^}]*\b(error|stack|message)\b'Length of output: 1719
Sanitize error payloads before emitting analytics events
Error objects can contain PII or sensitive internals. We must never ship raw .message, .error, or .stack fields to Segment/Mixpanel. Instead, extract only a safe error code/name plus a coarse-grained category (e.g. “network”, “permission”, “cancellation”, “generic”).
Please apply this refactor everywhere you currently call trackEvent or trackNfcEvent with raw error data:
• app/src/screens/prove/ConfirmBelongingScreen.tsx (lines 80–85)
Replace:
- trackNfcEvent(ProofEvents.PROVING_PROCESS_ERROR, {
- error: message,
- });
+ const safeError = sanitizeError(error, message);
+ trackNfcEvent(ProofEvents.PROVING_PROCESS_ERROR, safeError);• app/src/providers/authProvider.tsx (line 197)
Replace:
- trackEvent(AuthEvents.BIOMETRIC_LOGIN_FAILED, { error });
+ trackEvent(AuthEvents.BIOMETRIC_LOGIN_FAILED, sanitizeError(error));• app/src/providers/authProvider.web.tsx (line 210)
Replace:
- trackEvent(AuthEvents.BIOMETRIC_LOGIN_FAILED, { error });
+ trackEvent(AuthEvents.BIOMETRIC_LOGIN_FAILED, sanitizeError(error));• app/src/utils/proving/provingMachine.ts (line 403)
Replace:
- trackEvent(ProofEvents.TEE_WS_ERROR, { error: result.error });
+ trackEvent(ProofEvents.TEE_WS_ERROR, sanitizeError(result.error));• app/src/utils/proving/provingMachine.ts (line 851)
Replace:
- trackEvent(ProofEvents.TEE_CONN_FAILED, { message: msg });
+ trackEvent(ProofEvents.TEE_CONN_FAILED, sanitizeError(undefined, msg));You can centralize the logic in a helper:
function sanitizeError(err?: unknown, msg?: string) {
const code = err instanceof Error ? err.name : 'UnknownError';
const category = /network|timeout/i.test(msg ?? '') ? 'network'
: /permission|denied/i.test(msg ?? '') ? 'permission'
: /cancel|abort/i.test(msg ?? '') ? 'cancellation'
: 'generic';
return { code, category };
}Apply this pattern to any future analytics events to avoid inadvertent PII leakage.
🤖 Prompt for AI Agents
In app/src/screens/prove/ConfirmBelongingScreen.tsx around lines 80–85, the code
currently sends raw error text to analytics; replace the direct passing of
message with a sanitized payload: create or import a sanitizeError(err?:
unknown, msg?: string) helper that returns only a safe code/name and a
coarse-grained category, call sanitizeError(undefined, message) (or with the
actual error if available) and pass that object to trackNfcEvent instead of the
raw message, then keep the existing analytics flush calls unchanged.
| configure( | ||
| token: string, | ||
| enableDebug?: boolean, | ||
| flushPolicies?: { | ||
| flushInterval?: number; | ||
| flushCount?: number; | ||
| flushOnBackground?: boolean; | ||
| flushOnForeground?: boolean; | ||
| flushOnNetworkChange?: boolean; | ||
| }, | ||
| ): void; | ||
| trackEvent?(name: string, properties?: Record<string, unknown>): void; | ||
| flush?(): void; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
API alignment: configure looks good; confirm scan vs scanPassport naming across native/mocks
The expanded configure signature and optional trackEvent/flush match the PR intent. However, elsewhere in the repo and mocks we expose scanPassport via NativeModules.PassportReader, while this type defines scan(...). This mismatch can surface as runtime errors or type unsafety depending on which entry point callers use.
- If the JS wrapper truly exports
scan(...), ensure mocks/native also exposescan(aliasscanPassport). - If the native bridge is the public API, extend the d.ts with an optional
scanPassport?(...)to reflect reality.
To cover both code paths without breaking types, add a secondary optional method in the interface:
// Add alongside `scan(...)` in the PassportReader interface
scanPassport?(options: ScanOptions): Promise<{
mrz: string;
eContent: string;
encryptedDigest: string;
photo: { base64: string };
digestAlgorithm: string;
signerInfoDigestAlgorithm: string;
digestEncryptionAlgorithm: string;
LDSVersion: string;
unicodeVersion: string;
encapContent: string;
documentSigningCertificate: string;
dataGroupHashes: string;
}>;If you prefer keeping a single name, I can generate diffs to switch the mocks and callsites to scan(...) instead—say the word.
🏁 Script executed:
#!/bin/bash
# Find occurrences of scanPassport
rg -n "scanPassport" -C2 || true
# Find occurrences of scan( in PassportReader context
rg -n "\.scan\s*\(" -C2 || true
# Find NativeModules.PassportReader usage
rg -n "NativeModules\.PassportReader" -C2 || true
# List mock files related to passport reader
rg -i "__mocks__.*passport[-_]reader" -l || trueLength of output: 8566
Address scan vs scanPassport naming mismatch
There’s currently a gap between what the native modules and mocks expose (iOS / JS calls use scanPassport) and what the Android bridge and TypeScript definitions expect (scan). Without alignment, callers will hit undefined-method errors at runtime or TypeScript will flag missing properties.
• In app/src/types/react-native-passport-reader.d.ts, the interface lists scan(...) but not scanPassport. Add an optional alias there:
export interface PassportReader {
// …existing members…
scan(options: ScanOptions): Promise<ScanResult>;
/** iOS native bridge uses scanPassport */
scanPassport?(options: ScanOptions): Promise<ScanResult>;
// …existing members…
}• In app/jest.setup.js, the mock only defines scanPassport. Mirror the Android shape so tests covering JS calls to scan will pass:
NativeModules.PassportReader = {
configure: jest.fn(),
scanPassport: jest.fn(),
/** alias for Android-style API */
scan: jest.fn((opts) => NativeModules.PassportReader.scanPassport(opts)),
trackEvent: jest.fn(),
flush: jest.fn(),
};• Elsewhere in the JS wrapper (app/src/utils/nfcScanner.ts), scanIOS uses scanPassport while scanAndroid uses PassportReader.scan. With both signatures in the TS interface and both methods on the mock, all code paths and tests remain type-safe.
Implementing these changes will harmonize native bridges, mocks, and the TS layer—eliminating brittle ad-hoc aliases in callers and preventing runtime/type errors.
🤖 Prompt for AI Agents
In app/src/types/react-native-passport-reader.d.ts around lines 16–28, the
PassportReader interface exposes scan but not scanPassport which causes a
mismatch with iOS/native mocks; add an optional scanPassport?(options:
ScanOptions): Promise<ScanResult> alias alongside scan; in app/jest.setup.js
update the NativeModules.PassportReader mock to define both scanPassport and
scan (make scan call/forward to scanPassport) plus keep
configure/trackEvent/flush mocks so tests using either method pass; finally
verify app/src/utils/nfcScanner.ts uses the unified signatures (scan or
scanPassport) or call the appropriate alias to ensure both Android and iOS code
paths are covered and type-safe.
app/src/utils/nfcScanner.ts
Outdated
| // --- Mixpanel flush strategy --- | ||
| let mixpanelConfigured = false; | ||
| let eventCount = 0; | ||
| let flushTimer: ReturnType<typeof setInterval> | null = null; | ||
| let isConnected = true; | ||
| const eventQueue: Array<{ | ||
| name: string; | ||
| properties?: Record<string, unknown>; | ||
| }> = []; | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CI failure: wrong module imports/usage on Android drops events and breaks build
CI complains “'default' is not exported by …/react-native-passport-reader/index.android.js” and, functionally, Android uses RNPassportReader while iOS uses PassportReader. Current code mixes a default JS import and hard-codes NativeModules.PassportReader for configure/flush/track, which will be undefined on Android — events get dropped and configuration never happens.
Fix by removing the default JS import and using a platform-aware NativeModules handle consistently for configure/track/flush/scan.
- Define a platform-specific bridge once (outside these hunks):
// Place near the other imports
const Reader: any =
Platform.OS === 'android'
? NativeModules.RNPassportReader
: NativeModules.PassportReader;- Update configure/flush/track to use Reader:
export const configureNfcAnalytics = () => {
if (!MIXPANEL_NFC_PROJECT_TOKEN || mixpanelConfigured) return;
const enableDebugLogs = JSON.parse(String(ENABLE_DEBUG_LOGS));
- NativeModules.PassportReader.configure(
+ Reader?.configure?.(
MIXPANEL_NFC_PROJECT_TOKEN,
enableDebugLogs,
{
flushInterval: 30,
flushCount: 5,
flushOnBackground: true,
flushOnForeground: true,
flushOnNetworkChange: true,
},
);
setupFlushPolicies();
mixpanelConfigured = true;
}; export const flushMixpanelEvents = () => {
if (!MIXPANEL_NFC_PROJECT_TOKEN) return;
try {
if (__DEV__) console.log('[Mixpanel] flush');
// Send any queued events before flushing
while (eventQueue.length > 0) {
const evt = eventQueue.shift()!;
- NativeModules.PassportReader?.trackEvent?.(evt.name, evt.properties);
+ Reader?.trackEvent?.(evt.name, evt.properties);
}
- NativeModules.PassportReader?.flush?.();
+ Reader?.flush?.();
eventCount = 0;
} catch (err) {
if (__DEV__) console.warn('Mixpanel flush failed', err);
// re-queue on failure
if (typeof err !== 'undefined') {
// no-op, events are already queued if failure happened before flush
}
}
}; export const scan = async (inputs: Inputs) => {
configureNfcAnalytics();
return Platform.OS === 'android'
- ? await scanAndroid(inputs)
+ ? await scanAndroid(inputs)
: await scanIOS(inputs);
}; export const trackNfcEvent = (
name: string,
properties?: Record<string, unknown>,
) => {
if (!MIXPANEL_NFC_PROJECT_TOKEN) return;
if (!mixpanelConfigured) configureNfcAnalytics();
if (!isConnected) {
eventQueue.push({ name, properties });
return;
}
try {
- NativeModules.PassportReader?.trackEvent?.(name, properties);
+ Reader?.trackEvent?.(name, properties);
eventCount++;
if (eventCount >= 5) {
flushMixpanelEvents();
}
} catch (err) {
eventQueue.push({ name, properties });
}
};- Use the Android module for scan/reset:
const scanAndroid = async (inputs: Inputs) => {
- PassportReader.reset();
- return await PassportReader.scan({
+ Reader?.reset?.();
+ return await Reader.scan({
documentNumber: inputs.passportNumber,
dateOfBirth: inputs.dateOfBirth,
dateOfExpiry: inputs.dateOfExpiry,
canNumber: inputs.canNumber ?? '',
useCan: inputs.useCan ?? false,
});
};- Remove the default JS import (outside changed hunks):
-import PassportReader from 'react-native-passport-reader';This resolves the CI error and ensures Android actually configures and flushes Mixpanel instead of silently no-op'ing.
Also applies to: 56-73, 92-110, 118-124, 151-172
🤖 Prompt for AI Agents
In app/src/utils/nfcScanner.ts around lines 46 to 55 (and also apply the same
changes at 56-73, 92-110, 118-124, 151-172): the file currently mixes a default
JS import and hard-coded NativeModules.PassportReader which breaks Android (CI:
"'default' is not exported..." and RNPassportReader is the Android native
module), so remove the default JS import entirely, add a single platform-aware
NativeModules bridge near the other imports (const Reader = Platform.OS ===
'android' ? NativeModules.RNPassportReader : NativeModules.PassportReader), and
update all configure/flush/track/scan/reset calls to call Reader.<method>
consistently (use RNPassportReader on Android and PassportReader on iOS) so
configuration and event flushing works on both platforms.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
app/src/screens/passport/PassportNFCScanScreen.tsx (1)
207-217: Cancel the underlying native scan when the timeout fires to prevent dangling NFC sessionsWithout an explicit cancel/reset, the native scan may keep running and race with subsequent attempts.
scanTimeoutRef.current = setTimeout(() => { scanCancelledRef.current = true; trackEvent(PassportEvents.NFC_SCAN_FAILED, { error: 'timeout', }); trackNfcEvent(PassportEvents.NFC_SCAN_FAILED, { error: 'timeout', }); + try { + cancelScan(); + } catch {} openErrorModal('Scan timed out. Please try again.'); setIsNfcSheetOpen(false); }, 30000);Add import (outside hunk) to reuse your scanner utility’s cancel:
import { parseScanResponse, scan, /* add: */ cancelScan } from '@/utils/nfcScanner';app/src/utils/nfcScanner.ts (1)
54-62: Optional: expose a cancel API in this module and use it on timeout/blurHelps avoid dangling scans and reduces inconsistent event streams.
Add (outside hunks):
export const cancelScan = () => { try { if (Platform.OS === 'android') { reset(); } else { NativeModules.PassportReader?.reset?.(); } } catch { // no-op } };Also applies to: 65-76
♻️ Duplicate comments (4)
app/src/screens/passport/PassportNFCScanScreen.tsx (2)
140-158: Use sanitized error message in the user-facing modal to avoid PII leakageCurrently the modal shows the raw message; sanitize first and reuse the same sanitized value for email.
Apply:
const openErrorModal = useCallback( (message: string) => { flushAllAnalytics(); - showModal({ + const sanitized = sanitizeErrorMessage(message); + showModal({ titleText: 'NFC Scan Error', - bodyText: message, + bodyText: sanitized, buttonText: 'Report Issue', secondaryButtonText: 'Help', preventDismiss: false, onButtonPress: () => sendFeedbackEmail({ - message: sanitizeErrorMessage(message), + message: sanitized, origin: 'passport/nfc', }),
352-361: Pass the sanitized message to the modalAvoid surfacing raw errors that may contain MRZ or other sensitive values.
- openErrorModal(message); + openErrorModal(sanitized);app/src/utils/nfcScanner.ts (1)
11-12: Android crash risk: configureNfcAnalytics uses iOS module on AndroidconfigureNfcAnalytics calls NativeModules.PassportReader.configure directly. From this file you invoke it before every scan; on Android, PassportReader is undefined (module is RNPassportReader), causing a runtime error. Make the analytics module use a platform-aware reader.
Update app/src/utils/analytics.ts (outside this hunk):
+import { Platform, NativeModules } from 'react-native'; +const Reader = + Platform.OS === 'android' + ? NativeModules.RNPassportReader + : NativeModules.PassportReader; export const configureNfcAnalytics = () => { if (!MIXPANEL_NFC_PROJECT_TOKEN || mixpanelConfigured) return; const enableDebugLogs = JSON.parse(String(ENABLE_DEBUG_LOGS)); - NativeModules.PassportReader.configure( + Reader?.configure?.( MIXPANEL_NFC_PROJECT_TOKEN, enableDebugLogs, { flushInterval: 20, flushCount: 5, flushOnBackground: true, flushOnForeground: true, flushOnNetworkChange: true, }, ); setupFlushPolicies(); mixpanelConfigured = true; }; export const flushMixpanelEvents = () => { if (!MIXPANEL_NFC_PROJECT_TOKEN) return; try { if (__DEV__) console.log('[Mixpanel] flush'); while (eventQueue.length > 0) { const evt = eventQueue.shift()!; - NativeModules.PassportReader?.trackEvent?.(evt.name, evt.properties); + Reader?.trackEvent?.(evt.name, evt.properties); } - NativeModules.PassportReader?.flush?.(); + Reader?.flush?.(); eventCount = 0; } catch (err) { if (__DEV__) console.warn('Mixpanel flush failed', err); } }; export const trackNfcEvent = (name: string, properties?: Record<string, unknown>) => { if (!MIXPANEL_NFC_PROJECT_TOKEN) return; if (!mixpanelConfigured) configureNfcAnalytics(); if (!isConnected) { eventQueue.push({ name, properties }); return; } try { - NativeModules.PassportReader?.trackEvent?.(name, properties); + Reader?.trackEvent?.(name, properties); eventCount++; if (eventCount >= 5) flushMixpanelEvents(); } catch { eventQueue.push({ name, properties }); } };Also applies to: 46-48
app/src/types/react-native-passport-reader.d.ts (1)
16-28: Fix API mismatch with iOS (scan vs scanPassport) and tighten analytics typing
- iOS bridge exposes scanPassport; the d.ts only declares scan. This can yield undefined-method errors at runtime on iOS paths via NativeModules.PassportReader. Add an optional scanPassport alias on the interface.
- TrackEvent properties typed as unknown invites accidental PII leakage. Narrow to primitives.
Apply within-range diff (typing hardening):
- trackEvent?(name: string, properties?: Record<string, unknown>): void; + trackEvent?(name: string, properties?: Record<string, string | number | boolean | null | undefined>): void;Add outside-range interface alias (place next to scan(...)):
// Alias for iOS-native method name to prevent undefined at runtime scanPassport?(options: ScanOptions): Promise<ScanResult>;Run to confirm iOS usage sites and mocks won’t break:
#!/bin/bash rg -n -C2 '\bscanPassport\s*\(' app | sed -n '1,120p' rg -n -C2 'NativeModules\.PassportReader' app | sed -n '1,160p'
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (2)
app/Gemfile.lockis excluded by!**/*.lockapp/ios/Podfile.lockis excluded by!**/*.lock
📒 Files selected for processing (13)
app/android/react-native-passport-reader/index.android.js(1 hunks)app/package.json(1 hunks)app/src/Segment.ts(2 hunks)app/src/components/ErrorBoundary.tsx(2 hunks)app/src/mocks/react-native-passport-reader.ts(1 hunks)app/src/screens/passport/PassportNFCScanScreen.tsx(9 hunks)app/src/screens/passport/PassportNFCTroubleScreen.tsx(2 hunks)app/src/screens/prove/ConfirmBelongingScreen.tsx(3 hunks)app/src/screens/prove/QRCodeTroubleScreen.tsx(2 hunks)app/src/types/react-native-passport-reader.d.ts(2 hunks)app/src/utils/analytics.ts(4 hunks)app/src/utils/nfcScanner.ts(3 hunks)app/vite.config.ts(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- app/src/components/ErrorBoundary.tsx
- app/src/screens/prove/ConfirmBelongingScreen.tsx
🧰 Additional context used
📓 Path-based instructions (4)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/technical-specification.mdc)
**/*.{ts,tsx}: Define IdentityCommitment with fields: commitment (Poseidon hash), nullifier (domain-separated), timestamp (UTC number), version (circuit version), documentType ('passport' | 'eu_id_card')
Define DSCKeyCommitment with fields: publicKeyHash (Poseidon hash), certificateChain (hashes), revocationStatus (boolean), issuer (country code)
Define VerificationConfig with fields: circuitVersion (semver), complianceRules array, timeWindow (seconds, 24h), clockDrift (±5 min), trustAnchors, revocationRoots, timeSource (NTP), nullifierScope (domain separation)
Files:
app/vite.config.tsapp/src/mocks/react-native-passport-reader.tsapp/src/screens/passport/PassportNFCTroubleScreen.tsxapp/src/utils/analytics.tsapp/src/Segment.tsapp/src/screens/prove/QRCodeTroubleScreen.tsxapp/src/utils/nfcScanner.tsapp/src/screens/passport/PassportNFCScanScreen.tsxapp/src/types/react-native-passport-reader.d.ts
app/src/**/*.{ts,tsx,js,jsx}
⚙️ CodeRabbit configuration file
app/src/**/*.{ts,tsx,js,jsx}: Review React Native TypeScript code for:
- Component architecture and reusability
- State management patterns
- Performance optimizations
- TypeScript type safety
- React hooks usage and dependencies
- Navigation patterns
Files:
app/src/mocks/react-native-passport-reader.tsapp/src/screens/passport/PassportNFCTroubleScreen.tsxapp/src/utils/analytics.tsapp/src/Segment.tsapp/src/screens/prove/QRCodeTroubleScreen.tsxapp/src/utils/nfcScanner.tsapp/src/screens/passport/PassportNFCScanScreen.tsxapp/src/types/react-native-passport-reader.d.ts
app/android/**/*
⚙️ CodeRabbit configuration file
app/android/**/*: Review Android-specific code for:
- Platform-specific implementations
- Performance considerations
- Security best practices for mobile
Files:
app/android/react-native-passport-reader/index.android.js
app/package.json
📄 CodeRabbit inference engine (.cursor/rules/mobile-sdk-migration.mdc)
Expose a 'test:build' script in the app's package.json that builds deps, types, performs bundle analysis, and runs tests
Files:
app/package.json
🧠 Learnings (11)
📓 Common learnings
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Applies to native/ios/**/*.{swift} : iOS NFC: implement custom PassportReader as a Swift module
📚 Learning: 2025-08-25T14:25:57.586Z
Learnt from: aaronmgdr
PR: selfxyz/self#951
File: app/src/providers/authProvider.web.tsx:17-18
Timestamp: 2025-08-25T14:25:57.586Z
Learning: The selfxyz/mobile-sdk-alpha/constants/analytics import path is properly configured with SDK exports, Metro aliases, and TypeScript resolution. Import changes from @/consts/analytics to this path are part of valid analytics migration, not TypeScript resolution issues.
Applied to files:
app/vite.config.tsapp/src/screens/passport/PassportNFCTroubleScreen.tsxapp/src/utils/analytics.tsapp/src/screens/prove/QRCodeTroubleScreen.tsx
📚 Learning: 2025-08-24T18:52:25.796Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Applies to tests/src/**/*.{ts,tsx,js,jsx} : Use tests/ alias for test imports
Applied to files:
app/vite.config.ts
📚 Learning: 2025-08-24T18:52:25.796Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Applies to native/ios/**/*.{swift} : iOS NFC: implement custom PassportReader as a Swift module
Applied to files:
app/src/mocks/react-native-passport-reader.tsapp/src/utils/nfcScanner.tsapp/src/types/react-native-passport-reader.d.ts
📚 Learning: 2025-08-24T18:52:25.796Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Applies to jest.setup.js : Maintain comprehensive mocks in jest.setup.js for all native modules
Applied to files:
app/src/mocks/react-native-passport-reader.ts
📚 Learning: 2025-08-24T18:52:25.796Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Applies to native/android/**/*.{kt,kts} : Android NFC: implement RNPassportReaderModule in Kotlin
Applied to files:
app/src/mocks/react-native-passport-reader.tsapp/android/react-native-passport-reader/index.android.jsapp/src/utils/nfcScanner.ts
📚 Learning: 2025-08-24T18:54:04.809Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursor/rules/mobile-sdk-migration.mdc:0-0
Timestamp: 2025-08-24T18:54:04.809Z
Learning: Applies to app/jest.setup.js : Provide comprehensive Jest setup in app/jest.setup.js with required mocks
Applied to files:
app/src/mocks/react-native-passport-reader.ts
📚 Learning: 2025-08-24T18:54:04.809Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursor/rules/mobile-sdk-migration.mdc:0-0
Timestamp: 2025-08-24T18:54:04.809Z
Learning: Applies to app/package.json : Expose a 'test:build' script in the app's package.json that builds deps, types, performs bundle analysis, and runs tests
Applied to files:
app/package.json
📚 Learning: 2025-08-24T18:52:25.796Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Use yarn scripts: yarn ios/android for builds, yarn test for unit tests, and Fastlane for deployments
Applied to files:
app/package.json
📚 Learning: 2025-08-24T18:54:04.809Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursor/rules/mobile-sdk-migration.mdc:0-0
Timestamp: 2025-08-24T18:54:04.809Z
Learning: Applies to packages/mobile-sdk-alpha/package.json : Expose a 'test:build' script in the SDK's package.json that runs build, test, types, and lint
Applied to files:
app/package.json
📚 Learning: 2025-08-26T14:49:11.190Z
Learnt from: shazarre
PR: selfxyz/self#936
File: app/src/screens/passport/PassportNFCScanScreen.tsx:28-31
Timestamp: 2025-08-26T14:49:11.190Z
Learning: SelfClientProvider is wrapped in app/App.tsx, providing context for useSelfClient() hook usage throughout the React Native app navigation stacks.
Applied to files:
app/src/screens/passport/PassportNFCScanScreen.tsx
🧬 Code graph analysis (8)
app/src/mocks/react-native-passport-reader.ts (1)
app/src/screens/MainScreen.tsx (1)
Platform(106-115)
app/src/screens/passport/PassportNFCTroubleScreen.tsx (1)
app/src/utils/analytics.ts (1)
flushAllAnalytics(219-226)
app/src/utils/analytics.ts (2)
app/tests/__setup__/@env.js (4)
MIXPANEL_NFC_PROJECT_TOKEN(18-18)MIXPANEL_NFC_PROJECT_TOKEN(18-18)ENABLE_DEBUG_LOGS(11-11)ENABLE_DEBUG_LOGS(11-11)app/android/react-native-passport-reader/index.android.js (1)
NativeModules(5-5)
app/src/Segment.ts (1)
app/tests/__setup__/@env.js (2)
SEGMENT_KEY(19-19)SEGMENT_KEY(19-19)
app/src/screens/prove/QRCodeTroubleScreen.tsx (1)
app/src/utils/analytics.ts (1)
flushAllAnalytics(219-226)
app/src/utils/nfcScanner.ts (3)
app/android/react-native-passport-reader/android/src/main/java/io/tradle/nfc/RNPassportReaderModule.kt (2)
scan(198-232)reset(863-867)app/src/utils/analytics.ts (1)
configureNfcAnalytics(197-213)app/android/react-native-passport-reader/index.android.js (1)
NativeModules(5-5)
app/src/screens/passport/PassportNFCScanScreen.tsx (4)
app/src/utils/analytics.ts (2)
flushAllAnalytics(219-226)trackNfcEvent(228-249)packages/mobile-sdk-alpha/src/constants/analytics.ts (1)
PassportEvents(83-103)app/src/utils/utils.ts (1)
sanitizeErrorMessage(23-31)app/ios/SelfAnalytics.swift (1)
trackEvent(15-28)
app/src/types/react-native-passport-reader.d.ts (1)
app/ios/PassportReader.swift (3)
configure(49-53)configure(442-445)scanPassport(78-239)
⏰ Context from checks skipped due to timeout of 300000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build-ios
🔇 Additional comments (10)
app/package.json (1)
45-45: Nice: repo hygiene and CI friendliness improved.
- nice now builds deps before autofixes.
- test:build matches guidelines (deps + types + bundle analysis + tests).
Also applies to: 57-57
app/android/react-native-passport-reader/index.android.js (1)
8-12: Android export surface aligned (adds reset).Exporting reset alongside scan and RNPassportReader spread is correct and backward compatible.
app/src/Segment.ts (1)
12-13: ClarifyflushIntervalunit
TheflushIntervaloption is typed as a plainnumberin the v2.21.0 type definitions with no JSDoc indicating units—confirm via the official Segment docs whether it expects milliseconds or seconds to avoid unintended flush timing.app/src/screens/passport/PassportNFCTroubleScreen.tsx (2)
16-16: LGTM: centralized analytics importImporting the new flush API from '@/utils/analytics' aligns with the PR’s strategy.
54-57: LGTM: flush on mountFlushing analytics on error entry prevents event loss before navigation.
app/src/screens/prove/QRCodeTroubleScreen.tsx (2)
12-12: LGTM: adopt centralized analytics APIConsistent with other screens and new flushing strategy.
49-51: LGTM: flush on mountEnsures pending events are flushed when entering the trouble screen.
app/vite.config.ts (1)
45-48: LGTM: web alias for PassportReaderMapping 'react-native-passport-reader' to the web mock prevents native imports in web builds and unblocks the renderer.
app/src/screens/passport/PassportNFCScanScreen.tsx (1)
398-406: LGTM: flush on cancelFlushing on cancel helps drain buffers before leaving the flow.
app/src/types/react-native-passport-reader.d.ts (1)
48-66: Sync TS definitions with native module surfaces
- Extend
configureto(token: string, enableDebug?: boolean, flushPolicies?: FlushPolicies); iOS wrapper supports two args, Android implementation unverified—please confirm wrappers handle extra params.- Add
trackEvent(name: string, properties?: Record<string, string | number | boolean | null | undefined>): voidandflush(): voidnamed exports; verify native/JS modules expose these methods.- Extract inline
scanreturn shape into sharedScanResulttype to avoid duplication.
| import { NativeModules } from 'react-native'; | ||
| import { ENABLE_DEBUG_LOGS, MIXPANEL_NFC_PROJECT_TOKEN } from '@env'; | ||
| import NetInfo from '@react-native-community/netinfo'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
Stop using NativeModules directly; import the module to activate the web mock, harden configure, and await flush to prevent event loss.
- Using NativeModules bypasses the Vite alias, breaking web and tests.
- configure may throw or be absent; guard and try/catch.
- Await trackEvent/flush if they are async to avoid dropping queued events before flush.
Apply this diff:
-import { NativeModules } from 'react-native';
+// Importing the module (not NativeModules) ensures Vite/Web aliasing picks up the web mock.
+import * as PassportReader from 'react-native-passport-reader';
@@
-const flushMixpanelEvents = () => {
+const flushMixpanelEvents = async () => {
if (!MIXPANEL_NFC_PROJECT_TOKEN) return;
try {
if (__DEV__) console.log('[Mixpanel] flush');
// Send any queued events before flushing
while (eventQueue.length > 0) {
const evt = eventQueue.shift()!;
- NativeModules.PassportReader?.trackEvent?.(evt.name, evt.properties);
+ // Await if the native bridge returns a Promise; resolves immediately otherwise.
+ await Promise.resolve(
+ PassportReader?.trackEvent?.(evt.name, evt.properties),
+ );
}
- NativeModules.PassportReader?.flush?.();
+ if (PassportReader?.flush) {
+ await Promise.resolve(PassportReader.flush());
+ }
eventCount = 0;
} catch (err) {
if (__DEV__) console.warn('Mixpanel flush failed', err);
// re-queue on failure
if (typeof err !== 'undefined') {
// no-op, events are already queued if failure happened before flush
}
}
};
@@
export const configureNfcAnalytics = () => {
if (!MIXPANEL_NFC_PROJECT_TOKEN || mixpanelConfigured) return;
- const enableDebugLogs = JSON.parse(String(ENABLE_DEBUG_LOGS));
- NativeModules.PassportReader.configure(
- MIXPANEL_NFC_PROJECT_TOKEN,
- enableDebugLogs,
- {
- flushInterval: 20,
- flushCount: 5,
- flushOnBackground: true,
- flushOnForeground: true,
- flushOnNetworkChange: true,
- },
- );
+ const enableDebugLogs =
+ typeof ENABLE_DEBUG_LOGS === 'boolean'
+ ? ENABLE_DEBUG_LOGS
+ : ['1', 'true', 'yes', 'on'].includes(
+ String(ENABLE_DEBUG_LOGS).toLowerCase(),
+ );
+ if (typeof PassportReader?.configure !== 'function') {
+ if (__DEV__) console.warn('[Mixpanel] PassportReader.configure unavailable on this platform');
+ return;
+ }
+ try {
+ PassportReader.configure(MIXPANEL_NFC_PROJECT_TOKEN, enableDebugLogs, {
+ flushInterval: 20,
+ flushCount: 5,
+ flushOnBackground: true,
+ flushOnForeground: true,
+ flushOnNetworkChange: true,
+ });
+ } catch (e) {
+ if (__DEV__) console.warn('[Mixpanel] configure failed', e);
+ return;
+ }
setupFlushPolicies();
mixpanelConfigured = true;
};
@@
try {
- NativeModules.PassportReader?.trackEvent?.(name, properties);
+ PassportReader?.trackEvent?.(name, properties);
eventCount++;
if (eventCount >= 5) {
flushMixpanelEvents();
}Follow-up: search and replace any other NativeModules.PassportReader usages to keep imports consistent.
Also applies to: 176-194, 196-213, 228-249
🏁 Script executed:
#!/bin/bash
# Find direct NativeModules.PassportReader usages (should be none after refactor)
rg -nP --type=ts --type=tsx 'NativeModules\.PassportReader'Length of output: 89
🏁 Script executed:
#!/bin/bash
# Re-run search for direct NativeModules.PassportReader usages across TS/TSX files
rg -n 'NativeModules\.PassportReader' -g '*.ts' -g '*.tsx'Length of output: 502
Replace remaining NativeModules.PassportReader usages with PassportReader import
- app/src/utils/nfcScanner.ts:66
- app/src/utils/analytics.ts:183, 185, 200, 241
Use
import * as PassportReader from 'react-native-passport-reader';and replace all NativeModules.PassportReader calls with
await Promise.resolve(PassportReader.methodName(...))guarding configure and flush as shown in the original diff.
🤖 Prompt for AI Agents
In app/src/utils/analytics.ts (lines 6-8) and at the usages on lines ~183, ~185,
~200, ~241 (and app/src/utils/nfcScanner.ts line 66), remove references to
NativeModules.PassportReader and instead add an import line importing the module
as a namespace; replace each NativeModules.PassportReader.methodName(...) call
with an awaited Promise.resolve(PassportReader.methodName(...)); and for
configure/flush calls guard them with existence checks (e.g. if
(PassportReader.configure) await Promise.resolve(PassportReader.configure(...));
same pattern for flush) so all calls use the PassportReader namespace and are
promise-wrapped/awaited.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 5
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
app/tests/src/components/ErrorBoundary.test.tsx (1)
74-91: Assert call order to match test name: track → flush → Sentry.Current test only checks calls happened, not that flush preceded Sentry as required.
it('calls analytics flush before logging to Sentry', () => { @@ consoleError.mockRestore(); - expect(mockTrackNfcEvent).toHaveBeenCalledWith('error_boundary', { + expect(mockTrackNfcEvent).toHaveBeenCalledWith('error_boundary', { message: 'boom', stack: expect.any(String), }); expect(mockFlushAllAnalytics).toHaveBeenCalled(); + // Enforce ordering: track -> flush -> Sentry + expect( + mockTrackNfcEvent.mock.invocationCallOrder[0], + ).toBeLessThan(mockFlushAllAnalytics.mock.invocationCallOrder[0]); + const { captureException } = require('@/Sentry'); + expect( + mockFlushAllAnalytics.mock.invocationCallOrder[0], + ).toBeLessThan(captureException.mock.invocationCallOrder[0]); });
♻️ Duplicate comments (2)
app/src/utils/analytics.ts (2)
6-6: Stop using NativeModules directly; import the module to activate web mock and avoid test breakages.Direct NativeModules usage bypasses Vite/Jest aliasing and breaks web/tests; also prevents platform guards. Replace with the module namespace import.
-import { NativeModules } from 'react-native'; +// Importing the module ensures web aliases/mocks are applied. +import * as PassportReader from 'react-native-passport-reader';
240-245: Replace remaining NativeModules usage in trackNfcEvent.Aligns with module import and web mocks; prevents runtime errors where NativeModules is unavailable.
try { - NativeModules.PassportReader?.trackEvent?.(name, properties); + PassportReader?.trackEvent?.(name, properties); eventCount++; if (eventCount >= 5) { - flushMixpanelEvents(); + void flushMixpanelEvents(); }Also applies to: 228-249
🧹 Nitpick comments (1)
app/src/utils/analytics.ts (1)
161-174: Avoid listener leaks; capture unsubscribers and clear them in cleanupAnalytics.Hot reloads and reconfigure paths can accumulate listeners.
export const cleanupAnalytics = () => { eventQueue.length = 0; eventCount = 0; + try { + removeAppStateListener?.(); + removeAppStateListener = undefined; + removeNetInfoListener?.(); + removeNetInfoListener = undefined; + } catch {} }; const setupFlushPolicies = () => { - AppState.addEventListener('change', (state: AppStateStatus) => { + const appStateSub = AppState.addEventListener('change', (state: AppStateStatus) => { if (state === 'background' || state === 'active') { - flushMixpanelEvents(); + void flushMixpanelEvents(); } }); + removeAppStateListener = () => appStateSub.remove(); - NetInfo.addEventListener(state => { + removeNetInfoListener = NetInfo.addEventListener(state => { isConnected = state.isConnected ?? true; if (isConnected) { - flushMixpanelEvents(); + void flushMixpanelEvents(); } }); };Add at module scope (outside the shown ranges):
let removeAppStateListener: (() => void) | undefined; let removeNetInfoListener: (() => void) | undefined;Also applies to: 156-159
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (2)
app/ios/Podfile.lockis excluded by!**/*.lockyarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (4)
app/jest.setup.js(2 hunks)app/package.json(2 hunks)app/src/utils/analytics.ts(3 hunks)app/tests/src/components/ErrorBoundary.test.tsx(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- app/package.json
- app/jest.setup.js
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (.cursor/rules/technical-specification.mdc)
**/*.{ts,tsx}: Define IdentityCommitment with fields: commitment (Poseidon hash), nullifier (domain-separated), timestamp (UTC number), version (circuit version), documentType ('passport' | 'eu_id_card')
Define DSCKeyCommitment with fields: publicKeyHash (Poseidon hash), certificateChain (hashes), revocationStatus (boolean), issuer (country code)
Define VerificationConfig with fields: circuitVersion (semver), complianceRules array, timeWindow (seconds, 24h), clockDrift (±5 min), trustAnchors, revocationRoots, timeSource (NTP), nullifierScope (domain separation)
Files:
app/tests/src/components/ErrorBoundary.test.tsxapp/src/utils/analytics.ts
**/*.{test,spec}.{ts,js,tsx,jsx}
⚙️ CodeRabbit configuration file
**/*.{test,spec}.{ts,js,tsx,jsx}: Review test files for:
- Test coverage completeness
- Test case quality and edge cases
- Mock usage appropriateness
- Test readability and maintainability
Files:
app/tests/src/components/ErrorBoundary.test.tsx
app/src/**/*.{ts,tsx,js,jsx}
⚙️ CodeRabbit configuration file
app/src/**/*.{ts,tsx,js,jsx}: Review React Native TypeScript code for:
- Component architecture and reusability
- State management patterns
- Performance optimizations
- TypeScript type safety
- React hooks usage and dependencies
- Navigation patterns
Files:
app/src/utils/analytics.ts
🧠 Learnings (8)
📓 Common learnings
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Applies to native/ios/**/*.{swift} : iOS NFC: implement custom PassportReader as a Swift module
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Provide a unified JavaScript interface for NFC with platform detection
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Applies to native/android/**/*.{kt,kts} : Android NFC: implement RNPassportReaderModule in Kotlin
📚 Learning: 2025-08-24T18:52:25.796Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Applies to tests/src/**/*.{test,spec}.{ts,tsx,js,jsx} : Mock console.error in tests to avoid noisy output
Applied to files:
app/tests/src/components/ErrorBoundary.test.tsx
📚 Learning: 2025-08-24T18:52:25.796Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Test error boundaries and recovery mechanisms
Applied to files:
app/tests/src/components/ErrorBoundary.test.tsx
📚 Learning: 2025-08-24T18:54:04.809Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursor/rules/mobile-sdk-migration.mdc:0-0
Timestamp: 2025-08-24T18:54:04.809Z
Learning: Applies to app/jest.setup.js : Provide comprehensive Jest setup in app/jest.setup.js with required mocks
Applied to files:
app/tests/src/components/ErrorBoundary.test.tsx
📚 Learning: 2025-08-24T18:52:25.796Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Applies to jest.setup.js : Maintain comprehensive mocks in jest.setup.js for all native modules
Applied to files:
app/tests/src/components/ErrorBoundary.test.tsx
📚 Learning: 2025-08-24T18:52:25.796Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Applies to tests/src/**/*.{test,spec}.{ts,tsx,js,jsx} : Use renderHook for custom hook testing
Applied to files:
app/tests/src/components/ErrorBoundary.test.tsx
📚 Learning: 2025-08-24T18:52:25.796Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Applies to native/ios/**/*.{swift} : iOS NFC: implement custom PassportReader as a Swift module
Applied to files:
app/src/utils/analytics.ts
📚 Learning: 2025-08-24T18:52:25.796Z
Learnt from: CR
PR: selfxyz/self#0
File: .cursorrules:0-0
Timestamp: 2025-08-24T18:52:25.796Z
Learning: Applies to native/android/**/*.{kt,kts} : Android NFC: implement RNPassportReaderModule in Kotlin
Applied to files:
app/src/utils/analytics.ts
🧬 Code graph analysis (1)
app/src/utils/analytics.ts (2)
app/tests/__setup__/@env.js (4)
MIXPANEL_NFC_PROJECT_TOKEN(18-18)MIXPANEL_NFC_PROJECT_TOKEN(18-18)ENABLE_DEBUG_LOGS(11-11)ENABLE_DEBUG_LOGS(11-11)app/android/react-native-passport-reader/index.android.js (1)
NativeModules(5-5)
⏰ Context from checks skipped due to timeout of 300000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: build-android
- GitHub Check: build-ios
- GitHub Check: test
- GitHub Check: e2e-ios
- GitHub Check: analyze-ios
- GitHub Check: analyze-android
| import { AppState, type AppStateStatus } from 'react-native'; | ||
| import { NativeModules } from 'react-native'; | ||
| import { ENABLE_DEBUG_LOGS, MIXPANEL_NFC_PROJECT_TOKEN } from '@env'; | ||
| import NetInfo from '@react-native-community/netinfo'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
Repository-wide: replace NativeModules.PassportReader usages.
There are likely other call sites (e.g., nfcScanner). Replace them consistently.
Also applies to: 183-186, 200-201, 241-241
🏁 Script executed:
#!/bin/bash
# Find remaining direct usages
rg -nP --type=ts --type=tsx 'NativeModules\.PassportReader' -C2Length of output: 93
🏁 Script executed:
#!/bin/bash
# Search for any remaining direct usages of PassportReader or nfcScanner in TS/TSX files
rg -n -C2 'NativeModules\.(PassportReader|nfcScanner)' -g '*.{ts,tsx}'Length of output: 1502
Replace all direct NativeModules.PassportReader calls with the new PassportReaderModule
– app/src/utils/nfcScanner.ts: update line 66 from
NativeModules.PassportReader.scanDocument(…)to
PassportReaderModule.scanDocument(…)– app/src/utils/analytics.ts: update
• lines 183–186 (trackEvent/flush)
• lines 200–202 (configure)
• lines 241–243 (trackEvent)
and add at top of each file:
import PassportReaderModule from '<correct-path-to-PassportReaderModule>';🤖 Prompt for AI Agents
In app/src/utils/analytics.ts around lines 183–186, 200–202 and 241–243, replace
all direct NativeModules.PassportReader.* calls with PassportReaderModule.*
(i.e. call PassportReaderModule.trackEvent/flush/configure/trackEvent as
appropriate) and add an import at the top of the file: import
PassportReaderModule from '<correct-path-to-PassportReaderModule>'; also update
app/src/utils/nfcScanner.ts line 66 to call
PassportReaderModule.scanDocument(...) instead of
NativeModules.PassportReader.scanDocument(...); ensure the new import path is
correct and remove or stop using NativeModules.PassportReader references in both
files.
| const flushMixpanelEvents = () => { | ||
| if (!MIXPANEL_NFC_PROJECT_TOKEN) return; | ||
| try { | ||
| if (__DEV__) console.log('[Mixpanel] flush'); | ||
| // Send any queued events before flushing | ||
| while (eventQueue.length > 0) { | ||
| const evt = eventQueue.shift()!; | ||
| NativeModules.PassportReader?.trackEvent?.(evt.name, evt.properties); | ||
| } | ||
| NativeModules.PassportReader?.flush?.(); | ||
| eventCount = 0; | ||
| } catch (err) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make Mixpanel flush path async and await bridge calls to prevent event loss on crashes/navigation.
Draining the queue and calling flush without awaiting potential Promises risks dropping events at critical points.
-const flushMixpanelEvents = () => {
+const flushMixpanelEvents = async () => {
if (!MIXPANEL_NFC_PROJECT_TOKEN) return;
try {
if (__DEV__) console.log('[Mixpanel] flush');
// Send any queued events before flushing
while (eventQueue.length > 0) {
const evt = eventQueue.shift()!;
- NativeModules.PassportReader?.trackEvent?.(evt.name, evt.properties);
+ // Await if the native bridge is async; resolves immediately otherwise.
+ await Promise.resolve(
+ PassportReader?.trackEvent?.(evt.name, evt.properties),
+ );
}
- NativeModules.PassportReader?.flush?.();
+ if (PassportReader?.flush) {
+ await Promise.resolve(PassportReader.flush());
+ }
eventCount = 0;
} catch (err) {
if (__DEV__) console.warn('Mixpanel flush failed', err);Follow-ups within this file (to avoid unhandled Promises):
- In setupFlushPolicies() and threshold flush sites, call as
void flushMixpanelEvents();.
Also applies to: 183-186
🤖 Prompt for AI Agents
In app/src/utils/analytics.ts around lines 176 to 187, flushMixpanelEvents is
synchronous and calls NativeModules bridge methods without awaiting them, which
can drop events; change flushMixpanelEvents to be async, await each
NativeModules.PassportReader?.trackEvent call inside the drain loop and await
NativeModules.PassportReader?.flush() so bridge Promises are resolved before
returning, preserve the try/catch around awaits, and update callers
(setupFlushPolicies and other threshold flush sites noted) to invoke it as void
flushMixpanelEvents(); to avoid unhandled Promise warnings.
| }); | ||
| }; | ||
|
|
||
| const flushMixpanelEvents = () => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
Ensure all call sites tolerate async flush.
After making flushMixpanelEvents async, explicitly drop the Promise at non-awaiting call sites to avoid unhandled rejections.
Run to confirm no remaining direct calls without await/void:
Also applies to: 164-165, 171-172, 243-245
🏁 Script executed:
#!/bin/bash
rg -nP --type=ts --type=tsx '\bflushMixpanelEvents\(\)' -C2Length of output: 89
🏁 Script executed:
#!/bin/bash
rg -nP --glob '*.ts' --glob '*.tsx' '\bflushMixpanelEvents\(\)' -C2Length of output: 1126
Prefix non-awaited flushMixpanelEvents() calls with void
Replace each bare call to flushMixpanelEvents() with void flushMixpanelEvents() to drop the returned Promise and avoid unhandled rejections:
• app/src/utils/analytics.ts lines 164, 171, 225, 244
🤖 Prompt for AI Agents
In app/src/utils/analytics.ts around lines 164, 171, 176, 225, and 244, there
are bare calls to flushMixpanelEvents() that return a Promise and can cause
unhandled rejections; update each bare call to prefix with void (i.e., void
flushMixpanelEvents()) so the returned Promise is intentionally dropped, leaving
any awaited or explicitly handled usages unchanged, and run TypeScript linting
to ensure no unused-promise warnings remain.
| export const configureNfcAnalytics = () => { | ||
| if (!MIXPANEL_NFC_PROJECT_TOKEN || mixpanelConfigured) return; | ||
| const enableDebugLogs = JSON.parse(String(ENABLE_DEBUG_LOGS)); | ||
| NativeModules.PassportReader.configure( | ||
| MIXPANEL_NFC_PROJECT_TOKEN, | ||
| enableDebugLogs, | ||
| { | ||
| flushInterval: 20, | ||
| flushCount: 5, | ||
| flushOnBackground: true, | ||
| flushOnForeground: true, | ||
| flushOnNetworkChange: true, | ||
| }, | ||
| ); | ||
| setupFlushPolicies(); | ||
| mixpanelConfigured = true; | ||
| }; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Harden configureNfcAnalytics: robust boolean coercion, guard platform availability, and catch failures.
JSON.parse on undefined throws; configure may be unavailable on web/tests; lack of try/catch can crash app at startup.
export const configureNfcAnalytics = () => {
if (!MIXPANEL_NFC_PROJECT_TOKEN || mixpanelConfigured) return;
- const enableDebugLogs = JSON.parse(String(ENABLE_DEBUG_LOGS));
- NativeModules.PassportReader.configure(
- MIXPANEL_NFC_PROJECT_TOKEN,
- enableDebugLogs,
- {
- flushInterval: 20,
- flushCount: 5,
- flushOnBackground: true,
- flushOnForeground: true,
- flushOnNetworkChange: true,
- },
- );
+ const enableDebugLogs =
+ typeof ENABLE_DEBUG_LOGS === 'boolean'
+ ? ENABLE_DEBUG_LOGS
+ : ['1', 'true', 'yes', 'on'].includes(
+ String(ENABLE_DEBUG_LOGS).toLowerCase(),
+ );
+ if (typeof PassportReader?.configure !== 'function') {
+ if (__DEV__) console.warn('[Mixpanel] configure unavailable on this platform');
+ return;
+ }
+ try {
+ PassportReader.configure(MIXPANEL_NFC_PROJECT_TOKEN, enableDebugLogs, {
+ flushInterval: 20,
+ flushCount: 5,
+ flushOnBackground: true,
+ flushOnForeground: true,
+ flushOnNetworkChange: true,
+ });
+ } catch (e) {
+ if (__DEV__) console.warn('[Mixpanel] configure failed', e);
+ return;
+ }
setupFlushPolicies();
mixpanelConfigured = true;
};Also applies to: 199-210
🤖 Prompt for AI Agents
In app/src/utils/analytics.ts around lines 197 to 213 (also apply same fix to
199-210), replace the fragile JSON.parse(Boolean) usage and unguarded calls with
a defensive implementation: coerce ENABLE_DEBUG_LOGS to a boolean safely (e.g.,
check typeof ENABLE_DEBUG_LOGS !== 'undefined' ?
String(ENABLE_DEBUG_LOGS).toLowerCase() === 'true' : false), verify
NativeModules.PassportReader exists and has a configure function before calling
it, wrap the configure call and setupFlushPolicies() in a try/catch to log any
errors without throwing, and only set mixpanelConfigured = true after a
successful configure call.
| export const flushAllAnalytics = () => { | ||
| // Flush Segment analytics | ||
| const { flush: flushAnalytics } = analytics(); | ||
| flushAnalytics(); | ||
|
|
||
| // Flush Mixpanel events | ||
| flushMixpanelEvents(); | ||
| }; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Make flushAllAnalytics async and await both Segment and Mixpanel flushes at critical points.
Ensures durability before Sentry logging/navigation as per PR objectives.
-export const flushAllAnalytics = () => {
+export const flushAllAnalytics = async () => {
// Flush Segment analytics
const { flush: flushAnalytics } = analytics();
- flushAnalytics();
+ await Promise.resolve(flushAnalytics());
// Flush Mixpanel events
- flushMixpanelEvents();
+ await flushMixpanelEvents();
};📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| export const flushAllAnalytics = () => { | |
| // Flush Segment analytics | |
| const { flush: flushAnalytics } = analytics(); | |
| flushAnalytics(); | |
| // Flush Mixpanel events | |
| flushMixpanelEvents(); | |
| }; | |
| export const flushAllAnalytics = async () => { | |
| // Flush Segment analytics | |
| const { flush: flushAnalytics } = analytics(); | |
| await Promise.resolve(flushAnalytics()); | |
| // Flush Mixpanel events | |
| await flushMixpanelEvents(); | |
| }; |
🤖 Prompt for AI Agents
In app/src/utils/analytics.ts around lines 219 to 226, flushAllAnalytics is
currently synchronous and calls Segment's flush and Mixpanel flush without
awaiting them; change flushAllAnalytics to be async, await the Segment flush
(use the returned promise from analytics().flush) and await the Mixpanel flush
(ensure flushMixpanelEvents returns a promise or wrap it in a Promise) so both
flushes complete before returning — update any callers to await
flushAllAnalytics where durability is required.
* SDK Go version (#920) * feat: helper functions and constant for go-sdk * feat: formatRevealedDataPacked in go * chore: refactor * feat: define struct for selfBackendVerifier * feat: verify function for selfBackendVerifier * feat(wip): custom hasher * feat: SelfVerifierBacked in go * test(wip): scope and userContextHash is failing * test: zk proof verified * fix: MockConfigStore getactionId function * chore: refactor * chore: remove abi duplicate files * chore: move configStore to utils * chore: modified VcAndDiscloseProof struct * chore: more review changes * feat: impl DefaultConfig and InMemoryConfigStore * chore: refactor and export functions * fix: module import and README * chore: remove example folder * chore: remove pointers from VerificationConfig * chore: coderabbit review fixes * chore: more coderabbit review fix * chore: add license * fix: convert attestationIdd to int * chore: remove duplicate code --------- Co-authored-by: ayman <[email protected]> * Moving proving Utils to common (#935) * remove react dom * moves proving utils to the common * need to use rn components * fix imports * add proving-utils and dedeuplicate entry configs for esm and cjs. * must wrap in text component * fix metro bundling * fix mock import * fix builds and tests * please save me * solution? * fix test * Move proving inputs to the common package (#937) * create ofactTree type to share * move proving inputs from app to register inputs in common * missed reexport * ok * add some validations as suggested by our ai overlords * Fix mock passport flow (#942) * fix dev screens * add hint * rename * fix path * fix mobile-ci path * fix: extractMRZ (#938) * fix: extractMRZ * yarn nice && yarn types * fix test: remove unused * fix mobile ci * add script --------- Co-authored-by: Justin Hernandez <[email protected]> * Move Proving attest and cose (#950) * moved attest and cose utils to common with cursor converted tests in common to use vitest and converted coseVerify.test to vitest after moving from app to common what does cryptoLoader do? * moved away * get buff Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * SELF-253 feat: add user email feedback (#889) * feat: add sentry feedback * add sentry feedback to web * feat: add custom feedback modal & fix freeze on IOS * yarn nice * update lock * feat: show feedback widget on NFC scan issues (#948) * feat: show feedback widget on NFC scan issues * fix ref * clean up * fix report issue screen * abstract send user feedback email logic * fixes * change text to Report Issue * sanitize email and track event messge * remove unnecessary sanitization * add sanitize error message tests * fix tests * save wip. almost done * fix screen test * fix screen test * remove non working test --------- Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> * chore: centralize license header checks (#952) * chore: centralize license header scripts * chore: run license header checks from root * add header to other files * add header to bundle * add migration script and update check license headers * convert license to mobile sdk * migrate license headers * remove headers from common; convert remaining * fix headers * add license header checks * update unsupported passport screen (#953) * update unsupported passport screen * yarn nice * Migrate Analytics (#951) * setup analytics adapter for self mobile sdk client and use in app * wrap for context * fix build * yarn types is an alias for build when build just compiles ts * ok unlock * deeper * ok this looks to work * fix license check * make sure it starts with this line * someone didnt commit * fix double analytics bug and builds * lint * Read document catalog from selfClient (#936) * [SELF-676] feat: upgrade React Native from 0.75.4 to 0.76.9 (#943) * chore: upgrade build tooling to Node 22 and AGP 8.6 * chore: upgrade react-native to 0.76.9 * update lock files and formatting * fix path * fix: handle hermes-engine cache mismatch in CI after React Native upgrade - Add fallback logic to run 'pod update hermes-engine' when pod install fails - This resolves CocoaPods cache issues that occur after React Native version upgrades - Fixes CI pipeline failures on codex/update-core-tooling-for-react-native-upgrade branch * fix: improve hermes-engine cache handling in CI - Preemptively clear CocoaPods cache before pod install - This prevents dependency analysis failures that occur when cached podspecs conflict - Addresses the root cause: cache conflicts during 'Analyzing dependencies' phase - Keeps fallback logic for additional safety * fix: handle hermes-engine cache in mobile-bundle-analysis workflow - Add pod-install-with-cache-fix.sh script to handle hermes-engine cache conflicts - Update install-app:setup script to use the new cache fix approach - This fixes the mobile-bundle-analysis.yml workflow failures after React Native upgrade - Proactively clears CocoaPods cache and has fallback for hermes-engine updates * formatting * fix: robust hermes-engine cache handling in CI workflows - Apply comprehensive cache clearing to mobile-ci.yml and mobile-e2e.yml - Pre-emptively run 'pod update hermes-engine' before pod install - Clear multiple cache locations to handle CI environment differences - This prevents 'hermes-engine differs from Pods/Local Podspecs' errors - Fixes all workflows affected by React Native 0.76.9 upgrade cache issues * fixes * clean up * update lock files * fix tests * sort * fixes * fix ci * fix deployment target * android fixes * upgrade fix * fixes * fix: streamline mobile CI build and caching (#946) * fix: streamline mobile CI build and caching * Enable mobile E2E tests on codex/fix-mobile-ci-workflow-errors branch * test * simplify and fix path * workflow fixes * fix loading on 0.76.9 * clean up unnecessary comments * fix readme * finalize upgrade to 0.76.9 * fix android build and upgrade * fix bundler caching * download cli to fix "yarn start" issues * fix cli build erorr * fix script path * better path * abstract build step to prevent race condition * fixes * better cache * fix corepack build error * update lock * update lock * add yarn cache to workflows * fix test building * ci caching improvements * fix common type check * fix common ci * better mobile sdk alpha building logic * chore: speed up mobile e2e workflow (#962) * chore: speed up mobile e2e workflow * chore: disable android e2e job * chore: speed up ios build * fix: bundle js for ios debug build * fix e2e * fix mobile ci (#964) * feat: improve mixpanel flush strategy (#960) * feat: improve mixpanel flush strategy * fixes * fix build * update lock * refactor methods * conslidate calls * update package and lock * refactor: remove namespace imports (#969) * refactor: remove namespace imports * refactor: use named fs imports * refactor(app): replace path and fs namespace imports * format * format * Mixpanel tweaks (#971) * udpates * fox * update license * Add DSC parsing check (#836) * Handle missing dsc parsed * nice * fix test * throw * fix * chore(app): upgrade dependencies (#968) * chore(app): upgrade dependencies * update package * update lock files * fixes * lock * fix * Auth Adapter + (#958) * basic auth adapater * remove SelfMobileSDk, this was another architecture which the adapter patern replaced * rename to avoid confusion with client.test.ts * basic auth adapater * remove SelfMobileSDk, this was another architecture which the adapter patern replaced * rename to avoid confusion with client.test.ts * self * fix * remove prototypes * make sure its mounted * fix tests * fmt * require required adapters * fix types * not a partial * adds missing exports * fix missing data * Fix nfc configuration scanning issue (#978) * fix nfc scanning on ios and android * save test * fix tests * fix lint * Chore fix ios nfc scanning and compiling (#979) * fixes * silence error * fix debugge * fix nfc scanning * lint and pipeline fixes * large runner (#980) * chore: update to macos latest large runner (#981) * bump up to macos-latest-large * fix ci * Move loadSelectedDocument to SDK (#967) Co-authored-by: Aaron DeRuvo <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * docs: update mobile SDK migration progress (#982) * docs: record app integration progress * docs: consolidate mobile SDK migration tracking * docs: humanize migration tracking and merge prompts * docs: add common consolidation tasks * docs: reprioritize migration tasks * docs: soften migration plan tone * docs: detail agent prompts with file paths * docs: catalog Linear tasks for SDK * updates * remove artifact management * moves validateDocument functions into the common package. (#977) * moves validateDocument functions into the common package. * fix build issues and lint * handle bad connections better in nullifiier * add an abort controler to nullifer fetcher, ignore fals positives * import types separately * take it as an arg * chore: update yarn.lock * chore(app): resolve lint warnings (#990) * chore(app): resolve lint warnings * update lock * clean up any types * fix types * feedback from cr * [SELF-703] feat: Migrate mock generator to mobile sdk (#992) * feat: expose mock generator * formatting * fix tests and lint * rename passport to document * fix types * [SELF-698] scaffold mobile sdk demo app (#993) * chore: scaffold mobile sdk demo app * test: cover demo app menu * prettier and types * sort * add android app foundation * fix android loading * get ios app running * update script * cr feedback * disable fabric * fixes * fixes * fix * SELF-702: Refactor navigation structure and dev utilities (#994) * Refactor navigation and dev screens * refactor: rename passport screens to document * fixes * add missing header * fixes * type files * feat: clarify proof verification analytics (#996) * feat: increase sha256 byte size and add new rsa circuits (#986) * feat: increase sha256 byte size and add new rsa circuits * feat: modularise the rsa fp pow mod * chore: comment signature verifier for testing * fix: sha256_sha256_sha224_ecdsa_secp224r1 * lint * chore: implement google play suggestions (#997) * google play suggestions * update gitguardian ignore * remove unused * chore: address yarn lock issues (#1004) * address yarn lock issues * fix postinstall * skip postinstall for ci (#1005) * [SELF-654] feat: add native modules (#919) * feat: add ios native modules * fix: extractMRZ * Add android OCR native module * wire native mrz module with adapter * wire Native modules and fix tests * fixes * fix license header logic * fix tests * fix types * fix: ci test * fix: android build ci * fix: ios build CI * add podfile.lock * add yarn.lock * update lock files * add yarn.lock * add license * order methods * update lock * pipeline fixes * prettier * update lock file * fix native modules on external apps * bundle @selfxyz/common into mobile-sdk-alpha * chore: address yarn lock issues (#1004) * address yarn lock issues * fix postinstall * update lock * fix build issues * fix pipeline issue * fix ci * fix bad merge * fix android ci * fix ci errors * fix mobile sdk ci. stop gap fix for now until we create a package * tweaks * retry aapt2 approach * use ^0.8.4 instead of ^0.8.0 due to the use of custom errors * workflow fixes * fix file * update * fix ci * test ci fix * fix test --------- Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> * chore: update dev with staging 09/06/25 (#1007) * update CI * bump iOS version * update readme * update mobile-deploy ci * bump version iOS * update workflow to use workload identity federation (#933) * update workflow to use workload identity federation * add token permissions * correct provider name * chore: incrementing android build version for version 2.6.4 [github action] --------- Co-authored-by: Self GitHub Actions <[email protected]> * update ci * update ci * update ci * update ci * update ci * fix ci * fix ci * fix ci * remove fastlane use for android * bump iOS build version * update CI python script * iterate on CI * iterate on CI * iterate on CI * Dev (#941) * SDK Go version (#920) * feat: helper functions and constant for go-sdk * feat: formatRevealedDataPacked in go * chore: refactor * feat: define struct for selfBackendVerifier * feat: verify function for selfBackendVerifier * feat(wip): custom hasher * feat: SelfVerifierBacked in go * test(wip): scope and userContextHash is failing * test: zk proof verified * fix: MockConfigStore getactionId function * chore: refactor * chore: remove abi duplicate files * chore: move configStore to utils * chore: modified VcAndDiscloseProof struct * chore: more review changes * feat: impl DefaultConfig and InMemoryConfigStore * chore: refactor and export functions * fix: module import and README * chore: remove example folder * chore: remove pointers from VerificationConfig * chore: coderabbit review fixes * chore: more coderabbit review fix * chore: add license * fix: convert attestationIdd to int * chore: remove duplicate code --------- Co-authored-by: ayman <[email protected]> * Moving proving Utils to common (#935) * remove react dom * moves proving utils to the common * need to use rn components * fix imports * add proving-utils and dedeuplicate entry configs for esm and cjs. * must wrap in text component * fix metro bundling * fix mock import * fix builds and tests * please save me * solution? * fix test * Move proving inputs to the common package (#937) * create ofactTree type to share * move proving inputs from app to register inputs in common * missed reexport * ok * add some validations as suggested by our ai overlords * Fix mock passport flow (#942) * fix dev screens * add hint * rename * fix path * fix mobile-ci path * fix: extractMRZ (#938) * fix: extractMRZ * yarn nice && yarn types * fix test: remove unused * fix mobile ci * add script --------- Co-authored-by: Justin Hernandez <[email protected]> * Move Proving attest and cose (#950) * moved attest and cose utils to common with cursor converted tests in common to use vitest and converted coseVerify.test to vitest after moving from app to common what does cryptoLoader do? * moved away * get buff Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * SELF-253 feat: add user email feedback (#889) * feat: add sentry feedback * add sentry feedback to web * feat: add custom feedback modal & fix freeze on IOS * yarn nice * update lock * feat: show feedback widget on NFC scan issues (#948) * feat: show feedback widget on NFC scan issues * fix ref * clean up * fix report issue screen * abstract send user feedback email logic * fixes * change text to Report Issue * sanitize email and track event messge * remove unnecessary sanitization * add sanitize error message tests * fix tests * save wip. almost done * fix screen test * fix screen test * remove non working test --------- Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> * chore: centralize license header checks (#952) * chore: centralize license header scripts * chore: run license header checks from root * add header to other files * add header to bundle * add migration script and update check license headers * convert license to mobile sdk * migrate license headers * remove headers from common; convert remaining * fix headers * add license header checks * update unsupported passport screen (#953) * update unsupported passport screen * yarn nice --------- Co-authored-by: Vishalkulkarni45 <[email protected]> Co-authored-by: ayman <[email protected]> Co-authored-by: Aaron DeRuvo <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: Seshanth.S🐺 <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * bump version * bump yarn.lock * update ci (#966) * chore: Manually bump and release v2.6.4 (#961) * update lock files * bump and build android * update build artifacts * show generate mock document button * update lock * fix formatting and update failing e2e test * revert podfile * fixes * fix cold start of the app with deeplink * update ci * update ci * Sync MARKETING_VERSION to iOS project files after version bump * chore: incrementing android build version for version 2.6.4 [github action] (#976) Co-authored-by: remicolin <[email protected]> * chore: add build dependencies step for iOS and Android in mobile deploy workflow * chore: enhance mobile deploy workflow by adding CMake installation step * bump android build version * chore: incrementing android build version for version 2.6.4 [github action] (#985) Co-authored-by: remicolin <[email protected]> * chore: configure Metro bundler for production compatibility in mobile deploy workflow * chore: incrementing android build version for version 2.6.4 [github action] (#987) Co-authored-by: remicolin <[email protected]> * Revert "chore: configure Metro bundler for production compatibility in mobile deploy workflow" This reverts commit 60fc1f2580c2f6ad3105d8b904d969412a18bd2e. * reduce max old space size in mobile-deploy ci * fix android french id card (#957) * fix android french id card * fix common ci cache * feat: log apdu (#988) --------- Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: Seshanth.S🐺 <[email protected]> * unblock ci * fix merge * merge fixes * fix tests * make ci happy --------- Co-authored-by: turnoffthiscomputer <[email protected]> Co-authored-by: pputman-clabs <[email protected]> Co-authored-by: Self GitHub Actions <[email protected]> Co-authored-by: turnoffthiscomputer <[email protected]> Co-authored-by: Vishalkulkarni45 <[email protected]> Co-authored-by: ayman <[email protected]> Co-authored-by: Aaron DeRuvo <[email protected]> Co-authored-by: Seshanth.S🐺 <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * chore: fix yarn format (#1009) * fix yarn format * yarn format * fix lint * undo temporary disabling * pipeline fixes * revert nvmrc change * add new home screen (#1019) * add new home screen * fix typing issue * yarn nice * chore: update the cpp build script (#1021) * chore: install node (#1022) * chore: use node v22 (#1023) * chore: install yarn (#1024) * chore: yarn cache (#1025) * chore: sanitise node version (#1026) * remove lazy loading (#1018) * remove lazy loading * fix tests * formatting * fix imports and web ci * fix tests * fix building * fix * debug ci * fix web ci issue * fix * fix * fix ci * remove web render test * coderabbit feedback * fix ci * use import * fix lint * fix compiling * update lock * update lock * fix: update yarn.lock hash for @selfxyz/mobile-sdk-alpha Resolves CI error where yarn install --immutable failed due to outdated package hash. The hash changed from b2afc4 to f9ebb9. * fix: update yarn.lock hash after mobile-sdk-alpha changes - Hash changed from c0e6b9 to 0d0f72 due to package modifications - Cleaned caches and regenerated lockfile to ensure consistency - This resolves CI cache mismatch where old artifacts had stale hash * fix: update yarn.lock hash after building mobile-sdk-alpha - Final hash: 89f5a6 (includes built dist artifacts) - Built mobile-sdk-alpha to ensure package is in stable state - This should resolve CI immutable install errors * fix yarn lock and build * chore(ci): improve mobile e2e caching (#1010) * chore(ci): improve mobile e2e caching * chore(ci): restore deriveddata cache * chore(ci): remove ios deriveddata cache * chore(ci): cache ios derived data * chore(ci): optimize mobile deploy caching * chore(ci): enable ccache for ios e2e builds * fix(ci): add ccache path for ios e2e * moves ofac and protocol store (#1012) * move ofact tree fetch to common * move protocol store to the msdk, fix some dependencies on msdk * chore: remove register id from register circuits (#1028) * chore: remove register id from register circuits * chore: only use 128ram instance * Feat/build cpp (#1029) * chore: remove register id from register circuits * chore: only use 128ram instance * chore: build 2 circuits at a time * Remove navigationRef from provingMachine (#1011) * SDK: minimize amount of data sent through PROVING_PASSPORT_NOT_SUPPORTED event (#1030) * Fix mock passport generation (#1031) * fix mock passport generation * fix mobile ci tests * Feat/aadhaar (#949) * make contract sdk simpler (#514) * make contract sdk simpler * reduce root inputs * delete convert function * summarize our library * update npm package * update package version * update attestation id * add util function to get revealed data * Revert "make contract sdk simpler (#514)" (#518) This reverts commit 847b88d5ecc0d449b976a552f68af38eec8e561b. * merge dev into main (#576) * Feat: Show error code in SDK (#500) * feat: emit `error_code` and `reason` in app * feat: add `onError` in sdk * feat: Display reason in app * lint & fmt * feat: add scrollview in ProofRequestStatusScreen for long reasons * Fix input generation for 521bit curves (#481) * fix EC point padding for 521 bit curves * rename modulus to point in findStartIndexEC as it is a point * simplify matching logic * simplify padding logic * remove comment * remove log removing .only so the CI/CD runs circuit tests fix disclosure test fix scope in test fix scope error in circuit tests remove .only fix test * run ci/cd * Feat/simpler contract sdk (#519) * make contract sdk simpler * reduce root inputs * delete convert function * summarize our library * update npm package * update package version * update attestation id * add util function to get revealed data --------- Co-authored-by: motemotech <[email protected]> * forgot to include package update (#521) * Bump version to 2.5.1 (#522) * bump version * update fastlane * fix bump version * bump build and add todo * disable commit for now * [SEL-154] Step 1: Scan your passport (#511) * simplify navigation logic * use aesop design hook * save wip * add new aesop redesign screens * save wip design * refactor nav bar logic * fix paths * save wip * stub progress navbar and save wip * save wip progress bar animation * save wip progress bar, almost done with design * fix progress bar design * fix bottom padding * disable git commit for now * fix flaky android downloads that causes pipeline to crash * update lock for ci * [SEL-46] FE: Add minimum bottom padding (#510) * fix bottom padding for smaller screens * fix podfile post install hook permissions check * update pod lock and disable git commit action step for now * update lock * fix flaky android downloads that causes pipeline to crash * fix: improve error handling for forbidden countries list mismatch (#494) * Update SelfBackendVerifier.ts * Update constants.ts * Update formatInputs.ts * Update formatCallData.ts * DX: Auto format on save (#526) * save wip * use elint instead of prettier to sort imports * set imports to warn * sync prettier settigns * update prettier settings * save working version * fix export and disable mobile pipeline for now * limit auto formatting to the app folder * remove artefacts * SEL-187: Make bottom layout scrollable on smaller screens (#525) * fix design check * add an option to disable local sending of sentry events * better sentry enable / disable * fix scan passport height * make bottom layout scrollable so it doesn't squish top screen * simpler logic check. don't create new env var * fix internet connection issues * readd comment * use isConnected instead of internet reachable * use a dynamic bottom panel height * add missing recovery screens * move aesop below * remove dupe export * fix rebase * fix android package download issue * Feat/extend id support (#517) * refactor proving impleting xstate, speedup proving * add disclosure proof support * keep refactoring provingMachine, clean old implementation * call init method when switching from dsc to register * rebase with dev to display why the proof verification failed * refactor ws connexion between front-end and mobile to retrieve self-app * update the webclient at proofVerification and use selfAppStore in provingMachine * fix provintStore.init in ProveScreen * yarn nice * fetch data correctly in splash screen * Bump build versions for 2.5.1 (#531) * release new builds * fix app and build versions * fix env check * display error animation on failure on loading screen (#532) * display error animation on failure on loading screen * remove log --------- Co-authored-by: Justin Hernandez <[email protected]> * ci: bump actions/checkout to v4 (#529) * make contract sdk simpler (#514) * make contract sdk simpler * reduce root inputs * delete convert function * summarize our library * update npm package * update package version * update attestation id * add util function to get revealed data * Revert "make contract sdk simpler (#514)" (#518) This reverts commit 847b88d5ecc0d449b976a552f68af38eec8e561b. * ci: bump actions/checkout to v4 --------- Co-authored-by: nicoshark <[email protected]> Co-authored-by: turnoffthiscomputer <[email protected]> * fix italy (#530) * Fix/proving machine endpoint type (#538) * store endpoint type in proving machine * yarn nice * fix splash screen error (#539) * New bug fix build for v2.5.1 (#540) * bump new build for dev fixes * update lock * reinstall before running local deploy * SEL-178: Improve haptic feedback library (#535) * fix dev settings typing * add dev screens file * save haptic feedback progress * change ordedr * fix initial route and add haptic feedback screen to dev settings options * add delete scripts (#542) * update staging registry address (#545) * feat: Add Disclose history (#533) * feat: Add Disclose history * fix: Duplicate history in list * fix: Outdated disclosures * Delete app/ios/Self copy-Info.plist * allow a scale of up to 1.3 (#546) * allow a scale of up to 1.3 * update lock files * clean up unused imports * fix settings * add common sdk (#537) * add common sdk * remove sdk backend api * remove registry * regenerate sha256 rsa dsc each time * download ski-pem dynamically on staging, refactor initpassportDataParsing * add state machine for button on prove screen, improve ux on splash screen * fetch ski-pem in production * fix linter issues * fix prove screen button bugs * update podfile.lock and yarn.lock * run linter in circuits repo * bump build * bump version for sentry debugging * bump ios to version 118 --------- Co-authored-by: Justin Hernandez <[email protected]> * better connection check (#548) * Clean up navigation and setup Jest (#549) * remove dupe account screens and prefer the term home * organize screen loading better * sort keys * rename screen files wip * fix deleted directory issues * rename folders * fix paths and naming * save working jest import test * save base working jest navigation test * finalize navigation refactor and jest test * update test name and podfile lock * remove unused packages * use the correct version of react test renderer * bump build (#552) * Eth dublin (#554) * add mock id card generator * add genMockIdDoc in common/sdk exports * onboard developer id using deeplink, allow custom birthdate on mockpassport * log more dsc info (#558) * Push notification (#536) * add push notification feature * merge new app impl * change dsc key * import * reverse mock dsc * worked in the ios * checked in android * update url and delete console * delete small changes * lint * add yarn.lock * fix warning message * add mock notification service for test code * fix path for the mock implementation * add mock deeplink to the test code * nice notificationServiceMock.js * delete unused firebase related implementation * fix wording and UI related to notification service * hotfix on mockdatascreen --------- Co-authored-by: turnoffthiscomputer <[email protected]> * Fix deeplink 2 (#560) * fix deeplink * fix deeplink * yarn nice * feat: Use vision for MRZ scanning (SEL-47) (#557) * feat: Use vision for MRZ scanning * modify label to position the smartphone during the OCR scan --------- Co-authored-by: turnoffthiscomputer <[email protected]> * SEL-255: improved loading screen with estimated wait times (#550) * create new loading screen and rename static to misc * fix route * save wip loading screen * save wip animation * save static wip design * continue * splash * add a loading screen text helper * add test for loading screen text * save wip. almost there * update haptic logic * better feedback and add dev scren * save current work * update text logic and tests * load passport metadata in loading screen * simplify and fix tests * test for additional exponents * add new animation * rename file * consolidate ui useEffect and fix loading screen layout * fix current state * remove mockPassportFlow param * merge new loading screen and new notification logic * simplify * update lock * use passportMetadata instead of metadata * save simplification * update loading text based on pr feedback and tests * Bump v2.5.1: ios 122; android 60 (#561) * increment build to 120 * bump builds for 2.5.1. ios 121; android 60 * clean up logic * upgrade react native firebase for privacy manifests * update react native keychain to fix could not recover issue (#564) * fix: update ocr corrections (#563) * Chore: Polish proof history to prep for release (#566) * clean up nav and home boundaries, passport data screen insets * migrate proof history screen out of settings * minor clean up * save wip * add new ibm plex mono font and clean up proof detail screen * remove test data * remove extra loading screen text * remove unnecessary ceil * Bump v2.5.1; ios 123; android 62 (#565) * bump to build 61 * bump ios version * update version * Feature/add prettier formatter (#568) * Add Prettier configuration and ignore files for code formatting - Created .prettierignore to exclude specific directories and files from formatting. - Added .prettierrc.yml with custom settings for print width and trailing commas. - Updated package.json to include Prettier and its Solidity plugin as dependencies, along with scripts for formatting and checking code. * Run prettier formatting * fix nationality using mock passports * SEL-181 & SEL-252: Update mobile app events (#570) * improve analytics handling * add error boundary that flushes segment events before error occurs * upgrade segment analytics package * flush analytics when user encounters error screen * track all click events * add tracking to loading screen * better init and click event names * track cloud backup and modal actions * use __DEV__ for debugging * add tracking to account recovery, auth, mock data * return false instead of throwing * add more tracking events * save wip event updating * abstract analytic event names * update click events * clean up * move reasons comment * add unsupported passport event * Feature/enhance self verification root (#569) * Add SelfVerificationConsumer contract for self-verification logic - Introduced an abstract contract, SelfVerificationConsumer, that extends SelfVerificationRoot. - Implemented nullifier tracking, verification success events, and customizable validation and update methods for nullifiers. - Added error handling for nullifier check failures and hooks for derived contracts to implement custom logic after successful verification. * Add SelfHappyBirthday contract example using SelfVerificationConsumer - Introduced SelfHappyBirthday contract that allows users to claim USDC on their birthday. - Integrated SelfVerificationConsumer for handling verification and nullifier tracking. - Added functions to set claimable amount and window, along with event emissions for state changes. - Implemented logic to check if the claim is within the user's birthday window and transfer USDC accordingly. * Refactor imports in HappyBirthday contract for better organization - Updated import statements in HappyBirthday.sol to use relative paths for ISelfVerificationRoot, SelfCircuitLibrary, and SelfVerificationConsumer. - Improved code readability and maintainability by organizing imports more logically. * Refactor Airdrop contract to use SelfVerificationConsumer for registration logic - Updated Airdrop contract to inherit from SelfVerificationConsumer instead of SelfVerificationRoot. - Refactored mappings for user identifiers and nullifiers for improved clarity and functionality. - Enhanced error handling and updated function parameters for consistency. - Implemented new validation and update methods for nullifiers, streamlining the registration process. - Removed deprecated verifySelfProof function and integrated logic into new methods. * Add events and refactor SelfVerificationRoot and related contracts - Introduced new events in SelfVerificationRoot for verification configuration updates, scope changes, and attestation ID management. - Updated Airdrop contract to remove deprecated events and added a new event for Merkle root updates. - Refactored SelfPassportERC721 to inherit from SelfVerificationConsumer, enhancing verification logic and event handling. - Improved function parameters for consistency and clarity across contracts. * Refactor contracts to use SelfVerificationRoot and enhance verification logic - Removed SelfVerificationConsumer contract and updated related contracts to inherit from SelfVerificationRoot. - Refactored mappings and event emissions in Airdrop, HappyBirthday, and SelfPassportERC721 for improved clarity and functionality. - Enhanced verification success hooks to include user identifiers and nullifiers for better tracking. - Updated constructor parameters for consistency across contracts and improved error handling for user registration and claims. * Refactor constructor in SelfPassportERC721 for improved readability * Refactor function parameters in SelfVerificationRoot and related contracts * Refactor constructor parameter names in IdentityVerificationHub, Airdrop, IdentityRegistry, and ProxyRoot contracts for improved clarity and consistency * fix getCircuitName function (#575) * fix getCircuitName function * fix getCircuitName function * feat: Read ID cards (#571) * Update GitHub checkout action from v3 to v4 (#544) * Bump build version 2.5.2 to test react native keychain (#572) * bump build and version * bump version 2.5.2 * don't downgrade react native keychain * update app/README.md toolchain instructions (#140) * bump build (#580) --------- Co-authored-by: Seshanth.S🐺 <[email protected]> Co-authored-by: turboblitz <[email protected]> Co-authored-by: motemotech <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: crStiv <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: James Niken <[email protected]> Co-authored-by: Kevin Lin <[email protected]> Co-authored-by: leopardracer <[email protected]> Co-authored-by: Olof Andersson <[email protected]> * feat(wip): register circuit for aadhaar * chore: add anon aadhar circuits * chore: remove sc and disclose selfrica test * feat: extract aadhaar qr data * test: aadhaar qr data extract circuit * test: aadhaar register circuit * feat: extract pincode and ph no last 4 digit * fix: register aadhaar nullifier and commitment * test: Verify commitment circuit of aadhaar * feat: add photoHash inside commitment * feat: build Aadhaar OFAC SMT * feat: ofac check and reveal data (test done) * test: qr extractor for custom data input * feat: add state as reveal data inside VC and disclose * chore: add comments * fix: num2Ceil component * chore: review changes * chore: use passport SignatureVerifier * fix: signatureVerifier inputs * feat: extract ascii values of fields * feat: provide users the flexibility to reveal specific characters of a field * chore: refactor * test: register aadhaar for tampered data * test(wip): should return 0 if in ofac list * test: ofac check * test: register aadhaar circuit for different qr data * merge dev into main (#683) * remove sdk/tests (#622) * remove sdk/tests * chore: update yarn.lock --------- Co-authored-by: Ayman <[email protected]> * fix: add range check on paddedInLength of shaBytesDynamic (#623) * fix ci (#626) * implement self uups upgradeable (#592) * implement self uups upgradeable * small changes in identityVerificationHubImplV2 * delete aderyn.toml * chore: add custom verifier * chnage return output * feat: use self structs and a Generic output struct * feat: add userIdentifier, nullifier, forbiddencountries to returned output * add root view functions from registry * fix: build and compilation errors * add userDefined data into selfVerificationRoot * "resolve conflicts" * fix compilation problem * fix how to register verification config * test: CustomVerifier * fix verification root and hub integration * add scope check in hub impl * replace poseidon hash to ripemd+sha256 * add todo list * feat: refactor and add test cases for generic formatter * add performUserIdentifierCheck in basicVerification * change how to handle additionalData and fix stack too deep * start adding test codes * fix dependency problems in monorepo * fix: forbidden countries (#612) LGTM! * able to run test code * pass happy path * delete unused codes * change error code name, add caller address validation and add scripts to run test and build in monorepo * add all test cases in vcAndDisclose flow * remove comment out * chore: use actual user identifier outputs * success in registration tests * cover all cases * pass contractVersion instead of circuitVersion * fix disclose test * chore: add natspecs for ImplHubV2, CustomVerifier and GenericFormatter * change val name and remove unused lines * add val name change * remove userIdentifier from return data * feat: use GenericDiscloseOutput struct in verfication hook fix test cases for user identifier * chore: change the function order for Hub Impl V2 (#625) * fix nat specs * add nat spec in SelfStructs --------- Co-authored-by: Ayman <[email protected]> Co-authored-by: Nesopie <[email protected]> * prettier (#629) * CAN auth - android (#613) * add missed files * add NFCMethodSelectionScreen * bump android build --------- Co-authored-by: Justin Hernandez <[email protected]> * feat: add MRZ correction method to NFCMethodSelectionScreen (#627) * add npm auth token env (#632) * bump sdk version (#633) * publish npm package when merging on dev * bump common sdk version * replace yarn publish by npm publish * update common package version * Simplify dev mode gesture (#635) * Simplify developer mode gesture * Enable dev mode on MockData screen with five taps * add build smt function to common sdk * update vc_and_disclose_id test (dev branch) (#641) * fix: vc_and_disclose_id test * chore: yarn prettier * Show modal on NFC scan error (#642) * Add help button and error modal actions * fix the screen management * yarn nice * Bump build v2.5.4: ios 132; android 71 (#631) * bump version and build numbers * remove tamagui/toast * fix marketing version * fix: update TD1 and TD3 checks (#643) * bum yarn.lock * Bump build: ios 133; android 72 and build fixes (#654) * update gesture version and bump android build * bump and fix ios build * update lock files * fixes * fix fotoapparat library source * Update example contracts to include EUID usage (#656) * refactor: update HappyBirthday contract to V2 with support for E-Passport and EUID cards, introduce bonus multipliers, and enhance verification logic * refactor: update Airdrop contract to V2 with support for E-Passport and EU ID Card attestations * refactor: remove BASIS_POINTS constant from Airdrop contract * feat: introduce SelfIdentityERC721 contract for issuing NFTs based on verified identity credentials, replacing SelfPassportERC721 * fix: update verification functions in Airdrop, HappyBirthday, and SelfIdentityERC721 contracts to use customVerificationHook * cherry pick commit from add-test-self-verification... * block non-dev pr to main branch * audit fixes (#645) * merge dev branch into main (#624) * remove sdk/tests (#622) * remove sdk/tests * chore: update yarn.lock --------- Co-authored-by: Ayman <[email protected]> * fix: add range check on paddedInLength of shaBytesDynamic (#623) * fix ci (#626) --------- Co-authored-by: Ayman <[email protected]> Co-authored-by: Vishalkulkarni45 <[email protected]> * update contracts (#628) * remove sdk/tests (#622) * remove sdk/tests * chore: update yarn.lock --------- Co-authored-by: Ayman <[email protected]> * fix: add range check on paddedInLength of shaBytesDynamic (#623) * fix ci (#626) * implement self uups upgradeable (#592) * implement self uups upgradeable * small changes in identityVerificationHubImplV2 * delete aderyn.toml * chore: add custom verifier * chnage return output * feat: use self structs and a Generic output struct * feat: add userIdentifier, nullifier, forbiddencountries to returned output * add root view functions from registry * fix: build and compilation errors * add userDefined data into selfVerificationRoot * "resolve conflicts" * fix compilation problem * fix how to register verification config * test: CustomVerifier * fix verification root and hub integration * add scope check in hub impl * replace poseidon hash to ripemd+sha256 * add todo list * feat: refactor and add test cases for generic formatter * add performUserIdentifierCheck in basicVerification * change how to handle additionalData and fix stack too deep * start adding test codes * fix dependency problems in monorepo * fix: forbidden countries (#612) LGTM! * able to run test code * pass happy path * delete unused codes * change error code name, add caller address validation and add scripts to run test and build in monorepo * add all test cases in vcAndDisclose flow * remove comment out * chore: use actual user identifier outputs * success in registration tests * cover all cases * pass contractVersion instead of circuitVersion * fix disclose test * chore: add natspecs for ImplHubV2, CustomVerifier and GenericFormatter * change val name and remove unused lines * add val name change * remove userIdentifier from return data * feat: use GenericDiscloseOutput struct in verfication hook fix test cases for user identifier * chore: change the function order for Hub Impl V2 (#625) * fix nat specs * add nat spec in SelfStructs --------- Co-authored-by: Ayman <[email protected]> Co-authored-by: Nesopie <[email protected]> * prettier (#629) --------- Co-authored-by: Ayman <[email protected]> Co-authored-by: Vishalkulkarni45 <[email protected]> Co-authored-by: nicoshark <[email protected]> Co-authored-by: Nesopie <[email protected]> * fix: vc_and_disclose_id test (#640) * fix: vc_and_disclose_id test * chore: yarn prettier * fix: check if a config id exists * chore: change the function where the config not set verification is happening * fix: add await * feat: add getConfigId function in SelfVerificationRoot (#650) * feat: add getConfigId function in SelfVerificationRoot * update comment --------- Co-authored-by: motemotech <[email protected]> * chore: fix ofac end index in eu id cards * chore: fix tests * fix: example contracts and tests --------- Co-authored-by: turnoffthiscomputer <[email protected]> Co-authored-by: Vishalkulkarni45 <[email protected]> Co-authored-by: nicoshark <[email protected]> * Update deployment module for Identity Verification Hub V2 with detailed documentation and library linkage for CustomVerifier. Update initialization process to reflect changes in V2 implementation, ensuring proper setup for proxy deployment. (#658) * publish npm-package (#651) * App/eu id updates (#638) * fix build issues * generate disclosure proof with euids * generate disclosure proof with euids * Eu id updates 2 (#648) * update vc_and_disclose_id test (dev branch) (#641) * fix: vc_and_disclose_id test * chore: yarn prettier * Show modal on NFC scan error (#642) * Add help button and error modal actions * fix the screen management * yarn nice * Bump build v2.5.4: ios 132; android 71 (#631) * bump version and build numbers * remove tamagui/toast * fix marketing version * fix: update TD1 and TD3 checks (#643) * bum yarn.lock * add version and user defined data --------- Co-authored-by: Vishalkulkarni45 <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: Seshanth.S🐺 <[email protected]> * remove the mock user define data * get the useridentifier as a hash from the user defined data * chore: add version and userDefinedData * feat: use the version in register / dsc proofs as well * update calculateUserIdentifierHash * yarn nice * refactor: consolidate user context data handling and update payload structure * fix typing issues on sha1 * remove console.log(sha1) * fix sha1 import * refactor: streamline userDefinedData handling and adjust payload type for circuit * refactor: update sha1 usage and enhance logging in calculateUserIdentifierHash * yarn nice * yarn lint common * use ts-ignore for sha1 import * fix app ci tests * fix typing issue * remove unused ts-ignore * cast uuid before calling generateinputs * bump qrcode version * add tsup on the qrcode sdk * fix: exports on selfxyz/qrcode * update how we define config.version * fix yarn imports * yarn format --------- Co-authored-by: Vishalkulkarni45 <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: Seshanth.S🐺 <[email protected]> Co-authored-by: Ayman <[email protected]> * Hotfix contract compile error (#660) * Fix previous rebase error * Refactor deployment module for Identity Verification Hub V2. * Fix/sdk (#652) * fix: sdk build configs * chore: SelfBackendVerifier (WIP) * feat: add custom verification * feat: consider destination chain in user defined data * chore: export attestation id * chore: export attestation id * chore: export config storage * chore: don't throw an error if the proof is not valid * chore: trim abi and rm typechain types * refactor * chore: rm unnecessary exports * 📝 Add docstrings to `fix/sdk` (#653) Docstrings generation was requested by @remicolin. * https://github.com/selfxyz/self/pull/652#issuecomment-2992046545 The following files were modified: * `sdk/core/src/utils/hash.ts` * `sdk/core/src/utils/proof.ts` * `sdk/core/src/utils/utils.ts` Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * review fixes * chore: fix package.json cjs types * chore: add minor changes to checks * feat: add InMemoryConfigStore, allIds constant and verificationResult type * chore: export Verification config * feat: change the verification config types * fix: throw issues early if verification config is null * fix: update yarn.lock file * chore: lint * fix: rm ts expect error directive * fix: contract tests * use excluded countries instead forbidden countries list * chore: change types in constnats --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update npm-publish workflow and bump core package version to 1.0.0 (#661) * update import * Update get verification config visibility (#664) * Update deployment module for Identity Verification Hub V2 to correct file paths and module name for deployment commands. * Add troubleshooting documentation for verification issues in deployHubV2.ts. Include manual verification steps and common failure reasons to assist users during deployment. * Change visibility of getVerificationConfigV2 function from internal to public in IdentityVerificationHubImplV2 contract to allow external access. * Apply BUSL v1.1 license headers to app (#665) * Add BSL license headers to app sources * prettier * fix license reference - https://spdx.org/licenses/BUSL-1.1.html * bump build: android 73 (#659) * Contracts/deploy staging (#668) * update scripts * deploy vc and disclose id * fix the deployment scripts on staging * update yarn.lock * bump ios build and version (#669) * configure coderabbitai (#670) * tweak coderabbit * bump * more thorough test spec * Apply BSL to app codebase (#639) * Clean up root license wording * Simplify SPDX header * simplify license and rename BSL to BUSL * fix merge issues * fix missing method --------- Co-authored-by: Justin Hernandez <[email protected]> * SEL-423 apply xcode build suggestions (#671) * apply recommended app settings from xcode * stick to portrait orientation and update target settings * remove app clip references * Circuit audit fixes (#644) * feat: add range checks before use of LessEqThan and SelectSubArray * fix: Num2Bits_strict to constrain virtualKey * bump core version * bump core version and fix ci * chore: use npm_auth_token in yarnrc * chroe: rm yarnrc changes * chore: update npm publish * chore: run npm publish manually * chore: change hub contract address (#675) * Update npm-publish.yml * chore: use proper secret when publishing * feat: enable publishing if workflow was triggered manually * Contracts/update verifier (#673) * update hardhat config * update vc and disclose verifier * update vc and disclose verifier script and run it * update test self verification root * update verifier * bump sdk version and use new hub address * chore: update zk-kit binary merkle root dep (#674) * refactor deployment scripts (#678) * feat: add register eu id instances (#682) * feat: add register eu id instances * feat: add new instances * chore: update scripts * chore: fix sig alg * chore: rm circuits --------- Co-authored-by: Ayman <[email protected]> Co-authored-by: Vishalkulkarni45 <[email protected]> Co-authored-by: nicoshark <[email protected]> Co-authored-by: Nesopie <[email protected]> Co-authored-by: Seshanth.S🐺 <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: Kevin Lin <[email protected]> Co-authored-by: kevinsslin <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Eric Nakagawa <[email protected]> * fix: commitment hash * fix: register aadhaar test * chore: refactor * feat: reveal data in packed bytes * feat: add constrain on delimiterIndices * feat: reveal timestamp * merge main to feat/aadhaar * fix: tests * feat: hash pubKey * feat: add registry contract * feat: Update HubImplV2 (WIP) * add functions to generate aadhaar data (WIP) * modularize aadhaar data generation (WIP) * fix(wip): register test * fix: test qr extractor * fix * chore: refactor functions * feat: add age extractor and tested * feat: add isMiniumAge check * fix: prepareAadhaarTestData func * registry contract tests * feat: registry contract tests * feat: extract fields from qr data bytes * chore: refactor mockData * feat: move minimum age to revealPackedData * feat: create a constant.ts to retrive fields from unpacked bytes * chore: refactor * fix: exports * rebase * rebase * feat: add public signal ,indices mapping * chore: add public output to indices mapping * fix:AADHAAR_PUBLIC_SIGNAL_INDICES * feat: make nullifier public * fix: nullifier cal for disclose circuits * feat: merge isMiniumAgeValid and miniumAge signal * fix: disclsoe test * feat: support for user identifier and secret * chore :refactor * feat: ofac test last name , firstname * feat: add forbidden_countries_list check * feat: add tests for aadhaar (WIP) * failing ofac tests * feat: finish contract tests * fix: merge conflicts * update the common package to be usable in circuits and contracts * lint everything * coderabbit fixes * chore: update name dob,yob aadhaar ofac tree * feat: merge ofac and reverse ofac check into one * test: merged ofac constrain * SELF-253 feat: add user email feedback (#889) * feat: add sentry feedback * add sentry feedback to web * feat: add custom feedback modal & fix freeze on IOS * yarn nice * update lock * feat: show feedback widget on NFC scan issues (#948) * feat: show feedback widget on NFC scan issues * fix ref * clean up * fix report issue screen * abstract send user feedback email logic * fixes * change text to Report Issue * sanitize email and track event messge * remove unnecessary sanitization * add sanitize error message tests * fix tests * save wip. almost done * fix screen test * fix screen test * remove non working test --------- Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> * chore: centralize license header checks (#952) * chore: centralize license header scripts * chore: run license header checks from root * add header to other files * add header to bundle * add migration script and update check license headers * convert license to mobile sdk * migrate license headers * remove headers from common; convert remaining * fix headers * add license header checks * update unsupported passport screen (#953) * update unsupported passport screen * yarn nice * feat: support new ofac trees * fix: qr extractor tests * chore: remove unassigned age signal * chore: modify timestamp func comment * fix: add constrain on photo bytes delimiter * fix: add range check on minimumAge within 2^7 * fix: range check for country not in list * chore: remove dummy constrain * fix: assert lessthan * fix: check is photoEOI valid * fix: replace maxDataLength with qrPaddedLength for valid del indices * feat: update forbidden countries in disclose and disclose id * feat: convert name to uppercase * fix: add constrain between delimiter and photoEOI * feat: support for phno len 4 and 10 * chore: hard-code attestaion_ID to 3 * feat: calculate nullifier using uppercase name * feat: add real id support * fix: rebase error * chore: refactor * add new nullifier and commitment calc * fix: reuse uppercase name from verify commitment * feat: add a function that will iterate though all pubkeys * chore: skip real id test * chore: yarn format * chore: update yarn.lock * chore: rm trailing / from import * chore: add support for issuing state * chore: linting and types * chore: rm types script from circuits * chore: add license header --------- Co-authored-by: nicoshark <[email protected]> Co-authored-by: turnoffthiscomputer <[email protected]> Co-authored-by: Seshanth.S🐺 <[email protected]> Co-authored-by: turboblitz <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: crStiv <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: James Niken <[email protected]> Co-authored-by: Kevin Lin <[email protected]> Co-authored-by: leopardracer <[email protected]> Co-authored-by: Olof Andersson <[email protected]> Co-authored-by: vishal <[email protected]> Co-authored-by: Vishalkulkarni45 <[email protected]> Co-authored-by: kevinsslin <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Eric Nakagawa <[email protected]> * fix: CLA not supported (#1027) * fix: CLA not supported * fix "yarn android" building * remove unnecessary commands --------- Co-authored-by: Justin Hernandez <[email protected]> * chore: bump app version v2.6.5 (#1034) * update gem lock * bump build and version * fix app versions * chore: fix nfc passport reader private repo access (#1042) * add internal repo pat * update nfc passport reader location * update workflows to use PAT to access NFC Passport Reader * fix ci * update logic to access private repo * build(android): support 16KB page size (#1043) * build(android): support 16KB page size * fix 16kb * update lock * chore: bump v2.6.5 for release (#1036) * bump build * update to ssh clone to fix local build * update podfile lock * fix version * Feat/build aadhaar (#1044) * feat: build aadhaar circuits as well in the ci * feat: add register aadhaar case handling * fix aadhaar register output after building the cpp circuit (#1045) * fix: metro js crypto module build issues (#1047) * fix sdk build issues * fix build error * sort and fix dependencies * add constants-browserify * feat: add new verifiers (#1049) * feat: add new verifiers * format: contracts * fix: ofac check to aadhaar (#1050) * fix: hub-v2 (#1051) * Add DisclosureVerified event for comprehensive verification tracking (#945) * Add VerificationPerformed event to track verification calls - Added VerificationPerformed event with comprehensive tracking fields - Captures requestor contract, version, attestation ID, chain ID, config ID, user identifier, output, and user data - Enhanced _executeVerificationFlow to return additional tracking data - Event emission placed after verification completion for accurate tracking * chore: run formatter * chore: rename verify event name to DisclosureVerified * move clearPassportData, markCurrentDocumentAsRegistered, reStorePassportDataWithRightCSCA to SDK (#1041) * Move self app store to mobile sdk (#1040) * chore(mobile-sdk-alpha): remove unused tslib dependency (#1053) * remove tslib -- seems unused * remove deps accidentally added to root * build file * remove unused imports (#1055) * fix: sha256 signed attr tests (#1058) * fix mock screen launch (#1059) * Hotfix: Belgium ID cards (#1061) * feat: parse belgium TD1 mrz android * feat: Parse Belgium TD1 MRZ IOS * fix: OFAC trees not found (#1060) * fix: relax OFAC tree response validation * test: cover OFAC tree edge cases * fix stateless * revert and fix types * fix tests * [SELF-723] feat: add structured NFC and Proof logging (#1048) * feat: add structured NFC logging * fix ci * Fix: add deps * logging fixes. use breadcrumbs * fix android build * update SeverityLevel * [SELF-705] feat: add proof event logging (#1057) * feat: add proof event logging * refactor: unify sentry event logging * fix types * fix mock * simplify * code rabbit feedback * fix tests --------- Co-authored-by: seshanthS <[email protected]> * skip on dev (#1063) * don't get fancy just disable (#1064) * saw it building so gonna try (#1065) * Dev (#1074) * chore: bump v2.6.5 rd2 (#1067) * commit wip version bump * remove from building * chore: update tooling dependencies (#1069) * chore: update tooling dependencies * chore: align react typings and node types * update lock * chore: minor fixes across monorepo (#1068) * small fixes * fixes * fix gesture handler error * ci fixes * fix yarn build; add workflow ci (#1075) * add new workspace ci * disable package version check for now * build before checks * format * fix in future pr * feat: add functions for disclosing aadhaar attributes (#1033) * feat: add functions for disclosing aadhaar attributes * format * chore: update monorepo artifacts (#1079) * remove unneeded artifacts, skip building circuits * update md files * cleans up unused parts of sdk interface, adds inline documentation, (#1078) * cleans up unused parts of sdk interface, adds inline documentation, * fix up build * yolo * Feat/aadhaar sdk (#1082) * feat: add aadhaar support to the ts sdk * feat: aadhaar support to go sdk * chore: refactor * move clearPassportData, markCurrentDocumentAsRegistered, reStorePassportDataWithRightCSCA to SDK (#1041) * Move self app store to mobile sdk (#1040) * chore(mobile-sdk-alpha): remove unused tslib dependency (#1053) * remove tslib -- seems unused * remove deps accidentally added to root * build file * remove unused imports (#1055) * fix: sha256 signed attr tests (#1058) * fix mock screen launch (#1059) * Hotfix: Belgium ID cards (#1061) * feat: parse belgium TD1 mrz android * feat: Parse Belgium TD1 MRZ IOS * fix: OFAC trees not found (#1060) * fix: relax OFAC tree response validation * test: cover OFAC tree edge cases * fix stateless * revert and fix types * fix tests * [SELF-723] feat: add structured NFC and Proof logging (#1048) * feat: add structured NFC logging * fix ci * Fix: add deps * logging fixes. use breadcrumbs * fix android build * update SeverityLevel * [SELF-705] feat: add proof event logging (#1057) * feat: add proof event logging * refactor: unify sentry event logging * fix types * fix mock * simplify * code rabbit feedback * fix tests --------- Co-authored-by: seshanthS <[email protected]> * skip on dev (#1063) * don't get fancy just disable (#1064) * saw it building so gonna try (#1065) * chore: bump v2.6.5 rd2 (#1067) * commit wip version bump * remove from building * chore: update tooling dependencies (#1069) * chore: update tooling dependencies * chore: align react typings and node types * update lock * chore: minor fixes across monorepo (#1068) * small fixes * fixes * fix gesture handler error * ci fixes * fix yarn build; add workflow ci (#1075) * add new workspace ci * disable package version check for now * build before checks * format * fix in future pr * feat: add functions for disclosing aadhaar attributes (#1033) * feat: add functions for disclosing aadhaar attributes * format * chore: update monorepo artifacts (#1079) * remove unneeded artifacts, skip building circuits * update md files * chore: update hub contract address * format * fix: add aadhaar in AllIds * chore: bump to v1.1.0-beta --------- Co-authored-by: vishal <[email protected]> Co-authored-by: Leszek Stachowski <[email protected]> Co-authored-by: Aaron DeRuvo <[email protected]> Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: Seshanth.S🐺 <[email protected]> Co-authored-by: seshanthS <[email protected]> * feat: change to gcp attestation verification (#959) * feat: change to gcp attestation verification * lint * fix e2e test * chore: don't check PCR0 mapping if building the app locally * fmt:fix --------- Co-authored-by: Justin Hernandez <[email protected]> * Mobile SDK: move provingMachine from the app (#1052) * Mobile SDK: move provingMachine from the app * lint, fixes * fix web build? * lint * fix metro build, add deps * update lock files * move the status handlers and proving machine tests * may it be * fix up * yolo --------- Co-authored-by: Justin Hernandez <[email protected]> Co-authored-by: Aaron DeRuvo <[email protected]> * Revert "Mobile SDK: move provingMachine from the app (#1052)" (#1084) This reverts commit 8983ac22688f731bca8890cbf9be9c85b4ac2bf…
Tested iOS events and they all seemed to submit to segment once
__DEV__was removedSummary
Testing
yarn workspaces foreach -p -v --topological-dev --since=HEAD run nice --if-presentyarn lintyarn buildyarn workspace @selfxyz/contracts build(fails: Invalid account configuration)yarn typesyarn test(fails: web build render test and other workspaces)https://chatgpt.com/codex/tasks/task_b_68addee57dfc832db659654fddc0ad30
Summary by CodeRabbit
New Features
Bug Fixes
Tests