@mablhq/mabl-cli 1.59.6 → 1.61.3

package/browserTestMonitoring/cloudMonitoringPerformanceMetrics.js

@@ -1,249 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CloudMonitoringPerformanceMetrics = exports.DEFAULT_CLOUD_MONITORING_METRICS_EXPORT_PERIOD_MS = void 0;
-const api_1 = __importStar(require("@opentelemetry/api"));
-const resources_1 = require("@opentelemetry/resources");
-const sdk_metrics_1 = require("@opentelemetry/sdk-metrics");
-const opentelemetry_cloud_monitoring_exporter_1 = require("@google-cloud/opentelemetry-cloud-monitoring-exporter");
-const distributions_1 = require("./distributions");
-const DEBUG = false;
-const METRIC_NAME_PREFIX = 'mabl/tests/performance';
-exports.DEFAULT_CLOUD_MONITORING_METRICS_EXPORT_PERIOD_MS = 8000;
-const DEFAULT_METER_PROVIDER_SHUTDOWN_TIMEOUT_MS = 3 * exports.DEFAULT_CLOUD_MONITORING_METRICS_EXPORT_PERIOD_MS + 1000;
-class CloudMonitoringPerformanceMetrics {
-    constructor(projectId, runnerId, cloudMonitoringMetricsExportPeriodMs = exports.DEFAULT_CLOUD_MONITORING_METRICS_EXPORT_PERIOD_MS, meterProviderShutdownTimeoutMs = DEFAULT_METER_PROVIDER_SHUTDOWN_TIMEOUT_MS) {
-        this.projectId = projectId;
-        this.runnerId = runnerId;
-        this.cloudMonitoringMetricsExportPeriodMs = cloudMonitoringMetricsExportPeriodMs;
-        this.meterProviderShutdownTimeoutMs = meterProviderShutdownTimeoutMs;
-        if (DEBUG) {
-            api_1.diag.setLogger(new api_1.DiagConsoleLogger(), api_1.DiagLogLevel.ALL);
-        }
-        this.stepMetricsInstrumentNames = this.generateStepMetricsInstrumentNames();
-        this.testMetricsInstrumentNames = this.generateTestMetricsInstrumentNames();
-        this.meterProvider = this.initializeOpenTelemetry();
-        this.meter = this.meterProvider.getMeter(runnerId);
-        this.step = this.initializeStepMetrics();
-        this.test = this.initializeTestMetrics();
-    }
-    async shutdown() {
-        await this.meterProvider.shutdown({
-            timeoutMillis: this.meterProviderShutdownTimeoutMs,
-        });
-    }
-    generateStepMetricsInstrumentNames() {
-        return {
-            ...this.generateCommonInstrumentNames('step'),
-            firstContentfulPaint: this.generateInstrumentName('step', 'firstContentfulPaint'),
-            largestContentfulPaint: this.generateInstrumentName('step', 'largestContentfulPaint'),
-            cumulativeLayoutShift: this.generateInstrumentName('step', 'cumulativeLayoutShift'),
-            timeToFirstByte: this.generateInstrumentName('step', 'timeToFirstByte'),
-            domContentLoaded: this.generateInstrumentName('step', 'domContentLoaded'),
-        };
-    }
-    generateTestMetricsInstrumentNames() {
-        return {
-            ...this.generateCommonInstrumentNames('test'),
-            executionTime: this.generateInstrumentName('test', 'execution', 'time'),
-            runnerCount: this.generateCountInstrumentName('test', 'runner'),
-            firstContentfulPaintFailCount: this.generateCWVFailCountInstrumentName('test', 'firstContentfulPaint'),
-            largestContentfulPaintFailCount: this.generateCWVFailCountInstrumentName('test', 'largestContentfulPaint'),
-            cumulativeLayoutShiftFailCount: this.generateCWVFailCountInstrumentName('test', 'cumulativeLayoutShift'),
-            timeToFirstByteFailCount: this.generateCWVFailCountInstrumentName('test', 'timeToFirstByte'),
-            domContentLoadedFailCount: this.generateCWVFailCountInstrumentName('test', 'domContentLoaded'),
-        };
-    }
-    initializeOpenTelemetry() {
-        const StepMetricsViews = {
-            executionCount: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.SumAggregation(),
-                instrumentName: this.stepMetricsInstrumentNames.executionCount,
-            }),
-            failCount: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.SumAggregation(),
-                instrumentName: this.stepMetricsInstrumentNames.failCount,
-            }),
-            passCount: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.SumAggregation(),
-                instrumentName: this.stepMetricsInstrumentNames.passCount,
-            }),
-            firstContentfulPaint: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.ExplicitBucketHistogramAggregation(distributions_1.FCPBucketBoundaries, true),
-                instrumentName: this.stepMetricsInstrumentNames.firstContentfulPaint,
-            }),
-            largestContentfulPaint: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.ExplicitBucketHistogramAggregation(distributions_1.LCPBucketBoundaries, true),
-                instrumentName: this.stepMetricsInstrumentNames.largestContentfulPaint,
-            }),
-            cumulativeLayoutShift: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.ExplicitBucketHistogramAggregation(distributions_1.CLSBucketBoundaries, true),
-                instrumentName: this.stepMetricsInstrumentNames.cumulativeLayoutShift,
-            }),
-            timeToFirstByte: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.ExplicitBucketHistogramAggregation(distributions_1.TTFBBucketBoundaries, true),
-                instrumentName: this.stepMetricsInstrumentNames.timeToFirstByte,
-            }),
-            domContentLoaded: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.ExplicitBucketHistogramAggregation(distributions_1.DCLBucketBoundaries, true),
-                instrumentName: this.stepMetricsInstrumentNames.domContentLoaded,
-            }),
-        };
-        const TestMetricsViews = {
-            executionCount: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.SumAggregation(),
-                instrumentName: this.testMetricsInstrumentNames.executionCount,
-            }),
-            executionTime: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.ExplicitBucketHistogramAggregation(distributions_1.ElapsedExecutionTimeBucketBoundaries, true),
-                instrumentName: this.testMetricsInstrumentNames.executionTime,
-            }),
-            failCount: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.SumAggregation(),
-                instrumentName: this.testMetricsInstrumentNames.failCount,
-            }),
-            passCount: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.SumAggregation(),
-                instrumentName: this.testMetricsInstrumentNames.passCount,
-            }),
-            runnerCount: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.LastValueAggregation(),
-                instrumentName: this.testMetricsInstrumentNames.runnerCount,
-            }),
-            firstContentfulPaintFailCount: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.SumAggregation(),
-                instrumentName: this.testMetricsInstrumentNames.firstContentfulPaintFailCount,
-            }),
-            largestContentfulPaintFailCount: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.SumAggregation(),
-                instrumentName: this.testMetricsInstrumentNames.largestContentfulPaintFailCount,
-            }),
-            cumulativeLayoutShiftFailCount: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.SumAggregation(),
-                instrumentName: this.testMetricsInstrumentNames.cumulativeLayoutShiftFailCount,
-            }),
-            timeToFirstByteFailCount: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.SumAggregation(),
-                instrumentName: this.testMetricsInstrumentNames.timeToFirstByteFailCount,
-            }),
-            domContentLoadedFailCount: new sdk_metrics_1.View({
-                aggregation: new sdk_metrics_1.SumAggregation(),
-                instrumentName: this.testMetricsInstrumentNames.domContentLoadedFailCount,
-            }),
-        };
-        const meterProvider = new sdk_metrics_1.MeterProvider({
-            resource: new resources_1.Resource({
-                'service.namespace': 'execution',
-                'service.name': 'performance-test-runner',
-                'host.id': this.runnerId,
-            }),
-            views: [
-                ...Object.values(StepMetricsViews),
-                ...Object.values(TestMetricsViews),
-            ],
-        });
-        const exporter = new opentelemetry_cloud_monitoring_exporter_1.MetricExporter({
-            prefix: 'custom.googleapis.com',
-            projectId: this.projectId,
-        });
-        meterProvider.addMetricReader(new sdk_metrics_1.PeriodicExportingMetricReader({
-            exportIntervalMillis: this.cloudMonitoringMetricsExportPeriodMs,
-            exporter,
-        }));
-        api_1.default.metrics.setGlobalMeterProvider(this.meterProvider);
-        return meterProvider;
-    }
-    initializeStepMetrics() {
-        return {
-            executionCount: this.initializeStepCount('executionCount'),
-            failCount: this.initializeStepCount('failCount'),
-            passCount: this.initializeStepCount('passCount'),
-            firstContentfulPaint: this.initializeStepTimeHistogram('firstContentfulPaint'),
-            largestContentfulPaint: this.initializeStepTimeHistogram('largestContentfulPaint'),
-            cumulativeLayoutShift: this.initializeStepTimeHistogram('cumulativeLayoutShift'),
-            timeToFirstByte: this.initializeStepTimeHistogram('timeToFirstByte'),
-            domContentLoaded: this.initializeStepTimeHistogram('domContentLoaded'),
-        };
-    }
-    initializeTestMetrics() {
-        return {
-            executionCount: this.initializeTestCount('executionCount'),
-            executionTime: this.initializeTestTimeHistogram('executionTime'),
-            failCount: this.initializeTestCount('failCount'),
-            passCount: this.initializeTestCount('passCount'),
-            runnerCount: this.initializeTestCount('runnerCount'),
-            firstContentfulPaintFailCount: this.initializeTestCount('firstContentfulPaintFailCount'),
-            largestContentfulPaintFailCount: this.initializeTestCount('largestContentfulPaintFailCount'),
-            cumulativeLayoutShiftFailCount: this.initializeTestCount('cumulativeLayoutShiftFailCount'),
-            timeToFirstByteFailCount: this.initializeTestCount('timeToFirstByteFailCount'),
-            domContentLoadedFailCount: this.initializeTestCount('domContentLoadedFailCount'),
-        };
-    }
-    initializeStepCount(instrumentName) {
-        return this.initializeCounter(this.stepMetricsInstrumentNames[instrumentName]);
-    }
-    initializeTestCount(instrumentName) {
-        return this.initializeCounter(this.testMetricsInstrumentNames[instrumentName]);
-    }
-    initializeCounter(instrumentName) {
-        return this.meter.createCounter(instrumentName, {
-            valueType: api_1.ValueType.INT,
-        });
-    }
-    initializeStepTimeHistogram(instrumentName) {
-        return this.initializeTimeHistogram(this.stepMetricsInstrumentNames[instrumentName]);
-    }
-    initializeTestTimeHistogram(instrumentName) {
-        return this.initializeTimeHistogram(this.testMetricsInstrumentNames[instrumentName]);
-    }
-    initializeTimeHistogram(instrumentName) {
-        const histogram = this.meter.createHistogram(instrumentName, {
-            unit: instrumentName === this.stepMetricsInstrumentNames.cumulativeLayoutShift
-                ? undefined
-                : 'ms',
-        });
-        return histogram;
-    }
-    generateCommonInstrumentNames(granularity) {
-        return {
-            executionCount: this.generateCountInstrumentName(granularity, 'execution'),
-            failCount: this.generateResultInstrumentName(granularity, 'fail'),
-            passCount: this.generateResultInstrumentName(granularity, 'pass'),
-        };
-    }
-    generateCountInstrumentName(granularity, type) {
-        return this.generateInstrumentName(granularity, type, 'count');
-    }
-    generateResultInstrumentName(granularity, type) {
-        return this.generateInstrumentName(granularity, 'result', type);
-    }
-    generateCWVFailCountInstrumentName(granularity, type) {
-        return this.generateInstrumentName(granularity, type, 'failCount');
-    }
-    generateInstrumentName(granularity, ...path) {
-        return `${METRIC_NAME_PREFIX}/${granularity}/${path.join('/')}`;
-    }
-}
-exports.CloudMonitoringPerformanceMetrics = CloudMonitoringPerformanceMetrics;

