langium
Version:
A language engineering tool for the Language Server Protocol
99 lines • 3.93 kB
JavaScript
/******************************************************************************
* Copyright 2021 TypeFox GmbH
* This program and the accompanying materials are made available under the
* terms of the MIT License, which is available in the project root.
******************************************************************************/
import { CancellationToken, CancellationTokenSource } from '../utils/cancellation.js';
/**
* Delays the execution of the current code to the next tick of the event loop.
* Don't call this method directly in a tight loop to prevent too many promises from being created.
*/
export function delayNextTick() {
return new Promise(resolve => {
// In case we are running in a non-node environment, `setImmediate` isn't available.
// Using `setTimeout` of the browser API accomplishes the same result.
if (typeof setImmediate === 'undefined') {
setTimeout(resolve, 0);
}
else {
setImmediate(resolve);
}
});
}
let lastTick = 0;
let globalInterruptionPeriod = 10;
/**
* Reset the global interruption period and create a cancellation token source.
*/
export function startCancelableOperation() {
lastTick = performance.now();
return new CancellationTokenSource();
}
/**
* Change the period duration for `interruptAndCheck` to the given number of milliseconds.
* The default value is 10ms.
*/
export function setInterruptionPeriod(period) {
globalInterruptionPeriod = period;
}
/**
* This symbol may be thrown in an asynchronous context by any Langium service that receives
* a `CancellationToken`. This means that the promise returned by such a service is rejected with
* this symbol as rejection reason.
*/
export const OperationCancelled = Symbol('OperationCancelled');
/**
* Use this in a `catch` block to check whether the thrown object indicates that the operation
* has been cancelled.
*/
export function isOperationCancelled(err) {
return err === OperationCancelled;
}
/**
* This function does two things:
* 1. Check the elapsed time since the last call to this function or to `startCancelableOperation`. If the predefined
* period (configured with `setInterruptionPeriod`) is exceeded, execution is delayed with `delayNextTick`.
* 2. If the predefined period is not met yet or execution is resumed after an interruption, the given cancellation
* token is checked, and if cancellation is requested, `OperationCanceled` is thrown.
*
* All services in Langium that receive a `CancellationToken` may potentially call this function, so the
* `CancellationToken` must be caught (with an `async` try-catch block or a `catch` callback attached to
* the promise) to avoid that event being exposed as an error.
*/
export async function interruptAndCheck(token) {
if (token === CancellationToken.None) {
// Early exit in case cancellation was disabled by the caller
return;
}
const current = performance.now();
if (current - lastTick >= globalInterruptionPeriod) {
lastTick = current;
await delayNextTick();
// prevent calling delayNextTick every iteration of loop
// where delayNextTick takes up the majority or all of the
// globalInterruptionPeriod itself
lastTick = performance.now();
}
if (token.isCancellationRequested) {
throw OperationCancelled;
}
}
/**
* Simple implementation of the deferred pattern.
* An object that exposes a promise and functions to resolve and reject it.
*/
export class Deferred {
constructor() {
this.promise = new Promise((resolve, reject) => {
this.resolve = (arg) => {
resolve(arg);
return this;
};
this.reject = (err) => {
reject(err);
return this;
};
});
}
}
//# sourceMappingURL=promise-utils.js.map