@flareapp/js 1.2.1 → 2.0.0

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 | null;
-    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
-        )
-    );
-}

package/src/util/flatJsonStringify.ts

@@ -1,25 +0,0 @@
-export function flatJsonStringify(json: object): string {
-    const ancestors = new WeakSet<object>();
-    const path: object[] = [];
-
-    return JSON.stringify(json, function (this: object, _key, value) {
-        if (typeof value !== 'object' || value === null) {
-            return value;
-        }
-
-        // Pop ancestors that are no longer on the path to `this`.
-        while (path.length > 0 && path[path.length - 1] !== this) {
-            const popped = path.pop()!;
-            ancestors.delete(popped);
-        }
-
-        if (ancestors.has(value)) {
-            return '[Circular]';
-        }
-
-        ancestors.add(value);
-        path.push(value);
-
-        return value;
-    });
-}

package/src/util/flattenOnce.ts

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

package/src/util/glowsToEvents.ts

@@ -1,17 +0,0 @@
-import { V2AttributeValue, V2SpanEvent } from '../api/v2WireTypes';
-import { Glow } from '../types';
-
-// glow.microtime is seconds since epoch with sub-second fraction (see util/now.ts).
-// V2SpanEvent.startTimeUnixNano is unix nanoseconds.
-export function glowsToEvents(glows: Glow[]): V2SpanEvent[] {
-    return glows.map((glow) => ({
-        type: 'php_glow',
-        startTimeUnixNano: Math.round(glow.microtime * 1_000_000_000),
-        endTimeUnixNano: null,
-        attributes: {
-            'glow.name': String(glow.name),
-            'glow.level': glow.message_level,
-            'glow.context': (glow.meta_data ?? {}) as V2AttributeValue,
-        },
-    }));
-}

package/src/util/index.ts

@@ -1,7 +0,0 @@
-export * from './assert';
-export * from './assertKey';
-export * from './assertSolutionProvider';
-export * from './flatJsonStringify';
-export * from './flattenOnce';
-export * from './glowsToEvents';
-export * from './now';

package/src/util/now.ts

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