feat(refactor): dedicated autogenrated route configuration resolvers

Author: shreddedbacon

node-packages/commons/src/api.ts

@@ -44,11 +44,25 @@ export interface Project {
   storageCalc: number;
   subfolder: string;
   apiRoutes: any[];
-  autogeneratedRoutes: boolean;
-  autogeneratedRoutesPullrequests: boolean;
-  autogeneratedRoutePrefixes: string[]
-  autogeneratedPathRoutes: any[]
+  autogeneratedRouteConfig: AutogeneratedRouteConfig;
+}
+
+export interface AutogeneratedRouteConfig {
+  updated: string;
+  pathRoutes: AutogeneratedPathRoutes[];
   disableRequestVerification: boolean;
+  enabled?: boolean;
+  allowPullRequests?: boolean;
+  insecure?: string;
+  prefixes?: string[];
+  tlsAcme?: boolean;
+  // ingressClass?: string;
+}
+
+export interface AutogeneratedPathRoutes {
+  toService: string;
+  fromService: string;
+  path: string;
 }
 
 export interface Kubernetes {
@@ -715,6 +729,23 @@ fragment on Route {
 }
 `);
 
+const autogeneratedRouteConfigFragment = graphqlapi.createFragment(`
+fragment on AutogeneratedRouteConfig {
+  updated
+  enabled
+  allowPullRequests
+  prefixes
+  tlsAcme
+  insecure
+  pathRoutes {
+    toService
+    fromService
+    path
+  }
+  disableRequestVerification
+}
+`);
+
 export async function getEnvironmentByName(
   name: string,
   projectId: number,
@@ -745,13 +776,9 @@ export async function getEnvironmentByName(
         apiRoutes(source: API){
           ...${apiRouteFragment}
         }
-        autogeneratedRoutes
-        autogeneratedPathRoutes {
-          toService
-          fromService
-          path
+        autogeneratedRouteConfig {
+          ...${autogeneratedRouteConfigFragment}
         }
-        disableRequestVerification
       }
     }
   `);
@@ -788,13 +815,9 @@ export async function getEnvironmentByIdWithVariables(
         apiRoutes(source: API){
           ...${apiRouteFragment}
         }
-        autogeneratedRoutes
-        autogeneratedPathRoutes {
-          toService
-          fromService
-          path
+        autogeneratedRouteConfig {
+          ...${autogeneratedRouteConfigFragment}
         }
-        disableRequestVerification
       }
     }
   `);
@@ -909,11 +932,7 @@ interface GetOpenshiftInfoForProjectResult {
     | 'storageCalc'
     | 'subfolder'
     | 'apiRoutes'
-    | 'autogeneratedRoutes'
-    | 'autogeneratedRoutesPullrequests'
-    | 'autogeneratedRoutePrefixes'
-    | 'autogeneratedPathRoutes'
-    | 'disableRequestVerification'
+    | 'autogeneratedRouteConfig'
   > & {
     openshift: Pick<Kubernetes, keyof DeployTargetMinimalFragment>;
     envVariables: Pick<EnvKeyValue, 'name' | 'scope' | 'value'>[];
@@ -956,15 +975,9 @@ export const getOpenShiftInfoForProject = (project: string): Promise<GetOpenshif
         apiRoutes{
           domain
         }
-        autogeneratedRoutes
-        autogeneratedRoutesPullrequests
-        autogeneratedRoutePrefixes
-        autogeneratedPathRoutes {
-          toService
-          fromService
-          path
+        autogeneratedRouteConfig {
+          ...${autogeneratedRouteConfigFragment}
         }
-        disableRequestVerification
       }
     }
 `);

node-packages/commons/src/tasks.ts

