@stuntman/server 0.1.0

package/src/mock.ts

@@ -0,0 +1,349 @@
+import http from 'http';
+import https from 'https';
+import express from 'express';
+import { v4 as uuidv4 } from 'uuid';
+import { ruleExecutor } from './ruleExecutor';
+import { getTrafficStore } from './storage';
+import { RawHeaders, logger, HttpCode } from '@stuntman/shared';
+import RequestContext from './requestContext';
+import type * as Stuntman from '@stuntman/shared';
+import { IPUtils } from './ipUtils';
+import LRUCache from 'lru-cache';
+import { API } from './api/api';
+
+type WithRequiredProperty<Type, Key extends keyof Type> = Type & {
+    [Property in Key]-?: Type[Property];
+};
+
+const naiveGQLParser = (body: Buffer | string): Stuntman.GQLRequestBody | undefined => {
+    try {
+        let json: Stuntman.GQLRequestBody | undefined = undefined;
+        try {
+            json = JSON.parse(Buffer.isBuffer(body) ? body.toString('utf-8') : body);
+        } catch (kiss) {
+            // and swallow
+        }
+        if (!json?.query && !json?.operationName) {
+            return;
+        }
+        const lines = json.query
+            .split('\n')
+            .map((l) => l.replace(/^\s+/g, '').trim())
+            .filter((l) => !!l);
+        if (/^query /.test(lines[0])) {
+            json.type = 'query';
+        } else if (/^mutation /.test(lines[0])) {
+            json.type = 'mutation';
+        } else {
+            throw new Error(`Unable to resolve query type of ${lines[0]}`);
+        }
+        json.methodName = lines[json.operationName ? 1 : 0].split('(')[0].split('{')[0];
+        return json;
+    } catch (error) {
+        logger.debug(error, 'unable to parse GQL');
+    }
+    return undefined;
+};
+
+// TODO add proper web proxy mode
+
+export class Mock {
+    protected mockUuid: string;
+    protected options: Stuntman.ServerConfig;
+    protected mockApp: express.Express;
+    protected MOCK_DOMAIN_REGEX: RegExp;
+    protected URL_PORT_REGEX: RegExp;
+    protected server: http.Server | null = null;
+    protected serverHttps: https.Server | null = null;
+    protected trafficStore: LRUCache<string, Stuntman.LogEntry>;
+    protected ipUtils: IPUtils | null = null;
+    private _api: API | null = null;
+
+    get apiServer() {
+        if (this.options.api.disabled) {
+            return null;
+        }
+        if (!this._api) {
+            this._api = new API({ ...this.options.api, mockUuid: this.mockUuid }, this.options.webgui);
+        }
+        return this._api;
+    }
+
+    constructor(options: Stuntman.ServerConfig) {
+        this.mockUuid = uuidv4();
+        this.options = options;
+        if (this.options.mock.httpsPort && (!this.options.mock.httpsKey || !this.options.mock.httpsCert)) {
+            throw new Error('missing https key/cert');
+        }
+
+        this.MOCK_DOMAIN_REGEX = new RegExp(
+            `(?:\\.([0-9]+))?\\.(?:(?:${this.options.mock.domain})|(?:localhost))(https?)?(:${this.options.mock.port}${
+                this.options.mock.httpsPort ? `|${this.options.mock.httpsPort}` : ''
+            })?(?:\\b|$)`,
+            'i'
+        );
+        this.URL_PORT_REGEX = new RegExp(
+            `^(https?:\\/\\/[^:/]+):(?:${this.options.mock.port}${
+                this.options.mock.httpsPort ? `|${this.options.mock.httpsPort}` : ''
+            })(\\/.*)`,
+            'i'
+        );
+        this.trafficStore = getTrafficStore(this.mockUuid, this.options.storage.traffic);
+        this.ipUtils =
+            !this.options.mock.externalDns || this.options.mock.externalDns.length === 0
+                ? null
+                : new IPUtils({ mockUuid: this.mockUuid, externalDns: this.options.mock.externalDns });
+
+        this.mockApp = express();
+        // TODO for now request body is just a buffer passed further, not inflated
+        this.mockApp.use(express.raw({ type: '*/*' }));
+
+        this.mockApp.use((req: express.Request, res: express.Response, next: express.NextFunction) => {
+            RequestContext.bind(req, this.mockUuid);
+            next();
+        });
+
+        this.mockApp.all(/.*/, async (req, res) => {
+            const ctx: RequestContext | null = RequestContext.get(req);
+            const requestUuid = ctx?.uuid || uuidv4();
+            const timestamp = Date.now();
+            const originalHostname = req.hostname;
+            const unproxiedHostname = req.hostname.replace(this.MOCK_DOMAIN_REGEX, '');
+            const isProxiedHostname = originalHostname !== unproxiedHostname;
+            const originalRequest = {
+                id: requestUuid,
+                timestamp,
+                url: `${req.protocol}://${req.hostname}${req.originalUrl}`,
+                method: req.method,
+                rawHeaders: new RawHeaders(...req.rawHeaders),
+                ...(Buffer.isBuffer(req.body) && { body: req.body.toString('utf-8') }),
+            };
+            logger.debug(originalRequest, 'processing request');
+            const logContext: Record<string, any> = {
+                requestId: originalRequest.id,
+            };
+            const mockEntry: WithRequiredProperty<Stuntman.LogEntry, 'modifiedRequest'> = {
+                originalRequest,
+                modifiedRequest: {
+                    ...this.unproxyRequest(req),
+                    id: requestUuid,
+                    timestamp,
+                    ...(originalRequest.body && { gqlBody: naiveGQLParser(originalRequest.body) }),
+                },
+            };
+            if (!isProxiedHostname) {
+                this.removeProxyPort(mockEntry.modifiedRequest);
+            }
+            const matchingRule = await ruleExecutor.findMatchingRule(mockEntry.modifiedRequest);
+            if (matchingRule) {
+                mockEntry.mockRuleId = matchingRule.id;
+                mockEntry.labels = matchingRule.labels;
+                if (matchingRule.actions?.mockResponse) {
+                    const staticResponse =
+                        typeof matchingRule.actions.mockResponse === 'function'
+                            ? matchingRule.actions.mockResponse(mockEntry.modifiedRequest)
+                            : matchingRule.actions.mockResponse;
+                    mockEntry.modifiedResponse = staticResponse;
+                    logger.debug({ ...logContext, staticResponse }, 'replying with mocked response');
+                    if (matchingRule.storeTraffic) {
+                        this.trafficStore.set(requestUuid, mockEntry);
+                    }
+                    if (staticResponse.rawHeaders) {
+                        for (const header of staticResponse.rawHeaders.toHeaderPairs()) {
+                            res.setHeader(header[0], header[1]);
+                        }
+                    }
+                    res.status(staticResponse.status || 200);
+                    res.send(staticResponse.body);
+                    // static response blocks any further processing
+                    return;
+                }
+                if (matchingRule.actions?.modifyRequest) {
+                    mockEntry.modifiedRequest = matchingRule.actions?.modifyRequest(mockEntry.modifiedRequest);
+                    logger.debug({ ...logContext, modifiedRequest: mockEntry.modifiedRequest }, 'modified original request');
+                }
+            }
+            if (this.ipUtils && !isProxiedHostname && !this.ipUtils.isIP(originalHostname)) {
+                const hostname = originalHostname.split(':')[0];
+                try {
+                    const internalIPs = await this.ipUtils.resolveIP(hostname);
+                    if (this.ipUtils.isLocalhostIP(internalIPs) && this.options.mock.externalDns.length) {
+                        const externalIPs = await this.ipUtils.resolveIP(hostname, { useExternalDns: true });
+                        logger.debug({ ...logContext, hostname, externalIPs, internalIPs }, 'switched to external IP');
+                        mockEntry.modifiedRequest.url = mockEntry.modifiedRequest.url.replace(
+                            /^(https?:\/\/)[^:/]+/i,
+                            `$1${externalIPs}`
+                        );
+                    }
+                } catch (error) {
+                    // swallow the exeception, don't think much can be done at this point
+                    logger.warn({ ...logContext, error }, `error trying to resolve IP for "${hostname}"`);
+                }
+            }
+
+            let controller: AbortController | null = new AbortController();
+            const fetchTimeout = setTimeout(() => {
+                if (controller) {
+                    controller.abort(`timeout after ${this.options.mock.timeout}`);
+                }
+            }, this.options.mock.timeout);
+            req.on('close', () => {
+                logger.debug(logContext, 'remote client canceled the request');
+                clearTimeout(fetchTimeout);
+                if (controller) {
+                    controller.abort('remote client canceled the request');
+                }
+            });
+            let targetResponse: Response;
+            const hasKeepAlive = !!mockEntry.modifiedRequest.rawHeaders
+                .toHeaderPairs()
+                .find((h) => /^connection$/.test(h[0]) && /^keep-alive$/.test(h[1]));
+            try {
+                targetResponse = await fetch(mockEntry.modifiedRequest.url, {
+                    redirect: 'manual',
+                    headers: mockEntry.modifiedRequest.rawHeaders
+                        .toHeaderPairs()
+                        .filter((h) => !/^connection$/.test(h[0]) && !/^keep-alive$/.test(h[1])),
+                    body: mockEntry.modifiedRequest.body,
+                    method: mockEntry.modifiedRequest.method,
+                    keepalive: !!hasKeepAlive,
+                });
+            } finally {
+                controller = null;
+                clearTimeout(fetchTimeout);
+            }
+            const targetResponseBuffer = Buffer.from(await targetResponse.arrayBuffer());
+            const originalResponse = {
+                timestamp: Date.now(),
+                body: targetResponseBuffer.toString('binary'),
+                status: targetResponse.status,
+                rawHeaders: new RawHeaders(
+                    ...Array.from(targetResponse.headers.entries()).flatMap(([key, value]) => [key, value])
+                ),
+            };
+            logger.debug({ ...logContext, originalResponse }, 'received response');
+            mockEntry.originalResponse = originalResponse;
+            let modifedResponse: Stuntman.Response = {
+                ...originalResponse,
+                rawHeaders: new RawHeaders(
+                    ...Array.from(targetResponse.headers.entries()).flatMap(([key, value]) => {
+                        // TODO this replace may be too aggressive and doesn't handle protocol (won't be necessary with a trusted cert and mock serving http+https)
+                        return [
+                            key,
+                            isProxiedHostname
+                                ? value
+                                : value.replace(
+                                      new RegExp(`(?:^|\\b)(${unproxiedHostname.replace('.', '\\.')})(?:\\b|$)`, 'igm'),
+                                      originalHostname
+                                  ),
+                        ];
+                    })
+                ),
+            };
+            if (matchingRule?.actions?.modifyResponse) {
+                modifedResponse = matchingRule?.actions?.modifyResponse(mockEntry.modifiedRequest, originalResponse);
+                logger.debug({ ...logContext, modifedResponse }, 'modified response');
+            }
+
+            mockEntry.modifiedResponse = modifedResponse;
+            if (matchingRule?.storeTraffic) {
+                this.trafficStore.set(requestUuid, mockEntry);
+            }
+
+            if (modifedResponse.status) {
+                res.status(modifedResponse.status);
+            }
+            if (modifedResponse.rawHeaders) {
+                for (const header of modifedResponse.rawHeaders.toHeaderPairs()) {
+                    // since fetch decompresses responses we need to get rid of some headers
+                    // TODO maybe could be handled better than just skipping, although express should add these back for new body
+                    if (/^content-(?:length|encoding)$/i.test(header[0])) {
+                        continue;
+                    }
+                    res.setHeader(header[0], header[1]);
+                }
+            }
+            res.end(Buffer.from(modifedResponse.body, 'binary'));
+        });
+
+        this.mockApp.use((error: Error, req: express.Request, res: express.Response, _next: express.NextFunction) => {
+            const ctx: RequestContext | null = RequestContext.get(req);
+            const uuid = ctx?.uuid || uuidv4();
+            logger.error({ ...error, uuid }, 'Unexpected error');
+            if (res) {
+                res.status(HttpCode.INTERNAL_SERVER_ERROR).json({
+                    error: { message: error.message, httpCode: HttpCode.INTERNAL_SERVER_ERROR, uuid },
+                });
+                return;
+            }
+            console.log('mock encountered a critical error. exiting');
+            process.exit(1);
+        });
+    }
+
+    public start() {
+        if (this.server) {
+            throw new Error('mock server already started');
+        }
+        if (this.options.mock.httpsPort) {
+            this.serverHttps = https
+                .createServer(
+                    {
+                        key: this.options.mock.httpsKey,
+                        cert: this.options.mock.httpsCert,
+                    },
+                    this.mockApp
+                )
+                .listen(this.options.mock.httpsPort, () => {
+                    logger.info(`Mock listening on ${this.options.mock.domain}:${this.options.mock.httpsPort}`);
+                });
+        }
+        this.server = this.mockApp.listen(this.options.mock.port, () => {
+            logger.info(`Mock listening on ${this.options.mock.domain}:${this.options.mock.port}`);
+            if (!this.options.api.disabled) {
+                this.apiServer?.start();
+            }
+        });
+    }
+
+    public stop() {
+        if (!this.server) {
+            throw new Error('mock server not started');
+        }
+        if (!this.options.api.disabled) {
+            this.apiServer?.stop();
+        }
+        this.server.close((error) => {
+            logger.warn(error, 'problem closing server');
+            this.server = null;
+        });
+    }
+
+    protected unproxyRequest(req: express.Request): Stuntman.BaseRequest {
+        const protocol = (this.MOCK_DOMAIN_REGEX.exec(req.hostname) || [])[2] || req.protocol;
+        const port = (this.MOCK_DOMAIN_REGEX.exec(req.hostname) || [])[1] || undefined;
+
+        // TODO unproxied req might fail if there's a signed url :shrug:
+        // but then we can probably switch DNS for some particular 3rd party server to point to mock
+        // and in mock have a mapping rule for that domain to point directly to some IP :thinking:
+        return {
+            url: `${protocol}://${req.hostname.replace(this.MOCK_DOMAIN_REGEX, '')}${port ? `:${port}` : ''}${req.originalUrl}`,
+            rawHeaders: new RawHeaders(...req.rawHeaders.map((h) => h.replace(this.MOCK_DOMAIN_REGEX, ''))),
+            method: req.method,
+            ...(Buffer.isBuffer(req.body) && { body: req.body.toString('utf-8') }),
+        };
+    }
+
+    protected removeProxyPort(req: Stuntman.Request): void {
+        if (this.URL_PORT_REGEX.test(req.url)) {
+            req.url = req.url.replace(this.URL_PORT_REGEX, '$1$2');
+        }
+        const host = req.rawHeaders.get('host') || '';
+        if (
+            host.endsWith(`:${this.options.mock.port}`) ||
+            (this.options.mock.httpsPort && host.endsWith(`:${this.options.mock.httpsPort}`))
+        ) {
+            req.rawHeaders.set('host', host.split(':')[0]);
+        }
+    }
+}

