brighterscript 0.68.4 → 0.69.0

package/dist/lsp/ActionQueue.d.ts

@@ -0,0 +1,35 @@
+import type { CancellationToken } from 'vscode-languageserver-protocol';
+export declare class ActionQueue {
+    constructor(options?: ActionQueueOptions);
+    options: ActionQueueOptions;
+    private queue;
+    /**
+     * Run an action. This will run after all previous actions have completed
+     * @param action action to be run
+     */
+    run<T = any>(action: Action<T>, data?: T): Promise<void>;
+    private isRunning;
+    /**
+     * Process the next pending action. Safe to call even if another action is running, we will only run one action at a time
+     */
+    private process;
+    private stringifyJson;
+    get isIdle(): boolean;
+    /**
+     * Get a promise that resolves when the queue is empty
+     */
+    onIdle(): Promise<void>;
+    once(eventname: 'idle'): Promise<void>;
+    on(eventName: 'idle', handler: () => any): any;
+    private emit;
+    private emitter;
+    dispose(): void;
+}
+export declare type Action<T = any> = (data: T, cancellationToken?: CancellationToken) => any;
+export interface ActionQueueOptions {
+    /**
+     * Max milliseconds an individual action may run before it's cancelled. This is the amount of time the action actually runs,
+     * and does not count the time it waits in the queue
+     */
+    maxActionDuration: number;
+}

package/dist/lsp/ActionQueue.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionQueue = void 0;
+const vscode_languageserver_protocol_1 = require("vscode-languageserver-protocol");
+const deferred_1 = require("../deferred");
+const safeJsonStringify = require("safe-json-stringify");
+const eventemitter3_1 = require("eventemitter3");
+const util_1 = require("../util");
+class ActionQueue {
+    constructor(options) {
+        var _a;
+        var _b;
+        this.queue = [];
+        this.isRunning = false;
+        this.emitter = new eventemitter3_1.EventEmitter();
+        this.options = options !== null && options !== void 0 ? options : {};
+        (_a = (_b = this.options).maxActionDuration) !== null && _a !== void 0 ? _a : (_b.maxActionDuration = 2147483647);
+    }
+    /**
+     * Run an action. This will run after all previous actions have completed
+     * @param action action to be run
+     */
+    run(action, data) {
+        const deferred = new deferred_1.Deferred();
+        this.queue.push({
+            action: action,
+            data: data,
+            deferred: deferred
+        });
+        void this.process();
+        return deferred.promise;
+    }
+    /**
+     * Process the next pending action. Safe to call even if another action is running, we will only run one action at a time
+     */
+    async process() {
+        if (this.isRunning) {
+            return;
+        }
+        if (this.queue.length === 0) {
+            this.emit('idle');
+            return;
+        }
+        this.isRunning = true;
+        //run the action and resolve the deferred if it succeeds
+        const queueItem = this.queue.shift();
+        const cancellationTokenSource = new vscode_languageserver_protocol_1.CancellationTokenSource();
+        //process the action next tick to allow the event loop to catch up
+        let actionPromise = Promise.resolve().then(() => {
+            return queueItem.action(queueItem.data, cancellationTokenSource.token);
+        }).then((result) => {
+            queueItem.deferred.resolve(result);
+        });
+        //register a timeout that will reject if the action takes too long
+        let timeoutId;
+        const timeoutPromise = new Promise((resolve, reject) => {
+            timeoutId = setTimeout(() => {
+                cancellationTokenSource.cancel();
+                reject(new Error(`Action took longer than ${this.options.maxActionDuration}ms to complete. Data: ${this.stringifyJson(queueItem.data)}`));
+            }, this.options.maxActionDuration);
+        });
+        //wait for the action to finish or the timeout to trigger
+        await Promise.race([timeoutPromise, actionPromise]).catch((error) => {
+            //if we have an error, reject the deferred
+            queueItem.deferred.tryReject(error);
+        });
+        clearTimeout(timeoutId);
+        //small delay to allow the event loop to catch up
+        await util_1.default.sleep(1);
+        this.isRunning = false;
+        //at this point, we've properly handled the action, so try and handle the next one
+        await this.process();
+    }
+    stringifyJson(data) {
+        return safeJsonStringify(data, (_, value) => {
+            return typeof value === 'bigint' ? value.toString() : value;
+        });
+    }
+    get isIdle() {
+        return this.queue.length === 0 && !this.isRunning;
+    }
+    /**
+     * Get a promise that resolves when the queue is empty
+     */
+    onIdle() {
+        if (!this.isIdle) {
+            return this.once('idle');
+        }
+        return Promise.resolve();
+    }
+    once(eventName) {
+        return new Promise((resolve) => {
+            const disconnect = this.on(eventName, (...args) => {
+                disconnect();
+                resolve(args);
+            });
+        });
+    }
+    on(eventName, handler) {
+        this.emitter.on(eventName, handler);
+        return () => {
+            this.emitter.removeListener(eventName, handler);
+        };
+    }
+    async emit(eventName, data) {
+        //emit these events on next tick, otherwise they will be processed immediately which could cause issues
+        await util_1.default.sleep(0);
+        this.emitter.emit(eventName, data);
+    }
+    dispose() {
+        this.emitter.removeAllListeners();
+    }
+}
+exports.ActionQueue = ActionQueue;
+//# sourceMappingURL=ActionQueue.js.map

