Functions support #1110

clementetb · 2022-11-04T14:38:09Z

App function support

Add support for authenticated users to invoke App Services Application functions via the SDK.

Due to the serialization engine does not support third-party libraries yet, there are some limitations in what types can be used as arguments and return types:

Primitives, Bson, lists, and maps are valid argument types.
Results can only be deserialized to primitives or Bson types.

These limitations would be lifted once the Kserializer decoder for third-party libraries becomes stable.

The current implementation of the Ejson decoder does a case-by-case decoding based on the deserializationStrategy used. This would allow us to avoid future breaking changes, as it uses the same function signatures that we would be using in the future.

Pending

Use latest kserializer version.
Add tests for RealmInstant new extension functions.
Use kbson stable version.
Update the Changelog with the Kbson library version.

Depends on

# Conflicts: # CHANGELOG.md

rorbech

Looks way nicer now 🎉 ... I am just not landed on whether it makes sense to have the public API with both T and the KType 🤔

Further, there is also missing some tests when arguments and return value cannot be encoded and decoded with the default BsonEncoder.

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/internal/RealmInstantImpl.kt

rorbech · 2023-01-05T19:39:04Z

packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/Functions.kt

+     *
+     * @throws FunctionExecutionException if the function failed in some way.
+     */
+    public suspend fun <T> call(


A bit annoying that we cannot somehow tie the T with resultType ... Since there is no way to get the KType from a class at runtime, then there is no use cases for this method besides being called from the inlined one. Should we rather internalize this method then 🤔

Also a bit funny to have the generic parameter throughout the BsonConverter.decodeFromBsonValue but maybe it is ok 🤔 ... But if we keep the T along with a KType that is not bound to be the same then we should definitely be very explicit about that it will throw a ClassCastException if they don't match.

Oh, I didn't think it thoughtfully. Yes, we might like to internalize the method. And yes, the T value doesn't make sense in the BsonEncoder.

I made it internal and accessible to the extension function via de @PublishedApi annotation.

packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/internal/BsonEncoder.kt

...androidAndroidTest/kotlin/io/realm/kotlin/test/mongodb/shared/serializer/BsonEncoderTests.kt

rorbech · 2023-01-05T20:02:49Z

...androidAndroidTest/kotlin/io/realm/kotlin/test/mongodb/shared/serializer/BsonEncoderTests.kt

+
+    @Test
+    fun decodeFromBsonElement_throwsWrongType() {
+        (wrongPrimitiveAsserters + wrongRealmValueAsserters).forEach {


Nothing serious, but since we don't really uses these variables elsewhere we could maybe just define them locally in the method. Also a bit hard to track because you need to look up the DecoderAsserter class to understand it. Why not just use a Triple and have all the logic here and then destruct them into named variables to that it was easier to follow. Anyway, nothing critical 🤷

The asserters data structure has 4 parameters and is being reused in several tests.

Yes, we could use a Triple because not all parameters are used in every test, but it would mean that we would have to define multiple similar datasets in several tests..

...est-sync/src/androidAndroidTest/kotlin/io/realm/kotlin/test/mongodb/shared/FunctionsTests.kt

packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/Functions.kt

…ternal/RealmInstantImpl.kt Co-authored-by: Claus Rørbech <claus.rorbech@mongodb.com>

…ngodb/internal/BsonEncoder.kt Co-authored-by: Claus Rørbech <claus.rorbech@mongodb.com>

…ngodb/Functions.kt Co-authored-by: Christian Melchior <christian@ilios.dk>

… ct/app-functions # Conflicts: # packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/internal/BsonEncoder.kt

packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/internal/BsonEncoder.kt

packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/ext/FunctionsExt.kt

…ngodb/internal/BsonEncoder.kt Co-authored-by: Christian Melchior <christian@ilios.dk>

# Conflicts: # CHANGELOG.md

rorbech

Awesome. Only some minor comments ... and then of course CI 😬 Seems to fail due to asserting on class names that are obfuscated. Either remove the actual class name in the expected methods or maybe add keep the specific classes for testing purposes, just as the other rules in https://github.com/realm/realm-kotlin/blob/main/packages/test-base/proguard-rules-test.pro

packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/internal/BsonEncoder.kt

...est-sync/src/androidAndroidTest/kotlin/io/realm/kotlin/test/mongodb/shared/FunctionsTests.kt

…ngodb/internal/BsonEncoder.kt Co-authored-by: Claus Rørbech <claus.rorbech@mongodb.com>

clementetb added 3 commits October 28, 2022 15:39

Initial api

01c59ab

Add some implementation details

ad24fe7

Implement interop methods

5381c5f

clementetb self-assigned this Nov 4, 2022

cla-bot bot added the cla: yes label Nov 4, 2022

Add changelog entry

ca6b9ba

cmelchior mentioned this pull request Nov 4, 2022

Add preliminary API support for Functions #1045

Closed

clementetb added 18 commits November 8, 2022 15:55

Merge branch 'master' into ct/app-functions

5ea47a7

Push bson encoder poc

f4249e6

Some more POC

62dc949

Clean up

9942a06

Add BsonEncoder

2bce738

Add serializers for realm types

6559985

Add number conversion

13f66bf

Implement function tests

f06f098

make serializer module public

28fb79c

move bson decoder into sync package

4b34f93

Fix tests on multiplatform

1dbc3cf

Clean up

dbf9182

Pick up kbson from snapshot releases

8e3eb82

Add documentation

fe0975b

Clean up

849da0e

Add copyright headers

04e7180

Improve wording

6e9add5

Merge branch 'master' into ct/app-functions

90aec80

# Conflicts: # CHANGELOG.md

clementetb marked this pull request as ready for review November 16, 2022 11:18

clementetb requested review from rorbech and cmelchior November 16, 2022 11:18

clementetb added 2 commits November 16, 2022 17:35

Rename Bson encoder

68ffaf4

Update tests

fdec5bd

clementetb added 5 commits January 4, 2023 12:31

Remove depenency on createType as it is not available on native

5a2ef11

Merge branch 'main' into ct/app-functions

b1284fe

# Conflicts: # CHANGELOG.md

Ignore functions tests

89bbb95

Ignore bson encoder tests

351c1b3

Remove kserializer dependency

c89457a

clementetb requested a review from rorbech January 5, 2023 11:36

rorbech suggested changes Jan 5, 2023

View reviewed changes

cmelchior reviewed Jan 5, 2023

View reviewed changes

packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/Functions.kt Outdated Show resolved Hide resolved

packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/Functions.kt Outdated Show resolved Hide resolved

clementetb and others added 7 commits January 9, 2023 10:14

Update packages/library-base/src/commonMain/kotlin/io/realm/kotlin/in…

3d9aff6

…ternal/RealmInstantImpl.kt Co-authored-by: Claus Rørbech <claus.rorbech@mongodb.com>

Update packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mo…

0126727

…ngodb/internal/BsonEncoder.kt Co-authored-by: Claus Rørbech <claus.rorbech@mongodb.com>

Update packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mo…

950dd00

…ngodb/Functions.kt Co-authored-by: Christian Melchior <christian@ilios.dk>

PR change requests

10cef71

Merge branch 'ct/app-functions' of github.com:realm/realm-kotlin into…

8ff28ac

… ct/app-functions # Conflicts: # packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/internal/BsonEncoder.kt

Remove ktype and add support for RealmAny

0f6d115

Fix nullability issue on macos

e3b9bdc

clementetb requested a review from rorbech January 11, 2023 14:37

Add invalid argument and return type tests to Functions

8e8306f

cmelchior approved these changes Jan 12, 2023

View reviewed changes

packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/internal/BsonEncoder.kt Outdated Show resolved Hide resolved

packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/ext/FunctionsExt.kt Show resolved Hide resolved

clementetb and others added 3 commits January 12, 2023 14:00

Update packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mo…

8bc3ee7

…ngodb/internal/BsonEncoder.kt Co-authored-by: Christian Melchior <christian@ilios.dk>

Add documentation about ServiceException

3488db4

Merge branch 'main' into ct/app-functions

cdd77a1

# Conflicts: # CHANGELOG.md

rorbech approved these changes Jan 13, 2023

View reviewed changes

clementetb and others added 3 commits January 16, 2023 11:42

Update packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mo…

7673dae

…ngodb/internal/BsonEncoder.kt Co-authored-by: Claus Rørbech <claus.rorbech@mongodb.com>

Pr final change requests

d3b421e

Change comment

12deb5b

clementetb merged commit d4ebb86 into main Jan 16, 2023

clementetb deleted the ct/app-functions branch January 16, 2023 13:48

rorbech restored the ct/app-functions branch January 18, 2023 12:31

rorbech deleted the ct/app-functions branch January 18, 2023 12:42

github-actions bot locked as resolved and limited conversation to collaborators Mar 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Functions support #1110

Functions support #1110

clementetb commented Nov 4, 2022 •

edited

Loading

rorbech left a comment

rorbech Jan 5, 2023

rorbech Jan 5, 2023

clementetb Jan 9, 2023

clementetb Jan 11, 2023

rorbech Jan 5, 2023

clementetb Jan 11, 2023

rorbech left a comment

Functions support #1110

Functions support #1110

Conversation

clementetb commented Nov 4, 2022 • edited Loading

App function support

Pending

Depends on

rorbech left a comment

Choose a reason for hiding this comment

rorbech Jan 5, 2023

Choose a reason for hiding this comment

rorbech Jan 5, 2023

Choose a reason for hiding this comment

clementetb Jan 9, 2023

Choose a reason for hiding this comment

clementetb Jan 11, 2023

Choose a reason for hiding this comment

rorbech Jan 5, 2023

Choose a reason for hiding this comment

clementetb Jan 11, 2023

Choose a reason for hiding this comment

rorbech left a comment

Choose a reason for hiding this comment

clementetb commented Nov 4, 2022 •

edited

Loading