influxdata / influxdb-java

Java client for InfluxDB
MIT License
1.19k stars 478 forks source link

Support java records as measurement classes #983

Open eranl opened 11 months ago

eranl commented 11 months ago

Saving using a record is supported by existing code. This change adds support for loading into a record, using its canonical constructor. Both standard (JDK14+) and Android desugared (SDK34+) records are supported.

Access to record metadata is done through reflection, so this code compiles on JDK8. In order to support Android, and in order to keep the reflection logic simple, no record component reflection classes and methods are used. The price is a minor limitation: records can't have a custom constructor that has the same set of parameter names and types as the canonical one.

In order to add tests with records, I added a test-jdk17 directory and a java17 maven profile. I hope I did that correctly. Is there any other required setup for this?

The two new record test classes are identical except that one uses real records (and some new java features), and the other simulates Android desugared ones. They are both based on InfluxDBResultMapperTest, with the addition of a few record-specific tests.

There is some inconsistency between saving and loading that I am conflicted about:

On the one hand, it would be nice to always save all record fields, for consistency. On the other hand, there is value in leaving the flexibility on save, for use cases that don't care about this consistency, e.g. write-only ones. Always saving all record fields would also be a breaking change for any (unlikely) existing code using records for saving.

And this is on top of an existing inconsistency between saving and loading, which applies to both classes and records, but is more noticeable with records:

For this one, I could:

  1. prevent the exceptions by initializing such primitive fields to their zero value, or
  2. silently ignore the exceptions, or
  3. catch and give a more informative exception, or
  4. leave as is

Fixes #964

codecov-commenter commented 11 months ago

Codecov Report

Attention: 10 lines in your changes are missing coverage. Please review.

Comparison is base (9209837) 61.05% compared to head (b6979ee) 61.75%.

:exclamation: Current head b6979ee differs from pull request most recent head d11ed0b. Consider uploading reports for the commit d11ed0b to get more accurate results

Files Patch % Lines
...n/java/org/influxdb/impl/InfluxDBResultMapper.java 88.23% 7 Missing and 3 partials :warning:

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #983 +/- ## ============================================ + Coverage 61.05% 61.75% +0.69% - Complexity 437 453 +16 ============================================ Files 71 71 Lines 2583 2638 +55 Branches 278 288 +10 ============================================ + Hits 1577 1629 +52 - Misses 933 936 +3 Partials 73 73 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

majst01 commented 11 months ago

Hi @eranl

This is a nice improvement, but honestly i am not able to review this in the required depth because i am since long time no full time java developer anymore.

I am searching for a additional maintainer, so if you are interested let me know

eranl commented 11 months ago

Hi @eranl

This is a nice improvement, but honestly i am not able to review this in the required depth because i am since long time no full time java developer anymore.

I am searching for a additional maintainer, so if you are interested let me know

Hi @majst01,

Sure, happy to help. I would need some guidance though, since I've never done it.

eranl commented 9 months ago

Hi @majst01,

Any update?

eranl commented 2 months ago

Hi @majst01,

I would appreciate an update. Thanks.

majst01 commented 2 months ago

This project is basically in a archived state because i have no time an no personal usage of it anymore. Also there is another library from the influxdb authors themselve which also supports more features and database versions than this.

If you would like to take over maintainership, i would appreciate it.

eranl commented 2 months ago

Sure. Where do I start?

majst01 commented 2 months ago

Sure. Where do I start?

I am going to vacation now for two weeks, if you dont mind please ping me 1st week in october and we setup a short intro.

eranl commented 1 month ago

ping