Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add selectiveUnion for improved Superstruct error messaging #2696

Merged
merged 8 commits into from
Sep 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/examples/packages/bip32/snap.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "oIth1iwHikuY19tkSxTGtl4YzdX1XAiGn2RJl+DAeCs=",
"shasum": "5o3Zg3/1/23XKZdIzzo1Sbwmp2uQNF1EpnzyLYqhfqo=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
2 changes: 1 addition & 1 deletion packages/examples/packages/bip44/snap.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "Ta9rEMnKSdYz7ecxZh++RZyMSW9JVsQVqa+zFLLO87k=",
"shasum": "K0uZKIJkRUzXrIrbcNY/hjouFPSEVScyeJc0D5SvuIs=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "q9RIkIkHMu7cVWgMRnqa0iLb7gzeYAk9LA6WXlEJkUg=",
"shasum": "zjj26VuJEMPd17W0vAdpVONDt/JeYPacP5GwbRAiQZo=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
2 changes: 1 addition & 1 deletion packages/examples/packages/browserify/snap.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "Sehc3xVJmoP4CBbyL64schgPUfHu7Labnrtk5i5LH88=",
"shasum": "WEO5ozYWnfy690WSCYKkexaQnlkDbks1f+vXrRVQRTM=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
2 changes: 1 addition & 1 deletion packages/examples/packages/cronjobs/snap.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "o5qiOur9Zl+yAjHScLzh0FfK7/jcKx7rGqotitpJ6Uo=",
"shasum": "jcA6NL+j9BPrnOiv5FOl+KnTyxAJ5UdThThk4zCoiu8=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
2 changes: 1 addition & 1 deletion packages/examples/packages/dialogs/snap.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "77wtrsk6BY8OSjG5pWALMSJzOmznWaaR7EiM3LGigjI=",
"shasum": "P+jpppDqo3e+Dsyk2KP+26NlKDyGwW+CxztRYiDkqnQ=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
2 changes: 1 addition & 1 deletion packages/examples/packages/ethers-js/snap.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "fwMTtk4KJjak+yf6666Vv/+syXmFVAnVPAsBkalK2Qc=",
"shasum": "ARrlf69swjj7vnhGGRLajr4MFr4hbKbh9G5R987WFoo=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "ur2Jxp1kniP1jYLeexXHTB/+dgfJom1volcPQgSNX6c=",
"shasum": "dPssrjujrDEsuDMxogdHlFNJbGtuZjTpwwU5Lirbr6A=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
2 changes: 1 addition & 1 deletion packages/examples/packages/images/snap.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "ewEvZGj7D/wUtBH8bDutuDuJ1leq8n9Penuu8yDAykA=",
"shasum": "lNV3t5b0qgpl6fMuTUdFA75wWL3zFzm3MvEokB8VF5U=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "Y0k3QSqHBYytNfYgmtrjwhbZ3e8WzXhOQFYPJCIuJfg=",
"shasum": "nBYyvFGnEv4kGTgEAvmhbfAafd85Z1dxbQTczGahxvA=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "Huxm0NrX6zvh0k9iGnStycNNcmHSGRK1EK/+jmv7nyI=",
"shasum": "Mgf0SLyA7yvGJ3+3y8f/Nf2GuMUzLHt4zRj8ZwVoC08=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "mxW5zlXyghmveLeZIwJMZkwjqb7Y8peJut9uvbxgLCU=",
"shasum": "DdjMLFOqo+SfRA4nNJflLvSX3v/IwM23QtjPYzOLG1o=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/snaps.git"
},
"source": {
"shasum": "2HeDCuxgl9zngyHAGEyikHFuM3Rcek5Jc0lCeuPNFqA=",
"shasum": "psh5WYTtiqN1PD18OI3JLmBiMFuo8Uw0V56yiBMVZ4M=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
2 changes: 1 addition & 1 deletion packages/snaps-rpc-methods/jest.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ module.exports = deepmerge(baseConfig, {
],
coverageThreshold: {
global: {
branches: 92.07,
branches: 92.62,
functions: 96.96,
lines: 97.51,
statements: 96.97,
Expand Down
119 changes: 117 additions & 2 deletions packages/snaps-rpc-methods/src/permitted/createInterface.test.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
import { JsonRpcEngine } from '@metamask/json-rpc-engine';
import { text, type CreateInterfaceResult } from '@metamask/snaps-sdk';
import type { JSXElement } from '@metamask/snaps-sdk/jsx';
import { Text, Box } from '@metamask/snaps-sdk/jsx';
import {
Text,
Box,
Field,
Input,
Form,
Container,
Footer,
} from '@metamask/snaps-sdk/jsx';
import type { JsonRpcRequest, PendingJsonRpcResponse } from '@metamask/utils';

import type { CreateInterfaceParameters } from './createInterface';
Expand Down Expand Up @@ -132,7 +140,114 @@ describe('snap_createInterface', () => {
error: {
code: -32602,
message:
'Invalid params: At path: ui -- Expected the value to satisfy a union of `union | union`, but received: "foo".',
'Invalid params: At path: ui -- Expected type to be one of: "Address", "Bold", "Box", "Button", "Copyable", "Divider", "Dropdown", "RadioGroup", "FileInput", "Form", "Heading", "Input", "Image", "Italic", "Link", "Row", "Spinner", "Text", "Tooltip", "Checkbox", "Card", "Icon", "Selector", "Section", "Container", but received: undefined.',
stack: expect.any(String),
},
id: 1,
jsonrpc: '2.0',
});
});

it('throws on invalid UI', async () => {
const { implementation } = createInterfaceHandler;

const createInterface = jest.fn().mockReturnValue('foo');

const hooks = {
createInterface,
};

const engine = new JsonRpcEngine();

engine.push((request, response, next, end) => {
const result = implementation(
request as JsonRpcRequest<CreateInterfaceParameters>,
response as PendingJsonRpcResponse<CreateInterfaceResult>,
next,
end,
hooks,
);

result?.catch(end);
});

const response = await engine.handle({
jsonrpc: '2.0',
id: 1,
method: 'snap_createInterface',
params: {
ui: (
<Box>
<Field label="Input">
<Input name="input" />
</Field>
</Box>
) as JSXElement,
},
});

expect(response).toStrictEqual({
error: {
code: -32602,
message:
'Invalid params: At path: ui.props.children -- Expected type to be one of: "Address", "Bold", "Box", "Button", "Copyable", "Divider", "Dropdown", "RadioGroup", "FileInput", "Form", "Heading", "Input", "Image", "Italic", "Link", "Row", "Spinner", "Text", "Tooltip", "Checkbox", "Card", "Icon", "Selector", "Section", but received: "Field".',
stack: expect.any(String),
},
id: 1,
jsonrpc: '2.0',
});
});

it('throws on invalid nested UI', async () => {
const { implementation } = createInterfaceHandler;

const createInterface = jest.fn().mockReturnValue('foo');

const hooks = {
createInterface,
};

const engine = new JsonRpcEngine();

engine.push((request, response, next, end) => {
const result = implementation(
request as JsonRpcRequest<CreateInterfaceParameters>,
response as PendingJsonRpcResponse<CreateInterfaceResult>,
next,
end,
hooks,
);

result?.catch(end);
});

const response = await engine.handle({
jsonrpc: '2.0',
id: 1,
method: 'snap_createInterface',
params: {
ui: (
<Container>
<Box>
<Form name="form">
<Field label="Input">
<Input name="input" />
</Field>
</Form>
</Box>
<Footer>
<Text>Foo</Text>
</Footer>
</Container>
) as JSXElement,
},
});

expect(response).toStrictEqual({
error: {
code: -32602,
message:
'Invalid params: At path: ui.props.children.1.props.children.type -- Expected the literal `"Button"`, but received: "Text".',
stack: expect.any(String),
},
id: 1,
Expand Down
59 changes: 54 additions & 5 deletions packages/snaps-rpc-methods/src/restricted/dialog.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,30 @@ describe('implementation', () => {
},
});
});

it('handles confirmations using an ID', async () => {
const hooks = getMockDialogHooks();
const implementation = getDialogImplementation(hooks);
await implementation({
context: { origin: 'foo' },
method: 'snap_dialog',
params: {
type: DialogType.Confirmation,
id: 'baz',
},
});

expect(hooks.requestUserApproval).toHaveBeenCalledTimes(1);
expect(hooks.requestUserApproval).toHaveBeenCalledWith({
id: undefined,
origin: 'foo',
type: DIALOG_APPROVAL_TYPES[DialogType.Confirmation],
requestData: {
id: 'baz',
placeholder: undefined,
},
});
});
});

describe('prompts', () => {
Expand Down Expand Up @@ -414,6 +438,31 @@ describe('implementation', () => {
},
});
});

