Support ranges

Author: simolus3

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

@@ -32,6 +32,8 @@ SELECT oid, t.typtype,
                 FROM pg_attribute a
                 WHERE a.attrelid = t.typrelid)
         )
+        WHEN 'r' THEN json_build_object('inner', (SELECT rngsubtype FROM pg_range WHERE rngtypid = t.oid))
+        WHEN 'm' THEN json_build_object('inner', (SELECT rngsubtype FROM pg_range WHERE rngmultitypid = t.oid))
         ELSE NULL
     END AS desc
 FROM pg_type t
@@ -59,9 +61,11 @@ WHERE t.oid = ANY($1)
 
             if (!this.registry.knows(oid)) {
               // This type is an array of another custom type.
+              const inner = Number(element_type);
+              requireType(inner);
               this.registry.set(oid, {
                 type: 'array',
-                innerId: Number(element_type),
+                innerId: inner,
                 separatorCharCode: (delim as string).charCodeAt(0),
                 sqliteType: () => 'text' // Since it's JSON
               });
@@ -89,6 +93,15 @@ WHERE t.oid = ANY($1)
             this.registry.setDomainType(oid, inner);
             requireType(inner);
             break;
+          case 'r':
+          case 'm': {
+            const inner = Number(desc.inner);
+            this.registry.set(oid, {
+              type: row.typtype == 'r' ? 'range' : 'multirange',
+              innerId: inner,
+              sqliteType: () => 'text' // Since it's JSON
+            });
+          }
         }
       }
 
@@ -110,7 +123,6 @@ JOIN pg_namespace tn ON tn.oid = t.typnamespace
 WHERE a.attnum > 0
   AND NOT a.attisdropped
   AND cn.nspname = $1
-  AND tn.nspname NOT IN ('pg_catalog', 'information_schema');
     `;
 
     const query = await this.pool.query({ statement: sql, params: [{ type: 'varchar', value: schema }] });

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

@@ -49,7 +49,17 @@ interface CompositeType extends BaseType {
   members: { name: string; typeId: number }[];
 }
 
-type KnownType = BuiltinType | ArrayType | DomainType | DomainType | CompositeType;
+/**
+ * A type created with `CREATE TYPE AS RANGE`.
+ *
+ * Ranges are represented as {@link pgwire.Range}. Multiranges are represented as arrays thereof.
+ */
+interface RangeType extends BaseType {
+  type: 'range' | 'multirange';
+  innerId: number;
+}
+
+type KnownType = BuiltinType | ArrayType | DomainType | DomainType | CompositeType | RangeType;
 
 interface UnknownType extends BaseType {
   type: 'unknown';
@@ -199,23 +209,13 @@ export class CustomTypeRegistry {
       case 'composite': {
         const parsed: [string, any][] = [];
 
-        pgwire.decodeSequence({
-          source: raw,
-          delimiters: pgwire.COMPOSITE_DELIMITERS,
-          listener: {
-            onValue: (raw) => {
-              const nextMember = resolved.members[parsed.length];
-              if (nextMember) {
-                const value = raw == null ? null : this.decodeWithCustomTypes(raw, nextMember.typeId);
-                parsed.push([nextMember.name, value]);
-              }
-            },
-            // These are only used for nested arrays
-            onStructureStart: () => {},
-            onStructureEnd: () => {}
+        new pgwire.StructureParser(raw).parseComposite((raw) => {
+          const nextMember = resolved.members[parsed.length];
+          if (nextMember) {
+            const value = raw == null ? null : this.decodeWithCustomTypes(raw, nextMember.typeId);
+            parsed.push([nextMember.name, value]);
           }
         });
-
         return Object.fromEntries(parsed);
       }
       case 'array': {
@@ -234,12 +234,15 @@ export class CustomTypeRegistry {
           }
         }
 
-        return pgwire.decodeArray({
-          source: raw,
-          decodeElement: (source) => this.decodeWithCustomTypes(source, innerId),
-          delimiterCharCode: resolved.separatorCharCode
-        });
+        return new pgwire.StructureParser(raw).parseArray(
+          (source) => this.decodeWithCustomTypes(source, innerId),
+          resolved.separatorCharCode
+        );
       }
+      case 'range':
+        return new pgwire.StructureParser(raw).parseRange((s) => this.decodeWithCustomTypes(s, resolved.innerId));
+      case 'multirange':
+        return new pgwire.StructureParser(raw).parseMultiRange((s) => this.decodeWithCustomTypes(s, resolved.innerId));
     }
   }
 

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

@@ -478,13 +478,16 @@ INSERT INTO test_data(id, time, timestamp, timestamptz) VALUES (1, '17:42:01.12'
       await db.query(`CREATE DOMAIN rating_value AS FLOAT CHECK (VALUE BETWEEN 0 AND 5);`);
       await db.query(`CREATE TYPE composite AS (foo rating_value[], bar TEXT);`);
       await db.query(`CREATE TYPE nested_composite AS (a BOOLEAN, b composite);`);
+      await db.query(`CREATE TYPE mood AS ENUM ('sad', 'ok', 'happy')`);
 
       await db.query(`CREATE TABLE test_custom(
         id serial primary key,
         rating rating_value,
         composite composite,
         nested_composite nested_composite,
-        boxes box[]
+        boxes box[],
+        mood mood,
+        ranges int4multirange[]
       );`);
 
       const slotName = 'test_slot';
@@ -501,12 +504,14 @@ 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, boxes)
+          (rating, composite, nested_composite, boxes, mood, ranges)
         VALUES (
           1,
           (ARRAY[2,3], 'bar'),
           (TRUE, (ARRAY[2,3], 'bar')),
-          ARRAY[box(point '(1,2)', point '(3,4)'), box(point '(5, 6)', point '(7,8)')]
+          ARRAY[box(point '(1,2)', point '(3,4)'), box(point '(5, 6)', point '(7,8)')],
+          'happy',
+          ARRAY[int4multirange(int4range(2, 4), int4range(5, 7, '(]'))]::int4multirange[]
         );
       `);
 
