messaging: move docs to Markdown and never throw on calls to .notify #1817
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for content-scope-scripts ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Temporary Branch UpdateThe temporary branch has been updated with the latest changes. Below are the details:
Please use the above install command to update to the latest version. |
[Beta] Generated file diffTime updated: Fri, 11 Jul 2025 18:25:38 GMT Android
File has changed Chrome-mv3File has changed FirefoxFile has changed Integration
File has changed Windows
File has changed Apple
File has changed |
shakyShane
commented
Jul 11, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR extracts inline documentation into standalone Markdown files for better maintainability, updates the Typedoc configuration to include the new docs, and ensures .notify() calls never throw by wrapping them in a try/catch (with a corresponding unit test).
- Move native.js inline docs into
messaging/docs/Markdown files (messaging.md,implementation-guide.md,examples.md) - Update
typedoc.jsto include the top‐levelmessaging/docs/messaging.md - Wrap
transport.notifyin a silent try/catch and add a unit test to verify no exception is thrown
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| typedoc.js | Includes messaging/docs/messaging.md in the Typedoc config |
| messaging/native.js | Remove large inline doc comment, replace with module link |
| messaging/index.js | Wrap transport.notify in try/catch and update JSDoc comments |
| messaging/docs/messaging.md | New high-level Markdown overview for Messaging API |
| messaging/docs/implementation-guide.md | New platform implementation guide Markdown |
| messaging/docs/examples.md | New example payloads Markdown file |
| injected/unit-test/messaging.js | Add unit test ensuring .notify() doesn’t throw on errors |
Comments suppressed due to low confidence (1)
typedoc.js:10
- The Typedoc include pattern currently only adds
messaging/docs/messaging.md, but theimplementation-guide.mdandexamples.mdfiles won't be processed. Consider changing it to a glob likemessaging/docs/*.mdor adding individual entries for those Markdown files so all docs are published.
'messaging/docs/messaging.md',
jonathanKingston
approved these changes
Jul 11, 2025
|
@cursor anything to add? |
Leave me unread then. 😢 |
No, the bridge only delegates to the transports regardless. |
…ver_throw_on_calls_to_.notify
mallexxx
pushed a commit
that referenced
this pull request
Jul 17, 2025
…1817) * messaging: move docs to Markdown and never throw on calls to .notify * add development debugging so that generic implementation errors are not lost
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Asana Task/Github Issue: https://app.asana.com/1/137249556945/project/1201141132935289/task/1210768128803703?focus=true
Description
Small improvements towards https://app.asana.com/1/137249556945/project/1201141132935289/task/1210680503659356?focus=true
Testing Steps
Checklist
Please tick all that apply: