Merge #557

557: Add validation for document_id to prevent nil or empty values r=brunoocasali a=Trehana

# Pull Request

## Related issue
Fixes #556 

## What does this PR do?
Add validation for document_id to prevent nil or empty values

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: Trehana Fernando <[email protected]>

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-06-01 14:58:01 UTC using RuboCop version 1.63.5.
+# on 2024-09-10 01:25:16 UTC using RuboCop version 1.65.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -15,7 +15,7 @@ Metrics/BlockLength:
 # Offense count: 4
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 430
+  Max: 433
 
 # Offense count: 1
 # Configuration parameters: Max, CountKeywordArgs.

lib/meilisearch/error.rb

@@ -70,6 +70,15 @@ def initialize(message = nil)
     end
   end
 
+  class InvalidDocumentId < Error
+    attr_reader :message
+
+    def initialize(message = nil)
+      @message = "The document id is invalid. #{message}"
+      super(@message)
+    end
+  end
+
   module TenantToken
     class ExpireOrInvalidSignature < MeiliSearch::Error; end
     class InvalidApiKey < MeiliSearch::Error; end

lib/meilisearch/index.rb

@@ -220,6 +220,10 @@ def delete_documents!(documents_ids)
     alias delete_multiple_documents! delete_documents!
 
     def delete_document(document_id)
+      if document_id.nil? || document_id.to_s.empty?
+        raise MeiliSearch::InvalidDocumentId, 'document_id cannot be empty or nil'
+      end
+
       encode_document = URI.encode_www_form_component(document_id)
       response = http_delete "/indexes/#{@uid}/documents/#{encode_document}"
 

spec/meilisearch/client/errors_spec.rb

@@ -33,4 +33,12 @@
       end.to raise_error(MeiliSearch::CommunicationError)
     end
   end
+
+  context 'when document id is invalid' do
+    it 'raises MeiliSearch::InvalidDocumentId' do
+      expect do
+        client.index('movies').delete_document(nil)
+      end.to raise_error(MeiliSearch::InvalidDocumentId)
+    end
+  end
 end

spec/meilisearch/index/documents_spec.rb

@@ -393,6 +393,10 @@
     describe '#delete_document' do
       before { index.add_documents(documents).await }
 
+      it 'if the document id is nil, it raises an error' do
+        expect { index.delete_document(nil) }.to raise_error(MeiliSearch::InvalidDocumentId)
+      end
+
       it 'deletes one document from index' do
         id = 456
         index.delete_document(id).await