-
Notifications
You must be signed in to change notification settings - Fork 0
/
LorcanaAPI.test.ts
185 lines (170 loc) · 6.45 KB
/
LorcanaAPI.test.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
import {beforeAll, describe, expect, test} from '@jest/globals';
import {
getCardNameAndID,
CardType,
CardTypes,
Classifications,
Colors,
DEFAULT_LORCANA_API_ROOT_URL,
LorcanaAPI,
Rarities, Abilities,
} from "./index.js";
import {fail, failIfReason} from "./util.test.js";
import {Agent, fetch, setGlobalDispatcher} from 'undici';
const HTTP_TIMEOUT = 3 * 60 * 1000; // 3 minutes in ms
const IMAGE_TEST_RETRIES = 3;
const IMAGE_TEST_TIMEOUT = HTTP_TIMEOUT * IMAGE_TEST_RETRIES;
// avoid jest open handle error - this is a bug in jest, I swear
const JEST_OPEN_HANDLE_DELAY = 4000;
describe('LorcanaAPI', () => {
const api = new LorcanaAPI();
const cardsPromise = api.getCardsList();
beforeAll(() => {
setGlobalDispatcher(new Agent({
connectTimeout: HTTP_TIMEOUT,
bodyTimeout: HTTP_TIMEOUT,
headersTimeout: HTTP_TIMEOUT,
}));
});
describe('API sanity checks', () => {
test('Fetching the cards list works', async () => {
await expect(cardsPromise).resolves.toBeDefined();
});
test('Card colors match', async () => {
const errors: string[] = [];
const cards = await cardsPromise;
for(const card of cards) {
if(!Colors.includes(card.Color)) {
errors.push(`Unknown color '${card.Color}' found on card ${getCardNameAndID(card)}`);
}
}
failIfReason(errors.join('\n'));
});
test('Card rarities match', async () => {
const errors: string[] = [];
const cards = await cardsPromise;
for(const card of cards) {
if(!Rarities.includes(card.Rarity)) {
errors.push(`Unknown rarity '${card.Rarity}' found on card ${getCardNameAndID(card)}`);
}
}
failIfReason(errors.join('\n'));
});
test('Card types match', async () => {
const errors: string[] = [];
const cards = await cardsPromise;
for(const card of cards) {
if(!CardTypes.includes(card.Type)) {
errors.push(`Unknown card type '${card.Type}' found on card ${getCardNameAndID(card)}`);
}
}
failIfReason(errors.join('\n'));
});
test('Card classifications match', async () => {
const errors: string[] = [];
const cards = await cardsPromise;
for(const card of cards) {
if('Classifications' in card) {
for(const classification of card.Classifications) {
if(!(Classifications as string[]).includes(classification)) {
errors.push(`Unknown card classification '${classification}' found on card ${getCardNameAndID(card)}`);
}
}
if(card.Classifications.length === 0) {
errors.push(`Classifications present, but zero length for card ${getCardNameAndID(card)}`);
}
}
}
failIfReason(errors.join('\n'));
});
test('Card images resolve correctly', async () => {
const errors: string[] = [];
const cards = await cardsPromise;
await Promise.all(cards.map(async (card) => {
for(let i=0; i<IMAGE_TEST_RETRIES; i++) {
try {
const response = await fetch(card.Image);
if(!response.ok) {
errors.push(`BAD CARD IMAGE: ${getCardNameAndID(card)} - '${card.Image}'`);
return;
}
const contentType = response.headers.get('Content-Type');
if(!contentType) {
errors.push(`MISSING CONTENT TYPE, PROBABLY BAD: ${getCardNameAndID(card)} - '${card.Image}'`);
return;
}
if(!contentType.startsWith('image/')) {
errors.push(`CONTENT TYPE NOT IMAGE, PROBABLY BAD: ${getCardNameAndID(card)} - '${card.Image}'`);
return;
}
// Card's fine!
return;
} catch (e) {
if (i === IMAGE_TEST_RETRIES - 1) {
console.error(e);
errors.push(`ERROR WHILE FETCHING, PROBABLY SLOW LOADING: ${getCardNameAndID(card)} - '${card.Image}'`);
}
}
}
}));
failIfReason(errors.join('\n'));
},IMAGE_TEST_TIMEOUT);
test('CORS headers are set correctly', async () => {
const resp = await fetch(`${DEFAULT_LORCANA_API_ROOT_URL}/cards/fetch?strict=Smash`, {method: 'HEAD'});
const accessControl = resp.headers.get('Access-Control-Allow-Origin');
expect(accessControl).toBe('*');
}, 10_000);
test('If an ability word appears in the text box, it appears in the abilities list', async () => {
const errors: string[] = [];
const cards = await cardsPromise;
for(const card of cards) {
for(const ability of Abilities) {
if(card.Body_Text?.includes(ability) && (
!('Abilities' in card) ||
!(ability in (card.Abilities ?? {}))
)) {
errors.push(`${getCardNameAndID(card)} has the ability ${ability} in its body text, but not its Abilities list`);
}
}
}
failIfReason(errors.join('\n'));
});
});
test('[TS] Type narrowing works as expected', async () => {
const cards = await cardsPromise;
const aladdin = cards.find((c) => c.Name === 'Aladdin - Cornered Swordsman');
if(!aladdin) {
fail('Aladdin is not defined..?');
return;
}
if(aladdin.Type !== CardType.Character) {
fail('Aladdin is not a character..?');
return;
}
// This will only work if we've narrowed the type to be only a CharacterCardData
expect(aladdin.Willpower).toBe(1);
});
test('getCardByIDs works for Ariel - On Human Legs', async () => {
const ariel = await api.getCardByIDs(1, 1);
expect(ariel).toMatchSnapshot({
"Date_Modified": expect.any(String),
}, 'arielOnHumanLegs');
await new Promise<void>(resolve => setTimeout(() => resolve(), JEST_OPEN_HANDLE_DELAY)); // avoid jest open handle error
}, 10_000);
test('getCardsByIDs works to pull a couple cards from different sets', async () => {
const coupleCards = (await api.getCardsByIDs([
{setNum: 1, cardNum: 1},
{setNum: 1, cardNum: 3},
{setNum: 2, cardNum: 5},
{setNum: 2, cardNum: 7},
{setNum: 2, cardNum: 9},
]))?.sort((a, b) => b.Unique_ID.localeCompare(a.Unique_ID));
expect(Array.isArray(coupleCards)).toBe(true);
coupleCards!.forEach((card) => {
expect(card).toMatchSnapshot({
"Date_Modified": expect.any(String),
});
});
await new Promise<void>(resolve => setTimeout(() => resolve(), JEST_OPEN_HANDLE_DELAY)); // avoid jest open handle error
}, 10_000);
});