query.test.ts 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822
  1. import { describe, expect, test } from 'vitest'
  2. import { ident, joinSqlFragments, safeSql } from '../../src/pg-format'
  3. import { Query } from '../../src/query/Query'
  4. import * as QueryUtils from '../../src/query/Query.utils'
  5. import { QueryAction } from '../../src/query/QueryAction'
  6. import { QueryFilter } from '../../src/query/QueryFilter'
  7. import { QueryModifier } from '../../src/query/QueryModifier'
  8. import type { Filter, QueryTable, Sort } from '../../src/query/types'
  9. describe('Query', () => {
  10. test('from() should create a QueryAction with the correct table', () => {
  11. const query = new Query()
  12. const action = query.from('users', 'public')
  13. expect(action).toBeInstanceOf(QueryAction)
  14. expect(action['table']).toEqual({ name: 'users', schema: 'public' })
  15. })
  16. test('from() should use "public" as the default schema when not provided', () => {
  17. const query = new Query()
  18. const action = query.from('users')
  19. expect(action['table']).toEqual({ name: 'users', schema: 'public' })
  20. })
  21. })
  22. describe('QueryAction', () => {
  23. const table: QueryTable = { name: 'users', schema: 'public' }
  24. test('count() should create a QueryFilter with the correct action', () => {
  25. const action = new QueryAction(table)
  26. const filter = action.count()
  27. expect(filter).toBeInstanceOf(QueryFilter)
  28. expect(filter['table']).toEqual(table)
  29. expect(filter['actionConfig'].action).toBe('count')
  30. })
  31. test('delete() should create a QueryFilter with the correct action and options', () => {
  32. const action = new QueryAction(table)
  33. const filter = action.delete({ returning: true })
  34. expect(filter).toBeInstanceOf(QueryFilter)
  35. expect(filter['table']).toEqual(table)
  36. expect(filter['actionConfig'].action).toBe('delete')
  37. expect(filter['actionOptions']).toEqual({ returning: true })
  38. })
  39. test('insert() should create a QueryFilter with the correct action, values and options', () => {
  40. const action = new QueryAction(table)
  41. const values = [{ id: 1, name: 'John' }]
  42. const filter = action.insert(values, { returning: true })
  43. expect(filter).toBeInstanceOf(QueryFilter)
  44. expect(filter['table']).toEqual(table)
  45. expect(filter['actionConfig']).toEqual({ action: 'insert', actionValue: values })
  46. expect(filter['actionOptions']).toEqual({ returning: true })
  47. })
  48. test('select() should create a QueryFilter with the correct action and columns', () => {
  49. const action = new QueryAction(table)
  50. const cols = joinSqlFragments([ident('id'), ident('name')], ', ')
  51. const filter = action.select(cols)
  52. expect(filter).toBeInstanceOf(QueryFilter)
  53. expect(filter['table']).toEqual(table)
  54. expect(filter['actionConfig']).toEqual({ action: 'select', actionValue: 'id, name' })
  55. })
  56. test('update() should create a QueryFilter with the correct action, value and options', () => {
  57. const action = new QueryAction(table)
  58. const value = { name: 'John' }
  59. const filter = action.update(value, { returning: true })
  60. expect(filter).toBeInstanceOf(QueryFilter)
  61. expect(filter['table']).toEqual(table)
  62. expect(filter['actionConfig']).toEqual({ action: 'update', actionValue: value })
  63. expect(filter['actionOptions']).toEqual({ returning: true })
  64. })
  65. test('truncate() should create a QueryFilter with the correct action and options', () => {
  66. const action = new QueryAction(table)
  67. const filter = action.truncate({ returning: true })
  68. expect(filter).toBeInstanceOf(QueryFilter)
  69. expect(filter['table']).toEqual(table)
  70. expect(filter['actionConfig'].action).toBe('truncate')
  71. expect(filter['actionOptions']).toEqual({ returning: true })
  72. })
  73. })
  74. describe('QueryFilter', () => {
  75. const table: QueryTable = { name: 'users', schema: 'public' }
  76. test('filter() should add a filter and return the filter instance', () => {
  77. const queryFilter = new QueryFilter(table, {
  78. action: 'select',
  79. actionValue: joinSqlFragments([ident('id'), ident('name')], ', '),
  80. })
  81. const result = queryFilter.filter('id', '=', 1)
  82. expect(result).toBe(queryFilter)
  83. expect(queryFilter['filters']).toEqual([{ column: 'id', operator: '=', value: 1 }])
  84. })
  85. test('match() should add multiple filters and return the filter instance', () => {
  86. const queryFilter = new QueryFilter(table, {
  87. action: 'select',
  88. actionValue: joinSqlFragments([ident('id'), ident('name')], ', '),
  89. })
  90. const result = queryFilter.match({ id: 1, name: 'John' })
  91. expect(result).toBe(queryFilter)
  92. expect(queryFilter['filters']).toEqual([
  93. { column: 'id', operator: '=', value: 1 },
  94. { column: 'name', operator: '=', value: 'John' },
  95. ])
  96. })
  97. test('order() should add a sort and return the filter instance', () => {
  98. const queryFilter = new QueryFilter(table, {
  99. action: 'select',
  100. actionValue: joinSqlFragments([ident('id'), ident('name')], ', '),
  101. })
  102. const result = queryFilter.order('users', 'name', false, true)
  103. expect(result).toBe(queryFilter)
  104. expect(queryFilter['sorts']).toEqual([
  105. { table: 'users', column: 'name', ascending: false, nullsFirst: true },
  106. ])
  107. })
  108. test('range() should delegate to QueryModifier.range() and return the result', () => {
  109. const queryFilter = new QueryFilter(table, {
  110. action: 'select',
  111. actionValue: joinSqlFragments([ident('id'), ident('name')], ', '),
  112. })
  113. const result = queryFilter.range(0, 10)
  114. expect(result).toBeInstanceOf(QueryModifier)
  115. // The pagination gets set in the QueryModifier
  116. expect(result['pagination']).toEqual({ offset: 0, limit: 11 })
  117. })
  118. test('toSql() should delegate to QueryModifier.toSql() and return the SQL string', () => {
  119. const queryFilter = new QueryFilter(table, {
  120. action: 'select',
  121. actionValue: joinSqlFragments([ident('id'), ident('name')], ', '),
  122. })
  123. queryFilter.filter('id', '=', 1)
  124. const result = queryFilter.toSql()
  125. // Expected SQL should match the pattern from QueryUtils.selectQuery()
  126. expect(result).toBe('select id, name from public.users where id = 1;')
  127. })
  128. })
  129. describe('QueryModifier', () => {
  130. const table: QueryTable = { name: 'users', schema: 'public' }
  131. test('range() should set the pagination and return the modifier instance', () => {
  132. const queryModifier = new QueryModifier(table, {
  133. action: 'select',
  134. actionValue: joinSqlFragments([ident('id'), ident('name')], ', '),
  135. })
  136. const result = queryModifier.range(0, 10)
  137. expect(result).toBe(queryModifier)
  138. expect(queryModifier['pagination']).toEqual({ offset: 0, limit: 11 })
  139. })
  140. test('toSql() should generate the correct SQL for a count query', () => {
  141. const queryModifier = new QueryModifier(table, { action: 'count' })
  142. const result = queryModifier.toSql()
  143. expect(result).toBe('select count(*) from public.users;')
  144. })
  145. test('toSql() should generate the correct SQL for a delete query with filters', () => {
  146. const queryModifier = new QueryModifier(
  147. table,
  148. { action: 'delete' },
  149. {
  150. filters: [{ column: 'id', operator: '=', value: 1 }],
  151. actionOptions: { returning: true },
  152. }
  153. )
  154. const result = queryModifier.toSql()
  155. expect(result).toBe('delete from public.users where id = 1 returning *;')
  156. })
  157. test('toSql() should generate the correct SQL for a select query with filters, sorts and pagination', () => {
  158. const queryModifier = new QueryModifier(
  159. table,
  160. { action: 'select', actionValue: joinSqlFragments([ident('id'), ident('name')], ', ') },
  161. {
  162. filters: [{ column: 'id', operator: '>', value: 10 }],
  163. sorts: [{ table: 'users', column: 'name', ascending: true, nullsFirst: false }],
  164. }
  165. )
  166. queryModifier.range(0, 5)
  167. const result = queryModifier.toSql()
  168. expect(result).toMatchInlineSnapshot(
  169. `"select id, name from public.users where id > 10 order by users.name asc nulls last limit 6 offset 0;"`
  170. )
  171. })
  172. test('toSql() should generate the correct SQL for a truncate query', () => {
  173. const queryModifier = new QueryModifier(table, { action: 'truncate' })
  174. const result = queryModifier.toSql()
  175. expect(result).toBe('truncate public.users;')
  176. })
  177. test('toSql() should generate the correct SQL for a truncate query with cascade', () => {
  178. const queryModifier = new QueryModifier(
  179. table,
  180. { action: 'truncate' },
  181. {
  182. actionOptions: { cascade: true },
  183. }
  184. )
  185. const result = queryModifier.toSql()
  186. expect(result).toBe('truncate public.users cascade;')
  187. })
  188. })
  189. describe('Query.utils', () => {
  190. const table: QueryTable = { name: 'users', schema: 'public' }
  191. describe('countQuery', () => {
  192. test('should generate a correct count query without filters', () => {
  193. const result = QueryUtils.countQuery(table)
  194. expect(result).toBe('select count(*) from public.users;')
  195. })
  196. test('should generate a correct count query with filters', () => {
  197. const filters = [{ column: 'id', operator: '>' as const, value: 1 }]
  198. const result = QueryUtils.countQuery(table, { filters: filters })
  199. expect(result).toBe('select count(*) from public.users where id > 1;')
  200. })
  201. })
  202. describe('truncateQuery', () => {
  203. test('should generate a correct truncate query without cascade', () => {
  204. const result = QueryUtils.truncateQuery(table)
  205. expect(result).toBe('truncate public.users;')
  206. })
  207. test('should generate a correct truncate query with cascade', () => {
  208. const result = QueryUtils.truncateQuery(table, { cascade: true })
  209. expect(result).toBe('truncate public.users cascade;')
  210. })
  211. })
  212. describe('deleteQuery', () => {
  213. test('should throw an error if no filters are provided', () => {
  214. expect(() => QueryUtils.deleteQuery(table)).toThrow()
  215. })
  216. test('should generate a correct delete query with filters', () => {
  217. const filters = [{ column: 'id', operator: '=' as const, value: 1 }]
  218. const result = QueryUtils.deleteQuery(table, filters)
  219. expect(result).toBe('delete from public.users where id = 1;')
  220. })
  221. test('should include returning clause when specified', () => {
  222. const filters = [{ column: 'id', operator: '=' as const, value: 1 }]
  223. const result = QueryUtils.deleteQuery(table, filters, { returning: true })
  224. expect(result).toBe('delete from public.users where id = 1 returning *;')
  225. })
  226. test('should include enum array columns in returning clause when specified', () => {
  227. const filters = [{ column: 'id', operator: '=' as const, value: 1 }]
  228. const result = QueryUtils.deleteQuery(table, filters, {
  229. returning: true,
  230. enumArrayColumns: ['tags'],
  231. })
  232. expect(result).toBe('delete from public.users where id = 1 returning *, tags::text[];')
  233. })
  234. })
  235. describe('insertQuery', () => {
  236. test('should throw an error if no values are provided', () => {
  237. expect(() => QueryUtils.insertQuery(table, [])).toThrow()
  238. })
  239. test('should generate a correct insert query with values', () => {
  240. const values = [{ id: 1, name: 'John' }]
  241. const result = QueryUtils.insertQuery(table, values)
  242. expect(result).toMatchInlineSnapshot(
  243. `"insert into public.users (id,name) select id,name from jsonb_populate_recordset(null::public.users, '[{"id":1,"name":"John"}]');"`
  244. )
  245. })
  246. test('should include returning clause when specified', () => {
  247. const values = [{ id: 1, name: 'John' }]
  248. const result = QueryUtils.insertQuery(table, values, { returning: true })
  249. expect(result).toMatchInlineSnapshot(
  250. `"insert into public.users (id,name) select id,name from jsonb_populate_recordset(null::public.users, '[{"id":1,"name":"John"}]') returning *;"`
  251. )
  252. })
  253. test('should include enum array columns in returning clause when specified', () => {
  254. const values = [{ id: 1, name: 'John' }]
  255. const result = QueryUtils.insertQuery(table, values, {
  256. returning: true,
  257. enumArrayColumns: ['tags'],
  258. })
  259. expect(result).toMatchInlineSnapshot(
  260. `"insert into public.users (id,name) select id,name from jsonb_populate_recordset(null::public.users, '[{"id":1,"name":"John"}]') returning *, tags::text[];"`
  261. )
  262. })
  263. })
  264. describe('selectQuery', () => {
  265. test('should generate a correct select query without options', () => {
  266. const result = QueryUtils.selectQuery(table)
  267. expect(result).toBe('select * from public.users;')
  268. })
  269. test('should generate a correct select query with custom columns', () => {
  270. const result = QueryUtils.selectQuery(
  271. table,
  272. joinSqlFragments([ident('id'), ident('name')], ', ')
  273. )
  274. expect(result).toBe('select id, name from public.users;')
  275. })
  276. test('should generate a correct select query with filters', () => {
  277. const filters = [{ column: 'id', operator: '>' as const, value: 1 }]
  278. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  279. expect(result).toBe('select * from public.users where id > 1;')
  280. })
  281. test('should generate a correct select query with sorts', () => {
  282. const sorts = [{ table: 'users', column: 'name', ascending: true, nullsFirst: false }]
  283. const result = QueryUtils.selectQuery(table, safeSql`*`, { sorts: sorts })
  284. expect(result).toBe('select * from public.users order by users.name asc nulls last;')
  285. })
  286. test('should generate a correct select query with pagination', () => {
  287. const pagination = { limit: 10, offset: 0 }
  288. const result = QueryUtils.selectQuery(table, safeSql`*`, { pagination: pagination })
  289. expect(result).toBe('select * from public.users limit 10 offset 0;')
  290. })
  291. test('should ignore sorts with undefined column', () => {
  292. const sorts: Sort[] = [{ table: 'users', column: '', ascending: true, nullsFirst: false }]
  293. const result = QueryUtils.selectQuery(table, safeSql`*`, { sorts: sorts })
  294. expect(result).toMatchInlineSnapshot(`"select * from public.users;"`)
  295. })
  296. })
  297. describe('updateQuery', () => {
  298. test('should throw an error if no filters are provided', () => {
  299. const value = { name: 'John' }
  300. expect(() => QueryUtils.updateQuery(table, value)).toThrow()
  301. })
  302. test('should generate a correct update query with filters', () => {
  303. const value = { name: 'John' }
  304. const filters = [{ column: 'id', operator: '=' as const, value: 1 }]
  305. const result = QueryUtils.updateQuery(table, value, { filters: filters })
  306. expect(result).toMatchInlineSnapshot(
  307. `"update public.users set (name) = (select name from json_populate_record(null::public.users, '{"name":"John"}')) where id = 1;"`
  308. )
  309. })
  310. test('should include returning clause when specified', () => {
  311. const value = { name: 'John' }
  312. const filters = [{ column: 'id', operator: '=' as const, value: 1 }]
  313. const result = QueryUtils.updateQuery(table, value, {
  314. filters: filters,
  315. returning: true,
  316. })
  317. expect(result).toMatchInlineSnapshot(
  318. `"update public.users set (name) = (select name from json_populate_record(null::public.users, '{"name":"John"}')) where id = 1 returning *;"`
  319. )
  320. })
  321. test('should include enum array columns in returning clause when specified', () => {
  322. const value = { name: 'John' }
  323. const filters = [{ column: 'id', operator: '=' as const, value: 1 }]
  324. const result = QueryUtils.updateQuery(table, value, {
  325. filters: filters,
  326. returning: true,
  327. enumArrayColumns: ['tags'],
  328. })
  329. expect(result).toMatchInlineSnapshot(
  330. `"update public.users set (name) = (select name from json_populate_record(null::public.users, '{"name":"John"}')) where id = 1 returning *, tags::text[];"`
  331. )
  332. })
  333. })
  334. describe('Query.utils internal functions', () => {
  335. describe('applyFilters', () => {
  336. test('should correctly apply equality filters', () => {
  337. const filters: Filter[] = [{ column: 'name', operator: '=', value: 'John' }]
  338. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  339. expect(result).toBe("select * from public.users where name = 'John';")
  340. })
  341. test('should correctly apply multiple filters with AND logic', () => {
  342. const filters: Filter[] = [
  343. { column: 'name', operator: '=', value: 'John' },
  344. { column: 'age', operator: '>', value: 25 },
  345. ]
  346. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  347. expect(result).toBe("select * from public.users where name = 'John' and age > 25;")
  348. })
  349. test('should correctly handle "in" operator with array values', () => {
  350. const filters: Filter[] = [{ column: 'id', operator: 'in', value: [1, 2, 3] }]
  351. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  352. expect(result).toBe('select * from public.users where id in (1,2,3);')
  353. })
  354. test('should correctly handle "in" operator with comma-separated string', () => {
  355. const filters: Filter[] = [{ column: 'id', operator: 'in', value: '1,2,3' }]
  356. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  357. expect(result).toBe("select * from public.users where id in ('1','2','3');")
  358. })
  359. test('should correctly handle "is" operator with null value', () => {
  360. const filters: Filter[] = [{ column: 'email', operator: 'is', value: 'null' }]
  361. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  362. expect(result).toBe('select * from public.users where email is null;')
  363. })
  364. test('should correctly handle "is" operator with not null value', () => {
  365. const filters: Filter[] = [{ column: 'email', operator: 'is', value: 'not null' }]
  366. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  367. expect(result).toBe('select * from public.users where email is not null;')
  368. })
  369. test('should correctly handle "is" operator with boolean values', () => {
  370. const filters: Filter[] = [{ column: 'active', operator: 'is', value: 'true' }]
  371. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  372. expect(result).toBe('select * from public.users where active is true;')
  373. })
  374. test('should correctly escape string values in filters', () => {
  375. const filters: Filter[] = [{ column: 'name', operator: '=', value: "O'Reilly" }]
  376. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  377. expect(result).toContain("where name = 'O''Reilly'")
  378. })
  379. test('should error if tuple filter value length does not match column length', () => {
  380. const filters: Filter[] = [{ column: ['id', 'version'], operator: '=', value: [1] }]
  381. expect(() => QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })).toThrowError(
  382. 'Tuple filter value must have the same length as the column array'
  383. )
  384. })
  385. test('should error if tuple filter value is not an array', () => {
  386. const filters: Filter[] = [{ column: ['id', 'version'], operator: '=', value: 1 }]
  387. expect(() => QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })).toThrowError(
  388. 'Tuple filter value must be an array'
  389. )
  390. })
  391. test('should correctly handle tuple filters with equality operator', () => {
  392. const filters: Filter[] = [{ column: ['id', 'version'], operator: '=', value: [1, 2] }]
  393. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  394. expect(result).toBe('select * from public.users where (id, version) = (1, 2);')
  395. })
  396. test('should correctly handle tuple filters with greater than operator', () => {
  397. const filters: Filter[] = [{ column: ['id', 'version'], operator: '>', value: [1, 2] }]
  398. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  399. expect(result).toBe('select * from public.users where (id, version) > (1, 2);')
  400. })
  401. test('should correctly handle tuple filters with greater than or equal operator', () => {
  402. const filters: Filter[] = [{ column: ['id', 'version'], operator: '>=', value: [1, 2] }]
  403. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  404. expect(result).toBe('select * from public.users where (id, version) >= (1, 2);')
  405. })
  406. test('should correctly handle tuple filters with less than operator', () => {
  407. const filters: Filter[] = [{ column: ['id', 'version'], operator: '<', value: [10, 5] }]
  408. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  409. expect(result).toBe('select * from public.users where (id, version) < (10, 5);')
  410. })
  411. test('should correctly handle tuple filters with less than or equal operator', () => {
  412. const filters: Filter[] = [{ column: ['id', 'version'], operator: '<=', value: [10, 5] }]
  413. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  414. expect(result).toBe('select * from public.users where (id, version) <= (10, 5);')
  415. })
  416. test('should correctly handle tuple filters with not equal operator (<>)', () => {
  417. const filters: Filter[] = [{ column: ['id', 'version'], operator: '<>', value: [1, 2] }]
  418. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  419. expect(result).toBe('select * from public.users where (id, version) <> (1, 2);')
  420. })
  421. test('should correctly handle tuple filters with in operator', () => {
  422. const filters: Filter[] = [
  423. {
  424. column: ['id', 'version'],
  425. operator: 'in',
  426. value: [
  427. [1, 2],
  428. [3, 4],
  429. [5, 6],
  430. ],
  431. },
  432. ]
  433. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  434. expect(result).toBe(
  435. 'select * from public.users where (id, version) in ((1, 2), (3, 4), (5, 6));'
  436. )
  437. })
  438. test('should error if tuple filters with in operator do not have matching number of array values', () => {
  439. const filters: Filter[] = [
  440. {
  441. column: ['id', 'version'],
  442. operator: 'in',
  443. value: [[1, 2], [3, 4], [5]],
  444. },
  445. ]
  446. expect(() => QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })).toThrowError()
  447. })
  448. test('should correctly handle tuple filters with in operator using strings', () => {
  449. const filters: Filter[] = [
  450. {
  451. column: ['id', 'version'],
  452. operator: 'in',
  453. value: ['one,two', 'three,four', 'five,six'],
  454. },
  455. ]
  456. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  457. expect(result).toBe(
  458. `select * from public.users where (id, version) in (('one', 'two'), ('three', 'four'), ('five', 'six'));`
  459. )
  460. })
  461. test('should error if tuple filters with in operator do not have matching number of stringified values', () => {
  462. const filters: Filter[] = [
  463. {
  464. column: ['id', 'version'],
  465. operator: 'in',
  466. value: ['one,two', 'three,four', 'five'],
  467. },
  468. ]
  469. expect(() => QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })).toThrowError()
  470. })
  471. test('should correctly handle tuple filters with string values', () => {
  472. const filters: Filter[] = [
  473. { column: ['first_name', 'last_name'], operator: '=', value: ['John', 'Doe'] },
  474. ]
  475. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  476. expect(result).toBe(
  477. "select * from public.users where (first_name, last_name) = ('John', 'Doe');"
  478. )
  479. })
  480. test('should correctly handle mixed tuple and regular filters', () => {
  481. const filters: Filter[] = [
  482. { column: ['id', 'version'], operator: '>', value: [1, 2] },
  483. { column: 'active', operator: '=', value: true },
  484. ]
  485. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  486. expect(result).toBe(
  487. 'select * from public.users where (id, version) > (1, 2) and active = true;'
  488. )
  489. })
  490. test('should error when trying to use "is" operator as a tuple filter', () => {
  491. const filters: Filter[] = [
  492. {
  493. column: ['id', 'version'],
  494. operator: 'is',
  495. value: [null, null],
  496. },
  497. ]
  498. expect(() => QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })).toThrowError()
  499. })
  500. test('should error when trying to use "~~" operator as a tuple filter', () => {
  501. const filters: Filter[] = [
  502. {
  503. column: ['first_name', 'last_name'],
  504. operator: '~~',
  505. value: ['%John%', '%Doe%'],
  506. },
  507. ]
  508. expect(() => QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })).toThrowError()
  509. })
  510. test('should error when trying to use "~~*" operator as a tuple filter', () => {
  511. const filters: Filter[] = [
  512. { column: ['first_name', 'last_name'], operator: '~~*', value: ['%john%', '%doe%'] },
  513. ]
  514. expect(() => QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })).toThrowError()
  515. })
  516. test('should error when trying to use "!~~" operator as a tuple filter', () => {
  517. const filters: Filter[] = [
  518. { column: ['first_name', 'last_name'], operator: '!~~', value: ['%Admin%', '%System%'] },
  519. ]
  520. expect(() => QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })).toThrowError()
  521. })
  522. test('should error when trying to use "!~~*" operator as a tuple filter', () => {
  523. const filters: Filter[] = [
  524. { column: ['first_name', 'last_name'], operator: '!~~*', value: ['%admin%', '%system%'] },
  525. ]
  526. expect(() => QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })).toThrowError()
  527. })
  528. })
  529. describe('applySorts', () => {
  530. test('should correctly apply a single sort with default options', () => {
  531. const sorts: Sort[] = [
  532. { table: 'users', column: 'name', ascending: true, nullsFirst: false },
  533. ]
  534. const result = QueryUtils.selectQuery(table, safeSql`*`, { sorts: sorts })
  535. expect(result).toBe('select * from public.users order by users.name asc nulls last;')
  536. })
  537. test('should correctly apply a descending sort', () => {
  538. const sorts: Sort[] = [
  539. { table: 'users', column: 'name', ascending: false, nullsFirst: false },
  540. ]
  541. const result = QueryUtils.selectQuery(table, safeSql`*`, { sorts: sorts })
  542. expect(result).toBe('select * from public.users order by users.name desc nulls last;')
  543. })
  544. test('should correctly apply nulls first option', () => {
  545. const sorts: Sort[] = [
  546. { table: 'users', column: 'name', ascending: true, nullsFirst: true },
  547. ]
  548. const result = QueryUtils.selectQuery(table, safeSql`*`, { sorts: sorts })
  549. expect(result).toBe('select * from public.users order by users.name asc nulls first;')
  550. })
  551. test('should correctly apply multiple sorts', () => {
  552. const sorts: Sort[] = [
  553. { table: 'users', column: 'last_name', ascending: true, nullsFirst: false },
  554. { table: 'users', column: 'first_name', ascending: true, nullsFirst: false },
  555. ]
  556. const result = QueryUtils.selectQuery(table, safeSql`*`, { sorts: sorts })
  557. expect(result).toBe(
  558. 'select * from public.users order by users.last_name asc nulls last, users.first_name asc nulls last;'
  559. )
  560. })
  561. test('should ignore sorts with undefined column', () => {
  562. const sorts: Sort[] = [{ table: 'users', column: '', ascending: true, nullsFirst: false }]
  563. const result = QueryUtils.selectQuery(table, safeSql`*`, { sorts: sorts })
  564. expect(result).toMatchInlineSnapshot(`"select * from public.users;"`)
  565. })
  566. })
  567. describe('filterLiteral', () => {
  568. test('should correctly handle array literal syntax', () => {
  569. const filters: Filter[] = [{ column: 'tags', operator: '=', value: "ARRAY['tag1','tag2']" }]
  570. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  571. expect(result).toBe("select * from public.users where tags = ARRAY['tag1','tag2'];")
  572. })
  573. test('should correctly handle non-string values', () => {
  574. const filters: Filter[] = [{ column: 'active', operator: '=', value: true }]
  575. const result = QueryUtils.selectQuery(table, safeSql`*`, { filters: filters })
  576. expect(result).toBe('select * from public.users where active = true;')
  577. })
  578. })
  579. describe('queryTable', () => {
  580. test('should correctly format the table name with schema', () => {
  581. const result = QueryUtils.selectQuery({ name: 'orders', schema: 'shop' })
  582. expect(result).toBe('select * from shop.orders;')
  583. })
  584. })
  585. })
  586. })
  587. describe('End-to-end query chaining', () => {
  588. test('should correctly build a simple select query', () => {
  589. const query = new Query()
  590. const sql = query
  591. .from('users', 'public')
  592. .select(joinSqlFragments([ident('id'), ident('name'), ident('email')], ', '))
  593. .toSql()
  594. expect(sql).toBe('select id, name, email from public.users;')
  595. })
  596. test('should correctly build a filtered select query', () => {
  597. const query = new Query()
  598. const sql = query
  599. .from('users', 'public')
  600. .select(joinSqlFragments([ident('id'), ident('name'), ident('email')], ', '))
  601. .filter('id', '>', 10)
  602. .toSql()
  603. expect(sql).toBe('select id, name, email from public.users where id > 10;')
  604. })
  605. test('should correctly build a select query with multiple filters', () => {
  606. const query = new Query()
  607. const sql = query
  608. .from('users', 'public')
  609. .select(joinSqlFragments([ident('id'), ident('name'), ident('email')], ', '))
  610. .filter('id', '>', 10)
  611. .filter('name', '~~', '%John%')
  612. .toSql()
  613. expect(sql).toBe(
  614. "select id, name, email from public.users where id > 10 and name::text ~~ '%John%';"
  615. )
  616. })
  617. test('should correctly build a select query with match criteria', () => {
  618. const query = new Query()
  619. const sql = query
  620. .from('users', 'public')
  621. .select(joinSqlFragments([ident('id'), ident('name'), ident('email')], ', '))
  622. .match({ active: true, role: 'admin' })
  623. .toSql()
  624. expect(sql).toBe(
  625. "select id, name, email from public.users where active = true and role = 'admin';"
  626. )
  627. })
  628. test('should correctly build a select query with sorting', () => {
  629. const query = new Query()
  630. const sql = query
  631. .from('users', 'public')
  632. .select(joinSqlFragments([ident('id'), ident('name'), ident('email')], ', '))
  633. .order('users', 'name', true, false)
  634. .toSql()
  635. expect(sql).toBe('select id, name, email from public.users order by users.name asc nulls last;')
  636. })
  637. test('should correctly build a select query with pagination', () => {
  638. const query = new Query()
  639. const sql = query
  640. .from('users', 'public')
  641. .select(joinSqlFragments([ident('id'), ident('name'), ident('email')], ', '))
  642. .range(0, 9)
  643. .toSql()
  644. expect(sql).toBe('select id, name, email from public.users limit 10 offset 0;')
  645. })
  646. test('should correctly build a complete select query with filters, sorting and pagination', () => {
  647. const query = new Query()
  648. const sql = query
  649. .from('users', 'public')
  650. .select(joinSqlFragments([ident('id'), ident('name'), ident('email')], ', '))
  651. .filter('id', '>', 10)
  652. .match({ active: true })
  653. .order('users', 'name', true, false)
  654. .range(0, 9)
  655. .toSql()
  656. expect(sql).toBe(
  657. 'select id, name, email from public.users where id > 10 and active = true order by users.name asc nulls last limit 10 offset 0;'
  658. )
  659. })
  660. test('should correctly build an insert query', () => {
  661. const query = new Query()
  662. const sql = query
  663. .from('users', 'public')
  664. .insert([{ name: 'John', email: 'john@example.com' }], { returning: true })
  665. .toSql()
  666. expect(sql).toMatchInlineSnapshot(
  667. `"insert into public.users (name,email) select name,email from jsonb_populate_recordset(null::public.users, '[{"name":"John","email":"john@example.com"}]') returning *;"`
  668. )
  669. })
  670. test('should correctly build an update query', () => {
  671. const query = new Query()
  672. const sql = query
  673. .from('users', 'public')
  674. .update({ name: 'Updated Name' }, { returning: true })
  675. .filter('id', '=', 1)
  676. .toSql()
  677. expect(sql).toMatchInlineSnapshot(
  678. `"update public.users set (name) = (select name from json_populate_record(null::public.users, '{"name":"Updated Name"}')) where id = 1 returning *;"`
  679. )
  680. })
  681. test('should correctly build a delete query', () => {
  682. const query = new Query()
  683. const sql = query
  684. .from('users', 'public')
  685. .delete({ returning: true })
  686. .filter('id', '=', 1)
  687. .toSql()
  688. expect(sql).toBe('delete from public.users where id = 1 returning *;')
  689. })
  690. test('should correctly build a count query', () => {
  691. const query = new Query()
  692. const sql = query.from('users', 'public').count().filter('active', '=', true).toSql()
  693. expect(sql).toBe('select count(*) from public.users where active = true;')
  694. })
  695. test('should correctly build a truncate query', () => {
  696. const query = new Query()
  697. const sql = query.from('users', 'public').truncate().toSql()
  698. expect(sql).toBe('truncate public.users;')
  699. })
  700. })