[Gutenberg] Add error boundary components and exception logging by fluiddot · Pull Request #22655 · wordpress-mobile/WordPress-iOS

fluiddot · 2024-02-21T10:29:25Z

Related PRs:

[RNMobile] Add error boundary components and exception logging WordPress/gutenberg#59221
Add error boundary components and exception logging gutenberg-mobile#6655
Add support to log JavaScript exceptions to Sentry Automattic/Automattic-Tracks-iOS#278

This PR enables the error boundary at the editor and block level. It also connects Gutenberg Mobile to the Crash logging service in order to log JavaScript exceptions.

Additionally, it uploads to Sentry the JavaScript source map included in the GBM XCFramework.

To test:
Follow testing instructions from wordpress-mobile/gutenberg-mobile#6655.

Regression Notes

Potential unintended areas of impact
None on the user-facing side as this PR mainly implements a new RN bridge function. However, it also adds a step in the build process that if fails might disrupt the release process.
What I did to test those areas of impact (or what existing automated tests I relied on)
I manually tested the build process for alpha builds. I didn't cover beta and app store builds, but the only error I foresee that it might introduce is tagging the source map files with a wrong release version. We'll work with Apps Infra team closely in the release where these changes are introduced to validate the source map files are properly uploaded.
What automated tests I added (or what prevented me from doing so)
N/A

PR submission checklist:

I have completed the Regression Notes.
I have considered adding unit tests for my changes.
I have considered adding accessibility improvements for my changes.
I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

Testing checklist:

wpmobilebot · 2024-02-21T10:39:09Z

📲 You can test the changes from this Pull Request in WordPress Alpha by scanning the QR code below to install the corresponding build.

	App Name	WordPress Alpha
	Configuration	Release-Alpha
	Build Number	pr22655-eff477f
	Version	24.4
	Bundle ID	org.wordpress.alpha
	Commit	`eff477f`
	App Center Build	WPiOS - One-Offs #9120

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

wpmobilebot · 2024-02-21T10:40:10Z

📲 You can test the changes from this Pull Request in Jetpack Alpha by scanning the QR code below to install the corresponding build.

	App Name	Jetpack Alpha
	Configuration	Release-Alpha
	Build Number	pr22655-eff477f
	Version	24.4
	Bundle ID	com.jetpack.alpha
	Commit	`eff477f`
	App Center Build	jetpack-installable-builds #8163

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

fluiddot · 2024-02-26T13:16:10Z

+    upload_gutenberg_sourcemaps(
+      sentry_project_slug: SENTRY_PROJECT_SLUG_WORDPRESS,
+      release_version: release_version_current,
+      build_version: build_code_current,
+      app_identifier: WORDPRESS_BUNDLE_IDENTIFIER
+    )


This source map will be used for the App Store builds (beta and production) of the WordPress app.

fluiddot · 2024-02-26T13:17:01Z

+    upload_gutenberg_sourcemaps(
+      sentry_project_slug: SENTRY_PROJECT_SLUG_JETPACK,
+      release_version: release_version_current,
+      build_version: build_code_current,
+      app_identifier: JETPACK_BUNDLE_IDENTIFIER
+    )


This source map will be used for the App Store builds (beta and production) of the Jetpack app.

fluiddot · 2024-02-26T13:17:28Z

+    upload_gutenberg_sourcemaps(
+      sentry_project_slug: SENTRY_PROJECT_SLUG_WORDPRESS,
+      release_version: release_version_current_internal,
+      build_version: build_code_current_internal,
+      app_identifier: 'org.wordpress.internal'
+    )


This source map will be used for the internal builds of the WordPress app. As far as I checked, this version is seems no longer used.

fluiddot · 2024-02-26T13:18:50Z

+    upload_gutenberg_sourcemaps(
+      sentry_project_slug: sentry_project_slug,
+      release_version: release_version_current,
+      build_version: build_number,
+      app_identifier: app_identifier
+    )


