@flareapp/js 1.2.1 → 2.0.0

package/src/Flare.ts

@@ -1,203 +0,0 @@
-import { Api } from './api';
-import { collectContext } from './context';
-import { CLIENT_VERSION, KEY, SOURCEMAP_VERSION } from './env';
-import { getSolutions } from './solutions';
-import { createStackTrace } from './stacktrace';
-import {
-    Config,
-    Context,
-    Glow,
-    MessageLevel,
-    Report,
-    SolutionProvider,
-    SolutionProviderExtraParameters,
-} from './types';
-import { assert, assertKey, assertSolutionProvider, now } from './util';
-
-export class Flare {
-    config: Config = {
-        key: null,
-        version: CLIENT_VERSION,
-        sourcemapVersion: SOURCEMAP_VERSION,
-        stage: '',
-        maxGlowsPerReport: 30,
-        reportingUrl: 'https://ingress.flareapp.io/v1/errors',
-        reportBrowserExtensionErrors: false,
-        debug: false,
-        beforeEvaluate: (error) => error,
-        beforeSubmit: (report) => report,
-    };
-
-    glows: Glow[] = [];
-    context: Context = { context: {} };
-    solutionProviders: SolutionProvider[] = [];
-
-    constructor(public api: Api = new Api()) {}
-
-    light(key: string = KEY, debug: boolean = false): Flare {
-        this.config.key = key;
-        this.config.debug = debug;
-
-        return this;
-    }
-
-    configure(config: Partial<Config>): Flare {
-        this.config = { ...this.config, ...config };
-
-        return this;
-    }
-
-    test(): Promise<void> {
-        return this.report(new Error('The Flare client is set up correctly!'));
-    }
-
-    glow(name: string, level: MessageLevel = 'info', data: object | object[] = []): Flare {
-        const time = now();
-
-        this.glows.push({
-            name,
-            message_level: level,
-            meta_data: data,
-            time,
-            microtime: time,
-        });
-
-        if (this.glows.length > this.config.maxGlowsPerReport) {
-            this.glows = this.glows.slice(this.glows.length - this.config.maxGlowsPerReport);
-        }
-
-        return this;
-    }
-
-    clearGlows(): Flare {
-        this.glows = [];
-
-        return this;
-    }
-
-    addContext(name: string, value: any): Flare {
-        this.context.context[name] = value;
-
-        return this;
-    }
-
-    addContextGroup(groupName: string, value: object): Flare {
-        this.context[groupName] = value;
-
-        return this;
-    }
-
-    registerSolutionProvider(solutionProvider: SolutionProvider): Flare {
-        if (!assertSolutionProvider(solutionProvider, this.config.debug)) {
-            return this;
-        }
-
-        this.solutionProviders.push(solutionProvider);
-
-        return this;
-    }
-
-    async report(
-        error: Error,
-        context: Context = {},
-        extraSolutionParameters: SolutionProviderExtraParameters = {}
-    ): Promise<void> {
-        const errorToReport = await this.config.beforeEvaluate(error);
-
-        if (!errorToReport) {
-            return;
-        }
-
-        const report = await this.createReportFromError(error, context, extraSolutionParameters);
-
-        if (!report) {
-            return;
-        }
-
-        return this.sendReport(report);
-    }
-
-    async reportMessage(message: string, context: Context = {}, exceptionClass: string = 'Log'): Promise<void> {
-        const stackTrace = await createStackTrace(Error(), this.config.debug);
-
-        // The first item in the stacktrace is from this file, and irrelevant
-        stackTrace.shift();
-
-        this.sendReport({
-            notifier: `Flare JavaScript client v${CLIENT_VERSION}`,
-            exception_class: exceptionClass,
-            seen_at: now(),
-            message: message,
-            language: 'javascript',
-            glows: this.glows,
-            context: collectContext({ ...context, ...this.context }),
-            stacktrace: stackTrace,
-            sourcemap_version_id: this.config.sourcemapVersion,
-            solutions: [],
-            stage: this.config.stage,
-        });
-    }
-
-    createReportFromError(
-        error: Error,
-        context: Context = {},
-        extraSolutionParameters: SolutionProviderExtraParameters = {}
-    ): Promise<Report | false> {
-        if (!assert(error, 'No error provided.', this.config.debug)) {
-            return Promise.resolve(false);
-        }
-
-        const seenAt = now();
-
-        return Promise.all([
-            getSolutions(this.solutionProviders, error, extraSolutionParameters),
-            createStackTrace(error, this.config.debug),
-        ]).then((result) => {
-            const [solutions, stacktrace] = result;
-
-            assert(stacktrace.length, "Couldn't generate stacktrace of this error: " + error, this.config.debug);
-
-            return {
-                notifier: `Flare JavaScript client v${CLIENT_VERSION}`,
-                exception_class: error.constructor && error.constructor.name ? error.constructor.name : 'undefined',
-                seen_at: seenAt,
-                message: error.message,
-                language: 'javascript',
-                glows: this.glows,
-                context: collectContext({ ...context, ...this.context }),
-                stacktrace,
-                sourcemap_version_id: this.config.sourcemapVersion,
-                solutions,
-                stage: this.config.stage,
-            };
-        });
-    }
-
-    async sendReport(report: Report): Promise<void> {
-        if (!assertKey(this.config.key, this.config.debug)) {
-            return;
-        }
-
-        const reportToSubmit = await this.config.beforeSubmit(report);
-
-        if (!reportToSubmit) {
-            return;
-        }
-
-        return this.api.report(reportToSubmit, this.config);
-    }
-
-    // Deprecated, the following methods exist for backwards compatibility.
-
-    set beforeEvaluate(beforeEvaluate: Config['beforeEvaluate']) {
-        this.config.beforeEvaluate = beforeEvaluate ?? '';
-    }
-
-    set beforeSubmit(beforeSubmit: Config['beforeSubmit']) {
-        this.config.beforeSubmit = beforeSubmit ?? '';
-    }
-
-    set stage(stage: string | undefined) {
-        this.config.stage = stage ?? '';
-    }
-}

