Improve error handler

[curquiza]

Related to this issue meilisearch/integration-guides#19 and the new error handler available since the MeiliSearch v0.11.0

How to do a quick check

• run a MS instance in local (with masterKey as master key)
• create an index with test as UID
• at the root of the repo, launch $ bundle exec ruby test.rb where test.rb is:

require 'meilisearch'

client = MeiliSearch::Client.new('http://127.0.0.1:7700', 'masterKey')
index_uid = 'test'

# To see the `details` method and the attributes when rescueing
begin
  client.create_index(index_uid)
rescue => e
  puts e.details
  puts e.type
  puts e.link
end

# To see the interpreter output
puts ''
client.create_index(index_uid)

[eskombro]

Amazing work and tests! Thanks!

Why are you using simple error naming? Shouldn't we use the naming chosen here instead of simplifying it?

e.g.
ApiError -> MeiliSearchApiError
CommunicationError -> MeiliSearchCommunicationError
TimeoutError -> MeiliSearchTimeoutError

[eskombro]

Suggested change

	@message = "An error occurred while trying to connect to the MeiliSearch instance: #{message}"
	@message = "An error occurred while trying to connect to MeiliSearch: #{message}"

[curquiza]

I wanted to make a real difference between the MeiliSearch search-engine/API/instance and the package the user is currently using that is also named "meilisearch" @eskombro
What do you suggest then?

[eskombro]

👌

[curquiza]

@eskombro

Why are you using simple error naming? Shouldn't we use the naming chosen here instead of simplifying it?

Because ruby allows namespaces. When the users will do a begin/rescue (try/catch equivalent), they will write rescue MeiliSearch::ApiError => e. The MeiliSearch is already present, and would be redundant if I rename all my errors with a MeiliSearch prefix (it would imply rescue MeiliSearch::MeiliSearchApiError => e).

I've already explained all of these in the issue you linked in the Remark section 😉

Some language allows namespacing. So the raised error could be MeiliSearch::ApiError instead of MeiliSearchApiError. It depends on the language. We should adopt the best practice of each language 🙂

For example, in the Ruby and PHP SDKs, we used the namespace MeiliSearch.
In the JS one, we use the prefix MeiliSearch instead, directly in the name of the error.

Also, depending on the language, the Error could be changed as Exception for example (ex: PHP).

And I don't need to write the namespace MeiliSearch:: in the internal code of this package because we work only in the generic module MeiliSearch (see the module MeiliSearch declared at the begining of each file).

[eskombro]

👌