forked from mirrors/gecko-dev
b2e044ccd4
This is the first part of a bigger patch to make WebConsoleFront methods consumers handle fronts instead of plain grips. The main challenge with most of console methods is that the server can return either a primitive, an object that represent a primitive (undefined, null, Infinity, ...), a longString grip or an object grip. Since this would be complex to map as a protocol.js type, this patch either override the methods where we want to return fronts, or intercept events with the `before` method on them. The response is then handled to a function that will iteratore of the result object in a recursive manner, and create fronts when needed. Differential Revision: https://phabricator.services.mozilla.com/D54506 --HG-- extra : moz-landing-system : lando
85 lines
2.1 KiB
JavaScript
85 lines
2.1 KiB
JavaScript
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
"use strict";
|
|
|
|
const protocol = require("devtools/shared/protocol");
|
|
const { Arg, RetVal, generateActorSpec } = protocol;
|
|
|
|
const longStringSpec = generateActorSpec({
|
|
typeName: "longstractor",
|
|
|
|
methods: {
|
|
substring: {
|
|
request: {
|
|
start: Arg(0),
|
|
end: Arg(1),
|
|
},
|
|
response: { substring: RetVal() },
|
|
},
|
|
release: { release: true },
|
|
},
|
|
});
|
|
|
|
exports.longStringSpec = longStringSpec;
|
|
|
|
/**
|
|
* When a caller is expecting a LongString actor but the string is already available on
|
|
* client, the SimpleStringFront can be used as it shares the same API as a
|
|
* LongStringFront but will not make unnecessary trips to the server.
|
|
*/
|
|
class SimpleStringFront {
|
|
constructor(str) {
|
|
this.str = str;
|
|
}
|
|
|
|
get length() {
|
|
return this.str.length;
|
|
}
|
|
|
|
get initial() {
|
|
return this.str;
|
|
}
|
|
|
|
string() {
|
|
return Promise.resolve(this.str);
|
|
}
|
|
|
|
substring(start, end) {
|
|
return Promise.resolve(this.str.substring(start, end));
|
|
}
|
|
|
|
release() {
|
|
this.str = null;
|
|
return Promise.resolve(undefined);
|
|
}
|
|
}
|
|
|
|
exports.SimpleStringFront = SimpleStringFront;
|
|
|
|
// The long string actor needs some custom marshalling, because it is sometimes
|
|
// returned as a primitive rather than a complete form.
|
|
|
|
var stringActorType = protocol.types.getType("longstractor");
|
|
protocol.types.addType("longstring", {
|
|
_actor: true,
|
|
write: (value, context, detail) => {
|
|
if (!(context instanceof protocol.Actor)) {
|
|
throw Error("Passing a longstring as an argument isn't supported.");
|
|
}
|
|
|
|
if (value.short) {
|
|
return value.str;
|
|
}
|
|
return stringActorType.write(value, context, detail);
|
|
},
|
|
read: (value, context, detail) => {
|
|
if (context instanceof protocol.Actor) {
|
|
throw Error("Passing a longstring as an argument isn't supported.");
|
|
}
|
|
if (typeof value === "string") {
|
|
return new SimpleStringFront(value);
|
|
}
|
|
return stringActorType.read(value, context, detail);
|
|
},
|
|
});
|