refactor: support for future autogenerated route sources

Author: shreddedbacon

node-packages/commons/src/api.ts

@@ -714,7 +714,7 @@ export async function getEnvironmentByName(
           value
           scope
         }
-        apiRoutes{
+        apiRoutes(source: API){
           domain
           service
           alternativeNames{
@@ -778,7 +778,7 @@ export async function getEnvironmentByIdWithVariables(
           value
           scope
         }
-        apiRoutes{
+        apiRoutes(source: API){
           domain
           service
           alternativeNames{

node-packages/commons/src/tasks.ts

@@ -26,7 +26,7 @@ import {
   deployTargetPullrequest,
   deployTargetPromote
 } from './deploy-tasks';
-import { InternalEnvVariableScope, DeployData, DeployType, RemoveData } from './types';
+import { InternalEnvVariableScope, DeployData, DeployType, RemoveData, RouteSource } from './types';
 // @ts-ignore
 import sha1 from 'sha1';
 import crypto from 'crypto';
@@ -689,9 +689,14 @@ export const getEnvironmentsRouterPatternAndVariables = async function(
   let apiRoutes = environment.apiRoutes
   if (apiRoutes.length > 0) {
     for (let i = 0; i < apiRoutes.length; i++) {
-      // remove any yaml sourced apiRoutes from the list (these don't get send to builds from the api as they are configured by lagoon.yml)
-      if (apiRoutes[i].source == "YAML") {
-        delete apiRoutes[i]
+      // remove any yaml/autogenerated sourced apiRoutes from the list
+      // these don't get send to builds from the api as they are configured by lagoon.yml
+      // or are created by the autogenerated route configuration
+      if ([RouteSource.YAML, RouteSource.AUTOGENERATED].includes(apiRoutes[i].source.toLowerCase())) {
+        // the environment queries have (source: API) on the environments apiRoutes request
+        // this check is just a fallback check
+        apiRoutes.splice(i, 1);
+        i--;
         continue;
       }
       // the structure of annotations in the build-deploy-tool are `map[string]string`

node-packages/commons/src/types.ts

@@ -58,11 +58,16 @@ export enum AuditType {
   FILE = 'file',
 }
 
-
 export enum RouteType {
-    Standard = "standard",
-    Standby = "standby",
-    Active = "active"
+    STANDARD = 'standard',
+    STANDBY = 'standby',
+    ACTIVE = 'active'
+}
+
+export enum RouteSource {
+    API = 'api',
+    YAML = 'yaml',
+    AUTOGENERATED = 'autogenerated'
 }
 
 export interface DeployData {

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

@@ -23,9 +23,8 @@ exports.up = async function(knex) {
             table.integer('hsts_max_age').defaultTo(3153600);
             table.boolean('primary').notNullable().defaultTo(0); // default to false
             table.boolean('disable_request_verification').notNullable().defaultTo(0); // default to false
-            // table.text('annotations');
             table.text('path_routes');
-            table.enu('source', ['api','yaml']).notNullable().defaultTo('api');
+            table.enu('source', ['api','yaml','autogenerated']).notNullable().defaultTo('api');
             table.enu('type', ['standard', 'active', 'standby']).notNullable().defaultTo('standard');
             // table.boolean('wildcard').notNullable().defaultTo(0); // TBD
             // table.boolean('wildcard_apex').notNullable().defaultTo(0); // TBD

services/api/src/resolvers.js

@@ -481,6 +481,7 @@ async function getResolvers() {
     RouteSource: {
       API: 'api',
       YAML: 'yaml',
+      AUTOGENERATED: 'autogenerated',
     },
     RouteType: {
       STANDARD: 'standard',

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

@@ -95,6 +95,11 @@ export const Helpers = (sqlClientPool: Pool) => {
         // remove all route associations from environment
         // but leave the routes in the api attached to the project
         await routeHelpers(sqlClientPool).removeAllRoutesFromEnvironment(eid)
+        // delete any autogenerated routes, these are not reusable and are only associated to the environment they are on
+        await routeHelpers(sqlClientPool).deleteAutogeneratedRoutesForEnvironment(eid)
+        // delete any lagoon.yml managed routes from the api, if they want to manage them in the api
+        // they should be modified in the api to update the source to the api to nullify the lagoon.yml source
+        await routeHelpers(sqlClientPool).deleteLagoonYAMLRoutesForEnvironment(eid)
 
         // delete the environment backups rows
         // logger.debug(`deleting environment ${name}/id:${eid}/project:${pid} environment backups`)

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

@@ -11,6 +11,18 @@ export const Helpers = (sqlClientPool: Pool) => {
       Sql.removeAllRoutesFromEnvironment(environmentId)
     )
   }
+  const deleteAutogeneratedRoutesForEnvironment = async (environmentId: number) => {
+    await query(
+      sqlClientPool,
+      Sql.deleteAutogeneratedRoutesForEnvironment(environmentId)
+    )
+  }
+  const deleteLagoonYAMLRoutesForEnvironment = async (environmentId: number) => {
+    await query(
+      sqlClientPool,
+      Sql.deleteLagoonYAMLRoutesForEnvironment(environmentId)
+    )
+  }
   const removeRouteFromEnvironment = async (domain: string, environmentId: number) => {
     const routes = await query(
       sqlClientPool,
@@ -73,6 +85,8 @@ export const Helpers = (sqlClientPool: Pool) => {
 
   return {
     removeAllRoutesFromEnvironment,
+    deleteAutogeneratedRoutesForEnvironment,
+    deleteLagoonYAMLRoutesForEnvironment,
     removeRouteFromEnvironment,
     addRouteAnnotation,
     addRouteAnnotations,