error TS2345: Argument of type 'TransactionSql<{}>' is not assignable to parameter of type 'Sql<{}>'

[maarre]

This is typescript.

src/importdog.ts(58,92): error TS2345: Argument of type 'TransactionSql<{}>' is not assignable to parameter of type 'Sql<{}>'.
Type 'TransactionSql<{}>' is missing the following properties from type 'Sql<{}>': CLOSE, END, PostgresError, options, and 7 more.

This works in postgres 3.4.7. It didn't work in 3.4.8. It doesn't work in 3.4.9.

export const dog_subsidy = postgres({
            user: 'dog_subsidy',
            password: process.env.DOG_SUBSIDY_PASSWORD,
            host: 'localhost',
            port: 5432,
            database: 'dog_subsidy',
            max: os.cpus().length,
            debug: postgres_logger
        })

export async function sp_personsimm_create_v1(params: IfsPersonParamsSpPersonsimmCreateV1, breadcrumb: string, db = dog_subsidy): Promise<number |UserError> {

await dog_subsidy.begin(async conn => {
                const breeder = dog.breeder
                const breeder_imm =
                    new PersonParamsSpPersonsimmCreateV1(breeder.social_security_number.toString(), undefined)
                const breederimm_pk = await sp_personsimm_create_v1(breeder_imm, uuidv4(), conn)

The error is the last parameter in call to await sp_personsimm_create_v1(breeder_imm, uuidv4(), conn)

$ grep -e postgres -e typescript -e 'tsup":' package.json
    "postgres": "3.4.9",
    "tsup": "8.5.1",
    "typescript": "5.9.3",

$ node --version
v22.16.0

[porsager]

Probably caused by this change #1144

[sep2]

I don't think this is an issue from #1144.

You are passing trx object from .begin(trx) to a function expecting Sql. They are actually different runtime objects. As indicated in #1144 (comment) trx has fields sql does not have, and vice versa.

#1144 catches the bug in your code, not the cause of it.

Basically if you want a generic function that can accept both trx and sql, you should not let typescript default it to the type Sql, but to annotate its parameter type as SqlOrTrx like below:

import type { Sql as RawSql, TransactionSql } from 'postgres'

export type SqlRecordType = Record<string, unknown>

export type Trx = TransactionSql<SqlRecordType>

export type Sql = RawSql<SqlRecordType>

export type SqlOrTrx = Sql | Trx

export async function beginTransactionOrSavepoint<T>(
    handle: SqlOrTrx,
    callback: (trx: Trx) => Promise<T>
): Promise<T> {
    if ('savepoint' in handle) {
        return (await handle.savepoint(async (trx) => await callback(trx))) as Promise<T>
    } else if ('begin' in handle) {
        return (await handle.begin(async (trx) => await callback(trx))) as Promise<T>
    } else {
        throw new Error('unknown transaction handler')
    }
}

[AntonOfTheWoods]

@maarre can you provide a proper repro in a file, so we can not waste time hoping to put it together like you did?

[maarre]

@AntonOfTheWoods, I will try to make the whole thing open source. It will take som e time though.

[maarre]

@sep2 are you using semantic versioning? If so this is just a bugfix version and should not break things.

[AntonOfTheWoods]

@sep2 are you using semantic versioning? If so this is just a bugfix version and should not break things.

This is typescript... So it's just type checking. While I personally would get angry if someone made this argument with me... :-), it's not "broken" in terms of database access. Inconvenient, sure, but not "broken". And in any case, it looks like the fix helped many of us, just not everyone. Maybe another PR?

[sep2]

@sep2 are you using semantic versioning? If so this is just a bugfix version and should not break things.

If you are using TypeScript you have to follow type rules, otherwise It's better to use pure JavaScript. This PR merely fix the type bug introduced in 3.4.8. It only breaks invalid type code as intended, which I don't think has anything to do with semantic versioning.

[maarre]

@maarre can you provide a proper repro in a file, so we can not waste time hoping to put it together like you did?

I have made example code. It is now in review for use outside my company.

[maarre]

1163.zip

I have simplified my application. But still there are lots of dead code. It runs though.

Unpack and then run make.sh

There will be lots of errors/warnings/retries because of clashes in the database.

Then update package.json to 3.4.9. And build. This is what I get:

$ git diff
diff --git a/buggar/1163/package.json b/buggar/1163/package.json
index 25746fb..2570e17 100644
--- a/buggar/1163/package.json
+++ b/buggar/1163/package.json
@@ -1,7 +1,7 @@
 {
   "dependencies": {
     "commander": "14.0.3",
-    "postgres": "3.4.7",
+    "postgres": "3.4.9",
     "uuid": "13.0.0",
     "loglayer": "9.1.0",
     "prexit": "2.3.0",

$ npm run build

> d7-dog_subsidy-wrappers@1.0.1775713576172+alpha build
> tsc && tsup

src/importdog.ts(52,107): error TS2345: Argument of type 'TransactionSql<{}>' is not assignable to parameter of type 'Sql<{}>'.
  Type 'TransactionSql<{}>' is missing the following properties from type 'Sql<{}>': CLOSE, END, PostgresError, options, and 7 more.
src/importdog.ts(59,103): error TS2345: Argument of type 'TransactionSql<{}>' is not assignable to parameter of type 'Sql<{}>'.
  Type 'TransactionSql<{}>' is missing the following properties from type 'Sql<{}>': CLOSE, END, PostgresError, options, and 7 more.
src/importdog.ts(67,103): error TS2345: Argument of type 'TransactionSql<{}>' is not assignable to parameter of type 'Sql<{}>'.
  Type 'TransactionSql<{}>' is missing the following properties from type 'Sql<{}>': CLOSE, END, PostgresError, options, and 7 more.
src/importdog.ts(76,109): error TS2345: Argument of type 'TransactionSql<{}>' is not assignable to parameter of type 'Sql<{}>'.
  Type 'TransactionSql<{}>' is missing the following properties from type 'Sql<{}>': CLOSE, END, PostgresError, options, and 7 more.