Skip to content

Commit

Permalink
Ensure promise-typed operations and attributes return promises
Browse files Browse the repository at this point in the history 
Closes #79.

This removes support for overloading promise operations and non-promise operations, per whatwg/webidl#776.
  • Loading branch information
@domenic
domenic authored Apr 27, 2020
1 parent 96a008e commit f7520b3
Show file tree
Hide file tree
Showing 6 changed files with 288 additions and 3 deletions.
10 changes: 10 additions & 0 deletions lib/constructs/attribute.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ class Attribute {

const onInstance = utils.isOnInstance(this.idl, this.interface.idl);

const async = this.idl.idlType.generic === "Promise";
const promiseHandlingBefore = async ? `try {` : ``;
const promiseHandlingAfter = async ? `} catch (e) { return Promise.reject(e); }` : ``;

let brandCheck = `
if (!exports.is(esValue)) {
throw new TypeError("Illegal invocation");
Expand Down Expand Up @@ -72,12 +76,18 @@ class Attribute {
}

addMethod(this.idl.name, [], `
${promiseHandlingBefore}
const esValue = this !== null && this !== undefined ? this : globalObject;
${brandCheck}
${getterBody}
${promiseHandlingAfter}
`, "get", { configurable });

if (!this.idl.readonly) {
if (async) {
throw new Error(`Illegal promise-typed attribute "${this.idl.name}" in interface "${this.interface.idl.name}"`);
}

let idlConversion;
if (typeof this.idl.idlType.idlType === "string" && !this.idl.idlType.nullable &&
this.ctx.enumerations.has(this.idl.idlType.idlType)) {
Expand Down
21 changes: 21 additions & 0 deletions lib/constructs/operation.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,22 @@ class Operation {
return firstOverloadOnInstance;
}

isAsync() {
// As of the time of this writing, the current spec does not disallow such overloads, but the intention is to do so:
// https://github.com/heycam/webidl/pull/776
const firstAsync = this.idls[0].idlType.generic === "Promise";
for (const overload of this.idls.slice(1)) {
const isAsync = overload.idlType.generic === "Promise";
if (isAsync !== firstAsync) {
throw new Error(
`Overloading between Promise and non-Promise return types is not allowed: operation ` +
`"${this.name}" on ${this.interface.name}`
);
}
}
return firstAsync;
}

fixUpArgsExtAttrs() {
for (const idl of this.idls) {
for (const arg of idl.arguments) {
Expand All @@ -50,6 +66,9 @@ class Operation {
}

const onInstance = this.isOnInstance();
const async = this.isAsync();
const promiseHandlingBefore = async ? `try {` : ``;
const promiseHandlingAfter = async ? `} catch (e) { return Promise.reject(e); }` : ``;

const type = this.static ? "static operation" : "regular operation";
const overloads = Overloads.getEffectiveOverloads(type, this.name, 0, this.interface);
Expand Down Expand Up @@ -100,6 +119,8 @@ class Operation {
}
str += invocation;

str = promiseHandlingBefore + str + promiseHandlingAfter;

if (this.static) {
this.interface.addStaticMethod(this.name, argNames, str);
} else {
Expand Down
246 changes: 244 additions & 2 deletions test/__snapshots__/test.js.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,24 @@ exports.install = (globalObject, globalNames) => {
}
}

promiseOperation() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;
if (!exports.is(esValue)) {
throw new TypeError(\\"Illegal invocation\\");
}

CEReactions.preSteps(globalObject);
try {
return utils.tryWrapperForImpl(esValue[implSymbol].promiseOperation());
} finally {
CEReactions.postSteps(globalObject);
}
} catch (e) {
return Promise.reject(e);
}
}

get attr() {
const esValue = this !== null && this !== undefined ? this : globalObject;

Expand Down Expand Up @@ -479,10 +497,31 @@ exports.install = (globalObject, globalNames) => {
CEReactions.postSteps(globalObject);
}
}

get promiseAttribute() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;

if (!exports.is(esValue)) {
throw new TypeError(\\"Illegal invocation\\");
}

CEReactions.preSteps(globalObject);
try {
return utils.tryWrapperForImpl(esValue[implSymbol][\\"promiseAttribute\\"]);
} finally {
CEReactions.postSteps(globalObject);
}
} catch (e) {
return Promise.reject(e);
}
}
}
Object.defineProperties(CEReactions.prototype, {
method: { enumerable: true },
promiseOperation: { enumerable: true },
attr: { enumerable: true },
promiseAttribute: { enumerable: true },
[Symbol.toStringTag]: { value: \\"CEReactions\\", configurable: true }
});
if (globalObject[ctorRegistrySymbol] === undefined) {
Expand Down Expand Up @@ -3555,7 +3594,43 @@ exports.createImpl = (globalObject, constructorArgs, privateData) => {
return utils.implForWrapper(wrapper);
};

exports._internalSetup = (wrapper, globalObject) => {};
exports._internalSetup = (wrapper, globalObject) => {
Object.defineProperties(
wrapper,
Object.getOwnPropertyDescriptors({
unforgeablePromiseOperation() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;
if (!exports.is(esValue)) {
throw new TypeError(\\"Illegal invocation\\");
}

return utils.tryWrapperForImpl(esValue[implSymbol].unforgeablePromiseOperation());
} catch (e) {
return Promise.reject(e);
}
},
get unforgeablePromiseAttribute() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;

if (!exports.is(esValue)) {
throw new TypeError(\\"Illegal invocation\\");
}

return utils.tryWrapperForImpl(esValue[implSymbol][\\"unforgeablePromiseAttribute\\"]);
} catch (e) {
return Promise.reject(e);
}
}
})
);

Object.defineProperties(wrapper, {
unforgeablePromiseOperation: { configurable: false, writable: false },
unforgeablePromiseAttribute: { configurable: false }
});
};

exports.setup = (wrapper, globalObject, constructorArgs = [], privateData = {}) => {
privateData.wrapper = wrapper;
Expand Down Expand Up @@ -3655,12 +3730,63 @@ exports.install = (globalObject, globalNames) => {
}
return esValue[implSymbol].promiseConsumer(...args);
}

promiseOperation() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;
if (!exports.is(esValue)) {
throw new TypeError(\\"Illegal invocation\\");
}

return utils.tryWrapperForImpl(esValue[implSymbol].promiseOperation());
} catch (e) {
return Promise.reject(e);
}
}

get promiseAttribute() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;

if (!exports.is(esValue)) {
throw new TypeError(\\"Illegal invocation\\");
}

return utils.tryWrapperForImpl(esValue[implSymbol][\\"promiseAttribute\\"]);
} catch (e) {
return Promise.reject(e);
}
}

static staticPromiseOperation() {
try {
return utils.tryWrapperForImpl(Impl.implementation.staticPromiseOperation());
} catch (e) {
return Promise.reject(e);
}
}

static get staticPromiseAttribute() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;

return Impl.implementation[\\"staticPromiseAttribute\\"];
} catch (e) {
return Promise.reject(e);
}
}
}
Object.defineProperties(PromiseTypes.prototype, {
voidPromiseConsumer: { enumerable: true },
promiseConsumer: { enumerable: true },
promiseOperation: { enumerable: true },
promiseAttribute: { enumerable: true },
[Symbol.toStringTag]: { value: \\"PromiseTypes\\", configurable: true }
});
Object.defineProperties(PromiseTypes, {
staticPromiseOperation: { enumerable: true },
staticPromiseAttribute: { enumerable: true }
});
if (globalObject[ctorRegistrySymbol] === undefined) {
globalObject[ctorRegistrySymbol] = Object.create(null);
}
Expand Down Expand Up @@ -9166,6 +9292,19 @@ exports.install = (globalObject, globalNames) => {
return esValue[implSymbol].method();
}

promiseOperation() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;
if (!exports.is(esValue)) {
throw new TypeError(\\"Illegal invocation\\");
}

return utils.tryWrapperForImpl(esValue[implSymbol].promiseOperation());
} catch (e) {
return Promise.reject(e);
}
}

get attr() {
const esValue = this !== null && this !== undefined ? this : globalObject;

Expand All @@ -9189,10 +9328,26 @@ exports.install = (globalObject, globalNames) => {

esValue[implSymbol][\\"attr\\"] = V;
}

get promiseAttribute() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;

if (!exports.is(esValue)) {
throw new TypeError(\\"Illegal invocation\\");
}

return utils.tryWrapperForImpl(esValue[implSymbol][\\"promiseAttribute\\"]);
} catch (e) {
return Promise.reject(e);
}
}
}
Object.defineProperties(CEReactions.prototype, {
method: { enumerable: true },
promiseOperation: { enumerable: true },
attr: { enumerable: true },
promiseAttribute: { enumerable: true },
[Symbol.toStringTag]: { value: \\"CEReactions\\", configurable: true }
});
if (globalObject[ctorRegistrySymbol] === undefined) {
Expand Down Expand Up @@ -12249,7 +12404,43 @@ exports.createImpl = (globalObject, constructorArgs, privateData) => {
return utils.implForWrapper(wrapper);
};

exports._internalSetup = (wrapper, globalObject) => {};
exports._internalSetup = (wrapper, globalObject) => {
Object.defineProperties(
wrapper,
Object.getOwnPropertyDescriptors({
unforgeablePromiseOperation() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;
if (!exports.is(esValue)) {
throw new TypeError(\\"Illegal invocation\\");
}

return utils.tryWrapperForImpl(esValue[implSymbol].unforgeablePromiseOperation());
} catch (e) {
return Promise.reject(e);
}
},
get unforgeablePromiseAttribute() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;

if (!exports.is(esValue)) {
throw new TypeError(\\"Illegal invocation\\");
}

return utils.tryWrapperForImpl(esValue[implSymbol][\\"unforgeablePromiseAttribute\\"]);
} catch (e) {
return Promise.reject(e);
}
}
})
);

Object.defineProperties(wrapper, {
unforgeablePromiseOperation: { configurable: false, writable: false },
unforgeablePromiseAttribute: { configurable: false }
});
};

exports.setup = (wrapper, globalObject, constructorArgs = [], privateData = {}) => {
privateData.wrapper = wrapper;
Expand Down Expand Up @@ -12349,12 +12540,63 @@ exports.install = (globalObject, globalNames) => {
}
return esValue[implSymbol].promiseConsumer(...args);
}

promiseOperation() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;
if (!exports.is(esValue)) {
throw new TypeError(\\"Illegal invocation\\");
}

return utils.tryWrapperForImpl(esValue[implSymbol].promiseOperation());
} catch (e) {
return Promise.reject(e);
}
}

get promiseAttribute() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;

if (!exports.is(esValue)) {
throw new TypeError(\\"Illegal invocation\\");
}

return utils.tryWrapperForImpl(esValue[implSymbol][\\"promiseAttribute\\"]);
} catch (e) {
return Promise.reject(e);
}
}

static staticPromiseOperation() {
try {
return utils.tryWrapperForImpl(Impl.implementation.staticPromiseOperation());
} catch (e) {
return Promise.reject(e);
}
}

static get staticPromiseAttribute() {
try {
const esValue = this !== null && this !== undefined ? this : globalObject;

return Impl.implementation[\\"staticPromiseAttribute\\"];
} catch (e) {
return Promise.reject(e);
}
}
}
Object.defineProperties(PromiseTypes.prototype, {
voidPromiseConsumer: { enumerable: true },
promiseConsumer: { enumerable: true },
promiseOperation: { enumerable: true },
promiseAttribute: { enumerable: true },
[Symbol.toStringTag]: { value: \\"PromiseTypes\\", configurable: true }
});
Object.defineProperties(PromiseTypes, {
staticPromiseOperation: { enumerable: true },
staticPromiseAttribute: { enumerable: true }
});
if (globalObject[ctorRegistrySymbol] === undefined) {
globalObject[ctorRegistrySymbol] = Object.create(null);
}
Expand Down
Loading

0 comments on commit f7520b3

Please sign in to comment.