Merge pull request #10988 from EtherealEngine/project-update-name-fixes

Added a function to clean project names for k8s
EtherealEngine · Aug 16, 2024 · 64f7afd · 64f7afd
2 parents b209f08 + 8742fd4
commit 64f7afd
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 8 deletions.
diff --git a/packages/server-core/src/projects/project/github-helper.ts b/packages/server-core/src/projects/project/github-helper.ts
@@ -63,7 +63,7 @@ import { createExecutorJob } from '../../k8s-job-helper'
 import { getFileKeysRecursive } from '../../media/storageprovider/storageProviderUtils'
 import { getStorageProvider } from '../../media/storageprovider/storageprovider'
 import { useGit } from '../../util/gitHelperFunctions'
-import { getProjectPushJobBody } from './project-helper'
+import { cleanProjectName, getProjectPushJobBody } from './project-helper'
 import { ProjectParams } from './project.class'
 
 // 30 MB. GitHub's documentation says that the blob upload cutoff is 50MB, but in testing, some files that were around
@@ -353,7 +353,7 @@ export const pushProjectToGithub = async (
       returnData: '',
       status: 'pending'
     })
-    const projectJobName = project.name.toLowerCase().replace(/[^a-z0-9-.]/g, '-')
+    const projectJobName = cleanProjectName(project.name)
     const jobBody = await getProjectPushJobBody(app, project, user, reset, newJob.id, commitSHA)
     await app.service(apiJobPath).patch(newJob.id, {
       name: jobBody.metadata!.name

diff --git a/packages/server-core/src/projects/project/project-helper.ts b/packages/server-core/src/projects/project/project-helper.ts
@@ -1042,7 +1042,7 @@ export async function getProjectUpdateJobBody(
     command.push(data.reset.toString())
   }
 
-  const projectJobName = data.name.toLowerCase().replace(/[^a-z0-9-.]/g, '-')
+  const projectJobName = cleanProjectName(data.name)
 
   const labels = {
     'etherealengine/projectUpdater': 'true',
@@ -1090,7 +1090,7 @@ export async function getProjectPushJobBody(
     command.push(storageProviderName)
   }
 
-  const projectJobName = project.name.toLowerCase().replace(/[^a-z0-9-.]/g, '-')
+  const projectJobName = cleanProjectName(project.name)
 
   const labels = {
     'etherealengine/projectPusher': 'true',
@@ -1104,7 +1104,7 @@ export async function getProjectPushJobBody(
 }
 
 export const getCronJobBody = (project: ProjectType, image: string): object => {
-  const projectJobName = project.name.toLowerCase().replace(/[^a-z0-9-.]/g, '-')
+  const projectJobName = cleanProjectName(project.name)
   return {
     metadata: {
       name: `${process.env.RELEASE_NAME}-${projectJobName}-auto-update`,
@@ -1180,7 +1180,7 @@ export async function getDirectoryArchiveJobBody(
     jobId
   ]
 
-  const projectJobName = projectName.toLowerCase().replace(/[^a-z0-9-.]/g, '-')
+  const projectJobName = cleanProjectName(projectName)
 
   const labels = {
     'etherealengine/directoryArchiver': 'true',
@@ -1537,7 +1537,7 @@ export const updateProject = async (
   returned.needsRebuild = typeof data.needsRebuild === 'boolean' ? data.needsRebuild : true
 
   if (returned.name !== projectName)
-    await app.service(projectPath).patch(existingProject!.id, {
+    await app.service(projectPath).patch(returned.id, {
       name: projectName
     })
 
@@ -1858,3 +1858,10 @@ export const uploadLocalProjectToProvider = async (
   const assetsOnly = !fs.existsSync(path.join(projectRootPath, 'xrengine.config.ts'))
   return { files: results.filter((success) => !!success) as string[], assetsOnly }
 }
+
+export const cleanProjectName = (name: string) => {
+  const returned = name.toLowerCase().replace(/[^a-zA-Z0-9-.]/g, '-')
+  if (!/[a-zA-Z0-9]/.test(returned[0])) return cleanProjectName(name.slice(1))
+  if (!/[a-zA-Z0-9]/.test(returned[returned.length - 1])) return cleanProjectName(name.slice(0, returned.length - 1))
+  return returned
+}
diff --git a/packages/server-core/src/projects/project/project.hooks.ts b/packages/server-core/src/projects/project/project.hooks.ts
@@ -74,6 +74,7 @@ import logger from '../../ServerLogger'
 import { useGit } from '../../util/gitHelperFunctions'
 import { checkAppOrgStatus, checkUserOrgWriteStatus, checkUserRepoWriteStatus } from './github-helper'
 import {
+  cleanProjectName,
   deleteProjectFilesInStorageProvider,
   engineVersion,
   getProjectConfig,
@@ -550,7 +551,7 @@ const updateProjectJob = async (context: HookContext) => {
       returnData: '',
       status: 'pending'
     })
-    const projectJobName = data.name.toLowerCase().replace(/[^a-z0-9-.]/g, '-')
+    const projectJobName = cleanProjectName(data.name)
     const jobBody = await getProjectUpdateJobBody(
       data,
       context.app,