Condition improvements: support null params, support in Jmix Data Repositories

[dtaimanov]

I. Support conditions in Jmix Data Repositories

io.jmix.core.repository.JmixDataRepositoryContext has been added to pass io.jmix.core.querycondition.Condition and other Jmix-related paramters to Jmix Data Repositories. It allows to dynamically change them at runtime for repository methods.

Implementation:

• Supported by io.jmix.core.repository.JmixDataRepository standard methods.
• Supported as paramter of user-defined methods, e.g.:

   // ---------- Repository: ----------
   public interface CustomerRepository extends JmixDataRepository<Customer, UUID> {
       List<Customer> loadByName(String name, JmixDataRepositoryContext context);
       //...
   }
  
   // ---------- Usage: ----------
   customerRepository.loadByName("John", JmixDataRepositoryContext.of(condition))
   customerRepository.loadByName("Rincewind", JmixDataRepositoryContext.plan(getSomeFetchPlan()).condition(condition).build())
   // or using static imports:
   customerRepository.loadByName("Kel", hints(PersistenceHints.SOFT_DELETION, false)).condition(condition).build())

Priorities of parameter values (from highest to lowest):

FetchPlan:

1. FetchPlan parameter
2. JmixDataRepositoryContext#fetchPlan parameter
3. @FetchPlan annotatin value

Hints (different keys will be merged, the same key value will be overridden):

1. JmixDataRepositoryContext parameter
2. @QueryHints annotation value

II. Do not ignore conditions if parameter is null or empty:

See forum topic

Problem:

Jmix Data Repositories use io.jmix.core.querycondition.Condition under the hood. Condition originally have been designed to work with UI filter conditions where null value in field means that no filtering needed because value is not specified.

Unfortunately this is not correct behaviour for Data Repositories.

Solution:

Rework Conditions and Repositories in order to take nulls as parameters

Implementation:

• Conditions in UI: old behaviour, conditions with absent, null or empty parameter will be skipped.
• [breaking changes] JmixDataRepositories in new projects: derived methods will no longer skip conditions with null or empty values. Set jmix.core.skip-null-or-empty-conditions-by-default=true to return old behaviour for project
• [breaking changes] Manually created conditions in app code of new projects: will be applied even when parameter absent, null or empty.
  Set jmix.core.skip-null-or-empty-conditions-by-default=true to return old behaviour for all project or set ParameterCondition/JpqlCondition#skipNullOrEmpty = true to return old behaviour for particular condition.

Studio issue: JST-4693

QA Notes

I. Support conditions in Jmix Data Repositories

• Check JmixDataRepositoryContext parameter works for standard and query methods of repositories

II. Do not ignore conditions if parameter is null or empty

• Check that UI filter still do not filter entities out if no value specified
• Check that manually created conditions condider nulls in values
• Check that jmix.core.skip-null-or-empty-conditions-by-default toggles this behaviour
• (Additionally) Check that migration from old Jmix version automatically sets jmix.core.skip-null-or-empty-conditions-by-default=true

[MaxKatyshev]

Jmix version: 2.2.999-SNAPSHOT
Jmix Studio plugin version: 2.2.SNAPSHOT6075-233
IntelliJ version: IntelliJ IDEA 2023.3.2 (Ultimate Edition)
verified