Skip to content

Fix: Pass api key in headers and detect html error #999

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

Merged
merged 10 commits into from
May 18, 2024
Merged

Fix: Pass api key in headers and detect html error #999

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bdad231
Fix: Pass api key in headers and detect html error
ChaituVR May 17, 2024
21a892b
Merge branch 'master' into fix-send-api-key-in-headers
ChaituVR May 17, 2024
0c2d912
Merge branch 'master' of https://github.com/snapshot-labs/snapshot.js…
ChaituVR May 17, 2024
0bd7e15
fix tests
ChaituVR May 17, 2024
4dd6d94
Merge branch 'fix-send-api-key-in-headers' of https://github.com/snap…
ChaituVR May 17, 2024
32ad18f
Change to normal function
ChaituVR May 18, 2024
cc6c4b2
Update test/e2e/utils/getScores.spec.ts
ChaituVR May 18, 2024
bbbf941
Update formatScoreAPIUrl to include options.path
ChaituVR May 18, 2024
4215293
Merge branch 'fix-send-api-key-in-headers' of https://github.com/snap…
ChaituVR May 18, 2024
ab55ee7
v0.11.23
ChaituVR May 18, 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
80 changes: 50 additions & 30 deletions src/utils.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,14 @@ describe('utils', () => {

describe('when passing valid args', () => {
test('send a JSON-RPC payload to score-api', async () => {
const result = { result: 'OK' };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve({ result: 'OK' }))
text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
});

expect(_validate({})).resolves;
expect(fetch).toHaveBeenCalledWith(
'https://score.snapshot.org',
'https://score.snapshot.org/',
expect.objectContaining({
body: JSON.stringify({
jsonrpc: '2.0',
Expand All @@ -96,13 +97,14 @@ describe('utils', () => {
});

test('send a POST request with JSON content-type', async () => {
const result = { result: 'OK' };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve({ result: 'OK' }))
text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
});

expect(_validate({})).resolves;
expect(fetch).toHaveBeenCalledWith(
'https://score.snapshot.org',
'https://score.snapshot.org/',
expect.objectContaining({
method: 'POST',
headers: {
Expand All @@ -114,23 +116,28 @@ describe('utils', () => {
});

test('can customize the score-api url', () => {
const result = { result: 'OK' };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve({ result: 'OK' }))
text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
});

expect(
_validate({ options: { url: 'https://snapshot.org/?apiKey=xxx' } })
).resolves;
expect(fetch).toHaveBeenCalledWith(
'https://snapshot.org/?apiKey=xxx',
expect.anything()
'https://snapshot.org/',
expect.objectContaining({
headers: expect.objectContaining({
'X-API-KEY': 'xxx'
})
})
);
});

test('returns the JSON-RPC result property', () => {
const result = { result: 'OK' };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve(result))
text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
});

expect(_validate({})).resolves.toEqual('OK');
Expand All @@ -141,7 +148,7 @@ describe('utils', () => {
test('rejects with the JSON-RPC error object', () => {
const result = { error: { message: 'Oh no' } };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve(result))
text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
});

expect(_validate({})).rejects.toEqual(result.error);
Expand All @@ -152,7 +159,7 @@ describe('utils', () => {
test('rejects with the error', () => {
const result = new Error('Oh no');
fetch.mockReturnValue({
json: () => {
text: () => {
throw result;
}
});
Expand Down Expand Up @@ -196,7 +203,7 @@ describe('utils', () => {
network ?? payload.network,
addresses ?? payload.addresses,
snapshot ?? payload.snapshot,
scoreApiUrl ?? 'https://score.snapshot.org',
scoreApiUrl ?? 'https://score.snapshot.org/',
options ?? {}
);
}
Expand Down Expand Up @@ -239,8 +246,9 @@ describe('utils', () => {

describe('when passing valid args', () => {
test('send a JSON-RPC payload to score-api', async () => {
const result = { result: 'OK' };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve({ result: 'OK' }))
text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
});

expect(_getScores({})).resolves;
Expand All @@ -253,8 +261,9 @@ describe('utils', () => {
});

test('send a POST request with JSON content-type', async () => {
const result = { result: 'OK' };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve({ result: 'OK' }))
text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
});

expect(_getScores({})).resolves;
Expand All @@ -270,23 +279,29 @@ describe('utils', () => {
);
});

test('can customize the score-api url', () => {
test('can customize the score-api url and if apiKey should be passed in headers', () => {
const result = { result: 'OK' };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve({ result: 'OK' }))
text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
});

expect(_getScores({ scoreApiUrl: 'https://snapshot.org/?apiKey=xxx' }))
.resolves;
expect(fetch).toHaveBeenCalledWith(
'https://snapshot.org/api/scores?apiKey=xxx',
expect.anything()
'https://snapshot.org/api/scores',
expect.objectContaining({
headers: expect.objectContaining({
'X-API-KEY': 'xxx'
})
})
);
});

test('returns the JSON-RPC result scores property', () => {
const result = { scores: 'SCORES', other: 'Other' };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve({ result }))
text: () =>
new Promise((resolve) => resolve(JSON.stringify({ result })))
});

expect(_getScores({})).resolves.toEqual('SCORES');
Expand All @@ -295,7 +310,8 @@ describe('utils', () => {
test('returns the JSON-RPC all properties', () => {
const result = { scores: 'SCORES', other: 'Other' };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve({ result }))
text: () =>
new Promise((resolve) => resolve(JSON.stringify({ result })))
});

expect(
Expand All @@ -308,7 +324,7 @@ describe('utils', () => {
test('rejects with the JSON-RPC error object', () => {
const result = { error: { message: 'Oh no' } };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve(result))
text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
});

expect(_getScores({})).rejects.toEqual(result.error);
Expand All @@ -319,7 +335,7 @@ describe('utils', () => {
test('rejects with the error', () => {
const result = new Error('Oh no');
fetch.mockReturnValue({
json: () => {
text: () => {
throw result;
}
});
Expand Down Expand Up @@ -391,13 +407,14 @@ describe('utils', () => {

describe('when passing valid args', () => {
test('send a JSON-RPC payload to score-api', async () => {
const result = { result: 'OK' };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve({ result: 'OK' }))
text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
});

expect(_getVp({})).resolves;
expect(fetch).toHaveBeenCalledWith(
'https://score.snapshot.org',
'https://score.snapshot.org/',
expect.objectContaining({
body: JSON.stringify({
jsonrpc: '2.0',
Expand All @@ -409,13 +426,14 @@ describe('utils', () => {
});

test('send a POST request with JSON content-type', async () => {
const result = { result: 'OK' };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve({ result: 'OK' }))
text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
});

expect(_getVp({})).resolves;
expect(fetch).toHaveBeenCalledWith(
'https://score.snapshot.org',
'https://score.snapshot.org/',
expect.objectContaining({
method: 'POST',
headers: {
Expand All @@ -427,21 +445,23 @@ describe('utils', () => {
});

test('can customize the score-api url', () => {
const result = { result: 'OK' };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve({ result: 'OK' }))
text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
});

expect(_getVp({ options: { url: 'https://snapshot.org' } })).resolves;
expect(fetch).toHaveBeenCalledWith(
'https://snapshot.org',
'https://snapshot.org/',
expect.anything()
);
});

test('returns the JSON-RPC result property', () => {
const result = { data: 'OK' };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve({ result }))
text: () =>
new Promise((resolve) => resolve(JSON.stringify({ result })))
});

expect(_getVp({})).resolves.toEqual(result);
Expand All @@ -452,7 +472,7 @@ describe('utils', () => {
test('rejects with the JSON-RPC error object', () => {
const result = { error: { message: 'Oh no' } };
fetch.mockReturnValue({
json: () => new Promise((resolve) => resolve(result))
text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
});

expect(_getVp({})).rejects.toEqual(result.error);
Expand All @@ -463,7 +483,7 @@ describe('utils', () => {
test('rejects with the error', () => {
const result = new Error('Oh no');
fetch.mockReturnValue({
json: () => {
text: () => {
throw result;
}
});
Expand Down
Loading