Skip to content

docs: fix grammar in README and correct 'susbscribe' typo in tests #23

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

Open
0xRasmp wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix grammar in README and correct 'susbscribe' typo in tests #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ The `getKycStatus` return the KYC status of a user based on a user_token, issued
user signed a Sign Request (from your app) before (see Payloads - Intro).

If a user token specified is invalid, revoked, expired, etc. the method will always
return `NONE`, just like when a user didn't go through KYC. You cannot distinct a non-KYC'd user
return `NONE`, just like when a user didn't go through KYC. You cannot distinguish a non-KYC'd user
from an invalid token.

Alternatively, KYC status can be retrieved for an XPRL account address: the address selected in
Expand Down
295 changes: 174 additions & 121 deletions test/payload-subscribe.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,186 +1,239 @@
import jsonFixtures from './fixtures/xumm-api.json'
import * as jestFixtures from './fixtures/xumm-api'
import fetchMock from 'jest-fetch-mock'
import jsonFixtures from "./fixtures/xumm-api.json";
import * as jestFixtures from "./fixtures/xumm-api";
import fetchMock from "jest-fetch-mock";

fetchMock.enableMocks()
fetchMock.enableMocks();

import {XummSdk, XummTypes} from '../src/'
import {Server, WebSocket as MockedWebSocket} from 'mock-socket'
import { XummSdk, XummTypes } from "../src/";
import { Server, WebSocket as MockedWebSocket } from "mock-socket";

const wsEol = [MockedWebSocket.CLOSED, MockedWebSocket.CLOSING]
const wsEol = [MockedWebSocket.CLOSED, MockedWebSocket.CLOSING];

let mockServer: Server
let mockServer: Server;

beforeAll(() => {
Object.assign(global, {MockedWebSocket})
Object.assign(global, { MockedWebSocket });

mockServer = new Server('ws://xumm.local')
mockServer = new Server("ws://xumm.local");

mockServer.on('connection', socket => {
socket.send(JSON.stringify(jestFixtures.subscriptionUpdates.welcome))
mockServer.on("connection", (socket) => {
socket.send(JSON.stringify(jestFixtures.subscriptionUpdates.welcome));

setTimeout(() => {
socket.send(JSON.stringify(jestFixtures.subscriptionUpdates.expire))
}, 150)
socket.send(JSON.stringify(jestFixtures.subscriptionUpdates.expire));
}, 150);

setTimeout(() => {
socket.send(JSON.stringify(jestFixtures.subscriptionUpdates.opened))
}, 250)
socket.send(JSON.stringify(jestFixtures.subscriptionUpdates.opened));
}, 250);

setTimeout(() => {
socket.send(JSON.stringify(jestFixtures.subscriptionUpdates.rejected))
}, 350)
})
})
socket.send(JSON.stringify(jestFixtures.subscriptionUpdates.rejected));
}, 350);
});
});

afterAll(() => {
mockServer.close()
})
mockServer.close();
});

describe('XUMM Payload Subscriptions', () => {
process.env.XUMM_APIKEY = jsonFixtures.api.key
process.env.XUMM_APISECRET = jsonFixtures.api.secret
describe("XUMM Payload Subscriptions", () => {
process.env.XUMM_APIKEY = jsonFixtures.api.key;
process.env.XUMM_APISECRET = jsonFixtures.api.secret;

const Sdk = new XummSdk()
const Sdk = new XummSdk();

it('should susbscribe & resolve using inner resolve method @ callback', async () => {
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.get))
it("should subscribe & resolve using inner resolve method @ callback", async () => {
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.get));

const subscriptionSocket = await Sdk.payload.subscribe('0ef943e9-18ae-4fa2-952a-6f55dce363f0', event => {
if (typeof event.data.signed !== 'undefined') {
return event.resolve(event.data)
const subscriptionSocket = await Sdk.payload.subscribe(
"0ef943e9-18ae-4fa2-952a-6f55dce363f0",
(event) => {
if (typeof event.data.signed !== "undefined") {
return event.resolve(event.data);
}
}
})
);

expect(subscriptionSocket).toMatchObject({
payload: jsonFixtures.payload.get,
resolve: expect.any(Function),
resolved: expect.any(Promise),
websocket: expect.any(MockedWebSocket)
})

await new Promise(resolve => subscriptionSocket.websocket.onopen = resolve)

expect(subscriptionSocket.websocket.readyState).toEqual(subscriptionSocket.websocket.OPEN)
expect(await subscriptionSocket.resolved).toMatchObject(jestFixtures.subscriptionUpdates.rejected)
expect(wsEol).toEqual(expect.arrayContaining([subscriptionSocket.websocket.readyState]))

return
})

it('should susbscribe & resolve using return @ callback', async () => {
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.get))

const subscriptionSocket = await Sdk.payload.subscribe('0ef943e9-18ae-4fa2-952a-6f55dce363f0', event => {
if (typeof event.data.signed !== 'undefined') {
return event.data
websocket: expect.any(MockedWebSocket),
});

await new Promise(
(resolve) => (subscriptionSocket.websocket.onopen = resolve)
);

expect(subscriptionSocket.websocket.readyState).toEqual(
subscriptionSocket.websocket.OPEN
);
expect(await subscriptionSocket.resolved).toMatchObject(
jestFixtures.subscriptionUpdates.rejected
);
expect(wsEol).toEqual(
expect.arrayContaining([subscriptionSocket.websocket.readyState])
);

return;
});

it("should subscribe & resolve using return @ callback", async () => {
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.get));

const subscriptionSocket = await Sdk.payload.subscribe(
"0ef943e9-18ae-4fa2-952a-6f55dce363f0",
(event) => {
if (typeof event.data.signed !== "undefined") {
return event.data;
}
}
})
);

