Merge pull request #3990 from uselagoon/api-defined-routes

feat: support for routes defined in the api

Author: rocketeerbkw

Jenkinsfile

@@ -121,7 +121,7 @@ pipeline {
       parallel {
         stage ('1: run first test suite') {
           steps {
-            sh script: "make -j$NPROC k3d/retest TESTS=[api,deploytarget,active-standby-kubernetes,features-kubernetes,features-kubernetes-2,features-variables] BRANCH_NAME=${SAFEBRANCH_NAME}", label: "Running first test suite on k3d cluster"
+            sh script: "make -j$NPROC k3d/retest TESTS=[api,api-routes,deploytarget,active-standby-kubernetes,features-kubernetes,features-kubernetes-2,features-variables] BRANCH_NAME=${SAFEBRANCH_NAME}", label: "Running first test suite on k3d cluster"
             sh script: "pkill -f './local-dev/stern'", label: "Closing off test-suite-1 log after test completion"
           }
         }

Makefile

@@ -462,7 +462,7 @@ JWT_VERSION = 6.2.0
 STERN_VERSION = v2.6.1
 CHART_TESTING_VERSION = v3.11.0
 K3D_IMAGE = docker.io/rancher/k3s:v1.31.1-k3s1
-TESTS = [nginx,api,features-kubernetes,bulk-deployment,features-kubernetes-2,features-variables,active-standby-kubernetes,tasks,drush,python,gitlab,github,bitbucket,services]
+TESTS = [nginx,api,api-routes,features-kubernetes,bulk-deployment,features-kubernetes-2,features-variables,active-standby-kubernetes,tasks,drush,python,gitlab,github,bitbucket,services]
 CHARTS_TREEISH = main
 CHARTS_REPOSITORY = https://github.com/uselagoon/lagoon-charts.git
 #CHARTS_REPOSITORY = ../lagoon-charts

node-packages/commons/src/api.ts

@@ -43,6 +43,26 @@ export interface Project {
   standbyRoutes: string;
   storageCalc: number;
   subfolder: string;
+  apiRoutes: 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 {
@@ -681,6 +701,51 @@ export const allProjectsInGroup = (groupInput: {
     }
   );
 
+
+const apiRouteFragment = graphqlapi.createFragment(`
+fragment on Route {
+  domain
+  service
+  alternativeNames{
+    domain
+  }
+  annotations{
+    key
+    value
+  }
+  pathRoutes{
+    toService
+    path
+  }
+  tlsAcme
+  insecure
+  hstsEnabled
+  hstsIncludeSubdomains
+  hstsPreload
+  hstsMaxAge
+  primary
+  source
+  type
+}
+`);
+
+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,
@@ -697,9 +762,23 @@ export async function getEnvironmentByName(
         autoIdle,
         environmentType,
         openshiftProjectName,
+        openshift {
+          ...${deployTargetMinimalFragment}
+        }
         updated,
         created,
         deleted,
+        envVariables {
+          name
+          value
+          scope
+        }
+        apiRoutes(source: API){
+          ...${apiRouteFragment}
+        }
+        autogeneratedRouteConfig {
+          ...${autogeneratedRouteConfigFragment}
+        }
       }
     }
   `);
@@ -733,6 +812,12 @@ export async function getEnvironmentByIdWithVariables(
           value
           scope
         }
+        apiRoutes(source: API){
+          ...${apiRouteFragment}
+        }
+        autogeneratedRouteConfig {
+          ...${autogeneratedRouteConfigFragment}
+        }
       }
     }
   `);
@@ -846,6 +931,8 @@ interface GetOpenshiftInfoForProjectResult {
     | 'standbyRoutes'
     | 'storageCalc'
     | 'subfolder'
+    | 'apiRoutes'
+    | 'autogeneratedRouteConfig'
   > & {
     openshift: Pick<Kubernetes, keyof DeployTargetMinimalFragment>;
     envVariables: Pick<EnvKeyValue, 'name' | 'scope' | 'value'>[];
@@ -885,6 +972,12 @@ export const getOpenShiftInfoForProject = (project: string): Promise<GetOpenshif
         standbyRoutes
         storageCalc
         subfolder
+        apiRoutes{
+          domain
+        }
+        autogeneratedRouteConfig {
+          ...${autogeneratedRouteConfigFragment}
+        }
       }
     }
 `);

node-packages/commons/src/tasks.ts

@@ -20,13 +20,14 @@ import {
   addDeployment,
   getOrganizationByIdWithEnvs,
   getOrganizationById,
+  AutogeneratedRouteConfig,
 } from './api';
 import {
   deployTargetBranches,
   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';
@@ -528,11 +529,10 @@ export const getControllerBuildData = async function(deployTarget: any, deployDa
   }
 
   let deployment;
-  let environmentId;
+  const now = moment.utc();
+  const apiEnvironment = await getEnvironmentByName(branchName, lagoonProjectData.id, false);
+  const environmentId = apiEnvironment.environmentByName.id
   try {
-    const now = moment.utc();
-    const apiEnvironment = await getEnvironmentByName(branchName, lagoonProjectData.id, false);
-    environmentId = apiEnvironment.environmentByName.id
     deployment = await addDeployment(buildName,
       "NEW",
       now.format('YYYY-MM-DDTHH:mm:ss'),
@@ -551,10 +551,10 @@ export const getControllerBuildData = async function(deployTarget: any, deployDa
   // encode some values so they get sent to the controllers nicely
   const { routerPattern, appliedEnvVars: envVars } = await getEnvironmentsRouterPatternAndVariables(
     lagoonProjectData,
-    environment.addOrUpdateEnvironment,
+    apiEnvironment.environmentByName,
     deployTarget.openshift,
     bulkId || null, bulkName || null, priority, buildVariables,
-    bulkType.Deploy
+    bulkType.Deploy,
   )
 
   let organization: any = null;
@@ -627,23 +627,75 @@ enum bulkType {
 export const getEnvironmentsRouterPatternAndVariables = async function(
   project: Pick<
     Project,
-    'routerPattern' | 'sharedBaasBucket' | 'organization'
+    'routerPattern' |
+    'sharedBaasBucket' |
+    'organization' |
+    'apiRoutes' |
+    'autogeneratedRouteConfig'
   > & {
     openshift: Pick<Kubernetes, 'routerPattern'>;
     envVariables: Pick<EnvKeyValue, 'name' | 'value' | 'scope'>[];
   },
-  environment: { envVariables: Pick<EnvKeyValue, 'name' | 'value' | 'scope'>[]},
+  environment: {
+    envVariables: Pick<EnvKeyValue, 'name' | 'value' | 'scope'>[]
+    apiRoutes,
+    autogeneratedRouteConfig,
+  },
   deployTarget: Pick<Kubernetes, 'name' | 'routerPattern' | 'sharedBaasBucketName'>,
   bulkId: string | null,
   bulkName: string | null,
   buildPriority: number,
   buildVariables: Array<{name: string, value: string}>,
-  bulkTask: bulkType
+  bulkTask: bulkType,
 ): Promise<{ routerPattern: string, appliedEnvVars: string }> {
   type EnvKeyValueInternal = Pick<EnvKeyValue, 'name' | 'value'> & {
     scope: EnvVariableScope | InternalEnvVariableScope;
   }
 
+  /*
+    prepares the values to send to builds and tasks for consumption
+    this ensures the data is structured to match the one that the build expects when it receives the payload
+    this gets based64 encoded before being shipped. it is decoded during the build
+  */
+  let apiRoutes = environment.apiRoutes
+  if (apiRoutes.length > 0) {
+    for (let i = 0; i < apiRoutes.length; 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`
+      // 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
+    }
+  }
+
+  /*
+    this handles creating the autogenerated route configuration if any autogenerated route settings
+    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 = {}
+  if (project.autogeneratedRouteConfig !== null) {
+    agPayload = project.autogeneratedRouteConfig
+  }
+  if (environment.autogeneratedRouteConfig !== null) {
+    agPayload = environment.autogeneratedRouteConfig
+  }
   // 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.
@@ -711,6 +763,37 @@ 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.length > 0) {
+    applyIfNotExists({
+      name: "LAGOON_API_ROUTES",
+      value: encodeJSONBase64({routes: apiRoutes}),
+      scope: InternalEnvVariableScope.INTERNAL_SYSTEM
+    });
+  }
+  if (project.apiRoutes.length > 0) {
+    // if the project has any apiroutes defined, then we enforce cleanup of removed routes on any environments
+    applyIfNotExists({
+      name: "LAGOON_API_ROUTES_CLEANUP",
+      value: "true",
+      scope: InternalEnvVariableScope.INTERNAL_SYSTEM
+    });
+  }
+  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
+    // agPayload.autogenerate.insecure = "Redirect"
+    applyIfNotExists({
+      name: "LAGOON_API_AUTOGENERATED_CONFIG",
+      value: encodeJSONBase64(agPayload),
+      scope: InternalEnvVariableScope.INTERNAL_SYSTEM
+    });
+  }
+
   /*
    * Normally scoped env vars.
    *
@@ -1076,7 +1159,7 @@ 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
   )
   return appliedEnvVars
 }

node-packages/commons/src/types.ts

@@ -58,6 +58,18 @@ export enum AuditType {
   FILE = 'file',
 }
 
+export enum RouteType {
+    STANDARD = 'standard',
+    STANDBY = 'standby',
+    ACTIVE = 'active'
+}
+
+export enum RouteSource {
+    API = 'api',
+    YAML = 'yaml',
+    AUTOGENERATED = 'autogenerated'
+}
+
 export interface DeployData {
   baseBranchName?: string,
   baseSha?: string,