Make RespCommandsInfo optional for custom commands, remove json (#397)

* Make RespCommandsInfo optional for custom commands, remove json * update version * Add custom commands json to test * fix warning * update trigger for auto-release when version is changed.
microsoft · May 17, 2024 · ab9db61 · ab9db61
1 parent c0ae5a9
commit ab9db61
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 27 deletions.
diff --git a/.azure/pipelines/azure-pipelines-external-release.yml b/.azure/pipelines/azure-pipelines-external-release.yml
@@ -3,8 +3,14 @@
 #      1) update the name: string below (line 6)     -- this is the version for the nuget package (e.g. 1.0.0)
 #      2) update \libs\host\GarnetServer.cs readonly string version  (~line 45)   -- NOTE - these two values need to be the same 
 ###################################### 
-name: 1.0.9
-trigger: none
+name: 1.0.10
+trigger:
+  branches:
+    include:
+    - main
+  paths:
+    include:
+    - .azure/pipelines/azure-pipelines-external-release.yml
 resources:
   repositories:
   - repository: self

diff --git a/libs/host/GarnetServer.cs b/libs/host/GarnetServer.cs
@@ -42,7 +42,7 @@ public class GarnetServer : IDisposable
         protected StoreWrapper storeWrapper;
 
         // IMPORTANT: Keep the version in sync with .azure\pipelines\azure-pipelines-external-release.yml line ~6.
-        readonly string version = "1.0.9";
+        readonly string version = "1.0.10";
 
         /// <summary>
         /// Resp protocol version

diff --git a/libs/server/Custom/CustomCommandManager.cs b/libs/server/Custom/CustomCommandManager.cs
@@ -44,7 +44,7 @@ internal int Register(string name, int numParams, CommandType type, CustomRawStr
                 throw new Exception("Out of registration space");
 
             commandMap[id] = new CustomCommand(name, (byte)id, 1, numParams, type, customFunctions, expirationTicks);
-            customCommandsInfo.Add(name, commandInfo);
+            if (commandInfo != null) customCommandsInfo.Add(name, commandInfo);
             return id;
         }
 
@@ -99,7 +99,7 @@ internal int Register(string name, int numParams, CommandType commandType, int o
                 throw new Exception("Out of registration space");
 
             wrapper.commandMap[subCommand] = new CustomObjectCommand(name, (byte)objectTypeId, (byte)subCommand, 1, numParams, commandType, wrapper.factory);
-            customCommandsInfo.Add(name, commandInfo);
+            if (commandInfo != null) customCommandsInfo.Add(name, commandInfo);
 
             return subCommand;
         }
@@ -127,7 +127,7 @@ internal int Register(string name, int numParams, CommandType commandType, int o
                 throw new Exception("Out of registration space");
             wrapper.commandMap[subCommand] = new CustomObjectCommand(name, (byte)objectTypeId, (byte)subCommand, 1, numParams, commandType, wrapper.factory);
 
-            customCommandsInfo.Add(name, commandInfo);
+            if (commandInfo != null) customCommandsInfo.Add(name, commandInfo);
 
             return (objectTypeId, subCommand);
         }

diff --git a/libs/server/Servers/RegisterApi.cs b/libs/server/Servers/RegisterApi.cs
@@ -35,7 +35,7 @@ public RegisterApi(GarnetProvider provider)
         /// >0 => set expiration to given value.
         /// </param>
         /// <returns>ID of the registered command</returns>
-        public int NewCommand(string name, int numParams, CommandType type, CustomRawStringFunctions customFunctions, RespCommandsInfo commandInfo, long expirationTicks = 0)
+        public int NewCommand(string name, int numParams, CommandType type, CustomRawStringFunctions customFunctions, RespCommandsInfo commandInfo = null, long expirationTicks = 0)
             => provider.StoreWrapper.customCommandManager.Register(name, numParams, type, customFunctions, commandInfo, expirationTicks);
 
         /// <summary>
@@ -82,7 +82,7 @@ public void NewType(int type, CustomObjectFactory factory)
         /// <param name="type">Type ID for factory, registered using RegisterType</param>
         /// <param name="commandInfo">RESP command info</param>
         /// <returns>ID of the registered command</returns>
-        public int NewCommand(string name, int numParams, CommandType commandType, int type, RespCommandsInfo commandInfo)
+        public int NewCommand(string name, int numParams, CommandType commandType, int type, RespCommandsInfo commandInfo = null)
             => provider.StoreWrapper.customCommandManager.Register(name, numParams, commandType, type, commandInfo);
 
         /// <summary>
@@ -94,7 +94,7 @@ public int NewCommand(string name, int numParams, CommandType commandType, int t
         /// <param name="factory">Custom factory for object</param>
         /// <param name="commandInfo">RESP command info</param>
         /// <returns>ID of the registered command</returns>
-        public (int, int) NewCommand(string name, int numParams, CommandType commandType, CustomObjectFactory factory, RespCommandsInfo commandInfo)
+        public (int, int) NewCommand(string name, int numParams, CommandType commandType, CustomObjectFactory factory, RespCommandsInfo commandInfo = null)
             => provider.StoreWrapper.customCommandManager.Register(name, numParams, commandType, factory, commandInfo);
 
     }

diff --git a/main/GarnetServer/GarnetServer.csproj b/main/GarnetServer/GarnetServer.csproj
@@ -18,9 +18,6 @@
   </ItemGroup>
 
   <ItemGroup>
-    <None Update="CustomRespCommandsInfo.json">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </None>
     <None Update="garnet.conf">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

diff --git a/main/GarnetServer/Program.cs b/main/GarnetServer/Program.cs
@@ -3,8 +3,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.IO;
-using System.Reflection;
 using System.Threading;
 using Garnet.common;
 using Garnet.server;
@@ -16,8 +14,6 @@ namespace Garnet
     /// </summary>
     class Program
     {
-        private static readonly string CustomRespCommandInfoJsonFileName = "CustomRespCommandsInfo.json";
-
         static void Main(string[] args)
         {
             try
@@ -49,24 +45,19 @@ static void Main(string[] args)
         /// </summary>
         static bool TryRegisterExtensions(GarnetServer server)
         {
-            var binPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
-
-            if (!TryGetRespCommandsInfo(Path.Combine(binPath!, CustomRespCommandInfoJsonFileName), out var customCommandsInfo))
-                return false;
-
             // Register custom command on raw strings (SETIFPM = "set if prefix match")
-            server.Register.NewCommand("SETIFPM", 2, CommandType.ReadModifyWrite, new SetIfPMCustomCommand(), customCommandsInfo["SETIFPM"]);
+            server.Register.NewCommand("SETIFPM", 2, CommandType.ReadModifyWrite, new SetIfPMCustomCommand());
 
             // Register custom command on raw strings (SETWPIFPGT = "set with prefix, if prefix greater than")
-            server.Register.NewCommand("SETWPIFPGT", 2, CommandType.ReadModifyWrite, new SetWPIFPGTCustomCommand(), customCommandsInfo["SETWPIFPGT"]);
+            server.Register.NewCommand("SETWPIFPGT", 2, CommandType.ReadModifyWrite, new SetWPIFPGTCustomCommand());
 
             // Register custom command on raw strings (DELIFM = "delete if value matches")
-            server.Register.NewCommand("DELIFM", 1, CommandType.ReadModifyWrite, new DeleteIfMatchCustomCommand(), customCommandsInfo["DELIFM"]);
+            server.Register.NewCommand("DELIFM", 1, CommandType.ReadModifyWrite, new DeleteIfMatchCustomCommand());
 
             // Register custom commands on objects
             var factory = new MyDictFactory();
-            server.Register.NewCommand("MYDICTSET", 2, CommandType.ReadModifyWrite, factory, customCommandsInfo["MYDICTSET"]);
-            server.Register.NewCommand("MYDICTGET", 1, CommandType.Read, factory, customCommandsInfo["MYDICTGET"]);
+            server.Register.NewCommand("MYDICTSET", 2, CommandType.ReadModifyWrite, factory);
+            server.Register.NewCommand("MYDICTGET", 1, CommandType.Read, factory);
 
             // Register stored procedure to run a transactional command
             server.Register.NewTransactionProc("READWRITETX", 3, () => new ReadWriteTxn());

diff --git a/.../GarnetServer/CustomRespCommandsInfo.json → test/Garnet.test/CustomRespCommandsInfo.json b/.../GarnetServer/CustomRespCommandsInfo.json → test/Garnet.test/CustomRespCommandsInfo.json
diff --git a/test/Garnet.test/Garnet.test.csproj b/test/Garnet.test/Garnet.test.csproj
@@ -24,7 +24,7 @@
   </ItemGroup>
 
 	<ItemGroup>
-	  <EmbeddedResource Include="..\..\main\GarnetServer\CustomRespCommandsInfo.json" Link="CustomRespCommandsInfo.json">
+	  <EmbeddedResource Include="CustomRespCommandsInfo.json" Link="CustomRespCommandsInfo.json">
 	    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
 	  </EmbeddedResource>
 	</ItemGroup>