fix: EXPOSED-382 ClassCastException when uuid().references() is used with EntityID column #2079
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…with EntityID column Using references() invoked on a UUIDColumnType that targets an EntityIDColumnType<UUID> causes a ClassCastException. This occurs because PreparedStatementApi.fillParameters() tries to get the valueToDB() from EntityIDColumnType rather than the underlying UUIDColumnType and it is not possible to cast the refValue UUID to EntityID<UUID>. This exception does not happen with Int- or LongColumnType because their EntityID variants are wrapped as AutoIncColumnTypes that delegate to the correct underlying type. And this also doesn't happen if reference() is used because it creates an EntityIDColumnType under-the-hood which avoids type mismatch. This was most likely always happening but only causes an issue now that a stricter column type-safety has been introduced, which does not tolerate well a foreign key constraint between columns of different types.
bog-walk
commented
May 11, 2024
Comment on lines
+128
to
+133
| val castReferee = reference.referee<REF>()!! | ||
| val baseReferee = (castReferee.columnType as? EntityIDColumnType<REF>)?.idColumn ?: castReferee | ||
| factory.findWithCacheCondition({ | ||
| reference.referee!!.getValue(this, desc) == refValue | ||
| }) { | ||
| reference.referee<REF>()!! eq refValue | ||
| baseReferee eq refValue |
There was a problem hiding this comment.
This forces the query clause to use the underlying/wrapped type of EntityIDColumnType when setting statement parameters.
The elvis op is necessary in case the cast fails, which covers cases when an entity may have a foreign key on a target refColumn that is not actually an entityID column.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since version 0.50.0, using
Column.references()invoked on aUUIDColumnTypethat targets anEntityIDColumnType<UUID>causes aClassCastException.This occurs because
PreparedStatementApi.fillParameters()tries to get thevalueToDB()fromEntityIDColumnTyperather than the underlyingUUIDColumnType.This exception does not happen with Int- or LongColumnType because their EntityID variants are wrapped as
AutoIncColumnTypethat delegates to the correct underlying type.And this also doesn't happen if
reference()is used instead because it creates anEntityIDColumnTypeunder-the-hood which avoids any type mismatch.This was likely quietly happening before but only causes an issue now that a stricter column type-safety has been introduced.
Note: I considered adding similar logic to
OptionalReference.getValue(), but there is no optional variant forColumn.references(), so this point should not be reached.