it('handles prompts using an ID', async () => {
const hooks = getMockDialogHooks();
const implementation = getDialogImplementation(hooks);
await implementation({
context: { origin: 'foo' },
method: 'snap_dialog',
params: {
type: DialogType.Prompt,
id: 'baz',
placeholder: 'foobar',
},
});

expect(hooks.requestUserApproval).toHaveBeenCalledTimes(1);
expect(hooks.requestUserApproval).toHaveBeenCalledWith({
id: undefined,
origin: 'foo',
type: DIALOG_APPROVAL_TYPES[DialogType.Prompt],
requestData: {
id: 'baz',
placeholder: 'foobar',
},
});
});
});

describe('validation', () => {
Expand Down Expand Up @@ -446,7 +495,7 @@ describe('implementation', () => {
params: {} as any,
}),
).rejects.toThrow(
'Invalid params: Expected the value to satisfy a union of `object | object`, but received: [object Object]',
/Invalid params: At path: .* -- Expected type to be one of: .*, but received: .*/u,
Mrtenz marked this conversation as resolved.
Show resolved Hide resolved
);
});

Expand Down Expand Up @@ -487,7 +536,7 @@ describe('implementation', () => {
params: value as any,
}),
).rejects.toThrow(
/Invalid params: At path: .* Expected a value of type .*, but received: .*\./u,
/Invalid params: At path: .* -- Expected type to be one of: .*, but received: .*/u,
);
});

Expand All @@ -508,7 +557,7 @@ describe('implementation', () => {
},
}),
).rejects.toThrow(
/Invalid params: At path: placeholder Expected a value of type string, but received: .*\./u,
/Invalid params: At path: placeholder -- Expected a string, but received: .*/u,
);
},
);
Expand All @@ -528,7 +577,7 @@ describe('implementation', () => {
},
}),
).rejects.toThrow(
'Invalid params: At path: placeholder Expected a string with a length between 1 and 40, but received one with a length of 0.',
'Invalid params: At path: placeholder -- Expected a string with a length between `1` and `40` but received one with a length of `0`',
);
});

Expand All @@ -548,7 +597,7 @@ describe('implementation', () => {
},
}),
).rejects.toThrow(
'Invalid params: Unknown key: placeholder, received: "foobar".',
'Invalid params: At path: placeholder -- Expected a value of type `never`, but received: `"foobar"`',
);
},
);
Expand Down
Loading
Loading