feat: support for routes defined in the api

Author: shreddedbacon

node-packages/commons/src/api.ts

@@ -700,6 +700,31 @@ export async function getEnvironmentByName(
         updated,
         created,
         deleted,
+        apiRoutes{
+          domain
+          service
+          alternativeNames{
+            domain
+          }
+          annotations{
+            key
+            value
+          }
+          pathRoutes{
+            toService
+            path
+          }
+          tlsAcme
+          insecure
+          ingressClass
+          hstsEnabled
+          hstsIncludeSubdomains
+          hstsPreload
+          hstsMaxAge
+          autogenerated
+          primary
+          source
+        }
       }
     }
   `);

node-packages/commons/src/tasks.ts

@@ -529,6 +529,7 @@ export const getControllerBuildData = async function(deployTarget: any, deployDa
 
   let deployment;
   let environmentId;
+  let apiRoutes;
   try {
     const now = moment.utc();
     const apiEnvironment = await getEnvironmentByName(branchName, lagoonProjectData.id, false);
@@ -544,6 +545,29 @@ export const getControllerBuildData = async function(deployTarget: any, deployDa
       sourceUser,
       sourceType,
     );
+
+    // get apiRoutes for the environment if any
+    apiRoutes = apiEnvironment.environmentByName.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]
+          continue;
+        }
+        // the structure of annotations in the build-deploy-tool are `map[string]string`
+        // this converts the `key:value` type from the api to `map[string]string` for the build-deploy-tool to consume
+        let annotations = apiRoutes[i].annotations.reduce((acc, item) => {
+          acc[item.key] = item.value;
+          return acc;
+        }, {});
+        apiRoutes[i].annotations = annotations
+        // the structure of alternativeNames in the build-deploy-tool are `[]string`
+        // this converts to that type for the build-deploy-tool to consume
+        let alternativeNames = apiRoutes[i].alternativeNames.map(item => item.domain);
+        apiRoutes[i].alternativeNames = alternativeNames
+      }
+    }
   } catch (error) {
     logger.error(`Could not save deployment for project ${lagoonProjectData.id}. Message: ${error}`);
   }
@@ -554,7 +578,7 @@ export const getControllerBuildData = async function(deployTarget: any, deployDa
     environment.addOrUpdateEnvironment,
     deployTarget.openshift,
     bulkId || null, bulkName || null, priority, buildVariables,
-    bulkType.Deploy
+    bulkType.Deploy, apiRoutes
   )
 
   let organization: any = null;
@@ -638,7 +662,8 @@ export const getEnvironmentsRouterPatternAndVariables = async function(
   bulkName: string | null,
   buildPriority: number,
   buildVariables: Array<{name: string, value: string}>,
-  bulkTask: bulkType
+  bulkTask: bulkType,
+  apiRoutes: any
 ): Promise<{ routerPattern: string, appliedEnvVars: string }> {
   type EnvKeyValueInternal = Pick<EnvKeyValue, 'name' | 'value'> & {
     scope: EnvVariableScope | InternalEnvVariableScope;
@@ -711,6 +736,19 @@ export const getEnvironmentsRouterPatternAndVariables = async function(
     });
   }
 
+  // `LAGOON_API_ROUTES` is the successor to LAGOON_ROUTES_JSON. the build-deploy-tool will
+  // check if `LAGOON_ROUTES_JSON` is defined, then that will be used to prevent breaking deployments
+  // but will produce a build warning indicating that LAGOON_ROUTES_JSON will be deprecated in the future
+  // and to use API defined routes instead
+  if (apiRoutes) {
+    applyIfNotExists({
+      name: "LAGOON_API_ROUTES",
+      value: encodeJSONBase64({routes: apiRoutes}),
+      scope: InternalEnvVariableScope.INTERNAL_SYSTEM
+    });
+
+  }
+
   /*
    * Normally scoped env vars.
    *
@@ -1076,7 +1114,8 @@ export const getTaskProjectEnvironmentVariables = async (projectName: string, en
     result.project,
     environment.environmentById,
     environment.environmentById.openshift,
-    null, null, priority, [], bulkType.Task // bulk deployments don't apply to tasks yet, but this is future proofing the function call
+    null, null, priority, [], bulkType.Task, // bulk deployments don't apply to tasks yet, but this is future proofing the function call
+    null
   )
   return appliedEnvVars
 }

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

@@ -0,0 +1,54 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = async function(knex) {
+    route = await knex.schema.hasTable('routes');
+    if (!route) {
+        return knex.schema
+        .createTable('routes', function (table) {
+            table.increments('id').notNullable().primary();
+            table.string('domain', 300).notNullable();
+            table.integer('project').notNullable();
+            table.integer('environment');
+            table.string('service', 300);
+            table.boolean('tls_acme').notNullable().defaultTo(1);
+            table.enu('insecure', ['Allow', 'Redirect', 'None']).notNullable().defaultTo('Redirect');
+            // table.string('ingress_class', 300);
+            table.text('annotations');
+            table.text('path_routes');
+            table.string('monitoring_path', 300);
+            table.boolean('hsts_enabled').notNullable().defaultTo(0);
+            table.boolean('hsts_include_subdomains').notNullable().defaultTo(0);
+            table.boolean('hsts_preload').notNullable().defaultTo(0);
+            table.integer('hsts_max_age').defaultTo(3153600);
+            table.boolean('autogenerated').notNullable().defaultTo(0);
+            table.boolean('primary').notNullable().defaultTo(0);
+            table.boolean('wildcard').notNullable().defaultTo(0);
+            table.boolean('wildcard_apex').notNullable().defaultTo(0);
+            table.boolean('disable_request_verification').notNullable().defaultTo(0);
+            table.enu('verified', ['new','pending', 'running', 'error', 'verfied']).notNullable().defaultTo('new');
+            table.json('verification').defaultTo('{}');
+            table.enu('source', ['api','yaml']).notNullable().defaultTo('api');
+            table.unique(['domain', 'project'], {indexName: 'route_project'});
+        })
+        .createTable('routes_alternate_domain', function (table) {
+            table.increments('id').notNullable().primary();
+            table.integer('rid');
+            table.string('domain', 300).notNullable();
+            table.json('verification').defaultTo('{}');
+            table.unique(['domain', 'rid'], {indexName: 'alternate_domain_route'});
+        })
+    }
+    else {
+        return knex.schema
+    }
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = async function(knex) {
+    return knex.schema
+};

services/api/src/resolvers.js

@@ -310,6 +310,22 @@ const {
   getEnvVariablesByProjectEnvironmentName,
 } = require('./resources/env-variables/resolvers');
 
+const {
+  addRoute,
+  deleteRoute,
+  getRoutesByProjectId,
+  getRoutesByEnvironmentId,
+  getAlternateRoutesByRouteId,
+  getRouteAnnotationsByRouteId,
+  getPathRoutesByRouteId,
+  addRouteAlternativeDomains,
+  removeRouteAlternativeDomain,
+  addRouteAnnotation,
+  removeRouteAnnotation,
+  addPathRoutesToRoute,
+  removePathRouteFromRoute,
+} = require('./resources/routes/resolvers');
+
 async function getResolvers() {
   let graphqlUpload;
   try {
@@ -456,6 +472,15 @@ async function getResolvers() {
       HARBOR: 'harbor',
       HISTORY: 'history',
     },
+    RouteSource: {
+      API: 'api',
+      YAML: 'yaml',
+    },
+    RouteInsecure: {
+      ALLOW: 'Allow',
+      REDIRECT: 'Redirect',
+      NONE: 'None',
+    },
     Openshift: {
       projectUser: getProjectUser,
       token: getToken,
@@ -480,6 +505,7 @@ async function getResolvers() {
       publicKey: getProjectDeployKey,
       organizationDetails: getOrganizationByProject,
       retentionPolicies: getRetentionPoliciesByProjectId,
+      apiRoutes: getRoutesByProjectId,
     },
     GroupInterface: {
       __resolveType(group) {
@@ -522,6 +548,12 @@ async function getResolvers() {
       facts: getFactsByEnvironmentId,
       openshift: getOpenshiftByEnvironmentId,
       kubernetes: getOpenshiftByEnvironmentId,
+      apiRoutes: getRoutesByEnvironmentId,
+    },
+    Route: {
+      alternativeNames: getAlternateRoutesByRouteId,
+      annotations: getRouteAnnotationsByRouteId,
+      pathRoutes: getPathRoutesByRouteId,
     },
     Organization: {
       groups: getGroupsByOrganizationId,
@@ -812,6 +844,14 @@ async function getResolvers() {
     deleteHistoryRetentionPolicy,
     addHistoryRetentionPolicyLink,
     removeHistoryRetentionPolicyLink,
+    addRoute,
+    addRouteAlternativeDomains,
+    removeRouteAlternativeDomain,
+    deleteRoute,
+    addRouteAnnotation,
+    removeRouteAnnotation,
+    addPathRoutesToRoute,
+    removePathRouteFromRoute,
   },
   Subscription: {
     backupChanged: backupSubscriber,

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

@@ -0,0 +1,64 @@
+export type RouteAnnotation = {
+    key: string;
+    value: string;
+};
+
+export type RouteAnnotations = RouteAnnotation[];
+
+export function addAnnotation(
+  annotations: RouteAnnotations,
+  newKey: string,
+  newValue: string
+): RouteAnnotations {
+  const exists = annotations.some(
+    (a) => a.key === newKey && a.value === newValue
+  );
+
+  if (!exists) {
+    return [...annotations, { key: newKey, value: newValue }];
+  }
+
+  return annotations;
+}
+
+export function removeAnnotation(
+  annotations: RouteAnnotations,
+  targetKey: string,
+): RouteAnnotations {
+  return annotations.filter(
+    (a) => !(a.key === targetKey)
+  );
+}
+
+export type PathRoute = {
+    toService: string;
+    path: string;
+};
+
+export type PathRoutes = PathRoute[];
+
+export function addServicePathRoute(
+  pathRoutes: PathRoutes,
+  newToService: string,
+  newPath: string
+): PathRoutes {
+  const exists = pathRoutes.some(
+    (a) => a.toService === newToService && a.path === newPath
+  );
+
+  if (!exists) {
+    return [...pathRoutes, { toService: newToService, path: newPath }];
+  }
+
+  return pathRoutes;
+}
+
+export function removeServicePathRoute(
+  pathRoutes: PathRoutes,
+  targetToService: string,
+  targetPath: string
+): PathRoutes {
+  return pathRoutes.filter(
+    (a) => !(a.toService === targetToService && a.path === targetPath)
+  );
+}