Ask for and expose an ImmutableDictionary for the bindings on GroovyG…

…remlinScript. This is binary breaking but not source breaking because the old constructor is retained (marked obsolete) and the property contract just returns a more specialized type.
Gremlinq · Aug 17, 2024 · 4e468d0 · 4e468d0
1 parent 58bff48
commit 4e468d0
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 9 deletions.
diff --git a/src/Core/SerializedQueries/GroovyGremlinScript.cs b/src/Core/SerializedQueries/GroovyGremlinScript.cs
@@ -1,13 +1,20 @@
-using static ExRam.Gremlinq.Core.ExceptionHelper;
+using System.Collections.Immutable;
+
+using static ExRam.Gremlinq.Core.ExceptionHelper;
 
 namespace ExRam.Gremlinq.Core.Serialization
 {
     public readonly struct GroovyGremlinScript
     {
         private readonly string? _script;
-        private readonly IReadOnlyDictionary<string, object>? _bindings;
+        private readonly ImmutableDictionary<string, object>? _bindings;
+
+        [Obsolete($"Use {nameof(GroovyGremlinScript)}({nameof(String)}, {nameof(ImmutableDictionary<string, object>)}) constructor instead.")]
+        public GroovyGremlinScript(string script, IReadOnlyDictionary<string, object> bindings) : this(script, bindings.ToImmutableDictionary())
+        {
+        }
 
-        public GroovyGremlinScript(string script, IReadOnlyDictionary<string, object> bindings)
+        public GroovyGremlinScript(string script, ImmutableDictionary<string, object> bindings)
         {
             _script = script;
             _bindings = bindings;
@@ -17,6 +24,6 @@ public GroovyGremlinScript(string script, IReadOnlyDictionary<string, object> bi
 
         public string Script => _script ?? throw UninitializedStruct();
 
-        public IReadOnlyDictionary<string, object> Bindings => _bindings ?? throw UninitializedStruct();
+        public ImmutableDictionary<string, object> Bindings => _bindings ?? throw UninitializedStruct();
     }
 }
diff --git a/src/Core/SerializedQueries/GroovyWriter.cs b/src/Core/SerializedQueries/GroovyWriter.cs
@@ -43,7 +43,7 @@ public static GroovyGremlinScript ToGroovyScript(Bytecode bytecode, IGremlinQuer
             return new GroovyGremlinScript(
                 stringBuilder.ToString(),
                 includeBindings
-                    ? bindings.ToDictionary(static kvp => (string)kvp.Value, static kvp => kvp.Key)
+                    ? bindings.ToImmutableDictionary(static kvp => (string)kvp.Value, static kvp => kvp.Key)
                     : ImmutableDictionary<string, object>.Empty);
         }
 

diff --git a/src/Providers.Core/Extensions/RequestMessageExtensions.cs b/src/Providers.Core/Extensions/RequestMessageExtensions.cs
@@ -25,7 +25,7 @@ internal static class RequestMessageExtensions
                     return new GroovyGremlinScript(
                         script,
                         includeBindings && requestMessage.Arguments.TryGetValue(Tokens.ArgsBindings, out var bindingsObject) && bindingsObject is IReadOnlyDictionary<string, object> bindings
-                            ? bindings
+                            ? bindings.ToImmutableDictionary()
                             : ImmutableDictionary<string, object>.Empty);
                 }
             }

diff --git a/test/PublicApi.Tests/PublicApiTests.Core.DotNet6_0.verified.cs b/test/PublicApi.Tests/PublicApiTests.Core.DotNet6_0.verified.cs
@@ -1575,8 +1575,10 @@ public static ExRam.Gremlinq.Core.Serialization.GroovyExpression From(string ide
     }
     public readonly struct GroovyGremlinScript
     {
+        [System.Obsolete("Use GroovyGremlinScript(String, ImmutableDictionary) constructor instead.")]
         public GroovyGremlinScript(string script, System.Collections.Generic.IReadOnlyDictionary<string, object> bindings) { }
-        public System.Collections.Generic.IReadOnlyDictionary<string, object> Bindings { get; }
+        public GroovyGremlinScript(string script, System.Collections.Immutable.ImmutableDictionary<string, object> bindings) { }
+        public System.Collections.Immutable.ImmutableDictionary<string, object> Bindings { get; }
         public string Script { get; }
         public override string ToString() { }
     }

diff --git a/test/PublicApi.Tests/PublicApiTests.Core.DotNet7_0.verified.cs b/test/PublicApi.Tests/PublicApiTests.Core.DotNet7_0.verified.cs
@@ -1575,8 +1575,10 @@ public static ExRam.Gremlinq.Core.Serialization.GroovyExpression From(string ide
     }
     public readonly struct GroovyGremlinScript
     {
+        [System.Obsolete("Use GroovyGremlinScript(String, ImmutableDictionary) constructor instead.")]
         public GroovyGremlinScript(string script, System.Collections.Generic.IReadOnlyDictionary<string, object> bindings) { }
-        public System.Collections.Generic.IReadOnlyDictionary<string, object> Bindings { get; }
+        public GroovyGremlinScript(string script, System.Collections.Immutable.ImmutableDictionary<string, object> bindings) { }
+        public System.Collections.Immutable.ImmutableDictionary<string, object> Bindings { get; }
         public string Script { get; }
         public override string ToString() { }
     }

diff --git a/test/PublicApi.Tests/PublicApiTests.Core.DotNet8_0.verified.cs b/test/PublicApi.Tests/PublicApiTests.Core.DotNet8_0.verified.cs
@@ -1575,8 +1575,10 @@ public static ExRam.Gremlinq.Core.Serialization.GroovyExpression From(string ide
     }
     public readonly struct GroovyGremlinScript
     {
+        [System.Obsolete("Use GroovyGremlinScript(String, ImmutableDictionary) constructor instead.")]
         public GroovyGremlinScript(string script, System.Collections.Generic.IReadOnlyDictionary<string, object> bindings) { }
-        public System.Collections.Generic.IReadOnlyDictionary<string, object> Bindings { get; }
+        public GroovyGremlinScript(string script, System.Collections.Immutable.ImmutableDictionary<string, object> bindings) { }
+        public System.Collections.Immutable.ImmutableDictionary<string, object> Bindings { get; }
         public string Script { get; }
         public override string ToString() { }
     }