Branch
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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
const { assert } = require('chai');
const getLoader = require('../dependencies');
const components = require('../components.json');
describe('Dependency logic', function () {
/** @type {import("../dependencies").Components} */
const components = {
languages: {
'a': {
alias: 'a2'
},
'b': {
alias: 'b2'
},
'c': {
require: 'a',
optional: ['b', 'e']
},
'd': {
require: ['c', 'b'],
alias: 'xyz'
},
},
pluginsOrSomething: {
'e': {
modify: 'a'
},
}
};
/**
* Returns the ids of `getLoader`.
*
* @param {string[]} load
* @param {string[]} [loaded]
* @returns {string[]}
*/
function getIds(load, loaded) {
return getLoader(components, load, loaded).getIds();
}
describe('Returned ids', function () {
it('- should load requirements', function () {
assert.sameMembers(getIds(['d']), ['a', 'b', 'c', 'd']);
});
it('- should not load already loaded requirements if not necessary', function () {
assert.sameMembers(getIds(['d'], ['a', 'b']), ['c', 'd']);
});
it('- should load already loaded requirements if requested', function () {
assert.sameMembers(getIds(['a', 'd'], ['a', 'b']), ['a', 'c', 'd']);
});
it('- should reload modified components', function () {
assert.sameMembers(getIds(['e'], ['a', 'b', 'c', 'd']), ['a', 'c', 'd', 'e']);
});
it('- should work with empty load', function () {
assert.sameMembers(getIds([], ['a', 'b', 'c', 'd']), []);
});
it('- should return unknown ids as is', function () {
assert.sameMembers(getIds(['c', 'foo'], ['bar']), ['foo', 'c', 'a']);
});
it('- should throw on unknown dependencies', function () {
assert.throws(() => {
/** @type {import("../dependencies").Components} */
const circular = {
languages: {
a: {
require: 'c'
},
b: 'B'
}
};
getLoader(circular, ['a']).getIds();
});
});
});
describe('Load order', function () {
// Note: The order of a and b isn't defined, so don't add any test with both of them being loaded here
it('- should load components in the correct order (require)', function () {
assert.deepStrictEqual(getIds(['c']), ['a', 'c']);
});
it('- should load components in the correct order (modify)', function () {
assert.deepStrictEqual(getIds(['e', 'a']), ['a', 'e']);
});
it('- should load components in the correct order (optional)', function () {
assert.deepStrictEqual(getIds(['c', 'b'], ['a']), ['b', 'c']);
});
it('- should load components in the correct order (require + optional)', function () {
assert.deepStrictEqual(getIds(['d'], ['a']), ['b', 'c', 'd']);
});
it('- should load components in the correct order (require + modify + optional)', function () {
assert.deepStrictEqual(getIds(['d', 'e'], ['b']), ['a', 'e', 'c', 'd']);
});
});
describe('Aliases', function () {
it('- should resolve aliases in the list of components to load', function () {
assert.sameMembers(getIds(['xyz']), ['a', 'b', 'c', 'd']);
});
it('- should resolve aliases in the list of loaded components', function () {
assert.sameMembers(getIds(['d'], ['a', 'a2', 'b2']), ['c', 'd']);
});
it('- should throw on duplicate aliases', function () {
assert.throws(() => {
/** @type {import("../dependencies").Components} */
const circular = {
languages: {
a: {
alias: 'c'
},
b: {
alias: 'c'
}
}
};
getLoader(circular, ['a', 'foo' /* force the lazy alias resolver */]).getIds();
});
});
it('- should throw on aliases which are components', function () {
assert.throws(() => {
/** @type {import("../dependencies").Components} */
const circular = {
languages: {
a: {
alias: 'b'
},
b: 'B'
}
};
getLoader(circular, ['a', 'foo' /* force the lazy alias resolver */]).getIds();
});
});
});
describe('Circular dependencies', function () {
it('- should throw on circular dependencies', function () {
assert.throws(() => {
/** @type {import("../dependencies").Components} */
const circular = {
languages: {
a: {
require: 'b'
},
b: {
optional: 'a'
}
}
};
getLoader(circular, ['a']).getIds();
});
});
});
describe('Async loading', function () {
it('- should load components in the correct order', async function () {
/** @type {import("../dependencies").Components} */
const localComponents = {
languages: {
'a': {},
'b': {
require: 'a'
},
'c': {
require: 'b'
}
}
};
/** @type {string[]} */
const actualLoadOrder = [];
/** @type {string[]} */
const actualResolveOrder = [];
/**
*
* @param {string} id
* @returns {Promise<void>}
*/
function loadComp(id) {
actualLoadOrder.push(id);
// the idea is that the components which have to be loaded first, take the longest, so if all were to
// start getting loaded at the same time, their order would be the reverse of the expected order.
let delay;
if (id === 'a') {
delay = 30;
} else if (id === 'b') {
delay = 20;
} else if (id === 'c') {
delay = 10;
}
return new Promise((resolve) => {
setTimeout(() => {
actualResolveOrder.push(id);
resolve();
}, delay);
});
}
const loader = getLoader(localComponents, ['c']);
await loader.load(id => loadComp(id), {
series: async (before, after) => {
await before;
await after();
},
parallel: async (values) => {
await Promise.all(values);
}
});
assert.deepStrictEqual(actualLoadOrder, ['a', 'b', 'c'], 'actualLoadOrder:');
assert.deepStrictEqual(actualResolveOrder, ['a', 'b', 'c'], 'actualResolveOrder:');
});
});
});
describe('components.json', function () {
/**
* @param {T | T[] | undefined | null} value
* @returns {T[]}
* @template T
*/
function toArray(value) {
if (Array.isArray(value)) {
return value;
} else if (value == undefined) {
return [];
} else {
return [value];
}
}
/**
* @param {(entry: import("../dependencies").ComponentEntry, id: string, entries: Object<string, import("../dependencies").ComponentEntry>) => void} consumeFn
*/
function forEachEntry(consumeFn) {
/** @type {Object<string, import("../dependencies").ComponentEntry>} */
const entries = {};
for (const category in components) {
for (const id in components[category]) {
const entry = components[category][id];
if (id !== 'meta' && entry && typeof entry === 'object') {
entries[id] = entry;
}
}
}
for (const id in entries) {
consumeFn(entries[id], id, entries);
}
}
const entryProperties = [
'title',
'description',
'alias',
'aliasTitles',
'owner',
'require',
'optional',
'modify',
'noCSS',
'option'
];
it('- should be valid', function () {
try {
const allIds = [];
for (const category in components) {
Object.keys(components[category]).forEach(id => allIds.push(id));
}
// and an alias, so we force the lazy alias resolver to check all aliases
allIds.push('js');
getLoader(components, allIds).getIds();
} catch (error) {
assert.fail(error.toString());
}
});
it('- should not have redundant optional dependencies', function () {
forEachEntry((entry, id) => {
const optional = new Set(toArray(entry.optional));
for (const modifyId of toArray(entry.modify)) {
if (optional.has(modifyId)) {
assert.fail(`The component "${id}" has declared "${modifyId}" as both optional and modify.`);
}
}
for (const requireId of toArray(entry.require)) {
if (optional.has(requireId)) {
assert.fail(`The component "${id}" has declared "${requireId}" as both optional and require.`);
}
}
});
});
it('- should have a sorted language list', function () {
const ignore = new Set(['meta', 'markup', 'css', 'clike', 'javascript']);
/** @type {{ id: string, title: string }[]} */
const languages = Object.keys(components.languages).filter(key => !ignore.has(key)).map(key => {
return {
id: key,
title: components.languages[key].title
};
});
/**
* Transforms the given title into an intermediate representation to allowed for sensible comparisons
* between titles.
*
* @param {string} title
*/
function transformTitle(title) {
return title.replace(/\W+/g, '').replace(/^\d+/, '').toLowerCase();
}
const sorted = [...languages].sort((a, b) => {
const comp = transformTitle(a.title).localeCompare(transformTitle(b.title));
if (comp !== 0) {
return comp;
}
// a and b have the same intermediate form (e.g. "C" => "C", "C++" => "C", "C#" => "C").
return a.title.toLowerCase().localeCompare(b.title.toLowerCase());
});
assert.sameOrderedMembers(languages, sorted);
});
it('- should not have single-element or empty arrays', function () {
/** @type {keyof import("../dependencies").ComponentEntry} */
const properties = ['alias', 'optional', 'require', 'modify'];
forEachEntry((entry, id) => {
for (const prop of properties) {
const value = entry[prop];
if (Array.isArray(value)) {
if (value.length === 0) {
assert.fail(
`The component "${id}" defines an empty array for "${prop}".` +
` Please remove the "${prop}" property.`
);
} else if (value.length === 1) {
assert.fail(
`The component "${id}" defines a single-empty array for "${prop}".` +
` Please replace the array with its element.` +
`\n\t${JSON.stringify(prop)}: ${JSON.stringify(value[0])}`
);
}
}
}
});
});
it('- should only have alias titles for valid aliases', function () {
forEachEntry((entry, id) => {
const title = entry.title;
const alias = toArray(entry.alias);
const aliasTitles = entry.aliasTitles;
for (const key in aliasTitles) {
if (alias.indexOf(key) === -1) {
assert.fail(
`Component "${id}":` +
` The alias ${JSON.stringify(key)} in "aliasTitles" is not defined in "alias".`
);
}
if (aliasTitles[key] === title) {
assert.fail(
`Component "${id}":` +
` The alias title for ${JSON.stringify(key)} is the same as the normal title.` +
` Remove the alias title or choose a different alias title.`
);
}
}
});
});
it('- should not have unknown properties', function () {
const knownProperties = new Set(entryProperties);
forEachEntry((entry, id) => {
for (const prop in entry) {
if (!knownProperties.has(prop)) {
assert.fail(
`Component "${id}":` +
` The property ${JSON.stringify(prop)} is not supported by Prism.`
);
}
}
});
});
});