Fix decoding box[] type

Author: simolus3

modules/module-postgres/src/types/registry.ts

@@ -75,18 +75,21 @@ class CustomTypeValue extends CustomSqliteValue {
     return this.cache.lookupType(this.oid);
   }
 
-  toSqliteValue(context: CompatibilityContext): SqliteValue {
+  private decodeToDatabaseInputValue(context: CompatibilityContext): DatabaseInputValue {
     if (context.isEnabled(CompatibilityOption.customTypes)) {
       try {
-        const rawValue = this.cache.decodeWithCustomTypes(this.rawValue, this.oid);
-        const value = toSyncRulesValue(rawValue);
-        return applyValueContext(value, context);
+        return this.cache.decodeWithCustomTypes(this.rawValue, this.oid);
       } catch (_e) {
         return this.rawValue;
       }
+    } else {
+      return pgwire.PgType.decode(this.rawValue, this.oid);
     }
+  }
 
-    return this.rawValue;
+  toSqliteValue(context: CompatibilityContext): SqliteValue {
+    const value = toSyncRulesValue(this.decodeToDatabaseInputValue(context));
+    return applyValueContext(value, context);
   }
 
   get sqliteType(): SqliteValueType {
@@ -146,20 +149,25 @@ export class CustomTypeRegistry {
           oid: builtin,
           sqliteType: () => sqliteType
         });
+      }
+    }
 
-        const arrayVariant = pgwire.PgType.getArrayType(builtin);
-        if (arrayVariant != null) {
-          // NOTE: We could use builtin for this, since PgType.decode can decode arrays. Especially in the presence of
-          // nested arrays (or arrays in compounds) though, we prefer to keep a common decoder state across everything
-          // (since it's otherwise hard to decode inner separators properly). So, this ships its own array decoder.
-          this.byOid.set(arrayVariant, {
-            type: 'array',
-            innerId: builtin,
-            sqliteType: () => sqliteType,
-            // We assume builtin arrays use commas as a separator (the default)
-            separatorCharCode: pgwire.CHAR_CODE_COMMA
-          });
-        }
+    for (const [arrayId, innerId] of pgwire.ARRAY_TO_ELEM_OID.entries()) {
+      // We can just use the default decoder, except for box[] because those use a different delimiter. We don't fix
+      // this in PgType._decodeArray for backwards-compatibility.
+      if (innerId == 603) {
+        this.byOid.set(arrayId, {
+          type: 'array',
+          innerId,
+          sqliteType: () => 'text', // these get encoded as JSON arrays
+          separatorCharCode: 0x3b // ";"
+        });
+      } else {
+        this.byOid.set(arrayId, {
+          type: 'builtin',
+          oid: arrayId,
+          sqliteType: () => 'text' // these get encoded as JSON arrays
+        });
       }
     }
   }
@@ -245,7 +253,10 @@ export class CustomTypeRegistry {
       case 'unknown':
         return true;
       case 'array':
-        return this.isParsedWithoutCustomTypesSupport(this.lookupType(type.innerId));
+        return (
+          type.separatorCharCode == pgwire.CHAR_CODE_COMMA &&
+          this.isParsedWithoutCustomTypesSupport(this.lookupType(type.innerId))
+        );
       default:
         return false;
     }

modules/module-postgres/test/src/pg_test.test.ts

@@ -10,7 +10,7 @@ import {
 import { describe, expect, test } from 'vitest';
 import { clearTestDb, connectPgPool, connectPgWire, TEST_URI } from './util.js';
 import { WalStream } from '@module/replication/WalStream.js';
-import { PostgresTypeCache } from '@module/types/custom.js';
+import { PostgresTypeCache } from '@module/types/cache.js';
 
 describe('pg data types', () => {
   async function setupTable(db: pgwire.PgClient) {
@@ -483,7 +483,8 @@ INSERT INTO test_data(id, time, timestamp, timestamptz) VALUES (1, '17:42:01.12'
         id serial primary key,
         rating rating_value,
         composite composite,
-        nested_composite nested_composite
+        nested_composite nested_composite,
+        boxes box[]
       );`);
 
       const slotName = 'test_slot';
@@ -500,11 +501,12 @@ INSERT INTO test_data(id, time, timestamp, timestamptz) VALUES (1, '17:42:01.12'
 
       await db.query(`
         INSERT INTO test_custom
-          (rating, composite, nested_composite)
+          (rating, composite, nested_composite, boxes)
         VALUES (
           1,
           (ARRAY[2,3], 'bar'),
-          (TRUE, (ARRAY[2,3], 'bar'))
+          (TRUE, (ARRAY[2,3], 'bar')),
+          ARRAY[box(point '(1,2)', point '(3,4)'), box(point '(5, 6)', point '(7,8)')]
         );
       `);
 
@@ -524,14 +526,16 @@ INSERT INTO test_data(id, time, timestamp, timestamptz) VALUES (1, '17:42:01.12'
       expect(oldFormat).toMatchObject({
         rating: '1',
         composite: '("{2,3}",bar)',
-        nested_composite: '(t,"(""{2,3}"",bar)")'
+        nested_composite: '(t,"(""{2,3}"",bar)")',
+        boxes: '["(3","4)","(1","2);(7","8)","(5","6)"]'
       });
 
       const newFormat = applyRowContext(transformed, new CompatibilityContext(CompatibilityEdition.SYNC_STREAMS));
       expect(newFormat).toMatchObject({
         rating: 1,
         composite: '{"foo":[2.0,3.0],"bar":"bar"}',
-        nested_composite: '{"a":1,"b":{"foo":[2.0,3.0],"bar":"bar"}}'
+        nested_composite: '{"a":1,"b":{"foo":[2.0,3.0],"bar":"bar"}}',
+        boxes: JSON.stringify(['(3,4),(1,2)', '(7,8),(5,6)'])
       });
     } finally {
       await db.end();

packages/jpgwire/src/pgwire_types.ts

@@ -37,7 +37,7 @@ export enum PgTypeOid {
 
 // Generate using:
 //   select '[' || typarray || ', ' || oid || '], // ' || typname from pg_catalog.pg_type WHERE typarray != 0;
-const ARRAY_TO_ELEM_OID = new Map<number, number>([
+export const ARRAY_TO_ELEM_OID = new Map<number, number>([
   [1000, 16], // bool
   [1001, 17], // bytea
   [1002, 18], // char