Configure repo as public package (growthbook#6)

Author: bryce-fitzsimons

.babelrc.js

@@ -1,12 +1,11 @@
 {
-  "name": "growthbook-proxy",
+  "name": "@growthbook/proxy",
   "engines": {
     "node": ">=16"
   },
   "description": "GrowthBook proxy server for caching, realtime updates, telemetry, etc",
-  "private": true,
-  "version": "1.0.2",
-  "main": "dist/index.js",
+  "version": "1.0.3",
+  "main": "dist/app.js",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -16,13 +15,10 @@
   "scripts": {
     "lint": "eslint './**/*.{ts,js}' --fix --max-warnings 0 --cache --cache-strategy content",
     "build:clean": "rimraf -rf dist",
-    "build:esm": "cross-env BABEL_ENV=esmUnbundled babel src --extensions '.ts' --out-dir 'dist/esm' --source-maps",
-    "build:cjs": "cross-env BABEL_ENV=cjs babel src --extensions '.ts' --out-dir 'dist/cjs' --source-maps",
-    "build:bundles": "rollup -c",
     "build": "tsc",
     "type-check": "tsc --pretty --noEmit",
     "start": "node dist/src/index.js",
-    "dev": "concurrently 'tsc --watch' 'nodemon -q dist/src/index.js | yarn pino-pretty'"
+    "dev": "concurrently 'tsc --watch' 'nodemon -q dist/index.js | yarn pino-pretty'"
   },
   "dependencies": {
     "cors": "^2.8.5",
@@ -37,15 +33,6 @@
     "sse-pubsub": "^1.4.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.19.3",
-    "@babel/core": "^7.19.6",
-    "@babel/preset-env": "^7.19.4",
-    "@babel/preset-typescript": "^7.18.6",
-    "@rollup/plugin-babel": "^5.3.0",
-    "@rollup/plugin-commonjs": "^20.0.0",
-    "@rollup/plugin-json": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^13.0.4",
-    "@rollup/plugin-replace": "^3.0.0",
     "@types/cors": "^2.8.13",
     "@types/express": "^4.17.15",
     "@types/node": "^18.11.18",
@@ -64,8 +51,6 @@
     "pino-pretty": "^9.1.1",
     "prettier": "^2.8.1",
     "rimraf": "^3.0.2",
-    "rollup": "^2.56.3",
-    "rollup-plugin-terser": "^7.0.2",
     "typescript": "4.7.4"
   }
 }

package.json

@@ -2,7 +2,6 @@ import fs from "fs";
 import path from "path";
 import { Express } from "express";
 import cors from "cors";
-import { version } from "../package.json";
 import { adminRouter } from "./controllers/adminController";
 import { eventStreamRouter } from "./controllers/eventStreamController";
 import { featuresRouter } from "./controllers/featuresController";
@@ -13,6 +12,8 @@ import { eventStreamManager } from "./services/eventStreamManager";
 import { Context, GrowthBookProxy } from "./types";
 import logger, { initializeLogger } from "./services/logger";
 
+export { Context, GrowthBookProxy, CacheEngine } from "./types";
+
 let build: { sha: string; date: string };
 function getBuild() {
   if (!build) {
@@ -58,6 +59,9 @@ export const growthBookProxy = async (
   app: Express,
   context?: Partial<Context>
 ): Promise<GrowthBookProxy> => {
+  const packageJson = require("../package.json");
+  const version = (packageJson.version ?? "unknown") + "";
+
   const ctx: Context = { ...defaultContext, ...context };
   app.locals.ctx = ctx;
 
@@ -94,5 +98,6 @@ export const growthBookProxy = async (
       eventStreamManager,
       logger,
     },
+    version,
   };
-};
+};

rollup.config.js

@@ -3,8 +3,17 @@ import { growthBookProxy } from "./app";
 
 // Sample implementation for the GrowthBookProxy
 (async () => {
-  const { app, context } = await init();
+  const { app, server, context } = await init();
 
   // creating and starting the proxy is a one-liner
   await growthBookProxy(app, context);
+
+  process.on("SIGTERM", () => {
+    console.info("SIGTERM signal received: closing HTTP server");
+    // Todo: perform any cleanup
+    server.close(() => {
+      console.info("HTTP server closed");
+      process.exit(0);
+    });
+  });
 })();

src/app.ts

@@ -2,7 +2,6 @@ import express from "express";
 import * as spdy from "spdy";
 import dotenv from "dotenv";
 import { CacheEngine, Context } from "./types";
-import logger from "./services/logger";
 dotenv.config({ path: "./.env.local" });
 
 export default async () => {
@@ -40,24 +39,26 @@ export default async () => {
 
   // Start Express
   const app = express();
+  /* eslint-disable @typescript-eslint/no-explicit-any */
+  let server: any = null;
 
   // Start app
   if (USE_HTTP2) {
-    const server = spdy.createServer(
+    server = spdy.createServer(
       {
         key: HTTPS_KEY,
         cert: HTTPS_CERT,
       },
       app
     );
     server.listen(PROXY_PORT, () => {
-      logger.info(`GrowthBook proxy running over HTTP2, port ${PROXY_PORT}`);
+      console.info(`GrowthBook proxy running over HTTP2, port ${PROXY_PORT}`);
     });
   } else {
-    app.listen(PROXY_PORT, () => {
-      logger.info(`GrowthBook proxy running over HTTP1.1, port ${PROXY_PORT}`);
+    server = app.listen(PROXY_PORT, () => {
+      console.info(`GrowthBook proxy running over HTTP1.1, port ${PROXY_PORT}`);
     });
   }
 
-  return { app, context };
+  return { app, server, context };
 };

src/index.ts

@@ -1,9 +1,10 @@
+import { IncomingMessage, ServerResponse } from "http";
+import { Response } from "express";
 import {
   createProxyMiddleware,
   RequestHandler,
   responseInterceptor,
 } from "http-proxy-middleware";
-import { Request, Response } from "express";
 import { featuresCache } from "../../services/cache";
 import logger from "../../services/logger";
 import { eventStreamManager } from "../../services/eventStreamManager";
@@ -13,7 +14,12 @@ const errorCounts: Record<string, number> = {};
 
 const interceptor = (proxyTarget: string) =>
   responseInterceptor(
-    async (responseBuffer, proxyRes, req: Request, res: Response) => {
+    async (
+      responseBuffer,
+      proxyRes,
+      req: IncomingMessage,
+      res: ServerResponse
+    ) => {
       // got response, reset error count
       errorCounts[proxyTarget] = 0;
 
@@ -27,7 +33,7 @@ const interceptor = (proxyTarget: string) =>
 
         // refresh the cache
         try {
-          const apiKey = res.locals.apiKey;
+          const apiKey = (res as Response).locals.apiKey;
           const responseJson = JSON.parse(response);
           const oldEntry = await featuresCache.get(apiKey);
 

src/init.ts

@@ -1,6 +1,5 @@
 import got from "got";
 import { Request, Response } from "express";
-import { version } from "../../../package.json";
 import { featuresCache } from "../../services/cache";
 import logger from "../../services/logger";
 import { eventStreamManager } from "../../services/eventStreamManager";
@@ -22,7 +21,7 @@ export default ({ proxyTarget }: { proxyTarget: string }) =>
     activeFetchUrls.add(url);
     // eslint-disable-next-line no-async-promise-executor
     const entry = await got
-      .get(url, { headers: { "User-Agent": `GrowthBook Proxy ${version}` } })
+      .get(url, { headers: { "User-Agent": `GrowthBook Proxy` } })
       .json()
       .catch((e) => logger.error(e, "Refresh stale cache error"))
       .finally(() => activeFetchUrls.delete(url));

src/middleware/cache/readThroughCacheMiddleware.ts

@@ -1,6 +1,5 @@
 import got from "got";
 import { Context } from "../../types";
-import { version } from "../../../package.json";
 import logger from "../logger";
 import { getApiHostFromEnv, getConnectionsFromEnv } from "./helper";
 
@@ -96,7 +95,7 @@ export class Registrar {
     const url = `${this.growthbookApiHost}/api/v1/sdk-connections?withProxy=1&limit=100`;
     const headers = {
       Authorization: `Bearer ${this.secretApiKey}`,
-      "User-Agent": `GrowthBook Proxy ${version}`,
+      "User-Agent": `GrowthBook Proxy`,
     };
     const resp = (await got
       .get(url, { headers })
@@ -108,6 +107,7 @@ export class Registrar {
     if (resp?.connections) {
       const oldConnections = this.getAllConnections();
 
+      const newKeys: Set<string> = new Set();
       resp.connections.forEach((doc: ConnectionDoc) => {
         const connection: Partial<Connection> = {
           apiKey: doc.key,
@@ -116,8 +116,16 @@ export class Registrar {
           useEncryption: doc.encryptPayload,
         };
         this.setConnection(doc.key, connection);
+        newKeys.add(doc.key);
       });
 
+      // clean up stale connections
+      for (const key in oldConnections) {
+        if (!newKeys.has(key)) {
+          this.deleteConnection(key);
+        }
+      }
+
       const newConnections = this.getAllConnections();
       const hasChanges =
         JSON.stringify(newConnections) !== JSON.stringify(oldConnections);

src/middleware/cache/refreshStaleCacheMiddleware.ts

@@ -13,6 +13,7 @@ export interface GrowthBookProxy {
     eventStreamManager: EventStreamManager;
     logger: HttpLogger["logger"];
   };
+  version: string;
 }
 
 export interface Context {

src/services/registrar/index.ts

@@ -1,19 +1,20 @@
 {
   "compilerOptions": {
     "module": "commonjs",
+    "strict": true,
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
     "target": "es6",
     "noImplicitAny": true,
     "moduleResolution": "node",
     "sourceMap": true,
     "outDir": "dist",
+    "declaration": true,
     "typeRoots": ["node_modules/@types", "./typings"],
     "strictNullChecks": true,
     "strictBindCallApply": true,
     "strictPropertyInitialization": true,
-    "incremental": true,
-    "resolveJsonModule": true
+    "incremental": true
   },
   "include": ["src/**/*"]
 }