FEI-5001: Switch to TS enums, remove Flow infra (#852)

## Summary: Now that none of the downstream consumers of wonder-stuff are using Flow we can get rid of Flow related things from this repo. Issue: FEI-5001 ## Test plan: - `yarn build:types` - `yarn tsc` - `yarn build:docs`, open docs/index.html, see that `Runtime` is now a proper `enum` <img width="1904" alt="Screen Shot 2023-07-31 at 5 28 22 PM" src="https://github.com/Khan/wonder-stuff/assets/1044413/85bbb7a0-9bb8-4df8-9abf-c204f22dcdf6"> Author: kevinbarabash Reviewers: jeresig Required Reviewers: Approved By: jeresig Checks: ✅ Test (macos-latest, 16.x), ✅ codecov/project, ✅ Test (macos-latest, 16.x), ✅ Lint, typecheck, and coverage check (ubuntu-latest, 16.x), ✅ Prime node_modules cache for primary configuration (ubuntu-latest, 16.x), ⏭ gerald, ✅ CodeQL, ✅ Lint, typecheck, and coverage check (ubuntu-latest, 16.x), ✅ Prime node_modules cache for primary configuration (ubuntu-latest, 16.x), ✅ gerald, ✅ Analyze (javascript), ⏭ dependabot Pull Request URL: #852
Khan · Jul 31, 2023 · 4419e81 · 4419e81
1 parent fa7daca
commit 4419e81
Show file tree

Hide file tree

Showing 14 changed files with 57 additions and 160 deletions.
diff --git a/.changeset/silver-experts-attend.md b/.changeset/silver-experts-attend.md
@@ -0,0 +1,5 @@
+---
+"@khanacademy/wonder-stuff-server": major
+---
+
+Make Runtime a TS enum
diff --git a/.changeset/young-cameras-fail.md b/.changeset/young-cameras-fail.md
@@ -0,0 +1,5 @@
+---
+"ws-dev-build-settings": minor
+---
+
+Stop building Flow type definitions
diff --git a/.github/workflows/node-ci.yml b/.github/workflows/node-ci.yml
@@ -75,9 +75,6 @@ jobs:
     - name: Build Types
       run: yarn build:types
 
-    - name: Build Flow Types
-      run: yarn build:flowtypes
-
     # Linting / type checking
     - name: Eslint
       uses: Khan/actions@full-or-limited-v0

diff --git a/build-scripts/flowgen.d.ts b/build-scripts/flowgen.d.ts
diff --git a/build-scripts/gen-flow-types.ts b/build-scripts/gen-flow-types.ts
diff --git a/build-scripts/remove-test-types-from-dist.ts b/build-scripts/remove-test-types-from-dist.ts
diff --git a/build-settings/flowgen.d.ts b/build-settings/flowgen.d.ts
diff --git a/package.json b/package.json
@@ -58,7 +58,6 @@
     "express-async-handler": "^1.2.0",
     "express-winston": "^4.2.0",
     "fast-glob": "^3.3.0",
-    "flowgen": "git+https://[email protected]/Khan/flowgen.git#fa8050929948fb4313f738301285fb44625678c4",
     "heapdump": "^0.3.15",
     "jest": "^29.6.1",
     "jest-extended": "^4.0.0",
@@ -82,8 +81,7 @@
   "scripts": {
     "build": "rollup -c build-settings/rollup.config.js",
     "build:prodsizecheck": "rollup -c build-settings/rollup.config.js --configPlatforms='browser' --configFormats='esm' --configEnvironment='production'",
-    "build:types": "yarn tsc --build --verbose tsconfig-build.json && node -r @swc-node/register build-scripts/remove-test-types-from-dist.ts",
-    "build:flowtypes": "node -r @swc-node/register build-scripts/gen-flow-types.ts",
+    "build:types": "yarn tsc --build --verbose tsconfig-build.json",
     "build:docs": "typedoc",
     "watch": "rollup -c build-settings/rollup.config.js --watch",
     "clean": "rm -rf packages/wonder-stuff-*/dist && rm -rf packages/wonder-stuff-*/node_modules && rm -f packages/*/*.tsbuildinfo",

diff --git a/packages/tsconfig-shared.json b/packages/tsconfig-shared.json
@@ -1,6 +1,16 @@
 // This file is used by the tsconfig.json files in each package.
 /* Visit https://aka.ms/tsconfig to read more about this file */
 {
+  "exclude": [
+    "dist",
+    "**/*.test.*",
+    "**/__tests__/**",
+    "**/*.testdata.*",
+    "**/__testdata__/**",
+    "**/*.stories.*",
+    "**/__stories__/**",
+    "**/*.cypress.*"
+  ],
   "extends": "../tsconfig-common.json",
   "compilerOptions": {
     "composite": true,

diff --git a/packages/wonder-stuff-render-server/src/__tests__/run-server.test.ts b/packages/wonder-stuff-render-server/src/__tests__/run-server.test.ts
@@ -116,7 +116,9 @@ describe("#runServer", () => {
         const fakeRenderEnvironment: any = {
             render: jest.fn(),
         };
-        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue("test");
+        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue(
+            WSServer.Runtime.Test,
+        );
         jest.spyOn(WSServer, "getLogger").mockReturnValue(pretendLogger);
         jest.spyOn(WSServer, "getAppEngineInfo").mockReturnValue({} as any);
         const pretendApp = {
@@ -146,7 +148,9 @@ describe("#runServer", () => {
         const fakeRenderEnvironment: any = {
             render: jest.fn(),
         };
-        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue("test");
+        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue(
+            WSServer.Runtime.Test,
+        );
         jest.spyOn(WSServer, "getLogger").mockReturnValue(pretendLogger);
         jest.spyOn(WSServer, "getAppEngineInfo").mockReturnValue({} as any);
         const pretendApp = {
@@ -190,7 +194,9 @@ describe("#runServer", () => {
         const fakeRenderEnvironment: any = {
             render: jest.fn(),
         };
-        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue("test");
+        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue(
+            WSServer.Runtime.Test,
+        );
         jest.spyOn(WSServer, "getLogger").mockReturnValue(pretendLogger);
         jest.spyOn(WSServer, "getAppEngineInfo").mockReturnValue({} as any);
         const pretendApp = {
@@ -225,7 +231,9 @@ describe("#runServer", () => {
     it("should start the gateway", async () => {
         // Arrange
         const fakeRenderEnvironment: any = {render: jest.fn()};
-        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue("test");
+        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue(
+            WSServer.Runtime.Test,
+        );
         jest.spyOn(WSServer, "getAppEngineInfo").mockReturnValue({} as any);
         const pretendApp = {
             use: jest.fn().mockReturnThis(),
@@ -283,7 +291,9 @@ describe("#runServer", () => {
         // Arrange
         process.env.KA_ALLOW_HEAPDUMP = "1";
         const fakeRenderEnvironment: any = {render: jest.fn()};
-        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue("test");
+        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue(
+            WSServer.Runtime.Test,
+        );
         jest.spyOn(WSServer, "getAppEngineInfo").mockReturnValue({} as any);
         const pretendApp = {
             use: jest.fn().mockReturnThis(),

diff --git a/packages/wonder-stuff-render-server/src/__tests__/start-trace-agent-impl.test.ts b/packages/wonder-stuff-render-server/src/__tests__/start-trace-agent-impl.test.ts
@@ -8,7 +8,9 @@ jest.mock("@khanacademy/wonder-stuff-server");
 describe("#startTraceAgent", () => {
     it("should start the trace agent as disabled when not in production", () => {
         // Arrange
-        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue("development");
+        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue(
+            WSServer.Runtime.Development,
+        );
         const startSpy = jest.spyOn(TraceAgent, "start");
 
         // Act
@@ -20,7 +22,9 @@ describe("#startTraceAgent", () => {
 
     it("should start the trace agent as enabled when in production", () => {
         // Arrange
-        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue("production");
+        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue(
+            WSServer.Runtime.Production,
+        );
         const startSpy = jest.spyOn(TraceAgent, "start");
 
         // Act
@@ -33,7 +37,9 @@ describe("#startTraceAgent", () => {
     it("should return the tracer", () => {
         // Arrange
         const pretendTracer = {} as any;
-        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue("production");
+        jest.spyOn(WSServer, "getRuntimeMode").mockReturnValue(
+            WSServer.Runtime.Production,
+        );
         jest.spyOn(TraceAgent, "start").mockReturnValue(pretendTracer);
 
         // Act

diff --git a/packages/wonder-stuff-server/src/middleware/__tests__/request-authentication.test.ts b/packages/wonder-stuff-server/src/middleware/__tests__/request-authentication.test.ts
@@ -3,12 +3,13 @@ import {secret} from "@khanacademy/wonder-stuff-core";
 import * as GetRuntimeMode from "../../get-runtime-mode";
 import * as GetLogger from "../../get-logger";
 import {requestAuthentication} from "../request-authentication";
+import {Runtime} from "../../types";
 
 describe("#requestAuthentication", () => {
     describe("when not in production", () => {
         beforeEach(() => {
             jest.spyOn(GetRuntimeMode, "getRuntimeMode").mockReturnValue(
-                "development",
+                Runtime.Development,
             );
         });
 
@@ -193,7 +194,7 @@ describe("#requestAuthentication", () => {
     describe("when in production", () => {
         beforeEach(() => {
             jest.spyOn(GetRuntimeMode, "getRuntimeMode").mockReturnValue(
-                "production",
+                Runtime.Production,
             );
         });
 

diff --git a/packages/wonder-stuff-server/src/middleware/wrap-with-middleware.ts b/packages/wonder-stuff-server/src/middleware/wrap-with-middleware.ts
@@ -1,8 +1,7 @@
 import express from "express";
 import type {Application} from "express";
 import * as lw from "@google-cloud/logging-winston";
-import type {Logger, RequestAuthentication, RuntimeValue} from "../types";
-import {Runtime} from "../types";
+import {Logger, RequestAuthentication, Runtime} from "../types";
 import {attachAppEngineRequestID} from "./attach-app-engine-request-id";
 import {commonServiceRoutes} from "./common-service-routes";
 import {defaultErrorLogging} from "./default-error-logging";
@@ -13,7 +12,7 @@ import {requestAuthentication} from "./request-authentication";
 export const wrapWithMiddleware = async (
     app: Application,
     logger: Logger,
-    mode: RuntimeValue,
+    mode: Runtime,
     requestAuthOptions?: RequestAuthentication,
 ): Promise<Application> => {
     // Setup the middleware around the app.

diff --git a/packages/wonder-stuff-server/src/types.ts b/packages/wonder-stuff-server/src/types.ts
@@ -24,14 +24,11 @@ export type Logger = WinstonLogger;
 /**
  * The runtime modes that a gateway can run under.
  */
-// TODO(FEI-5001): Replace with TS enum
-export const Runtime = {
-    Production: "production" as const,
-    Development: "development" as const,
-    Test: "test" as const,
-} as const;
-
-export type RuntimeValue = (typeof Runtime)[keyof typeof Runtime];
+export enum Runtime {
+    Production = "production",
+    Development = "development",
+    Test = "test",
+}
 
 /**
  * Options to configure logging.
@@ -40,7 +37,7 @@ export type LoggingOptions = {
     /**
      * The runtime mode.
      */
-    mode: RuntimeValue;
+    mode: Runtime;
     /**
      * Log only if the level of a logged entry is less than or equal to this
      * level. Enables filtering out of debug message in production, for example.
@@ -100,7 +97,7 @@ export type ServerOptions = {
     /**
      * What runtime mode the server is running under.
      */
-    readonly mode: RuntimeValue;
+    readonly mode: Runtime;
     /**
      * Optional value in milliseconds for keepalive timeout of the server.
      * For running in Google Cloud, this should be higher than the load