@flareapp/js 2.0.0-rc.1 → 2.0.0

package/src/Flare.ts

@@ -1,208 +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: KEY,
-        version: CLIENT_VERSION,
-        sourcemapVersion: SOURCEMAP_VERSION,
-        stage: '',
-        maxGlowsPerReport: 30,
-        reportingUrl: 'https://reporting.flareapp.io/api/reports',
-        reportBrowserExtensionErrors: false,
-        debug: false,
-        beforeEvaluate: (error) => error,
-        beforeSubmit: (report) => report,
-    };
-
-    glows: Glow[] = [];
-    context: Context = { context: {} };
-    solutionProviders: SolutionProvider[] = [];
-
-    constructor(public http: 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.http.report(
-            reportToSubmit,
-            this.config.reportingUrl,
-            this.config.key,
-            this.config.reportBrowserExtensionErrors
-        );
-    }
-
-    // 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 { Report } from '../types';
-import { flatJsonStringify } from '../util';
-
-export class Api {
-    report(report: Report, url: string, key: string, reportBrowserExtensionErrors: boolean): Promise<void> {
-        return fetch(url, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-                'X-Api-Token': key,
-                'X-Requested-With': 'XMLHttpRequest',
-                'X-Report-Browser-Extension-Errors': JSON.stringify(reportBrowserExtensionErrors),
-            },
-            body: flatJsonStringify({
-                ...report,
-                key: key,
-            }),
-        }).then(
-            (response) => {
-                if (response.status !== 204) {
-                    console.error(`Received response with status ${response.status} from Flare`);
-                }
-            },
-            (error) => console.error(error)
-        );
-    }
-}

package/src/api/index.ts

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

package/src/browser/catchWindowErrors.ts

