agerix/iconify
2
0
Fork 0
mirror of https://github.com/iconify/iconify.git synced 2024-12-13 14:13:06 +00:00
Code Issues Releases Activity

Merge branch 'dev/redundancy'

Browse Source
This commit is contained in:
Vjacheslav Trushkin 2022-01-27 09:36:10 +02:00
commit ded43ed8fc
19 changed files with 2278 additions and 2132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/api-redundancy/.eslintrc.js
View File

@ -15,6 +15,6 @@ module.exports = {
rules: {
'no-mixed-spaces-and-tabs': ['off'],
'no-unused-vars': ['off'],
'@typescript-eslint/no-unused-vars-experimental': ['error'],
// '@typescript-eslint/no-unused-vars-experimental': ['error'],
},
};

3685
packages/api-redundancy/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

20
packages/api-redundancy/package.json
View File

@ -30,16 +30,16 @@
"directory": "packages/api-redundancy"
},
"devDependencies": {
"@types/jest": "^27.0.1",
"@types/node": "^16.9.4",
"@typescript-eslint/eslint-plugin": "^4.31.1",
"@typescript-eslint/parser": "^4.31.1",
"@types/jest": "^27.4.0",
"@types/node": "^17.0.12",
"@typescript-eslint/eslint-plugin": "^5.10.1",
"@typescript-eslint/parser": "^5.10.1",
"cross-env": "^7.0.3",
"eslint": "^7.32.0",
"eslint-plugin-jasmine": "^4.1.2",
"jasmine": "^3.9.0",
"jest": "^27.2.0",
"ts-jest": "^27.0.5",
"tsup": "^5.1.0"
"eslint": "^8.7.0",
"eslint-plugin-jasmine": "^4.1.3",
"jasmine": "^4.0.2",
"jest": "^27.4.7",
"ts-jest": "^27.1.3",
"tsup": "^5.11.11"
}
}

47
packages/api-redundancy/spec/redundancySpec.mjs
View File

