tests: unit tests for route

packages/server-core/src/route/route/route.test.ts

@@ -0,0 +1,103 @@
+import appRootPath from 'app-root-path'
+import assert from 'assert'
+import fs from 'fs'
+import path from 'path'
+import { v4 as uuid } from 'uuid'
+
+import { destroyEngine } from '@etherealengine/engine/src/ecs/classes/Engine'
+
+import { Application } from '../../../declarations'
+import { createFeathersExpressApp } from '../../createApp'
+import { deleteFolderRecursive } from '../../util/fsHelperFunctions'
+
+const params = { isInternal: true } as any
+
+const cleanup = async (app: Application, projectName: string) => {
+  const projectDir = path.resolve(appRootPath.path, `packages/projects/projects/${projectName}/`)
+  deleteFolderRecursive(projectDir)
+  try {
+    await app.service('project').Model.destroy({ where: { name: projectName } })
+  } catch (e) {}
+}
+
+const updateXREngineConfigForTest = (projectName: string, customRoute: string) => {
+  const testXREngineConfig = `
+  import type { ProjectConfigInterface } from '@etherealengine/projects/ProjectConfigInterface'
+
+  const config: ProjectConfigInterface = {
+    routes: {
+      test: {
+        component: () => import('@etherealengine/client/src/pages/index'),
+      },
+      "${customRoute}": {
+        component: () => import('@etherealengine/client/src/pages/index'),
+      }
+    },
+  }
+
+  export default config
+  `
+
+  const projectsRootFolder = path.join(appRootPath.path, 'packages/projects/projects/')
+  const projectLocalDirectory = path.resolve(projectsRootFolder, projectName)
+  const xrEngineConfigFilePath = path.resolve(projectLocalDirectory, 'xrengine.config.ts')
+
+  fs.rmSync(xrEngineConfigFilePath)
+  fs.writeFileSync(xrEngineConfigFilePath, testXREngineConfig)
+}
+
+describe('route.test', () => {
+  let app: Application
+  let testProject: string
+  let testRoute: string
+
+  before(async () => {
+    app = createFeathersExpressApp()
+    await app.setup()
+  })
+
+  after(async () => {
+    await destroyEngine()
+    await cleanup(app, testProject)
+  })
+
+  it('should find the installed project routes', async () => {
+    testProject = `test-project-${uuid()}`
+    testRoute = `test-route-${uuid()}`
+
+    await app.service('project').create({ name: testProject }, params)
+    updateXREngineConfigForTest(testProject, testRoute)
+
+    const installedRoutes = await app.service('routes-installed').find()
+    const route = installedRoutes.data.find((route) => route.project === testProject)
+
+    assert.ok(route)
+    assert.equal(route.project, testProject)
+  })
+
+  it('should not be activated by default (the installed project)', async () => {
+    const route = await app.service('route').find({ query: { project: testProject } })
+    assert.equal(route.total, 0)
+  })
+
+  it('should activate a route', async () => {
+    const activateResult = await app
+      .service('route-activate')
+      .create({ project: testProject, route: testRoute, activate: true }, params)
+    const fetchResult = await app.service('route').find({ query: { project: testProject } })
+    const route = fetchResult.data.find((d) => d.project === testProject)
+
+    assert.ok(activateResult)
+    assert.equal(fetchResult.total, 1)
+
+    assert.equal(route?.project, testProject)
+    assert.equal(route?.route, testRoute)
+  })
+
+  it('should deactivate a route', async () => {
+    await app.service('route-activate').create({ project: testProject, route: testRoute, activate: false }, params)
+
+    const route = await app.service('route').find({ query: { project: testProject } })
+    assert.equal(route.total, 0)
+  })
+})

packages/server-core/src/route/route/route.ts

@@ -30,7 +30,7 @@ declare module '@etherealengine/common/declarations' {
   }
 }
 
-export const getInstalledRoutes = (): any => {
+export const getInstalledRoutes = () => {
   return async () => {
     const projects = fs
       .readdirSync(path.resolve(__dirname, '../../../../projects/projects/'), { withFileTypes: true })
@@ -60,8 +60,8 @@ export const getInstalledRoutes = (): any => {
   }
 }
 
-export const activateRoute = (routeService: RouteService): any => {
-  return async (data: { project: string; route: string; activate: boolean }, params: Params) => {
+export const activateRoute = (routeService: RouteService) => {
+  return async (data: { project: string; route: string; activate: boolean }, params: Params = {}) => {
     const activatedRoutes = await routeService.find({
       paginate: false
     })