@flareapp/node 0.1.0 → 0.2.0

package/tests/regexFlagSanitization.test.ts

@@ -1,88 +0,0 @@
-import { describe, expect, it } from 'vitest';
-
-import { captureBody, DEFAULT_BODY_CONTENT_TYPES } from '../src/context/body';
-import { projectHeaders, DEFAULT_HEADER_DENYLIST } from '../src/context/headers';
-import { NodeFlare } from '../src/Flare';
-
-// Helpers to extract stored options from a configured NodeFlare instance.
-// We drive the options through the real configureNode path then exercise
-// the functions that consume them, so that we test the full sanitize path.
-
-describe('regex flag sanitization in configureNode', () => {
-    describe('bodyKeyDenylist with g flag', () => {
-        it('redacts every matching key even when denylist has the g flag', () => {
-            // Without sanitization, /password|token/g would retain lastIndex state
-            // across calls and silently skip the second match.
-            const instance = new NodeFlare();
-            instance.configureNode({
-                bodyKeyDenylist: /password|token/g,
-                captureRequestBody: true,
-                bodyAllowedContentTypes: DEFAULT_BODY_CONTENT_TYPES,
-            });
-
-            // Extract the sanitized denylist by capturing the body with a known input.
-            // We pass the body object directly (skips content-type check).
-            const body = { user: 'alice', password: 'secret', token: 'abc' };
-            // Re-use captureBody with the sanitized regex extracted via getContext hack.
-            // Simpler: call captureBody manually with the regex that configureNode produced.
-            // We can't easily inspect private state, so we test the observable effect
-            // through captureBody called with a regex that has the g flag removed.
-            const sanitizedDenylist = new RegExp(/password|token/.source, '');
-            const out = captureBody(body, undefined, {
-                bodyAllowedContentTypes: DEFAULT_BODY_CONTENT_TYPES,
-                bodyKeyDenylist: sanitizedDenylist,
-                bodyMaxBytes: 16_384,
-            });
-
-            const parsed = JSON.parse(out!);
-            expect(parsed.user).toBe('alice');
-            expect(parsed.password).toBe('[redacted]');
-            expect(parsed.token).toBe('[redacted]');
-        });
-
-        it('g flag on bodyKeyDenylist causes silent skip without sanitization (documents the bug)', () => {
-            // This test documents the broken behavior that sanitization fixes.
-            // With the g flag, the second test() call on the same regex instance
-            // may return false for a matching key (depending on lastIndex state).
-            const buggyRegex = /password|token/g;
-            const keys = ['password', 'token'];
-            const results = keys.map((k) => buggyRegex.test(k));
-            // At least one of the two tests returns false due to lastIndex advancement.
-            // (After matching 'password', lastIndex moves past it, so 'token' test resets
-            // or mis-fires depending on the JS engine state.)
-            // The exact outcome is engine-dependent, but the point is that the g flag
-            // makes behavior unreliable — sanitization removes it to guarantee correctness.
-            expect(results.includes(false)).toBe(true);
-        });
-    });
-
-    describe('headerDenylist — resolveHeaderDenylist already strips g/y (regression guard)', () => {
-        it('custom headerDenylist with g flag is combined correctly and redacts all matches', () => {
-            // resolveHeaderDenylist merges and strips g/y from the custom part.
-            const attrs = projectHeaders(
-                { 'Authorization': 'Bearer xyz', 'X-Custom-Secret': 'val', 'X-Other': 'ok' },
-                {
-                    headerDenylist: new RegExp(`(?:${DEFAULT_HEADER_DENYLIST.source})|(?:x-custom-secret)`, 'i'),
-                    headerAllowlist: null,
-                },
-            );
-            expect(attrs['http.request.header.authorization']).toBe('[redacted]');
-            expect(attrs['http.request.header.x-custom-secret']).toBe('[redacted]');
-            expect(attrs['http.request.header.x-other']).toBe('ok');
-        });
-    });
-
-    describe('bodyAllowedContentTypes with g flag', () => {
-        it('still matches content-type correctly after g flag is stripped', () => {
-            // A g-flagged regex for allowed content types would misfire on the second
-            // check after sanitization removes the flag, the regex becomes stateless.
-            const body = '{"a":1}';
-            const out = captureBody(body, 'application/json', {
-                bodyAllowedContentTypes: new RegExp(DEFAULT_BODY_CONTENT_TYPES.source, ''),
-                bodyKeyDenylist: /^$/,
-                bodyMaxBytes: 16_384,
-            });
-            expect(out).toBe('{"a":1}');
-        });
-    });
-});

package/tests/scopeIsolation.test.ts

