search

spring-projects / spring-data-relational

Spring Data Relational. Home of Spring Data JDBC and Spring Data R2DBC.
https://spring.io/projects/spring-data-jdbc
Apache License 2.0
753 stars 345 forks source link

Consider JTS Geometry types as simple types #1711

Closed pete-setchell-kubra closed 8 months ago

pete-setchell-kubra commented 8 months ago

Bug Report

Creating a basic entity with a PostGIS geometry Point type does not function as expected with Spring Data R2DBC. A Point can be read from a fixture in the database using the native PostgisGeometryCodec, but cannot be inserted in a new entity.

Versions

Current Behavior

Attempting to set up a minimal mapping of a point with JTS does not work as expected with kotlin and Spring Data R2DBC. Running through a debugger, the PostgisGeometryCodec seems to be dynamically loaded during connection handshake, but this is not done in time to stop the exception being thrown on first write.

Stack trace ``` org.springframework.dao.InvalidDataAccessApiUsageException: Nested entities are not supported at org.springframework.data.r2dbc.convert.MappingR2dbcConverter.writePropertyInternal(MappingR2dbcConverter.java:251) at org.springframework.data.r2dbc.convert.MappingR2dbcConverter.writeProperties(MappingR2dbcConverter.java:218) at org.springframework.data.r2dbc.convert.MappingR2dbcConverter.writeInternal(MappingR2dbcConverter.java:189) at org.springframework.data.r2dbc.convert.MappingR2dbcConverter.write(MappingR2dbcConverter.java:181) at org.springframework.data.r2dbc.convert.MappingR2dbcConverter.write(MappingR2dbcConverter.java:61) at org.springframework.data.r2dbc.core.DefaultReactiveDataAccessStrategy.getOutboundRow(DefaultReactiveDataAccessStrategy.java:177) at org.springframework.data.r2dbc.core.R2dbcEntityTemplate.lambda$doInsert$6(R2dbcEntityTemplate.java:470) at reactor.core.publisher.FluxFlatMap.trySubscribeScalarMap(FluxFlatMap.java:153) at reactor.core.publisher.MonoFlatMap.subscribeOrReturn(MonoFlatMap.java:53) at reactor.core.publisher.InternalMonoOperator.subscribe(InternalMonoOperator.java:63) at reactor.core.publisher.MonoUsingWhen.subscribe(MonoUsingWhen.java:87) at reactor.core.publisher.Mono.subscribe(Mono.java:4512) at kotlinx.coroutines.reactor.MonoKt.awaitSingleOrNull(Mono.kt:47) at org.springframework.aop.framework.CoroutinesUtils.awaitSingleOrNull(CoroutinesUtils.java:42) at org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopProxy.java:268) at jdk.proxy2/jdk.proxy2.$Proxy69.save(Unknown Source) at com.example.r2dbchibernatepoc.repository.AssetRepositoryTest$testInsert$1.invokeSuspend(AssetRepositoryTest.kt:29) at _COROUTINE._BOUNDARY._(CoroutineDebugging.kt:46) at com.example.r2dbchibernatepoc.repository.AssetRepositoryTest$testInsert$1.invokeSuspend(AssetRepositoryTest.kt:29)```

Table schema

Input Code ```sql CREATE SEQUENCE asset_id_seq; CREATE TABLE IF NOT EXISTS asset ( id BIGINT PRIMARY KEY DEFAULT NEXTVAL('asset_id_seq'), geom GEOMETRY(Point, 4326) ); ```

Steps to reproduce

