Kotlin 2.0 Compatibility: Unable to Instantiate Message

[Polar-Points]

Hi Stream team,

I'm currently upgrading my project to use Kotlin 2.0 with the K2 compiler, and I’ve encountered a compatibility issue with the Stream Chat Android SDK (v5.x).

Previously, I was constructing messages like this:

val message = Message(
    id = UUID.randomUUID().toString(),
    text = "Hello world!",
    user = getStreamUser(),
    parentId = someParentId
)
channelClient.sendMessage(message).enqueue { ... }

It seems like the model class has @InternalStreamChatApi annotation.on it.

But under Kotlin 2.0, this now fails to compile with the following error:

This is internal API for the Stream Chat libraries. Do not depend on this API in your own client code.
Because Kotlin 2.0 now enforces internal API annotations as access restrictions, I can no longer construct Message objects manually — yet methods like ChannelClient.sendMessage(message: Message) still require me to provide one.

What is a guidance on a work around for this? Tried upgrading to 6.4.0 but still getting this error.

We are currently using stream 5.5.0 and we are using the low level client not the compose one. (might be time for an update hahah)

[VelikovPetar]

Hi @Polar-Points ,

Thank you for the report!
The Message model (or the ChannelClient.sendMessage method) don't apply the InternalStreamChatApi annotation (We only have the Message.channelInfo marked, but as far as I can see, you are not using it). Is it possible to check if the error is coming from the usage of a different method, such as the getStreamUser()? Perhaps it is internally using some API which is marked as InternalStreamChatApi.
I would like to identify the exact piece of code which triggers the error, so that we could provide a suitable alternative!

Best regards,
Petar

[Polar-Points]

@VelikovPetar Thanks for getting back to me! This is what I am seeing. I have attached screenshots. Note that I have updated from 5.5.0 -> 5.17.23, which seems to be the last published version for version 5.

I do see that this is marked internal, not sure if this little line would have set off the k2 compiler

@property:InternalStreamChatApi
    var channelInfo: ChannelInfo? = null,

[VelikovPetar]

Hi @Polar-Points,

Thanks for the details - You are correct, I did some tests and the Message model is considered as InternalStreamChatApi because the channelInfo property and the ChannelInfo model are also marked with InternalStreamChatApi.
I am not sure if upgrading the SDK version to a newer one is a feasible option for you (since v6.0.0 the channelInfo is no longer internal), but if not, you should be able to use @OptIn(InternalStreamChatApi::class) on the enclosing class where you instantiate the Message object, which would suppress the error/warning. It is perfectly safe to instantiate the Message object - it is just not advised to read the channelInfo member. Because it is marked as internal, it can be a subject of change. Although even this shouldn't be a problem, because in the next oldest release (6.0.0) this property is public, so it can be considered as stable.

Let me know if this helps you!

Best regards,
Petar

[Polar-Points]

Sweet that worked! Yeah updating to 6.0 is kind of a big lift for now. I might try updating us to the super latest 5x release so we get the bug fixes and what not but that can come later. Appreciate the help!