@@ -1,47 +0,0 @@
-import { afterAll, beforeAll, describe, expect, it } from 'vitest';
-
-import { flare } from '../src';
-
-beforeAll(() => {
-    flare.removeProcessListeners();
-});
-
-afterAll(() => {
-    flare.removeProcessListeners();
-});
-
-describe('concurrent request scope isolation', () => {
-    it('glows, attributes, user, entryPoint do not leak across requests', async () => {
-        const captured: Array<Record<string, unknown>> = [];
-
-        async function request(label: string) {
-            return flare.runWithContext({ path: `/${label}` }, async () => {
-                flare.glow(`glow-${label}`);
-                flare.addContext(`ctx-${label}`, label);
-                flare.setUser({ id: `u-${label}` });
-                flare.setEntryPoint({ identifier: `/handler/${label}`, type: 'http' });
-                await new Promise((r) => setTimeout(r, Math.random() * 20));
-                const scope = flare.getContext()!;
-                const custom = (scope.pendingAttributes['context.custom'] ?? {}) as Record<string, unknown>;
-                captured.push({
-                    label,
-                    glows: scope.glows.map((g) => g.name),
-                    customKeys: Object.keys(custom),
-                    userId: scope.user?.id,
-                    entryPointId: scope.entryPoint?.identifier,
-                });
-            });
-        }
-
-        await Promise.all(['a', 'b', 'c'].map(request));
-        captured.sort((x, y) => String(x.label).localeCompare(String(y.label)));
-
-        for (const row of captured) {
-            const label = row.label;
-            expect(row.glows).toEqual([`glow-${label}`]);
-            expect(row.customKeys).toContain(`ctx-${label}`);
-            expect(row.userId).toBe(`u-${label}`);
-            expect(row.entryPointId).toBe(`/handler/${label}`);
-        }
-    });
-});

package/tests/setFrameworkScope.test.ts

@@ -1,86 +0,0 @@
-import { Api } from '@flareapp/core';
-import { describe, expect, it } from 'vitest';
-
-import { NodeFlare } from '../src/Flare';
-
-function makeInstance() {
-    const sent: any[] = [];
-    const api = new Api();
-    api.report = (report: any) => {
-        sent.push(report);
-        return Promise.resolve();
-    };
-    const instance = new NodeFlare();
-    instance.api = api;
-    instance.light('test-key');
-    return { instance, sent };
-}
-
-describe('setFramework inside runWithContext', () => {
-    it('framework attrs appear in report even when called inside a request scope', async () => {
-        const { instance, sent } = makeInstance();
-
-        instance.setFramework({ name: 'Express', version: '4.0.0' });
-
-        await instance.runWithContext({ method: 'GET', path: '/test' }, async () => {
-            await instance.report(new Error('boom'));
-        });
-
-        expect(sent.length).toBe(1);
-        const attrs = sent[0].attributes as Record<string, unknown>;
-        expect(attrs['flare.framework.name']).toBe('Express');
-        expect(attrs['flare.framework.version']).toBe('4.0.0');
-    });
-
-    it('framework attrs appear when setFramework is called before runWithContext', async () => {
-        const { instance, sent } = makeInstance();
-
-        instance.setFramework({ name: 'Fastify', version: '5.0.0' });
-
-        await instance.runWithContext({ method: 'POST', path: '/submit' }, async () => {
-            await instance.report(new Error('fastify-error'));
-        });
-
-        expect(sent.length).toBe(1);
-        const attrs = sent[0].attributes as Record<string, unknown>;
-        expect(attrs['flare.framework.name']).toBe('Fastify');
-        expect(attrs['flare.framework.version']).toBe('5.0.0');
-    });
-
-    it('framework attrs appear in report outside of runWithContext', async () => {
-        const { instance, sent } = makeInstance();
-
-        instance.setFramework({ name: 'Koa', version: '3.0.0' });
-        await instance.report(new Error('koa-error'));
-
-        expect(sent.length).toBe(1);
-        const attrs = sent[0].attributes as Record<string, unknown>;
-        expect(attrs['flare.framework.name']).toBe('Koa');
-        expect(attrs['flare.framework.version']).toBe('3.0.0');
-    });
-
-    it('context.custom.framework is set inside runWithContext when setFramework was called at startup', async () => {
-        const { instance, sent } = makeInstance();
-
-        instance.setFramework({ name: 'Express', version: '4.0.0' });
-
-        await instance.runWithContext({ method: 'GET', path: '/test' }, async () => {
-            await instance.report(new Error('boom'));
-        });
-
-        expect(sent.length).toBe(1);
-        const custom = sent[0].attributes['context.custom'] as Record<string, unknown>;
-        expect(custom.framework).toBe('express');
-    });
-
-    it('context.custom.framework is set outside runWithContext', async () => {
-        const { instance, sent } = makeInstance();
-
-        instance.setFramework({ name: 'Koa', version: '3.0.0' });
-        await instance.report(new Error('koa-error'));
-
-        expect(sent.length).toBe(1);
-        const custom = sent[0].attributes['context.custom'] as Record<string, unknown>;
-        expect(custom.framework).toBe('koa');
-    });
-});

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-    "extends": "../../tsconfig.json",
-    "compilerOptions": {
-        "paths": {
-            "@flareapp/core": ["../core/src/index.ts"]
-        }
-    },
-    "include": ["src"]
-}

package/vitest.config.ts

@@ -1,18 +0,0 @@
-import { resolve, dirname } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-import { defineConfig } from 'vitest/config';
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-export default defineConfig({
-    test: {
-        environment: 'node',
-    },
-    resolve: {
-        alias: {
-            '@flareapp/core': resolve(__dirname, '../core/src/index.ts'),
-            '@flareapp/node': resolve(__dirname, 'src/index.ts'),
-        },
-    },
-});