package/dist/lsp/ActionQueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionQueue.js","sourceRoot":"","sources":["../../src/lsp/ActionQueue.ts"],"names":[],"mappings":";;;AACA,mFAAyE;AACzE,0CAAuC;AACvC,yDAAyD;AACzD,iDAA6C;AAC7C,kCAA2B;AAE3B,MAAa,WAAW;IAEpB,YACI,OAA4B;;;QAQxB,UAAK,GAcR,EAAE,CAAC;QAiBA,cAAS,GAAG,KAAK,CAAC;QAqGlB,YAAO,GAAG,IAAI,4BAAY,EAAE,CAAC;QA1IjC,IAAI,CAAC,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAS,CAAC;QACpC,YAAA,IAAI,CAAC,OAAO,EAAC,iBAAiB,uCAAjB,iBAAiB,GAAK,UAAa,EAAC;IACrD,CAAC;IAoBD;;;OAGG;IACI,GAAG,CAAU,MAAiB,EAAE,IAAQ;QAC3C,MAAM,QAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAChC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YACZ,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,QAAQ,EAAE,QAAQ;SACrB,CAAC,CAAC;QACH,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,QAAQ,CAAC,OAAO,CAAC;IAC5B,CAAC;IAID;;OAEG;IACK,KAAK,CAAC,OAAO;QACjB,IAAI,IAAI,CAAC,SAAS,EAAE;YAChB,OAAO;SACV;QACD,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACzB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAClB,OAAO;SACV;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,wDAAwD;QACxD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACrC,MAAM,uBAAuB,GAAG,IAAI,wDAAuB,EAAE,CAAC;QAE9D,kEAAkE;QAClE,IAAI,aAAa,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;YAC5C,OAAO,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,uBAAuB,CAAC,KAAK,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,kEAAkE;QAClE,IAAI,SAAyB,CAAC;QAC9B,MAAM,cAAc,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnD,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;gBACxB,uBAAuB,CAAC,MAAM,EAAE,CAAC;gBACjC,MAAM,CACF,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,OAAO,CAAC,iBAAiB,yBAAyB,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CACpI,CAAC;YACN,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,yDAAyD;QACzD,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAChE,0CAA0C;YAC1C,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,YAAY,CAAC,SAAS,CAAC,CAAC;QAExB,iDAAiD;QACjD,MAAM,cAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAEpB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QAEvB,kFAAkF;QAClF,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC;IAEO,aAAa,CAAC,IAAS;QAC3B,OAAO,iBAAiB,CACpB,IAAI,EACJ,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;YACT,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAChE,CAAC,CACJ,CAAC;IACN,CAAC;IAED,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,MAAM;QACT,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACd,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC5B;QACD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAGM,IAAI,CAAC,SAAiB;QACzB,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,EAAE;YAChC,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,SAA6C,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;gBAClF,UAAU,EAAE,CAAC;gBACb,OAAO,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAGM,EAAE,CAAC,SAAiB,EAAE,OAA8B;QACvD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,OAAc,CAAC,CAAC;QAC3C,OAAO,GAAG,EAAE;YACR,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,EAAE,OAAc,CAAC,CAAC;QAC3D,CAAC,CAAC;IACN,CAAC;IAGO,KAAK,CAAC,IAAI,CAAC,SAAiB,EAAE,IAAU;QAC5C,uGAAuG;QACvG,MAAM,cAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAGM,OAAO;QACV,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC;IACtC,CAAC;CACJ;AApJD,kCAoJC"}

