ellnix commented 1 year ago

Pull Request

Related issue

Fixes #266

What does this PR do?

The purpose of this PR is to detach the MeiliSearch document deletion process from the ActiveRecord object so that documents corresponding to a record can be deleted even if the record no longer exists in the database.

Tests were also added for new functionality and to hopefully prevent regressions.

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?

Solution Considerations

Please read #266 for full context:

The suggested fix in #266 would not work due to the fact that the primary key of a record in an index can be dynamic (by a user-created method) and may not be reconstructed by the record's database ID alone. In addition, a record may have multiple entries in multiple indexes.
I created a new job so as not to break MSJob (although I suspect it would be better if it was replaced with a job dedicated to enqueued indexing, since that's all it does now anyway)
ActiveJob needs to somehow serialize the parameters to a job, default serialization (through GlobalID) relies on a database entry to reinitialize the record when the job is run
- Since the record may no longer exist by the time the job runs, I pass a list of indexes and IDs that may (more on that) belong to the record
I created a new set of ms_entries methods whose purpose is to use the current configuration to list every index the record may have a document in, along with the record's primary key in that index
- The method does not check Utilities.indexable? so it is possible that some of the entries it returns are not actually in MeiliSearch, this is by design since its intention is to be exhaustive and in theory those primary keys cannot belong to another record so deleting them should be ok

codecov[bot] commented 1 year ago

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (53febb3) 89.15% compared to head (d32db1a) 89.32%.

Files	Patch %	Lines
lib/meilisearch/rails/ms_clean_up_job.rb	90.00%	1 Missing :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #290 +/- ## ========================================== + Coverage 89.15% 89.32% +0.17% ========================================== Files 10 11 +1 Lines 664 684 +20 ========================================== + Hits 592 611 +19 - Misses 72 73 +1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.