package/src/api/Api.ts

@@ -1,27 +0,0 @@
-import { Config, Report } from '../types';
-import { flatJsonStringify } from '../util';
-
-import { mapToV2Wire } from './mapToV2Wire';
-
-export class Api {
-    report(report: Report, config: Config): Promise<void> {
-        return fetch(config.reportingUrl, {
-            method: 'POST',
-            headers: {
-                'Accept': 'application/json',
-                'Content-Type': 'application/json',
-                'X-Api-Token': config.key ?? '',
-                'X-Report-Browser-Extension-Errors': JSON.stringify(config.reportBrowserExtensionErrors),
-                'X-Flare-Client-Version': '1',
-            },
-            body: flatJsonStringify(mapToV2Wire(report, config)),
-        }).then(
-            (response) => {
-                if (response.status !== 200 && response.status !== 201 && response.status !== 204) {
-                    console.error(`Received response with status ${response.status} from Flare`);
-                }
-            },
-            (error) => console.error(error)
-        );
-    }
-}

package/src/api/index.ts

@@ -1,2 +0,0 @@
-export * from './Api';
-export * from './mapToV2Wire';

package/src/api/mapToV2Wire.ts

@@ -1,120 +0,0 @@
-import { CLIENT_VERSION } from '../env';
-import { Config, Context, Report, StackFrame } from '../types';
-import { glowsToEvents } from '../util/glowsToEvents';
-
-import { V2AttributeValue, V2Attributes, V2StackFrame, V2WirePayload } from './v2WireTypes';
-
-const KNOWN_CONTEXT_BUCKETS = new Set(['request', 'request_data', 'cookies', 'context']);
-
-const NON_APPLICATION_FRAME_PATTERN = /node_modules|vendor|chunk-/;
-
-export function mapToV2Wire(report: Report, config: Config): V2WirePayload {
-    const wire: V2WirePayload = {
-        seenAtUnixNano: Math.round(report.seen_at * 1_000_000_000),
-        stacktrace: report.stacktrace.map(mapStackFrame),
-        events: glowsToEvents(report.glows),
-        attributes: buildAttributes(report, config),
-    };
-
-    if (report.exception_class) {
-        wire.exceptionClass = report.exception_class;
-    }
-    if (report.message != null) {
-        wire.message = report.message;
-    }
-    if (report.sourcemap_version_id) {
-        wire.sourcemapVersionId = report.sourcemap_version_id;
-    }
-
-    return wire;
-}
-
-function mapStackFrame(frame: StackFrame): V2StackFrame {
-    const out: V2StackFrame = {
-        file: frame.file,
-        lineNumber: frame.line_number,
-        isApplicationFrame: !NON_APPLICATION_FRAME_PATTERN.test(frame.file),
-    };
-
-    if (frame.column_number != null) {
-        out.columnNumber = frame.column_number;
-    }
-    if (frame.method) {
-        out.method = frame.method;
-    }
-    if (frame.class) {
-        out.class = frame.class;
-    }
-    if (frame.code_snippet) {
-        out.codeSnippet = frame.code_snippet;
-    }
-
-    return out;
-}
-
-function buildAttributes(report: Report, config: Config): V2Attributes {
-    const attrs: V2Attributes = {
-        'telemetry.sdk.language': 'javascript',
-        'telemetry.sdk.name': '@flareapp/js',
-        'telemetry.sdk.version': CLIENT_VERSION,
-        'flare.language.name': 'javascript',
-        'flare.entry_point.type': 'web',
-    };
-
-    if (typeof window !== 'undefined' && window.location && window.location.href) {
-        attrs['flare.entry_point.value'] = window.location.href;
-    }
-
-    if (config.stage) {
-        attrs['service.stage'] = config.stage;
-    }
-    if (config.version) {
-        attrs['service.version'] = config.version;
-    }
-
-    const context: Context = report.context ?? {};
-
-    if (context.request?.url) attrs['url.full'] = String(context.request.url);
-    if (context.request?.useragent) attrs['user_agent.original'] = String(context.request.useragent);
-    if (context.request?.referrer) attrs['http.request.referrer'] = String(context.request.referrer);
-    if (context.request?.readyState) attrs['document.ready_state'] = String(context.request.readyState);
-
-    if (context.request_data?.queryString) {
-        attrs['url.query'] = context.request_data.queryString as V2AttributeValue;
-    }
-    if (context.cookies) {
-        attrs['http.request.cookies'] = context.cookies as V2AttributeValue;
-    }
-
-    const custom = buildCustomContext(context);
-    if (Object.keys(custom).length > 0) {
-        attrs['context.custom'] = custom;
-    }
-
-    return attrs;
-}
-
-function buildCustomContext(context: Context): { [k: string]: V2AttributeValue } {
-    const custom: { [k: string]: V2AttributeValue } = {};
-
-    // Passed-context: any top-level key not in known buckets.
-    for (const key of Object.keys(context)) {
-        if (KNOWN_CONTEXT_BUCKETS.has(key)) continue;
-        custom[key] = context[key] as V2AttributeValue;
-    }
-
-    // addContext('foo', value) populates context.context.foo. Flatten its
-    // children into siblings under context.custom. We process this AFTER the
-    // passed-context loop above so that on a collision (e.g. user calls both
-    // addContext('vue', X) and flare.report(err, {vue: Y})), the addContext
-    // value wins — same outcome as the {...passed, ...this.context} merge in
-    // Flare.report's createReportFromError.
-    const added = (context as any).context;
-    if (added && typeof added === 'object') {
-        for (const key of Object.keys(added)) {
-            custom[key] = added[key] as V2AttributeValue;
-        }
-    }
-
-    return custom;
-}

