@flareapp/js 1.0.0 → 1.1.0-rc.1

package/src/types.ts

@@ -1,92 +1,76 @@
-export namespace Flare {
-    export type BeforeEvaluate = (
-        error: Error,
-    ) => Error | false | Promise<Error | false>;
+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 BeforeSubmit = (
-        report: ErrorReport,
-    ) => ErrorReport | false | Promise<ErrorReport | false>;
+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 type Config = {
-        key: string;
-        reportingUrl: string;
-        maxGlowsPerReport: number;
-        maxReportsPerMinute: number;
-        stage?: string;
-    };
+export interface SolutionProviderExtraParameters {}
 
-    export type ErrorReport = {
-        notifier: string;
-        exception_class: string;
-        seen_at: number;
-        message: string;
-        language: 'javascript';
-        glows: Array<Flare.Glow>;
-        context: Flare.Context;
-        stacktrace: Array<Flare.StackFrame>;
-        sourcemap_version_id: string;
-        solutions: Array<Flare.Solution>;
-        stage?: string;
-    };
+export type SolutionProvider = {
+    canSolve: (error: Error, extraParameters?: SolutionProviderExtraParameters) => boolean | Promise<boolean>;
+    getSolutions: (error: Error, extraParameters?: SolutionProviderExtraParameters) => Solution[] | Promise<Solution[]>;
+};
 
-    export interface SolutionProviderExtraParameters {}
+export type Solution = {
+    class: string;
+    title: string;
+    description: string;
+    links: { [label: string]: string };
+    action_description?: string;
+    is_runnable?: boolean;
+};
 
-    export type SolutionProvider = {
-        canSolve: (
-            error: Error,
-            extraParameters?: SolutionProviderExtraParameters,
-        ) => boolean | Promise<boolean>;
-        getSolutions: (
-            error: Error,
-            extraParameters?: SolutionProviderExtraParameters,
-        ) => Array<Flare.Solution> | Promise<Array<Flare.Solution>>;
+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
     };
-
-    export type Solution = {
-        class: string;
-        title: string;
-        description: string;
-        links: { [label: string]: string };
-        action_description?: string;
-        is_runnable?: boolean;
+    request_data?: {
+        queryString: { [key: string]: string };
     };
+    cookies?: { [key: string]: string };
+    [key: string]: any;
+};
 
-    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 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: Array<Object>;
-    };
+export type Glow = {
+    time: number;
+    microtime: number;
+    name: String;
+    message_level: MessageLevel;
+    meta_data: object | object[];
+};
 
-    export type MessageLevel =
-        | 'info'
-        | 'debug'
-        | 'warning'
-        | 'error'
-        | 'critical';
-}
+export type MessageLevel = 'info' | 'debug' | 'warning' | 'error' | 'critical';

package/src/util/assert.ts

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,12 @@
+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
+        )
+    );
+}

package/src/util/flatJsonStringify.ts

@@ -0,0 +1,22 @@
+// https://stackoverflow.com/a/11616993/6374824
+export function flatJsonStringify(json: Object): string {
+    let cache: any = [];
+
+    const flattenedStringifiedJson = JSON.stringify(json, function (_, value) {
+        if (typeof value === 'object' && value !== null) {
+            if (cache.indexOf(value) !== -1) {
+                try {
+                    return JSON.parse(JSON.stringify(value));
+                } catch (error) {
+                    return;
+                }
+            }
+            cache.push(value);
+        }
+        return value;
+    });
+
+    cache = null;
+
+    return flattenedStringifiedJson;
+}

package/src/util/flattenOnce.ts

@@ -0,0 +1,5 @@
+export function flattenOnce(array: Array<Array<any>>) {
+    return array.reduce((flat, toFlatten) => {
+        return flat.concat(toFlatten);
+    }, []);
+}

package/src/util/index.ts

@@ -1,44 +1,6 @@
-import build from '../build';
-
-export function assert(value: any, message: string, debug: boolean) {
-    if (debug && !value) {
-        console.error(
-            `Flare JavaScript client v${build.clientVersion}: ${message}`,
-        );
-    }
-
-    return !!value;
-}
-
-// https://stackoverflow.com/a/11616993/6374824
-export function flatJsonStringify(json: Object): string {
-    let cache: any = [];
-
-    const flattenedStringifiedJson = JSON.stringify(json, function (_, value) {
-        if (typeof value === 'object' && value !== null) {
-            if (cache.indexOf(value) !== -1) {
-                try {
-                    return JSON.parse(JSON.stringify(value));
-                } catch (error) {
-                    return;
-                }
-            }
-            cache.push(value);
-        }
-        return value;
-    });
-
-    cache = null;
-
-    return flattenedStringifiedJson;
-}
-
-export function now(): number {
-    return Math.round(Date.now() / 1000);
-}
-
-export function flattenOnce(array: Array<Array<any>>) {
-    return array.reduce((flat, toFlatten) => {
-        return flat.concat(toFlatten);
-    }, []);
-}
+export * from './assert';
+export * from './assertKey';
+export * from './assertSolutionProvider';
+export * from './flatJsonStringify';
+export * from './flattenOnce';
+export * from './now';