package/src/requestContext.ts

@@ -0,0 +1,23 @@
+import type { Request } from 'express';
+import { v4 as uuidv4 } from 'uuid';
+
+export default class RequestContext {
+    static _bindings: WeakMap<Request, RequestContext> = new WeakMap<Request, RequestContext>();
+
+    public readonly mockUuid;
+    public readonly uuid;
+
+    constructor(mockUuid: string) {
+        this.uuid = uuidv4();
+        this.mockUuid = mockUuid;
+    }
+
+    static bind(req: Request, mockUuid: string): void {
+        const ctx = new RequestContext(mockUuid);
+        RequestContext._bindings.set(req, ctx);
+    }
+
+    static get(req: Request): RequestContext | null {
+        return RequestContext._bindings.get(req) || null;
+    }
+}

package/src/ruleExecutor.ts

@@ -0,0 +1,193 @@
+import AwaitLock from 'await-lock';
+import { AppError, DEFAULT_RULE_PRIORITY, HttpCode, logger } from '@stuntman/shared';
+import type * as Stuntman from '@stuntman/shared';
+import { DEFAULT_RULES } from './rules';
+
+const rulesLock = new AwaitLock();
+
+const transformMockRuleToLive = (rule: Stuntman.Rule): Stuntman.LiveRule => {
+    return {
+        ...rule,
+        counter: 0,
+        isEnabled: rule.isEnabled ?? true,
+        createdTimestamp: Date.now(),
+    };
+};
+
+class RuleExecutor {
+    // TODO persistent rule storage maybe
+    private _rules: Stuntman.LiveRule[];
+
+    private get enabledRules() {
+        if (!this._rules) {
+            return new Array<Stuntman.LiveRule>();
+        }
+        const now = Date.now();
+        return this._rules
+            .filter((r) => (r.isEnabled && !Number.isFinite(r.ttlSeconds)) || r.createdTimestamp + r.ttlSeconds * 1000 > now)
+            .sort((a, b) => (a.priority ?? DEFAULT_RULE_PRIORITY) - (b.priority ?? DEFAULT_RULE_PRIORITY));
+    }
+
+    constructor(rules?: Stuntman.Rule[]) {
+        this._rules = (rules || []).map(transformMockRuleToLive);
+    }
+
+    private hasExpired() {
+        const now = Date.now();
+        return this._rules.some((r) => Number.isFinite(r.ttlSeconds) && r.createdTimestamp + r.ttlSeconds * 1000 < now);
+    }
+
+    private async cleanUpExpired() {
+        if (!this.hasExpired()) {
+            return;
+        }
+        await rulesLock.acquireAsync();
+        const now = Date.now();
+        try {
+            this._rules = this._rules.filter((r) => {
+                const shouldKeep = !Number.isFinite(r.ttlSeconds) || r.createdTimestamp + r.ttlSeconds * 1000 > now;
+                if (!shouldKeep) {
+                    logger.debug({ ruleId: r.id }, 'removing expired rule');
+                }
+                return shouldKeep;
+            });
+        } finally {
+            await rulesLock.release();
+        }
+    }
+
+    async addRule(rule: Stuntman.Rule, overwrite?: boolean): Promise<Stuntman.LiveRule> {
+        await this.cleanUpExpired();
+        await rulesLock.acquireAsync();
+        try {
+            if (this._rules.some((r) => r.id === rule.id)) {
+                if (!overwrite) {
+                    throw new AppError({ httpCode: HttpCode.CONFLICT, message: 'rule with given ID already exists' });
+                }
+                this._removeRule(rule.id);
+            }
+            const liveRule = transformMockRuleToLive(rule);
+            this._rules.push(liveRule);
+            logger.debug(liveRule, 'rule added');
+            return liveRule;
+        } finally {
+            await rulesLock.release();
+        }
+    }
+
+    private _removeRule(ruleOrId: string | Stuntman.Rule) {
+        this._rules = this._rules.filter((r) => {
+            const notFound = r.id !== (typeof ruleOrId === 'string' ? ruleOrId : ruleOrId.id);
+            if (!notFound) {
+                logger.debug({ ruleId: r.id }, 'rule removed');
+            }
+            return notFound;
+        });
+    }
+
+    async removeRule(id: string): Promise<void>;
+    async removeRule(rule: Stuntman.Rule): Promise<void>;
+    async removeRule(ruleOrId: string | Stuntman.Rule): Promise<void> {
+        await this.cleanUpExpired();
+        await rulesLock.acquireAsync();
+        try {
+            this._removeRule(ruleOrId);
+        } finally {
+            await rulesLock.release();
+        }
+    }
+
+    enableRule(id: string): void;
+    enableRule(rule: Stuntman.Rule): void;
+    enableRule(ruleOrId: string | Stuntman.Rule): void {
+        this._rules.forEach((r) => {
+            if (r.id === (typeof ruleOrId === 'string' ? ruleOrId : ruleOrId.id)) {
+                r.isEnabled = true;
+                logger.debug({ ruleId: r.id }, 'rule enabled');
+            }
+        });
+    }
+
+    disableRule(id: string): void;
+    disableRule(rule: Stuntman.Rule): void;
+    disableRule(ruleOrId: string | Stuntman.Rule): void {
+        this._rules.forEach((r) => {
+            if (r.id === (typeof ruleOrId === 'string' ? ruleOrId : ruleOrId.id)) {
+                r.isEnabled = false;
+                logger.debug({ ruleId: r.id }, 'rule disabled');
+            }
+        });
+    }
+
+    async findMatchingRule(request: Stuntman.Request): Promise<Stuntman.LiveRule | null> {
+        const logContext: Record<string, any> = {
+            requestId: request.id,
+        };
+        const matchingRule = this.enabledRules.find((rule) => {
+            const matchResult = rule.matches(request);
+            if (typeof matchResult === 'boolean') {
+                return matchResult;
+            }
+            return matchResult.result;
+        });
+        if (!matchingRule) {
+            logger.debug(logContext, 'no matching rule found');
+            return null;
+        }
+        const matchResult: Stuntman.RuleMatchResult = matchingRule.matches(request);
+        logContext.ruleId = matchingRule.id;
+        logger.debug(logContext, 'matching rule found');
+        const matchingRuleClone = Object.freeze(Object.assign({}, matchingRule));
+        ++matchingRule.counter;
+        logContext.ruleCounter = matchingRule.counter;
+        if (Number.isNaN(matchingRule.counter) || !Number.isFinite(matchingRule.counter)) {
+            matchingRule.counter = 0;
+            logger.warn(logContext, "it's over 9000!!!");
+        }
+        if (matchingRule.disableAfterUse) {
+            if (typeof matchingRule.disableAfterUse === 'boolean' || matchingRule.disableAfterUse <= matchingRule.counter) {
+                logger.debug(logContext, 'disabling rule for future requests');
+                this.disableRule(matchingRule);
+            }
+        }
+        if (matchingRule.removeAfterUse) {
+            if (typeof matchingRule.removeAfterUse === 'boolean' || matchingRule.removeAfterUse <= matchingRule.counter) {
+                logger.debug(logContext, 'removing rule for future requests');
+                this.removeRule(matchingRule);
+            }
+        }
+        if (typeof matchResult !== 'boolean') {
+            if (matchResult.disableRuleIds && matchResult.disableRuleIds.length > 0) {
+                logger.debug(
+                    { ...logContext, disableRuleIds: matchResult.disableRuleIds },
+                    'disabling rules based on matchResult'
+                );
+                for (const ruleId of matchResult.disableRuleIds) {
+                    this.disableRule(ruleId);
+                }
+            }
+            if (matchResult.enableRuleIds && matchResult.enableRuleIds.length > 0) {
+                logger.debug(
+                    { ...logContext, disableRuleIds: matchResult.disableRuleIds },
+                    'enabling rules based on matchResult'
+                );
+                for (const ruleId of matchResult.enableRuleIds) {
+                    this.enableRule(ruleId);
+                }
+            }
+        }
+        return matchingRuleClone;
+    }
+
+    async getRules(): Promise<readonly Stuntman.LiveRule[]> {
+        await this.cleanUpExpired();
+        return this._rules;
+    }
+
+    async getRule(id: string): Promise<Stuntman.LiveRule | undefined> {
+        await this.cleanUpExpired();
+        return this._rules.find((r) => r.id === id);
+    }
+}
+
+export const ruleExecutor = new RuleExecutor(DEFAULT_RULES.map((r) => ({ ...r, ttlSeconds: Infinity })));

