@vector-im/matrix-bot-sdk/src/metrics/decorators.ts

TypeScript/JavaScript SDK for Matrix bots and appservices

import {
    METRIC_IDENTITY_CLIENT_FAILED_FUNCTION_CALL,
    METRIC_IDENTITY_CLIENT_FUNCTION_CALL,
    METRIC_IDENTITY_CLIENT_SUCCESSFUL_FUNCTION_CALL,
    METRIC_INTENT_FAILED_FUNCTION_CALL,
    METRIC_INTENT_FUNCTION_CALL,
    METRIC_INTENT_SUCCESSFUL_FUNCTION_CALL,
    METRIC_MATRIX_CLIENT_FAILED_FUNCTION_CALL,
    METRIC_MATRIX_CLIENT_FUNCTION_CALL,
    METRIC_MATRIX_CLIENT_SUCCESSFUL_FUNCTION_CALL,
} from "./names";
import { IdentityClientCallContext, IntentCallContext, MatrixClientCallContext } from "./contexts";

/**
 * Times a MatrixClient function call for metrics.
 * @category Metrics
 */
export function timedMatrixClientFunctionCall() {
    return function(_target: unknown, functionName: string, descriptor: PropertyDescriptor) {
        const originalMethod = descriptor.value;
        descriptor.value = async function(...args) {
            const context = this.metrics.assignUniqueContextId(<MatrixClientCallContext>{
                functionName,
                client: this,
            });
            this.metrics.start(METRIC_MATRIX_CLIENT_FUNCTION_CALL, context);
            try {
                const result = await originalMethod.apply(this, args);
                this.metrics.increment(METRIC_MATRIX_CLIENT_SUCCESSFUL_FUNCTION_CALL, context, 1);
                return result;
            } catch (e) {
                this.metrics.increment(METRIC_MATRIX_CLIENT_FAILED_FUNCTION_CALL, context, 1);
                throw e;
            } finally {
                this.metrics.end(METRIC_MATRIX_CLIENT_FUNCTION_CALL, context);
            }
        };
    };
}

/**
 * Times an IdentityClient function call for metrics.
 * @category Metrics
 */
export function timedIdentityClientFunctionCall() {
    return function(_target: unknown, functionName: string, descriptor: PropertyDescriptor) {
        const originalMethod = descriptor.value;
        descriptor.value = async function(...args: any[]) {
            const context = this.metrics.assignUniqueContextId(<IdentityClientCallContext>{
                functionName,
                client: this,
            });
            this.metrics.start(METRIC_IDENTITY_CLIENT_FUNCTION_CALL, context);
            try {
                const result = await originalMethod.apply(this, args);
                this.metrics.increment(METRIC_IDENTITY_CLIENT_SUCCESSFUL_FUNCTION_CALL, context, 1);
                return result;
            } catch (e) {
                this.metrics.increment(METRIC_IDENTITY_CLIENT_FAILED_FUNCTION_CALL, context, 1);
                throw e;
            } finally {
                this.metrics.end(METRIC_IDENTITY_CLIENT_FUNCTION_CALL, context);
            }
        };
    };
}

/**
 * Times an Intent function call for metrics.
 * @category Metrics
 */
export function timedIntentFunctionCall() {
    return function(_target: unknown, functionName: string, descriptor: PropertyDescriptor) {
        const originalMethod = descriptor.value;
        descriptor.value = async function(...args: any[]) {
            const context = this.metrics.assignUniqueContextId(<IntentCallContext>{
                functionName,
                client: this.client,
                intent: this,
            });
            this.metrics.start(METRIC_INTENT_FUNCTION_CALL, context);
            try {
                const result = await originalMethod.apply(this, args);
                this.metrics.increment(METRIC_INTENT_SUCCESSFUL_FUNCTION_CALL, context, 1);
                return result;
            } catch (e) {
                this.metrics.increment(METRIC_INTENT_FAILED_FUNCTION_CALL, context, 1);
                throw e;
            } finally {
                this.metrics.end(METRIC_INTENT_FUNCTION_CALL, context);
            }
        };
    };
}