WithStatements.utils.test.ts 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  1. import { safeSql } from '@supabase/pg-meta'
  2. import { describe, expect, it, vi } from 'vitest'
  3. import { transformStatementDataToRows } from './WithStatements.utils'
  4. vi.mock('../IndexAdvisor/index-advisor.utils', () => ({
  5. filterProtectedSchemaIndexAdvisorResult: vi.fn((result) => {
  6. if (result?._mock_filter_null) return null
  7. return result
  8. }),
  9. queryInvolvesProtectedSchemas: vi.fn((query: string) => {
  10. return query?.toLowerCase().includes('auth.')
  11. }),
  12. }))
  13. const makeRow = (overrides: Record<string, any> = {}) => ({
  14. query: safeSql`SELECT 1`,
  15. rolname: 'postgres',
  16. calls: 10,
  17. mean_time: 5.0,
  18. min_time: 1.0,
  19. max_time: 20.0,
  20. total_time: 50.0,
  21. prop_total_time: 0,
  22. rows_read: 100,
  23. cache_hit_rate: 0.95,
  24. index_advisor_result: null,
  25. ...overrides,
  26. })
  27. describe('transformStatementDataToRows', () => {
  28. it('returns empty array for null or empty input', () => {
  29. expect(transformStatementDataToRows(null as any)).toEqual([])
  30. expect(transformStatementDataToRows([])).toEqual([])
  31. })
  32. it('transforms basic rows correctly', () => {
  33. const data = [makeRow()]
  34. const result = transformStatementDataToRows(data)
  35. expect(result).toHaveLength(1)
  36. expect(result[0]).toMatchObject({
  37. query: 'SELECT 1',
  38. rolname: 'postgres',
  39. calls: 10,
  40. mean_time: 5.0,
  41. min_time: 1.0,
  42. max_time: 20.0,
  43. total_time: 50.0,
  44. rows_read: 100,
  45. cache_hit_rate: 0.95,
  46. })
  47. })
  48. it('preserves zero-valued numeric fields as 0', () => {
  49. const data = [
  50. makeRow({
  51. calls: 0,
  52. mean_time: 0,
  53. min_time: 0,
  54. max_time: 0,
  55. total_time: 0,
  56. rows_read: 0,
  57. cache_hit_rate: 0,
  58. }),
  59. ]
  60. const result = transformStatementDataToRows(data)
  61. expect(result).toHaveLength(1)
  62. expect(result[0].calls).toBe(0)
  63. expect(result[0].mean_time).toBe(0)
  64. expect(result[0].min_time).toBe(0)
  65. expect(result[0].max_time).toBe(0)
  66. expect(result[0].total_time).toBe(0)
  67. expect(result[0].rows_read).toBe(0)
  68. expect(result[0].cache_hit_rate).toBe(0)
  69. })
  70. it('sets rolname to undefined when missing', () => {
  71. const data = [makeRow({ rolname: undefined })]
  72. const result = transformStatementDataToRows(data)
  73. expect(result[0].rolname).toBeUndefined()
  74. })
  75. it('calculates prop_total_time as percentage of total time', () => {
  76. const data = [
  77. makeRow({ query: safeSql`Q1`, total_time: 75 }),
  78. makeRow({ query: safeSql`Q2`, total_time: 25 }),
  79. ]
  80. const result = transformStatementDataToRows(data)
  81. expect(result[0].prop_total_time).toBe(75)
  82. expect(result[1].prop_total_time).toBe(25)
  83. })
  84. it('handles prop_total_time when total is zero', () => {
  85. const data = [makeRow({ total_time: 0 })]
  86. const result = transformStatementDataToRows(data)
  87. expect(result[0].prop_total_time).toBe(0)
  88. })
  89. it('applies index_advisor_result filtering', () => {
  90. const data = [
  91. makeRow({
  92. index_advisor_result: { index_statements: ['CREATE INDEX ON public.users (id)'] },
  93. }),
  94. ]
  95. const result = transformStatementDataToRows(data)
  96. expect(result[0].index_advisor_result).toEqual({
  97. index_statements: ['CREATE INDEX ON public.users (id)'],
  98. })
  99. })
  100. it('sets index_advisor_result to null when source is null', () => {
  101. const data = [makeRow({ index_advisor_result: null })]
  102. const result = transformStatementDataToRows(data)
  103. expect(result[0].index_advisor_result).toBeNull()
  104. })
  105. describe('filterIndexAdvisor mode', () => {
  106. it('keeps rows for non-protected schema queries', () => {
  107. const data = [makeRow({ query: safeSql`SELECT * FROM public.users` })]
  108. const result = transformStatementDataToRows(data, true)
  109. expect(result).toHaveLength(1)
  110. })
  111. it('keeps protected-schema rows that have valid recommendations', () => {
  112. const data = [
  113. makeRow({
  114. query: safeSql`SELECT * FROM auth.users`,
  115. index_advisor_result: { index_statements: ['CREATE INDEX ON auth.users (id)'] },
  116. }),
  117. ]
  118. const result = transformStatementDataToRows(data, true)
  119. expect(result).toHaveLength(1)
  120. })
  121. it('filters out protected-schema rows with no valid recommendations', () => {
  122. const data = [
  123. makeRow({
  124. query: safeSql`SELECT * FROM auth.users`,
  125. index_advisor_result: { _mock_filter_null: true },
  126. }),
  127. ]
  128. const result = transformStatementDataToRows(data, true)
  129. expect(result).toHaveLength(0)
  130. })
  131. it('does not filter protected-schema rows when filterIndexAdvisor is false', () => {
  132. const data = [
  133. makeRow({
  134. query: safeSql`SELECT * FROM auth.users`,
  135. index_advisor_result: { _mock_filter_null: true },
  136. }),
  137. ]
  138. const result = transformStatementDataToRows(data, false)
  139. expect(result).toHaveLength(1)
  140. })
  141. })
  142. })