Input Code ```kotlin import org.locationtech.jts.geom.Geometry @Table("asset") data class Asset constructor( @Id val id: Long?, @Column val geom: Geometry ) interface AssetRepository : CoroutineCrudRepository { override suspend fun findById(id: Long): Asset? } ``` ```kotlin import org.locationtech.jts.geom.Coordinate; import org.locationtech.jts.geom.Geometry import org.locationtech.jts.geom.GeometryFactory; import org.locationtech.jts.geom.PrecisionModel @SpringBootTest class AssetRepositoryTest @Autowired constructor(val userRepository: UserRepository, val assetRepository: AssetRepository) { @Test fun testInsert() { val longitude = 37.7434579544699 val latitude = -122.44437070120628 val factory4326 = GeometryFactory(PrecisionModel(PrecisionModel.FLOATING), 4326) val p: Geometry = factory4326.createPoint(Coordinate(longitude, latitude)) as Geometry runBlocking { val a = assetRepository.save(Asset(id=null, geom = p)) assertNotNull(a.id) val aid = a.id!! val b = assetRepository.findById(aid) assertEquals(a, b) assertNotNull(b?.geom) } } @Test fun testRead() { runBlocking { val aid = 1L val a = assetRepository.findById(aid) assertNotNull(a?.geom) } } } ``` A minimal reproducible version of this bug is available here: https://github.com/pete-setchell-kubra/r2dbcrepro

Expected behavior/code

Possible Solution

This may be in issue in r2dbc-postgresql, I'll double file there and update this ticket with an issue number.

pete-setchell-kubra commented 8 months ago

Also filed against r2dbc-postgresql

https://github.com/pgjdbc/r2dbc-postgresql/issues/626

mp911de commented 8 months ago

We do not consider JTS types (org.locationtech.jts) as simple ones as Spring Data has no dependency on JTS.

I suggest subclassing org.springframework.data.r2dbc.dialect.PostgresDialect and providing JTS types via getSimpleTypes() in addition to PostgresDialect.getSimpleTypes().

As we're not deeply involved with JTS, I suggest that you first experiment within your own domain and once you're happy with how things work, feel free to submit a pull request.

pete-setchell-kubra commented 8 months ago

Thanks for the pointer, I'm attempting to implement a PostgisDialect as you suggest.

I'm curious about the distinction between org.locationtech.jts types and io.r2dbc.postgresql.codec types that you do support. org.springframework.data.r2dbc.dialect.PostgresDialect is obviously designed to define the types that r2dbc-postgresql supports, and does so by instrospection. As org.locationtech.jts is at least a transitive provided dependency of r2dbc-postgresql couldn't you follow a similar approach without having to introduce dependencies?

pete-setchell-kubra commented 8 months ago

For anyone else trying to get this working, here's my working kotlin solution.

class PostgisDialect: PostgresDialect() {

    companion object {
        var gisSimpleTypes: MutableCollection<out Class<*>>

        init {
            val types = HashSet(org.springframework.data.r2dbc.dialect.PostgresDialect.INSTANCE.simpleTypes())
            types.addAll(listOf<String> (
                    "org.locationtech.jts.geom.Geometry",
                    "org.locationtech.jts.geom.Point",
                    "org.locationtech.jts.geom.MultiPoint",
                    "org.locationtech.jts.geom.LineString",
                    "org.locationtech.jts.geom.LinearRing",
                    "org.locationtech.jts.geom.MultiLineString",
                    "org.locationtech.jts.geom.Polygon",
                    "org.locationtech.jts.geom.MultiPolygon",
                    "org.locationtech.jts.geom.GeometryCollection"
                )
                .filter {
                    ClassUtils.isPresent(it, PostgisDialect::class.java.getClassLoader())
                }.map {
                    ClassUtils.resolveClassName(it, PostgisDialect::class.java.getClassLoader())
                }.toMutableSet())
            gisSimpleTypes = types
        }
    }

    override fun getSimpleTypes(): MutableCollection<out Class<*>> {
        return gisSimpleTypes
    }
}
class PostgisDialectProvider: R2dbcDialectProvider {
    override fun getDialect(connectionFactory: ConnectionFactory): Optional<R2dbcDialect> {
        return Optional.of(PostgisDialect())
    }
}

META-INF/spring.factories

org.springframework.data.r2dbc.dialect.DialectResolver$R2dbcDialectProvider=com.example.r2dbchibernatepoc.repository.PostgisDialectProvider

@mp911de, I'll prepare a pull request to roll this up. As it doesn't require converters or any additional dependencies, I don't see why it couldn't be rolled straight into PostgresDialect.

pete-setchell-kubra commented 8 months ago

This turned out to be extremely straightforward, so I've created a pull request. Hope it saves someone else an hour or two of debugging!

https://github.com/spring-projects/spring-data-relational/pull/1713