refactor: trim domains for spaces

Author: shreddedbacon

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

@@ -29,8 +29,7 @@ export const Helpers = (sqlClientPool: Pool) => {
       Sql.selectRoutesByDomainAndEnvironmentID(domain, environmentId)
     )
     if (routes.length == 0) {
-      logger.error(`Route doesn't exist on this environment`)
-      return null
+      throw new Error(`Route doesn't exist on this environment`);
     }
     const route = routes[0]
     await query(

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

@@ -12,8 +12,10 @@ import { isDNS1123Subdomain } from '../../util/func';
 import { AuditType, RouteSource, RouteType } from '@lagoon/commons/dist/types';
 import { logger } from '../../loggers/logger';
 
+// check array for duplicates that are trimmed and lowercased
 function hasDuplicates(arr) {
-  return new Set(arr).size !== arr.length;
+  const normalized = arr.map(item => item.trim().toLowerCase());
+  return new Set(normalized).size !== normalized.length;
 }
 
 /*
@@ -55,6 +57,9 @@ export const addRouteToProject: ResolverFn = async (
     project: projectId
   });
 
+  // trim spaces from domain name
+  const domainName = domain.trim()
+
   let environmentData;
   let environmentId = null;
   // let environmentServices;
@@ -68,11 +73,11 @@ export const addRouteToProject: ResolverFn = async (
   // check the route doesn't already exist in this project as either a top level route, or an alternative domain on another route
   const exists = await query(
     sqlClientPool,
-    Sql.selectRouteByDomainAndProjectID(domain, projectId)
+    Sql.selectRouteByDomainAndProjectID(domainName, projectId)
   )
   const exists2 = await query(
     sqlClientPool,
-    Sql.selectRouteAlternativeDomainsByDomainAndProjectID(domain, projectId)
+    Sql.selectRouteAlternativeDomainsByDomainAndProjectID(domainName, projectId)
   )
 
   // fail if the route already exists somewhere in the project
@@ -81,8 +86,8 @@ export const addRouteToProject: ResolverFn = async (
   }
 
   // check if the domain is valid dns subdomain
-  if (!isDNS1123Subdomain(domain)) {
-    throw Error(`'${domain}' is not a valid domain`)
+  if (!isDNS1123Subdomain(domainName)) {
+    throw Error(`'${domainName}' is not a valid domain`)
   }
 
   if (environment && !service) {
@@ -104,7 +109,9 @@ export const addRouteToProject: ResolverFn = async (
   // fail if the domain is provided more than once
   if (alternativeNames !== undefined) {
     for (const d of alternativeNames) {
-      if (d == domain) {
+      // trim spaces from the alternate domain as part of comparison check
+      const altDomain = d.trim()
+      if (altDomain == domainName) {
         throw Error(`Main domain included in alternate domains`)
       }
     }
@@ -168,7 +175,7 @@ export const addRouteToProject: ResolverFn = async (
     sqlClientPool,
     Sql.insertRoute({
       id,
-      domain,
+      domain: domainName,
       project: projectId,
       environment: environmentId,
       service,
@@ -197,11 +204,13 @@ export const addRouteToProject: ResolverFn = async (
   // add the alternate domains
   if (alternativeNames !== undefined) {
     for (const d of alternativeNames) {
+      // trim spaces from domain name
+      const altDomain = d.trim()
       await query(
         sqlClientPool,
         Sql.insertRouteAlternativeDomain({
           rid: insertId,
-          domain: d,
+          domain: altDomain,
         })
       );
     }
@@ -277,7 +286,7 @@ export const updateRouteOnProject: ResolverFn = async (
           break;
         }
         // otherwise reject the update
-        throw Error(`Cannot update lagoon yaml managed routes`)
+        throw Error(`Cannot update route managed by lagoon.yml`)
       case RouteSource.AUTOGENERATED:
         // reject update from general users
         throw Error(`Cannot update autogenerated routes`)
@@ -566,6 +575,13 @@ export const removeRouteFromEnvironment: ResolverFn = async (
   const ret = await query(sqlClientPool, Sql.selectRouteByID(routeId));
   const route = ret[0];
 
+  if (route.source.toLowerCase() === RouteSource.YAML) {
+    throw Error(`This route cannot be removed from the environment as it is managed by a lagoon.yml file`)
+  }
+  if (route.source.toLowerCase() === RouteSource.AUTOGENERATED) {
+    throw Error(`Cannot remove autogenerated routes from an environment using this endpoint`)
+  }
+
   const auditLog: AuditLog = {
     resource: {
       id: projectData.id.toString(),
@@ -644,7 +660,7 @@ export const addRouteAlternativeDomains: ResolverFn = async (
       )
       // if the domains provided don't already exist, then add them
       if (exists.length > 0 || exists2.length > 0) {
-        throw Error(`Route exists in this project already`)
+        throw Error(`Route already exists in this project`)
       }
       // check if the domain is valid dns subdomain
       if (!isDNS1123Subdomain(d)) {
@@ -1039,7 +1055,7 @@ export const deleteRoute: ResolverFn = async (
       throw new Error(`Cannot delete autogenerated routes, you must modify the project or environment autogenerated route configuration`);
     }
     if (route.source.toLowerCase() == RouteSource.YAML) {
-      throw new Error(`Cannot delete routes that are managed by lagoon.yml, either modify the route in the api or delete it from the lagoon.yml file.`);
+      throw new Error(`Cannot delete routes that are managed by a lagoon.yml file, either modify the route in the api or delete it from the lagoon.yml file.`);
     }
   }
   // @TODO: do we want to block deletion of routes if they are attached to an environment?