Originally, the polyfill created a Proxy with the original API object as
the target. This was changed to `Object.create(chrome)` because not
doing so would prevent the `browser.devtools` API from working because
the devtools API object is assigned as a read-only & non-configurable
property (#57).
However, that action itself caused a new bug: Whenever an API object
is dereferenced via the `browser` namespace, the original API is no
longer available in the `chrome` namespace, and trying to access the
API through `chrome` returns `undefined` plus the "Previous API
instantiation failed" warning (#58).
This is because Chrome lazily initializes fields in the `chrome`
API, but on the object from which the property is accessed, while
the polyfill accessed the property through an object with the
prototype set to `chrome` instead of directly via chrome.
To fix that, `Object.create(chrome)` was replaced with
`Object.assign({}, chrome)`. This fixes both of the previous issues
because
1) It is still a new object.
2) All lazily initialized fields are explicitly initialized.
This fix created a new issue: In Chrome some APIs cannot be used even
though they are visible in the API (e.g. `chrome.clipboard`), so
calling `Object.assign({}, chrome)` causes an error to be printed to
the console (#70).
To solve this, I use `Object.create(chrome)` again as a proxy target,
but dereference the API via the original target (`chrome`) to not
regress on #58.
Besides fixing the bug, this also reduces the performance impact
of the API because all API fields are lazily initialized again,
instead of upon start-up.
This fixes#70.
To be able to wrap the devtools API namespaces, this patch applies the
following changes:
- fix: Prevent Proxy violation exception on the read-only/non-configurable devtools property
by using an empty object with the `chrome` API object as its prototype
as the root Proxy target (the Proxy instances returned for the
`chrome` API object) and add a related test case.
- fix: Added support for a new `singleCallbackArg` metadata property,
which prevents devtools.panels.create to resolve an array of
parameters (See the related Chromium issue at
https://bugs.chromium.org/p/chromium/issues/detail?id=768159)
and add the related test cases.
- test: Changes to the test case related to proxy getter/setter behavior
on non wrapped properties:
in the "deletes proxy getter/setter that are not wrapped" test case from
the "test-proxied-properties.js" test file, we ensure that when a
getter/setter is called for a "non-wrapped" property, the getter/setter
is going to affect the original target object, unfortunately this in
not true anymore for the root object (the `chrome` API object) because
we are using an empty object (which has the `chrome` API object as its
prototype and it is not exposed outside of the polyfill sources)
as the target of the Proxy instance related to it,
this change to the target of the Proxy has been needed to prevent the
TypeError exception raised by the Proxy instance when we try to access
the "devtools" property (which is non-configurable and read-only on the
`chrome` API object).
This addresses [issue 7] by making it possible for users to run:
```sh
npm install webextension-polyfill
```
and download a module that they can use with a bundler as follows:
```js
import browser from 'webextension-polyfill';
```
Also, add a [prepublish script] so that users who clone the repo don't
need to run `grunt` manually. In addition, specify [files] in
package.json so that this module can be published to npm without
including miscellanea. This can be verified by running:
```sh
npm pack && tar -tvf webextension-polyfill-0.1.0.tgz
```
[issue 7]: https://github.com/mozilla/webextension-polyfill/issues/7
[files]: https://docs.npmjs.com/files/package.json#files
[prepublish script]: https://docs.npmjs.com/misc/scripts
- if the a browser global already exists, it should not be overridden
- use Object.defineProperty on the wrapped browser global
(and test "has" for cached properties)
- delete a property defined with Object.defineProperty
- methods that are not wrapped are proxied correctly
- the special onMessage wrapper should not wrap a listener that is not
a function
- test that a returned rejected Promise on the onMessage listener
is turned in the parameter of the sendResponse callback
Luca Greco
Rob Wu
Luca Greco
Joseph Frazier