This source map will be used for the alpha builds (i.e. installable builds in PRs). The app is determined by the app_identifier parameter.

fluiddot · 2024-02-26T13:20:39Z

+    # The bundle and source map files are the same for all architectures.
+    gutenberg_bundle = File.join(PROJECT_ROOT_FOLDER, "Pods/Gutenberg/Frameworks/Gutenberg.xcframework/ios-arm64/Gutenberg.framework")


As specified in the inline comment, the bundle and source map files are included for each architecture. However, both files are the same, as the JavaScript code isn't affected by the architecture. Hence, we can use the files from any of the architectures.

fluiddot · 2024-02-26T13:22:15Z

 # Update the matching .inputs.xcfilelist when changing these
 XCFRAMEWORK_BUNDLE_ROOT="$PODS_XCFRAMEWORKS_BUILD_DIR/Gutenberg/Gutenberg.framework"
 PODS_BUNDLE_ROOT="$PODS_ROOT/Gutenberg/bundle/ios"
+LOCAL_BUNDLE="$PODS_ROOT/../../gutenberg-mobile/bundle/ios"


When testing a production version of the JS bundle in local builds, I noticed we don't have a quick way to use a local bundle. For this reason, I added a third option to fetch the bundle by pointing to a local path.

The option to fetch the bundle form $PODS_ROOT/Gutenberg/bundle/ios seems to be deprecated as the library is provided with the XCFramework. We could remove it.

…vice

# Conflicts: # Gutenberg/config.yml # Podfile.lock

jhnstn

The test build worked from wordpress-mobile/gutenberg-mobile#6654) worked as expected.

Looks like there are some linting issues but otherwise looks good to go.
Nice work @fluiddot !

fluiddot · 2024-03-08T09:33:04Z

Looks like there are some linting issues but otherwise looks good to go.

The only remaining dangermattic error is the Tracks reference to a branch. Once Automattic/Automattic-Tracks-iOS#280 is merged, I'll update it with the release tag.

fluiddot added 4 commits February 20, 2024 18:13

Update Automattic-Tracks-iOS pod to point to branch

d6202c3

Add function to log JavaScript exceptions to Crash Logging service

1cd609b

Add step to copy local bundle

804b772

Update Gutenberg Mobile reference

89645c2

fluiddot added the Gutenberg Editing and display of Gutenberg blocks. label Feb 21, 2024

This was referenced Feb 21, 2024

Add support to log JavaScript exceptions to Sentry Automattic/Automattic-Tracks-iOS#278

Merged

Add error boundary components and exception logging wordpress-mobile/gutenberg-mobile#6655

Merged

fluiddot added 7 commits February 22, 2024 18:19

Add fastlane step to upload Gutenberg source map

edbc5da

Update Gutenberg Mobile reference

481a47d

Add build and app_identifier parameters to upload source maps

9f0b36c

Use correct app identifier for internal/alpha/prototype builds

c034cc5

Use callback when logging JS exception

6fbfb59

Upate Podfile.lock

cbc74d2

Update Gutenberg Mobile reference

1b900e2

fluiddot commented Feb 26, 2024

View reviewed changes

Parse JavaScript exception before sending it to the Crash logging ser…

9ea8dbd

…vice

fluiddot changed the title ~~[Gutenberg] Add error boundary components and exception reporting~~ [Gutenberg] Add error boundary components and exception logging Feb 28, 2024

Update Gutenberg Mobile reference and Automattic-Tracks-iOS pod

8566c1b

fluiddot marked this pull request as ready for review February 28, 2024 12:38

fluiddot requested a review from jhnstn February 28, 2024 12:38

fluiddot added 2 commits February 29, 2024 13:23

Rename JSException param to message

037244d

Update Gutenberg Mobile reference and Automattic-Tracks-iOS pod

f4fd4a8

