ScopeType enforced (#9271)

* Name change:
- Changed name of `interface ScopeType` to `interface ScopeTypeInterface`

* ScopeType enforced

* Merge fix

---------

Co-authored-by: Josh Field <[email protected]>

Author: AmadeusSlabu

packages/engine/src/common/functions/checkScope.ts

@@ -24,7 +24,7 @@ Ethereal Engine. All Rights Reserved.
 */
 
 import { Engine } from '../../ecs/classes/Engine'
-import { ScopeType, scopePath } from '../../schemas/scope/scope.schema'
+import { ScopeTypeInterface, scopePath } from '../../schemas/scope/scope.schema'
 import { UserType } from '../../schemas/user/user.schema'
 
 export const checkScope = async (user: UserType, currentType: string, scopeToVerify: string) => {
@@ -33,7 +33,7 @@ export const checkScope = async (user: UserType, currentType: string, scopeToVer
       userId: user.id,
       paginate: false
     }
-  })) as any as ScopeType[]
+  })) as any as ScopeTypeInterface[]
 
   if (!scopes || scopes.length === 0) {
     return false

packages/engine/src/schemas/scope/scope-type.schema.ts

@@ -26,7 +26,9 @@ Ethereal Engine. All Rights Reserved.
 // For more information about this file see https://dove.feathersjs.com/guides/cli/service.schemas.html
 import type { Static } from '@feathersjs/typebox'
 import { getValidator, querySyntax, Type } from '@feathersjs/typebox'
+import { TypedString } from '../../common/types/TypeboxUtils'
 import { dataValidator, queryValidator } from '../validators'
+import { ScopeType } from './scope.schema'
 
 export const scopeTypePath = 'scope-type'
 
@@ -35,7 +37,9 @@ export const scopeTypeMethods = ['find', 'get'] as const
 // Main data model schema
 export const scopeTypeSchema = Type.Object(
   {
-    type: Type.String(),
+    type: TypedString<ScopeType>({
+      format: 'uuid'
+    }),
     createdAt: Type.String({ format: 'date-time' }),
     updatedAt: Type.String({ format: 'date-time' })
   },

packages/engine/src/schemas/scope/scope.schema.ts

@@ -34,6 +34,7 @@ import { dataValidator, queryValidator } from '../validators'
 export const scopePath = 'scope'
 
 export const scopeMethods = ['create', 'find', 'remove'] as const
+export type ScopeType = OpaqueType<'ScopeType'> & string
 
 export type ScopeID = OpaqueType<'ScopeID'> & string
 
@@ -43,7 +44,9 @@ export const scopeSchema = Type.Object(
     id: TypedString<ScopeID>({
       format: 'uuid'
     }),
-    type: Type.String(),
+    type: TypedString<ScopeType>({
+      format: 'uuid'
+    }),
     userId: TypedString<UserID>({
       format: 'uuid'
     }),
@@ -52,7 +55,7 @@ export const scopeSchema = Type.Object(
   },
   { $id: 'Scope', additionalProperties: false }
 )
-export interface ScopeType extends Static<typeof scopeSchema> {}
+export interface ScopeTypeInterface extends Static<typeof scopeSchema> {}
 
 // Schema for creating new entries
 export const scopeDataSchema = Type.Pick(scopeSchema, ['type', 'userId'], {

packages/engine/src/schemas/user/user.schema.ts

@@ -29,6 +29,7 @@ import type { Static } from '@feathersjs/typebox'
 import { getValidator, querySyntax, Type } from '@feathersjs/typebox'
 import { TypedString } from '../../common/types/TypeboxUtils'
 import { instanceAttendanceSchema } from '../networking/instance-attendance.schema'
+import { ScopeType } from '../scope/scope.schema'
 import { locationAdminSchema } from '../social/location-admin.schema'
 import { locationBanSchema } from '../social/location-ban.schema'
 import { userSettingSchema } from '../user/user-setting.schema'
@@ -43,7 +44,9 @@ export const userMethods = ['get', 'find', 'create', 'patch', 'remove'] as const
 
 export const userScopeSchema = Type.Object(
   {
-    type: Type.String()
+    type: TypedString<ScopeType>({
+      format: 'uuid'
+    })
   },
   { $id: 'UserScope', additionalProperties: false }
 )

packages/server-core/src/hooks/is-scope.ts

@@ -27,7 +27,7 @@ import { HookContext } from '@feathersjs/feathers'
 
 import { UserType } from '@etherealengine/engine/src/schemas/user/user.schema'
 
-import { ScopeType, scopePath } from '@etherealengine/engine/src/schemas/scope/scope.schema'
+import { ScopeTypeInterface, scopePath } from '@etherealengine/engine/src/schemas/scope/scope.schema'
 import { Application } from '../../declarations'
 
 export default (currentType: string, scopeToVerify: string) => {
@@ -40,7 +40,7 @@ export default (currentType: string, scopeToVerify: string) => {
         userId: loggedInUser.id
       },
       paginate: false
-    })) as ScopeType[]
+    })) as ScopeTypeInterface[]
     if (!scopes || scopes.length === 0) return false
 
     const currentScopes = scopes.reduce<string[]>((result, sc) => {

packages/server-core/src/hooks/verify-scope.test.ts

@@ -28,7 +28,7 @@ import assert from 'assert'
 
 import { destroyEngine } from '@etherealengine/engine/src/ecs/classes/Engine'
 
-import { scopePath } from '@etherealengine/engine/src/schemas/scope/scope.schema'
+import { scopePath, ScopeType } from '@etherealengine/engine/src/schemas/scope/scope.schema'
 import { AvatarID } from '@etherealengine/engine/src/schemas/user/avatar.schema'
 import { userApiKeyPath, UserApiKeyType } from '@etherealengine/engine/src/schemas/user/user-api-key.schema'
 import { InviteCode, UserName, userPath, UserType } from '@etherealengine/engine/src/schemas/user/user.schema'
@@ -101,7 +101,7 @@ describe('verify-scope', () => {
     })
 
     await app.service(scopePath).create({
-      type: 'location:read',
+      type: 'location:read' as ScopeType,
       userId: user.id
     })
 
@@ -129,7 +129,7 @@ describe('verify-scope', () => {
     })
 
     await app.service(scopePath).create({
-      type: 'location:read',
+      type: 'location:read' as ScopeType,
       userId: user.id
     })
 
@@ -165,12 +165,12 @@ describe('verify-scope', () => {
     })
 
     await app.service(scopePath).create({
-      type: 'location:read',
+      type: 'location:read' as ScopeType,
       userId: user.id
     })
 
     await app.service(scopePath).create({
-      type: 'admin:admin',
+      type: 'admin:admin' as ScopeType,
       userId: user.id
     })
 

packages/server-core/src/hooks/verify-scope.ts

@@ -27,7 +27,7 @@ import { HookContext } from '@feathersjs/feathers'
 
 import { UserType } from '@etherealengine/engine/src/schemas/user/user.schema'
 
-import { ScopeType, scopePath } from '@etherealengine/engine/src/schemas/scope/scope.schema'
+import { ScopeTypeInterface, scopePath } from '@etherealengine/engine/src/schemas/scope/scope.schema'
 import { Forbidden, NotAuthenticated, NotFound } from '@feathersjs/errors'
 import { Application } from '../../declarations'
 
@@ -41,7 +41,7 @@ export default (currentType: string, scopeToVerify: string) => {
         userId: loggedInUser.id
       },
       paginate: false
-    })) as ScopeType[]
+    })) as ScopeTypeInterface[]
     if (!scopes || scopes.length === 0) throw new NotFound('No scope available for the current user.')
 
     const currentScopes = scopes.reduce<string[]>((result, sc) => {

packages/server-core/src/networking/instance/instance.ts

@@ -30,7 +30,7 @@ import {
   instancePath,
   InstanceType
 } from '@etherealengine/engine/src/schemas/networking/instance.schema'
-import { scopePath, ScopeType } from '@etherealengine/engine/src/schemas/scope/scope.schema'
+import { scopePath, ScopeType, ScopeTypeInterface } from '@etherealengine/engine/src/schemas/scope/scope.schema'
 import { channelPath, ChannelType } from '@etherealengine/engine/src/schemas/social/channel.schema'
 import { UserID } from '@etherealengine/engine/src/schemas/user/user.schema'
 import { Paginated } from '@feathersjs/feathers'
@@ -74,10 +74,10 @@ export default (app: Application): void => {
     try {
       const adminScopes = (await app.service(scopePath).find({
         query: {
-          type: 'admin:admin'
+          type: 'admin:admin' as ScopeType
         },
         paginate: false
-      })) as ScopeType[]
+      })) as ScopeTypeInterface[]
 
       const targetIds = adminScopes.map((admin) => admin.userId)
       // eslint-disable-next-line @typescript-eslint/restrict-template-expressions

packages/server-core/src/projects/project-permission/project-permission.test.ts

@@ -35,7 +35,7 @@ import {
   projectPermissionPath
 } from '@etherealengine/engine/src/schemas/projects/project-permission.schema'
 import { projectPath } from '@etherealengine/engine/src/schemas/projects/project.schema'
-import { scopePath } from '@etherealengine/engine/src/schemas/scope/scope.schema'
+import { ScopeType, scopePath } from '@etherealengine/engine/src/schemas/scope/scope.schema'
 import { AvatarID } from '@etherealengine/engine/src/schemas/user/avatar.schema'
 import { UserApiKeyType, userApiKeyPath } from '@etherealengine/engine/src/schemas/user/user-api-key.schema'
 import { InviteCode, UserID, UserName, UserType, userPath } from '@etherealengine/engine/src/schemas/user/user.schema'
@@ -129,27 +129,27 @@ describe('project-permission.test', () => {
     })) as Paginated<UserApiKeyType>
     user4.apiKey = user4ApiKeys.data.length > 0 ? user4ApiKeys.data[0] : user4.apiKey
     await app.service(scopePath).create({
-      type: 'editor:write',
+      type: 'editor:write' as ScopeType,
       userId: user1.id
     })
     await app.service(scopePath).create({
-      type: 'editor:write',
+      type: 'editor:write' as ScopeType,
       userId: user2.id
     })
     await app.service(scopePath).create({
-      type: 'editor:write',
+      type: 'editor:write' as ScopeType,
       userId: user3.id
     })
     await app.service(scopePath).create({
-      type: 'editor:write',
+      type: 'editor:write' as ScopeType,
       userId: user4.id
     })
     await app.service(scopePath).create({
-      type: 'projects:read',
+      type: 'projects:read' as ScopeType,
       userId: user4.id
     })
     await app.service(scopePath).create({
-      type: 'projects:write',
+      type: 'projects:write' as ScopeType,
       userId: user4.id
     })
   })

packages/server-core/src/projects/project/project.ts

@@ -32,7 +32,7 @@ import {
   projectPermissionPath
 } from '@etherealengine/engine/src/schemas/projects/project-permission.schema'
 import { ProjectType, projectMethods, projectPath } from '@etherealengine/engine/src/schemas/projects/project.schema'
-import { ScopeType, scopePath } from '@etherealengine/engine/src/schemas/scope/scope.schema'
+import { ScopeType, ScopeTypeInterface, scopePath } from '@etherealengine/engine/src/schemas/scope/scope.schema'
 import { UserID } from '@etherealengine/engine/src/schemas/user/user.schema'
 import { Application } from '../../../declarations'
 import { ProjectService } from './project.class'
@@ -78,10 +78,10 @@ export default (app: Application): void => {
 
       const projectReadScopes = (await app.service(scopePath).find({
         query: {
-          type: 'projects:read'
+          type: 'projects:read' as ScopeType
         },
         paginate: false
-      })) as ScopeType[]
+      })) as ScopeTypeInterface[]
 
       targetIds = targetIds.concat(projectReadScopes.map((admin) => admin.userId!))
       targetIds = _.uniq(targetIds)