package/dist/lsp/ActionQueue.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lsp/ActionQueue.spec.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const ActionQueue_1 = require("./ActionQueue");
+const util_1 = require("../util");
+const deferred_1 = require("../deferred");
+const testHelpers_spec_1 = require("../testHelpers.spec");
+describe('ActionQueue', () => {
+    let queue;
+    beforeEach(() => {
+        queue = new ActionQueue_1.ActionQueue();
+    });
+    it('runs successful actions in sequence', async () => {
+        let results = [];
+        void queue.run(() => {
+            results.push(1);
+        });
+        await queue.run(() => {
+            results.push(2);
+        });
+        (0, chai_1.expect)(results).to.eql([1, 2]);
+    });
+    it('runs actions after a failed action', async () => {
+        let results = [];
+        void queue.run(() => {
+            results.push(1);
+        });
+        void queue.run(() => {
+            throw new Error('Crash');
+        });
+        await queue.run(() => {
+            results.push(3);
+        });
+        (0, chai_1.expect)(results).to.eql([1, 3]);
+    });
+    it('properly serializes bigInt', async () => {
+        queue = new ActionQueue_1.ActionQueue({
+            maxActionDuration: 1
+        });
+        await (0, testHelpers_spec_1.expectThrowsAsync)(async () => {
+            await queue.run(async () => {
+                await util_1.default.sleep(10);
+            }, BigInt(1));
+        }, 'Action took longer than 1ms to complete. Data: "1"');
+    });
+    it('rejects action that took too long, and marks cancellationToken accordingly', async () => {
+        queue = new ActionQueue_1.ActionQueue({
+            maxActionDuration: 100
+        });
+        let cancellationToken;
+        let results = [];
+        let task1Deferred = new deferred_1.Deferred();
+        let task1Promise = queue.run(async (data, token) => {
+            await util_1.default.sleep(200);
+            cancellationToken = token;
+            if (!cancellationToken.isCancellationRequested) {
+                results.push(1);
+            }
+            task1Deferred.resolve();
+        });
+        await queue.run(() => {
+            results.push(2);
+        });
+        (0, chai_1.expect)(results).to.eql([2]);
+        //wait for task 1's promise to finish and verify we get an error
+        let error;
+        try {
+            await task1Promise;
+        }
+        catch (e) {
+            error = e;
+        }
+        (0, chai_1.expect)(error === null || error === void 0 ? void 0 : error.message).to.eql('Action took longer than 100ms to complete. Data: undefined');
+        //now wait for task1's work to actually finish
+        await task1Deferred.promise;
+        //the token should be marked as cancelled
+        (0, chai_1.expect)(cancellationToken.isCancellationRequested).to.be.true;
+    });
+});
+//# sourceMappingURL=ActionQueue.spec.js.map

package/dist/lsp/ActionQueue.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionQueue.spec.js","sourceRoot":"","sources":["../../src/lsp/ActionQueue.spec.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAC9B,+CAA4C;AAC5C,kCAA2B;AAC3B,0CAAuC;AACvC,0DAAwD;AAGxD,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IACzB,IAAI,KAAkB,CAAC;IAEvB,UAAU,CAAC,GAAG,EAAE;QACZ,KAAK,GAAG,IAAI,yBAAW,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACjD,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,KAAK,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;YAChB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;YACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAChD,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,KAAK,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;YAChB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,KAAK,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QACH,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;YACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QACxC,KAAK,GAAG,IAAI,yBAAW,CAAC;YACpB,iBAAiB,EAAE,CAAC;SACvB,CAAC,CAAC;QACH,MAAM,IAAA,oCAAiB,EAAC,KAAK,IAAI,EAAE;YAC/B,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;gBACvB,MAAM,cAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACzB,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC,EAAE,oDAAoD,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE,KAAK,IAAI,EAAE;QACxF,KAAK,GAAG,IAAI,yBAAW,CAAC;YACpB,iBAAiB,EAAE,GAAG;SACzB,CAAC,CAAC;QACH,IAAI,iBAAoC,CAAC;QACzC,IAAI,OAAO,GAAG,EAAE,CAAC;QAEjB,IAAI,aAAa,GAAG,IAAI,mBAAQ,EAAE,CAAC;QACnC,IAAI,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;YAC/C,MAAM,cAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACtB,iBAAiB,GAAG,KAAK,CAAC;YAC1B,IAAI,CAAC,iBAAiB,CAAC,uBAAuB,EAAE;gBAC5C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACnB;YACD,aAAa,CAAC,OAAO,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;YACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5B,gEAAgE;QAChE,IAAI,KAAK,CAAC;QACV,IAAI;YACA,MAAM,YAAY,CAAC;SACtB;QAAC,OAAO,CAAC,EAAE;YACR,KAAK,GAAG,CAAC,CAAC;SACb;QACD,IAAA,aAAM,EAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,4DAA4D,CAAC,CAAC;QAC5F,8CAA8C;QAC9C,MAAM,aAAa,CAAC,OAAO,CAAC;QAC5B,yCAAyC;QACzC,IAAA,aAAM,EAAC,iBAAiB,CAAC,uBAAuB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IACjE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/lsp/DocumentManager.d.ts

