Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

8.1 KB
Raw Blame
import { screen } from '@testing-library/react'
import { beforeEach, describe, expect, it, vi } from 'vitest'

import {
  STORAGE_ROW_STATUS,
  STORAGE_ROW_TYPES,
} from '@/components/interfaces/Storage/Storage.constants'
import type { StorageItem } from '@/components/interfaces/Storage/Storage.types'
import { PreviewPane } from '@/components/interfaces/Storage/StorageExplorer/PreviewPane'
import { customRender as render } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'

const { versioningEnabled, selectedBucket, selectedFilePreview } = vi.hoisted(() => ({
  versioningEnabled: { current: true },
  selectedBucket: {
    current: { id: 'my-bucket', name: 'my-bucket', public: false } as Record<string, unknown>,
  },
  selectedFilePreview: { current: undefined as Record<string, unknown> | undefined },
}))

vi.mock(
  '@/components/interfaces/App/FeaturePreview/FeaturePreviewContext',
  async (importOriginal) => {
    const actual = await importOriginal<Record<string, unknown>>()
    return { ...actual, useIsStorageVersioningEnabled: () => versioningEnabled.current }
  }
)

vi.mock('@/state/storage-explorer', () => ({
  useStorageExplorerStateSnapshot: () => ({
    projectRef: 'abcdef',
    selectedBucket: selectedBucket.current,
    selectedFilePreview: selectedFilePreview.current,
    openedFolders: [],
    setSelectedItemsToDelete: vi.fn(),
    setItemsToPurge: vi.fn(),
    refetchAllOpenedFolders: vi.fn().mockResolvedValue(undefined),
    replaceFile: vi.fn(),
    setSelectedFileCustomExpiry: vi.fn(),
    downloadFile: vi.fn(),
  }),
}))
vi.mock('@/components/interfaces/Storage/StorageExplorer/StorageExplorerNavigation', () => ({
  useStorageExplorerNavigation: () => ({ clearPreviewedFile: vi.fn() }),
}))
vi.mock('@/hooks/misc/useCheckPermissions', () => ({
  useAsyncCheckPermissions: () => ({ can: true }),
}))
vi.mock('@/components/interfaces/Storage/StorageExplorer/useCopyUrl', () => ({
  useCopyUrl: () => ({ onCopyUrl: vi.fn() }),
}))

const FILE: StorageItem = {
  id: 'f1',
  name: 'photo.png',
  type: STORAGE_ROW_TYPES.FILE,
  status: STORAGE_ROW_STATUS.READY,
  metadata: {
    cacheControl: 'max-age=3600',
    contentLength: 10,
    size: 10,
    httpStatusCode: 200,
    eTag: 'etag',
    lastModified: '2024-01-01T00:00:00Z',
    mimetype: 'image/png',
  },
  isCorrupted: false,
  created_at: '2024-01-01T00:00:00Z',
  updated_at: '2024-01-01T00:00:00Z',
  last_accessed_at: null,
  path: 'photo.png',
}

const VERSIONS = [
  {
    id: 'f1',
    name: 'photo.png',
    version: 'v-current',
    created_at: '2024-01-01T00:00:00Z',
    updated_at: '2024-01-01T00:00:00Z',
    last_accessed_at: null,
    archived_at: null,
    is_delete_marker: false,
    metadata: { size: 10, mimetype: 'image/png' },
  },
]

/**
 * Ferhat's A/B/C case: B was written while suspended so it carries no version id and the
 * listing drops it, but A stays behind it as a restorable noncurrent version.
 */
const NONCURRENT_UNDER_UNVERSIONED_CURRENT = [
  {
    id: 'f1',
    name: 'photo.png',
    version: null,
    created_at: '2024-02-01T00:00:00Z',
    updated_at: '2024-02-01T00:00:00Z',
    last_accessed_at: null,
    archived_at: null,
    is_delete_marker: false,
    metadata: { size: 12, mimetype: 'image/png' },
  },
  {
    id: 'f1',
    name: 'photo.png',
    version: 'v-a',
    created_at: '2024-01-01T00:00:00Z',
    updated_at: '2024-01-01T00:00:00Z',
    last_accessed_at: null,
    archived_at: '2024-02-01T00:00:00Z',
    is_delete_marker: false,
    metadata: { size: 10, mimetype: 'image/png' },
  },
]

const mockVersionListing = (objects: unknown[]) =>
  addAPIMock({
    method: 'post',
    path: '/platform/storage/:ref/buckets/:id/objects/list',
    response: () => Response.json(objects),
  })

