index.ts

Filename	Percent	Threshold	Total	Covered	Uncovered
src/db/index.ts	100.00%	80%	102	102	0

import { PgTable, type TableConfig } from 'drizzle-orm/pg-core';
import { type TablesRelationalConfig, sql } from 'drizzle-orm';

import { DBTransactionError } from 'exceptions/errors.js';
import type { Logger } from 'winston';
import type { PgUpdateSetSource } from 'drizzle-orm/pg-core';
import type { PostgresJsDatabase } from 'drizzle-orm/postgres-js';
import type { PostgresJsTransaction } from 'drizzle-orm/postgres-js';
import { checkForDuplicates } from './utils.js';
import { chunk } from 'lodash-es';
import { defaultLogger } from 'utils/logger.js';
import type { schema } from './models.js';

/** A drizzle PostgreSQL database client */
export type DB = PostgresJsDatabase<typeof schema>;

export class Query {
  constructor(
    private db: DB,
    private logger: Logger = defaultLogger
  ) {}

  /**
   * Bulk upsert
   * @param model Model table to upsert records into
   * @param instancesToCreate Instances to upsert
   * @param runningTransaction A transaction to use when running several bulkUpserts within a single transaction
   */
  async bulkUpsert<
    T extends PgTable<TableConfig>,
    U extends PostgresJsTransaction<
      Record<string, unknown>,
      TablesRelationalConfig
    >,
  >(model: T, instancesToCreate: T['$inferInsert'][], runningTransaction?: U) {
    if (instancesToCreate.length === 0) return;

    // The database table name
    const modelName = model[Symbol.for('drizzle:BaseName')];

    this.logger.debug(
      `Upserting ${instancesToCreate.length} instances to "${modelName}" table`
    );

    checkForDuplicates(instancesToCreate as { uid: string }[], modelName);

    // Set fields on conflict using Postgres excluded alias
    const onConflictSetFields = Object.fromEntries(
      Object.keys(instancesToCreate[0])
        .filter((prop) => prop !== 'uid') // Exclude "uid" primary keys
        .map((x) => [x, sql.raw(`excluded."${x}"`)])
    ) as PgUpdateSetSource<T>;

    const transactionContext = (runningTransaction ||
      this.db) as typeof this.db;

    await transactionContext.transaction(async (tx) => {
      // Chunk to ensure we don't hit MAX_PARAMETERS_EXCEEDED in Postgres
      const chunksToCreate = chunk(instancesToCreate, 500);

      for (const chunkToCreate of chunksToCreate) {
        try {
          await tx.insert(model).values(chunkToCreate).onConflictDoUpdate({
            target: model['uid'],
            set: onConflictSetFields,
          });
        } catch (e: unknown) {
          if (e instanceof Error) {
            throw new DBTransactionError(
              `BulkUpsert transaction failed on table: ${modelName}\n${e.message}`
            );
          } else {
            throw new DBTransactionError(
              `BulkUpsert transaction failed on table: ${modelName}`
            );
          }
        }
      }
    });
  }
}

[]

TypeScript Coverage Report generated by type-coverage and typescript-coverage-report at Thu, 04 Apr 2024 19:50:44 GMT

TypeScript coverage report