Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1b9220fb62 |
@@ -347,6 +347,12 @@ are outside `make check`. Neither opens the popup from the toolbar button: both
|
||||
load its page in an ordinary tab, so what the toolbar popup itself adds, its
|
||||
size and its closing when it loses focus, is covered by neither.
|
||||
|
||||
Each run builds its image under a tag of its own, `autistmask-e2e-chrome:` or
|
||||
`autistmask-e2e-firefox:` followed by twelve random hex digits, and removes that
|
||||
image when it exits, an interrupt included. Two clones can therefore run the
|
||||
same suite at once without one build taking the other's image away, and no run
|
||||
leaves an image behind.
|
||||
|
||||
### Chrome (`make test-e2e`)
|
||||
|
||||
`make test-e2e` builds `dist/chrome/` and drives the **real popup in a real
|
||||
@@ -2143,12 +2149,7 @@ view would leave a wallet one click from deletion.
|
||||
Bytes that are not UTF-8 are shown as "This message is not text." For
|
||||
typed data, formatted domain/type/message fields (EIP-712). The primary
|
||||
type shown is the one ethers signs, derived from the typed data's `types`,
|
||||
not the type the site states. The message shows only the fields that type
|
||||
declares, at every level of nesting and in the type's order: ethers signs
|
||||
those and drops any other key. Typed data carrying other keys is not
|
||||
refused; each such key is listed after the message under "Not part of the
|
||||
signature", by its place in the message (`details.note`,
|
||||
`details[1].note`) and its value.
|
||||
not the type the site states.
|
||||
- Token permission warning, at the top of the message (typed data whose
|
||||
primary type is `Permit`, as in EIP-2612, or one of Permit2's signature
|
||||
types): "⚠️ TOKEN PERMISSION: Signing this lets the spender below take the
|
||||
|
||||
+13
-15
@@ -22,13 +22,18 @@ set -eu
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||
|
||||
IMAGE="$("$SCRIPT_DIR/projectname")-e2e-chrome"
|
||||
|
||||
IIDFILE=""
|
||||
# Each run builds, runs and then removes an image under a tag of its own.
|
||||
# Under one tag shared by every run, a second clone's build moves the tag
|
||||
# off this run's image, and the image store can then delete that untagged
|
||||
# image before or while this run uses it. The tag is random rather than
|
||||
# $$ because CI jobs share one docker daemon, but each job's container
|
||||
# numbers its processes from scratch.
|
||||
IMAGE="$("$SCRIPT_DIR/projectname")-e2e-chrome:$(od -An -N6 -tx1 /dev/urandom | tr -d ' \n')"
|
||||
|
||||
cleanup() {
|
||||
if [ -n "$IIDFILE" ]; then
|
||||
rm -f "$IIDFILE"
|
||||
# No image to remove when the build failed or was interrupted.
|
||||
if docker image inspect "$IMAGE" >/dev/null 2>&1; then
|
||||
docker image rm "$IMAGE" >/dev/null
|
||||
fi
|
||||
}
|
||||
|
||||
@@ -40,22 +45,15 @@ main() {
|
||||
exit 1
|
||||
fi
|
||||
|
||||
IIDFILE="$(mktemp)"
|
||||
trap cleanup EXIT
|
||||
trap 'cleanup; exit 130' INT TERM
|
||||
|
||||
echo "Building the Chrome e2e image (extension included)..."
|
||||
# --no-cache: the image build runs make build and its checks, and a
|
||||
# cached layer is a check that did not run.
|
||||
docker build --no-cache --iidfile "$IIDFILE" -t "$IMAGE" \
|
||||
-f tests/e2e/Dockerfile .
|
||||
docker build --no-cache -t "$IMAGE" -f tests/e2e/Dockerfile .
|
||||
|
||||
echo "Running e2e suite in the pinned Playwright container..."
|
||||
# The image is run by ID, not by tag: where two clones of this repo run
|
||||
# the suite at once, the other build can move the tag between this
|
||||
# build and this run, and the suite would then silently test the other
|
||||
# checkout.
|
||||
#
|
||||
# --ipc=host: Chromium's shared-memory needs more than the default
|
||||
# 64MB /dev/shm or renderers crash.
|
||||
# HOME=/tmp: the image's root home is not a reliable place for the
|
||||
@@ -79,7 +77,7 @@ main() {
|
||||
-e HOME=/tmp \
|
||||
-e PW_EXPERIMENTAL_SERVICE_WORKER_NETWORK_EVENTS=1 \
|
||||
-e "E2E_TRACE_NETWORK=${E2E_TRACE_NETWORK:-0}" \
|
||||
"$(cat "$IIDFILE")" \
|
||||
"$IMAGE" \
|
||||
node tests/e2e/run.js
|
||||
|
||||
# Where chrome.storage.local lives, and what moves it: two unpacked loads
|
||||
@@ -95,7 +93,7 @@ main() {
|
||||
docker run --rm \
|
||||
--ipc=host \
|
||||
-e HOME=/tmp \
|
||||
"$(cat "$IIDFILE")" \
|
||||
"$IMAGE" \
|
||||
node tests/e2e/storagePartition.js
|
||||
}
|
||||
|
||||
|
||||
+8
-15
@@ -21,13 +21,13 @@ set -eu
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||
|
||||
IMAGE="$("$SCRIPT_DIR/projectname")-e2e-firefox"
|
||||
|
||||
IIDFILE=""
|
||||
# A tag of this run's own, as in script/test-e2e, which says why.
|
||||
IMAGE="$("$SCRIPT_DIR/projectname")-e2e-firefox:$(od -An -N6 -tx1 /dev/urandom | tr -d ' \n')"
|
||||
|
||||
cleanup() {
|
||||
if [ -n "$IIDFILE" ]; then
|
||||
rm -f "$IIDFILE"
|
||||
# No image to remove when the build failed or was interrupted.
|
||||
if docker image inspect "$IMAGE" >/dev/null 2>&1; then
|
||||
docker image rm "$IMAGE" >/dev/null
|
||||
fi
|
||||
}
|
||||
|
||||
@@ -39,22 +39,15 @@ main() {
|
||||
exit 1
|
||||
fi
|
||||
|
||||
IIDFILE="$(mktemp)"
|
||||
trap cleanup EXIT
|
||||
trap 'cleanup; exit 130' INT TERM
|
||||
|
||||
echo "Building the pinned Firefox e2e image (extension included)..."
|
||||
# --no-cache: the image build runs make build and its checks, and a
|
||||
# cached layer is a check that did not run.
|
||||
docker build --no-cache --iidfile "$IIDFILE" -t "$IMAGE" \
|
||||
-f tests/e2e/firefox/Dockerfile .
|
||||
docker build --no-cache -t "$IMAGE" -f tests/e2e/firefox/Dockerfile .
|
||||
|
||||
echo "Running the Firefox e2e suite..."
|
||||
# The image is run by ID, not by tag: where two clones of this repo run
|
||||
# the suite at once, the other build can move the tag between this
|
||||
# build and this run, and the suite would then silently test the other
|
||||
# checkout.
|
||||
#
|
||||
# --shm-size=1g: Firefox needs more than the default 64MB /dev/shm.
|
||||
# --network none: the suite stubs nothing, so this is what keeps the
|
||||
# run offline and deterministic. The extension swallows its own
|
||||
@@ -72,7 +65,7 @@ main() {
|
||||
--shm-size=1g \
|
||||
--network none \
|
||||
-e HOME=/tmp \
|
||||
"$(cat "$IIDFILE")" \
|
||||
"$IMAGE" \
|
||||
node tests/e2e/firefox/run.js dist/firefox
|
||||
|
||||
# The install/uninstall/re-install property, against the packaged XPI
|
||||
@@ -85,7 +78,7 @@ main() {
|
||||
--shm-size=1g \
|
||||
--network none \
|
||||
-e HOME=/tmp \
|
||||
"$(cat "$IIDFILE")" \
|
||||
"$IMAGE" \
|
||||
node tests/e2e/firefox/reinstall.js
|
||||
}
|
||||
|
||||
|
||||
@@ -626,38 +626,10 @@ function permitWarningHtml(types, primaryType, domain, message) {
|
||||
return html;
|
||||
}
|
||||
|
||||
// What ethers signs of a message value of type `type`: a struct keeps only
|
||||
// the fields its type declares, in the type's order, and a list is read item
|
||||
// by item. ethers drops every other key, so each one is added to `notSigned`
|
||||
// with its place in the message and its value, for the screen to list apart.
|
||||
function signedValue(types, type, value, path, notSigned) {
|
||||
const itemType = type.replace(/\[\d*\]$/, "");
|
||||
if (itemType !== type) {
|
||||
if (!Array.isArray(value)) return value;
|
||||
return value.map((item, i) =>
|
||||
signedValue(types, itemType, item, `${path}[${i}]`, notSigned),
|
||||
);
|
||||
}
|
||||
const fields = types[type];
|
||||
if (!fields || !value || typeof value !== "object") return value;
|
||||
const at = (name) => (path ? `${path}.${name}` : name);
|
||||
for (const [key, val] of Object.entries(value)) {
|
||||
if (!fields.some((f) => f.name === key)) notSigned.push([at(key), val]);
|
||||
}
|
||||
return Object.fromEntries(
|
||||
fields.map((f) => [
|
||||
f.name,
|
||||
signedValue(types, f.type, value[f.name], at(f.name), notSigned),
|
||||
]),
|
||||
);
|
||||
}
|
||||
|
||||
// The typed data as the screen shows it. The primary type shown is the one
|
||||
// ethers signs, never the page's word for it; typedDataRefusal() keeps the two
|
||||
// from differing on anything that can be signed. The Message section shows
|
||||
// only what is signed, and any other key the page sent is listed after it as
|
||||
// not part of the signature. Only typed data that cannot be read at all is
|
||||
// shown as raw text, and typedDataRefusal() refuses it.
|
||||
// from differing on anything that can be signed. Only typed data that cannot
|
||||
// be read at all is shown as raw text, and typedDataRefusal() refuses it.
|
||||
function formatTypedDataHtml(jsonStr) {
|
||||
let data;
|
||||
let primaryType;
|
||||
@@ -691,30 +663,12 @@ function formatTypedDataHtml(jsonStr) {
|
||||
html += `<div class="mb-2"><div class="text-muted">Primary type</div>`;
|
||||
html += `<div class="font-bold">${escapeHtml(primaryType)}</div></div>`;
|
||||
|
||||
const lineHtml = (key, val) =>
|
||||
`<div><span class="text-muted">${escapeHtml(key)}:</span> <span class="break-all">${escapeHtml(display(val))}</span></div>`;
|
||||
|
||||
if (data.message) {
|
||||
const notSigned = [];
|
||||
const message = signedValue(
|
||||
data.types,
|
||||
primaryType,
|
||||
data.message,
|
||||
"",
|
||||
notSigned,
|
||||
);
|
||||
html += `<div class="mb-2"><div class="text-muted">Message</div>`;
|
||||
for (const [key, val] of Object.entries(message)) {
|
||||
html += lineHtml(key, val);
|
||||
for (const [key, val] of Object.entries(data.message)) {
|
||||
html += `<div><span class="text-muted">${escapeHtml(key)}:</span> <span class="break-all">${escapeHtml(display(val))}</span></div>`;
|
||||
}
|
||||
html += `</div>`;
|
||||
if (notSigned.length > 0) {
|
||||
html += `<div class="mb-2"><div class="text-muted">Not part of the signature</div>`;
|
||||
for (const [key, val] of notSigned) {
|
||||
html += lineHtml(key, val);
|
||||
}
|
||||
html += `</div>`;
|
||||
}
|
||||
}
|
||||
|
||||
return html;
|
||||
|
||||
@@ -233,26 +233,6 @@ function warningOf(data) {
|
||||
return html.slice(0, html.indexOf(">Domain<"));
|
||||
}
|
||||
|
||||
const NOT_SIGNED = ">Not part of the signature<";
|
||||
|
||||
// The Message section alone, without the keys listed after it as not part of
|
||||
// the signature.
|
||||
function messageOf(data) {
|
||||
const html = formatTypedDataHtml(JSON.stringify(data));
|
||||
const end = html.indexOf(NOT_SIGNED);
|
||||
return html.slice(
|
||||
html.indexOf(">Message<"),
|
||||
end === -1 ? html.length : end,
|
||||
);
|
||||
}
|
||||
|
||||
// The keys listed as not part of the signature, or "" when there are none.
|
||||
function notSignedOf(data) {
|
||||
const html = formatTypedDataHtml(JSON.stringify(data));
|
||||
const start = html.indexOf(NOT_SIGNED);
|
||||
return start === -1 ? "" : html.slice(start);
|
||||
}
|
||||
|
||||
function request(data) {
|
||||
return { method: "eth_signTypedData_v4", typedData: JSON.stringify(data) };
|
||||
}
|
||||
@@ -332,8 +312,7 @@ describe("the warning reads only the fields the signed type declares", () => {
|
||||
});
|
||||
|
||||
// A Permit whose type names its spender `operator`; the page adds a
|
||||
// `spender` key the type does not declare. The Message section names
|
||||
// only the operator, and the added key is listed apart as not signed.
|
||||
// `spender` key the type does not declare.
|
||||
test("an added key is not named as the spender", () => {
|
||||
const data = {
|
||||
...PERMIT,
|
||||
@@ -352,10 +331,6 @@ describe("the warning reads only the fields the signed type declares", () => {
|
||||
const warning = warningOf(data);
|
||||
expect(warning).toContain(WARNING);
|
||||
expect(warning).not.toContain(DECOY);
|
||||
expect(messageOf(data)).toContain(SPENDER);
|
||||
expect(messageOf(data)).not.toContain(DECOY);
|
||||
expect(notSignedOf(data)).toContain("spender:");
|
||||
expect(notSignedOf(data)).toContain(DECOY);
|
||||
});
|
||||
|
||||
// The permit for a Uniswap v3 position NFT: a `Permit` with no amount
|
||||
@@ -396,47 +371,6 @@ describe("the warning reads only the fields the signed type declares", () => {
|
||||
});
|
||||
});
|
||||
|
||||
// ethers signs only the declared fields at every level of nesting, so an
|
||||
// added key inside a struct is not signed either. Such typed data is not
|
||||
// refused; the added key is listed apart, with where it sits in the message.
|
||||
describe("the Message section shows only the fields that are signed", () => {
|
||||
const NOTE = "This signature only signs you in";
|
||||
|
||||
test("an added key inside a nested struct is listed as not signed", () => {
|
||||
const data = {
|
||||
...PERMIT_SINGLE,
|
||||
message: {
|
||||
...PERMIT_SINGLE.message,
|
||||
details: { ...PERMIT_SINGLE.message.details, note: NOTE },
|
||||
},
|
||||
};
|
||||
expect(messageOf(data)).toContain("expiration");
|
||||
expect(messageOf(data)).not.toContain(NOTE);
|
||||
expect(notSignedOf(data)).toContain("details.note:");
|
||||
expect(notSignedOf(data)).toContain(NOTE);
|
||||
expect(typedDataRefusal(request(data))).toBeNull();
|
||||
});
|
||||
|
||||
test("an added key inside a list item is listed with its index", () => {
|
||||
const [first, second] = PERMIT_BATCH.message.details;
|
||||
const data = {
|
||||
...PERMIT_BATCH,
|
||||
message: {
|
||||
...PERMIT_BATCH.message,
|
||||
details: [first, { ...second, note: NOTE }],
|
||||
},
|
||||
};
|
||||
expect(messageOf(data)).not.toContain(NOTE);
|
||||
expect(notSignedOf(data)).toContain("details[1].note:");
|
||||
expect(notSignedOf(data)).toContain(NOTE);
|
||||
});
|
||||
|
||||
test("nothing is listed apart when every key is declared", () => {
|
||||
expect(notSignedOf(PERMIT_SINGLE)).toBe("");
|
||||
expect(notSignedOf(LOGIN)).toBe("");
|
||||
});
|
||||
});
|
||||
|
||||
describe("the primary type shown is the one ethers signs", () => {
|
||||
// A drain stated as a sign-in: the page says Login, the types say
|
||||
// PermitSingle, and ethers would sign PermitSingle.
|
||||
|
||||
Reference in New Issue
Block a user