Merge #258

258: Changes related to the next MeiliSearch release (v0.24.0) r=curquiza a=meili-bot

Related to this issue: meilisearch/integration-guides#149

This PR:
- gathers the changes related to the next MeiliSearch release (v0.24.0) so that this package is ready when the official release is out.
- should pass the tests against the [latest pre-release of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases).
- might eventually contain test failures until the MeiliSearch v0.24.0 is out.

⚠️ This PR should NOT be merged until the next release of MeiliSearch (v0.24.0) is out.

_This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/master/guides/pre-release-week.md) purpose._


Co-authored-by: meili-bot <[email protected]>
Co-authored-by: Clémentine Urquizar - curqui <[email protected]>
Co-authored-by: Clémentine Urquizar <[email protected]>

Author: 3 people

README.md

@@ -198,7 +198,7 @@ JSON output:
 
 ## 🤖 Compatibility with MeiliSearch
 
-This package only guarantees the compatibility with the [version v0.23.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.23.0).
+This package only guarantees the compatibility with the [version v0.24.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.24.0).
 
 ## 💡 Learn More
 

lib/meilisearch/error.rb

@@ -29,10 +29,10 @@ def initialize(http_code, http_message, http_body)
 
     def get_meilisearch_error_info(http_body)
       @http_body = JSON.parse(http_body)
-      @ms_code = @http_body['errorCode']
+      @ms_code = @http_body['code']
       @ms_message = @http_body['message']
-      @ms_type = @http_body['errorType']
-      @ms_link = @http_body['errorLink']
+      @ms_type = @http_body['type']
+      @ms_link = @http_body['link']
     rescue JSON::ParserError
       # We might receive a JSON::ParserError when, for example, MeiliSearch is running behind
       # some proxy (ELB or Nginx, for example), and the request timeouts, returning us

spec/meilisearch/client/dumps_spec.rb

@@ -20,7 +20,7 @@
   it 'fails to get dump status without uid' do
     expect do
       client.dump_status('uid_not_exists')
-    end.to raise_meilisearch_api_error_with(404, 'not_found', 'invalid_request_error')
+    end.to raise_meilisearch_api_error_with(404, 'dump_not_found', 'invalid_request')
   end
 
   it 'works with method aliases' do

spec/meilisearch/client/indexes_spec.rb

@@ -56,15 +56,15 @@
 
         expect do
           client.create_index('existing_index')
-        end.to raise_meilisearch_api_error_with(400, 'index_already_exists', 'invalid_request_error')
+        end.to raise_meilisearch_api_error_with(409, 'index_already_exists', 'invalid_request')
       end
     end
 
     context 'when the uid format is invalid' do
       it 'raises an error' do
         expect do
           client.create_index('two words')
-        end.to raise_meilisearch_api_error_with(400, 'invalid_index_uid', 'invalid_request_error')
+        end.to raise_meilisearch_api_error_with(400, 'invalid_index_uid', 'invalid_request')
       end
     end
   end

spec/meilisearch/client/keys_spec.rb

@@ -15,22 +15,22 @@
     new_client = MeiliSearch::Client.new(URL, public_key)
     expect do
       new_client.index(random_uid).settings
-    end.to raise_meilisearch_api_error_with(403, 'invalid_token', 'authentication_error')
+    end.to raise_meilisearch_api_error_with(403, 'invalid_api_key', 'auth')
   end
 
   it 'fails to get keys if private key used' do
     private_key = client.keys['private']
     new_client = MeiliSearch::Client.new(URL, private_key)
     expect do
       new_client.keys
-    end.to raise_meilisearch_api_error_with(403, 'invalid_token', 'authentication_error')
+    end.to raise_meilisearch_api_error_with(403, 'invalid_api_key', 'auth')
   end
 
   it 'fails to search if no key used' do
     new_client = MeiliSearch::Client.new(URL)
     expect do
       new_client.index(random_uid).settings