package/browserTestMonitoring/distributions.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateBucketBoundaries = exports.DCLBucketBoundaries = exports.TTFBBucketBoundaries = exports.CLSBucketBoundaries = exports.LCPBucketBoundaries = exports.FCPBucketBoundaries = exports.ElapsedExecutionTimeBucketBoundaries = void 0;
-exports.ElapsedExecutionTimeBucketBoundaries = generateBucketBoundaries({ limit: 60000, width: 1000 }, { limit: 300000, width: 5000 }, { limit: 3600000, width: 60000 });
-exports.FCPBucketBoundaries = generateBucketBoundaries({ limit: 1800, width: 25 }, { limit: 3000, width: 50 }, { limit: 6000, width: 100 }, { limit: 30000, width: 500 }, { limit: 50000, width: 1000 });
-exports.LCPBucketBoundaries = generateBucketBoundaries({ limit: 1500, width: 25 }, { limit: 2500, width: 50 }, { limit: 4000, width: 75 }, { limit: 8000, width: 250 }, { limit: 30000, width: 500 }, { limit: 60000, width: 1000 });
-exports.CLSBucketBoundaries = generateBucketBoundaries({ limit: 0.1, width: 0.001 }, { limit: 0.25, width: 0.0025 }, { limit: 0.5, width: 0.01 }, { limit: 1, width: 0.05 });
-exports.TTFBBucketBoundaries = generateBucketBoundaries({ limit: 1000, width: 25 }, { limit: 2000, width: 50 }, { limit: 5000, width: 75 }, { limit: 10000, width: 250 }, { limit: 30000, width: 500 }, { limit: 60000, width: 1000 });
-exports.DCLBucketBoundaries = generateBucketBoundaries({ limit: 1000, width: 25 }, { limit: 2000, width: 50 }, { limit: 5000, width: 75 }, { limit: 10000, width: 250 }, { limit: 30000, width: 500 }, { limit: 60000, width: 1000 });
-function generateBucketBoundaries(...rules) {
-    if (!rules.length) {
-        throw new Error('At least one rule must be specified');
-    }
-    return rules
-        .reduce((boundaries, rule, index) => {
-        const { limit, width } = rule;
-        const previousLimit = boundaries[index][boundaries[index].length - 1];
-        if (width <= 0) {
-            throw new Error(`Invalid rule specification at index ${index}: width must be positive but was ${width}`);
-        }
-        if (limit <= previousLimit) {
-            throw new Error(`Invalid rule specification at index ${index}: limit ${limit} must be strictly greater than previous limit ${previousLimit}`);
-        }
-        if (previousLimit + width > limit) {
-            throw new Error(`Invalid rule specification at index ${index}: previous limit ${previousLimit} + width ${width} must not exceed limit ${limit}`);
-        }
-        const correctionFactor = 10000;
-        const bucketCount = Math.floor((limit * correctionFactor - previousLimit * correctionFactor) /
-            (width * correctionFactor));
-        const buckets = [...Array(bucketCount)].map((_value, index) => (previousLimit * correctionFactor +
-            width * correctionFactor * (index + 1)) /
-            correctionFactor);
-        boundaries.push(buckets);
-        return boundaries;
-    }, [[0]])
-        .flat()
-        .slice(1);
-}
-exports.generateBucketBoundaries = generateBucketBoundaries;