@@ -0,0 +1,63 @@
+import type { MaybePromise } from '../interfaces';
+/**
+ * Maintains a queued/buffered list of file operations. These operations don't actually do anything on their own.
+ * You need to call the .apply() function and provide an action to operate on them.
+ */
+export declare class DocumentManager {
+    private options;
+    constructor(options: {
+        delay: number;
+        flushHandler?: (event: FlushEvent) => any;
+    });
+    private queue;
+    private timeoutHandle;
+    private throttle;
+    /**
+     * Add/set the contents of a file
+     */
+    set(options: {
+        srcPath: string;
+        fileContents?: string;
+        allowStandaloneProject?: boolean;
+    }): void;
+    /**
+     * Delete a file or directory. If a directory is provided, all pending changes within that directory will be discarded
+     * and only the delete action will be queued
+     */
+    delete(srcPath: string): void;
+    private isFlushRunning;
+    private flush;
+    /**
+     * Is the manager settled (i.e. no pending files, all files have been fully flushed)
+     */
+    get isIdle(): boolean;
+    /**
+     * Returns a promise that resolves when there are no pending files and no active flushes are running. Will immediately resolve if there are no files,
+     * and will wait until files are flushed if there are files.
+     */
+    onIdle(): Promise<void>;
+    once(eventName: 'flush'): Promise<FlushEvent>;
+    on(eventName: 'flush', handler: (data: any) => MaybePromise<void>): any;
+    private emitSync;
+    private emitter;
+    dispose(): void;
+}
+export interface SetDocumentAction {
+    srcPath: string;
+    type: 'set';
+    allowStandaloneProject?: boolean;
+    fileContents: string;
+}
+export interface DeleteDocumentAction {
+    srcPath: string;
+    type: 'delete';
+    allowStandaloneProject?: boolean;
+}
+export declare type DocumentAction = SetDocumentAction | DeleteDocumentAction;
+export declare type DocumentActionWithStatus = DocumentAction & {
+    id: number;
+    status: 'accepted' | 'rejected';
+};
+export interface FlushEvent {
+    actions: DocumentAction[];
+}

