supabase__supabase/apps/studio/state/sql-editor/sql-editor-state.test.ts

import { untrustedSql } from '@supabase/pg-meta'
import { beforeEach, describe, expect, it } from 'vitest'

import { sqlEditorState } from './sql-editor-state'
import type { SnippetWithContent } from '@/data/content/sql-folders-query'
import { untrustedLogSql } from '@/data/logs/safe-analytics-sql'

function makeLogSnippet(id: string): SnippetWithContent {
  return {
    id,
    name: 'My Logs Query',
    description: '',
    visibility: 'user',
    project_id: 42,
    owner_id: 7,
    folder_id: null,
    favorite: false,
    status: 'saved',
    inserted_at: '2024-01-01T00:00:00.000Z',
    updated_at: '2024-01-01T00:00:00.000Z',
    type: 'log_sql',
    content: {
      content_id: id,
      schema_version: '1',
      unchecked_sql: untrustedLogSql('select * from logs'),
    },
  }
}

function makeSnippet(
  id: string,
  overrides: Omit<Partial<SnippetWithContent>, 'content' | 'type'> = {}
): SnippetWithContent {
  return {
    id,
    name: 'My Query',
    description: 'A description',
    visibility: 'user',
    project_id: 42,
    owner_id: 7,
    folder_id: null,
    favorite: false,
    status: 'saved',
    inserted_at: '2024-01-01T00:00:00.000Z',
    updated_at: '2024-01-01T00:00:00.000Z',
    ...overrides,
    type: 'sql',
    content: {
      content_id: id,
      schema_version: '1',
      unchecked_sql: untrustedSql('SELECT * FROM users;'),
    },
  }
}

describe('addFavorite / removeFavorite', () => {
  beforeEach(() => {
    // sqlEditorState is a module-level singleton, so reset the state these tests touch
    for (const id of Object.keys(sqlEditorState.snippets)) {
      delete sqlEditorState.snippets[id]
    }
    sqlEditorState.needsSaving.clear()
  })

  it('marks a loaded snippet as favorite without queueing it for saving', () => {
    sqlEditorState.addSnippet({ projectRef: 'ref', snippet: makeSnippet('snippet-1') })

    sqlEditorState.addFavorite('snippet-1')

    expect(sqlEditorState.snippets['snippet-1'].snippet.favorite).toBe(true)
    // Favorites persist immediately via the save coordinator, not the queue.
    expect(sqlEditorState.needsSaving.has('snippet-1')).toBe(false)
  })

  it('unmarks a favorited snippet without queueing it for saving', () => {
    sqlEditorState.addSnippet({
      projectRef: 'ref',
      snippet: makeSnippet('snippet-1', { favorite: true }),
    })

    sqlEditorState.removeFavorite('snippet-1')

    expect(sqlEditorState.snippets['snippet-1'].snippet.favorite).toBe(false)
    expect(sqlEditorState.needsSaving.has('snippet-1')).toBe(false)
  })

  it('ignores addFavorite for a snippet that is not in the store', () => {
    expect(() => sqlEditorState.addFavorite('missing')).not.toThrow()
    expect(sqlEditorState.needsSaving.has('missing')).toBe(false)
  })

  it('ignores removeFavorite for a snippet that is not in the store', () => {
    expect(() => sqlEditorState.removeFavorite('missing')).not.toThrow()
    expect(sqlEditorState.needsSaving.has('missing')).toBe(false)
  })
})

describe('setSql — source-aware branding', () => {
  beforeEach(() => {
    for (const id of Object.keys(sqlEditorState.snippets)) {
      delete sqlEditorState.snippets[id]
    }
    sqlEditorState.needsSaving.clear()
  })

  it('updates the SQL of a database snippet and marks it for saving', () => {
    sqlEditorState.addSnippet({ projectRef: 'ref', snippet: makeSnippet('db-1') })

    sqlEditorState.setSql({ id: 'db-1', sql: 'select 2' })

    expect(sqlEditorState.snippets['db-1'].snippet.content?.unchecked_sql).toBe('select 2')
    expect(sqlEditorState.needsSaving.has('db-1')).toBe(true)
  })

  it('updates the SQL of a logs snippet and marks it for saving', () => {
    sqlEditorState.addSnippet({ projectRef: 'ref', snippet: makeLogSnippet('logs-1') })

    sqlEditorState.setSql({ id: 'logs-1', sql: 'select count(*) from logs' })

    expect(sqlEditorState.snippets['logs-1'].snippet.content?.unchecked_sql).toBe(
      'select count(*) from logs'
    )
    expect(sqlEditorState.needsSaving.has('logs-1')).toBe(true)
  })
})