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.

Sign up for GitHub

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

Add isSnapId utility function #2808

Merged
merged 3 commits into from
Oct 8, 2024
Merged

Add isSnapId utility function #2808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
274a18d
Add `isSnapId` utility function
Mrtenz Oct 8, 2024
ba10346
Fix test
Mrtenz Oct 8, 2024
888d91b
Fix import
Mrtenz Oct 8, 2024
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
4 changes: 2 additions & 2 deletions packages/snaps-utils/coverage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"branches": 99.74,
"functions": 98.91,
"functions": 98.92,
"lines": 99.45,
"statements": 96.3
"statements": 96.31
}
36 changes: 32 additions & 4 deletions packages/snaps-utils/src/snaps.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,37 @@ import {
assertIsValidSnapId,
verifyRequestedSnapPermissions,
stripSnapPrefix,
isSnapId,
} from './snaps';
import { MOCK_SNAP_ID } from './test-utils';
import { uri, WALLET_SNAP_PERMISSION_KEY } from './types';

describe('isSnapId', () => {
it.each(['npm:@metamask/test-snap-bip44', 'local:http://localhost:8000'])(
'returns `true` for "%s"',
(value) => {
expect(isSnapId(value)).toBe(true);
},
);

it.each([
undefined,
{},
null,
true,
2,
'foo:bar',
' local:http://localhost:8000',
'local:http://localhost:8000 ',
'local:http://localhost:8000\n',
'local:http://localhost:8000\r',
'local:😎',
'local:␡',
])('returns `false` for "%s"', (value) => {
expect(isSnapId(value)).toBe(false);
});
});

describe('assertIsValidSnapId', () => {
it.each([undefined, {}, null, true, 2])(
'throws for non-strings (#%#)',
Expand Down Expand Up @@ -239,7 +267,7 @@ describe('isSnapPermitted', () => {
{
type: 'snapIds',
value: {
foo: {},
[MOCK_SNAP_ID]: {},
},
},
],
Expand Down Expand Up @@ -273,9 +301,9 @@ describe('isSnapPermitted', () => {
},
};

expect(isSnapPermitted(validPermissions, 'foo')).toBe(true);
expect(isSnapPermitted(invalidPermissions1, 'foo')).toBe(false);
expect(isSnapPermitted(invalidPermissions2, 'foo')).toBe(false);
expect(isSnapPermitted(validPermissions, MOCK_SNAP_ID)).toBe(true);
expect(isSnapPermitted(invalidPermissions1, MOCK_SNAP_ID)).toBe(false);
expect(isSnapPermitted(invalidPermissions2, MOCK_SNAP_ID)).toBe(false);
});

describe('verifyRequestedSnapPermissions', () => {
Expand Down
12 changes: 12 additions & 0 deletions packages/snaps-utils/src/snaps.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import type { BlockReason } from '@metamask/snaps-registry';
import type { SnapId, Snap as TruncatedSnap } from '@metamask/snaps-sdk';
import type { Struct } from '@metamask/superstruct';
import {
is,
empty,
enums,
intersection,
Expand Down Expand Up @@ -311,6 +312,17 @@ export function stripSnapPrefix(snapId: string): string {
return snapId.replace(getSnapPrefix(snapId), '');
}

/**
* Check if the given value is a valid snap ID. This function is a type guard,
* and will narrow the type of the value to `SnapId` if it returns `true`.
*
* @param value - The value to check.
* @returns `true` if the value is a valid snap ID, and `false` otherwise.
*/
export function isSnapId(value: unknown): value is SnapId {
return is(value, SnapIdStruct);
}

/**
* Assert that the given value is a valid snap ID.
*
Expand Down
Loading