Deprecate base urls (#3)

* Add support for multi locations, add some tests, fix some parameter parsing for corridor path etc. Sample requests

* multi locationId, tests,bug fixes

* Correct logic for locationId

* Allow hosting without setting the BASE_URLs env param

Author: murithigeo

src/apidocs/index.ts

@@ -1,54 +1,20 @@
 import fs from "node:fs";
 import YAML from "js-yaml";
 import path from "node:path";
-import type { oas3 } from "exegesis-express";
-import { LanHostGenerator } from "../common/utils/lanHostHandler.js";
 import process from "node:process";
 import type { OpenAPIObject } from "openapi3-ts";
-export const NODE_ENV: "production" | "dev" = process.env?.NODE_ENV || "dev";
-export const PORT = process.env.PORT || 3000;
-
-if (NODE_ENV === "production" && !process.env.BASE_URLS)
-  throw new Error("BASE_URLS env variable must be set in prod");
-
-//import { PORT } from '../index.js';
-const lanAddress = new LanHostGenerator().lanAddress();
-
-const servers: oas3.ServerObject[] = (
-  process.env?.BASE_URLS || "http://localhost"
-)
-  .split(",")
-  .concat(
-    lanAddress && typeof lanAddress === "string" && NODE_ENV !== "production"
-      ? `http://${lanAddress}`
-      : ""
-  )
-  .filter((u) => URL.canParse(u))
-  .map((u) => ({ url: NODE_ENV === "production" ? u : `${u}:${PORT}` }));
-
-console.log(`Server root is: ${servers.map((p) => p.url).join(";\t")}`);
 
 export const apidocs = {
-  edr: {
-    ...(YAML.load(
+  edr:
+    (YAML.load(
       fs.readFileSync(path.join(process.cwd(), `/src/apidocs/edr.yaml`), {
         encoding: "utf8",
       })
-    ) as OpenAPIObject),
-    servers: servers.map(({ url, description }) => ({
-      url: `${url}/edr`,
-      description,
-    })),
-  },
-  features: {
-    ...(YAML.load(
-      fs.readFileSync(path.join(process.cwd(), `/src/apidocs/features.yaml`), {
-        encoding: "utf8",
-      })
-    ) as OpenAPIObject),
-    servers: servers.map(({ url, description }) => ({
-      url: `${url}/features`,
-      description,
-    })),
-  },
-};
+    ) as OpenAPIObject)
+  ,
+  features: YAML.load(
+    fs.readFileSync(path.join(process.cwd(), `/src/apidocs/features.yaml`), {
+      encoding: "utf8",
+    })
+  ) as OpenAPIObject
+};

src/app.ts

@@ -3,9 +3,20 @@ import cors from "cors";
 import requestLogger from "./logging/index.js";
 import edrApi from "./standards/edr/index.js";
 import featuresApi from "./standards/features/index.js";
-import { NODE_ENV, PORT } from "./apidocs/index.js";
 import http from "node:http";
 import { scalar } from "./common/utils/scalar.js";
+import type { oas3 } from "exegesis";
+import { LanHostGenerator } from "./common/utils/lanHostHandler.js";
+
+const { lanAddress } = new LanHostGenerator();
+const NODE_ENV: string = process.env.NODE_ENV || "development";
+export const PORT = process.env.PORT || "8000";
+
+if (lanAddress) console.log(`Server also accessible on LAN at ${lanAddress}`)
+// Declare alternative servers
+// Modifies the document you get :root/*/api
+// TODO point to a env parameter
+export const servers: oas3.ServerObject[] = [];
 const app = express();
 
 app.use(cors());
@@ -44,8 +55,8 @@ app.get("/", (_, res, next) => {
   next();
 });
 
-app.use(await featuresApi);
-app.use(await edrApi);
+app.use("/features", await featuresApi);
+app.use("/edr", await edrApi);
 
 const server = http.createServer(app);
 export default server;

src/common/common.utils.ts

@@ -184,3 +184,26 @@ export function filterCollectionByZ({
       : true;
   return minCheck && maxCheck && levelCheck;
 }
+
+/**
+ * Run before other plugins that require the serverObject to be set
+ * @param location string like this edr not /edr
+ * @returns 
+ */
+export function setRelativeServerLocation(location: string): ExegesisPlugin {
+  return {
+    info: { name: "x-exegesis-plugin", },
+    makeExegesisPlugin(data) {
+      return {
+        //preRouting:(ctx)=>{}
+        postRouting: (ctx: ExegesisPluginContext) => {
+          let url = `${ctx.req.protocol || "https"}://${ctx.req.headers.host}/${location}`
+          ctx.api.serverObject = {
+            url,
+            description: `Auto-generated server root`
+          }
+        }
+      }
+    }
+  }
+}

src/common/utils/lanHostHandler.ts

@@ -2,12 +2,12 @@ import os from "node:os";
 import process from "node:process";
 
 export class LanHostGenerator {
-  constructor() {}
+  constructor() { }
 
   /**
    * @returns number|string. If no address is found, then returns 0
    */
-  lanAddress(): string | number {
+  public get lanAddress(): string | number {
     let ips: number | string = 0;
     if (process.argv.includes("--host")) {
       const ifaces = os.networkInterfaces();
@@ -24,6 +24,6 @@ export class LanHostGenerator {
         }
       });
     }
-    return ips;
+    return ips === 0 ? undefined : ips
   }
 }

src/index.ts

@@ -1,4 +1,3 @@
-import { PORT } from "./apidocs/index.js";
-import app from "./app.js";
+import app, { PORT } from "./app.js";
 
-app.listen(PORT,()=>console.log(`listening on ${PORT}`));
+app.listen(PORT, () => console.log(`listening on ${PORT}`));