package/src/rules/catchAll.ts

@@ -0,0 +1,14 @@
+import { CATCH_ALL_RULE_PRIORITY, CATCH_RULE_NAME } from '@stuntman/shared';
+import type * as Stuntman from '@stuntman/shared';
+
+export const catchAllRule: Stuntman.DeployedRule = {
+    id: CATCH_RULE_NAME,
+    matches: () => true,
+    priority: CATCH_ALL_RULE_PRIORITY,
+    actions: {
+        mockResponse: (req: Stuntman.Request) => ({
+            body: `Request received by Stuntman mock <pre>${JSON.stringify(req, null, 4)}</pre>`,
+            status: 200,
+        }),
+    },
+};

package/src/rules/echo.ts

@@ -0,0 +1,14 @@
+import { DEFAULT_RULE_PRIORITY } from '@stuntman/shared';
+import type * as Stuntman from '@stuntman/shared';
+
+export const echoRule: Stuntman.DeployedRule = {
+    id: 'internal/echo',
+    priority: DEFAULT_RULE_PRIORITY + 1,
+    matches: (req: Stuntman.Request) => /https?:\/\/echo\/.*/.test(req.url),
+    actions: {
+        mockResponse: (req: Stuntman.Request) => ({
+            body: req,
+            status: 200,
+        }),
+    },
+};

