Issue #2258 - Typeful Metadata #2270

homedirectory · 2024-06-10T07:25:23Z

Resolve #2258.

This PR should be merged together with corresponding PRs in TG applications and https://github.com/fieldenms/tg-libs/pull/27.

Summary of changes

There have been a number of breaking changes associated with the removal of EQL3 metadata and EQL2
metadata, therefore TG applications need to be adjusted accordingly.

Metadata:

EQL3 and EQL2 metadata have been removed and their usages replaced by Typeful Metadata
Stricter validation of property definitions during metadata generation: unsupported property types
are detected early (in some cases an unsupported type is shown mercy and corresponding property is
simply skipped).
Changes to Property Metadata:
- Properties with a composite or a union entity type are classified according to their nature in
  the same way as other properties. This hadn't been the case with EQL3 metadata, which ignored
  the nature of such properties, instead forcing the caller to look at their sub-properties for
  this information.

Other changes:

Value range validation (from-to) is now supported for BigDecimal.
All generated proxy entity types now implement IProxyEntity.
Generated ID-only proxy entity types now implement IIdOnlyProxyEntity.
Test entity types were modified by replacing unsupported property types with supported ones (e.g.,
Double by BigDecimal).

Future work

Encapsulate Hibernate type access in a standalone service. It should have the following API:
```
Optional<?> hibernateType(PropertyMetadata property)
```
Encapsulate EqlTable access in a standalone service. It should have the following API:
```
EqlTable eqlTable(Class<? extends AbstractEntity<?>> entityType)
```

Encapsulate TableStructForBatchInsertion access in a standalone service. It should have the following API:

TableStructForBatchInsertion tableStructForBatchInsertion(Class<? extends AbstractEntity<?>> entityType)

Encapsulate database DDL generation in a standalone service. It should have the following API:
```
List<String> generateDatabaseDdl(Dialect dialect)
```
Configure dependency injection and decouple IDomainMetadata from QuerySourceInfoProvider.

…ubpackage to be later turned into new implementation (based on EQL3 metadata).

sorted() was causing a runtime error due to StringBuffer and String not being mutually comparable.

…ive to visitors with a single clause

These predicates are preferred over "instanceof" statements.

…keys parameterised with boolean

… type

…data Injection of the metadata service is yet to be implemented.

…type metadata instances

…ies to generate metadata for property "version" It is not clear why a more specific predicate (targeting only the superclass) had been used, but the incosistencies it could result in don't make a lot of sense (e.g., generated types based on synthetic-based-on-persistent would lack metadata for "version").

…allTypes

…-on-persistent entity types Consider the whole type hierarchy, not just the superclass.

…ut a DB table During migration to Typeful Metadata the algorithm has been incorrecly understood and table name existence became a strict constraint.

…tity proxy types

Note: Cache.get, if key is absent, caches the value returned by the supplied loader, so there is no need to Cache.put it manually.

…ion of DomainProperty

… behaviour * Exclude plain properties of persistent entities (they were absent from EQL3 metadata). * Correct computation of key member indices for entities with a simple key.

Given the following entities: Entity E CompositeKeyMember property x: U Union Entity U property y: E Fetch model construction would get stuck in a cycle between them.

…ies typed with union entities

…hip between an entity and a union entity

…during tests

Nazar Chaykivskyy and others added 30 commits February 21, 2024 10:02

Merge branch 'develop' into Issue-#2180

8a70dc8

#2180 Copied existing retrieval model implementation classes to new s…

d04e065

…ubpackage to be later turned into new implementation (based on EQL3 metadata).

Merge branch 'develop' into Issue-#2180

f948309

Merge branch 'develop' into Issue-#2180

e949c1b

Merge branch 'develop' into Issue-#2180

6159e1e

Merge branch 'develop' into Issue-#2180

b1a996d

Merge branch 'develop' into Issue-#2180

66c5804

#2180 Document fetch and IRetrievalModel classes

97c1a0f

#2180 Simplify EntityContainerEnhancer.getDataInBatches

5d28d7b

#2180 Minor simplifications in EntityContainerEnhancer

1827cd0

#2180 Simplify yields enhancement during stage 1-2 tranformation

c9ec48e

#2238 Add missing Test annotation and fix a failing assertion

e19065f

sorted() was causing a runtime error due to StringBuffer and String not being mutually comparable.

#2180 Add utilities for test assertions about Optionals

71a9988

#2180 Utility for retrieving the first element of a collection

dabdd6b

#2180 Decompose yields enhancement to improve clarity

3883bc5

Fix malformed format string

3f7b3be

