@theia/core 1.45.0 → 1.46.0-next.72

package/lib/common/performance/measurement-protocol.d.ts

@@ -1,65 +1,65 @@
-/********************************************************************************
-* Copyright (c) 2021 STMicroelectronics and others.
-*
-* This program and the accompanying materials are made available under the
-* terms of the Eclipse Public License 2.0 which is available at
-* http://www.eclipse.org/legal/epl-2.0.
-*
-* This Source Code may also be made available under the following Secondary
-* Licenses when the conditions for such availability set forth in the Eclipse
-* Public License v. 2.0 are satisfied: GNU General Public License, version 2
-* with the GNU Classpath Exception which is available at
-* https://www.gnu.org/software/classpath/license.html.
-*
-* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-*******************************************************************************/
-import { Measurement, MeasurementOptions } from './measurement';
-import { Stopwatch } from './stopwatch';
-export declare const BackendStopwatch: unique symbol;
-/** API path of the stopwatch service that exposes the back-end stopwatch to clients. */
-export declare const stopwatchPath = "/services/stopwatch";
-/** Token representing a remote measurement in the {@link BackendStopwatch} protocol. */
-export declare type RemoteMeasurement = number;
-export declare const BackendStopwatchOptions: unique symbol;
-/**
- * A service that exposes the back-end's {@link Stopwatch} to clients
- * via the remote API. If you do not need this service then bind or re-bind
- * the {@link NullBackendStopwatch} implementation to this service interface.
- */
-export interface BackendStopwatch {
-    /**
-     * Create a {@link Measurement} that will compute the time that elapsed on the back-end when logged.
-     *
-     * @param name the {@link Measurement.name measurement name}
-     * @param options optional configuration of the new measurement
-     * @returns a token identifying an unique self-timing measurement relative to the back-end's timeline
-     */
-    start(name: string, options?: MeasurementOptions): Promise<RemoteMeasurement>;
-    /**
-     * Stop a measurement previously {@link start started} and log in the back-end a measurement of
-     * its duration relative to the back-end's timeline.
-     *
-     * @param measurement token identifying a measurement previously {@link start started}
-     * @param message a message to log
-     * @param messageArgs optional arguments to the `message`
-     */
-    stop(measurement: RemoteMeasurement, message: string, messageArgs: any[]): Promise<void>;
-}
-/**
- * Default implementation of the (remote) back-end stopwatch service.
- */
-export declare class DefaultBackendStopwatch {
-    readonly measurements: Map<number, Measurement>;
-    protected idSequence: number;
-    protected readonly stopwatch: Stopwatch;
-    start(name: string, options?: MeasurementOptions): RemoteMeasurement;
-    stop(measurementToken: RemoteMeasurement, message: string, messageArgs: any[]): void;
-}
-/**
- * No-op implementation of the (remote) back-end stopwatch service.
- */
-export declare class NullBackendStopwatch implements BackendStopwatch {
-    start(): Promise<RemoteMeasurement>;
-    stop(): Promise<void>;
-}
+/********************************************************************************
+* Copyright (c) 2021 STMicroelectronics and others.
+*
+* This program and the accompanying materials are made available under the
+* terms of the Eclipse Public License 2.0 which is available at
+* http://www.eclipse.org/legal/epl-2.0.
+*
+* This Source Code may also be made available under the following Secondary
+* Licenses when the conditions for such availability set forth in the Eclipse
+* Public License v. 2.0 are satisfied: GNU General Public License, version 2
+* with the GNU Classpath Exception which is available at
+* https://www.gnu.org/software/classpath/license.html.
+*
+* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+*******************************************************************************/
+import { Measurement, MeasurementOptions } from './measurement';
+import { Stopwatch } from './stopwatch';
+export declare const BackendStopwatch: unique symbol;
+/** API path of the stopwatch service that exposes the back-end stopwatch to clients. */
+export declare const stopwatchPath = "/services/stopwatch";
+/** Token representing a remote measurement in the {@link BackendStopwatch} protocol. */
+export declare type RemoteMeasurement = number;
+export declare const BackendStopwatchOptions: unique symbol;
+/**
+ * A service that exposes the back-end's {@link Stopwatch} to clients
+ * via the remote API. If you do not need this service then bind or re-bind
+ * the {@link NullBackendStopwatch} implementation to this service interface.
+ */
+export interface BackendStopwatch {
+    /**
+     * Create a {@link Measurement} that will compute the time that elapsed on the back-end when logged.
+     *
+     * @param name the {@link Measurement.name measurement name}
+     * @param options optional configuration of the new measurement
+     * @returns a token identifying an unique self-timing measurement relative to the back-end's timeline
+     */
+    start(name: string, options?: MeasurementOptions): Promise<RemoteMeasurement>;
+    /**
+     * Stop a measurement previously {@link start started} and log in the back-end a measurement of
+     * its duration relative to the back-end's timeline.
+     *
+     * @param measurement token identifying a measurement previously {@link start started}
+     * @param message a message to log
+     * @param messageArgs optional arguments to the `message`
+     */
+    stop(measurement: RemoteMeasurement, message: string, messageArgs: any[]): Promise<void>;
+}
+/**
+ * Default implementation of the (remote) back-end stopwatch service.
+ */
+export declare class DefaultBackendStopwatch {
+    readonly measurements: Map<number, Measurement>;
+    protected idSequence: number;
+    protected readonly stopwatch: Stopwatch;
+    start(name: string, options?: MeasurementOptions): RemoteMeasurement;
+    stop(measurementToken: RemoteMeasurement, message: string, messageArgs: any[]): void;
+}
+/**
+ * No-op implementation of the (remote) back-end stopwatch service.
+ */
+export declare class NullBackendStopwatch implements BackendStopwatch {
+    start(): Promise<RemoteMeasurement>;
+    stop(): Promise<void>;
+}
 //# sourceMappingURL=measurement-protocol.d.ts.map

