Merge pull request #19 from cipherstash/unique-index-option

Add ability to specify unique constraint on exact and range indexes

Author: fimac

cipherstash-client.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "aws-sdk-core", "~> 3.0"
   s.add_runtime_dependency "aws-sdk-kms", "~> 1.0"
   s.add_runtime_dependency 'cbor', '~> 0.5.9.6'
-  s.add_runtime_dependency "cipherstash-grpc", "= 0.20220706.5"
+  s.add_runtime_dependency "cipherstash-grpc", "= 0.20220801.1"
   s.add_runtime_dependency "enveloperb", "~> 0.0"
   s.add_runtime_dependency "launchy", "~> 2.5"
   s.add_runtime_dependency "ore-rs", "~> 0.0"

lib/cipherstash/client.rb

@@ -145,6 +145,8 @@ def collections
     #
     # @raise [CipherStash::Client::Error::DecryptionFailure] if there was a problem decrypting the naming key.
     #
+    # @raise [CipherStash::Client::Error::InvalidSchemaError] if there was a problem with the format of the schema.
+    #
     def create_collection(name, schema)
       @metrics.measure_client_call("create_collection") do
         metadata = {

lib/cipherstash/client/rpc.rb

@@ -79,6 +79,7 @@ def create_collection(name, metadata, indexes)
                     id: blob_from_uuid(idx[:meta]["$indexId"]),
                     settings: encrypt_blob(idx.to_cbor, "createCollection"),
                     type: index_type(idx[:mapping]["kind"]),
+                    unique: idx[:mapping]["unique"]
                   }
                 end
               )
@@ -103,6 +104,7 @@ def migrate_collection(name, metadata, indexes, from_schema_version)
                     id: blob_from_uuid(idx[:meta]["$indexId"]),
                     settings: encrypt_blob(idx.to_cbor, "migrateCollection"),
                     type: index_type(idx[:mapping]["kind"]),
+                    unique: idx[:mapping]["unique"]
                   }
                 end,
                 fromSchemaVersion: from_schema_version
@@ -158,6 +160,8 @@ def put(collection, id, record, vectors)
         uuid_from_blob(id)
       rescue ::GRPC::NotFound
         raise Error::RecordPutFailure, "Collection '#{collection.name}' not found"
+      rescue ::GRPC::InvalidArgument => ex
+        raise Error::RecordPutFailure, "Error while putting record into collection '#{collection.name}': #{ex.message} (#{ex.class})"
       rescue ::GRPC::BadStatus => ex
         raise Error::RecordPutFailure, "Error while putting records into collection '#{collection.name}': #{ex.message} (#{ex.class})"
       end
@@ -278,7 +282,11 @@ def put_stream(collection, records)
 
         res.numInserted
       rescue ::GRPC::NotFound
-        raise Error::RecordDeleteFailure, "Collection '#{collection.name}' not found"
+        raise Error::RecordPutFailure, "Collection '#{collection.name}' not found"
+      rescue ::GRPC::InvalidArgument => ex
+        raise Error::RecordPutFailure, "Error while putting records into collection '#{collection.name}': #{ex.message} (#{ex.class})"
+      rescue ::GRPC::BadStatus => ex
+        raise Error::RecordPutFailure, "Error while putting records into collection '#{collection.name}': #{ex.message} (#{ex.class})"
       end
 
       def delete(collection, id)

lib/cipherstash/index.rb

@@ -43,6 +43,10 @@ def generate(id, settings, schema_versions)
       def settings(name, base_settings, schema)
         subclass = subclass_from_kind(base_settings["kind"])
 
+        if base_settings.key?("unique") && !subclass.uniqueness_supported?
+          raise CipherStash::Client::Error::InvalidSchemaError, "Unique constraint not allowed on type #{base_settings["kind"].inspect}" 
+        end
+
         {
           meta: subclass.meta(name),
           mapping: subclass.mapping(base_settings, schema),
@@ -131,6 +135,14 @@ def orderable?
       # that do
       false
     end
+    
+    # Does this index support a unique constraint?
+    #
+    # @return [bool]
+    #
+    def uniqueness_supported?
+      false
+    end
 
     # Examine the given record and send back index vectors.
     #

lib/cipherstash/index/dynamic_filter_match.rb

@@ -26,6 +26,10 @@ def self.meta(name)
         def orderable?
           false
         end
+        
+        def self.uniqueness_supported?
+          false
+        end
 
         def analyze(uuid, record)
           blid = blob_from_uuid(uuid)

lib/cipherstash/index/dynamic_ore_match.rb

@@ -22,6 +22,10 @@ def orderable?
         false
       end
 
+      def self.uniqueness_supported?
+        false
+      end
+
       def analyze(uuid, record)
         blid = blob_from_uuid(uuid)
         raw_terms = collect_string_fields(record).map(&:last)

lib/cipherstash/index/exact.rb

@@ -26,6 +26,10 @@ def orderable?
         false
       end
 
+      def self.uniqueness_supported?
+        true
+      end
+
       def analyze(uuid, record)
         blid = blob_from_uuid(uuid)
 

lib/cipherstash/index/field_dynamic_exact.rb

@@ -18,6 +18,10 @@ def self.meta(name)
         self.ore_meta(name)
       end
 
+      def self.uniqueness_supported?
+        false
+      end
+
       def analyze(uuid, record)
         blid = blob_from_uuid(uuid)
 

lib/cipherstash/index/field_dynamic_filter_match.rb

@@ -23,6 +23,10 @@ def self.meta(name)
           self.filter_meta(name)
         end
 
+        def self.uniqueness_supported?
+          false
+        end
+
         def analyze(uuid, record)
           blid = blob_from_uuid(uuid)
 

lib/cipherstash/index/field_dynamic_ore_match.rb

@@ -18,6 +18,10 @@ def self.meta(name)
         self.ore_meta(name)
       end
 
+      def self.uniqueness_supported?
+        false
+      end
+
       def analyze(uuid, record)
         blid = blob_from_uuid(uuid)