const renderPane = (file: Partial<StorageItem> = {}) => {
  selectedFilePreview.current = { ...FILE, ...file }
  return render(<PreviewPane />)
}

describe('PreviewPane', () => {
  beforeEach(() => {
    versioningEnabled.current = true
    selectedBucket.current = { id: 'my-bucket', name: 'my-bucket', public: false }

    mockVersionListing(VERSIONS)
    addAPIMock({
      method: 'post',
      path: '/platform/storage/:ref/buckets/:id/objects/sign',
      response: () => Response.json({ signedUrl: '/storage/v1/object/sign/photo.png' }),
    })
    addAPIMock({
      method: 'get',
      path: '/platform/storage/:ref/buckets/:id/lifecycle',
      response: () => Response.json({ rules: [] }),
    })
  })

  it('offers Archive, a purge and "Upload new version" on an enabled bucket', async () => {
    selectedBucket.current = { ...selectedBucket.current, versioning_status: 'ENABLED' }
    renderPane({ is_versioned: true })

    expect(await screen.findByRole('button', { name: 'Archive' })).toBeInTheDocument()
    expect(screen.getByRole('button', { name: 'More delete options' })).toBeInTheDocument()
    expect(screen.queryByRole('button', { name: 'Delete file' })).not.toBeInTheDocument()
    expect(await screen.findByRole('button', { name: 'Upload new version' })).toBeInTheDocument()
  })

  it('offers a single Delete and no version history for a file written while suspended', async () => {
    // The listing drops unversioned rows, so a file with no history comes back empty.
    mockVersionListing([])
    selectedBucket.current = { ...selectedBucket.current, versioning_status: 'SUSPENDED' }
    renderPane({ is_versioned: false })

    // Suspended can't soft-delete, so there is no Archive and no purge split button.
    expect(await screen.findByRole('button', { name: 'Delete file' })).toBeInTheDocument()
    expect(screen.queryByRole('button', { name: 'Archive' })).not.toBeInTheDocument()
    expect(screen.queryByRole('button', { name: 'More delete options' })).not.toBeInTheDocument()
    expect(screen.queryByText('Versions')).not.toBeInTheDocument()
  })

  it('reads "Replace file" and shows version history for a versioned file on a suspended bucket', async () => {
    selectedBucket.current = { ...selectedBucket.current, versioning_status: 'SUSPENDED' }
    renderPane({ is_versioned: true })

    // The label names the action, not the retention. The Versions section explains that.
    expect(await screen.findByRole('button', { name: 'Replace file' })).toBeInTheDocument()
    expect(screen.queryByRole('button', { name: 'Upload new version' })).not.toBeInTheDocument()
    expect(await screen.findByText('Versions')).toBeInTheDocument()
    expect(await screen.findByText(/retains the current version one last time/)).toBeInTheDocument()
  })

  it('still shows version history when a retained version sits under an unversioned current', async () => {
    // Hiding here would strand a version the user can still restore.
    mockVersionListing(NONCURRENT_UNDER_UNVERSIONED_CURRENT)
    selectedBucket.current = { ...selectedBucket.current, versioning_status: 'SUSPENDED' }
    renderPane({ is_versioned: false })

    expect(await screen.findByText('Versions')).toBeInTheDocument()
    expect(await screen.findByText(/overwrites it in place/)).toBeInTheDocument()
  })

  it('reads "Replace file" and hides version history on a disabled bucket', async () => {
    mockVersionListing([])
    selectedBucket.current = { ...selectedBucket.current, versioning_status: 'DISABLED' }
    renderPane({ is_versioned: false })

    expect(await screen.findByRole('button', { name: 'Replace file' })).toBeInTheDocument()
    expect(screen.getByRole('button', { name: 'Delete file' })).toBeInTheDocument()
    expect(screen.queryByText('Versions')).not.toBeInTheDocument()
  })

  it('shows version history for every file on an enabled bucket, even one written before versioning', async () => {
    mockVersionListing([])
    selectedBucket.current = { ...selectedBucket.current, versioning_status: 'ENABLED' }
    renderPane({ is_versioned: false })

    // The next write will version it, so the history has to be on offer.
    expect(await screen.findByText('Versions')).toBeInTheDocument()
  })

  it.each(['photo.png', 'nested/deep/photo.png'])(
    'displays the file base name for %s',
    async (name) => {
      selectedBucket.current = { ...selectedBucket.current, versioning_status: 'ENABLED' }
      renderPane({ name })
      expect(await screen.findByText('photo.png')).toBeInTheDocument()
    }
  )
})