#2180 Refactor Finder.findCommonProperties using functional style

b8782a1

Documentation improvements

d79eac6

#2258 Introduce core abstractions for typeful metadata

a691456

#2258 Provide an implementation of PropertyMetadata

fa6b476

#2258 Provide an implementation of TypeMetadata.Entity

bc09b8d

#2258 Provide an implementation of TypeMetadata.Composite

ee75ae3

#2258 Enhance metadata interfaces with convenient methods as alternat…

f9eecda

…ive to visitors with a single clause

#2258 Enhance sealed interfaces with convenient predicates

b484bb9

These predicates are preferred over "instanceof" statements.

#2258 Enhance PropertyMetadata with a convenient method for metadata …

35851e4

…keys parameterised with boolean

#2258 Introduce 2 more interfaces that assist with metadata access

9c40e1d

#2258 Extract NewProperty.newParameterizedType into a reusable utility

86840a2

#2258 Enhance PropertyTypeMetadata with access to the underlying Java…

e1de099

… type

#2258 Migrate container enhancer and retrieval models to typeful meta…

313a385

…data Injection of the metadata service is yet to be implemented.

#2258 Enhance IDomainMetadata with method for accessing all existing …

41cb6e0

…type metadata instances

homedirectory added 26 commits June 5, 2024 12:13

#2258 More precise error message

7fe2bd0

#2258 Implement a stream util: foldLeft

502cb6f

#2258 Test: StreamUtils.foldLeft

f3b66d3

#2258 Use StreamUtils.foldLeft for clarity

47c1ac7

#2258 Replace Collection by Stream in return type of IDomainMetadata.…

9135db2

…allTypes

#2258 Simplify switch expression with a single clause

db0e4b4

#2258 Implement a util method to stream entity type hierarchy

b4c27a1

#2258 PersistDomainMetadataModel: exhaustively handle synthetic-based…

b57b8b3

…-on-persistent entity types Consider the whole type hierarchy, not just the superclass.

#2258 PersistDomainMetadataModel: correctly handle entity types witho…

30817b0

…ut a DB table During migration to Typeful Metadata the algorithm has been incorrecly understood and table name existence became a strict constraint.

#2258 Remove outdated comment

ad620b6

#2258 Ability to provide interfaces to be implemented by generated en…

d142941

…tity proxy types

#2258 Identify proxy entity types by a special marker interface

32dc0ef

#2258 Identify id-only proxy entity types by a special marker interface

df36fb7

#2258 Optimise usages of EntityProxyContainer

60721c6

#2258 Minor improvements to EntityProxyContainer

529d203

Note: Cache.get, if key is absent, caches the value returned by the supplied loader, so there is no need to Cache.put it manually.

#2258 Fix typo in variable name that was leading to incorrect generat…

e0f549b

…ion of DomainProperty

#2258 PersistDomainMetadataModel: more changes to align with previous…

7d69a80

… behaviour * Exclude plain properties of persistent entities (they were absent from EQL3 metadata). * Correct computation of key member indices for entities with a simple key.

#2258 EntityMetadataUtils: ensure composite key members are ordered

18410d9

#2258 Avoid non-termination during fetch model construction

5600cf8

Given the following entities: Entity E CompositeKeyMember property x: U Union Entity U property y: E Fetch model construction would get stuck in a cycle between them.

#2258 PersistDomainMetadataModel: no need for column name for propert…

050fa7e

…ies typed with union entities

#2258 Test: fetch model construction for a case of circular relations…

b4e12dd

…hip between an entity and a union entity

#2258 Minor improvements to FetchModelTest

d7849f9

#2258 Adjust a test after adding a static field to AbstractEntity

bb53bc9

#2258 DomainPropertyHolder: add meaningful properties descriptions

7da5d23

Merge branch 'develop' into Issue-#2258

37a1802

homedirectory requested a review from 01es June 10, 2024 07:27

homedirectory and others added 3 commits June 10, 2024 13:16

#2258 Create missing parent directories when saving a script to file …

bec19b8

…during tests

Merge branch 'develop' into Issue-#2258

f2bb2e0

#2258 Synced with develop.

50b24cf

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue #2258 - Typeful Metadata #2270

Issue #2258 - Typeful Metadata #2270

homedirectory commented Jun 10, 2024 •

edited

Loading

Issue #2258 - Typeful Metadata #2270

Are you sure you want to change the base?

Issue #2258 - Typeful Metadata #2270

Conversation

homedirectory commented Jun 10, 2024 • edited Loading

Summary of changes

Future work

homedirectory commented Jun 10, 2024 •

edited

Loading