@ -21,7 +21,7 @@ describe('Redundancy class', () => {
const query = redundancy.query(
'/foo',
(resource, payload, status) => {
(resource, payload, callback) => {
counter++;
expect(counter).toBeLessThan(3); // No more than 2 queries should be executed
@ -34,7 +34,7 @@ describe('Redundancy class', () => {
}
// Do something with "data", simulate instant callback
status.done(responses[uri]);
callback('success', responses[uri]);
// Complete test
setTimeout(() => {
@ -78,29 +78,32 @@ describe('Redundancy class', () => {
};
let counter = 0;
const query = redundancy.query('/foo', (resource, payload, status) => {
counter++;
expect(counter).toBeLessThan(2); // Should be success on first call because start index = 1
const query = redundancy.query(
'/foo',
(resource, payload, callback) => {
counter++;
expect(counter).toBeLessThan(2); // Should be success on first call because start index = 1
// Make URI from resource + payload
const uri = resource + payload;
// Make URI from resource + payload
const uri = resource + payload;
// Get fake data if it exists
if (responses[uri] === void 0) {
return;
// Get fake data if it exists
if (responses[uri] === void 0) {
return;
}
// Do something with "data", simulate instant callback
callback('success', responses[uri]);
// Complete test
setTimeout(() => {
expect(counter).toEqual(1);
expect(query().status).toEqual('completed');
expect(redundancy.getIndex()).toEqual(1);
done();
});
}
// Do something with "data", simulate instant callback
status.done(responses[uri]);
// Complete test
setTimeout(() => {
expect(counter).toEqual(1);
expect(query().status).toEqual('completed');
expect(redundancy.getIndex()).toEqual(1);
done();
});
});
);
// Test find()
expect(redundancy.find((item) => item().payload === '/foo')).toEqual(

25
packages/api-redundancy/src/config.ts
View File

@ -1,24 +1,3 @@
/**
* Callback for "timeout" configuration property.
* Returns number of milliseconds to wait before failing query, while there are pending resources.
*/
export interface TimeoutCallback {
(
startTime: number // Start time
): number;
}
/**
* Callback for "rotate" configuration property.
* Returns number of milliseconds to wait before trying next resource.
*/
export interface RotationTimeoutCallback {
(
queriesSent: number, // Number of queries sent, starts with 1 for timeout after first resource
startTime: number // Query start time
): number;
}
/**
* Resource to rotate (usually hostname or partial URL)
*/
@ -30,8 +9,8 @@ export type RedundancyResource = string;
export interface RedundancyConfig {
resources: RedundancyResource[]; // Resources to rotate
index: number; // Start index
timeout: number | TimeoutCallback; // Timeout for error (full timeout = timeout + resources.length * rotate)
rotate: number | RotationTimeoutCallback; // Timeout for one query
timeout: number; // Timeout for error (full timeout = timeout + resources.length * rotate)
rotate: number; // Timeout for one query
random: boolean; // True if order should be randomised
dataAfterTimeout: boolean; // True if data can be sent after timeout
}

8
packages/api-redundancy/src/index.ts
View File

@ -13,9 +13,9 @@ import { sendQuery } from './query';
export { GetQueryStatus, QueryModuleCallback, QueryDoneCallback };
export type {
QueryAbortCallback,
QueryUpdateIndexCallback,
QueryStatus,
PendingQueryItem,
QueryModuleResponseType,
QueryModuleResponse,
} from './query';
/**
@ -117,10 +117,6 @@ export function initRedundancy(cfg: Partial<RedundancyConfig>): Redundancy {
if (doneCallback) {
doneCallback(data, error);
}
},
(newIndex) => {
// Update start index
config.index = newIndex;
}
);
queries.push(query);

107
packages/api-redundancy/src/query.ts
View File

@ -11,12 +11,20 @@ type QueryItemStatus = 'pending' | 'completed' | 'aborted' | 'failed';
*/
type QueryPayload = unknown;
/**
* Response from query module
*/
export type QueryModuleResponseData = unknown;
/**
* Callback
*
* If error is present, something went wrong and data is undefined. If error is undefined, data is set.
*/
export type QueryDoneCallback = (data?: unknown, error?: unknown) => void;
export type QueryDoneCallback = (
data?: QueryModuleResponseData,
error?: QueryModuleResponseData
) => void;
/**
* Callback for "abort" pending item.
@ -24,9 +32,13 @@ export type QueryDoneCallback = (data?: unknown, error?: unknown) => void;
export type QueryAbortCallback = () => void;
/**
* Callback to call to update last successful resource index. Used by Resundancy class to automatically update config.
* Response from query module
*/
export type QueryUpdateIndexCallback = (index: number) => void;
export type QueryModuleResponseType = 'success' | 'next' | 'abort';
export type QueryModuleResponse = (
status: QueryModuleResponseType,
data: QueryModuleResponseData
) => void;
/**
* Status for query
@ -52,12 +64,10 @@ export type GetQueryStatus = () => QueryStatus;
/**
* Item in pending items list
*/
export interface PendingQueryItem {
readonly getQueryStatus: GetQueryStatus;
interface PendingQueryItem {
status: QueryItemStatus; // Current query status
readonly resource: RedundancyResource; // Resource
readonly done: QueryDoneCallback; // Function to call with data
abort?: QueryAbortCallback; // Function to call to abort query, set by query handler
readonly callback: QueryModuleResponse; // Function to call with data
}
/**
@ -66,7 +76,7 @@ export interface PendingQueryItem {
export type QueryModuleCallback = (
resource: RedundancyResource,
payload: QueryPayload,
queryItem: PendingQueryItem
callback: QueryModuleResponse
) => void;
/**
@ -74,10 +84,9 @@ export type QueryModuleCallback = (
*/
export function sendQuery(
config: RedundancyConfig,
payload: unknown,
payload: QueryPayload,
query: QueryModuleCallback,
done?: QueryDoneCallback,
success?: QueryUpdateIndexCallback
done?: QueryDoneCallback
): GetQueryStatus {
// Get number of resources
const resourcesCount = config.resources.length;
@ -110,7 +119,7 @@ export function sendQuery(
const startTime = Date.now();
let status: QueryItemStatus = 'pending';
let queriesSent = 0;
let lastError: unknown = void 0;
let lastError: QueryModuleResponseData | undefined;
// Timer
let timer: ReturnType<typeof setTimeout> | null = null;
@ -148,9 +157,6 @@ export function sendQuery(
// Abort all queued items
queue.forEach((item) => {
if (item.abort) {
item.abort();
}
if (item.status === 'pending') {
item.status = 'aborted';
}
@ -205,15 +211,12 @@ export function sendQuery(
* Clear queue
*/
function clearQueue(): void {
queue = queue.filter((item) => {
queue.forEach((item) => {
if (item.status === 'pending') {
item.status = 'aborted';
}
if (item.abort) {
item.abort();
}
return false;
});
queue = [];
}
/**
@ -221,10 +224,10 @@ export function sendQuery(
*/
function moduleResponse(
item: PendingQueryItem,
data?: unknown,
error?: unknown
response: QueryModuleResponseType,
data: QueryModuleResponseData
): void {
const isError = data === void 0;
const isError = response !== 'success';
// Remove item from queue
queue = queue.filter((queued) => queued !== item);
@ -248,11 +251,16 @@ export function sendQuery(
return;
}
// Abort
if (response === 'abort') {
lastError = data;
failQuery();
return;
}
// Error
if (isError) {
if (error !== void 0) {
lastError = error;
}
lastError = data;
if (!queue.length) {
if (!resources.length) {
// Nothing else queued, nothing can be queued
@ -270,11 +278,11 @@ export function sendQuery(
resetTimer();
clearQueue();
// Update index in Redundancy
if (success && !config.random) {
// Update index in configuration
if (!config.random) {
const index = config.resources.indexOf(item.resource);
if (index !== -1 && index !== config.index) {
success(index);
config.index = index;
}
}
@ -302,22 +310,16 @@ export function sendQuery(
if (resource === void 0) {
// Nothing to execute: wait for final timeout before failing
if (queue.length) {
const timeout: number =
typeof config.timeout === 'function'
? config.timeout(startTime)
: config.timeout;
if (timeout) {
// Last timeout before failing to allow late response
timer = setTimeout(() => {
resetTimer();
if (status === 'pending') {
// Clear queue
clearQueue();
failQuery();
}
}, timeout);
return;
}
// Last timeout before failing to allow late response
timer = setTimeout(() => {
resetTimer();
if (status === 'pending') {
// Clear queue
clearQueue();
failQuery();
}
}, config.timeout);
return;
}
// Fail
@ -327,11 +329,10 @@ export function sendQuery(
// Create new item
const item: PendingQueryItem = {
getQueryStatus,
status: 'pending',
resource,
done: (data?: unknown, error?: unknown) => {
moduleResponse(item, data, error);
callback: (status, data) => {
moduleResponse(item, status, data);
},
};
@ -341,17 +342,11 @@ export function sendQuery(
// Bump next index
queriesSent++;
// Get timeout for next item
const timeout: number =
typeof config.rotate === 'function'
? config.rotate(queriesSent, startTime)
: config.rotate;
// Create timer
timer = setTimeout(execNext, timeout);
timer = setTimeout(execNext, config.rotate);
// Execute it
query(resource, payload, item);
query(resource, payload, item.callback);
}
// Execute first query on next tick

93
packages/api-redundancy/tests/advanced-queries-test.ts
View File

@ -1,5 +1,5 @@
import type { RedundancyConfig } from '../src/config';
import type { PendingQueryItem } from '../src/query';
import type { QueryModuleResponse } from '../src/query';
import { sendQuery } from '../src/query';
describe('Advanced queries with multiple resources', () => {
@ -20,14 +20,13 @@ describe('Advanced queries with multiple resources', () => {
let isSync = true;
const startTime = Date.now();
let sentQuery = 0;
let itemAborted = false;
let secondItem: PendingQueryItem;
let secondCallback: QueryModuleResponse;
// Send query
const getStatus = sendQuery(
config,
payload,
(resource, queryPayload, queryItem) => {
(resource, queryPayload, callback) => {
expect(isSync).toEqual(false);
expect(queryPayload).toEqual(payload);
@ -36,7 +35,6 @@ describe('Advanced queries with multiple resources', () => {
expect(resource).toEqual(resources[sentQuery]);
// Check status
expect(queryItem.getQueryStatus).toEqual(getStatus);
const status = getStatus();
expect(status.status).toEqual('pending');
expect(status.payload).toEqual(payload);
@ -51,13 +49,6 @@ describe('Advanced queries with multiple resources', () => {
expect(status.queriesSent).toEqual(1);
expect(status.queriesPending).toEqual(1);
// Add abort
queryItem.abort = (): void => {
done(
'Abort should have not been called for first item'
);
};
// Fail in 20ms
setTimeout(() => {
// Status should not have changed
@ -66,7 +57,7 @@ describe('Advanced queries with multiple resources', () => {
expect(status.queriesPending).toEqual(1);
// Fail
queryItem.done(void 0, true);
callback('next', true);
}, 20);
return;
@ -75,15 +66,8 @@ describe('Advanced queries with multiple resources', () => {
expect(status.queriesSent).toEqual(2);
expect(status.queriesPending).toEqual(1);
// Add abort
queryItem.abort = (): void => {
done(
'Abort should have not been called for second item'
);
};
// Save item
secondItem = queryItem;
secondCallback = callback;
return;
case 3:
@ -91,16 +75,8 @@ describe('Advanced queries with multiple resources', () => {
expect(status.queriesSent).toEqual(3);
expect(status.queriesPending).toEqual(2);
// Add abort
queryItem.abort = (): void => {
// This item should be aborted, but only once
expect(itemAborted).toEqual(false);
expect(sentQuery).toEqual(3);
itemAborted = true;
};
// Complete second item
secondItem.done(result);
secondCallback('success', result);
return;
default:
@ -111,9 +87,6 @@ describe('Advanced queries with multiple resources', () => {
// Make sure queries were sent
expect(sentQuery).toEqual(3);
// Third query should have been aborted
expect(itemAborted).toEqual(true);
// Validate data
expect(data).toEqual(result);
expect(error).toBeUndefined();
@ -159,14 +132,13 @@ describe('Advanced queries with multiple resources', () => {
let isSync = true;
const startTime = Date.now();
let sentQuery = 0;
let itemAborted = false;
let firstItem: PendingQueryItem;
let firstCallback: QueryModuleResponse;
// Send query
const getStatus = sendQuery(
config,
payload,
(resource, queryPayload, queryItem) => {
(resource, queryPayload, callback) => {
expect(isSync).toEqual(false);
expect(queryPayload).toEqual(payload);
@ -175,7 +147,6 @@ describe('Advanced queries with multiple resources', () => {
expect(resource).toEqual(resources[sentQuery]);
// Check status
expect(queryItem.getQueryStatus).toEqual(getStatus);
const status = getStatus();
expect(status.status).toEqual('pending');
expect(status.payload).toEqual(payload);
@ -190,15 +161,8 @@ describe('Advanced queries with multiple resources', () => {
expect(status.queriesSent).toEqual(1);
expect(status.queriesPending).toEqual(1);
// Add abort
queryItem.abort = (): void => {
done(
'Abort should have not been called for first item'
);
};
// Store item
firstItem = queryItem;
// Store callback
firstCallback = callback;
return;
case 2:
@ -206,12 +170,6 @@ describe('Advanced queries with multiple resources', () => {
expect(status.queriesSent).toEqual(2);
expect(status.queriesPending).toEqual(2);
// Add abort
queryItem.abort = (): void => {
expect(itemAborted).toEqual(false);
itemAborted = true;
};
// Complete first item in 20ms (70ms from start), then second item
setTimeout(() => {
// Check status
@ -220,14 +178,12 @@ describe('Advanced queries with multiple resources', () => {
expect(status.queriesSent).toEqual(2);
expect(status.queriesPending).toEqual(2);
firstItem.done(result1);
firstCallback('success', result1);
// Complete second item in 30 ms
setTimeout(() => {
expect(queryItem.status).toEqual('aborted');
// Should not change anything because query is already complete
queryItem.done(result2);
callback('success', result2);
// Finish test
done();
@ -243,9 +199,6 @@ describe('Advanced queries with multiple resources', () => {
// Make sure queries were sent
expect(sentQuery).toEqual(2);
// Second query should have been aborted
expect(itemAborted).toEqual(true);
// Validate data
expect(data).toEqual(result1);
expect(error).toBeUndefined();
@ -290,14 +243,14 @@ describe('Advanced queries with multiple resources', () => {
let isSync = true;
const startTime = Date.now();
let sentQuery = 0;
let firstItem: PendingQueryItem;
let firstCallback: QueryModuleResponse;
let completeCount = 0;
// Send query
const getStatus = sendQuery(
config,
payload,
(resource, queryPayload, queryItem) => {
(resource, queryPayload, callback) => {
expect(isSync).toEqual(false);
expect(queryPayload).toEqual(payload);
@ -306,7 +259,6 @@ describe('Advanced queries with multiple resources', () => {
expect(resource).toEqual(resources[sentQuery]);
// Check status
expect(queryItem.getQueryStatus).toEqual(getStatus);
const status = getStatus();
expect(status.status).toEqual('pending');
expect(status.payload).toEqual(payload);
@ -321,8 +273,8 @@ describe('Advanced queries with multiple resources', () => {
expect(status.queriesSent).toEqual(1);
expect(status.queriesPending).toEqual(1);
// Store item
firstItem = queryItem;
// Store callback
firstCallback = callback;
return;
case 2:
@ -360,7 +312,7 @@ describe('Advanced queries with multiple resources', () => {
expect(diff > 130 && diff < 170).toEqual(true);
// Send data from first query, which should be ignored because dataAfterTimeout is false
firstItem.done(result);
firstCallback('success', result);
// Complete test
done();
@ -399,14 +351,14 @@ describe('Advanced queries with multiple resources', () => {
let isSync = true;
const startTime = Date.now();
let sentQuery = 0;
let firstItem: PendingQueryItem;
let firstCallback: QueryModuleResponse;
let completeCount = 0;
// Send query
const getStatus = sendQuery(
config,
payload,
(resource, queryPayload, queryItem) => {
(resource, queryPayload, callback) => {
expect(isSync).toEqual(false);
expect(queryPayload).toEqual(payload);
@ -415,7 +367,6 @@ describe('Advanced queries with multiple resources', () => {
expect(resource).toEqual(resources[sentQuery]);
// Check status
expect(queryItem.getQueryStatus).toEqual(getStatus);
const status = getStatus();
expect(status.status).toEqual('pending');
expect(status.payload).toEqual(payload);
@ -430,8 +381,8 @@ describe('Advanced queries with multiple resources', () => {
expect(status.queriesSent).toEqual(1);
expect(status.queriesPending).toEqual(1);
// Store item
firstItem = queryItem;
// Store callback
firstCallback = callback;
return;
case 2:
@ -469,7 +420,7 @@ describe('Advanced queries with multiple resources', () => {
expect(diff > 130 && diff < 170).toEqual(true);
// Send data from first query
firstItem.done(result);
firstCallback('success', result);
})();
return;

90
packages/api-redundancy/tests/basic-query-test.ts
View File

@ -74,7 +74,7 @@ describe('Basic queries', () => {
const getStatus = sendQuery(
config,
payload,
(resource, queryPayload, queryItem) => {
(resource, queryPayload, callback) => {
expect(isSync).toEqual(false);
expect(resource).toEqual(resources[0]);
expect(queryPayload).toEqual(payload);
@ -84,20 +84,14 @@ describe('Basic queries', () => {
sentQuery = true;
// Check status
expect(queryItem.getQueryStatus).toEqual(getStatus);
const status = getStatus();
expect(status.status).toEqual('pending');
expect(status.payload).toEqual(payload);
expect(status.queriesSent).toEqual(1);
expect(status.queriesPending).toEqual(1);
// Add abort function
queryItem.abort = (): void => {
done('Abort should have not been called');
};
// Complete
queryItem.done(result);
callback('success', result);
},
(data, error) => {
// Make sure query was sent
@ -152,7 +146,7 @@ describe('Basic queries', () => {
const getStatus = sendQuery(
config,
payload,
(resource, queryPayload, queryItem) => {
(resource, queryPayload, callback) => {
expect(isSync).toEqual(false);
expect(resource).toEqual(resources[0]);
expect(queryPayload).toEqual(payload);
@ -161,13 +155,8 @@ describe('Basic queries', () => {
expect(sentQuery).toEqual(false);
sentQuery = true;
// Add abort function
queryItem.abort = (): void => {
done('Abort should have not been called');
};
// Fail
queryItem.done(void 0, result);
callback('next', result);
},
(data, error) => {
// Make sure query was sent
@ -216,13 +205,12 @@ describe('Basic queries', () => {
let isSync = true;
const startTime = Date.now();
let sentQuery = false;
let itemAborted = false;
// Send query
const getStatus = sendQuery(
config,
payload,
(resource, queryPayload, queryItem) => {
(resource, queryPayload) => {
expect(isSync).toEqual(false);
expect(resource).toEqual(resources[0]);
expect(queryPayload).toEqual(payload);
@ -231,12 +219,6 @@ describe('Basic queries', () => {
expect(sentQuery).toEqual(false);
sentQuery = true;
// Add abort function
queryItem.abort = (): void => {
expect(itemAborted).toEqual(false);
itemAborted = true;
};
// Do not do anything
},
(data, error) => {
@ -253,9 +235,6 @@ describe('Basic queries', () => {
expect(status.queriesSent).toEqual(1);
expect(status.queriesPending).toEqual(0);
// Item should have been aborted
expect(itemAborted).toEqual(true);
// Should have been config.rotate + config.timeout
const diff = Date.now() - startTime;
expect(diff).toBeGreaterThan(250);
@ -272,4 +251,63 @@ describe('Basic queries', () => {
isSync = false;
});
it('Abort query', (done) => {
const payload = {};
const resources = ['api1', 'api2', 'api3'];
const config: RedundancyConfig = {
resources,
index: 0,
timeout: 200,
rotate: 100,
random: false,
dataAfterTimeout: false,
};
// Tracking
let isSync = true;
let sentQuery = false;
// Send query
const getStatus = sendQuery(
config,
payload,
(resource, queryPayload, callback) => {
expect(isSync).toEqual(false);
expect(resource).toEqual(resources[0]);
expect(queryPayload).toEqual(payload);
// Make sure query was executed only once
expect(sentQuery).toEqual(false);
sentQuery = true;
// Abort
callback('abort', 404);
},
(data, error) => {
// Make sure query was sent
expect(sentQuery).toEqual(true);
// Validate data
expect(data).toBeUndefined();
expect(error).toBe(404);
// Check status
const status = getStatus();
expect(status.status).toEqual('failed');
expect(status.queriesSent).toEqual(1);
expect(status.queriesPending).toEqual(0);
done();
}
);
// Check status
const status = getStatus();
expect(status.status).toEqual('pending');
expect(status.queriesSent).toEqual(0);
expect(status.queriesPending).toEqual(0);
isSync = false;
});
});

114
packages/api-redundancy/tests/multiple-resources-test.ts
View File

@ -24,7 +24,7 @@ describe('Multiple resources', () => {
const getStatus = sendQuery(
config,
payload,
(resource, queryPayload, queryItem) => {
(resource, queryPayload, callback) => {
expect(isSync).toEqual(false);
expect(resource).toEqual('api1');
expect(queryPayload).toEqual(payload);
@ -34,20 +34,14 @@ describe('Multiple resources', () => {
sentQuery++;
// Check status
expect(queryItem.getQueryStatus).toEqual(getStatus);
const status = getStatus();
expect(status.status).toEqual('pending');
expect(status.payload).toEqual(payload);
expect(status.queriesSent).toEqual(1);
expect(status.queriesPending).toEqual(1);
// Add abort function
queryItem.abort = (): void => {
done('Abort should have not been called');
};
// Complete
queryItem.done(result);
callback('success', result);
},
(data, error) => {
// Make sure query was sent
@ -68,9 +62,6 @@ describe('Multiple resources', () => {
expect(diff).toBeLessThan(50);
done();
},
() => {
done('This should not have been called');
}
);
@ -100,14 +91,12 @@ describe('Multiple resources', () => {
let isSync = true;
const startTime = Date.now();
let sentQuery = 0;
let itemAborted = false;
let parentUpdated = false;
// Send query
const getStatus = sendQuery(
config,
payload,
(resource, queryPayload, queryItem) => {
(resource, queryPayload, callback) => {
expect(isSync).toEqual(false);
expect(queryPayload).toEqual(payload);
@ -116,7 +105,6 @@ describe('Multiple resources', () => {
expect(resource).toEqual(resources[sentQuery]);
// Check status
expect(queryItem.getQueryStatus).toEqual(getStatus);
const status = getStatus();
expect(status.status).toEqual('pending');
expect(status.payload).toEqual(payload);
@ -128,29 +116,15 @@ describe('Multiple resources', () => {
expect(status.queriesSent).toEqual(sentQuery);
expect(status.queriesPending).toEqual(sentQuery);
// Add abort function
// Time out first, complete second
switch (sentQuery) {
case 1:
queryItem.abort = (): void => {
// First item should be aborted, but only once
expect(itemAborted).toEqual(false);
// When this is executed, counter should have been increased
expect(sentQuery).toEqual(2);
itemAborted = true;
// Do nothing, let it time out
};
// Do nothing, let it time out
return;
case 2:
queryItem.abort = (): void => {
done('Abort should have not been called');
};
// Send result
queryItem.done(result);
callback('success', result);
return;
default:
@ -161,9 +135,6 @@ describe('Multiple resources', () => {
// Make sure queries were sent
expect(sentQuery).toEqual(2);
// First query should have been aborted
expect(itemAborted).toEqual(true);
// Validate data
expect(data).toEqual(result);
expect(error).toBeUndefined();
@ -174,20 +145,12 @@ describe('Multiple resources', () => {
expect(status.queriesSent).toEqual(2);
expect(status.queriesPending).toEqual(0);
// Parent should have been updated
expect(parentUpdated).toEqual(true);
// Delay between first and second queries
const diff = Date.now() - startTime;
expect(diff).toBeGreaterThan(50);
expect(diff).toBeLessThan(150);
done();
},
(newIndex) => {
// Start index should be updated to 1
expect(newIndex).toEqual(1);
parentUpdated = true;
}
);
@ -216,14 +179,12 @@ describe('Multiple resources', () => {
let isSync = true;
const startTime = Date.now();
let sentQuery = 0;
let item1Aborted = false;
let item2Aborted = false;
// Send query
const getStatus = sendQuery(
config,
payload,
(resource, queryPayload, queryItem) => {
(resource, queryPayload, callback) => {
expect(isSync).toEqual(false);
expect(queryPayload).toEqual(payload);
@ -232,7 +193,6 @@ describe('Multiple resources', () => {
expect(resource).toEqual(resources[sentQuery]);
// Check status
expect(queryItem.getQueryStatus).toEqual(getStatus);
const status = getStatus();
expect(status.status).toEqual('pending');
expect(status.payload).toEqual(payload);
@ -247,29 +207,8 @@ describe('Multiple resources', () => {
// Add abort functions
switch (sentQuery) {
case 1:
queryItem.abort = (): void => {
expect(item1Aborted).toEqual(false);
expect(item2Aborted).toEqual(false);
// This should have been executed at the end
expect(sentQuery).toEqual(2);
item1Aborted = true;
// Do not send anything
};
return;
case 2:
queryItem.abort = (): void => {
expect(item1Aborted).toEqual(true);
expect(item2Aborted).toEqual(false);
// This should have been executed at the end
expect(sentQuery).toEqual(2);
item2Aborted = true;
// Do not send anything
};
// Do not send anything
return;
default:
@ -280,10 +219,6 @@ describe('Multiple resources', () => {
// Make sure queries were sent
expect(sentQuery).toEqual(2);
// Queries should have been aborted
expect(item1Aborted).toEqual(true);
expect(item2Aborted).toEqual(true);
// Validate data
expect(data).toBeUndefined();
expect(error).toBeUndefined();
@ -300,9 +235,6 @@ describe('Multiple resources', () => {
expect(diff).toBeLessThan(120);
done();
},
() => {
done('This should have never been called');
}
);
@ -331,14 +263,12 @@ describe('Multiple resources', () => {
let isSync = true;
const startTime = Date.now();
let sentQuery = 0;
let item1Aborted = false;
let item2Aborted = false;
// Send query
const getStatus = sendQuery(
config,
payload,
(resource, queryPayload, queryItem) => {
(resource, queryPayload) => {
expect(isSync).toEqual(false);
expect(queryPayload).toEqual(payload);
@ -348,33 +278,11 @@ describe('Multiple resources', () => {
// Bump counter
sentQuery++;
// Add abort functions
switch (sentQuery) {
case 1:
queryItem.abort = (): void => {
item1Aborted = true;
};
return;
case 2:
queryItem.abort = (): void => {
item2Aborted = true;
};
return;
default:
done('This code should not have been reached');
}
},
(data, error) => {
// Make sure queries were sent
expect(sentQuery).toEqual(2);
// Queries should have been aborted
expect(item1Aborted).toEqual(true);
expect(item2Aborted).toEqual(true);
// Validate data
expect(data).toBeUndefined();
expect(error).toBeUndefined();
@ -385,9 +293,6 @@ describe('Multiple resources', () => {
expect(diff).toBeLessThan(120);
done();
},
() => {
done('This should have never been called');
}
);
@ -448,9 +353,6 @@ describe('Multiple resources', () => {
expect(diff).toBeLessThan(170);
done();
},
() => {
done('This should have never been called');
}
);

47
packages/api-redundancy/tests/redundancy-test.ts
View File

@ -23,7 +23,7 @@ describe('Redundancy class', () => {
const query = redundancy.query(
'/foo',
(resource, payload, status) => {
(resource, payload, callback) => {
counter++;
expect(counter).toBeLessThan(3); // No more than 2 queries should be executed
@ -36,7 +36,7 @@ describe('Redundancy class', () => {
}
// Do something with "data", simulate instant callback
status.done(responses[uri]);
callback('success', responses[uri]);
// Complete test
setTimeout(() => {
@ -80,29 +80,32 @@ describe('Redundancy class', () => {
};
let counter = 0;
const query = redundancy.query('/foo', (resource, payload, status) => {
counter++;
expect(counter).toBeLessThan(2); // Should be success on first call because start index = 1
const query = redundancy.query(
'/foo',
(resource, payload, callback) => {
counter++;
expect(counter).toBeLessThan(2); // Should be success on first call because start index = 1
// Make URI from resource + payload
const uri = (resource as string) + (payload as string);
// Make URI from resource + payload
const uri = (resource as string) + (payload as string);
// Get fake data if it exists
if (responses[uri] === void 0) {
return;
// Get fake data if it exists
if (responses[uri] === void 0) {
return;
}
// Do something with "data", simulate instant callback
callback('success', responses[uri]);
// Complete test
setTimeout(() => {
expect(counter).toEqual(1);
expect(query().status).toEqual('completed');
expect(redundancy.getIndex()).toEqual(1);
done();
});
}
// Do something with "data", simulate instant callback
status.done(responses[uri]);
// Complete test
setTimeout(() => {
expect(counter).toEqual(1);
expect(query().status).toEqual('completed');
expect(redundancy.getIndex()).toEqual(1);
done();
});
});
);
// Test find()
expect(redundancy.find((item) => item().payload === '/foo')).toEqual(

24
packages/core/spec/api/loadingSpec.mjs
View File

@ -46,7 +46,7 @@ describe('Testing API loadIcons', () => {
return [item];
};
const sendQuery = (host, params, item) => {
const sendQuery = (host, params, callback) => {
// This callback should be called after prepareQuery
expect(asyncCounter).toBe(2);
asyncCounter++;
@ -64,7 +64,7 @@ describe('Testing API loadIcons', () => {
expect(params).toEqual(expected);
// Send data
item.done({
callback('success', {
prefix,
icons: {
icon1: {
@ -170,7 +170,7 @@ describe('Testing API loadIcons', () => {
};
let queryCounter = 0;
const sendQuery = (host, params, item) => {
const sendQuery = (host, params, callback) => {
// Test input
expect(host).toBe('https://api1.local');
@ -196,7 +196,7 @@ describe('Testing API loadIcons', () => {
body: '<path d="" />',
};
});
item.done({
callback('success', {
prefix,
icons,
// Test mismatched provider: should be ignored because provider name is not affected by actual API response
@ -263,7 +263,7 @@ describe('Testing API loadIcons', () => {
};
let queryCounter = 0;
const sendQuery = (host, params, item) => {
const sendQuery = (host, params, callback) => {
queryCounter++;
params;
switch (queryCounter) {
@ -279,7 +279,7 @@ describe('Testing API loadIcons', () => {
expect(host).toBe('https://api2.local');
// Return result
item.done({
callback('success', {
prefix,
icons: {
icon1: {
@ -359,7 +359,7 @@ describe('Testing API loadIcons', () => {
};
let queryCounter = 0;
const sendQuery = (host, params, item) => {
const sendQuery = (host, params, callback) => {
queryCounter++;
expect(params.type).toBe('icons');
@ -382,7 +382,7 @@ describe('Testing API loadIcons', () => {
expect(host).toBe('https://api2.local');
// Return result
item.done({
callback('success', {
prefix,
icons: {
icon1: {
@ -401,7 +401,7 @@ describe('Testing API loadIcons', () => {
expect(host).toBe('https://api2.local');
// Return result
item.done({
callback('success', {
prefix,
icons: {
icon3: {
@ -514,7 +514,7 @@ describe('Testing API loadIcons', () => {
};
let queryCounter = 0;
const sendQuery = (host, params, item) => {
const sendQuery = (host, params, callback) => {
queryCounter++;
expect(params.type).toBe('icons');
@ -539,7 +539,7 @@ describe('Testing API loadIcons', () => {
expect(host).toBe('https://api2.local');
// Return result
item.done({
callback('success', {
prefix: params.prefix,
icons: {
icon1: {
@ -559,7 +559,7 @@ describe('Testing API loadIcons', () => {
expect(host).toBe('https://api2.local');
// Return result
item.done({
callback('success', {
prefix: params.prefix,
icons: {
icon2: {

4
packages/core/src/api/modules.ts
View File

@ -1,4 +1,4 @@
import type { PendingQueryItem } from '@iconify/api-redundancy';
import type { QueryModuleResponse } from '@iconify/api-redundancy';
/**
* Params for sendQuery()
@ -31,7 +31,7 @@ export type IconifyAPIPrepareIconsQuery = (
export type IconifyAPISendQuery = (
host: string,
params: IconifyAPIQueryParams,
status: PendingQueryItem
callback: QueryModuleResponse
) => void;
/**

26
packages/core/src/api/modules/fetch.ts
View File

@ -1,4 +1,4 @@
import type { PendingQueryItem } from '@iconify/api-redundancy';
import type { QueryModuleResponse } from '@iconify/api-redundancy';
import type {
IconifyAPIQueryParams,
IconifyAPIPrepareIconsQuery,
@ -106,6 +106,13 @@ function calculateMaxLength(provider: string, prefix: string): number {
return result;
}
/**
* Should query be aborted, based on last HTTP status
*/
function shouldAbort(status: number): boolean {
return status === 404;
}
/**
* Prepare params
*/
@ -178,11 +185,11 @@ function getPath(provider?: string): string {
const send: IconifyAPISendQuery = (
host: string,
params: IconifyAPIQueryParams,
status: PendingQueryItem
callback: QueryModuleResponse
): void => {
if (!fetchModule) {
// Fail: return "424 Failed Dependency" (its not meant to be used like that, but it is the closest match)
status.done(void 0, 424);
callback('abort', 424);
return;
}
@ -208,7 +215,7 @@ const send: IconifyAPISendQuery = (
default:
// Fail: return 400 Bad Request
status.done(void 0, 400);
callback('abort', 400);
return;
}
@ -218,10 +225,11 @@ const send: IconifyAPISendQuery = (
// console.log('API query:', host + path);
fetchModule(host + path)
.then((response) => {
if (response.status !== 200) {
const status = response.status;
if (status !== 200) {
setTimeout(() => {
// Complete on next tick to get out of try...catch
status.done(void 0, response.status);
callback(shouldAbort(status) ? 'abort' : 'next', status);
});
return;
}
@ -234,7 +242,7 @@ const send: IconifyAPISendQuery = (
if (typeof data !== 'object' || data === null) {
setTimeout(() => {
// Complete on next tick to get out of try...catch
status.done(void 0, defaultError);
callback('next', defaultError);
});
return;
}
@ -242,11 +250,11 @@ const send: IconifyAPISendQuery = (
// Store cache and complete on next tick
setTimeout(() => {
// Complete on next tick to get out of try...catch
status.done(data);
callback('success', data);
});
})
.catch(() => {
status.done(void 0, defaultError);
callback('next', defaultError);
});
};

10
packages/core/src/api/modules/jsonp.ts
View File

@ -1,4 +1,4 @@
import type { PendingQueryItem } from '@iconify/api-redundancy';
import type { QueryModuleResponse } from '@iconify/api-redundancy';
import type {
IconifyAPIQueryParams,
IconifyAPIPrepareIconsQuery,
@ -104,6 +104,7 @@ function calculateMaxLength(provider: string, prefix: string): number {
// Get available length
const url = mergeParams(prefix + '.js', {
icons: '',
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
callback: rootVarName!,
});
result =
@ -170,11 +171,11 @@ const prepare: IconifyAPIPrepareIconsQuery = (
const send: IconifyAPISendQuery = (
host: string,
params: IconifyAPIQueryParams,
status: PendingQueryItem
callback: QueryModuleResponse
): void => {
if (params.type !== 'icons') {
// JSONP supports only icons
status.done(void 0, 400);
callback('abort', 400);
return;
}
@ -201,6 +202,7 @@ const send: IconifyAPISendQuery = (
const url = mergeParams(prefix + '.js', {
icons: iconsList,
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
callback: rootVarName!.replace('{cb}', callbackName),
});
const path = pathCache[cacheKey] + url;
@ -208,7 +210,7 @@ const send: IconifyAPISendQuery = (
global[callbackName] = (data: unknown): void => {
// Remove callback and complete query
delete global[callbackName];
status.done(data);
callback('success', data);
};
// Create URI

20
packages/core/src/api/modules/mock.ts
View File

@ -1,6 +1,5 @@
/* eslint-disable @typescript-eslint/no-unused-vars-experimental */
/* eslint-disable @typescript-eslint/no-unused-vars */
import type { PendingQueryItem } from '@iconify/api-redundancy';
import type { QueryModuleResponse } from '@iconify/api-redundancy';
import type {
IconifyAPIIconsQueryParams,
IconifyAPIQueryParams,
@ -252,7 +251,7 @@ export const mockAPIModule: IconifyAPIModule = {
send: (
host: string,
params: IconifyAPIQueryParams,
status: PendingQueryItem
queryCallback: QueryModuleResponse
) => {
const provider = params.provider;
let data: IconifyMockAPI;
@ -261,7 +260,7 @@ export const mockAPIModule: IconifyAPIModule = {
case 'icons': {
if (provider === void 0) {
// Fail: return 400 Bad Request
status.done(void 0, 400);
queryCallback('abort', 400);
return;
}
const index = (params as MockAPIIconsQueryParams).index;
@ -280,12 +279,12 @@ export const mockAPIModule: IconifyAPIModule = {
default:
// Fail: return 400 Bad Request
status.done(void 0, 400);
queryCallback('abort', 400);
return;
}
if (data === void 0) {
status.done(void 0, 404);
queryCallback('abort', 404);
return;
}
@ -308,11 +307,10 @@ export const mockAPIModule: IconifyAPIModule = {
// Run after delay
callback(() => {
if (typeof data.response === 'number') {
status.done(void 0, data.response);
} else {
status.done(data.response);
}
queryCallback(
typeof data.response === 'number' ? 'next' : 'success',
data.response
);
});
},
};

34
packages/core/tests/api/loading-test.ts
View File

@ -1,4 +1,4 @@
import type { PendingQueryItem } from '@iconify/api-redundancy';
import type { QueryModuleResponse } from '@iconify/api-redundancy';
import { addAPIProvider } from '../../lib/api/config';
import type {
IconifyAPIIconsQueryParams,
@ -58,7 +58,7 @@ describe('Testing API loadIcons', () => {
const sendQuery = (
host: string,
params: IconifyAPIQueryParams,
item: PendingQueryItem
callback: QueryModuleResponse
): void => {
// This callback should be called after prepareQuery
expect(asyncCounter).toBe(2);
@ -77,7 +77,7 @@ describe('Testing API loadIcons', () => {
expect(params).toEqual(expected);
// Send data
item.done({
callback('success', {
prefix,
icons: {
icon1: {
@ -191,7 +191,7 @@ describe('Testing API loadIcons', () => {
const sendQuery = (
host: string,
params: IconifyAPIQueryParams,
item: PendingQueryItem
callback: QueryModuleResponse
): void => {
expect(params.type).toBe('icons');
@ -206,7 +206,7 @@ describe('Testing API loadIcons', () => {
expect(params).toEqual(expected);
// Send data
item.done({
callback('success', {
prefix,
icons: {
icon1: {
@ -265,7 +265,7 @@ describe('Testing API loadIcons', () => {
const sendQuery = (
host: string,
params: IconifyAPIQueryParams,
item: PendingQueryItem
callback: QueryModuleResponse
): void => {
expect(params.type).toBe('icons');
@ -280,7 +280,7 @@ describe('Testing API loadIcons', () => {
expect(params).toEqual(expected);
// Send data
item.done({
callback('success', {
prefix,
icons: {
icon1: {
@ -351,7 +351,7 @@ describe('Testing API loadIcons', () => {
const sendQuery = (
host: string,
params: IconifyAPIQueryParams,
item: PendingQueryItem
callback: QueryModuleResponse
): void => {
// Test input
expect(host).toBe('https://api1.local');
@ -378,7 +378,7 @@ describe('Testing API loadIcons', () => {
body: '<path d="" />',
};
});
item.done({
callback('success', {
prefix,
icons,
// Test mismatched provider: should be ignored because provider name is not affected by actual API response
@ -452,7 +452,7 @@ describe('Testing API loadIcons', () => {
const sendQuery = (
host: string,
params: IconifyAPIQueryParams,
item: PendingQueryItem
callback: QueryModuleResponse
): void => {
queryCounter++;
params;
@ -469,7 +469,7 @@ describe('Testing API loadIcons', () => {
expect(host).toBe('https://api2.local');
// Return result
item.done({
callback('success', {
prefix,
icons: {
icon1: {
@ -556,7 +556,7 @@ describe('Testing API loadIcons', () => {
const sendQuery = (
host: string,
params: IconifyAPIQueryParams,
item: PendingQueryItem
callback: QueryModuleResponse
): void => {
queryCounter++;
@ -580,7 +580,7 @@ describe('Testing API loadIcons', () => {
expect(host).toBe('https://api2.local');
// Return result
item.done({
callback('success', {
prefix,
icons: {
icon1: {
@ -599,7 +599,7 @@ describe('Testing API loadIcons', () => {
expect(host).toBe('https://api2.local');
// Return result
item.done({
callback('success', {
prefix,
icons: {
icon3: {
@ -719,7 +719,7 @@ describe('Testing API loadIcons', () => {
const sendQuery = (
host: string,
params: IconifyAPIQueryParams,
item: PendingQueryItem
callback: QueryModuleResponse
): void => {
queryCounter++;
@ -745,7 +745,7 @@ describe('Testing API loadIcons', () => {
expect(host).toBe('https://api2.local');
// Return result
item.done({
callback('success', {
prefix: params.prefix,
icons: {
icon1: {
@ -765,7 +765,7 @@ describe('Testing API loadIcons', () => {
expect(host).toBe('https://api2.local');
// Return result
item.done({
callback('success', {
prefix: params.prefix,
icons: {
icon2: {

43
packages/core/tests/api/mock-test.ts
View File

@ -353,4 +353,47 @@ describe('Testing mock API module', () => {
isSync = false;
});
it('not_found response', (done) => {
const prefix = nextPrefix();
mockAPIData({
type: 'icons',
provider,
prefix,
icons: ['test1', 'test2'],
response: {
prefix,
icons: {},
not_found: ['test1', 'test2'],
},
});
let isSync = true;
loadIcons(
[
{
provider,
prefix,
name: 'test1',
},
],
(loaded, missing, pending) => {
expect(isSync).toBe(false);
expect(loaded).toEqual([]);
expect(pending).toEqual([]);
expect(missing).toEqual([
{
provider,
prefix,
name: 'test1',
},
]);
done();
}
);
isSync = false;
});
});

11
packages/utils/src/icon-set/validate.ts
View File

@ -173,8 +173,17 @@ export function validateIconSet(
}
});
// Check not_found
if (data.not_found !== void 0 && !(data.not_found instanceof Array)) {
if (fix) {
delete data.not_found;
} else {
throw new Error('Invalid not_found list');
}
}
// Make sure icons list is not empty
if (!Object.keys(data.icons).length) {
if (!Object.keys(data.icons).length && !data.not_found?.length) {
throw new Error('Icon set is empty');
}