package/src/rules/index.ts

@@ -0,0 +1,7 @@
+import { catchAllRule } from './catchAll';
+import { echoRule } from './echo';
+import type * as Stuntman from '@stuntman/shared';
+
+// TODO add option to load rules additional default rules from some nice configurable folder
+
+export const DEFAULT_RULES: Stuntman.DeployedRule[] = [catchAllRule, echoRule];

package/src/storage.ts

@@ -0,0 +1,39 @@
+import LRUCache from 'lru-cache';
+import type * as Stuntman from '@stuntman/shared';
+import sizeof from 'object-sizeof';
+
+const DNS_CACHE_OPTIONS: LRUCache.Options<string, string> = {
+    max: 1000,
+    ttl: 1000 * 60 * 15,
+    allowStale: false,
+    updateAgeOnGet: false,
+    updateAgeOnHas: false,
+};
+
+const trafficStoreInstances: Record<string, LRUCache<string, Stuntman.LogEntry>> = {};
+const dnsResolutionCacheInstances: Record<string, LRUCache<string, string>> = {};
+
+export const getTrafficStore = (key: string, options?: Stuntman.StorageConfig) => {
+    if (!(key in trafficStoreInstances)) {
+        if (!options) {
+            throw new Error('initialize with options first');
+        }
+        trafficStoreInstances[key] = new LRUCache<string, Stuntman.LogEntry>({
+            max: options.limitCount,
+            maxSize: options.limitSize,
+            ttl: options.ttl,
+            allowStale: false,
+            updateAgeOnGet: false,
+            updateAgeOnHas: false,
+            sizeCalculation: (value) => sizeof(value),
+        });
+    }
+    return trafficStoreInstances[key];
+};
+
+export const getDnsResolutionCache = (key: string) => {
+    if (!(key in dnsResolutionCacheInstances)) {
+        dnsResolutionCacheInstances[key] = new LRUCache<string, string>(DNS_CACHE_OPTIONS);
+    }
+    return dnsResolutionCacheInstances[key];
+};

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+    "compilerOptions": {
+        "target": "ES2018",
+        "module": "commonjs",
+        "rootDir": "src",
+        "declaration": true,
+        "outDir": "dist",
+        "esModuleInterop": true,
+        "forceConsistentCasingInFileNames": true,
+        "strict": true,
+        "skipLibCheck": true,
+        "typeRoots": ["node_modules/@types"],
+        "allowJs": true,
+        "moduleResolution": "node16"
+    }
+}