Skip to content

Helper methods and extensions to improve kotlin interop. #1478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Sep 23, 2024

Conversation

rozza
Copy link
Member

@rozza rozza commented Aug 13, 2024

Based on kmongo-property but provides both infix and nested helpers.

Adds a new package org.mongodb.mongodb-driver-kotlin-extensions. Its both kotlin drivers and bson kotlin implementations agnostic. So can be used with any combination of bson-kotlin, bson-kotlinx, mongodb-driver-kotlin-sync and mongodb-driver-kotlin-coroutine.

Initial Filters extensions support, with both inflix and nested helpers eg:

import com.mongodb.kotlin.client.model.Filters.eq

// infix
Person::name.eq(person.name)

// nested
val bson = eq(Person::name, person.name)

Also adds path based support which works with vairous annotations on the data class: @SerialName("_id"), @BsonId, @BsonProperty("_id"):

(Restaurant::reviews / Review::score).path() == "reviews.rating"

JAVA-5308 JAVA-5484

…ngo-property but provides both infix and nested helpers.

Adds a new package `org.mongodb.mongodb-driver-kotlin-extensions`. Its both kotlin drivers and bson kotlin implementations agnostic.
So can be used with any combination of `bson-kotlin`, `bson-kotlinx`, `mongodb-driver-kotlin-sync` and `mongodb-driver-kotlin-coroutine`.

Initial Filters extensions support, with both inflix and nested helpers eg:

```
import com.mongodb.kotlin.client.model.Filters.eq

// infix
Person::name.eq(person.name)

// nested
val bson = eq(Person::name, person.name)
```

Also adds path based support which works with vairous annotations on the data class: `@SerialName("_id")`, `@BsonId`, `@BsonProperty("_id")`:

```
(Restaurant::reviews / Review::score).path() == "reviews.rating"
```

JAVA-5308 JAVA-5484
@rozza rozza requested review from jyemin and vbabanin August 13, 2024 13:12
@jyemin jyemin removed their request for review August 13, 2024 20:45
Copy link
Member

@vbabanin vbabanin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall! Just a couple of questions.

NOTE: I am still reviewing some of the files before LGTM.

@rozza rozza requested a review from vbabanin August 29, 2024 11:30
@rozza rozza requested a review from vbabanin September 3, 2024 12:11
@vbabanin
Copy link
Member

LGTM, noting that I'm not deeply versed in Kotlin!

@vbabanin vbabanin requested a review from nhachicha September 16, 2024 16:09
Copy link
Contributor

@nhachicha nhachicha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM some minor comments 👍

import org.bson.conversions.Bson

/** Filters extension methods to improve Kotlin interop */
public object Filters {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that driver-core defines the same overloads for String property name
so if a user combines both filters they need to FQN the second one.

       val bsonExt = eq(Person::name, person.name)
       val bson = com.mongodb.client.model.Filters.eq(Person::name.name, person.name)

Extension functions can reside as top methods on a Kotlin file, the suggested approach below might offer IDE help when importing (although you still need 2 static imports for both)

  • FiltersExt.kt
package com.mongodb.client.model.ext

import com.mongodb.client.model.Filters
import com.mongodb.kotlin.client.model.path
import org.bson.conversions.Bson
import kotlin.internal.OnlyInputTypes
import kotlin.reflect.KProperty

@JvmName("eqExt")
public infix fun <@OnlyInputTypes T> KProperty<T?>.eq(value: T?): Bson = Filters.eq(path(), value)
public fun <@OnlyInputTypes T> eq(property: KProperty<T?>, value: T?): Bson = property.eq(value)

and in the

  • FiltersTes.kt
import com.mongodb.client.model.Filters.eq
import com.mongodb.client.model.ext.eq

  val bson = eq(Person::name, person.name)
  val bson2 = eq(Person::name.name, person.name)
  assertEquals(expected, bson.document)