package/src/api/v2WireTypes.ts

@@ -1,39 +0,0 @@
-// Internal types — NOT re-exported from packages/js/src/index.ts.
-// These describe the v2 wire shape posted to https://ingress.flareapp.io/v1/errors.
-
-export type V2AttributeValue =
-    | string
-    | number
-    | boolean
-    | null
-    | V2AttributeValue[]
-    | { [key: string]: V2AttributeValue };
-
-export type V2Attributes = Record<string, V2AttributeValue>;
-
-export type V2StackFrame = {
-    file: string;
-    lineNumber: number;
-    columnNumber?: number;
-    method?: string;
-    class?: string;
-    codeSnippet?: { [line: number]: string };
-    isApplicationFrame?: boolean;
-};
-
-export type V2SpanEvent = {
-    type: string;
-    startTimeUnixNano: number;
-    endTimeUnixNano: number | null;
-    attributes: V2Attributes;
-};
-
-export type V2WirePayload = {
-    exceptionClass?: string;
-    message?: string;
-    seenAtUnixNano: number;
-    sourcemapVersionId?: string;
-    stacktrace: V2StackFrame[];
-    events: V2SpanEvent[];
-    attributes: V2Attributes;
-};

package/src/browser/catchWindowErrors.ts

@@ -1,72 +0,0 @@
-export function catchWindowErrors() {
-    if (typeof window === 'undefined') {
-        return;
-    }
-
-    // @ts-ignore
-    const flare = window.flare;
-
-    if (!window || !flare) {
-        return;
-    }
-
-    window.addEventListener('error', (event: ErrorEvent) => {
-        if (event.error) {
-            flare.report(event.error);
-        }
-    });
-
-    window.addEventListener('unhandledrejection', (event: PromiseRejectionEvent) => {
-        const reason = event.reason;
-
-        if (reason instanceof Error) {
-            flare.report(reason);
-            return;
-        }
-
-        if (hasStack(reason)) {
-            const error = new Error(rejectionReasonToMessage(reason));
-            error.stack = (reason as { stack: string }).stack;
-            flare.report(error);
-            return;
-        }
-
-        flare.reportMessage(rejectionReasonToMessage(reason), {}, 'UnhandledPromiseRejection');
-    });
-}
-
-function rejectionReasonToMessage(reason: unknown): string {
-    if (typeof reason === 'string') {
-        return reason;
-    }
-
-    if (reason == null) {
-        return `Unhandled promise rejection (${reason})`;
-    }
-
-    if (typeof reason === 'object') {
-        if ('message' in reason && typeof (reason as Record<string, unknown>).message === 'string') {
-            return (reason as Record<string, unknown>).message as string;
-        }
-
-        try {
-            const json = JSON.stringify(reason);
-            if (json && json !== '{}') {
-                return `Unhandled promise rejection: ${json}`;
-            }
-        } catch {}
-
-        return 'Unhandled promise rejection with non-serializable object';
-    }
-
-    return `Unhandled promise rejection: ${String(reason)}`;
-}
-
-function hasStack(value: unknown): boolean {
-    return (
-        typeof value === 'object' &&
-        value !== null &&
-        'stack' in value &&
-        typeof (value as Record<string, unknown>).stack === 'string'
-    );
-}

