fix log-server openapi file loading

log-api now exports a json file instead of a yaml file

Author: QuentinRoy

packages/log-api/.gitignore

@@ -8,4 +8,5 @@ dist/
 # Dependency directories
 node_modules/
 
-openapi.yaml
+openapi.yaml
+openapi.json

packages/log-api/tspconfig.yaml

@@ -3,8 +3,8 @@ emit:
 options:
   '@typespec/openapi3':
     emitter-output-dir: '{output-dir}'
-    output-file: 'openapi.yaml'
-    file-type: 'yaml'
+    output-file: 'openapi.json'
+    file-type: 'json'
     seal-object-schemas: true
     openapi-versions:
       - '3.1.0'

packages/log-client/package.json

@@ -34,8 +34,8 @@
   },
   "scripts": {
     "test": "cross-env NODE_ENV=test vitest",
-    "generate-api-types": "openapi-typescript node_modules/@lightmill/log-api/openapi.yaml --empty-objects-unknown --output ./generated/api.d.ts",
-    "watch:generate-api-types": "pnpm run generate-api-types && onchange 'node_modules/@lightmill/log-api/openapi.yaml' --no-exclude -- pnpm run generate-api-types",
+    "generate-api-types": "openapi-typescript node_modules/@lightmill/log-api/openapi.json --empty-objects-unknown --output ./generated/api.d.ts",
+    "watch:generate-api-types": "pnpm run generate-api-types && onchange 'node_modules/@lightmill/log-api/openapi.json' --no-exclude -- pnpm run generate-api-types",
     "build": "pnpm run generate-api-types && tsc -b tsconfig.build.json",
     "prepublish": "pnpm run build"
   },

packages/log-server/package.json

@@ -23,8 +23,8 @@
     "build": "pnpm run generate-api-types && rm -rf dist && tsc -b tsconfig.build.json",
     "prepublish": "pnpm run build",
     "test": "cross-env NODE_ENV=test vitest --typecheck",
-    "generate-api-types": "openapi-typescript node_modules/@lightmill/log-api/openapi.yaml --empty-objects-unknown --output ./generated/api.d.ts",
-    "watch:generate-api-types": "pnpm run generate-api-types && onchange 'node_modules/@lightmill/log-api/openapi.yaml' --no-exclude -- pnpm run generate-api-types",
+    "generate-api-types": "openapi-typescript node_modules/@lightmill/log-api/openapi.json --empty-objects-unknown --output ./generated/api.d.ts",
+    "watch:generate-api-types": "pnpm run generate-api-types && onchange 'node_modules/@lightmill/log-api/openapi.json' --no-exclude -- pnpm run generate-api-types",
     "cli": "tsx ./src/cli.ts",
     "cli-watch": "tsx --watch ./src/cli.ts"
   },

packages/log-server/src/app.ts

@@ -1,5 +1,5 @@
 import { match, P } from '@gabriel/ts-pattern';
-import { parse } from '@std/yaml';
+import apiSpecModule from '@lightmill/log-api/openapi.json' with { type: 'json' };
 import cookieParser from 'cookie-parser';
 import express, { type NextFunction } from 'express';
 import * as OpenApiValidator from 'express-openapi-validator';
@@ -10,8 +10,6 @@ import {
 import session, { Store as SessionStore } from 'express-session';
 import log from 'loglevel';
 import MemorySessionStoreModule from 'memorystore';
-import { readFileSync } from 'node:fs';
-import path from 'node:path';
 import type { components } from '../generated/api.js';
 import { experimentHandlers } from './app-experiments-handlers.js';
 import { logHandlers } from './app-logs-handlers.js';
@@ -23,10 +21,7 @@ import { createTypedExpressServer } from './typed-server.js';
 import { firstStrict } from './utils.js';
 
 const SESSION_COOKIE_NAME = 'lightmill-session-id';
-const OPEN_API_SPEC = path.join(
-  import.meta.dirname,
-  '../node_modules/@lightmill/log-api/openapi.yaml',
-);
+const apiSpec = apiSpecModule as OpenAPIV3.DocumentV3;
 
 const MemorySessionStore = MemorySessionStoreModule(session);
 
@@ -76,13 +71,9 @@ export function LogServer({
     }),
   );
 
-  const apiSpecFile = readFileSync(OPEN_API_SPEC, 'utf8');
-  const apiSpec = parse(apiSpecFile) as OpenAPIV3.DocumentV3;
-  apiSpec.servers = [{ url: baseUrl }];
-
   app.use(
     OpenApiValidator.middleware({
-      apiSpec,
+      apiSpec: { ...apiSpec, servers: [{ url: baseUrl }] },
       validateApiSpec: mode !== 'production',
       validateRequests: { allErrors: mode !== 'production' },
       validateResponses: mode !== 'production',

packages/log-server/tsconfig.json

@@ -3,7 +3,8 @@
   "extends": "../../tsconfig.json",
   "compilerOptions": {
     "allowSyntheticDefaultImports": true,
-    "noUncheckedIndexedAccess": true
+    "noUncheckedIndexedAccess": true,
+    "resolveJsonModule": true
   },
   "include": [
     "./src/**/*.ts",

tsconfig.json

@@ -1,10 +1,10 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
-    "target": "es2022",
-    "lib": ["es2022"],
-    "module": "Node16",
-    "moduleResolution": "Node16",
+    "target": "ESNext",
+    "lib": ["ESNext"],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
     "noImplicitAny": true,
     "strict": true,
     "sourceMap": true,