package/lib/common/performance/measurement-protocol.js

@@ -1,79 +1,79 @@
-"use strict";
-/********************************************************************************
-* Copyright (c) 2021 STMicroelectronics and others.
-*
-* This program and the accompanying materials are made available under the
-* terms of the Eclipse Public License 2.0 which is available at
-* http://www.eclipse.org/legal/epl-2.0.
-*
-* This Source Code may also be made available under the following Secondary
-* Licenses when the conditions for such availability set forth in the Eclipse
-* Public License v. 2.0 are satisfied: GNU General Public License, version 2
-* with the GNU Classpath Exception which is available at
-* https://www.gnu.org/software/classpath/license.html.
-*
-* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-*******************************************************************************/
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NullBackendStopwatch = exports.DefaultBackendStopwatch = exports.BackendStopwatchOptions = exports.stopwatchPath = exports.BackendStopwatch = void 0;
-/* eslint-disable @typescript-eslint/no-explicit-any */
-const inversify_1 = require("inversify");
-const stopwatch_1 = require("./stopwatch");
-exports.BackendStopwatch = Symbol('BackendStopwatch');
-/** API path of the stopwatch service that exposes the back-end stopwatch to clients. */
-exports.stopwatchPath = '/services/stopwatch';
-exports.BackendStopwatchOptions = Symbol('BackendStopwatchOptions');
-/**
- * Default implementation of the (remote) back-end stopwatch service.
- */
-let DefaultBackendStopwatch = class DefaultBackendStopwatch {
-    constructor() {
-        this.measurements = new Map();
-        this.idSequence = 0;
-    }
-    start(name, options) {
-        const result = ++this.idSequence;
-        this.measurements.set(result, this.stopwatch.start(name, options));
-        return result;
-    }
-    stop(measurementToken, message, messageArgs) {
-        const measurement = this.measurements.get(measurementToken);
-        if (measurement) {
-            this.measurements.delete(measurementToken);
-            measurement.log(message, ...messageArgs);
-        }
-    }
-};
-__decorate([
-    (0, inversify_1.inject)(stopwatch_1.Stopwatch),
-    __metadata("design:type", stopwatch_1.Stopwatch)
-], DefaultBackendStopwatch.prototype, "stopwatch", void 0);
-DefaultBackendStopwatch = __decorate([
-    (0, inversify_1.injectable)()
-], DefaultBackendStopwatch);
-exports.DefaultBackendStopwatch = DefaultBackendStopwatch;
-/**
- * No-op implementation of the (remote) back-end stopwatch service.
- */
-let NullBackendStopwatch = class NullBackendStopwatch {
-    start() {
-        return Promise.resolve(0);
-    }
-    stop() {
-        return Promise.resolve();
-    }
-};
-NullBackendStopwatch = __decorate([
-    (0, inversify_1.injectable)()
-], NullBackendStopwatch);
-exports.NullBackendStopwatch = NullBackendStopwatch;
+"use strict";
+/********************************************************************************
+* Copyright (c) 2021 STMicroelectronics and others.
+*
+* This program and the accompanying materials are made available under the
+* terms of the Eclipse Public License 2.0 which is available at
+* http://www.eclipse.org/legal/epl-2.0.
+*
+* This Source Code may also be made available under the following Secondary
+* Licenses when the conditions for such availability set forth in the Eclipse
+* Public License v. 2.0 are satisfied: GNU General Public License, version 2
+* with the GNU Classpath Exception which is available at
+* https://www.gnu.org/software/classpath/license.html.
+*
+* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+*******************************************************************************/
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NullBackendStopwatch = exports.DefaultBackendStopwatch = exports.BackendStopwatchOptions = exports.stopwatchPath = exports.BackendStopwatch = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const inversify_1 = require("inversify");
+const stopwatch_1 = require("./stopwatch");
+exports.BackendStopwatch = Symbol('BackendStopwatch');
+/** API path of the stopwatch service that exposes the back-end stopwatch to clients. */
+exports.stopwatchPath = '/services/stopwatch';
+exports.BackendStopwatchOptions = Symbol('BackendStopwatchOptions');
+/**
+ * Default implementation of the (remote) back-end stopwatch service.
+ */
+let DefaultBackendStopwatch = class DefaultBackendStopwatch {
+    constructor() {
+        this.measurements = new Map();
+        this.idSequence = 0;
+    }
+    start(name, options) {
+        const result = ++this.idSequence;
+        this.measurements.set(result, this.stopwatch.start(name, options));
+        return result;
+    }
+    stop(measurementToken, message, messageArgs) {
+        const measurement = this.measurements.get(measurementToken);
+        if (measurement) {
+            this.measurements.delete(measurementToken);
+            measurement.log(message, ...messageArgs);
+        }
+    }
+};
+__decorate([
+    (0, inversify_1.inject)(stopwatch_1.Stopwatch),
+    __metadata("design:type", stopwatch_1.Stopwatch)
+], DefaultBackendStopwatch.prototype, "stopwatch", void 0);
+DefaultBackendStopwatch = __decorate([
+    (0, inversify_1.injectable)()
+], DefaultBackendStopwatch);
+exports.DefaultBackendStopwatch = DefaultBackendStopwatch;
+/**
+ * No-op implementation of the (remote) back-end stopwatch service.
+ */
+let NullBackendStopwatch = class NullBackendStopwatch {
+    start() {
+        return Promise.resolve(0);
+    }
+    stop() {
+        return Promise.resolve();
+    }
+};
+NullBackendStopwatch = __decorate([
+    (0, inversify_1.injectable)()
+], NullBackendStopwatch);
+exports.NullBackendStopwatch = NullBackendStopwatch;
 //# sourceMappingURL=measurement-protocol.js.map