package/src/browser/index.ts

@@ -1 +0,0 @@
-export * from './catchWindowErrors';

package/src/context/collectContext.ts

@@ -1,18 +0,0 @@
-import { Context } from '../types';
-
-import cookie from './cookie';
-import request from './request';
-import requestData from './requestData';
-
-export function collectContext(additionalContext: object): Context {
-    if (typeof window === 'undefined') {
-        return additionalContext;
-    }
-
-    return {
-        ...cookie(),
-        ...request(),
-        ...requestData(),
-        ...additionalContext,
-    };
-}

package/src/context/cookie.ts

@@ -1,24 +0,0 @@
-export default function cookie() {
-    if (!window.document.cookie) {
-        return {};
-    }
-
-    const cookies: { [key: string]: string } = {};
-
-    for (const raw of window.document.cookie.split('; ')) {
-        const eq = raw.indexOf('=');
-        if (eq === -1) {
-            continue;
-        }
-
-        const name = raw.slice(0, eq);
-        const value = raw.slice(eq + 1);
-        cookies[name] = value;
-    }
-
-    if (Object.keys(cookies).length === 0) {
-        return {};
-    }
-
-    return { cookies };
-}

package/src/context/index.ts

@@ -1 +0,0 @@
-export * from './collectContext';

package/src/context/request.ts

@@ -1,10 +0,0 @@
-export default function request() {
-    return {
-        request: {
-            url: window.document.location.href,
-            useragent: window.navigator.userAgent,
-            referrer: window.document.referrer,
-            readyState: window.document.readyState,
-        },
-    };
-}

package/src/context/requestData.ts

@@ -1,13 +0,0 @@
-export default function requestData() {
-    if (!window.location.search) {
-        return {};
-    }
-
-    const queryString: { [key: string]: string } = {};
-
-    new URLSearchParams(window.location.search).forEach((value, key) => {
-        queryString[key] = value;
-    });
-
-    return { request_data: { queryString } };
-}

package/src/env/index.ts

@@ -1,12 +0,0 @@
-declare const FLARE_JS_KEY: string | undefined;
-declare const FLARE_SOURCEMAP_VERSION: string | undefined;
-
-// Injected during build
-export const CLIENT_VERSION =
-    typeof process.env.FLARE_JS_CLIENT_VERSION === 'undefined' ? '?' : process.env.FLARE_JS_CLIENT_VERSION;
-
-// Injected by flare-vite-plugin-sourcemap-uploader (optional)
-export const KEY = typeof FLARE_JS_KEY === 'undefined' ? '' : FLARE_JS_KEY;
-
-// Injected by flare-vite-plugin-sourcemap-uploader (optional)
-export const SOURCEMAP_VERSION = typeof FLARE_SOURCEMAP_VERSION === 'undefined' ? '' : FLARE_SOURCEMAP_VERSION;

