feat: add ElectronContextBridgeProvider

[trulysinclair]

Closes #2618

PR Type

• Feature

Description of the changes

This PR adds the ElectronContextBridgeProvider which adds support for Electron applications that use the isolated context and preload scripts. Developers using this provider MUST follow the steps included in the README to set up a contextBridge that correctly implements the IContextBridgeImpl interface. I've opted to pass the defined contextBridge object to the provider so that the developer is able to freely name the context bridge api without being forced to use "main" or "electronApi", etc.

PR checklist

• Project builds (yarn build) and changes have been tested in at least two supported browsers (Edge + non-Chromium based browser)
• All public APIs (classes, methods, etc) have been documented following the jsdoc syntax
• Stories have been added and existing stories have been tested
• Added appropriate documentation. Docs PR:

• License header has been added to all new source files (yarn setLicense)
• Contains NO breaking changes

Other information

[trulysinclair]

@microsoft-github-policy-service agree

[gavinbarron]

This is excellent stuff and much needed, so thank you @trulysinclair

What do you think of bumping to a recent version of Electron?

[trulysinclair]

Thank you, and the only usage of Electron is BrowserWindow, ipcMain, ipcRenderer, and protocol. The current version is 28 stable, and currently 11 is in use. These four APIs haven't seen any breaking changes that would conflict from what I've seen, so I'd say its safe to upgrade to the latest version.

[trulysinclair]

This may need to be halted, while the context bridge and everything works fine, attempting to use the react wrapper causes issues with 'require' is not defined, or not being able to reach into node_modules. For this context provider to work fully, those components would also need to work without nodeIntegration set to true.

This was a massive oversight on my end, I apologize.

EDIT: Never mind, the issue was the Content Security Policy not allowing MGT to fetch the necessary URLs. Easily fixed.

[sebastienlevert]

@trulysinclair thanks for this PR! It's amazing to see this, I am sure our Electron devs will be very thankful for this great change! It may take some time because of the Holiday season to process, but this is not forgotten! I added the related bug to out v4 milestone that will land in early 2024, so not only this will be fixed, but it will be part of a great major release! I'll let the engineers review and comment on the PR, but I'm excited for this scenario! Thanks!

[gavinbarron]

This is great stuff!

Thank you so much for providing this improvement @trulysinclair

[trulysinclair]

This is great stuff!

Thank you so much for providing this improvement @trulysinclair

Thank you! I'm glad I could contribute to this awesome toolkit!

[gavinbarron]

Hey @trulysinclair are you able to help out with a sample app on this?

I've been trying to get this running and keep running into issues with electron that I'm sure a developer experienced with electron would solve quickly, but I'm not that person and would greatly appreciate the help on this one.

[trulysinclair]

@gavinbarron absolutely, I've been using it in production I can extract what works for a sample app

[gavinbarron]

@trulysinclair Thank you, perhaps we could PR it to replace the existing https://github.com/pnp/mgt-samples/tree/main/samples/app/electron-app

[trulysinclair]

@gavinbarron Would you prefer a second one, that way both with and without contextBridge exist for devs who may opt out of isolation for prototyping?

[gavinbarron]

That would be fantastic! Although part of me thinks we should be guiding folks towards the more secure and preferred ContextBridge approach

[trulysinclair]

That's a good point, I'll rewrite the existing unsafe example