package/dist/lsp/DocumentManager.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentManager = void 0;
+const EventEmitter = require("eventemitter3");
+const util_1 = require("../util");
+/**
+ * Maintains a queued/buffered list of file operations. These operations don't actually do anything on their own.
+ * You need to call the .apply() function and provide an action to operate on them.
+ */
+class DocumentManager {
+    constructor(options) {
+        this.options = options;
+        this.queue = new Map();
+        this.isFlushRunning = false;
+        this.emitter = new EventEmitter();
+    }
+    throttle() {
+        if (this.timeoutHandle) {
+            clearTimeout(this.timeoutHandle);
+        }
+        this.timeoutHandle = setTimeout(() => {
+            void this.flush();
+        }, this.options.delay);
+    }
+    /**
+     * Add/set the contents of a file
+     */
+    set(options) {
+        var _a;
+        const srcPath = util_1.default.standardizePath(options.srcPath);
+        if (this.queue.has(srcPath)) {
+            this.queue.delete(srcPath);
+        }
+        this.queue.set(srcPath, {
+            type: 'set',
+            srcPath: srcPath,
+            fileContents: options.fileContents,
+            allowStandaloneProject: (_a = options.allowStandaloneProject) !== null && _a !== void 0 ? _a : false
+        });
+        //schedule a future flush
+        this.throttle();
+    }
+    /**
+     * Delete a file or directory. If a directory is provided, all pending changes within that directory will be discarded
+     * and only the delete action will be queued
+     */
+    delete(srcPath) {
+        srcPath = util_1.default.standardizePath(srcPath);
+        //remove any pending action with this exact path
+        this.queue.delete(srcPath);
+        //we can't tell if this a directory, so just remove all pending changes for files that start with this path
+        for (const key of this.queue.keys()) {
+            if (key.startsWith(srcPath)) {
+                this.queue.delete(key);
+            }
+        }
+        //register this delete
+        this.queue.set(srcPath, { type: 'delete', srcPath: srcPath });
+        //schedule a future flush
+        this.throttle();
+    }
+    async flush() {
+        var _a, _b;
+        //if we're already running a flush, don't run another
+        if (this.isFlushRunning) {
+            return;
+        }
+        this.isFlushRunning = true;
+        while (this.queue.size > 0) {
+            try {
+                const event = {
+                    actions: [...this.queue.values()]
+                };
+                this.queue.clear();
+                await ((_b = (_a = this.options).flushHandler) === null || _b === void 0 ? void 0 : _b.call(_a, event));
+            }
+            catch (e) {
+                console.error(e);
+            }
+        }
+        this.emitSync('flush');
+        this.isFlushRunning = false;
+    }
+    /**
+     * Is the manager settled (i.e. no pending files, all files have been fully flushed)
+     */
+    get isIdle() {
+        return this.queue.size === 0 && this.isFlushRunning === false;
+    }
+    /**
+     * Returns a promise that resolves when there are no pending files and no active flushes are running. Will immediately resolve if there are no files,
+     * and will wait until files are flushed if there are files.
+     */
+    async onIdle() {
+        while (!this.isIdle) {
+            await this.once('flush');
+        }
+    }
+    once(eventName) {
+        return new Promise((resolve) => {
+            const off = this.on(eventName, (data) => {
+                off();
+                resolve(data);
+            });
+        });
+    }
+    on(eventName, handler) {
+        this.emitter.on(eventName, handler);
+        return () => {
+            this.emitter.removeListener(eventName, handler);
+        };
+    }
+    emitSync(eventName, data) {
+        this.emitter.emit(eventName, data);
+    }
+    dispose() {
+        this.queue = new Map();
+        this.emitter.removeAllListeners();
+    }
+}
+exports.DocumentManager = DocumentManager;
+//# sourceMappingURL=DocumentManager.js.map

