All files / semaphore CriticalSection.spec.ts

100% Statements 95/95
100% Branches 0/0
96.08% Functions 49/51
100% Lines 74/74

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 1821x 1x   1x 1x   1x 1x   1x   1x 13x     1x 1x   1x 1x 20x     1x     1x 1x 1x     1x 1x     1x 1x       1x   1x 1x         1x         1x 1x   1x 20x 20x         1x 1x   1x 20x 20x         1x 1x 1x     1x     1x 1x 1x     1x     1x 1x   1x 1x       1x       1x 1x 1x                                                   1x   1x 14x   14x 14x 14x           1x 14x       1x 1x                     1x 13x       1x 1x 1x     1x 1x     1x 1x 1x   1x 1x      
import 'mocha';
import { expect } from 'chai';
 
import { expectInstantly, expectNever, expectTimelyIn } from '../timing.common-spec';
import { ICriticalSection, CriticalSection } from './CriticalSection';
 
describe('CriticalSection', () => {
	const INTENTIONAL_EXCEPTION_MESSAGE = 'Intentional exception';
 
	let criticalSection: ICriticalSection = new CriticalSection();
 
	beforeEach(() => {
		criticalSection = new CriticalSection();
	});
 
	it('Contention', async () => {
		const COUNT = 20;
 
		const actions: Promise<void>[] = [];
		for (let i = 0; i < COUNT; i++) {
			actions.push(criticalSection.do(() => {}));
		}
 
		await expectInstantly(Promise.all(actions));
	});
 
	it('do() must await returned Promise', async () => {
		await expectInstantly(expect(criticalSection.do(() => {
			return Promise.resolve(42);
		})).to.eventually.equal(42));
 
		await expectInstantly(expect(criticalSection.do(async () => {
			return 42;
		})).to.eventually.equal(42));
 
		await expectInstantly(expect(criticalSection.do(async () => {
			return Promise.resolve(42);
		})).to.eventually.equal(42));
	});
 
	it('Endless contention => nobody else may enter', async () => {
		// No await
		criticalSection.do(async () => {
			return new Promise(() => {
				// Never resolve
			});
		});
 
		await expectNever(criticalSection.do(() => {
			// Just implictly return and do nothing
		}));
	});
 
	it('Exceptions lead to rejection of do() promise', async () => {
		const COUNT = 20;
 
		for (let i = 0; i < COUNT; i++) {
			await expect(criticalSection.do(() => {
				throw new Error(INTENTIONAL_EXCEPTION_MESSAGE);
			})).to.eventually.be.rejectedWith(INTENTIONAL_EXCEPTION_MESSAGE);
		}
	});
 
	it('Rejecting promises lead to rejection of do() promise', async () => {
		const COUNT = 20;
 
		for (let i = 0; i < COUNT; i++) {
			await expect(criticalSection.do(async () => {
				return Promise.reject(INTENTIONAL_EXCEPTION_MESSAGE);
			})).to.eventually.be.rejectedWith(INTENTIONAL_EXCEPTION_MESSAGE);
		}
	});
 
	it('Exception in critical section must free it again', async () => {
		await expect(criticalSection.do(() => {
			throw new Error(INTENTIONAL_EXCEPTION_MESSAGE);
		})).to.eventually.be.rejectedWith(INTENTIONAL_EXCEPTION_MESSAGE);
 
		await expectInstantly(criticalSection.do(() => {}));
	});
 
	it('Rejecting promise in critical section must free it again', async () => {
		await expect(criticalSection.do(async () => {
			return Promise.reject(INTENTIONAL_EXCEPTION_MESSAGE);
		})).to.eventually.be.rejectedWith(INTENTIONAL_EXCEPTION_MESSAGE);
 
		await expectInstantly(criticalSection.do(() => {}));
	});
 
	it('Must not be reentrant', async () => {
		const NEVER_TIMEOUT = 100;
 
		await expectTimelyIn(expect(criticalSection.do(async () => {
			await expectNever(criticalSection.do(() => {
				// Do nothing
			}), NEVER_TIMEOUT);
 
			return 42;
		})).to.eventually.equal(42), NEVER_TIMEOUT);
	});
 
	it('CriticalSection.for returns a valid CriticalSection for objects and\
 keeps returning the same on the same objects', async () => {
		const dummyObjects: Object[] = [
			// "Classical" Objects
			{}, [], Number, String,
 
			// More advanced prototypes
			Object.prototype, Number.prototype, String.prototype,
 
			// Functions
			() => {}, setTimeout,
 
			// Property descriptors (shall be equivalent to "normal" objects)
			Object.getOwnPropertyDescriptor(
				Object.defineProperty({}, 'testProp', {
					configurable: false,
					enumerable: false,
					writable: false,
					value: 42
				}),
				'testProp'
			) as PropertyDescriptor,
 
			// The class, its prototype and the sections for them themselves
			CriticalSection, CriticalSection.prototype,
			CriticalSection.for(CriticalSection), CriticalSection.for(CriticalSection.prototype)
		];
 
		const initialCriticalSections: ICriticalSection[] = [];
 
		for (const dummyObject of dummyObjects) {
			const section = CriticalSection.for(dummyObject);
 
			initialCriticalSections.push(section);
			await expectNever(section.do(async () => {
				return new Promise(() => {
					// Do not resolve
				});
			}));
		}
 
		for (let i = 0; i < dummyObjects.length; i++) {
			expect(CriticalSection.for(dummyObjects[i])).to.equal(initialCriticalSections[i]);
		}
	});
 
	it('CriticalSection.for throws on primitive types', async () => {
		const primitiveValues: any[] = [
			// Primitive values as per
			// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures
			true, false,
			null,
			undefined,
			1, 2, 3, 42.5, NaN, Infinity, -Infinity,
			'Hello World!',
			Symbol('a symbol')
		];
 
		for (const primitiveValue of primitiveValues) {
			expect(() => CriticalSection.for(primitiveValue)).to.throw(TypeError);
		}
	});
 
	it('CriticalSection.for returns distinct CriticalSections for multiple {}, []', () => {
		expect(CriticalSection.for({})).to.not.equal(CriticalSection.for({}));
		expect(CriticalSection.for([])).to.not.equal(CriticalSection.for([]));
	});
 
	it('CriticalSection.for returns identical CriticalSections for the same object', () => {
		expect(CriticalSection.for(Object.prototype)).to.not.equal(CriticalSection.for([]));
	});
 
	it('CriticalSection.for returns distinct CriticalSections on the prototype chain', () => {
		const prototypeObj = {};
		expect(CriticalSection.for(prototypeObj)).to.be.instanceof(CriticalSection);
 
		const obj = Object.create(prototypeObj);
		expect(CriticalSection.for(obj)).to.not.equal(CriticalSection.for(prototypeObj));
	});
});