[V3] Add universal link support for macOS #4712
Conversation
…nk support on macOS.
WalkthroughRenames the C-exported URL handler from Changes
Sequence Diagram(s)sequenceDiagram
participant Apple as Apple OS
participant Delegate as AppDelegate
participant Go as Go runtime
rect rgb(248, 249, 255)
note over Apple,Delegate: Apple Event (Custom URL Scheme)
Apple->>Delegate: handleGetURLEvent:withReplyEvent:
Delegate->>Go: HandleOpenURL(urlString)
Go->>Go: Parse URL & emit ApplicationLaunchedWithUrl
end
rect rgb(240, 255, 245)
note over Apple,Delegate: Universal Link (NSUserActivity)
Apple->>Delegate: application:continueUserActivity:restorationHandler:
Delegate->>Delegate: check NSUserActivityTypeBrowsingWeb & webpageURL
Delegate->>Go: HandleOpenURL(webpageURL)
Go->>Go: Parse URL & emit ApplicationLaunchedWithUrl
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Thanks 🙏 Please could you add an entry to the changelog located at |
|
@leaanthony added |
github-actions
bot
added
the
Documentation
|
Would it be possible to have some short documentation on how to use this feature? I'm ok having that in a later PR if we make a ticket for it 👍 Will be updating the docs significantly over the weekend so I'm ok to delay it 👍 |
|
@leaanthony happy to add docs for v3, however can't see v3 site docs in repo. Where should I add it? |
Amazing! 🎉 They are in |
…nto v3/mac-universal-links
|
@leaanthony added |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/src/content/docs/guides/custom-protocol-association.mdx(2 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: APshenkin
Repo: wailsapp/wails PR: 4484
File: v2/internal/frontend/utils/urlValidator.go:25-31
Timestamp: 2025-08-08T13:15:20.339Z
Learning: In Wails v2 (PR wailsapp/wails#4484), for BrowserOpenURL URL validation (v2/internal/frontend/utils/urlValidator.go), maintainers (APshenkin) prefer not to restrict schemes to an http/https allowlist because supported schemes may vary. The allowlist suggestion is declined; continue with the existing denylist approach and generic validation.
📚 Learning: 2025-08-08T13:15:20.339Z
Learnt from: APshenkin
Repo: wailsapp/wails PR: 4484
File: v2/internal/frontend/utils/urlValidator.go:25-31
Timestamp: 2025-08-08T13:15:20.339Z
Learning: In Wails v2 (PR wailsapp/wails#4484), for BrowserOpenURL URL validation (v2/internal/frontend/utils/urlValidator.go), maintainers (APshenkin) prefer not to restrict schemes to an http/https allowlist because supported schemes may vary. The allowlist suggestion is declined; continue with the existing denylist approach and generic validation.
Applied to files:
docs/src/content/docs/guides/custom-protocol-association.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Run Go Tests v3 (windows-latest, 1.24)
- GitHub Check: Run Go Tests v3 (ubuntu-latest, 1.24)
- GitHub Check: Run Go Tests v3 (macos-latest, 1.24)
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (2)
docs/src/content/docs/guides/custom-protocol-association.mdx (2)
112-113: Good clarification on macOS LaunchServices behavior.The added explanation of how macOS delivers custom protocol URLs via LaunchServices and Apple Events is accurate and helpful context for users.
160-177: Verify Windows Web-to-App linking implementation and scope.The Windows Web-to-App linking section references MSIX packaging. However, based on the PR description, the changes were tested only on macOS (not on Windows). Please verify:
- Is Web-to-App linking actually implemented in the Wails runtime for Windows?
- Does this feature work only with MSIX packages, or is it also supported when distributed via NSIS (the traditional Wails Windows installer approach)?
- Does the Windows implementation emit
ApplicationLaunchedWithUrlfor Web-to-App links as documented?If this feature is not yet fully implemented or tested on Windows, consider adding a note clarifying the current support status or deferring this section to a follow-up PR once implementation and testing are complete.
|
@leaanthony added. Was blind to not find folder with docs 😀 |
|
2 participants
Description
This PR backports https://github.com/wailsapp/wails/pull/4693/files to V3
Fixes # (issue)
Type of change
Please select the option that is relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using
wails doctor.If you checked Linux, please specify the distro and version.
Test Configuration
Please paste the output of
wails doctor. If you are unable to run this command, please describe your environment in as much detail as possible.Checklist:
website/src/pages/changelog.mdxwith details of this PRSummary by CodeRabbit
New Features
Refactor
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.