package/src/util/now.ts

@@ -0,0 +1,3 @@
+export function now(): number {
+    return Math.round(Date.now() / 1000);
+}

package/tsconfig.json

@@ -1,4 +1,4 @@
 {
     "extends": "../../tsconfig.json",
-    "include": ["src"],
+    "include": ["src"]
 }

package/src/FlareClient.ts

@@ -1,285 +0,0 @@
-import { assert, now, flatJsonStringify } from './util';
-import { collectContext } from './context';
-import { createStackTrace } from './stacktrace';
-import build from './build';
-import getSolutions from './solutions';
-import { Flare } from './types';
-
-export default class FlareClient {
-    public version: string = build.clientVersion;
-
-    public config: Flare.Config = {
-        key: '',
-        reportingUrl: 'https://flareapp.io/api/reports',
-        maxGlowsPerReport: 30,
-        maxReportsPerMinute: 500,
-    };
-
-    private glows: Array<Flare.Glow> = [];
-
-    private context: Flare.Context = { context: {} };
-
-    public beforeEvaluate: Flare.BeforeEvaluate = (error) => error;
-
-    public beforeSubmit: Flare.BeforeSubmit = (report) => report;
-
-    private reportedErrorsTimestamps: Array<number> = [];
-
-    private solutionProviders: Array<Flare.SolutionProvider> = [];
-
-    private sourcemapVersion: string = build.sourcemapVersion;
-
-    public debug: boolean = false;
-
-    public stage: string | undefined = undefined;
-
-    public light(key: string = build.flareJsKey, debug = false): FlareClient {
-        this.debug = debug;
-
-        if (
-            !assert(
-                key && typeof key === 'string',
-                'An empty or incorrect Flare key was passed, errors will not be reported.',
-                this.debug,
-            ) ||
-            !assert(
-                Promise,
-                'ES6 promises are not supported in this environment, errors will not be reported.',
-                this.debug,
-            )
-        ) {
-            return this;
-        }
-
-        this.config.key = key;
-
-        return this;
-    }
-
-    public glow(
-        name: string,
-        level: Flare.MessageLevel = 'info',
-        metaData: Array<object> = [],
-    ): FlareClient {
-        const time = now();
-
-        this.glows.push({
-            name,
-            message_level: level,
-            meta_data: metaData,
-            time,
-            microtime: time,
-        });
-
-        if (this.glows.length > this.config.maxGlowsPerReport) {
-            this.glows = this.glows.slice(
-                this.glows.length - this.config.maxGlowsPerReport,
-            );
-        }
-
-        return this;
-    }
-
-    public addContext(name: string, value: any): FlareClient {
-        this.context.context[name] = value;
-
-        return this;
-    }
-
-    public addContextGroup(groupName: string, value: object): FlareClient {
-        this.context[groupName] = value;
-
-        return this;
-    }
-
-    public registerSolutionProvider(
-        provider: Flare.SolutionProvider,
-    ): FlareClient {
-        if (
-            !assert(
-                'canSolve' in provider,
-                'A solution provider without a [canSolve] property was added.',
-                this.debug,
-            ) ||
-            !assert(
-                'getSolutions' in provider,
-                'A solution provider without a [getSolutions] property was added.',
-                this.debug,
-            )
-        ) {
-            return this;
-        }
-
-        this.solutionProviders.push(provider);
-
-        return this;
-    }
-
-    public reportMessage(
-        message: string,
-        context: Flare.Context = {},
-        exceptionClass: string = 'Log',
-    ): void {
-        const seenAt = now();
-
-        createStackTrace(Error()).then((stacktrace) => {
-            // The first item in the stacktrace is from this file, and irrelevant
-            stacktrace.shift();
-
-            const report: Flare.ErrorReport = {
-                notifier: `Flare JavaScript client v${build.clientVersion}`,
-                exception_class: exceptionClass,
-                seen_at: seenAt,
-                message: message,
-                language: 'javascript',
-                glows: this.glows,
-                context: collectContext({ ...context, ...this.context }),
-                stacktrace,
-                sourcemap_version_id: this.sourcemapVersion,
-                solutions: [],
-                stage: this.stage,
-            };
-
-            this.sendReport(report);
-        });
-    }
-
-    public report(
-        error: Error,
-        context: Flare.Context = {},
-        extraSolutionParameters: Flare.SolutionProviderExtraParameters = {},
-    ): void {
-        Promise.resolve(this.beforeEvaluate(error)).then(
-            (reportReadyForEvaluation) => {
-                if (!reportReadyForEvaluation) {
-                    return;
-                }
-
-                this.createReport(error, context, extraSolutionParameters).then(
-                    (report) => (report ? this.sendReport(report) : {}),
-                );
-            },
-        );
-    }
-
-    public createReport(
-        error: Error,
-        context: Flare.Context = {},
-        extraSolutionParameters: Flare.SolutionProviderExtraParameters = {},
-    ): Promise<Flare.ErrorReport | false> {
-        if (!assert(error, 'No error provided.', this.debug)) {
-            return Promise.resolve(false);
-        }
-
-        const seenAt = now();
-
-        return Promise.all([
-            getSolutions(
-                this.solutionProviders,
-                error,
-                extraSolutionParameters,
-            ),
-            createStackTrace(error),
-        ]).then((result) => {
-            const [solutions, stacktrace] = result;
-
-            assert(
-                stacktrace.length,
-                "Couldn't generate stacktrace of this error: " + error,
-                this.debug,
-            );
-
-            return {
-                notifier: `Flare JavaScript client v${build.clientVersion}`,
-                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.sourcemapVersion,
-                solutions,
-                stage: this.stage,
-            };
-        });
-    }
-
-    private sendReport(report: Flare.ErrorReport): void {
-        if (
-            !assert(
-                this.config.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.",
-                this.debug,
-            )
-        ) {
-            return;
-        }
-
-        if (this.maxReportsPerMinuteReached()) {
-            return;
-        }
-
-        Promise.resolve(this.beforeSubmit(report)).then(
-            (reportReadyForSubmit) => {
-                if (!reportReadyForSubmit) {
-                    return;
-                }
-
-                fetch(this.config.reportingUrl, {
-                    method: 'POST',
-                    headers: {
-                        'Content-Type': 'application/json',
-                        'X-Requested-With': 'XMLHttpRequest',
-                        'x-api-token': this.config.key,
-                    },
-                    body: flatJsonStringify({
-                        ...reportReadyForSubmit,
-                        key: this.config.key,
-                    }),
-                }).then(
-                    (response) => {
-                        if (response.status !== 204) {
-                            console.error(
-                                `Received response with status ${response.status} from Flare`,
-                            );
-                        }
-                    },
-                    (error) => console.error(error),
-                );
-
-                this.reportedErrorsTimestamps.push(Date.now());
-            },
-        );
-    }
-
-    private maxReportsPerMinuteReached(): boolean {
-        if (
-            this.reportedErrorsTimestamps.length >=
-            this.config.maxReportsPerMinute
-        ) {
-            const nErrorsBack =
-                this.reportedErrorsTimestamps[
-                    this.reportedErrorsTimestamps.length -
-                        this.config.maxReportsPerMinute
-                ];
-
-            if (nErrorsBack > Date.now() - 60 * 1000) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    public test(): FlareClient {
-        this.report(new Error('The Flare client is set up correctly!'));
-
-        return this;
-    }
-}

package/src/build.ts

@@ -1,16 +0,0 @@
-declare const FLARE_JS_KEY: string | undefined;
-declare const FLARE_SOURCEMAP_VERSION: string | undefined;
-
-export default {
-    // Injected during build
-    clientVersion:
-        typeof process.env.FLARE_JS_CLIENT_VERSION === 'undefined'
-            ? '?'
-            : process.env.FLARE_JS_CLIENT_VERSION,
-    // Optionally injected by flare-vite-plugin-sourcemap-uploader
-    flareJsKey: typeof FLARE_JS_KEY === 'undefined' ? '' : FLARE_JS_KEY,
-    sourcemapVersion:
-        typeof FLARE_SOURCEMAP_VERSION === 'undefined'
-            ? ''
-            : FLARE_SOURCEMAP_VERSION,
-};

package/src/module.d.ts

@@ -1,3 +0,0 @@
-interface Window {
-    flare: import('./FlareClient').default;
-}