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

feat: connect relying party on ready only #31

Merged
merged 2 commits into from
Aug 5, 2024
Merged

feat: connect relying party on ready only #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3aa125d
feat: connect relying party on ready only
peterpeterparker Aug 5, 2024
9756832
chore: remove unused imports
peterpeterparker Aug 5, 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
125 changes: 69 additions & 56 deletions src/wallet.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {beforeEach} from 'vitest';
import * as walletHandlers from './handlers/wallet.handlers';
import {JSON_RPC_VERSION_2} from './types/rpc';
import {WALLET_WINDOW_CENTER, WALLET_WINDOW_TOP_RIGHT, windowFeatures} from './utils/window.utils';
import {Wallet, type WalletParameters} from './wallet';

Expand All @@ -25,67 +25,80 @@ describe('Wallet', () => {
vi.restoreAllMocks();
});

const options = [
{
title: 'default options',
params: mockParameters,
expectedOptions: windowFeatures(WALLET_WINDOW_TOP_RIGHT)
},
{
title: 'centered window',
params: {
...mockParameters,
windowOptions: WALLET_WINDOW_CENTER
},
expectedOptions: windowFeatures(WALLET_WINDOW_CENTER)
},
{
title: 'custom window',
params: {
...mockParameters,
windowOptions: 'height=600, width=400'
},
expectedOptions: 'height=600, width=400'
}
];

it.each(options)('$title', async ({params, expectedOptions}) => {
const addEventListenerSpy = vi.spyOn(window, 'addEventListener');
const removeEventListenerSpy = vi.spyOn(window, 'removeEventListener');
describe('Connection errors', () => {
it('should throw connection timeout error', async () => {
vi.spyOn(walletHandlers, 'retryRequestStatus').mockResolvedValue('timeout');

const promise = Wallet.connect(params);

const messageEvent = new MessageEvent('message', {
origin: mockParameters.url
await expect(Wallet.connect(mockParameters)).rejects.toThrow(
'Connection timeout. Unable to connect to the wallet.'
);
});

window.dispatchEvent(messageEvent);

const wallet = await promise;

expect(wallet).toBeInstanceOf(Wallet);

expect(window.open).toHaveBeenCalledWith(mockParameters.url, 'walletWindow', expectedOptions);
expect(window.open).toHaveBeenCalledTimes(1);

expect(addEventListenerSpy).toHaveBeenCalledWith('message', expect.any(Function));
expect(removeEventListenerSpy).toHaveBeenCalledWith('message', expect.any(Function));
});

it('should throw connection timeout error', async () => {
vi.spyOn(walletHandlers, 'retryRequestStatus').mockResolvedValue('timeout');
it('should assert edge case wallet not defined but request status success', async () => {
vi.spyOn(walletHandlers, 'retryRequestStatus').mockResolvedValue('ready');

await expect(Wallet.connect(mockParameters)).rejects.toThrow(
'Connection timeout. Unable to connect to the wallet.'
);
await expect(Wallet.connect(mockParameters)).rejects.toThrow(
'Unexpected error. Request status succeeded, but wallet is not defined.'
);
});
});

it('should assert edge case wallet not defined but request status success', async () => {
vi.spyOn(walletHandlers, 'retryRequestStatus').mockResolvedValue('ready');

await expect(Wallet.connect(mockParameters)).rejects.toThrow(
'Unexpected error. Request status succeeded, but wallet is not defined.'
);
describe('Connection success', () => {
const options = [
{
title: 'default options',
params: mockParameters,
expectedOptions: windowFeatures(WALLET_WINDOW_TOP_RIGHT)
},
{
title: 'centered window',
params: {
...mockParameters,
windowOptions: WALLET_WINDOW_CENTER
},
expectedOptions: windowFeatures(WALLET_WINDOW_CENTER)
},
{
title: 'custom window',
params: {
...mockParameters,
windowOptions: 'height=600, width=400'
},
expectedOptions: 'height=600, width=400'
}
];

it.each(options)('$title', async ({params, expectedOptions}) => {
const addEventListenerSpy = vi.spyOn(window, 'addEventListener');
const removeEventListenerSpy = vi.spyOn(window, 'removeEventListener');

const promise = Wallet.connect(params);

const messageEvent = new MessageEvent('message', {
origin: mockParameters.url,
data: {
jsonrpc: JSON_RPC_VERSION_2,
id: '123',
result: 'ready'
}
});

window.dispatchEvent(messageEvent);

const wallet = await promise;

expect(wallet).toBeInstanceOf(Wallet);

expect(window.open).toHaveBeenCalledWith(
mockParameters.url,
'walletWindow',
expectedOptions
);
expect(window.open).toHaveBeenCalledTimes(1);

expect(addEventListenerSpy).toHaveBeenCalledWith('message', expect.any(Function));
expect(removeEventListenerSpy).toHaveBeenCalledWith('message', expect.any(Function));
});
});
});

Expand Down
10 changes: 7 additions & 3 deletions src/wallet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import {assertNonNullish, nonNullish} from '@dfinity/utils';
import {nanoid} from 'nanoid';
import {retryRequestStatus} from './handlers/wallet.handlers';
import {IcrcReadyResponse} from './types/icrc-responses';
import {
WALLET_WINDOW_TOP_RIGHT,
windowFeatures,
Expand Down Expand Up @@ -51,10 +52,13 @@ export class Wallet {

let wallet: Wallet | undefined;

const onMessage = ({origin, data: _}: MessageEvent): void => {
const onMessage = ({origin, data: msgData}: MessageEvent): void => {
// TODO: validate origin
// TODO: safeParse + validate ID
wallet = new Wallet({origin});

const {success: isWalletReady} = IcrcReadyResponse.safeParse(msgData);
if (isWalletReady) {
wallet = new Wallet({origin});
}
};

window.addEventListener('message', onMessage);
Expand Down