Skip to content
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.

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

Update documentation to be clear that native extensions cannot be developed using UWP / WinUI3 #3191

Open
minfrin opened this issue Jun 8, 2024 · 2 comments
Labels
ADO cat: extensions Extensions-related content.

Comments

@minfrin
Copy link

minfrin commented Jun 8, 2024

The docs contain the following text:

 The app installer must create a registry key and set the default value of the key to the full path of the native messaging host manifest file.

This registry update step is impossible from an MSIX package, because of the sandboxed nature of MSIX apps. In turn, this means that neither WinUI3 nor UWP can be used to develop native web extensions, because both require MSIX.

The docs need to be updated to clearly state which Windows technologies are compatible, so that you don't end up wasting ages doing down development dead ends.


Document Details

Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

AB#51711492

@captainbrosset
Copy link
Contributor

Thank you for filing, and sorry that you're experiecing this confusion and time lost.
I'm not personally knowledgeable in this area, but I've asked other people on the team and we will update the docs based on this as soon as I know more.
In the meantime, I would suggest referring to the Windows app developer documentation for help on updating the registry on install. It seems like this article might help., if you're able to use the Windows Installer: https://learn.microsoft.com/en-us/windows/win32/msi/modifying-the-registry

@captainbrosset captainbrosset added cat: extensions Extensions-related content. ADO and removed triage-needed labels Jun 10, 2024
@minfrin
Copy link
Author

minfrin commented Jun 25, 2024

In the meantime, I would suggest referring to the Windows app developer documentation for help on updating the registry on install. It seems like this article might help., if you're able to use the Windows Installer: https://learn.microsoft.com/en-us/windows/win32/msi/modifying-the-registry

Unfortunately the link above is for the obsolete MSI installer, which has been replaced by MSIX.

To clarify, the docs need to describe a workable path from:

  • The development of the WinUI3 native extension; and
  • Packaged as modern MSIX; and
  • Findable by Microsoft Edge.

Right now this appears impossible as MSIX (note the X - not the same as MSI) sandboxes applications (a good thing) and in so doing makes it impossible for Edge and a native extension from seeing each other.

The docs either need to explicitly state that WinUI+MSIX can be used to make extensions, or explicitly state that WinUI3/MSIX cannot be used to make extensions.

Right now the docs say nothing, leaving you investing tonnes of time making a WinUI3 app, only to discover it's impossible to deploy it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ADO cat: extensions Extensions-related content.
Projects
None yet
Development

No branches or pull requests

2 participants