fluiddot mentioned this pull request Mar 1, 2024

[Gutenberg] Add error boundary components and exception logging wordpress-mobile/WordPress-Android#20359

Merged

13 tasks

fluiddot added 3 commits March 6, 2024 18:24

Merge branch 'trunk' into rnmobile/add/log-exception-to-crash-logging

18269e4

# Conflicts: # Gutenberg/config.yml # Podfile.lock

Update Podfile.lock

e58b8b1

Conform Automattic Tracks protocol for JSException

a1a692f

dangermattic reviewed Mar 6, 2024

View reviewed changes

Comment thread fastlane/lanes/build.rb Outdated

dangermattic reviewed Mar 6, 2024

View reviewed changes

Comment thread fastlane/lanes/build.rb Outdated

dangermattic reviewed Mar 6, 2024

View reviewed changes

Comment thread fastlane/lanes/build.rb Outdated

dangermattic reviewed Mar 6, 2024

View reviewed changes

Comment thread fastlane/lanes/build.rb Outdated

dangermattic reviewed Mar 6, 2024

View reviewed changes

Comment thread fastlane/lanes/build.rb Outdated

dangermattic reviewed Mar 6, 2024

View reviewed changes

Comment thread fastlane/lanes/build.rb Outdated

dangermattic reviewed Mar 6, 2024

View reviewed changes

Comment thread fastlane/lanes/build.rb Outdated

dangermattic reviewed Mar 6, 2024

View reviewed changes

Comment thread fastlane/lanes/build.rb Outdated

fluiddot added 4 commits March 7, 2024 10:54

Update GutenbergJSException extension

a355e40

Update Gutenberg Mobile reference and Automattic-Tracks-iOS pod

d7cbf8b

Update release notes

f2791d6

Address dangermattic issues

3f5b7cb

dangermattic reviewed Mar 7, 2024

View reviewed changes

Comment thread fastlane/lanes/build.rb Outdated

Address dangermattic issues

a2259f1

jhnstn approved these changes Mar 7, 2024

View reviewed changes

fluiddot added 2 commits March 11, 2024 09:14

Update Tracks to version 3.3

eb83b4c

Update Podfile.lock

d496af0

fluiddot added this to the 24.5 milestone Mar 11, 2024

Update Gutenberg Mobile reference

eff477f

fluiddot added the Observability label Mar 11, 2024

fluiddot enabled auto-merge March 11, 2024 18:08

fluiddot merged commit 6b28a9d into trunk Mar 11, 2024

fluiddot deleted the rnmobile/add/log-exception-to-crash-logging branch March 11, 2024 18:16

		# The bundle and source map files are the same for all architectures.
		gutenberg_bundle = File.join(PROJECT_ROOT_FOLDER, "Pods/Gutenberg/Frameworks/Gutenberg.xcframework/ios-arm64/Gutenberg.framework")

Conversation

fluiddot commented Feb 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Regression Notes

Uh oh!

wpmobilebot commented Feb 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wpmobilebot commented Feb 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fluiddot Feb 26, 2024

Choose a reason for hiding this comment

Uh oh!

fluiddot Feb 26, 2024

Choose a reason for hiding this comment

Uh oh!

fluiddot Feb 26, 2024

Choose a reason for hiding this comment

Uh oh!

fluiddot Feb 26, 2024

Choose a reason for hiding this comment

Uh oh!

fluiddot Feb 26, 2024

Choose a reason for hiding this comment

Uh oh!

fluiddot Feb 26, 2024

Choose a reason for hiding this comment

Uh oh!

fluiddot Feb 26, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jhnstn left a comment

Choose a reason for hiding this comment

Uh oh!

fluiddot commented Mar 8, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fluiddot commented Feb 21, 2024 •

edited

Loading

wpmobilebot commented Feb 21, 2024 •

edited

Loading

wpmobilebot commented Feb 21, 2024 •

edited

Loading