@@ -1,36 +0,0 @@
-export function catchWindowErrors() {
-    if (typeof window === 'undefined') {
-        return;
-    }
-
-    // @ts-ignore
-    const flare = window.flare;
-
-    if (!window || !flare) {
-        return;
-    }
-
-    const originalOnerrorHandler = window.onerror;
-    const originalOnunhandledrejectionHandler = window.onunhandledrejection;
-
-    window.onerror = (_1, _2, _3, _4, error) => {
-        if (error) {
-            flare.report(error);
-        }
-
-        if (typeof originalOnerrorHandler === 'function') {
-            originalOnerrorHandler(_1, _2, _3, _4, error);
-        }
-    };
-
-    window.onunhandledrejection = (error: PromiseRejectionEvent) => {
-        if (error.reason instanceof Error) {
-            flare.report(error.reason);
-        }
-
-        if (typeof originalOnunhandledrejectionHandler === 'function') {
-            // @ts-ignore
-            originalOnunhandledrejectionHandler(error);
-        }
-    };
-}

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,17 +0,0 @@
-export default function cookie() {
-    if (!window.document.cookie) {
-        return {};
-    }
-
-    return {
-        cookies: window.document.cookie.split('; ').reduce(
-            (cookies, cookie) => {
-                const [cookieName, cookieValue] = cookie.split(/=/);
-                cookies[cookieName] = cookieValue;
-
-                return cookies;
-            },
-            {} as { [key: string]: string }
-        ),
-    };
-}

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,59 +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([
-                {
-                    line_number: 0,
-                    column_number: 0,
-                    method: 'unknown',
-                    file: 'unknown',
-                    code_snippet: {
-                        0: 'Could not read from file: stacktrace missing',
-                    },
-                    trimmed_column_number: null,
-                    class: 'unknown',
-                },
-            ]);
-        }
-
-        Promise.all(
-            ErrorStackParser.parse(error).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 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}`
-    );
-}

package/src/stacktrace/fileReader.ts

@@ -1,96 +0,0 @@
-const cachedFiles: { [key: string]: string } = {};
-
-type CodeSnippet = {
-    [key: number]: string;
-};
-
-type ReaderResponse = {
-    codeSnippet: CodeSnippet;
-    trimmedColumnNumber: number | null;
-};
-
-export function getCodeSnippet(url?: string, lineNumber?: number, columnNumber?: number): Promise<ReaderResponse> {
-    return new Promise((resolve) => {
-        if (!url || !lineNumber) {
-            return resolve({
-                codeSnippet: {
-                    0: `Could not read from file: missing file URL or line number. URL: ${url} lineNumber: ${lineNumber}`,
-                },
-                trimmedColumnNumber: null,
-            });
-        }
-
-        readFile(url).then((fileText) => {
-            if (!fileText) {
-                return resolve({
-                    codeSnippet: {
-                        0: `Could not read from file: Error while opening file at URL ${url}`,
-                    },
-                    trimmedColumnNumber: null,
-                });
-            }
-
-            return resolve(readLinesFromFile(fileText, lineNumber, columnNumber));
-        });
-    });
-}
-
-function readFile(url: string): Promise<string | null> {
-    if (cachedFiles[url]) {
-        return Promise.resolve(cachedFiles[url]);
-    }
-
-    return fetch(url)
-        .then((response) => {
-            if (response.status !== 200) {
-                return null;
-            }
-
-            return response.text();
-        })
-        .catch(() => null);
-}
-
-export function readLinesFromFile(
-    fileText: string,
-    lineNumber: number,
-    columnNumber?: number,
-    maxSnippetLineLength = 1000,
-    maxSnippetLines = 40
-): ReaderResponse {
-    const codeSnippet: CodeSnippet = {};
-    let trimmedColumnNumber = null;
-
-    const lines = fileText.split('\n');
-
-    for (let i = -maxSnippetLines / 2; i <= maxSnippetLines / 2; i++) {
-        const currentLineIndex = lineNumber + i;
-
-        if (currentLineIndex >= 0 && lines[currentLineIndex]) {
-            const displayLine = currentLineIndex + 1; // the linenumber in a stacktrace is not zero-based like an array
-
-            if (lines[currentLineIndex].length > maxSnippetLineLength) {
-                if (columnNumber && columnNumber + maxSnippetLineLength / 2 > maxSnippetLineLength) {
-                    codeSnippet[displayLine] = lines[currentLineIndex].substr(
-                        columnNumber - Math.round(maxSnippetLineLength / 2),
-                        maxSnippetLineLength
-                    );
-
-                    if (displayLine === lineNumber) {
-                        trimmedColumnNumber = Math.round(maxSnippetLineLength / 2);
-                    }
-
-                    continue;
-                }
-
-                codeSnippet[displayLine] = lines[currentLineIndex].substr(0, maxSnippetLineLength) + '…';
-
-                continue;
-            }
-
-            codeSnippet[displayLine] = lines[currentLineIndex];
-        }
-    }
-
-    return { codeSnippet, trimmedColumnNumber };
-}

package/src/stacktrace/index.ts

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

package/src/types.ts

@@ -1,76 +0,0 @@
-export type Config = {
-    key: string;
-    version: string;
-    sourcemapVersion: string;
-    stage: string;
-    maxGlowsPerReport: number;
-    reportBrowserExtensionErrors: boolean;
-    reportingUrl: string;
-    debug: boolean;
-    beforeEvaluate: (error: Error) => Error | false | null | Promise<Error | false | null>;
-    beforeSubmit: (report: Report) => Report | false | null | Promise<Report | false | null>;
-};
-
-export type Report = {
-    notifier: string;
-    exception_class: string;
-    seen_at: number;
-    message: string;
-    language: 'javascript';
-    glows: Glow[];
-    context: Context;
-    stacktrace: StackFrame[];
-    sourcemap_version_id: string;
-    solutions: Solution[];
-    stage?: string;
-};
-
-export interface SolutionProviderExtraParameters {}
-
-export type SolutionProvider = {
-    canSolve: (error: Error, extraParameters?: SolutionProviderExtraParameters) => boolean | Promise<boolean>;
-    getSolutions: (error: Error, extraParameters?: SolutionProviderExtraParameters) => Solution[] | Promise<Solution[]>;
-};
-
-export type Solution = {
-    class: string;
-    title: string;
-    description: string;
-    links: { [label: string]: string };
-    action_description?: string;
-    is_runnable?: boolean;
-};
-
-export type Context = {
-    request?: {
-        url?: String;
-        useragent?: String;
-        referrer?: String; // TODO: Flare doesn't catch this yet
-        readyState?: String; // TODO: Flare doesn't catch this yet
-    };
-    request_data?: {
-        queryString: { [key: string]: string };
-    };
-    cookies?: { [key: string]: string };
-    [key: string]: any;
-};
-
-export type StackFrame = {
-    line_number: number;
-    column_number: number; // TODO: Flare doesn't catch this yet
-    method: string;
-    file: string;
-    code_snippet: { [key: number]: string };
-    trimmed_column_number: number | null;
-    class: string;
-};
-
-export type Glow = {
-    time: number;
-    microtime: number;
-    name: String;
-    message_level: MessageLevel;
-    meta_data: object | object[];
-};
-
-export type MessageLevel = 'info' | 'debug' | 'warning' | 'error' | 'critical';

package/src/util/assert.ts

@@ -1,9 +0,0 @@
-import { CLIENT_VERSION } from '../env';
-
-export function assert(value: any, message: string, debug: boolean) {
-    if (debug && !value) {
-        console.error(`Flare JavaScript client v${CLIENT_VERSION}: ${message}`);
-    }
-
-    return !!value;
-}

package/src/util/assertKey.ts

@@ -1,11 +0,0 @@
-import { assert } from './assert';
-
-export function assertKey(key: unknown, debug: boolean): boolean {
-    return assert(
-        key,
-        'The client was not yet initialised with an API key. ' +
-            "Run client.light('<flare-project-key>') when you initialise your app. " +
-            "If you are running in dev mode and didn't run the light command on purpose, you can ignore this error.",
-        debug
-    );
-}

package/src/util/assertSolutionProvider.ts

@@ -1,12 +0,0 @@
-import { assert } from './assert';
-
-export function assertSolutionProvider(solutionProvider: object, debug: boolean): boolean {
-    return (
-        assert('canSolve' in solutionProvider, 'A solution provider without a [canSolve] property was added.', debug) &&
-        assert(
-            'getSolutions' in solutionProvider,
-            'A solution provider without a [getSolutions] property was added.',
-            debug
-        )
-    );
-}