Merge pull request #395 from hakaari/feat/unified-logger

Author: torkinos

README.md

@@ -190,9 +190,9 @@ Each test file requires an `appId` block and a `---` separator before the comman
 appId: com.pears.pass
 ---
 - launchApp
-- assertVisible: 'Master password'
+- assertVisible: "Master password"
 - tapOn:
-    text: 'Master password'
+    text: "Master password"
 ```
 
 For more information, see the [Maestro documentation](https://maestro.mobile.dev/).
@@ -230,6 +230,31 @@ We welcome contributions. See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for the dev
 
 ---
 
+## Logging
+
+Logging is off by default. When enabled, logs are written to the app's cache directory — `main.log` from the JS host (React Native side) and `core-logs.txt` from the Bare vault worker. The worker's sink redacts known sensitive fields (passwords, keys, tokens, etc.) before writing to `core-logs.txt`. The host logger does not redact, so treat anything passed to `logger.*` on the JS side as on-disk-visible in `main.log`.
+
+Two ways to enable:
+
+- **In-app toggle** (Settings → Diagnostics → **Enable logs**). Persists across launches. Toggling off stops writes but keeps existing log files; toggling back on resumes appending to the same files, so a session can span multiple toggles.
+- **Nightly builds** (`PearPass-nightly`): logging defaults to `debug` on first launch so testers don't have to opt in. The toggle still works to disable it.
+
+Logs can be shared via Diagnostics screen **Share logs** action that zips both files plus a small metadata file (app version, distribution channel).
+
+---
+
+## Error reporting
+
+**PearPass mobile is open source. Public releases and self-built versions never send any data anywhere. Sentry is only enabled on our nightly distribution channel for catching crashes during pre-release testing.**
+
+Verifying:
+
+- The gate is `isNightly()` from `src/constants/distribution.js`. Returns `false` unless the distribution channel is `nightly`.
+- The Expo config plugin for Sentry is only loaded when `PEARPASS_DISTRIBUTION=nightly` at build time. `app.config.ts`. `app.json` has no Sentry plugin entry, so standard / F-Droid builds never include it.
+- The Bare-side Sentry SDK (`sentry-bare`) is an optional peer dependency of `pearpass-lib-vault-core` — public builds don't install it.
+
+---
+
 ## License
 
 This project is licensed under the Apache License, Version 2.0. See the [LICENSE](./LICENSE) file for details.

app.config.ts

@@ -2,6 +2,7 @@ import { ConfigContext, ExpoConfig } from '@expo/config'
 
 export default ({ config }: ConfigContext): ExpoConfig => {
   const distribution = process.env.PEARPASS_DISTRIBUTION || 'standard'
+  const isNightly = distribution === 'nightly'
 
   const plugins = config.plugins ? [...config.plugins] : []
   plugins.push(['./plugins/withAndroidDistribution', { distribution }])
@@ -14,6 +15,9 @@ export default ({ config }: ConfigContext): ExpoConfig => {
       extensionBundlePath: 'bundles/autofill.bundle',
     },
   ])
+  if (isNightly) {
+    plugins.push('@sentry/react-native/expo')
+  }
 
   return {
     ...config,
@@ -26,4 +30,3 @@ export default ({ config }: ConfigContext): ExpoConfig => {
     }
   }
 }
-

index.js

@@ -1,11 +1,27 @@
-import './strict.css';
-import '@expo/metro-runtime';
+import './strict.css'
+import '@expo/metro-runtime'
 
 import { registerRootComponent } from 'expo'
 
+import { isNightly } from './src/constants/distribution'
 import { Main } from './src/main'
+import { loadLogConfiguration } from './src/utils/logConfigurationStorage'
+import { logger } from './src/utils/logger'
 
-// registerRootComponent calls AppRegistry.registerComponent('main', () => App);
-// It also ensures that whether you load the app in Expo Go or in a native build,
-// the environment is set up appropriately
+// Should happen first - awaiting AsyncStorage before
+// registering races the native activity on Android — iOS happens to win
+// the race, Android does not, and the JS root never mounts.
 registerRootComponent(Main)
+
+async function bootstrap() {
+  await loadLogConfiguration()
+
+  if (isNightly()) {
+    const { initSentry } = require('./src/utils/sentry')
+    initSentry()
+  } else {
+    logger.log('[sentry] disabled — non-nightly distribution')
+  }
+}
+
+bootstrap()

jest.config.js

@@ -10,7 +10,7 @@ export default {
   },
   testPathIgnorePatterns: ['/node_modules/', '/.yalc/', '/packages/'],
   transformIgnorePatterns: [
-    'node_modules/(?!(react-native|@react-native|@react-native-community|react-redux|@reduxjs/toolkit|immer|styled-components|@testing-library/react-native|expo-local-authentication|@tetherto|pearpass-lib-ui-react-native-components|pearpass-lib-ui-theme-provider|pearpass-lib-ui-theme-provider/native|pearpass-utils-password-check|@react-navigation/bottom-tabs|@gorhom/bottom-sheet|pearpass-utils-password-generator|expo-clipboard|expo-haptics|expo-document-picker|expo-file-system|expo-modules-core|wdk-react-native-passkey-internal|react-native-passkey|axios|react-native-config|pearpass-lib-data-export|pearpass-lib-constants|react-native-toast-message|react-native-reanimated|react-native-vision-camera|react-native-worklets-core|vision-camera-zxing)/)'
+    'node_modules/(?!(react-native|@react-native|@react-native-community|react-redux|@reduxjs/toolkit|immer|styled-components|@testing-library/react-native|expo|expo-local-authentication|@tetherto|pearpass-lib-ui-react-native-components|pearpass-lib-ui-theme-provider|pearpass-lib-ui-theme-provider/native|pearpass-utils-password-check|@react-navigation/bottom-tabs|@gorhom/bottom-sheet|pearpass-utils-password-generator|expo-clipboard|expo-constants|expo-haptics|expo-document-picker|expo-file-system|expo-modules-core|expo-sharing|wdk-react-native-passkey-internal|react-native-passkey|axios|react-native-config|pearpass-lib-data-export|pearpass-lib-constants|react-native-toast-message|react-native-reanimated|react-native-vision-camera|react-native-worklets-core|vision-camera-zxing)/)'
   ],
   setupFilesAfterEnv: ['./jest.setup.js']
 }

jest.setup.js

@@ -54,3 +54,39 @@ jest.mock('./src/context/HapticsContext', () => ({
   }),
   HapticsProvider: ({ children }) => children
 }))
+
+jest.mock('@react-native-async-storage/async-storage', () =>
+  require('@react-native-async-storage/async-storage/jest/async-storage-mock')
+)
+
+jest.mock('expo-file-system/next', () => ({
+  File: jest.fn().mockImplementation(() => ({
+    exists: false,
+    size: 0,
+    create: jest.fn(),
+    delete: jest.fn(),
+    write: jest.fn(),
+    textSync: jest.fn(() => ''),
+    open: jest.fn(() => ({
+      offset: 0,
+      size: 0,
+      writeBytes: jest.fn(),
+      close: jest.fn()
+    }))
+  })),
+  Paths: { cache: { uri: 'file:///mock-cache/' } }
+}))
+
+jest.mock('expo-sharing', () => ({
+  shareAsync: jest.fn(() => Promise.resolve())
+}))
+
+jest.mock('expo-constants', () => ({
+  __esModule: true,
+  default: { expoConfig: { extra: {} } }
+}))
+
+jest.mock('@sentry/react-native', () => ({
+  init: jest.fn(),
+  reactNavigationIntegration: jest.fn(() => ({}))
+}))

metro.config.cjs

@@ -1,8 +1,12 @@
 // Learn more https://docs.expo.io/guides/customizing-metro
-const { getDefaultConfig } = require('expo/metro-config')
+const isNightly = process.env.PEARPASS_DISTRIBUTION === 'nightly'
 
 /** @type {import('expo/metro-config').MetroConfig} */
-const config = getDefaultConfig(__dirname)
+const config = isNightly
+  ? require('@sentry/react-native/metro').getSentryExpoConfig(__dirname, {
+      includeWebFeedback: false
+    })
+  : require('expo/metro-config').getDefaultConfig(__dirname)
 
 config.transformer = {
   ...config.transformer,