package/dist/lsp/DocumentManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocumentManager.js","sourceRoot":"","sources":["../../src/lsp/DocumentManager.ts"],"names":[],"mappings":";;;AAAA,8CAA8C;AAE9C,kCAA2B;AAE3B;;;GAGG;AACH,MAAa,eAAe;IAExB,YACY,OAGP;QAHO,YAAO,GAAP,OAAO,CAGd;QAGG,UAAK,GAAG,IAAI,GAAG,EAA0B,CAAC;QAmD1C,mBAAc,GAAG,KAAK,CAAC;QAgEvB,YAAO,GAAG,IAAI,YAAY,EAAE,CAAC;IArHrC,CAAC;IAKO,QAAQ;QACZ,IAAI,IAAI,CAAC,aAAa,EAAE;YACpB,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACpC;QACD,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,GAAG,EAAE;YACjC,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;QACtB,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,OAAqF;;QAC5F,MAAM,OAAO,GAAG,cAAI,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtD,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YACzB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;SAC9B;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE;YACpB,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,OAAO;YAChB,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,sBAAsB,EAAE,MAAA,OAAO,CAAC,sBAAsB,mCAAI,KAAK;SAClE,CAAC,CAAC;QACH,yBAAyB;QACzB,IAAI,CAAC,QAAQ,EAAE,CAAC;IACpB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,OAAe;QACzB,OAAO,GAAG,cAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACxC,gDAAgD;QAChD,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC3B,2GAA2G;QAC3G,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE;YACjC,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;gBACzB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aAC1B;SACJ;QACD,sBAAsB;QACtB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAE9D,yBAAyB;QACzB,IAAI,CAAC,QAAQ,EAAE,CAAC;IACpB,CAAC;IAIO,KAAK,CAAC,KAAK;;QACf,qDAAqD;QACrD,IAAI,IAAI,CAAC,cAAc,EAAE;YACrB,OAAO;SACV;QAED,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE;YACxB,IAAI;gBACA,MAAM,KAAK,GAAe;oBACtB,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;iBACpC,CAAC;gBACF,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;gBACnB,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,OAAO,EAAC,YAAY,mDAAG,KAAK,CAAC,CAAA,CAAC;aAC5C;YAAC,OAAO,CAAC,EAAE;gBACR,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;aACpB;SACJ;QACD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACvB,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC;IAClE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM;QACf,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE;YACjB,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC5B;IACL,CAAC;IAGM,IAAI,CAAC,SAAiB;QACzB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,SAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;gBAC3C,GAAG,EAAE,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAGM,EAAE,CAAC,SAAiB,EAAE,OAA+C;QACxE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,OAAc,CAAC,CAAC;QAC3C,OAAO,GAAG,EAAE;YACR,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,EAAE,OAAc,CAAC,CAAC;QAC3D,CAAC,CAAC;IACN,CAAC;IAGO,QAAQ,CAAC,SAAiB,EAAE,IAAK;QACrC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAIM,OAAO;QACV,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC;IACtC,CAAC;CACJ;AAlID,0CAkIC"}

package/dist/lsp/DocumentManager.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lsp/DocumentManager.spec.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const util_1 = require("../util");
+const DocumentManager_1 = require("./DocumentManager");
+const testHelpers_spec_1 = require("../testHelpers.spec");
+describe('DocumentManager', () => {
+    let manager;
+    let results = [];
+    beforeEach(() => {
+        results = [];
+        manager = new DocumentManager_1.DocumentManager({
+            delay: 5,
+            flushHandler: (event) => {
+                results.push(...event.actions);
+            }
+        });
+    });
+    it('throttles multiple events', async () => {
+        manager.set({ srcPath: 'alpha', fileContents: 'one' });
+        await util_1.util.sleep(1);
+        manager.set({ srcPath: 'alpha', fileContents: 'two' });
+        await util_1.util.sleep(1);
+        manager.set({ srcPath: 'alpha', fileContents: 'three' });
+        await manager.onIdle();
+        (0, chai_1.expect)(results).to.eql([{
+                type: 'set',
+                srcPath: 'alpha',
+                fileContents: 'three',
+                allowStandaloneProject: false
+            }]);
+    });
+    it('does not lose newly added that arrives during a flush operation', async () => {
+        const srcPath = (0, util_1.standardizePath) `${testHelpers_spec_1.rootDir}/source/main.bs`;
+        let contentsQueue = [
+            'two',
+            'three',
+            'four'
+        ];
+        manager = new DocumentManager_1.DocumentManager({
+            delay: 5,
+            flushHandler: (event) => {
+                //once the flush happens, add NEW data to the queue. this is the data we need to ensure we don't lose
+                if (contentsQueue.length > 0) {
+                    manager.set({ srcPath: srcPath, fileContents: contentsQueue.shift() });
+                }
+                //store the actions
+                results.push(...event.actions);
+            }
+        });
+        manager.set({ srcPath: srcPath, fileContents: 'one' });
+        await manager.onIdle();
+        (0, chai_1.expect)(results.map(x => x.fileContents)).to.eql([
+            'one',
+            'two',
+            'three',
+            'four'
+        ]);
+    });
+    it('any file change delays the first one', async () => {
+        manager.set({ srcPath: 'alpha', fileContents: 'one' });
+        await util_1.util.sleep(1);
+        manager.set({ srcPath: 'beta', fileContents: 'two' });
+        await util_1.util.sleep(1);
+        manager.set({ srcPath: 'alpha', fileContents: 'three' });
+        await util_1.util.sleep(1);
+        manager.set({ srcPath: 'beta', fileContents: 'four' });
+        await util_1.util.sleep(1);
+        await manager.onIdle();
+        (0, chai_1.expect)(results).to.eql([{
+                type: 'set',
+                srcPath: 'alpha',
+                fileContents: 'three',
+                allowStandaloneProject: false
+            }, {
+                type: 'set',
+                srcPath: 'beta',
+                fileContents: 'four',
+                allowStandaloneProject: false
+            }]);
+    });
+    it('keeps the last-in change', async () => {
+        manager.set({ srcPath: 'alpha', fileContents: 'one' });
+        manager.delete('alpha');
+        await manager.onIdle();
+        (0, chai_1.expect)(results).to.eql([{
+                type: 'delete',
+                srcPath: 'alpha'
+            }]);
+        results = [];
+        manager.set({ srcPath: 'alpha', fileContents: 'two' });
+        manager.delete('alpha');
+        manager.set({ srcPath: 'alpha', fileContents: 'three' });
+        await manager.onIdle();
+        (0, chai_1.expect)(results).to.eql([{
+                type: 'set',
+                srcPath: 'alpha',
+                fileContents: 'three',
+                allowStandaloneProject: false
+            }]);
+    });
+});
+//# sourceMappingURL=DocumentManager.spec.js.map

