@prairielearn/postgres 1.7.0 → 1.7.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @prairielearn/postgres
 
+## 1.7.2
+
+### Patch Changes
+
+- 2b003b4d9: Upgrade all dependencies
+
+## 1.7.1
+
+### Patch Changes
+
+- 8fd47d928: Upgrade all dependencies
+
 ## 1.7.0
 
 ### Minor Changes

package/README.md

@@ -23,7 +23,7 @@ await sqldb.initAsync(
     max: 2,
     idleTimeoutMillis: 30000,
   },
-  idleErrorHandler
+  idleErrorHandler,
 );
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/postgres",
-  "version": "1.7.0",
+  "version": "1.7.2",
   "main": "./dist/index.js",
   "repository": {
     "type": "git",
@@ -16,19 +16,19 @@
     "@prairielearn/tsconfig": "^0.0.0",
     "@types/mocha": "^10.0.1",
     "@types/multipipe": "^3.0.1",
-    "@types/node": "^18.16.3",
+    "@types/node": "^18.16.19",
     "mocha": "^10.2.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.4"
+    "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@types/debug": "^4.1.7",
-    "@types/lodash": "^4.14.194",
+    "@types/debug": "^4.1.8",
+    "@types/lodash": "^4.14.195",
     "@types/pg-cursor": "^2.7.0",
     "multipipe": "^4.0.0",
-    "pg": "^8.10.0",
-    "pg-cursor": "^2.9.0",
-    "pg-pool": "^3.6.0",
+    "pg": "^8.11.1",
+    "pg-cursor": "^2.10.1",
+    "pg-pool": "^3.6.1",
     "zod": "^3.21.4"
   }
 }

package/src/pool.test.ts

@@ -31,7 +31,7 @@ describe('@prairielearn/postgres', function () {
     await postgresTestUtils.createDatabase();
     await queryAsync(
       'CREATE TABLE workspaces (id BIGSERIAL PRIMARY KEY, created_at TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP);',
-      {}
+      {},
     );
     await queryAsync('INSERT INTO workspaces (id) SELECT s FROM generate_series(1, 100) AS s', {});
   });
@@ -58,7 +58,7 @@ describe('@prairielearn/postgres', function () {
       const rows = await queryRows(
         'SELECT * FROM workspaces WHERE id <= $1;',
         [10],
-        WorkspaceSchema
+        WorkspaceSchema,
       );
       assert.lengthOf(rows, 10);
     });