src/models/db.ts

@@ -1,21 +1,17 @@
-/**
- * @description central interface to export initialized models
- * Use Kysely because there is a new plugin to ease use of kysley-postgis plugin
- */
-//import { Pool } from "pg";
 import pg from 'pg';
 const { Pool, types } = pg;
 pg.types.setTypeParser(types.builtins.NUMERIC, (val) => parseFloat(val));
 pg.types.setTypeParser(types.builtins.INT4, (val) => parseInt(val));
+import process from "node:process";
+let NODE_ENV = process.env.NODE_ENV || "development";
 import {
 	Kysely,
 	PostgresDialect,
 	ParseJSONResultsPlugin,
-	type TableExpression,
 	type ReferenceExpression
 } from 'kysely';
 import * as models from './models.js';
-import { NODE_ENV } from '../apidocs/index.js';
+import { NODE_ENV } from '../app.ts';
 
 export interface Database {
 	isd: models.ISD_GlobalHourly;

src/services/isd.service.ts

@@ -104,7 +104,7 @@ export const isdCollection: EdrCollection = {
   ],
   data_queries: {
     locations: {
-      output_formats: ["GeoJSON","JSON","CoverageJSON"],
+      output_formats: ["GeoJSON", "JSON", "CoverageJSON"],
       default_output_format: "GeoJSON",
       async handler({ datetime, z, bbox, crs, instanceId, limit, offset }) {
         let { rows, numberMatched } = await db
@@ -194,7 +194,7 @@ export const isdCollection: EdrCollection = {
     },
     items: {
       default_output_format: "GeoJSON",
-      output_formats: ["GeoJSON", "YAML", "CoverageJSON","JSON"],
+      output_formats: ["GeoJSON", "YAML", "CoverageJSON", "JSON"],
     },
     radius: {
       default_output_format: "JSON",
@@ -263,7 +263,7 @@ export const isdCollection: EdrCollection = {
                 .select(eb => eb.fn.agg("ARRAY_AGG", ["country"])
                   .distinct()
                   .as("countries")), "@>", sql`ARRAY[${sql.join(locationId)}]::varchar[]`)
-              conditions.push(check);
+              conditions.push(eb("country", "in", locationId.map(p => p.toString())));
               return check;
             })
             .executeTakeFirstOrThrow(

src/standards/edr/controllers/apiController.ts

@@ -2,6 +2,7 @@ import type { ExegesisContext } from "exegesis-express";
 import { EdrRqManager } from "../edr.utils.js";
 import { scalar } from "../../../common/utils/scalar.js";
 import { jsonlikeToYAML } from "../../../common/common.utils.js";
+import { servers } from "../../../app.js";
 
 function getServiceDoc(ctx: ExegesisContext): void {
   ctx.res
@@ -15,8 +16,12 @@ function getServiceDesc(ctx: ExegesisContext): void {
     ctx,
     collections: [],
   }).outputFormatParser("json", ["json", "yaml"]);
-  const { openApiDoc } = ctx.api;
-
+  let { openApiDoc } = ctx.api;
+  openApiDoc = {
+    ...openApiDoc,
+    // This negates the need to set a env variable with the server url
+    servers: [ctx.api.serverObject, ...openApiDoc.servers || [], ...servers.map(({ url, description }) => ({ url: `${url}/edr`, description }))]
+  }
   ctx.res.status(200);
   switch (f) {
     case "json":

src/standards/edr/index.ts

@@ -14,10 +14,12 @@ import trajectoryController from "./controllers/trajectoryController.js";
 import { middleware, type ExegesisOptions } from "exegesis-express";
 import { postToGetEdrPlugin } from "./plugins/postToGetEdrPlugin.js";
 import { apidocs } from "../../apidocs/index.js";
+import { setRelativeServerLocation } from "../../common/common.utils.js";
 
 //console.log(doc)
 const options: ExegesisOptions = {
-  plugins: [postToGetEdrPlugin()],
+  plugins: [setRelativeServerLocation("edr"),
+  postToGetEdrPlugin()],
   lazyCompileValidationSchemas: true,
   //customFormats: { datetimeRegex },
   controllers: {

src/standards/features/controllers/apiController.ts

@@ -2,25 +2,28 @@ import type { ExegesisContext } from "exegesis-express";
 import { scalar } from "../../../common/utils/scalar.js";
 import { FeaturesRqManager } from "../features.utils.js";
 import { jsonlikeToYAML } from "../../../common/common.utils.js";
+import { servers } from "../../../app.js";
 
 function getServiceDesc(ctx: ExegesisContext): void {
   const { f, contentTypeHeader } = new FeaturesRqManager({
     ctx,
     collections: [],
   }).outputFormatParser("JSON", ["JSON", "YAML", "HTML"]);
 
+  let { openApiDoc } = ctx.api;
+  openApiDoc = { ...openApiDoc, servers: [ctx.api.serverObject, ...openApiDoc.servers || [], ...servers.map(({ url, description }) => ({ url: `${url}/features`, description }))] }
   ctx.res.status(200).set(...contentTypeHeader);
 
   switch (f) {
     case "json":
       ctx.res
         .set("content-type", "application/vnd.oai.openapi+json;version=3.0")
-        .setBody(ctx.api.openApiDoc);
+        .setBody(openApiDoc);
       break;
     case "yaml":
       ctx.res
         .set("content-type", "application/vnd.oai.openapi;version=3.0")
-        .setBody(jsonlikeToYAML(ctx.api.openApiDoc));
+        .setBody(jsonlikeToYAML(openApiDoc));
       break;
     case "html":
       ctx.res.redirect(302, "/features/api.html");