@speckle/shared/src/authz/policies/project/savedViews/canSetAsHomeView.spec.ts

Shared code between various Speckle JS packages

import { describe, expect, it } from 'vitest'
import { OverridesOf } from '../../../../tests/helpers/types.js'
import {
  getEnvFake,
  getProjectFake,
  getSavedViewFake,
  getWorkspaceFake,
  getWorkspacePlanFake,
  getWorkspaceSsoProviderFake,
  getWorkspaceSsoSessionFake
} from '../../../../tests/fakes.js'
import { Roles } from '../../../../core/constants.js'
import {
  ProjectNotEnoughPermissionsError,
  SavedViewInvalidUpdateError,
  ServerNoAccessError,
  WorkspaceNoAccessError,
  WorkspacePlanNoFeatureAccessError,
  WorkspacesNotEnabledError
} from '../../../domain/authErrors.js'
import { canSetSavedViewAsHomeViewPolicy } from './canSetAsHomeView.js'
import { SavedViewVisibility } from '../../../domain/savedViews/types.js'

describe('canSetSavedViewAsHomeViewPolicy', () => {
  const buildSUT = (overrides?: OverridesOf<typeof canSetSavedViewAsHomeViewPolicy>) =>
    canSetSavedViewAsHomeViewPolicy({
      getSavedView: getSavedViewFake({
        projectId: 'project-id',
        authorId: 'user-id'
      }),
      getProject: getProjectFake({
        id: 'project-id',
        workspaceId: null
      }),
      getEnv: getEnvFake({
        FF_WORKSPACES_MODULE_ENABLED: true,
        FF_SAVED_VIEWS_ENABLED: true
      }),
      getServerRole: async () => Roles.Server.User,
      getProjectRole: async () => Roles.Stream.Owner,
      getWorkspaceRole: async () => null,
      getWorkspace: async () => null,
      getWorkspaceSsoProvider: async () => null,
      getWorkspacePlan: async () => null,
      getWorkspaceSsoSession: async () => null,
      getAdminOverrideEnabled: async () => false,
      ...overrides
    })

  it('fails in non-workspaced project, even if project owner', async () => {
    const policy = buildSUT()

    const result = await policy({
      userId: 'user-id',
      projectId: 'project-id',
      savedViewId: 'saved-view-id'
    })

    expect(result).toBeAuthErrorResult({
      code: WorkspaceNoAccessError.code
    })
  })

  describe('w/ workspaced project', async () => {
    const buildWorkspacedSUT = (
      overrides?: OverridesOf<typeof canSetSavedViewAsHomeViewPolicy>
    ) =>
      buildSUT({
        getProject: getProjectFake({
          id: 'project-id',
          workspaceId: 'workspace-id'
        }),
        getWorkspaceRole: async () => Roles.Workspace.Member,
        getWorkspace: getWorkspaceFake({
          id: 'workspace-id'
        }),
        getWorkspacePlan: getWorkspacePlanFake({
          workspaceId: 'workspace-id',
          name: 'pro'
        }),
        getWorkspaceSsoProvider: getWorkspaceSsoProviderFake({
          providerId: 'sso-provider-id'
        }),
        getWorkspaceSsoSession: getWorkspaceSsoSessionFake({
          providerId: 'sso-provider-id'
        }),
        ...overrides
      })

    it('works for non-author if user is workspace admin', async () => {
      const sut = buildWorkspacedSUT({
        getWorkspaceRole: async () => Roles.Workspace.Admin
      })

      const result = await sut({
        userId: 'user-idx',
        projectId: 'project-id',
        savedViewId: 'saved-view-id'
      })

      expect(result).toBeOKResult()
    })

    it('works for non-author if user is contributor', async () => {
      const sut = buildWorkspacedSUT({
        getProjectRole: async () => Roles.Stream.Contributor
      })

      const result = await sut({
        userId: 'user-idx',
        projectId: 'project-id',
        savedViewId: 'saved-view-id'
      })

      expect(result).toBeOKResult()
    })

    it('fails if workspaces disabled', async () => {
      const sut = buildWorkspacedSUT({
        getEnv: getEnvFake({
          FF_WORKSPACES_MODULE_ENABLED: false,
          FF_SAVED_VIEWS_ENABLED: true
        })
      })

      const result = await sut({
        userId: 'user-id',
        projectId: 'project-id',
        savedViewId: 'saved-view-id'
      })

      expect(result).toBeAuthErrorResult({
        code: WorkspacesNotEnabledError.code
      })
    })

    it('fails if saved views disabled', async () => {
      const sut = buildWorkspacedSUT({
        getEnv: getEnvFake({
          FF_WORKSPACES_MODULE_ENABLED: true,
          FF_SAVED_VIEWS_ENABLED: false
        })
      })

      const result = await sut({
        userId: 'user-id',
        projectId: 'project-id',
        savedViewId: 'saved-view-id'
      })

      expect(result).toBeAuthErrorResult({
        code: WorkspacePlanNoFeatureAccessError.code
      })
    })

    it('fails if just reviewer', async () => {
      const sut = buildWorkspacedSUT({
        getProjectRole: async () => Roles.Stream.Reviewer
      })

      const result = await sut({
        userId: 'user-id',
        projectId: 'project-id',
        savedViewId: 'saved-view-id'
      })

      expect(result).toBeAuthErrorResult({
        code: ProjectNotEnoughPermissionsError.code
      })
    })

    it('fails if logged out', async () => {
      const sut = buildWorkspacedSUT({
        getWorkspaceRole: async () => null,
        getServerRole: async () => null,
        getProjectRole: async () => null
      })

      const result = await sut({
        userId: 'user-id',
        projectId: 'project-id',
        savedViewId: 'saved-view-id'
      })
      expect(result).toBeAuthErrorResult({
        code: ServerNoAccessError.code
      })
    })

    it('succeeds if view author', async () => {
      const sut = buildWorkspacedSUT({
        getSavedView: getSavedViewFake({
          projectId: 'project-id',
          authorId: 'user-id'
        })
      })

      const result = await sut({
        userId: 'user-id',
        projectId: 'project-id',
        savedViewId: 'saved-view-id'
      })

      expect(result).toBeOKResult()
    })

    it('fails if view is author-only', async () => {
      const sut = buildWorkspacedSUT({
        getSavedView: getSavedViewFake({
          projectId: 'project-id',
          authorId: 'user-id',
          visibility: SavedViewVisibility.authorOnly
        })
      })

      const result = await sut({
        userId: 'user-id',
        projectId: 'project-id',
        savedViewId: 'saved-view-id'
      })

      expect(result).toBeAuthErrorResult({
        code: SavedViewInvalidUpdateError.code,
        message: /home view/
      })
    })

    it('fails if view is federated', async () => {
      const sut = buildWorkspacedSUT({
        getSavedView: getSavedViewFake({
          projectId: 'project-id',
          authorId: 'user-id',
          resourceIds: ['aaaa', 'bbb']
        })
      })

      const result = await sut({
        userId: 'user-id',
        projectId: 'project-id',
        savedViewId: 'saved-view-id'
      })

      expect(result).toBeAuthErrorResult({
        code: SavedViewInvalidUpdateError.code,
        message: /single model/
      })
    })
  })
})