@@ -109,7 +109,7 @@ describe('@prairielearn/postgres', function () {
       const row = await queryOptionalRow(
         'SELECT * FROM workspaces WHERE id = $1;',
         [1],
-        WorkspaceSchema
+        WorkspaceSchema,
       );
       assert.isNotNull(row);
       assert.equal(row?.id, '1');
@@ -118,7 +118,7 @@ describe('@prairielearn/postgres', function () {
     it('handles missing result', async () => {
       const row = await queryOptionalRow(
         'SELECT * FROM workspaces WHERE id = -1;',
-        WorkspaceSchema
+        WorkspaceSchema,
       );
       assert.isNull(row);
     });
@@ -196,7 +196,7 @@ describe('@prairielearn/postgres', function () {
         const cursor = await queryValidatedCursor(
           'SELECT * FROM workspaces WHERE id <= 10 ORDER BY id ASC;',
           {},
-          WorkspaceSchema
+          WorkspaceSchema,
         );
         const allRows = [];
         for await (const rows of cursor.iterate(10)) {
@@ -212,7 +212,7 @@ describe('@prairielearn/postgres', function () {
         const cursor = await queryValidatedCursor(
           'SELECT * FROM workspaces WHERE id <= 10 ORDER BY id ASC;',
           {},
-          BadWorkspaceSchema
+          BadWorkspaceSchema,
         );
 
         async function readAllRows() {
@@ -234,7 +234,7 @@ describe('@prairielearn/postgres', function () {
         const cursor = await queryValidatedCursor(
           'SELECT * FROM workspaces WHERE id <= 10 ORDER BY id ASC;',
           {},
-          WorkspaceSchema
+          WorkspaceSchema,
         );
         const stream = cursor.stream(1);
         const allRows = [];
@@ -249,7 +249,7 @@ describe('@prairielearn/postgres', function () {
         const cursor = await queryValidatedCursor(
           'SELECT * FROM workspaces ORDER BY id ASC;',
           {},
-          BadWorkspaceSchema
+          BadWorkspaceSchema,
         );
         const stream = cursor.stream(1);
 

package/src/pool.ts

@@ -67,7 +67,7 @@ function debugParams(params: QueryParams): string {
  */
 function paramsToArray(
   sql: string,
-  params: QueryParams
+  params: QueryParams,
 ): { processedSql: string; paramsArray: any } {
   if (typeof sql !== 'string') throw new Error('SQL must be a string');
   if (Array.isArray(params)) {
@@ -159,7 +159,7 @@ export class PostgresPool {
    */
   async initAsync(
     pgConfig: pg.PoolConfig,
-    idleErrorHandler: (error: Error, client: pg.PoolClient) => void
+    idleErrorHandler: (error: Error, client: pg.PoolClient) => void,
   ): Promise<void> {
     this.pool = new pg.Pool(pgConfig);
     this.pool.on('error', function (err, client) {
@@ -192,7 +192,7 @@ export class PostgresPool {
       } catch (err: any) {
         if (retryCount === retryTimeouts.length) {
           throw new Error(
-            `Could not connect to Postgres after ${retryTimeouts.length} attempts: ${err.message}`
+            `Could not connect to Postgres after ${retryTimeouts.length} attempts: ${err.message}`,
           );
         }
 
@@ -288,7 +288,7 @@ export class PostgresPool {
   async queryWithClientAsync(
     client: pg.PoolClient,
     sql: string,
-    params: QueryParams
+    params: QueryParams,
   ): Promise<pg.QueryResult> {
     this._queryCount += 1;
     debug('queryWithClient()', 'sql:', debugString(sql));
@@ -316,7 +316,7 @@ export class PostgresPool {
   async queryWithClientOneRowAsync(
     client: pg.PoolClient,
     sql: string,
-    params: QueryParams
+    params: QueryParams,
   ): Promise<pg.QueryResult> {
     debug('queryWithClientOneRow()', 'sql:', debugString(sql));
     debug('queryWithClientOneRow()', 'params:', debugParams(params));
@@ -345,7 +345,7 @@ export class PostgresPool {
   async queryWithClientZeroOrOneRowAsync(
     client: pg.PoolClient,
     sql: string,
-    params: QueryParams
+    params: QueryParams,
   ): Promise<QueryResult> {
     debug('queryWithClientZeroOrOneRow()', 'sql:', debugString(sql));
     debug('queryWithClientZeroOrOneRow()', 'params:', debugParams(params));
@@ -395,7 +395,7 @@ export class PostgresPool {
   rollbackWithClient(
     client: pg.PoolClient,
     _done: (release?: any) => void,
-    callback: (err: Error | null) => void
+    callback: (err: Error | null) => void,
   ) {
     // Note that we can't use `util.callbackify` here because this function
     // has an additional unused `done` parameter for backwards compatibility.
@@ -456,7 +456,7 @@ export class PostgresPool {
     client: pg.PoolClient,
     _done: (rollback?: any) => void,
     err: Error | null | undefined,
-    callback: (error: Error | null) => void
+    callback: (error: Error | null) => void,
   ): void {
     this.endTransactionAsync(client, err)
       .then(() => callback(null))
@@ -645,7 +645,7 @@ export class PostgresPool {
   async callWithClientAsync(
     client: pg.PoolClient,
     functionName: string,
-    params: any[]
+    params: any[],
   ): Promise<pg.QueryResult> {
     debug('callWithClient()', 'function:', functionName);
     debug('callWithClient()', 'params:', debugParams(params));
@@ -668,7 +668,7 @@ export class PostgresPool {
   async callWithClientOneRowAsync(
     client: pg.PoolClient,
     functionName: string,
-    params: any[]
+    params: any[],
   ): Promise<pg.QueryResult> {
     debug('callWithClientOneRow()', 'function:', functionName);
     debug('callWithClientOneRow()', 'params:', debugParams(params));
@@ -696,7 +696,7 @@ export class PostgresPool {
   async callWithClientZeroOrOneRowAsync(
     client: pg.PoolClient,
     functionName: string,
-    params: any[]
+    params: any[],
   ): Promise<pg.QueryResult> {
     debug('callWithClientZeroOrOneRow()', 'function:', functionName);
     debug('callWithClientZeroOrOneRow()', 'params:', debugParams(params));
@@ -724,7 +724,7 @@ export class PostgresPool {
   async queryValidatedRows<Model extends z.ZodTypeAny>(
     query: string,
     params: QueryParams,
-    model: Model
+    model: Model,
   ): Promise<z.infer<Model>[]> {
     const results = await this.queryAsync(query, params);
     return z.array(model).parse(results.rows);
@@ -737,7 +737,7 @@ export class PostgresPool {
   async queryValidatedOneRow<Model extends z.ZodTypeAny>(
     query: string,
     params: QueryParams,
-    model: Model
+    model: Model,
   ): Promise<z.infer<Model>> {
     const results = await this.queryOneRowAsync(query, params);
     return model.parse(results.rows[0]);
@@ -750,7 +750,7 @@ export class PostgresPool {
   async queryValidatedZeroOrOneRow<Model extends z.ZodTypeAny>(
     query: string,
     params: QueryParams,
-    model: Model
+    model: Model,
   ): Promise<z.infer<Model> | null> {
     const results = await this.queryZeroOrOneRowAsync(query, params);
     if (results.rows.length === 0) {
@@ -768,7 +768,7 @@ export class PostgresPool {
   async queryValidatedSingleColumnRows<Model extends z.ZodTypeAny>(
     query: string,
     params: QueryParams,
-    model: Model
+    model: Model,
   ): Promise<z.infer<Model>[]> {
     const results = await this.queryAsync(query, params);
     if (results.fields.length !== 1) {
@@ -787,7 +787,7 @@ export class PostgresPool {
   async queryValidatedSingleColumnOneRow<Model extends z.ZodTypeAny>(
     query: string,
     params: QueryParams,
-    model: Model
+    model: Model,
   ): Promise<z.infer<Model>> {
     const results = await this.queryOneRowAsync(query, params);
     if (results.fields.length !== 1) {
@@ -805,7 +805,7 @@ export class PostgresPool {
   async queryValidatedSingleColumnZeroOrOneRow<Model extends z.ZodTypeAny>(
     query: string,
     params: QueryParams,
-    model: Model
+    model: Model,
   ): Promise<z.infer<Model> | null> {
     const results = await this.queryZeroOrOneRowAsync(query, params);
     if (results.fields.length !== 1) {
@@ -826,7 +826,7 @@ export class PostgresPool {
   async callValidatedRows<Model extends z.ZodTypeAny>(
     sprocName: string,
     params: any[],
-    model: Model
+    model: Model,
   ): Promise<z.infer<Model>[]> {
     const results = await this.callAsync(sprocName, params);
     return z.array(model).parse(results.rows);
@@ -839,7 +839,7 @@ export class PostgresPool {
   async callValidatedOneRow<Model extends z.ZodTypeAny>(
     sprocName: string,
     params: any[],
-    model: Model
+    model: Model,
   ): Promise<z.infer<Model>> {
     const results = await this.callOneRowAsync(sprocName, params);
     return model.parse(results.rows[0]);
@@ -852,7 +852,7 @@ export class PostgresPool {
   async callValidatedZeroOrOneRow<Model extends z.ZodTypeAny>(
     sprocName: string,
     params: any[],
-    model: Model
+    model: Model,
   ): Promise<z.infer<Model> | null> {
     const results = await this.callZeroOrOneRowAsync(sprocName, params);
     if (results.rows.length === 0) {
@@ -866,12 +866,12 @@ export class PostgresPool {
   async queryRows<Model extends z.ZodTypeAny>(
     sql: string,
     params: QueryParams,
-    model: Model
+    model: Model,
   ): Promise<z.infer<Model>[]>;
   async queryRows<Model extends z.ZodTypeAny>(
     sql: string,
     paramsOrSchema: QueryParams | Model,
-    maybeModel?: Model
+    maybeModel?: Model,
   ) {
     const params = maybeModel === undefined ? {} : (paramsOrSchema as QueryParams);
     const model = maybeModel === undefined ? (paramsOrSchema as Model) : maybeModel;
@@ -889,12 +889,12 @@ export class PostgresPool {
   async queryRow<Model extends z.ZodTypeAny>(
     sql: string,
     params: QueryParams,
-    model: Model
+    model: Model,
   ): Promise<z.infer<Model>>;
   async queryRow<Model extends z.ZodTypeAny>(
     sql: string,
     paramsOrSchema: QueryParams | Model,
-    maybeModel?: Model
+    maybeModel?: Model,
   ) {
     const params = maybeModel === undefined ? {} : (paramsOrSchema as QueryParams);
     const model = maybeModel === undefined ? (paramsOrSchema as Model) : maybeModel;
@@ -909,17 +909,17 @@ export class PostgresPool {
 
   async queryOptionalRow<Model extends z.ZodTypeAny>(
     sql: string,
-    model: Model
+    model: Model,
   ): Promise<z.infer<Model> | null>;
   async queryOptionalRow<Model extends z.ZodTypeAny>(
     sql: string,
     params: QueryParams,
-    model: Model
+    model: Model,
   ): Promise<z.infer<Model> | null>;
   async queryOptionalRow<Model extends z.ZodTypeAny>(
     sql: string,
     paramsOrSchema: QueryParams | Model,
-    maybeModel?: Model
+    maybeModel?: Model,
   ) {
     const params = maybeModel === undefined ? {} : (paramsOrSchema as QueryParams);
     const model = maybeModel === undefined ? (paramsOrSchema as Model) : maybeModel;
@@ -941,7 +941,7 @@ export class PostgresPool {
   async queryCursorWithClient(
     client: pg.PoolClient,
     sql: string,
-    params: QueryParams
+    params: QueryParams,
   ): Promise<Cursor> {
     this._queryCount += 1;
     debug('queryCursorWithClient()', 'sql:', debugString(sql));
@@ -957,7 +957,7 @@ export class PostgresPool {
    */
   async queryCursor<Model extends z.ZodTypeAny>(
     sql: string,
-    params: QueryParams
+    params: QueryParams,
   ): Promise<CursorIterator<z.infer<Model>>> {
     return this.queryValidatedCursorInternal(sql, params);
   }
@@ -970,7 +970,7 @@ export class PostgresPool {
   async queryValidatedCursor<Model extends z.ZodTypeAny>(
     sql: string,
     params: QueryParams,
-    model: Model
+    model: Model,
   ): Promise<CursorIterator<z.infer<Model>>> {
     return this.queryValidatedCursorInternal(sql, params, model);
   }
@@ -978,7 +978,7 @@ export class PostgresPool {
   private async queryValidatedCursorInternal<Model extends z.ZodTypeAny>(
     sql: string,
     params: QueryParams,
-    model?: Model
+    model?: Model,
   ): Promise<CursorIterator<z.infer<Model>>> {
     const client = await this.getClientAsync();
     const cursor = await this.queryCursorWithClient(client, sql, params);

package/src/test-utils.ts

@@ -37,7 +37,7 @@ async function createDatabase(
     database,
     templateDatabase,
     prepare,
-  }: CreateDatabaseOptions = {}
+  }: CreateDatabaseOptions = {},
 ): Promise<void> {
   const client = new pg.Client({
     ...getPoolConfig(options),
@@ -46,7 +46,7 @@ async function createDatabase(
   await client.connect();
 
   const escapedDatabase = client.escapeIdentifier(
-    database ?? getDatabaseNameForCurrentMochaWorker(options.database)
+    database ?? getDatabaseNameForCurrentMochaWorker(options.database),
   );
   if (dropExistingDatabase ?? true) {
     await client.query(`DROP DATABASE IF EXISTS ${escapedDatabase}`);
@@ -76,7 +76,7 @@ async function createDatabase(
       },
       (err) => {
         throw err;
-      }
+      },
     );
   }
 }
@@ -103,7 +103,7 @@ async function resetDatabase(options: PostgresTestUtilsOptions): Promise<void> {
 
 async function dropDatabase(
   options: PostgresTestUtilsOptions,
-  { closePool = true, force = false, database }: DropDatabaseOptions = {}
+  { closePool = true, force = false, database }: DropDatabaseOptions = {},
 ): Promise<void> {
   if (closePool) {
     await defaultPool.closeAsync();