The minimalistic document archiving platform.
import { describe, expect, test } from 'vitest';
import { usersTable } from '../../users/users.table';
import { setupDatabase } from './database';
import { createInMemoryDatabase } from './database.test-utils';
import { createBatchedIterator, createIterator, getRuntimeTableColumns } from './database.usecases';
const createUsers = ({ count }: { count: number }) =>
Array.from({ length: count }, (_, i) => ({ id: `usr_${i}`, email: `user-${i}@papra.dev` }));
describe('database usecases', () => {
describe('createIterator', () => {
test('permit to iterate over a large collection of records', async () => {
const { db } = await createInMemoryDatabase({
users: createUsers({ count: 10 }),
});
const query = db.select().from(usersTable).orderBy(usersTable.id).$dynamic();
const iterator = createIterator({ query });
const results: string[] = [];
for await (const record of iterator) {
results.push(record.id);
}
expect(results.length).to.eql(10);
expect(results).to.eql([
'usr_0',
'usr_1',
'usr_2',
'usr_3',
'usr_4',
'usr_5',
'usr_6',
'usr_7',
'usr_8',
'usr_9',
]);
});
test('it works with Array.fromAsync', async () => {
const { db } = await createInMemoryDatabase({
users: createUsers({ count: 10 }),
});
const query = db.select().from(usersTable).orderBy(usersTable.id).$dynamic();
const iterator = createIterator({ query });
const results = await Array.fromAsync(iterator);
expect(results.length).to.eql(10);
});
test('the amount of records per page is configurable', async () => {
const { db } = await createInMemoryDatabase({
users: createUsers({ count: 10 }),
});
const query = db.select().from(usersTable).orderBy(usersTable.id).$dynamic();
const iterator = createIterator({ query, batchSize: 3 });
const results: string[] = [];
for await (const record of iterator) {
results.push(record.id);
}
expect(results.length).to.eql(10);
expect(results).to.eql([
'usr_0',
'usr_1',
'usr_2',
'usr_3',
'usr_4',
'usr_5',
'usr_6',
'usr_7',
'usr_8',
'usr_9',
]);
});
});
describe('createBatchedIterator', () => {
test('iterates over all items using the getBatch function', async () => {
const data = [1, 2, 3, 4, 5];
const iterator = createBatchedIterator({
getBatch: async ({ offset, limit }) => data.slice(offset, offset + limit),
batchSize: 2,
});
const results = await Array.fromAsync(iterator);
expect(results).to.eql([1, 2, 3, 4, 5]);
});
test('handles empty collections', async () => {
const iterator = createBatchedIterator({
getBatch: async () => [],
batchSize: 10,
});
const results = await Array.fromAsync(iterator);
expect(results).to.eql([]);
});
test('handles collections smaller than batch size', async () => {
const data = [1, 2, 3];
const iterator = createBatchedIterator({
getBatch: async ({ offset, limit }) => data.slice(offset, offset + limit),
batchSize: 10,
});
const results = await Array.fromAsync(iterator);
expect(results).to.eql([1, 2, 3]);
});
test('handles collections that are exact multiples of batch size', async () => {
const data = [1, 2, 3, 4, 5, 6];
const iterator = createBatchedIterator({
getBatch: async ({ offset, limit }) => data.slice(offset, offset + limit),
batchSize: 3,
});
const results = await Array.fromAsync(iterator);
expect(results).to.eql([1, 2, 3, 4, 5, 6]);
});
});
describe('getRuntimeTableColumns', () => {
test('returns the list of columns for a given table', async () => {
const { db } = setupDatabase({ url: ':memory:' });
await db.run(`CREATE TABLE test_table (id INTEGER PRIMARY KEY, name TEXT)`);
expect(await getRuntimeTableColumns({ tableName: 'test_table', db })).to.eql(['id', 'name']);
});
test('returns an empty array for a non-existing table', async () => {
const { db } = setupDatabase({ url: ':memory:' });
expect(await getRuntimeTableColumns({ tableName: 'non_existing_table', db })).to.eql([]);
});
});
});