feat(browsercontext): implement BrowserContext.overridePermissions #3159
Conversation
Introduce an API to manage permissions per browser context: - BrowserContext.overridePermissions(origin, permissions) - BrowserContext.resetPermissionOverrides() Fixes puppeteer#846.
| @@ -612,6 +615,11 @@ const page = await context.newPage(); | |||
| await page.goto('https://example.com'); | |||
| ``` | |||
|
|
|||
| #### browser.defaultBrowserContext() | |||
There was a problem hiding this comment.
Can we call this the mainBroswerContext to align with mainFrame?
There was a problem hiding this comment.
There's no hierarchy between browser contexts.
docs/api.md
Outdated
| #### browserContext.pages() | ||
| - returns: <[Promise]<[Array]<[Page]>>> Promise which resolves to an array of all open pages. Non visible pages, such as `"background_page"`, will not be listed here. You can find them using [target.page()](#targetpage). | ||
|
|
||
| An array of all pages inside the browser context. | ||
|
|
||
| #### browserContext.resetPermissionOverrides() |
There was a problem hiding this comment.
ClearPermissionOverrides? Reset feels like it might deny all permissions.
docs/api.md
Outdated
| #### browser.defaultBrowserContext() | ||
| - returns: <[BrowserContext]> | ||
|
|
||
| Returns default browser context. Default browser context cannot be closed. |
There was a problem hiding this comment.
Returns the default browser context. The default browser context can not be closed.
docs/api.md
Outdated
| await context.overridePermissions('https://html5demos.com', ['geolocation']); | ||
| ``` | ||
|
|
||
| > **NOTE** Permission management is scoped to browser context and is done per origins rather then |
There was a problem hiding this comment.
I tried to fix the wording of this. But instead just remove this note. The api makes it clear how it works, and nobody needs to know why.
docs/api.md
Outdated
| @@ -719,11 +727,56 @@ The default browser context is the only non-incognito browser context. | |||
|
|
|||
| Creates a new page in the browser context. | |||
|
|
|||
|
|
|||
| #### browserContext.overridePermissions(origin, permissions) | |||
| - `origin` <[string]> An [origin] to grant permissions to. | |||
There was a problem hiding this comment.
e.g. “https://example.com”
docs/api.md
Outdated
| - `'clipboard-read'` | ||
| - `'clipboard-write'` | ||
| - `'payment-handler'` | ||
| - `'flash'` (chrome-specific permission) |
There was a problem hiding this comment.
I guess it's a permission to run flash
There was a problem hiding this comment.
Removed flash for now.
docs/api.md
Outdated
|
|
||
| #### browserContext.overridePermissions(origin, permissions) | ||
| - `origin` <[string]> An [origin] to grant permissions to. | ||
| - `permissions` <[Array]<[string]>> An array of permissions to grant. All permissions that are not listed here will be automatically denied. Permission might be one of the following values: |
There was a problem hiding this comment.
Permissions can be one of the following values:
lib/Browser.js
Outdated
| * @param {string} origin | ||
| * @param {!Array<string>} permissions | ||
| */ | ||
| async _overridePermissions(contextId, origin, permissions) { |
There was a problem hiding this comment.
I feel like this code should be in the browser context. That way if we ever add a helper method for the default browser context on the browser, it won’t conflict with the internal method.
They might be if launched with pre-initialized userDataDir. |
Introduce an API to manage permissions per browser context:
Fixes #846.