bsky-app/README.md

Bluesky

Build instructions

• Setup your environment using the react native instructions.
• Setup your environment for e2e testing using detox:
  • yarn global add detox-cli
  • brew tap wix/brew
  • brew install applesimutils
• After initial setup:
  • npx expo prebuild -> you will also need to run this anytime app.json or package.json changes
• Start the dev servers
  • git clone git@github.com:bluesky-social/atproto.git
  • cd atproto
  • yarn
  • cd packages/dev-env && yarn start
• Run the dev app
  • iOS: yarn ios
  • Android: yarn android
  • Web: yarn web
• Run e2e tests
  • Start in various console tabs:
    • yarn e2e:server
    • yarn e2e:metro
  • Run once: yarn e2e:build
  • Each test run: yarn e2e:run
• Tips
  • npx react-native info Checks what has been installed.
  • The android simulator won't be able to access localhost services unless you run adb reverse tcp:{PORT} tcp:{PORT}
    • For instance, the localhosted dev-wallet will need adb reverse tcp:3001 tcp:3001
  • For some reason, the typescript compiler chokes on platform-specific files (e.g. foo.native.ts) but only when compiling for Web thus far. Therefore we always have one version of the file which doesn't use a platform specifier, and that should bee the Web version. (More info.)

Build instructions (with Go)

Prerequisites

• Go
• Yarn

Steps

To run the build with Go, use staging credentials, your own, or any other account you create.

cd social-app
yarn && yarn build-web
cp ./web-build/static/js/*.* bskyweb/static/js/
cd bskyweb/
go mod tidy
go build -v -tags timetzdata -o bskyweb ./cmd/bskyweb
./bskyweb serve --pds-host=https://staging.bsky.dev --handle=<HANDLE> --password=<PASSWORD>

On build success, access the application at http://localhost:8100/. Subsequent changes require re-running the above steps in order to be reflected.

Various notes

Debugging

• Note that since 0.70, debugging using the old debugger (which shows up using CMD+D) doesn't work anymore. Follow the instructions below to debug the code: https://reactnative.dev/docs/next/hermes#debugging-js-on-hermes-using-google-chromes-devtools

Developer Menu

To open the Developer Menu on an expo-dev-client app you can do the following:

• Android Device: Shake the device vertically, or if your device is connected via USB, run adb shell input keyevent 82 in your terminal
• Android Emulator: Either press Cmd ⌘ + m or Ctrl + m or run adb shell input keyevent 82 in your terminal
• iOS Device: Shake the device, or touch 3 fingers to the screen
• iOS Simulator: Press Ctrl + Cmd ⌘ + z on a Mac in the emulator to simulate the shake gesture, or press Cmd ⌘ + d

Running E2E Tests

• Make sure you've setup your environment following above
• Make sure Metro and the dev server are running
• Run yarn e2e
• Find the artifacts in the artifact folder

Polyfills

./platform/polyfills.*.ts adds polyfills to the environment. Currently this includes:

• TextEncoder / TextDecoder

Sentry sourcemaps

Sourcemaps should automatically be updated when a signed build is created using eas build and published using eas submit due to the postPublish hook setup in app.json. However, if an update is created and published OTA using eas update, we need to the take the following steps to upload sourcemaps to Sentry:

• Run eas update. This will generate a dist folder in your project root, which contains your JavaScript bundles and source maps. This command will also output the 'Android update ID' and 'iOS update ID' that we'll need in the next step.
• Copy or rename the bundle names in the dist/bundles folder to match index.android.bundle (Android) or main.jsbundle (iOS).
• Next, you can use the Sentry CLI to upload your bundles and source maps:
  • release name should be set to ${bundleIdentifier}@${version}+${buildNumber} (iOS) or ${androidPackage}@${version}+${versionCode} (Android), so for example com.domain.myapp@1.0.0+1.
  • dist should be set to the Update ID that eas update generated.
• Command for Android: node_modules/@sentry/cli/bin/sentry-cli releases \ files <release name> \ upload-sourcemaps \ --dist <Android Update ID> \ --rewrite \ dist/bundles/index.android.bundle dist/bundles/android-<hash>.map
• Command for iOS: node_modules/@sentry/cli/bin/sentry-cli releases \ files <release name> \ upload-sourcemaps \ --dist <iOS Update ID> \ --rewrite \ dist/bundles/main.jsbundle dist/bundles/ios-<hash>.map