  val kmongoDsl = Person::name eq person.name

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the namespaces are different they can import both methods:

import com.mongodb.client.model.Filters.eq
import com.mongodb.kotlin.client.model.Filters.eq

...

    @Test
    fun testEqSupport() {
        val expected = BsonDocument.parse("""{"name": "Ada"}""")
        val bson = eq(Person::name, person.name)
        assertEquals(expected, bson.document)

        val bson2 = eq(Person::name.name, person.name)
        assertEquals(expected, bson2.document)

        val kmongoDsl = Person::name eq person.name
        assertEquals(expected, kmongoDsl.document)
    }

@rozza rozza requested a review from nhachicha September 20, 2024 13:14
@rozza
Copy link
Member Author

rozza commented Sep 20, 2024

@nhachicha thanks for the review - I think I've responded to everything or have asked follow questions.

Copy link
Contributor

@nhachicha nhachicha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice one 🎉
Should this still target master or a feature branch?

@rozza rozza changed the base branch from master to kotlin-extensions September 23, 2024 09:26
@rozza rozza merged commit a82e79e into mongodb:kotlin-extensions Sep 23, 2024
54 of 59 checks passed
@rozza rozza deleted the JAVA-5308 branch September 23, 2024 09:58
nhachicha pushed a commit that referenced this pull request Dec 2, 2024
Adds a new package `org.mongodb.mongodb-driver-kotlin-extensions`. Its both, kotlin driver and bson kotlin implementation agnostic. Can be used with any combination of `bson-kotlin`, `bson-kotlinx`, `mongodb-driver-kotlin-sync` and `mongodb-driver-kotlin-coroutine`.

Initial Filters extensions support, with both inflix and nested helpers eg:

```
import com.mongodb.kotlin.client.model.Filters.eq

// infix
Person::name.eq(person.name)

// nested
val bson = eq(Person::name, person.name)
```

Also adds path based support which works with vairous annotations on the data class: `@SerialName("_id")`, `@BsonId`, `@BsonProperty("_id")`:

```
(Restaurant::reviews / Review::score).path() == "reviews.rating"
```

JAVA-5308 JAVA-5484
nhachicha added a commit that referenced this pull request Dec 2, 2024
* Helper methods and extensions to improve kotlin interop. (#1478)

Adds a new package `org.mongodb.mongodb-driver-kotlin-extensions`. Its both, kotlin driver and bson kotlin implementation agnostic. Can be used with any combination of `bson-kotlin`, `bson-kotlinx`, `mongodb-driver-kotlin-sync` and `mongodb-driver-kotlin-coroutine`.

Initial Filters extensions support, with both inflix and nested helpers eg:

```
import com.mongodb.kotlin.client.model.Filters.eq

// infix
Person::name.eq(person.name)

// nested
val bson = eq(Person::name, person.name)
```

Also adds path based support which works with vairous annotations on the data class: `@SerialName("_id")`, `@BsonId`, `@BsonProperty("_id")`:

```
(Restaurant::reviews / Review::score).path() == "reviews.rating"
```

JAVA-5308 JAVA-5484

* Gradle: Support custom header annotation

* Added since annotation to Filters.kt

JAVA-5308

* Adding Kotlin extensions methods for projection. (#1515)

* Adding Kotlin extensions methods for projection. Fixes JAVA-5603

---------

Co-authored-by: Ross Lawley <[email protected]>

* Adding Kotlin extensions methods for updates   (#1529)

* Adding Kotlin extension function for Updates operations
JAVA-5601

* Grouping static checks under the same task (#1526)

* Grouping all static checks under the "check" task

JAVA-5633

* Add extension methods for Indexes (#1532)

JAVA-5604

* Adding extension methods for Sorts (#1533)

JAVA-5602

* Adding extensions for Aggregators and Accumulators (#1562)

* Adding extensions for Aggregators and Accumulators

---------

Co-authored-by: Ross Lawley <[email protected]>
Co-authored-by: Ross Lawley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants