Merge pull request #314 from basho/features/lrb/ts-ttb-encoding

READY: Implement TTB encoding for Riak TS put / query messages

.gitignore

@@ -50,3 +50,4 @@ CommonAssemblyInfo.cs
 *.DotSettings
 *.dcvr.settings
 StyleCop.Cache
+.vs/

RELNOTES.md

@@ -1,6 +1,12 @@
 Release Notes
 =============
 
+[v2.4.0](https://github.com/basho/riak-dotnet-client/issues?q=milestone%3Ariak-dotnet-client-2.4.0)
+------
+
+* Add support of encoding `Store` and `Query` Riak TS commands in Erlang term format. Compatible with Riak TS 1.3 and above.
+* Add `useTtbEncoding` cluster and node configuration option. Set `useTtbEncoding=false` to *disable* Erlang term format encoding when connecting to a Riak TS 1.2 cluster.
+
 [v2.3.0](https://github.com/basho/riak-dotnet-client/issues?q=milestone%3Ariak-dotnet-client-2.3.0)
 ------
 

build/build.targets

@@ -216,8 +216,11 @@
   </Target>
 
   <Target Name="CodeAnalysis">
+    <PropertyGroup Condition="'$(VisualStudioVersion)' == ''">
+      <VisualStudioVersion>12.0</VisualStudioVersion>
+    </PropertyGroup>
     <MSBuild Projects="$(SolutionFile)"
-             Properties="Configuration=Debug;VisualStudioVersion=12.0;CodeAnalysisTreatWarningsAsErrors=true;CodeAnalysisRuleSet=MinimumRecommendedRules.ruleset;RunCodeAnalysis=true" />
+             Properties="Configuration=Debug;VisualStudioVersion=$(VisualStudioVersion);CodeAnalysisTreatWarningsAsErrors=true;CodeAnalysisRuleSet=MinimumRecommendedRules.ruleset;RunCodeAnalysis=true" />
   </Target>
 
   <Target Name="UnitTest" DependsOnTargets="GitSubmodule;SetupTests;Debug;CodeAnalysis">
@@ -231,7 +234,7 @@
     <Exec WorkingDirectory="$(SolutionDir)"
           Command="$(NUnitConsoleRunnerCommand) -work=$(ProjDir)\RiakClientTests.Live $(ProjDir)\RiakClientTests.Live\RiakClientTests.Live.nunit" />
     <Exec WorkingDirectory="$(SolutionDir)"
-          Command="$(NUnitConsoleRunnerCommand) -work=$(ProjDir)\Test -run=Test.Integration.CRDT,Test.Integration.KV $(ProjDir)\Test\Test.nunit" />
+          Command="$(NUnitConsoleRunnerCommand) -work=$(ProjDir)\Test -run=Test.Integration.CRDT,Test.Integration.KV,Test.Integration.Issues $(ProjDir)\Test\Test.nunit" />
   </Target>
 
   <Target Name="TimeseriesTest" DependsOnTargets="SetupTests;Debug">

make.ps1

@@ -199,6 +199,11 @@ if (! ([String]::IsNullOrEmpty($VersionString))) {
     $version_property = "/property:VersionString=$VersionString"
 }
 
+$vs_version_property = ''
+if (Test-Path -Path HKLM:\SOFTWARE\Microsoft\VisualStudio\14.0) {
+    $vs_version_property = '/property:VisualStudioVersion=14.0'
+}
+
 $script_path = Get-ScriptPath
 
 $build_targets_file = Get-BuildTargetsFile -ScriptPath $script_path
@@ -246,8 +251,8 @@ else
     $maxcpu_property = '/maxcpucount'
 }
 
-Write-Debug "MSBuild command: $msbuild_exe ""/verbosity:$Verbosity"" /nologo /m ""/property:SolutionDir=$script_path\"" ""$maxcpu_property"" ""$version_property"" ""$verbose_property"" ""$git_remote_property"" ""$protogen_property"" ""/target:$Target"" ""$build_targets_file"""
-& $msbuild_exe "/verbosity:$Verbosity" /nologo /m "/property:SolutionDir=$script_path\" "$maxcpu_property" "$version_property" "$verbose_property" "$git_remote_property" "$protogen_property" "/target:$Target" "$build_targets_file"
+Write-Debug "MSBuild command: $msbuild_exe ""/verbosity:$Verbosity"" /nologo /m ""/property:SolutionDir=$script_path\"" ""$maxcpu_property"" ""$version_property"" ""$vs_version_property"" ""$verbose_property"" ""$git_remote_property"" ""$protogen_property"" ""/target:$Target"" ""$build_targets_file"""
+& $msbuild_exe "/verbosity:$Verbosity" /nologo /m "/property:SolutionDir=$script_path\" "$maxcpu_property" "$version_property" "$vs_version_property" "$verbose_property" "$git_remote_property" "$protogen_property" "/target:$Target" "$build_targets_file"
 if ($? -ne $True) {
     throw "$msbuild_exe failed: $LastExitCode"
 }

src/ChaosMonkeyApp/ChaosMonkeyApp.csproj

@@ -24,6 +24,7 @@
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <Prefer32Bit>false</Prefer32Bit>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <PlatformTarget>AnyCPU</PlatformTarget>
@@ -34,6 +35,7 @@
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <Prefer32Bit>false</Prefer32Bit>
   </PropertyGroup>
   <ItemGroup>
     <Compile Include="Program.cs" />

src/RiakClient/Auth/RiakSecurityManager.cs

@@ -68,7 +68,7 @@ public bool IsSecurityEnabled
         {
             get
             {
-                return (false == MonoUtil.IsRunningOnMono) &&
+                return (MonoUtil.IsRunningOnMono == false) &&
                        (authConfig != null && (!string.IsNullOrWhiteSpace(authConfig.Username)));
             }
         }

src/RiakClient/Commands/CRDT/FetchCommand{TResponse}.cs

@@ -44,7 +44,7 @@ public override MessageCode ExpectedCode
             get { return MessageCode.DtFetchResp; }
         }
 
-        public override RpbReq ConstructPbRequest()
+        public override RiakReq ConstructRequest(bool useTtb)
         {
             var req = new DtFetchReq();
 

src/RiakClient/Commands/CRDT/FetchCounter.cs

@@ -35,7 +35,7 @@ public FetchCounter(FetchCounterOptions options)
         {
         }
 
-        public override void OnSuccess(RpbResp response)
+        public override void OnSuccess(RiakResp response)
         {
             if (response == null)
             {

src/RiakClient/Commands/CRDT/FetchMap.cs

@@ -35,7 +35,7 @@ public FetchMap(FetchMapOptions options)
         {
         }
 
-        public override void OnSuccess(RpbResp response)
+        public override void OnSuccess(RiakResp response)
         {
             if (response == null)
             {

src/RiakClient/Commands/CRDT/FetchSet.cs

@@ -36,7 +36,7 @@ public FetchSet(FetchSetOptions options)
         {
         }
 
-        public override void OnSuccess(RpbResp response)
+        public override void OnSuccess(RiakResp response)
         {
             if (response == null)
             {

src/RiakClient/Commands/CRDT/UpdateCommand{TResponse}.cs

@@ -44,7 +44,7 @@ public override MessageCode ExpectedCode
             get { return MessageCode.DtUpdateResp; }
         }
 
-        public override RpbReq ConstructPbRequest()
+        public override RiakReq ConstructRequest(bool useTtb)
         {
             var req = new DtUpdateReq();
 
@@ -73,7 +73,7 @@ public override RpbReq ConstructPbRequest()
             return req;
         }
 
-        public override void OnSuccess(RpbResp response)
+        public override void OnSuccess(RiakResp response)
         {
             if (response == null)
             {

src/RiakClient/Commands/Command{TOptions,TResponse}.cs

@@ -8,7 +8,7 @@
     /// </summary>
     /// <typeparam name="TOptions">The type of the options for this command.</typeparam>
     /// <typeparam name="TResponse">The type of the response data from Riak.</typeparam>
-    public abstract class Command<TOptions, TResponse> : IRiakCommand
+    public abstract class Command<TOptions, TResponse> : Command<TResponse>
         where TOptions : CommandOptions
         where TResponse : Response
     {
@@ -33,18 +33,7 @@ public TOptions Options
             get { return CommandOptions; }
         }
 
-        /// <summary>
-        /// A sub-class instance of <see cref="Response"/> representing the response from Riak.
-        /// </summary>
-        public TResponse Response { get; protected set; }
-
-        public abstract MessageCode ExpectedCode { get; }
-
-        public abstract RpbReq ConstructPbRequest();
-
-        public abstract void OnSuccess(RpbResp rpbResp);
-
-        protected RiakString GetKey(RiakString optskey, RpbResp response)
+        protected RiakString GetKey(RiakString optskey, RiakResp response)
         {
             RiakString key = optskey;
 

src/RiakClient/Commands/Command{TResponse}.cs

@@ -1,6 +1,9 @@
 namespace RiakClient.Commands
 {
+    using System;
+    using System.IO;
     using Messages;
+    using ProtoBuf;
 
     /// <summary>
     /// Base class for Riak commands that don't have options.
@@ -23,8 +26,25 @@ public Command()
 
         public abstract MessageCode ExpectedCode { get; }
 
-        public abstract RpbReq ConstructPbRequest();
+        public abstract RiakReq ConstructRequest(bool useTtb);
 
-        public abstract void OnSuccess(RpbResp rpbResp);
+        public abstract void OnSuccess(RiakResp rpbResp);
+
+        public virtual RiakResp DecodeResponse(byte[] buffer)
+        {
+            Type expectedType = MessageCodeTypeMapBuilder.GetTypeFor(ExpectedCode);
+
+            if (buffer == null || buffer.Length == 0)
+            {
+                return Activator.CreateInstance(expectedType) as RiakResp;
+            }
+            else
+            {
+                using (var memStream = new MemoryStream(buffer))
+                {
+                    return Serializer.NonGeneric.Deserialize(expectedType, memStream) as RiakResp;
+                }
+            }
+        }
     }
-}
+}

src/RiakClient/Commands/FetchServerInfo.cs

@@ -33,12 +33,12 @@ public override MessageCode ExpectedCode
             get { return MessageCode.RpbGetServerInfoResp; }
         }
 
-        public override RpbReq ConstructPbRequest()
+        public override RiakReq ConstructRequest(bool useTtb)
         {
-            return new RpbReq(MessageCode.RpbGetServerInfoReq);
+            return new RiakReq(MessageCode.RpbGetServerInfoReq);
         }
 
-        public override void OnSuccess(RpbResp response)
+        public override void OnSuccess(RiakResp response)
         {
             if (response == null)
             {

src/RiakClient/Commands/IRiakCommand.cs

@@ -7,10 +7,14 @@
     /// </summary>
     public interface IRiakCommand
     {
+        // TODO FUTURE
+        // interface should not be concerned with encoding or Riak msg
         MessageCode ExpectedCode { get; }
 
-        RpbReq ConstructPbRequest();
+        RiakReq ConstructRequest(bool useTtb);
 
-        void OnSuccess(RpbResp rpbResp);
+        RiakResp DecodeResponse(byte[] buffer);
+
+        void OnSuccess(RiakResp rpbResp);
     }
 }

src/RiakClient/Commands/KV/FetchPreflist.cs

@@ -25,7 +25,7 @@ public override MessageCode ExpectedCode
             get { return MessageCode.RpbGetBucketKeyPreflistResp; }
         }
 
-        public override RpbReq ConstructPbRequest()
+        public override RiakReq ConstructRequest(bool useTtb)
         {
             var req = new RpbGetBucketKeyPreflistReq();
 
@@ -36,7 +36,7 @@ public override RpbReq ConstructPbRequest()
             return req;
         }
 
-        public override void OnSuccess(RpbResp response)
+        public override void OnSuccess(RiakResp response)
         {
             if (response == null)
             {

src/RiakClient/Commands/TS/ByKeyCommand{TResponse}.cs

@@ -35,7 +35,7 @@ public ByKeyCommand(ByKeyOptions options)
             }
         }
 
-        public override RpbReq ConstructPbRequest()
+        public override RiakReq ConstructRequest(bool useTtb)
         {
             ITsByKeyReq req = GetByKeyReq();
 
@@ -49,7 +49,7 @@ public override RpbReq ConstructPbRequest()
 
             req.key.AddRange(CommandOptions.Key.ToTsCells());
 
-            return (RpbReq)req;
+            return (RiakReq)req;
         }
 
         protected abstract ITsByKeyReq GetByKeyReq();