fix(naming): allow -internal as a suffix for internal services

Author: djMax

__tests__/config.test.ts

@@ -18,6 +18,7 @@ describe('configuration loader', () => {
     expect(config.get('envswitchon')).toBeTruthy();
 
     expect(config.get('servicetype')).toBeTruthy();
+    expect(config.get('oservicetype')).toBeTruthy();
     expect(config.get('notservicetype')).toBeFalsy();
 
     const orig = ['a', 'b', 'd'];

__tests__/fake-serv/config/config.json

@@ -6,6 +6,7 @@
   "envswitchoff": "env_switch:ENV_VAR_DOESNT_EXIST",
   "envswitchon": "env_switch:!ENV_VAR_DOESNT_EXIST",
   "servicetype": "servicetype:serv",
+  "oservicetype": "servicetype:internal",
   "notservicetype": "servicetype:api",
   "server": {
     "metrics": {

package.json

@@ -72,7 +72,7 @@
     "@opentelemetry/sdk-node": "^0.39.1",
     "@opentelemetry/semantic-conventions": "^1.13.0",
     "cookie-parser": "^1.4.6",
-    "dotenv": "^16.0.3",
+    "dotenv": "^16.3.0",
     "eventsource": "^1.1.2",
     "express": "next",
     "express-openapi-validator": "^5.0.4",
@@ -87,20 +87,20 @@
     "shortstop-yaml": "^1.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.6.3",
-    "@commitlint/config-conventional": "^17.6.3",
-    "@openapi-typescript-infra/coconfig": "^3.0.1",
+    "@commitlint/cli": "^17.6.5",
+    "@commitlint/config-conventional": "^17.6.5",
+    "@openapi-typescript-infra/coconfig": "^3.0.2",
     "@types/cookie-parser": "^1.4.3",
     "@types/eventsource": "1.1.11",
     "@types/express": "^4.17.17",
     "@types/glob": "^8.1.0",
-    "@types/jest": "^29.5.1",
+    "@types/jest": "^29.5.2",
     "@types/lodash": "^4.14.195",
     "@types/minimist": "^1.2.2",
     "@types/node": "^18.16.15",
     "@types/supertest": "^2.0.12",
-    "coconfig": "^0.10.1",
-    "eslint": "^8.41.0",
+    "coconfig": "^0.12.0",
+    "eslint": "^8.43.0",
     "eslint-config-gasbuddy": "^7.2.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-jest": "^27.2.1",
@@ -112,7 +112,7 @@
     "supertest": "^6.3.3",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.4"
+    "typescript": "^5.1.3"
   },
   "packageManager": "[email protected]"
 }

src/config/shortstops.ts

@@ -29,9 +29,16 @@ function betterRequire(basepath: string) {
   };
 }
 
+function canonicalizeServiceSuffix(suffix?: string) {
+  if (!suffix) {
+    return 'internal';
+  }
+  return { serv: 'internal' }[suffix] || suffix;
+}
+
 /**
  * Our convention is that service names end with:
- *  -serv - a back end service not callable by the outside world and where no authorization occurs
+ *  -serv or -internal - a back end service not callable by the outside world and where no authorization occurs (canonicalized to internal)
  *  -api - a non-UI front end service that exposes swagger and sometimes non-swagger APIs
  *  -web - a UI front end service
  *  -worker - a scheduled job or queue processor
@@ -41,7 +48,7 @@ function betterRequire(basepath: string) {
  * whether it's NOT of any of the specified types
  */
 function serviceTypeFactory(name: string) {
-  const type = name.split('-').pop();
+  const type = canonicalizeServiceSuffix(name.split('-').pop());
 
   return function serviceType(v: string) {
     let checkValue = v;
@@ -50,7 +57,7 @@ function serviceTypeFactory(name: string) {
       matchIsGood = false;
       checkValue = checkValue.substring(1);
     }
-    const values = checkValue.split(',');
+    const values = checkValue.split(',').map(canonicalizeServiceSuffix);
     // Welp, there's no XOR so here we are.
     return type && values.includes(type) ? matchIsGood : !matchIsGood;
   };

src/express-app/app.ts

@@ -168,7 +168,7 @@ export async function startApp<
   // so that the req can decide whether to save the raw request body or not.
   const attachServiceLocals: RequestHandler = (req, res, next) => {
     res.locals.logger = logger;
-    let maybePromise: Promise<void> | void;
+    let maybePromise: Promise<void> | void | undefined;
     try {
       maybePromise = serviceImpl.onRequest?.(
         req as RequestWithApp<SLocals>,