expect(subscriptionSocket).toMatchObject({
payload: jsonFixtures.payload.get,
resolve: expect.any(Function),
resolved: expect.any(Promise),
websocket: expect.any(MockedWebSocket)
})
websocket: expect.any(MockedWebSocket),
});

await new Promise(resolve => subscriptionSocket.websocket.onopen = resolve)
await new Promise(
(resolve) => (subscriptionSocket.websocket.onopen = resolve)
);

expect(subscriptionSocket.websocket.readyState).toEqual(subscriptionSocket.websocket.OPEN)
expect(await subscriptionSocket.resolved).toMatchObject(jestFixtures.subscriptionUpdates.rejected)
expect(wsEol).toEqual(expect.arrayContaining([subscriptionSocket.websocket.readyState]))
expect(subscriptionSocket.websocket.readyState).toEqual(
subscriptionSocket.websocket.OPEN
);
expect(await subscriptionSocket.resolved).toMatchObject(
jestFixtures.subscriptionUpdates.rejected
);
expect(wsEol).toEqual(
expect.arrayContaining([subscriptionSocket.websocket.readyState])
);

return
})
return;
});

it('should susbscribe & resolve using obj.resolve() method', async () => {
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.get))
it("should subscribe & resolve using obj.resolve() method", async () => {
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.get));

const subscriptionSocket = await Sdk.payload.subscribe('0ef943e9-18ae-4fa2-952a-6f55dce363f0')
const subscriptionSocket = await Sdk.payload.subscribe(
"0ef943e9-18ae-4fa2-952a-6f55dce363f0"
);

expect(subscriptionSocket).toMatchObject({
payload: jsonFixtures.payload.get,
resolve: expect.any(Function),
resolved: expect.any(Promise),
websocket: expect.any(MockedWebSocket)
})
websocket: expect.any(MockedWebSocket),
});

await new Promise(resolve => subscriptionSocket.websocket.onopen = resolve)
await new Promise(
(resolve) => (subscriptionSocket.websocket.onopen = resolve)
);

expect(subscriptionSocket.websocket.readyState).toEqual(subscriptionSocket.websocket.OPEN)
expect(subscriptionSocket.websocket.readyState).toEqual(
subscriptionSocket.websocket.OPEN
);

let receivedWsMessages = 0
subscriptionSocket.websocket.onmessage = () => receivedWsMessages++
let receivedWsMessages = 0;
subscriptionSocket.websocket.onmessage = () => receivedWsMessages++;

setTimeout(() => {
subscriptionSocket.resolve({dummyObject: true})
expect(receivedWsMessages).toEqual(3)
}, 500)

expect(await subscriptionSocket.resolved).toMatchObject({dummyObject: true})
expect(wsEol).toEqual(expect.arrayContaining([subscriptionSocket.websocket.readyState]))

return
})

it('should create, susbscribe & resolve using return @ callback', async () => {
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.created))
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.get))