@@ -20,6 +20,7 @@ import {
   addDeployment,
   getOrganizationByIdWithEnvs,
   getOrganizationById,
+  AutogeneratedRouteConfig,
 } from './api';
 import {
   deployTargetBranches,
@@ -53,30 +54,6 @@ interface DeathHandler {
   (msg: ConsumeMessage, error: Error): void;
 }
 
-interface AutogeneratedRouteConfiguration {
-  autogenerate?: {
-    enabled?: boolean;
-    allowPullRequests?: boolean;
-    insecure?: string;
-    prefixes?: string[];
-    'tls-acme'?: boolean;
-    ingressClass?: string;
-    disableRequestVerification?: boolean;
-    pathRoutes?: AutogeneratePathRoute[];
-  };
-  environment?: {
-    autogenerateRoutes?: boolean
-    autogeneratePathRoutes?: AutogeneratePathRoute[];
-    disableRequestVerification?: boolean;
-  }
-}
-
-interface AutogeneratePathRoute {
-    toService: string;
-    path: string;
-    fromService: string;
-}
-
 export let sendToLagoonTasks = function(
   task: string,
   payload?: any
@@ -653,22 +630,16 @@ export const getEnvironmentsRouterPatternAndVariables = async function(
     'routerPattern' |
     'sharedBaasBucket' |
     'organization' |
-    'autogeneratedRoutes' |
-    'autogeneratedRoutesPullrequests' |
-    'autogeneratedRoutePrefixes' |
-    'autogeneratedPathRoutes' |
-    'disableRequestVerification' |
-    'apiRoutes'
+    'apiRoutes' |
+    'autogeneratedRouteConfig'
   > & {
     openshift: Pick<Kubernetes, 'routerPattern'>;
     envVariables: Pick<EnvKeyValue, 'name' | 'value' | 'scope'>[];
   },
   environment: {
     envVariables: Pick<EnvKeyValue, 'name' | 'value' | 'scope'>[]
     apiRoutes,
-    autogeneratedRoutes
-    autogeneratedPathRoutes
-    disableRequestVerification
+    autogeneratedRouteConfig,
   },
   deployTarget: Pick<Kubernetes, 'name' | 'routerPattern' | 'sharedBaasBucketName'>,
   bulkId: string | null,
@@ -718,37 +689,13 @@ export const getEnvironmentsRouterPatternAndVariables = async function(
     on the project or environment are set, this then gets setup in the required format
     and base64 encoded before being sent to the build, it is decoded there
   */
-  let agPayload: AutogeneratedRouteConfiguration = {
-    autogenerate: {},
-    environment: {},
-  }
-  if (project.autogeneratedRoutes !== null) {
-    agPayload.autogenerate.enabled = project.autogeneratedRoutes
+  let agPayload = {}
+  if (project.autogeneratedRouteConfig !== null) {
+    agPayload = project.autogeneratedRouteConfig
   }
-  if (project.autogeneratedRoutesPullrequests !== null) {
-    agPayload.autogenerate.allowPullRequests = project.autogeneratedRoutesPullrequests
+  if (environment.autogeneratedRouteConfig !== null) {
+    agPayload = environment.autogeneratedRouteConfig
   }
-  if (project.autogeneratedRoutePrefixes) {
-    agPayload.autogenerate.prefixes = project.autogeneratedRoutePrefixes
-  }
-  if (project.autogeneratedPathRoutes.length > 0) {
-    agPayload.autogenerate.pathRoutes = project.autogeneratedPathRoutes
-  }
-  if (project.disableRequestVerification !== null) {
-    agPayload.autogenerate.disableRequestVerification = project.disableRequestVerification
-  }
-  if (environment.autogeneratedRoutes !== null) {
-    agPayload.environment.autogenerateRoutes = environment.autogeneratedRoutes
-  }
-  if (environment.autogeneratedPathRoutes.length > 0) {
-    agPayload.environment.autogeneratePathRoutes = environment.autogeneratedPathRoutes
-  }
-  if (environment.disableRequestVerification !== null) {
-    // environment doesn't have a direct override for request validation disable, but as this is applied to a build
-    // we can just set the one that would apply normally to the project
-    agPayload.autogenerate.disableRequestVerification = environment.disableRequestVerification
-  }
-
   // Single list of env vars that apply to an environment. Env vars from multiple
   // sources (organization, project, enviornment, build vars, etc) are
   // consolidated based on precedence.
@@ -835,7 +782,7 @@ export const getEnvironmentsRouterPatternAndVariables = async function(
       scope: InternalEnvVariableScope.INTERNAL_SYSTEM
     });
   }
-  if (Object.keys(agPayload.autogenerate).length || Object.keys(agPayload.environment).length) {
+  if (Object.keys(agPayload).length) {
     // if there is any autogenerated route configuration to send
     // set that here
     // @TODO: need to figure out a better way to handle the default autogenerate insecure handling

services/api/database/migrations/20250925000000_routes.js renamed to services/api/database/migrations/20251030000000_routes.js

@@ -42,22 +42,24 @@ exports.up = async function(knex) {
         })
         .createTable('routes_annotations', function (table) {
             table.increments('id').notNullable().primary();
-            table.integer('route_id'); //route id
+            table.integer('route_id');
             table.string('key', 63).notNullable();
             table.text('value');
             table.unique(['key', 'route_id'], {indexName: 'alternate_domain_route'});
         })
-        .alterTable('environment', (table) => {
-            table.boolean('autogenerated_routes'); // default to null to effectively retain lagoon.yml as the source, would override lagoon.yml if defined
-            table.text('autogenerated_path_routes') // would be JSON equivalent of what is in lagoon.yml, would override lagoon.yml if defined
-            table.boolean('disable_request_verification'); // default to null to retain lagoon.yml as the source, would override lagoon.yml if defined
-        })
-        .alterTable('project', (table) => {
-            table.boolean('autogenerated_routes'); // default to null to retain lagoon.yml as the source, would override lagoon.yml if defined
-            table.boolean('autogenerated_routes_pullrequests'); // default to null to retain lagoon.yml as the source, would override lagoon.yml if defined
-            table.text('autogenerated_route_prefixes') // would be comma separated list of prefixes representing what is in the .lagoon.yml, would override lagoon.yml if defined
-            table.text('autogenerated_path_routes') // would be JSON equivalent of what is in lagoon.yml, would override lagoon.yml if defined
-            table.boolean('disable_request_verification'); // default to null to retain lagoon.yml as the source, would override lagoon.yml if defined
+        .createTable('routes_autogenerated_configuration', (table) => {
+            table.increments('id').notNullable().primary();
+            table.enu('type', ['project', 'environment']);
+            table.integer('type_id');
+            table.timestamp('updated').notNullable().defaultTo(knex.fn.now());
+            table.boolean('enabled').notNullable().defaultTo(1); // default to true
+            table.boolean('allow_pull_requests').notNullable().defaultTo(1); // default to true
+            table.boolean('tls_acme').notNullable().defaultTo(1); // default to true
+            table.enu('insecure', ['Allow', 'Redirect', 'None']).notNullable().defaultTo('Redirect');
+            table.text('prefixes') // would be comma separated list of prefixes representing what is in the .lagoon.yml, would override lagoon.yml if defined
+            table.text('path_routes') // would be JSON equivalent of what is in lagoon.yml, would override lagoon.yml if defined
+            table.boolean('disable_request_verification').notNullable().defaultTo(0); // default to false
+            table.unique(['type', 'type_id'], {indexName: 'autogenerated_route_config_type'});
         })
         .alterTable('organization', function (table) {
             table.boolean('feature_api_routes').defaultTo(0); // disable api routes feature by default, future release of lagoon will remove this when routes api becomes generally available
@@ -77,18 +79,7 @@ exports.down = async function(knex) {
     .dropTable('routes')
     .dropTable('routes_alternate_domain')
     .dropTable('routes_annotations')
-    .alterTable('environment', (table) => {
-        table.dropColumn('autogenerated_routes');
-        table.dropColumn('autogenerated_path_routes');
-        table.dropColumn('disable_request_verification');
-    });
-    .alterTable('project', (table) => {
-        table.dropColumn('autogenerated_routes');
-        table.dropColumn('autogenerated_routes_pullrequests');
-        table.dropColumn('autogenerated_route_prefixes');
-        table.dropColumn('autogenerated_path_routes');
-        table.dropColumn('disable_request_verification');
-    });
+    .dropTable('routes_autogenerated_configuration')
     .alterTable('organization', (table) => {
         table.dropColumn('feature_api_routes');
     });

services/api/src/resolvers.js

@@ -127,7 +127,6 @@ const {
   getEnvironmentByServiceId,
   getServiceContainersByServiceId,
   deleteEnvironmentService,
-  getAutogeneratedPathRoutes
 } = require('./resources/environment/resolvers');
 
 const {
@@ -196,7 +195,6 @@ const {
   removeProjectMetadataByKey,
   getPrivateKey,
   getProjectDeployKey,
-  getAutogeneratedRoutePrefixes,
   getFeatureApiRoutes
 } = require('./resources/project/resolvers');
 
@@ -335,6 +333,14 @@ const {
   activeStandbyRouteMove,
   removeRouteFromEnvironment,
   updateRouteOnProject,
+  getAutogeneratedRouteConfigByProjectId,
+  getAutogeneratedRouteConfigByEnvironmentId,
+  getAutogeneratedRoutePrefixes,
+  getAutogeneratedPathRoutes,
+  updateAutogeneratedRouteConfigOnProject,
+  updateAutogeneratedRouteConfigOnEnvironment,
+  removeAutogeneratedRouteConfigFromProject,
+  removeAutogeneratedRouteConfigFromEnvironment,
 } = require('./resources/routes/resolvers');
 
 async function getResolvers() {
@@ -523,10 +529,13 @@ async function getResolvers() {
       organizationDetails: getOrganizationByProject,
       retentionPolicies: getRetentionPoliciesByProjectId,
       apiRoutes: getRoutesByProjectId,
-      autogeneratedRoutePrefixes: getAutogeneratedRoutePrefixes,
-      autogeneratedPathRoutes: getAutogeneratedPathRoutes,
+      autogeneratedRouteConfig: getAutogeneratedRouteConfigByProjectId,
       featureApiRoutes: getFeatureApiRoutes,
     },
+    AutogeneratedRouteConfig: {
+      prefixes: getAutogeneratedRoutePrefixes,
+      pathRoutes: getAutogeneratedPathRoutes,
+    },
     GroupInterface: {
       __resolveType(group) {
         return 'Group';
@@ -570,7 +579,7 @@ async function getResolvers() {
       kubernetes: getOpenshiftByEnvironmentId,
       pendingChanges: getPendingChangesByEnvironmentId,
       apiRoutes: getRoutesByEnvironmentId,
-      autogeneratedPathRoutes: getAutogeneratedPathRoutes,
+      autogeneratedRouteConfig: getAutogeneratedRouteConfigByEnvironmentId,
     },
     Route: {
       alternativeNames: getAlternateRoutesByRouteId,
@@ -880,6 +889,10 @@ async function getResolvers() {
     removeRouteAnnotation,
     addPathRoutesToRoute,
     removePathRouteFromRoute,
+    updateAutogeneratedRouteConfigOnProject,
+    updateAutogeneratedRouteConfigOnEnvironment,
+    removeAutogeneratedRouteConfigFromProject,
+    removeAutogeneratedRouteConfigFromEnvironment,
   },
   Subscription: {
     backupChanged: backupSubscriber,

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

@@ -100,6 +100,8 @@ export const Helpers = (sqlClientPool: Pool) => {
         await routeHelpers(sqlClientPool).deleteLagoonYAMLRoutesForEnvironment(eid)
         // but leave the routes in the api attached to the project
         await routeHelpers(sqlClientPool).removeAllRoutesFromEnvironment(eid)
+        // delete any autogenerated route configuration for this environment
+        await routeHelpers(sqlClientPool).deleteAutogeneratedRouteConfigForEnvironment(eid);
 
         // delete the environment backups rows
         // logger.debug(`deleting environment ${name}/id:${eid}/project:${pid} environment backups`)