package/browserTestMonitoring/metricsRecorder.js

@@ -1,129 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MetricsRecorder = void 0;
-const cloudMonitoringPerformanceMetrics_1 = require("./cloudMonitoringPerformanceMetrics");
-const Executor_1 = require("../execution/Executor");
-const TestResult_1 = require("../core/execution/TestResult");
-const pureUtil_1 = require("../util/pureUtil");
-class MetricsRecorder {
-    constructor(projectId, testMetricLabels, metricsFactory = (projectId, runnerId) => new cloudMonitoringPerformanceMetrics_1.CloudMonitoringPerformanceMetrics(projectId, runnerId), cwvFailureCriteria) {
-        this.testMetricLabels = testMetricLabels;
-        this.cwvFailureCriteria = cwvFailureCriteria;
-        this.metrics = metricsFactory(projectId, testMetricLabels.runner_id);
-    }
-    async stop() {
-        await this.metrics.shutdown();
-    }
-    recordTestMetricsForResult(testResult, navigationInfo) {
-        const testElapsedTimeMillis = testResult.endTime - testResult.startTime;
-        const testPassed = testResult.status === TestResult_1.TestResultStatus.passed;
-        this.recordTestMetrics({
-            executionCount: 1,
-            executionTime: testElapsedTimeMillis,
-            failCount: testPassed ? 0 : 1,
-            passCount: testPassed ? 1 : 0,
-            runnerCount: 1,
-            ...this.getCWVFailCounts(navigationInfo),
-        });
-    }
-    getCWVFailCounts(navigationInfo) {
-        var _a;
-        if (!this.cwvFailureCriteria) {
-            return {};
-        }
-        const { relevantStepIds, metricConfiguration } = this.cwvFailureCriteria;
-        const relevantNavigationInfo = (_a = relevantStepIds === null || relevantStepIds === void 0 ? void 0 : relevantStepIds.map((stepId) => navigationInfo.get(stepId)).filter(pureUtil_1.isDefined)) !== null && _a !== void 0 ? _a : Array.from(navigationInfo.values());
-        const relevantMetric = relevantNavigationInfo.flatMap((navigationInfo) => navigationInfo.metric);
-        return metricConfiguration
-            .map((configuration) => {
-            const { name, threshold } = configuration;
-            const hasTestFailed = relevantMetric
-                .filter((metric) => metric.name === name)
-                .some((metric) => metric.value > threshold);
-            return {
-                [this.metricNameToTestMeasurementName(name)]: hasTestFailed ? 1 : 0,
-            };
-        })
-            .reduce((measurements, measurement) => Object.assign(measurements, measurement), {});
-    }
-    metricNameToTestMeasurementName(name) {
-        switch (name) {
-            case 'FCP':
-                return 'firstContentfulPaintFailCount';
-            case 'LCP':
-                return 'largestContentfulPaintFailCount';
-            case 'CLS':
-                return 'cumulativeLayoutShiftFailCount';
-            case 'TTFB':
-                return 'timeToFirstByteFailCount';
-            default:
-            case 'domContentLoadedEventEnd':
-                return 'domContentLoadedFailCount';
-        }
-    }
-    recordStepMetricsForResult(result) {
-        const labels = {
-            ...this.testMetricLabels,
-            step_id: result.stepId,
-        };
-        this.recordStepMetrics(labels, {
-            executionCount: 1,
-            failCount: result.status === Executor_1.StepStatus.Failed ? 1 : 0,
-            passCount: result.status === Executor_1.StepStatus.Passed ? 1 : 0,
-        });
-    }
-    recordCWVStepMetrics(stepId, metric) {
-        const labels = {
-            ...this.testMetricLabels,
-            step_id: stepId,
-        };
-        this.recordStepMetrics(labels, this.transformCWVStepMetricToStepMeasurement(metric));
-    }
-    transformCWVStepMetricToStepMeasurement(metric) {
-        const { name, value } = metric;
-        switch (name) {
-            case 'FCP':
-                return { firstContentfulPaint: value };
-            case 'LCP':
-                return { largestContentfulPaint: value };
-            case 'CLS':
-                return { cumulativeLayoutShift: value };
-            case 'TTFB':
-                return { timeToFirstByte: value };
-            case 'domContentLoadedEventEnd':
-                return { domContentLoaded: value };
-            default:
-                return {};
-        }
-    }
-    recordStepMetrics(labels, measurements) {
-        Object.keys(measurements).forEach((name) => {
-            const instrument = this.metrics.step[name];
-            const value = measurements[name];
-            if (value !== undefined && !Number.isNaN(value)) {
-                this.recordValue(instrument, value, labels);
-            }
-        });
-    }
-    recordTestMetrics(measurements) {
-        Object.keys(measurements).forEach((name) => {
-            const instrument = this.metrics.test[name];
-            const value = measurements[name];
-            if (value !== undefined && !Number.isNaN(value)) {
-                this.recordValue(instrument, value, this.testMetricLabels);
-            }
-        });
-    }
-    recordValue(instrument, value, labels) {
-        if (instrument.add) {
-            instrument.add(value, labels);
-        }
-        else if (instrument.record) {
-            instrument.record(value, labels);
-        }
-        else {
-            console.error('Unexpected instrument type', instrument);
-        }
-    }
-}
-exports.MetricsRecorder = MetricsRecorder;

package/browserTestMonitoring/types.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const TestMetricLabelKeys = [
-    'runner_id',
-    'functional_test_id',
-    'performance_test_run_id',
-];
-const StepMetricLabelKeys = ['step_id', ...TestMetricLabelKeys];