@@ -527,15 +532,24 @@ INSERT INTO test_data(id, time, timestamp, timestamptz) VALUES (1, '17:42:01.12'
         rating: '1',
         composite: '("{2,3}",bar)',
         nested_composite: '(t,"(""{2,3}"",bar)")',
-        boxes: '["(3","4)","(1","2);(7","8)","(5","6)"]'
+        boxes: '["(3","4)","(1","2);(7","8)","(5","6)"]',
+        mood: 'happy',
+        ranges: '{"{[2,4),[6,8)}"}'
       });
 
       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"}}',
-        boxes: JSON.stringify(['(3,4),(1,2)', '(7,8),(5,6)'])
+        boxes: JSON.stringify(['(3,4),(1,2)', '(7,8),(5,6)']),
+        mood: 'happy',
+        ranges: JSON.stringify([
+          [
+            { lower: 2, upper: 4, lower_exclusive: 0, upper_exclusive: 1 },
+            { lower: 6, upper: 8, lower_exclusive: 0, upper_exclusive: 1 }
+          ]
+        ])
       });
     } finally {
       await db.end();

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

@@ -121,4 +121,29 @@ describe('custom type registry', () => {
     // SELECT ROW(ARRAY[(FALSE,2)]::c2[])::c3;
     checkResult('("{""(f,2)""}")', 1339, '("{""(f,2)""}")', '{"c":[{"a":0,"b":2}]}');
   });
+
+  test('range', () => {
+    registry.set(1337, {
+      type: 'range',
+      sqliteType: () => 'text',
+      innerId: PgTypeOid.INT2
+    });
+
+    checkResult('[1,2]', 1337, '[1,2]', '{"lower":1,"upper":2,"lower_exclusive":0,"upper_exclusive":0}');
+  });
+
+  test('multirange', () => {
+    registry.set(1337, {
+      type: 'multirange',
+      sqliteType: () => 'text',
+      innerId: PgTypeOid.INT2
+    });
+
+    checkResult(
+      '{[1,2),[3,4)}',
+      1337,
+      '{[1,2),[3,4)}',
+      '[{"lower":1,"upper":2,"lower_exclusive":0,"upper_exclusive":1},{"lower":3,"upper":4,"lower_exclusive":0,"upper_exclusive":1}]'
+    );
+  });
 });

packages/jpgwire/src/index.ts

@@ -3,4 +3,4 @@ export * from './certs.js';
 export * from './util.js';
 export * from './metrics.js';
 export * from './pgwire_types.js';
-export * from './sequence_tokenizer.js';
+export * from './structure_parser.js';

packages/jpgwire/src/pgwire_types.ts

@@ -3,16 +3,7 @@
 import { JsonContainer } from '@powersync/service-jsonbig';
 import { CustomSqliteValue, TimeValue, type DatabaseInputValue } from '@powersync/service-sync-rules';
 import { dateToSqlite, lsnMakeComparable, timestampToSqlite, timestamptzToSqlite } from './util.js';
-import {
-  arrayDelimiters,
-  CHAR_CODE_COMMA,
-  CHAR_CODE_LEFT_BRACE,
-  CHAR_CODE_RIGHT_BRACE,
-  decodeArray,
-  decodeSequence,
-  Delimiters,
-  SequenceListener
-} from './sequence_tokenizer.js';
+import { StructureParser } from './structure_parser.js';
 
 export enum PgTypeOid {
   TEXT = 25,
@@ -165,10 +156,7 @@ export class PgType {
 
   static _decodeArray(text: string, elemTypeOid: number): DatabaseInputValue[] {
     text = text.replace(/^\[.+=/, ''); // skip dimensions
-    return decodeArray({
-      source: text,
-      decodeElement: (raw) => PgType.decode(raw, elemTypeOid)
-    });
+    return new StructureParser(text).parseArray((raw) => (raw == null ? null : PgType.decode(raw, elemTypeOid)));
   }
 
   static _decodeBytea(text: string): Uint8Array {