@gfean/react-native-bundle-drop
v0.9.0
Published
Over-the-air updates for Expo and bare React Native apps, with channels, staged rollouts, patch delivery, and rollback.
Maintainers
Keywords
Readme
Bundle Drop
Ship reliable over-the-air updates to Expo and bare React Native apps.
Bundle Drop delivers JavaScript and asset updates to compatible iOS and Android binaries, with channel-based releases, targeted rollouts, rollback safety, and patch-sized downloads.
Website • Docs • Dashboard • Coming from CodePush?
Why Bundle Drop?
Shipping a JavaScript or asset fix should not always require a new native build.
| Native release workflow | With Bundle Drop | | --- | --- | | Rebuild the app for every JavaScript or asset change. | Publish OTA-compatible changes from your machine or CI. | | Wait for users to install the next store version. | Compatible devices can receive an update on their next check. | | Leave a faulty release active until another binary ships. | Stop a rollout or return to a verified bundle quickly. |
Bundle Drop only delivers updates that match the installed app's native and runtime identity. Native changes still require a new App Store or Play Store build.
Features
- Expo and bare React Native support — use the Expo config plugin or native React Native autolinking.
- Channel-based distribution — ship to
develop,production,beta, or any channel you define. - Targeted rollouts — stage releases and target specific cohorts with user properties.
- Rollback safety — every install is a verified, immutable bundle; rollback is a local pointer switch.
- Hybrid OTA transport — keep full-bundle integrity while supported devices download patch-sized changes.
- Runtime gating — updates only reach compatible native binaries.
- Observability metadata — bundle hashes and source maps keep crash reports attributable to the correct release.
- CI/CD support — upload with a Personal Access Token from any pipeline.
- Bundle Drop Sight — inspect JavaScript bundle sizes locally, including working-tree comparisons against a Git baseline.
Compatibility
| Surface | Supported versions | | --- | --- | | Expo | SDK 54, 55, 56, and 57 | | Bare React Native | React Native 0.71 and newer | | Platforms | iOS and Android | | Architectures | Legacy architecture and New Architecture | | Node.js | 20.19.4 or newer | | React | 17 or newer |
The Node requirement applies to installation of the package, including projects
that use only the mobile SDK. Development and
package builds use Node 22.13.0, as specified in .nvmrc.
Run bundle-drop --help to browse commands grouped into Setup, Analysis,
Releases, and Account. Existing command names and flags remain unchanged.
For iOS metadata, --plist-file and Sight accept XML Info.plist files; binary
and OpenStep property lists are not supported.
Installation
Expo
Install the package with Expo's version-aware installer:
npx expo install @gfean/react-native-bundle-dropBundle Drop's setup command registers the config plugin and preserves your existing Expo Metro configuration.
Bare React Native
Install with your package manager:
npm install @gfean/react-native-bundle-drop
# or
yarn add @gfean/react-native-bundle-dropThen install the iOS pod:
cd ios && pod installReact Native autolinking handles the package on both platforms. The setup command adds the app-entry integration that allows a Release build to start an installed OTA.
Bundle Drop Sight
Sight analyzes production JavaScript bundles and emitted assets in your browser. It
does not require a Bundle Drop account, OTA project configuration, login, or native
integration. Run it from the app directory containing package.json:
npx bundle-drop sight --platform android
npx bundle-drop sight --compare main --platform android
npx bundle-drop sight --compare origin/main --fetch --platform iosThe first command analyzes the current app using its installed dependencies and
includes emitted assets through the automatic CLI handoff.
--compare builds both an explicit Git baseline and a captured copy of your current
working tree. Both builds run locally, including when the baseline is a remote
tracking branch. Sight compares raw UTF-8 bytes in minified JavaScript and uses
source maps to attribute changes to packages and files. Both CLI modes include a
Bundled assets breakdown for files emitted by the same Metro/Expo build, such as
images and fonts. Assets do not change the JavaScript totals or treemap.
Bundle Drop OTA size measures a locally generated full OTA archive using Bundle Drop's canonical packaging. Each revision uses its own JavaScript engine configuration: Hermes is compiled with project-local tooling when enabled. JavaScript attribution and raw asset sizes remain separate; they are not bytecode attribution.
Bare iOS upload and Sight honor explicit Bundle Drop and native Hermes settings first.
For the standard React Native 0.81.x template, they also recognize the installed
React Native helpers' implicit Hermes default when those helpers match the verified
0.81.5 files. This conservative fallback is skipped
for custom engine configuration, community JSC indicators, or unfamiliar templates
and versions. For a custom project, set hermesBytecode: { ios: true } (or false
for JavaScript) in bundle.drop.config.js to match the engine in your native app.
The fallback does not evaluate Ruby or change your Podfile.
Measurement adds compilation and archive compression after the JavaScript build, once per side in a comparison. Expo's Hermes path also performs a separate bytecode export to preserve its upload-specific minification behavior. It requires a resolvable app/runtime identity. When that identity or required compiler is unavailable, Sight keeps the JavaScript and asset analysis and marks the OTA measurement unavailable with a reason. It never fills in an estimated archive size. Comparing this metric requires Bundle Drop to be configured on both branches with a resolvable app/runtime identity. The archive describes the selected Sight entry and build environment; upload overrides or different inputs can produce another size.
Asset sizes count each emitted output file once, including emitted density variants. Identical contents at different output paths count separately; a changed hash at the same path is a change even when the byte size is unchanged. Only emitted files are counted, not every asset in the repository. Native-only resources and network-loaded assets are outside this measurement. The OTA archive includes delivery metadata and asset manifests, and excludes source maps. It is not APK/IPA size. File size changes do not measure startup time or memory use.
No native app build is needed for asset analysis or comparison. The existing JavaScript bundling step emits the files into private temporary directories; the CLI records relative output paths, byte lengths, and SHA-256 hashes, then removes the emitted asset copies. Only the inventory is passed to Sight, with no image previews or binary asset uploads. This collection code stays in the CLI and adds no runtime dependencies or mobile SDK code.
The CLI transfers the generated files to Sight through a short-lived loopback
session. Source code, bundles, source maps, and comparison metadata are not uploaded
to Bundle Drop servers. Loading the Sight web page still needs browser access to
bundledrop.app.
Comparison options
| Option | Behavior |
| --- | --- |
| --compare <ref> | Resolve a branch, tag, or commit to an immutable baseline commit before building. |
| --fetch | Refresh the explicitly named remote branch, such as origin/main, using ordinary Git credentials. Requires --compare. |
| --platform ios\|android | Compare one platform per invocation. If ambiguous, interactive use prompts; noninteractive use requires the flag. |
| --project-type bare\|expo | Override project detection consistently for both sides. |
| --entry-file <path> | Choose an app-relative entry file that must exist in both snapshots. |
| --include <path> | Copy an extra local file or directory identically into both snapshots; repeat for multiple inputs. |
| --no-open | Keep the generated files and print manual browser instructions. |
| --keep | Keep the comparison files after a successful browser transfer. |
| --output <path> | Write persistent output to an empty directory. |
Without --fetch, Sight uses locally available refs and does not contact a Git
remote. main is never silently substituted with origin/main. Explicit refresh
requires a configured remote branch; use normal Git commands first to obtain a
missing tag, commit, or additional shallow history. Sight neither requests nor
stores repository credentials.
What each side builds
The current snapshot contains tracked working-tree contents, including uncommitted edits and deletions, plus nonignored untracked files. Ignored inputs such as local environment files are excluded unless explicitly included:
npx bundle-drop sight --compare main --platform android \
--include .env.production --include local-build-configIncluded paths must stay inside the repository. They cannot overwrite files tracked on either side or supply dependency manifests, lockfiles, or installed dependencies. The same captured contents are added to both sides, so the baseline remains a comparison under the same explicitly supplied local configuration.
Sight creates private temporary Git worktrees for the two builds. Both have a
detached HEAD: baseline points at the resolved baseline commit, and current
points at your original HEAD with captured working-tree files overlaid. Your
original staging partition is not reproduced; scripts that distinguish staged
from unstaged changes, or depend on an attached branch name, may behave differently.
Sight does not switch, stash, reset, or stage your original checkout.
The private repository has independent object storage and preserves the captured
local branch/tag/remote-tracking refs and available history. git rev-parse HEAD
and ancestry queries use each side's own commit. git describe evaluates the
captured tags from that commit; these are today's locally available refs, not
their historical state at the baseline date. Missing shallow history or tags may
change its output, and Sight does not fetch them implicitly. Branch-name queries
observe detached HEAD; the original branch label is metadata only.
git describe --dirty reflects each private worktree, including explicit includes
and build-script changes. Original dirty status is recorded separately. Builds
depending on attached branches or staging partitions must accommodate these
semantics through their existing configuration/environment. Sight verifies pinned
HEADs and refs around build phases and rejects mutations that invalidate provenance.
It rechecks captured files, modes, symlinks, HEAD, and index for observed concurrent
changes; the copy is not an atomic filesystem snapshot.
Both sides use the same Node executable, platform, production/minification settings, and logical entrypoint. Each revision retains its own dependencies and bundler configuration. Sight records framework/package-manager versions and warns when relevant inputs differ. A framework upgrade or configuration change can legitimately affect the result. Required environment variables must be available to both builds; there is no automatic fallback from a failed build to the other revision's output.
Dependencies and supported repository layouts
Comparison installs fresh dependencies for each side from its own lockfile. It
supports npm, pnpm, Yarn Classic, and modern Yarn with nodeLinker: node-modules.
An exact packageManager declaration must match the available executable; tracked
yarnPath configurations are honored. Without a declaration, a unique lockfile
family selects the available manager and its actual version is recorded. Sight
does not automatically download package-manager binaries or change a lockfile to
make installation succeed.
Dependency installation can access package registries and execute project lifecycle
scripts. Existing script policies are preserved. For declared engines.node ranges,
Sight uses the installed npm executable to check a temporary dependency-free
manifest with an offline, script-disabled dry run before the real installs. This
check also requires npm when the project uses Yarn or pnpm. Build/configuration
scripts execute as ordinary local processes; the temporary worktrees are not a
security sandbox for untrusted project code.
Apps in a single npm, Yarn, or pnpm workspace root can use other packages inside
the same Git repository. Installation runs at the workspace root; bundling runs
from the app directory. Nested/ambiguous workspace roots, nested app lockfiles,
external local dependencies or symlinks, Bun, and Plug'n'Play installations are not
supported. npm workspaces require a v2 or newer lockfile. Unresolved Git conflicts,
sparse/partial clones, required Git submodules, Git LFS/checkout filters, and tracked
node_modules are also unsupported. There is no comparison build or dependency-tree
cache in this version.
Actual workspace frozen installs have been verified on macOS arm64 with Node
22.13.0 using npm 10.9.2, pnpm 11.24.0, Yarn 1.22.22, and Yarn 3.8.3. These installer
checks cover a registry dependency, a local workspace dependency, lifecycle scripts,
and unchanged manifests/lockfiles. Real comparisons were also verified with npm
10.9.2, React Native 0.83.1, and Expo 55.0.0: dirty source capture, package additions,
identical inputs, and automatic browser attribution after source cleanup.
An Expo Router 55.0.18 app also passed a real comparison using expo-router/entry.
Windows/Linux hosts and full framework builds with pnpm or Yarn remain unverified;
the installer checks alone do not establish those combinations.
Keeping files and opening Sight manually
npx bundle-drop sight --platform android --no-open --output ./sight-analysis
npx bundle-drop sight --compare main --platform android \
--no-open --output ./sight-comparisonSingle analysis keeps a bundle/source-map pair and analysis-assets.json, a local
record of emitted paths, sizes, hashes, and the exact bundle/map hashes. The automatic
CLI handoff verifies this binding before including assets in the analysis.
Comparison output contains baseline/ and current/ bundle/source-map pairs plus
comparison.json and comparison-assets.json as local records. Automatic CLI
loading verifies these files and includes Git labels, build context, and asset
sizes. The browser does not expose metadata or inventory upload controls.
For a manual JavaScript-only comparison, open Bundle Drop Sight, select Compare, and attach the four bundle/map files. Manual Analyze still takes one bundle and its matching map; manual Compare still takes two pairs. Neither requires the Bundle Drop SDK or extra JSON files. Git labels and asset sizes appear only through the CLI handoff. Changing a file after a CLI handoff clears its comparison context.
Comparison metadata remains limited to 64 KiB. Each asset inventory is limited to 4 MiB and 10,000 files per build; oversized inventories fail explicitly instead of producing partial totals. Inventory paths are output-relative and are never opened by the browser.
Temporary worktrees and dependencies are removed after success, failure, or
cancellation. Completed files from either CLI mode are retained when browser handoff
fails; the CLI prints their location, and comparisons also print the diagnostics
directory. --keep, --no-open, and --output retain the requested artifacts,
including the local asset record. A failure before complete artifacts
exist removes owned temporary output; explicitly requested output directories are
kept for inspection.
The metadata contains local temporary source roots so unchanged source maps remain attributable after cleanup. Sight excludes those roots from displayed/exported provenance and analytics. Manual file loading uses ordinary JavaScript comparison behavior without the CLI source-path context.
Removal failures report the owned directory for manual recovery. An uncatchable
termination, such as a forced process kill or power loss, can leave temporary
bundle-drop-sight-* directories. After confirming the invocation and its build
processes have stopped, remove only those reported/identified temporary directories;
keep completed comparison output if it is still needed.
On macOS/Linux, Sight stops ordinary child process groups before removing the
worktrees, including background children left after a command exits. On Windows,
cancellation uses taskkill for the active process tree, but this version has no
Job Object containment: background descendants can survive if their parent has
already exited. Scripts that deliberately detach into a separate process group
also fall outside process-group cleanup.
First-Time Setup
Run these commands from your app's project root:
npx bundle-drop login
npx bundle-drop doctorlogin signs you in, creates bundle.drop.config.js when needed, pins the
authenticated runtime-delivery bootstrap under .bundle-drop/, detects Expo or
bare React Native, previews the integration changes, and completes setup. doctor
then validates configuration, runtime identity, native integration, and startup
ownership.
Run init when you need to review or rerun setup. You can force project detection
for unusual repository layouts:
npx bundle-drop init
npx bundle-drop init --project-type expo
npx bundle-drop init --project-type bareRun npx bundle-drop doctor again after changing native integration, Metro, Expo
configuration, or runtime versions.
When Bundle Drop rotates manifest verification keys or changes the public manifest route, refresh the pinned client-visible bootstrap explicitly:
npx bundle-drop sync
npx bundle-drop doctorApps upgrading from an inline runtimeDelivery block or a direct Metro alias should
remove that stale block and run npx bundle-drop init once to install the
package-managed Metro wrapper. Inline delivery data is ignored: the validated
runtime-delivery lockfile is the sole trust source. After that one-time migration, sync
is the narrow command for refreshing trust data.
The runtime-delivery lockfile is not a secret and should be committed. Setup keeps the
generated Metro wrapper, build receipts, and other transient .bundle-drop files
ignored while allowing .bundle-drop/runtime-delivery.lock.json into source
control. Projects with the former runtime-delivery.generated.json filename remain
readable; run bundle-drop sync to migrate and remove that legacy file.
Manual setup without AI planning
You can configure Bundle Drop without sending project files to the AI setup planner.
Create bundle.drop.config.js with the project identity and public project API key
shown in the developer dashboard:
module.exports = {
serverUrl: 'https://api.bundledrop.app',
defaultChannel: 'develop',
runtimeVersion: { ios: '1.0.0', android: '1.0.0' },
org: { slug: 'your-org' },
project: {
name: 'Your App',
slug: 'your-app',
apiKey: 'your-public-project-key',
},
};Wrap the final exported Metro config. For bare React Native:
const { getDefaultConfig, mergeConfig } = require('@react-native/metro-config');
const { withBundleDrop } = require('@gfean/react-native-bundle-drop/metro');
const config = mergeConfig(getDefaultConfig(__dirname), {});
module.exports = withBundleDrop(config, { projectRoot: __dirname });For Expo:
const { getDefaultConfig } = require('expo/metro-config');
const { withBundleDropExpo } = require('@gfean/react-native-bundle-drop/metro');
module.exports = withBundleDropExpo(getDefaultConfig(__dirname), {
projectRoot: __dirname,
});Expo projects must also add @gfean/react-native-bundle-drop to the app config's
plugins array. Bare projects must connect Bundle Drop to the Release bundle URL in
their Android and iOS entrypoints. Follow the
manual native setup guide because the
entrypoint shape varies across React Native versions.
Finish every manual setup by authenticating, generating the public trust bootstrap, and validating the complete integration:
npx bundle-drop login
npx bundle-drop sync
npx bundle-drop doctorsync creates .bundle-drop/runtime-delivery.lock.json, recreates it if it or
the entire .bundle-drop directory was deleted, and repairs the corresponding
.gitignore rules. The lockfile contains public identity and verification material,
not secrets, so commit it with the application.
Initialize the Runtime
Call BundleDrop.init once, as early as possible in the app process.
Expo Router
Initialize in app/_layout.tsx, before rendering the root layout:
import { BundleDrop } from '@gfean/react-native-bundle-drop';
import { Stack } from 'expo-router';
BundleDrop.init({
enabled: !__DEV__,
environment: __DEV__ ? 'development' : 'production',
channelName: 'develop',
policy: 'on-next-launch',
});
export default function RootLayout() {
return <Stack />;
}Conventional React Native entrypoint
Initialize near the top of your entry file, before registering the root component:
import { AppRegistry } from 'react-native';
import { BundleDrop } from '@gfean/react-native-bundle-drop';
import App from './App';
import { name as appName } from './app.json';
BundleDrop.init({
enabled: !__DEV__,
environment: __DEV__ ? 'development' : 'production',
channelName: 'develop',
policy: 'on-next-launch',
});
AppRegistry.registerComponent(appName, () => App);Expo Builds and Development
Bundle Drop needs its native integration in the installed app. Expo Go does not contain that native adapter, so the SDK remains disabled there and your app can keep using Expo Go for normal development.
Debug builds and development clients also keep Metro as the JavaScript authority; they do not start an installed OTA bundle. Test the OTA lifecycle with a non-Debug Release build.
For managed/CNG projects, setup can leave ios/ and android/ absent. The config
plugin generates the native integration during a later prebuild, expo run:*, or
EAS Build. Typical local Release builds are:
npx expo run:ios --configuration Release
npx expo run:android --variant releaseFor remote builds, use your normal EAS profiles:
eas build --platform ios
eas build --platform androidWith the default literal runtime configuration, the plugin embeds the platform's
literal in the native build and Expo uploads resolve that same literal directly from
bundle.drop.config.js. This normal workflow does not require a build receipt.
An advanced Expo project can explicitly make its Expo runtime policy authoritative
with runtimeVersion: { source: 'expo' }. In that opt-in mode, uploads require an
exact receipt from the matching local native build. For a remote EAS build, create an
authenticated receipt from the completed build and pass the returned path to upload:
npx bundle-drop eas-receipt ios --build-id <eas-build-id>
npx bundle-drop upload ios --channel develop --build-receipt <receipt-path>Rebuild the native app whenever the config plugin, native dependencies, permissions, or runtime compatibility boundary changes.
expo-updates startup ownership
An active expo-updates installation can also own native startup, so it cannot be
active in the same binary as Bundle Drop. Setup and doctor stop when they detect
that conflict. To migrate intentionally, review the proposed changes and run:
npx bundle-drop init --project-type expo --migrate-expo-updatesThis removes the active expo-updates integration and requires a new native binary.
Do not publish a Bundle Drop update until that replacement binary has been built and
distributed.
Runtime Versions
bundle.drop.config.js defines literal runtime versions shared by Expo and bare
React Native projects:
module.exports = {
// ...project configuration
runtimeVersion: {
ios: '1.0.0',
android: '1.0.0',
},
};Keep a platform's literal unchanged for OTA-compatible JavaScript and asset updates. The upload will then target binaries built with that same runtime value.
When native code or native configuration changes, bump the affected platform's
literal and build a new binary before uploading updates for that runtime. For
example, an iOS-only native change should bump runtimeVersion.ios; Android can keep
its existing value. This makes the compatibility boundary explicit and prevents an
update from reaching a binary that cannot run it.
Native Startup Recovery
Bundle Drop records every OTA startup attempt in native storage before React Native
receives the bundle path. If an attempt does not reach its configured health boundary,
the next distinct app launch counts it as incomplete. The candidate is retried until
rollback.maxCrashCount is reached, then quarantined locally and replaced with the
previous native-proven healthy OTA bundle. If that bundle is missing, corrupt,
incompatible, or locally revoked, startup falls back to the bundle embedded in the app.
Automatic health waits for React content to appear and then applies
rollback.healthyAfterSec. Apps with a stronger readiness boundary can opt into
healthCheckMode: 'manual' and call BundleDrop.reportHealthy() after hydration,
migrations, authentication bootstrap, or navigation setup completes. Health is committed
against the exact native launch attempt, so a delayed callback from an older React runtime
cannot approve a newer launch.
Recovery is local and offline; it never waits for a network request during startup. With
maxCrashCount: 0, launch-health counting and automatic crash-loop rollback are disabled,
while integrity, runtime compatibility, quarantine, and locally persisted revocation checks
still apply. Native startup recovery requires a binary built with the corresponding SDK
nativeVersion; it cannot be added to an older installed binary through OTA JavaScript.
Crashes after an attempt is healthy do not trigger this rollback path and should use normal
crash reporting plus fix-forward or explicit rollback controls.
Managed Runtime Delivery
Runtime delivery is package-managed. bundle.drop.config.js stays focused on
application-owned values such as project identity, channel, runtime versions, and
rollback policy; it does not contain manifest hosts, access routes, public keys, or
a delivery-mode switch.
bundle-drop login and bundle-drop init synchronize the trust bootstrap during
setup. bundle-drop sync performs the same narrow operation later for repair or key
rotation. Each command validates authenticated project credentials and writes the
identity-bound .bundle-drop/runtime-delivery.lock.json. Metro confirms that
the bootstrap belongs to the same server, organization, and project before merging
it into the runtime module. Malformed, copied, unsupported, or private-key-bearing
data is rejected.
Older apps with an inline runtimeDelivery block keep their ordinary project
configuration, but the inline block is ignored and should be removed during
migration. Only the identity-bound runtime-delivery lockfile can enable managed delivery.
If the server explicitly disables delivery for a project, synchronization removes a
stale bootstrap and the SDK continues through the compatible /ota/resolve path.
The SDK resolves a complete public lane locally. Invalid, expired, incomplete,
dynamic, unavailable, or network-failed manifests safely fall back to /ota/resolve.
Artifact download authorization remains API-key authenticated and uses opaque
release and artifact references rather than URLs embedded in the manifest.
Lane manifests are signed state and are not themselves the revocation clock. Every
local check also fetches a small environment-wide signed publisher lease. The SDK
verifies its key, exact manifest origin, issue time, and short absolute expiry before
it verifies or persists lane generation state. A missing, invalid, expired, or
operator-disabled lease therefore falls back to /ota/resolve, even when cached
manifest bytes remain cryptographically valid.
Artifact download capabilities are intentionally short-lived. If an artifact URL is rejected with HTTP 401 or 403 during download, the SDK reauthorizes the original signed selection once and retries only when its generation, target, transport, artifact references, and signed hashes are unchanged. Verification, reconstruction, and installation failures are never retried this way.
With managed delivery, install through downloadUpdate, or use the React hook's
fetchBundles and installBundle(bundle) list-item flow. Direct named
installBundle(hash, url, ...) calls are rejected because they bypass the fresh
resolve and artifact-authorization decision.
Unchanged install state is reported at most once every seven days. A current bundle hash, app environment, or user-property change is reported immediately; successful installs continue to use the separate idempotent installed receipt.
The manifest URL is derived from manifestBaseUrl, manifestAccessId, channel,
platform, and runtime version. manifestAccessId is an opaque URL-routing value,
not a signing secret. publicKeys contains public P-256 JWK coordinates keyed by
the manifest JWS kid, which permits signing-key rotation.
Pass onRuntimeDeliveryDiagnostic to BundleDrop.init to export the fast-path
signals to your metrics system. Events contain a bounded counter name, cumulative
process count, timestamp, and optional channel/reason/status metadata; they never
contain access IDs, install IDs, JWS bodies, user properties, or artifact URLs.
getRuntimeDeliveryDiagnosticCounters() returns a process-local snapshot. The
counter names are manifest_hit, dynamic_manifest, origin_fallback,
invalid_signature, unknown_key, lane_mismatch,
generation_regression, generation_equivocation,
manifest_http_error, manifest_network_error, manifest_timeout,
manifest_too_large, manifest_invalid, manifest_stream_unavailable,
authority_lease_http_error, authority_lease_network_error,
authority_lease_timeout, authority_lease_too_large,
authority_lease_invalid, authority_lease_invalid_signature,
authority_lease_unknown_key, authority_lease_expired,
authority_lease_origin_mismatch, and authority_lease_disabled.
Manifest responses are read incrementally and cancelled as soon as they exceed
1 MiB. A runtime without a readable response stream fails closed to /ota/resolve
instead of buffering an unbounded body.
Managed runtime delivery uses native SHA-256 and ES256 verification. After upgrading to
an SDK release whose nativeVersion includes this support (0.5.0 or newer), run
Pods/prebuild as appropriate and ship a new native binary before enabling runtime
delivery for the project. Bundle Drop's native-version validation will reject a JavaScript/native
adapter mismatch.
Upload an Update
With the default literal runtime configuration, Expo uploads resolve the app version
through the Expo project and the runtime through bundle.drop.config.js. They do not
need --version, --plist-file, or Gradle-path options:
npx bundle-drop upload ios --channel develop
npx bundle-drop upload android --channel developBare React Native uploads specify or resolve the app version explicitly:
npx bundle-drop upload android --version 1.2.3 --channel develop
npx bundle-drop upload ios --plist-file ios/Info.plist --channel developAdd --sourcemap to produce source maps for error tracking. In CI/CD, pass a
Personal Access Token with --token <PAT> instead of using an interactive login.
Update Policies
policy controls what happens after Bundle Drop hydrates its local state on startup:
| Policy | Behavior |
| --- | --- |
| manual | Check only when you call the APIs yourself. Default. |
| immediate | Download and apply a new bundle right away. |
| on-next-launch | Stage the update now, then apply it on the next cold launch. |
on-next-launch is a good default for most apps: users do not see a reload in the
middle of a session, and the update is ready for the next launch.
Driving Updates Manually
For custom update UI, use the useBundleDrop() hook. It subscribes to the singleton
runtime and exposes actions plus live state:
import { Button } from 'react-native';
import { useBundleDrop } from '@gfean/react-native-bundle-drop';
function UpdateBanner() {
const { checkLatest, downloadUpdate, applyUpdate, pendingApply, isBusy } =
useBundleDrop();
if (pendingApply) {
return <Button title="Restart to update" onPress={applyUpdate} />;
}
return (
<Button
title="Check for updates"
disabled={isBusy}
onPress={async () => {
await checkLatest();
await downloadUpdate();
}}
/>
);
}The same actions are available as standalone functions (checkForUpdate,
downloadUpdate, applyUpdate, setChannel, reportHealthy, and others) for use
outside React.
Targeted Rollouts
Attach user properties to target specific cohorts when you stage a release:
import { setUserProperty } from '@gfean/react-native-bundle-drop';
await setUserProperty('plan', 'pro');
await setUserProperty('age', 33);
await setUserProperty('beta', true);Property values must be strings, finite numbers, or booleans. Keys are trimmed and
must be non-empty, 128 characters or fewer, and cannot start with $, contain .,
contain a null byte, or use reserved prototype names.
Hybrid OTA Delivery
Bundle Drop installs complete, immutable bundle folders, each identified by a
canonical bundleHash for the reconstructed file tree. Patch transport is a download
optimization: the SDK reconstructs the complete target folder, validates the
manifest, verifies file hashes and sizes, and only then promotes the bundle.
- The SDK supports
asset-only-v1patch sets and advertisesxdelta3-vcdiffwhen native xdelta support passes its probe. - If patch transport is unavailable or fails, the SDK falls back to the signed full ZIP.
- Rollback remains a local pointer switch between verified bundle hashes.
The production manifest contract is manifestVersion: 1. jsBundleHash is retained
as metadata only.
Observability
Every bundle has a unique hash, and bundle-drop upload --sourcemap produces source
maps so stack traces remain attributable across updates. Use
getObservabilityContext() to tag error reports with the running bundle:
import { getObservabilityContext } from '@gfean/react-native-bundle-drop';
const context = await getObservabilityContext();This works with Sentry, Bugsnag, Datadog, and other error trackers. See the
observability guide. Apps on
@sentry/react-native 7.8.x that combine Sentry's Metro wrapper with Hermes should
follow the guide's
Sentry/Hermes OTA setup
to keep content-derived Debug IDs from inflating binary patches.
API Reference
Import the runtime API from @gfean/react-native-bundle-drop.
Runtime controller
| Export | Description |
| --- | --- |
| BundleDrop.init(options) | Initialize the runtime for the app process. |
| BundleDrop.setChannel(name) / setChannel | Change the active channel for singleton actions. |
| BundleDrop.getChannelName() / getChannelName | Read the active channel. |
| BundleDrop.reportHealthy() / reportHealthy | In manual health mode, ask native recovery to mark the exact running OTA attempt healthy. |
BundleDrop.init(options)
| Option | Type | Default | Description |
| --- | --- | --- | --- |
| environment | string | Required | App environment shown in analytics, such as production, staging, or development. |
| enabled | boolean | true | When false, the SDK stays configured but does not check, download, or apply. |
| channelName | string | Config defaultChannel (develop) | Initial OTA channel for this process. |
| policy | 'manual' \| 'immediate' \| 'on-next-launch' | 'manual' | Startup behavior after hydration. |
| checkOnly | boolean | false | Startup resolves updates without downloading or applying them. |
| onStatusUpdate | (status: string) => void | — | Listener for human-readable status messages. |
| onRuntimeDeliveryDiagnostic | (event: RuntimeDeliveryDiagnosticEvent) => void | — | Listener for bounded runtime-delivery counter events suitable for metrics export. |
Update actions — checkForUpdate, downloadUpdate, installBundle,
applyUpdate, getUpdateState, getInstalledBundleInfo, getAvailableBundles,
getAvailableChannels.
React — useBundleDrop() returns live state (status, isEnabled, isBusy,
channelName, installedInfo, pendingApply, hasBundle, availableChannels)
plus update actions.
User properties — setUserProperty, removeUserProperty, getUserProperties,
getCurrentUserProperties, resetUserProperties.
Errors — BundleDropError, isBundleDropError.
Runtime delivery diagnostics — getRuntimeDeliveryDiagnosticCounters returns
the current process-local counter snapshot.
Metro — import withBundleDropExpo for Expo or withBundleDrop for bare React
Native from @gfean/react-native-bundle-drop/metro when configuring Metro manually.
CLI (npx bundle-drop <command>) — login, logout, whoami, init, sync,
doctor, eas-receipt <ios|android>, and upload <ios|android>.
Good to Know
- OTA covers JavaScript and assets, not native code. Native modules, native dependency upgrades, permissions, native configuration, and React Native upgrades require a new store binary.
- Follow store policies. Use OTA delivery for changes that remain within Apple and Google requirements and the purpose of the reviewed app.
- Compatibility checks are deliberate. A device does not receive an update built for a different app or runtime version.
- Release builds run installed OTAs. Expo Go, Debug builds, and development clients continue to use their development JavaScript source.
- Bundle Drop complements crash reporting. It provides release identity and source-map support; it does not replace an error tracker.
Docs and Links
- Website: bundledrop.app
- Docs: bundledrop.app/docs
- Dashboard: developer.bundledrop.app
- Migrating from CodePush: bundledrop.app/codepush-alternative
- Issues: github.com/GFean/react-native-bundle-drop/issues
- Security: SECURITY.md
- Contributing: CONTRIBUTING.md
License
ISC
