refactor: adjust route endpoints to use less ids for inputs

Author: shreddedbacon

services/api/database/migrations/20250925000000_routes.js

@@ -8,6 +8,8 @@ exports.up = async function(knex) {
         return knex.schema
         .createTable('routes', function (table) {
             table.increments('id').notNullable().primary();
+            table.timestamp('created').notNullable().defaultTo(knex.fn.now());
+            table.timestamp('updated').notNullable().defaultTo(knex.fn.now());
             table.string('domain', 300).notNullable();
             table.integer('project').notNullable();
             table.integer('environment');

services/api/src/resolvers.js

@@ -311,7 +311,7 @@ const {
 } = require('./resources/env-variables/resolvers');
 
 const {
-  addRoute,
+  addRouteToProject,
   deleteRoute,
   getRoutesByProjectId,
   getRoutesByEnvironmentId,
@@ -324,6 +324,8 @@ const {
   removeRouteAnnotation,
   addPathRoutesToRoute,
   removePathRouteFromRoute,
+  addOrUpdateRouteToEnvironment,
+  removeRouteFromEnvironment,
 } = require('./resources/routes/resolvers');
 
 async function getResolvers() {
@@ -554,6 +556,8 @@ async function getResolvers() {
       alternativeNames: getAlternateRoutesByRouteId,
       annotations: getRouteAnnotationsByRouteId,
       pathRoutes: getPathRoutesByRouteId,
+      environment: getEnvironmentById,
+      project: getProjectById,
     },
     Organization: {
       groups: getGroupsByOrganizationId,
@@ -844,7 +848,9 @@ async function getResolvers() {
     deleteHistoryRetentionPolicy,
     addHistoryRetentionPolicyLink,
     removeHistoryRetentionPolicyLink,
-    addRoute,
+    addRouteToProject,
+    addOrUpdateRouteToEnvironment,
+    removeRouteFromEnvironment,
     addRouteAlternativeDomains,
     removeRouteAlternativeDomain,
     deleteRoute,

services/api/src/resources/environment/helpers.ts

@@ -7,6 +7,7 @@ import { Sql as problemSql } from '../problem/sql';
 import { Sql as factSql } from '../fact/sql';
 // import { Sql as backupSql } from '../backup/sql';
 import { Helpers as projectHelpers } from '../project/helpers';
+import { Helpers as routeHelpers } from '../routes/helpers';
 import { HistoryRetentionEnforcer } from '../retentionpolicy/history';
 import { logger } from '../../loggers/logger';
 
@@ -91,6 +92,12 @@ export const Helpers = (sqlClientPool: Pool) => {
           problemSql.deleteProblemsForEnvironment(eid)
         );
 
+        // delete any autogenerated routes from the api for this environment
+        await routeHelpers(sqlClientPool).deleteEnvironmentAutogeneratedRoutes(eid)
+        // remove all remaining route associations from environment
+        // but leave the routes in the api attached to the project
+        await routeHelpers(sqlClientPool).removeAllRoutesFromEnvironment(eid)
+
         // delete the environment backups rows
         // logger.debug(`deleting environment ${name}/id:${eid}/project:${pid} environment backups`)
         // @TODO: this could be done here, but it would mean that to recover all the backup ids of a deleted environment

services/api/src/resources/environment/resolvers.ts

@@ -46,11 +46,19 @@ export const getEnvironmentByName: ResolverFn = async (
 };
 
 export const getEnvironmentById = async (
-  root,
+  eid,
   args,
   { sqlClientPool, hasPermission, adminScopes }
 ) => {
-  const environment = await Helpers(sqlClientPool).getEnvironmentById(args.id);
+  // handle dealing with arg or passthrough
+  let environmentId = args.id
+  if (eid) {
+    environmentId = eid.id
+  }
+  if (eid == null && !args.id) {
+    return null;
+  }
+  const environment = await Helpers(sqlClientPool).getEnvironmentById(environmentId);
 
   if (!environment) {
     return null;
@@ -1059,10 +1067,7 @@ export const getEnvironmentServicesByEnvironmentId: ResolverFn = async (
   args,
   { sqlClientPool }
 ) => {
-  const rows = await query(
-    sqlClientPool,
-    Sql.selectServicesByEnvironmentId(eid)
-  );
+  const rows = await Helpers(sqlClientPool).getEnvironmentServices(eid)
   return rows;
 };
 

services/api/src/resources/routes/helpers.ts

@@ -1,9 +1,56 @@
-export type RouteAnnotation = {
-    key: string;
-    value: string;
-};
+import { Pool } from 'mariadb';
+import { query } from '../../util/db';
+import { Sql } from './sql';
+import { Helpers as environmentHelpers } from '../environment/helpers';
+import { Helpers as projectHelpers } from '../project/helpers';
 
-export type RouteAnnotations = RouteAnnotation[];
+import { RouteAnnotations, PathRoutes } from './types';
+
+export const Helpers = (sqlClientPool: Pool) => {
+  const removeAllRoutesFromEnvironment = async (environmentId: number) => {
+    await query(
+      sqlClientPool,
+      Sql.removeAllRoutesFromEnvironment(environmentId)
+    )
+  }
+  const deleteEnvironmentAutogeneratedRoutes = async (environmentId: number) => {
+    await query(
+      sqlClientPool,
+      Sql.deleteEnvironmentAutogeneratedRoutes(environmentId)
+    )
+  }
+  const removeRouteFromEnvironment = async (domain: string, environmentId: number) => {
+    const routes = await query(
+      sqlClientPool,
+      Sql.selectRoutesByDomainAndEnvironmentID(domain, environmentId)
+    )
+    if (routes.length == 0) {
+      throw Error(`Route doesn't exist on this environment`)
+    }
+    const route = routes[0]
+    if (route.autogenerated == true) {
+      throw Error(`Cannot remove autogenerated routes`)
+    }
+    await query(
+      sqlClientPool,
+      Sql.updateRoute({
+        id: route.id,
+        patch: {
+          environment: null,
+          service: null,
+          pathRoutes: null,
+        }
+      })
+    );
+    return route.id
+  };
+
+  return {
+    removeAllRoutesFromEnvironment,
+    deleteEnvironmentAutogeneratedRoutes,
+    removeRouteFromEnvironment,
+  }
+}
 
 export function addAnnotation(
   annotations: RouteAnnotations,
@@ -30,13 +77,6 @@ export function removeAnnotation(
   );
 }
 
-export type PathRoute = {
-    toService: string;
-    path: string;
-};
-
-export type PathRoutes = PathRoute[];
-
 export function addServicePathRoute(
   pathRoutes: PathRoutes,
   newToService: string,