const payload = jestFixtures.validPayload as XummTypes.XummPostPayloadBodyJson
const createdAndSubscribed = await Sdk.payload.createAndSubscribe(payload, event => {
if (typeof event.data.signed !== 'undefined') {
return event.data
subscriptionSocket.resolve({ dummyObject: true });
expect(receivedWsMessages).toEqual(3);
}, 500);

expect(await subscriptionSocket.resolved).toMatchObject({
dummyObject: true,
});
expect(wsEol).toEqual(
expect.arrayContaining([subscriptionSocket.websocket.readyState])
);

return;
});

it("should create, subscribe & resolve using return @ callback", async () => {
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.created));
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.get));

const payload =
jestFixtures.validPayload as XummTypes.XummPostPayloadBodyJson;
const createdAndSubscribed = await Sdk.payload.createAndSubscribe(
payload,
(event) => {
if (typeof event.data.signed !== "undefined") {
return event.data;
}
}
})
);

expect(createdAndSubscribed).toMatchObject({
created: jestFixtures.createPayloadResponseObject,
payload: jsonFixtures.payload.get,
resolve: expect.any(Function),
resolved: expect.any(Promise),
websocket: expect.any(MockedWebSocket)
})

await new Promise(resolve => createdAndSubscribed.websocket.onopen = resolve)

expect(createdAndSubscribed.websocket.readyState).toEqual(createdAndSubscribed.websocket.OPEN)
expect(await createdAndSubscribed.resolved).toMatchObject(jestFixtures.subscriptionUpdates.rejected)
expect(wsEol).toEqual(expect.arrayContaining([createdAndSubscribed.websocket.readyState]))

return
})

it('should create, susbscribe & resolve using using obj.resolve() method', async () => {
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.created))
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.get))

const payload = jestFixtures.validPayload as XummTypes.XummPostPayloadBodyJson
const createdAndSubscribed = await Sdk.payload.createAndSubscribe(payload)
websocket: expect.any(MockedWebSocket),
});

await new Promise(
(resolve) => (createdAndSubscribed.websocket.onopen = resolve)
);

expect(createdAndSubscribed.websocket.readyState).toEqual(
createdAndSubscribed.websocket.OPEN
);
expect(await createdAndSubscribed.resolved).toMatchObject(
jestFixtures.subscriptionUpdates.rejected
);
expect(wsEol).toEqual(
expect.arrayContaining([createdAndSubscribed.websocket.readyState])
);

return;
});

it("should create, subscribe & resolve using using obj.resolve() method", async () => {
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.created));
fetchMock.doMockOnce(JSON.stringify(jsonFixtures.payload.get));

const payload =
jestFixtures.validPayload as XummTypes.XummPostPayloadBodyJson;
const createdAndSubscribed = await Sdk.payload.createAndSubscribe(payload);

expect(createdAndSubscribed).toMatchObject({
created: jestFixtures.createPayloadResponseObject,
payload: jsonFixtures.payload.get,
resolve: expect.any(Function),
resolved: expect.any(Promise),
websocket: expect.any(MockedWebSocket)
})
websocket: expect.any(MockedWebSocket),
});

await new Promise(resolve => createdAndSubscribed.websocket.onopen = resolve)
await new Promise(
(resolve) => (createdAndSubscribed.websocket.onopen = resolve)
);

expect(createdAndSubscribed.websocket.readyState).toEqual(createdAndSubscribed.websocket.OPEN)
expect(createdAndSubscribed.websocket.readyState).toEqual(
createdAndSubscribed.websocket.OPEN
);

let receivedWsMessages = 0
createdAndSubscribed.websocket.onmessage = () => receivedWsMessages++
let receivedWsMessages = 0;
createdAndSubscribed.websocket.onmessage = () => receivedWsMessages++;

setTimeout(() => {
createdAndSubscribed.resolve({dummyObject: true})
expect(receivedWsMessages).toEqual(3)
}, 500)

expect(await createdAndSubscribed.resolved).toMatchObject({dummyObject: true})
expect(wsEol).toEqual(expect.arrayContaining([createdAndSubscribed.websocket.readyState]))

return
})
})
createdAndSubscribed.resolve({ dummyObject: true });
expect(receivedWsMessages).toEqual(3);
}, 500);

expect(await createdAndSubscribed.resolved).toMatchObject({
dummyObject: true,
});
expect(wsEol).toEqual(
expect.arrayContaining([createdAndSubscribed.websocket.readyState])
);

return;
});
});