package/lib/common/performance/measurement.d.ts

@@ -1,112 +1,112 @@
-/********************************************************************************
-* Copyright (c) 2021 STMicroelectronics and others.
-*
-* This program and the accompanying materials are made available under the
-* terms of the Eclipse Public License 2.0 which is available at
-* http://www.eclipse.org/legal/epl-2.0.
-*
-* This Source Code may also be made available under the following Secondary
-* Licenses when the conditions for such availability set forth in the Eclipse
-* Public License v. 2.0 are satisfied: GNU General Public License, version 2
-* with the GNU Classpath Exception which is available at
-* https://www.gnu.org/software/classpath/license.html.
-*
-* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-*******************************************************************************/
-import { LogLevel } from '../logger';
-/**
- * A `Measurement` counts the time elapsed between its creation when the {@link Stopwatch}
- * is {@link Stopwatch.start started} and when it is {@link stop stopped}.
- */
-export interface Measurement {
-    /**
-     * Compute the elapsed time, in milliseconds, if not already done (only has effect on the first invocation).
-     * A `NaN` result indicates that the watch was stopped but failed to make a measurement.
-     */
-    stop(): number;
-    /** The measurement name. This may show up in the performance measurement framework appropriate to the application context. */
-    name: string;
-    /**
-     * The elapsed time measured, if it has been {@link stop stopped} and measured, or `NaN` if the platform disabled
-     * performance measurement.
-     */
-    elapsed?: number;
-    /**
-     * Compute the elapsed time and log a message annotated with that timing information.
-     * The message is logged at the level determined by the {@link MeasurementOptions}.
-     *
-     * @param detail a message detailing what activity was measured
-     * @param optionalArgs optional message arguments as per the usual console API
-     */
-    log(detail: string, ...optionalArgs: any[]): void;
-    /**
-     * Compute the elapsed time and log a debug message annotated with that timing information.
-     *
-     * @param detail a message detailing what activity was measured
-     * @param optionalArgs optional message arguments as per the usual console API
-     */
-    debug(detail: string, ...optionalArgs: any[]): void;
-    /**
-     * Compute the elapsed time and log an info message annotated with that timing information.
-     *
-     * @param detail a message detailing what activity was measured
-     * @param optionalArgs optional message arguments as per the usual console API
-     */
-    info(detail: string, ...optionalArgs: any[]): void;
-    /**
-     * Compute the elapsed time and log a warning message annotated with that timing information.
-     *
-     * @param detail a message detailing what activity was measured
-     * @param optionalArgs optional message arguments as per the usual console API
-     */
-    warn(detail: string, ...optionalArgs: any[]): void;
-    /**
-     * Compute the elapsed time and log an error message annotated with that timing information.
-     *
-     * @param detail a message detailing what activity was measured
-     * @param optionalArgs optional message arguments as per the usual console API
-     */
-    error(detail: string, ...optionalArgs: any[]): void;
-}
-/**
- * Optional configuration of a {@link Measurement} specified at the time of its creation.
- */
-export interface MeasurementOptions {
-    /**
-     * A specific context of the application in which an activity was measured.
-     * Results in logs being emitted with a "[<context>]" qualified at the head.
-     */
-    context?: string;
-    /** An optional logging level at which to emit the log message. The default value is {@link LogLevel.INFO}. */
-    defaultLogLevel?: LogLevel;
-    /**
-     * Some measurements are measured against a threshold (in millis) that they should not exceed.
-     * If omitted, the implied threshold is unlimited time (no threshold).
-     *
-     * @see {@link Stopwatch.startAsync}
-     * @see {@link thresholdLogLevel}
-     */
-    thresholdMillis?: number;
-    /**
-     * Flag to indicate whether the stopwatch should store measurement results for later retrieval.
-     * For example the cache can be used to retrieve measurements which were taken during startup before a listener had a chance to register.
-     */
-    storeResults?: boolean;
-}
-/**
- * Captures the result of a {@link Measurement} in a serializable format.
- */
-export interface MeasurementResult {
-    /** The measurement name. This may show up in the performance measurement framework appropriate to the application context. */
-    name: string;
-    /** The time when the measurement recording has been started */
-    startTime: number;
-    /**
-     * The elapsed time measured, if it has been {@link stop stopped} and measured, or `NaN` if the platform disabled
-     * performance measurement.
-     */
-    elapsed: number;
-    /** An optional label for the application the start of which (in real time) is the basis of all measurements. */
-    owner?: string;
-}
+/********************************************************************************
+* Copyright (c) 2021 STMicroelectronics and others.
+*
+* This program and the accompanying materials are made available under the
+* terms of the Eclipse Public License 2.0 which is available at
+* http://www.eclipse.org/legal/epl-2.0.
+*
+* This Source Code may also be made available under the following Secondary
+* Licenses when the conditions for such availability set forth in the Eclipse
+* Public License v. 2.0 are satisfied: GNU General Public License, version 2
+* with the GNU Classpath Exception which is available at
+* https://www.gnu.org/software/classpath/license.html.
+*
+* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+*******************************************************************************/
+import { LogLevel } from '../logger';
+/**
+ * A `Measurement` counts the time elapsed between its creation when the {@link Stopwatch}
+ * is {@link Stopwatch.start started} and when it is {@link stop stopped}.
+ */
+export interface Measurement {
+    /**
+     * Compute the elapsed time, in milliseconds, if not already done (only has effect on the first invocation).
+     * A `NaN` result indicates that the watch was stopped but failed to make a measurement.
+     */
+    stop(): number;
+    /** The measurement name. This may show up in the performance measurement framework appropriate to the application context. */
+    name: string;
+    /**
+     * The elapsed time measured, if it has been {@link stop stopped} and measured, or `NaN` if the platform disabled
+     * performance measurement.
+     */
+    elapsed?: number;
+    /**
+     * Compute the elapsed time and log a message annotated with that timing information.
+     * The message is logged at the level determined by the {@link MeasurementOptions}.
+     *
+     * @param detail a message detailing what activity was measured
+     * @param optionalArgs optional message arguments as per the usual console API
+     */
+    log(detail: string, ...optionalArgs: any[]): void;
+    /**
+     * Compute the elapsed time and log a debug message annotated with that timing information.
+     *
+     * @param detail a message detailing what activity was measured
+     * @param optionalArgs optional message arguments as per the usual console API
+     */
+    debug(detail: string, ...optionalArgs: any[]): void;
+    /**
+     * Compute the elapsed time and log an info message annotated with that timing information.
+     *
+     * @param detail a message detailing what activity was measured
+     * @param optionalArgs optional message arguments as per the usual console API
+     */
+    info(detail: string, ...optionalArgs: any[]): void;
+    /**
+     * Compute the elapsed time and log a warning message annotated with that timing information.
+     *
+     * @param detail a message detailing what activity was measured
+     * @param optionalArgs optional message arguments as per the usual console API
+     */
+    warn(detail: string, ...optionalArgs: any[]): void;
+    /**
+     * Compute the elapsed time and log an error message annotated with that timing information.
+     *
+     * @param detail a message detailing what activity was measured
+     * @param optionalArgs optional message arguments as per the usual console API
+     */
+    error(detail: string, ...optionalArgs: any[]): void;
+}
+/**
+ * Optional configuration of a {@link Measurement} specified at the time of its creation.
+ */
+export interface MeasurementOptions {
+    /**
+     * A specific context of the application in which an activity was measured.
+     * Results in logs being emitted with a "[<context>]" qualified at the head.
+     */
+    context?: string;
+    /** An optional logging level at which to emit the log message. The default value is {@link LogLevel.INFO}. */
+    defaultLogLevel?: LogLevel;
+    /**
+     * Some measurements are measured against a threshold (in millis) that they should not exceed.
+     * If omitted, the implied threshold is unlimited time (no threshold).
+     *
+     * @see {@link Stopwatch.startAsync}
+     * @see {@link thresholdLogLevel}
+     */
+    thresholdMillis?: number;
+    /**
+     * Flag to indicate whether the stopwatch should store measurement results for later retrieval.
+     * For example the cache can be used to retrieve measurements which were taken during startup before a listener had a chance to register.
+     */
+    storeResults?: boolean;
+}
+/**
+ * Captures the result of a {@link Measurement} in a serializable format.
+ */
+export interface MeasurementResult {
+    /** The measurement name. This may show up in the performance measurement framework appropriate to the application context. */
+    name: string;
+    /** The time when the measurement recording has been started */
+    startTime: number;
+    /**
+     * The elapsed time measured, if it has been {@link stop stopped} and measured, or `NaN` if the platform disabled
+     * performance measurement.
+     */
+    elapsed: number;
+    /** An optional label for the application the start of which (in real time) is the basis of all measurements. */
+    owner?: string;
+}
 //# sourceMappingURL=measurement.d.ts.map

