Skip to content

fix(ios): make the RNSentry SPEC CHECKSUM in Podfile.lock machine-independent #6534

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.

Sign up for GitHub

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

Open
alwx wants to merge 4 commits into
base: main
Choose a base branch
from
+94 −9
Open

fix(ios): make the RNSentry SPEC CHECKSUM in Podfile.lock machine-independent #6534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7c7cd0c
fix(ios): make the RNSentry SPEC CHECKSUM in Podfile.lock machine-ind…
alwx Jul 28, 2026
4a82d33
Merge branch 'main' into alwx/bugfix/6467
alwx Jul 30, 2026
6d1638b
Merge branch 'main' into alwx/bugfix/6467
alwx Jul 30, 2026
dc4206f
docs(changelog): move entry to Unreleased and reference #6534
alwx Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@
> make sure you follow our [migration guide](https://docs.sentry.io/platforms/react-native/migration/) first.
<!-- prettier-ignore-end -->

## Unreleased

### Fixes

- Make the `RNSentry` SPEC CHECKSUM in `Podfile.lock` machine-independent ([#6534](https://github.com/getsentry/sentry-react-native/pull/6534))

The prebuilt `Sentry.xcframework` is now referenced through a `$(PODS_ROOT)/sentry-xcframeworks/…` symlink instead of the absolute per-user cache path, so `Podfile.lock` no longer churns between developers and CI. Expect a one-time `RNSentry` checksum change on the next `pod install`; the `SENTRY_XCFRAMEWORK_CACHE_DIR=/tmp/…` workaround is no longer needed.

## 8.21.0

### Features
Expand Down
27 changes: 18 additions & 9 deletions packages/core/RNSentry.podspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,16 +130,25 @@ Pod::Spec.new do |s|
# sentry-cocoa's `Sentry.xcframework` layout is stable across releases.
# Add a slice there if a future release ships one.
#
# Point the search paths at the pod-install-time absolute path to the
# xcframework. `${PODS_TARGET_SRCROOT}` is only defined in per-pod
# xcconfigs, not in aggregate/user-target xcconfigs, and a
# `${PODS_ROOT}`-relative fallback works for one Podfile layout but
# breaks for another (e.g. the RN sample apps put node_modules at a
# different depth from RNSentryCocoaTester). Using the absolute path
# avoids the layout-detection dance — the path is regenerated on
# every `pod install`, so it's not something anyone commits.
# Reference the xcframework through a `Pods/sentry-xcframeworks/…`
# symlink so the search paths are machine-independent (see
# `stage_sentry_xcframework_in_pods`) — the values below feed the
# `RNSentry` SPEC CHECKSUM in `Podfile.lock`, so an absolute
# `~/Library/Caches/…` path here made the lockfile churn between
# machines (#6467). `${PODS_TARGET_SRCROOT}` can't be used instead: it
# is only defined in per-pod xcconfigs, not in aggregate/user-target
# xcconfigs, and a `${PODS_ROOT}`-relative path to node_modules works
# for one Podfile layout but breaks for another (e.g. the RN sample
# apps put node_modules at a different depth from RNSentryCocoaTester).
# When the link can't be staged — or the podspec is evaluated outside a
# `pod install`, where `$(PODS_ROOT)` would point at an unrelated
# sandbox — fall back to the absolute pod-install-time path: functional,
# but with a machine-specific checksum.
sentry_xcframework_ref =
stage_sentry_xcframework_in_pods(sentry_xcframework_dir, sentry_cocoa_version, 'Sentry') ||
sentry_xcframework_dir
xcframework_search_paths = SENTRY_XCFRAMEWORK_SLICES_BY_SDK.each_with_object({}) do |(sdk, slice_ids), acc|
paths = slice_ids.map { |slice| %("#{File.join(sentry_xcframework_dir, slice)}") }
paths = slice_ids.map { |slice| %("#{File.join(sentry_xcframework_ref, slice)}") }
acc["FRAMEWORK_SEARCH_PATHS[sdk=#{sdk}*]"] = (['$(inherited)'] + paths).join(' ')
end

Expand Down
68 changes: 68 additions & 0 deletions packages/core/scripts/sentry_utils.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,3 +165,71 @@ def ensure_sentry_xcframework(version, product = 'Sentry')
target_dir
end

# Directory inside the CocoaPods sandbox (`Pods/`) that holds the symlinks to
# the cached xcframeworks staged by `stage_sentry_xcframework_in_pods`.
SENTRY_XCFRAMEWORK_STAGING_DIR = 'sentry-xcframeworks'.freeze

# Stage the cached xcframework behind a machine-independent `$(PODS_ROOT)`
# reference.
#
# Everything assigned to `pod_target_xcconfig`/`user_target_xcconfig` is part
# of the evaluated spec, and CocoaPods derives the pod's `SPEC CHECKSUM` in
# `Podfile.lock` from exactly that evaluated spec. Pointing
# `FRAMEWORK_SEARCH_PATHS` at the per-user cache directory
# (`~/Library/Caches/…`) therefore leaked `$HOME` into the checksum: two
# machines installing the same SDK version produced different `RNSentry`
# checksums and `Podfile.lock` churned on every `pod install` (#6467).
#
# Instead, symlink `Pods/sentry-xcframeworks/<version>/<product>.xcframework`
# to the cached bundle and reference it as
# `$(PODS_ROOT)/sentry-xcframeworks/…` — a string that is identical on every
# machine (including ones overriding `SENTRY_XCFRAMEWORK_CACHE_DIR`).
# `$(PODS_ROOT)` is defined by CocoaPods in both the per-pod and the
# user/aggregate xcconfigs, unlike `$(PODS_TARGET_SRCROOT)`, and the link
# lives inside `Pods/` so no Podfile-layout detection is needed.
#
# Returns the `$(PODS_ROOT)`-based path, or nil when the link can't be staged
# — callers must then fall back to the absolute cache path (previous
# behaviour, functional but with a machine-specific checksum).
def stage_sentry_xcframework_in_pods(xcframework_dir, version, product = 'Sentry')
# Only stage when we're inside a real `pod install`, i.e. CocoaPods has
# located a Podfile and `sandbox_root` therefore points at the `Pods/`
# directory of the project that will consume the xcconfig. Anywhere else
# (`pod ipc spec`, `pod lib lint`, plain `Specification.from_file`) the
# sandbox root is unrelated to that project — CocoaPods evaluates a podspec
# with the CWD set to the podspec's own directory, so a guessed
# `<cwd>/Pods` would stage the link inside `node_modules/@sentry/
# react-native/` and `$(PODS_ROOT)/…` would dangle at build time. Bail out
# and let the caller use the absolute path, which is always correct.
return nil unless defined?(Pod::Config) &&
Pod::Config.instance.respond_to?(:podfile_path) &&
Pod::Config.instance.podfile_path

staging_root = File.join(Pod::Config.instance.sandbox_root.to_s, SENTRY_XCFRAMEWORK_STAGING_DIR)
staging_dir = File.join(staging_root, version)
link_path = File.join(staging_dir, "#{product}.xcframework")

FileUtils.mkdir_p(staging_dir)
# Recreate the link when it's missing or points at a stale location (e.g.
# `SENTRY_XCFRAMEWORK_CACHE_DIR` changed between installs). `rm_rf` unlinks
# the symlink itself, it does not follow it into the shared cache.
unless File.symlink?(link_path) && File.readlink(link_path) == xcframework_dir
FileUtils.rm_rf(link_path)
File.symlink(xcframework_dir, link_path)
end

# Drop links staged for other sentry-cocoa versions (left behind by SDK
# upgrades) so the directory doesn't collect dangling symlinks.
Dir.glob(File.join(staging_root, '*')).each do |stale|
FileUtils.rm_rf(stale) unless File.basename(stale) == version
end

"$(PODS_ROOT)/#{SENTRY_XCFRAMEWORK_STAGING_DIR}/#{version}/#{product}.xcframework"
rescue StandardError, NotImplementedError => e
if defined?(Pod::UI)
Pod::UI.warn "[Sentry] Could not link the #{product} xcframework into Pods/ " \
"(#{e.class}: #{e.message}). Falling back to the absolute cache path; " \
"the RNSentry checksum in Podfile.lock will be machine-specific."
end
nil

@cursor cursor Bot Jul 30, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prune errors force checksum fallback

Medium Severity

In stage_sentry_xcframework_in_pods, a failure while pruning older sentry-xcframeworks version directories is handled by the same rescue that covers symlink staging. After the current symlink is created successfully, that cleanup error makes the method return nil, so the podspec falls back to absolute cache paths in FRAMEWORK_SEARCH_PATHS and the RNSentry lockfile checksum becomes machine-specific again.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit dc4206f. Configure here.

@antonis antonis Jul 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alwx The above looks valid 👍 Feel free to handle it in a follow up if the solution is complicated.

end
Loading