-    end.to raise_meilisearch_api_error_with(401, 'missing_authorization_header', 'authentication_error')
+    end.to raise_meilisearch_api_error_with(401, 'missing_authorization_header', 'auth')
   end
 
   it 'succeeds to search when using public key' do

spec/meilisearch/index/base_spec.rb

@@ -45,6 +45,19 @@
   end
 
   it 'updates primary-key of index if not defined before' do
+    index = client.create_index('uid', primaryKey: 'primary_key')
+    index.update(primaryKey: 'new_primary_key')
+    expect(index).to be_a(MeiliSearch::Index)
+    expect(index.uid).to eq('uid')
+    expect(index.primary_key).to eq('new_primary_key')
+    expect(index.fetch_primary_key).to eq('new_primary_key')
+    expect(index.created_at).to be_a(Time)
+    expect(index.created_at).to be_within(60).of(Time.now)
+    expect(index.updated_at).to be_a(Time)
+    expect(index.updated_at).to be_within(60).of(Time.now)
+  end
+
+  it 'updates primary-key of index if has been defined before but there is not docs' do
     index = client.create_index('uid')
     index.update(primaryKey: 'new_primary_key')
     expect(index).to be_a(MeiliSearch::Index)
@@ -58,13 +71,15 @@
   end
 
   it 'returns error if trying to update primary-key if it is already defined' do
-    index = client.create_index('uid', primaryKey: 'primary_key')
+    index = client.index('uid')
+    update = index.add_documents({ id: 1, title: 'My Title' })
+    index.wait_for_pending_update(update['updateId'])
     expect do
       index.update(primaryKey: 'new_primary_key')
     end.to raise_meilisearch_api_error_with(
       400,
-      'primary_key_already_present',
-      'invalid_request_error'
+      'index_primary_key_already_exists',
+      'invalid_request'
     )
   end
 

spec/meilisearch/index/documents_spec.rb

@@ -486,7 +486,7 @@
       response = index.add_documents!(documents)
       update = index.get_update_status(response['updateId'])
       expect(update['status']).to eq('failed')
-      expect(update['errorCode']).to eq('missing_primary_key')
+      expect(update['error']['code']).to eq('primary_key_inference_failed')
     end
   end
 

spec/meilisearch/index/settings_spec.rb

@@ -127,8 +127,8 @@
 
       response = index.get_update_status(response['updateId'])
 
-      expect(response.keys).to include('message')
-      expect(response['errorCode']).to eq('invalid_request')
+      expect(response.keys).to include('error')
+      expect(response['error']['code']).to eq('invalid_ranking_rule')
     end
 
     it 'resets ranking rules' do
@@ -562,8 +562,8 @@
       response = index.add_documents(title: 'Test')
       index.wait_for_pending_update(response['updateId'])
       response = index.get_update_status(response['updateId'])
-      expect(response.keys).to include('message')
-      expect(response['errorCode']).to eq('missing_primary_key')
+      expect(response.keys).to include('error')
+      expect(response['error']['code']).to eq('primary_key_inference_failed')
     end
 
     it 'adds documents when there is a primary-key' do

spec/support/exceptions_helpers.rb

@@ -14,31 +14,31 @@ def raise_bad_request_meilisearch_api_error
     raise_meilisearch_api_error_with(
       400,
       'bad_request',
-      'invalid_request_error'
+      'invalid_request'
     )
   end
 
   def raise_index_not_found_meilisearch_api_error
     raise_meilisearch_api_error_with(
       404,
       'index_not_found',
-      'invalid_request_error'
+      'invalid_request'
     )
   end
 
   def raise_document_not_found_meilisearch_api_error
     raise_meilisearch_api_error_with(
       404,
       'document_not_found',
-      'invalid_request_error'
+      'invalid_request'
     )
   end
 
   def raise_missing_primary_key_meilisearch_api_error
     raise_meilisearch_api_error_with(
       400,
-      'missing_primary_key',
-      'invalid_request_error'
+      'primary_key_inference_failed',
+      'invalid_request'
     )
   end
 end