influxdb-java icon indicating copy to clipboard operation
influxdb-java copied to clipboard

Support java records as measurement classes

Open eranl opened this issue 1 year ago • 8 comments

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 save, existing logic, which lets you choose which fields to include, applies
  • On load, all fields are always loaded into, since the canonical constructor is used

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:

  • On save, all included fields are always saved
  • On load, only fields that are contained in the query result are actually loaded. All other class fields are silently ignored, while other record fields are initialized to null, which results in an exception for primitive fields.

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

eranl avatar Dec 16 '23 03:12 eranl

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
@@             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.

codecov-commenter avatar Dec 16 '23 03:12 codecov-commenter

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

majst01 avatar Dec 21 '23 11:12 majst01

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 avatar Dec 21 '23 15:12 eranl

Hi @majst01,

Any update?

eranl avatar Feb 16 '24 16:02 eranl

Hi @majst01,

I would appreciate an update. Thanks.

eranl avatar Sep 14 '24 02:09 eranl

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.

majst01 avatar Sep 14 '24 07:09 majst01

Sure. Where do I start?

eranl avatar Sep 14 '24 12:09 eranl

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.

majst01 avatar Sep 14 '24 14:09 majst01

ping

eranl avatar Oct 03 '24 13:10 eranl