package/dist/lsp/DocumentManager.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocumentManager.spec.js","sourceRoot":"","sources":["../../src/lsp/DocumentManager.spec.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAC9B,kCAAqD;AAErD,uDAAoD;AACpD,0DAA8C;AAE9C,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC7B,IAAI,OAAwB,CAAC;IAC7B,IAAI,OAAO,GAAqB,EAAE,CAAC;IAEnC,UAAU,CAAC,GAAG,EAAE;QACZ,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,GAAG,IAAI,iCAAe,CAAC;YAC1B,KAAK,EAAE,CAAC;YACR,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;gBACpB,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;YACnC,CAAC;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACvC,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QACvD,MAAM,WAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QACvD,MAAM,WAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;QAEzD,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC;QAEvB,IAAA,aAAM,EACF,OAAO,CACV,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;gBACN,IAAI,EAAE,KAAK;gBACX,OAAO,EAAE,OAAO;gBAChB,YAAY,EAAE,OAAO;gBACrB,sBAAsB,EAAE,KAAK;aAChC,CAAC,CAAC,CAAC;IACR,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,OAAO,GAAG,IAAA,sBAAC,EAAA,GAAG,0BAAO,iBAAiB,CAAC;QAE7C,IAAI,aAAa,GAAG;YAChB,KAAK;YACL,OAAO;YACP,MAAM;SACT,CAAC;QACF,OAAO,GAAG,IAAI,iCAAe,CAAC;YAC1B,KAAK,EAAE,CAAC;YACR,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;gBACpB,qGAAqG;gBACrG,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC1B,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,aAAa,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;iBAC1E;gBAED,mBAAmB;gBACnB,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;YACnC,CAAC;SACJ,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QACvD,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC;QACvB,IAAA,aAAM,EAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAE,CAAuB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;YACnE,KAAK;YACL,KAAK;YACL,OAAO;YACP,MAAM;SACT,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QAClD,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QACvD,MAAM,WAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAEpB,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QACtD,MAAM,WAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAEpB,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;QACzD,MAAM,WAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAEpB,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;QACvD,MAAM,WAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAEpB,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC;QAEvB,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;gBACpB,IAAI,EAAE,KAAK;gBACX,OAAO,EAAE,OAAO;gBAChB,YAAY,EAAE,OAAO;gBACrB,sBAAsB,EAAE,KAAK;aAChC,EAAE;gBACC,IAAI,EAAE,KAAK;gBACX,OAAO,EAAE,MAAM;gBACf,YAAY,EAAE,MAAM;gBACpB,sBAAsB,EAAE,KAAK;aAChC,CAAC,CAAC,CAAC;IACR,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACtC,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QACvD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC;QAEvB,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;gBACpB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,OAAO;aACnB,CAAC,CAAC,CAAC;QAEJ,OAAO,GAAG,EAAE,CAAC;QAEb,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;QACvD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACxB,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;QAEzD,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC;QAEvB,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;gBACpB,IAAI,EAAE,KAAK;gBACX,OAAO,EAAE,OAAO;gBAChB,YAAY,EAAE,OAAO;gBACrB,sBAAsB,EAAE,KAAK;aAChC,CAAC,CAAC,CAAC;IACR,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}