(feat): DocumentDataProvider to allow external data sources

[Guikingone]

Description

Hi everyone 👋🏻

Small suggestion here that can help the bundle supporting extra document data sources, for now, this bundle only support loading document data from entities (without asynchronous supports but more on this later), even if this is the de facto approach when it comes to data handling in Symfony application (thanks to Doctrine), we often use external services like Redis, Kafka and so on, these services contains data and we often need to search on it.

The idea here is to introduce the idea of DocumentDataProvider (or just _X_DataProvider) along with a DataProviderRegistry which allow to use the data providers and allow each provider to return an array that contains data that we can load into indexes.

Basic example

Ok, so, here's a small example:

final class FooDataProvider implements DataProviderInterface
{
    public function getData(): array
    {
        // Fetch data from external data source and return a valid array
    }

    public static function getIndex(): string // static is not a requirement
    {
        return 'foo';
    }
}

Following the same approach, an EntityDataProvider can be created to move the logic from the existing command to a dedicated class.

The final part is a DataProviderRegistry which contains and allow to access and interact with the data providers (sort them, filter them and many more) which can be injected in the command to remove some logic on it and ease both the debug and evolution phase.

Regarding the asynchronous support, when using Messenger and regarding #62, adding this layer can help introduce the asynchronous support by allowing to dispatch a message which can call the registry to persist data into MS.

I've already implemented a solution here but the final implementation can be improved 🙂

Other

--

Thanks for the feedback and have a great day 🙂

[curquiza]

Hello @Guikingone thanks a lot for having taken the time to write this issue.
Since I'm not a Symfony user, I let people from the community to give their opinion 😄

[norkunas]

I think it'd nice addition :)

[Guikingone]

Hi 👋🏻

@curquiza If it's good for you, I can start working on a solution, submit a PR then we can see if it fit the bundle and improve the developer experience 🙂

[curquiza]

Hello @Guikingone, thanks for your suggestion, I think we can start a work on it! :)