WIP: TypeRegistry in ConnectionSettings. (#235)

Author: isoos

lib/postgres.dart

@@ -3,6 +3,7 @@ import 'dart:convert';
 
 import 'package:collection/collection.dart';
 import 'package:meta/meta.dart';
+import 'package:postgres/src/types/type_registry.dart';
 import 'package:stream_channel/stream_channel.dart';
 
 import 'src/replication.dart';
@@ -436,13 +437,18 @@ class ConnectionSettings extends SessionSettings {
   /// [Streaming Replication Protocol]: https://www.postgresql.org/docs/current/protocol-replication.html
   final ReplicationMode? replicationMode;
 
+  /// When set, use the type registry with custom types, instead of the
+  /// built-in ones provided by the package.
+  final TypeRegistry? typeRegistry;
+
   ConnectionSettings({
     this.applicationName,
     this.timeZone,
     this.encoding,
     this.sslMode,
     this.transformer,
     this.replicationMode,
+    this.typeRegistry,
     super.connectTimeout,
     super.queryTimeout,
     super.queryMode,

lib/src/types/binary_codec.dart

@@ -585,7 +585,8 @@ class PostgresBinaryDecoder {
       case TypeOid.regtype:
         final data = input.buffer.asByteData(input.offsetInBytes, input.length);
         final oid = data.getInt32(0);
-        return TypeRegistry.instance.resolveOid(oid);
+        // TODO: DecodeInput may provide the connection-level TypeRegistry
+        return TypeRegistry().resolveOid(oid);
       case TypeOid.voidType:
         return null;
 

lib/src/types/type_registry.dart

@@ -71,10 +71,6 @@ final _builtInTypes = <Type>{
 };
 
 class TypeRegistry {
-  // TODO: implement connection-level registry
-  @internal
-  static final instance = TypeRegistry();
-
   final _byTypeOid = <int, Type>{};
   final _bySubstitutionName = <String, Type>{};
 
@@ -110,6 +106,7 @@ class TypeRegistry {
 
   Type? resolveSubstitution(String name) => _bySubstitutionName[name];
 
+  /// Note: this returns only types with oids.
   @internal
-  Iterable<Type> get values => _byTypeOid.values;
+  Iterable<Type> get registered => _byTypeOid.values;
 }

lib/src/v3/connection.dart

@@ -7,7 +7,6 @@ import 'package:async/async.dart' as async;
 import 'package:charcode/ascii.dart';
 import 'package:meta/meta.dart';
 import 'package:pool/pool.dart' as pool;
-import 'package:postgres/src/types/type_registry.dart';
 import 'package:stream_channel/stream_channel.dart';
 
 import '../../postgres.dart';
@@ -658,7 +657,8 @@ class _PgResultStreamSubscription
           for (final field in message.fieldDescriptions)
             ResultSchemaColumn(
               typeOid: field.typeOid,
-              type: TypeRegistry.instance.resolveOid(field.typeOid),
+              type: session._connection._settings.typeRegistry
+                  .resolveOid(field.typeOid),
               columnName: field.fieldName,
               columnOid: field.columnOid,
               tableOid: field.tableOid,

lib/src/v3/resolved_settings.dart

@@ -1,6 +1,7 @@
 import 'dart:convert';
 
 import 'package:postgres/messages.dart';
+import 'package:postgres/src/types/type_registry.dart';
 import 'package:stream_channel/stream_channel.dart';
 
 import '../../postgres.dart';
@@ -50,6 +51,8 @@ class ResolvedConnectionSettings extends ResolvedSessionSettings
   final StreamChannelTransformer<Message, Message>? transformer;
   @override
   final ReplicationMode replicationMode;
+  @override
+  final TypeRegistry typeRegistry;
 
   ResolvedConnectionSettings(
       ConnectionSettings? super.settings, ConnectionSettings? super.fallback)
@@ -62,7 +65,10 @@ class ResolvedConnectionSettings extends ResolvedSessionSettings
         transformer = settings?.transformer ?? fallback?.transformer,
         replicationMode = settings?.replicationMode ??
             fallback?.replicationMode ??
-            ReplicationMode.none;
+            ReplicationMode.none,
+        // TODO: consider merging the type registries
+        typeRegistry =
+            settings?.typeRegistry ?? fallback?.typeRegistry ?? TypeRegistry();
 
   bool isMatchingConnection(ResolvedConnectionSettings other) {
     return isMatchingSession(other) &&

lib/src/v3/variable_tokenizer.dart

@@ -386,7 +386,8 @@ class VariableTokenizer {
 
     if (consumedColonForType) {
       final typeName = typeBuffer.toString();
-      final type = TypeRegistry.instance.resolveSubstitution(typeName);
+      // TODO: get this from the connection settings
+      final type = TypeRegistry().resolveSubstitution(typeName);
       if (type == null) {
         error('Unknown type: $typeName');
       }

test/interpolation_test.dart

@@ -15,11 +15,12 @@ void main() {
       Type.serial,
     };
 
-    for (final type in TypeRegistry.instance.values) {
+    for (final type in TypeRegistry().registered) {
       if (withoutMapping.contains(type)) continue;
 
       expect(
-        PostgreSQLFormatIdentifier.typeStringToCodeMap.values.contains(type),
+        PostgreSQLFormatIdentifier.typeStringToCodeMap.registered
+            .contains(type),
         true,
         reason: 'There should be a type mapping for $type',
       );