package/lib/common/performance/measurement.js

@@ -1,18 +1,18 @@
-"use strict";
-/********************************************************************************
-* Copyright (c) 2021 STMicroelectronics and others.
-*
-* This program and the accompanying materials are made available under the
-* terms of the Eclipse Public License 2.0 which is available at
-* http://www.eclipse.org/legal/epl-2.0.
-*
-* This Source Code may also be made available under the following Secondary
-* Licenses when the conditions for such availability set forth in the Eclipse
-* Public License v. 2.0 are satisfied: GNU General Public License, version 2
-* with the GNU Classpath Exception which is available at
-* https://www.gnu.org/software/classpath/license.html.
-*
-* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-*******************************************************************************/
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/********************************************************************************
+* Copyright (c) 2021 STMicroelectronics and others.
+*
+* This program and the accompanying materials are made available under the
+* terms of the Eclipse Public License 2.0 which is available at
+* http://www.eclipse.org/legal/epl-2.0.
+*
+* This Source Code may also be made available under the following Secondary
+* Licenses when the conditions for such availability set forth in the Eclipse
+* Public License v. 2.0 are satisfied: GNU General Public License, version 2
+* with the GNU Classpath Exception which is available at
+* https://www.gnu.org/software/classpath/license.html.
+*
+* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+*******************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=measurement.js.map