package/src/index.ts

@@ -1,14 +0,0 @@
-import { Flare } from './Flare';
-import { catchWindowErrors } from './browser';
-
-// Expose package singleton
-export const flare = new Flare();
-
-if (typeof window !== 'undefined' && window) {
-    // @ts-expect-error
-    window.flare = flare;
-
-    catchWindowErrors();
-}
-
-export { Flare } from './Flare';

package/src/solutions/getSolutions.ts

@@ -1,35 +0,0 @@
-import { Solution, SolutionProvider, SolutionProviderExtraParameters } from '../types';
-import { flattenOnce } from '../util';
-
-export function getSolutions(
-    solutionProviders: Array<SolutionProvider>,
-    error: Error,
-    extraSolutionParameters: SolutionProviderExtraParameters = {}
-): Promise<Array<Solution>> {
-    return new Promise((resolve) => {
-        const canSolves = solutionProviders.reduce(
-            (canSolves, provider) => {
-                canSolves.push(Promise.resolve(provider.canSolve(error, extraSolutionParameters)));
-
-                return canSolves;
-            },
-            [] as Array<Promise<boolean>>
-        );
-
-        Promise.all(canSolves).then((resolvedCanSolves) => {
-            const solutionPromises: Array<Promise<Array<Solution>>> = [];
-
-            resolvedCanSolves.forEach((canSolve, i) => {
-                if (canSolve) {
-                    solutionPromises.push(
-                        Promise.resolve(solutionProviders[i].getSolutions(error, extraSolutionParameters))
-                    );
-                }
-            });
-
-            Promise.all(solutionPromises).then((solutions) => {
-                resolve(flattenOnce(solutions));
-            });
-        });
-    });
-}

package/src/solutions/index.ts

@@ -1 +0,0 @@
-export * from './getSolutions';

package/src/stacktrace/createStackTrace.ts

@@ -1,69 +0,0 @@
-import ErrorStackParser from 'error-stack-parser';
-
-import { StackFrame } from '../types';
-import { assert } from '../util';
-
-import { getCodeSnippet } from './fileReader';
-
-export function createStackTrace(error: Error, debug: boolean): Promise<Array<StackFrame>> {
-    return new Promise((resolve) => {
-        if (!hasStack(error)) {
-            assert(false, "Couldn't generate stacktrace of below error:", debug);
-
-            if (debug) {
-                console.error(error);
-            }
-
-            return resolve([fallbackFrame('stacktrace missing')]);
-        }
-
-        let parsed: ReturnType<typeof ErrorStackParser.parse>;
-        try {
-            parsed = ErrorStackParser.parse(error);
-        } catch (parseError) {
-            if (debug) {
-                console.error('Flare: failed to parse stacktrace', parseError);
-            }
-            return resolve([fallbackFrame('Could not parse stacktrace')]);
-        }
-
-        Promise.all(
-            parsed.map((frame) => {
-                return new Promise<StackFrame>((resolve) => {
-                    getCodeSnippet(frame.fileName, frame.lineNumber, frame.columnNumber).then((snippet) => {
-                        resolve({
-                            line_number: frame.lineNumber || 1,
-                            column_number: frame.columnNumber || 1,
-                            method: frame.functionName || 'Anonymous or unknown function',
-                            file: frame.fileName || 'Unknown file',
-                            code_snippet: snippet.codeSnippet,
-                            trimmed_column_number: snippet.trimmedColumnNumber,
-                            class: '',
-                        });
-                    });
-                });
-            })
-        ).then(resolve);
-    });
-}
-
-function fallbackFrame(message: string): StackFrame {
-    return {
-        line_number: 0,
-        column_number: 0,
-        method: 'unknown',
-        file: 'unknown',
-        code_snippet: { 0: message },
-        trimmed_column_number: null,
-        class: 'unknown',
-    };
-}
-
-function hasStack(err: any): boolean {
-    return (
-        !!err &&
-        (!!err.stack || !!err.stacktrace || !!err['opera#sourceloc']) &&
-        typeof (err.stack || err.stacktrace || err['opera#sourceloc']) === 'string' &&
-        err.stack !== `${err.name}: ${err.message}`
-    );
-}