Migration from 6.4.1 to 7.1.0 - removed classes/functions

[pawelryznar]

Hi. I'm trying to migrate from 6.4.1 to 7.1.0. In my project I'm using:

    implementation("com.github.vladimir-bukhtoyarov:bucket4j-core:7.1.0")
    implementation("com.github.vladimir-bukhtoyarov:bucket4j-jcache:7.1.0")

I don't see how could I migrate that code, as it's deprecated (Bucket4j) or deleted (GridBucketState, JCache):

import io.github.bucket4j.Bucket4j
import io.github.bucket4j.grid.GridBucketState
import io.github.bucket4j.grid.jcache.JCache

    private val cache: Cache<String, GridBucketState> = cacheManager.getCache(rateLimitProperties.cacheName)
    private val buckets = Bucket4j.extension(JCache::class.java).proxyManagerForCache(cache)
.
.
.
val bucket = buckets.getProxy(principal.name, configuration)
val probe = bucket.tryConsumeAndReturnRemaining(1)

and in ehcache.xml config:

    <cache alias="rate-limit-buckets">
        <key-type>java.lang.String</key-type>
        <value-type>io.github.bucket4j.grid.GridBucketState</value-type>
        <expiry>
            <ttl>3600</ttl>
        </expiry>
        <heap>1000000</heap>
        <jsr107:mbeans enable-statistics="true"/>
    </cache>

[vladimir-bukhtoyarov]

@pawelryznar hello,

See this as an example of migration. And do not forget to read the documentation https://bucket4j.com/7.1.0/toc.html#bucket4j-jcache

[pawelryznar]

Yes of course. I read it, but would be great if in the documentation would have some short upgrade guide, especially that version 7 introduces quite a lot of breaking changes.
It's hard to just look at some PR, and say why GridBucketState was used before, and now it's removed and why I should use byte[] instead.

[vladimir-bukhtoyarov]

Storing buckets as a flat array of bytes helps to be compatible with peer class loading. Modern JCache implementations allow to cross-node downloading of byte code of EntryProcessors, see for example the documentation https://ignite.apache.org/docs/latest/code-deployment/peer-class-loading

But no one implementation provides cross-node classloading for cache values, for example by the hyperlink above you can see following note:

So storing state as bytes solves the limitations.

I read it, but would be great if in the documentation would have some short upgrade guide, especially that version 7 introduces quite a lot of breaking changes.

Exactly, I want the same. But it is a non-profitable project that is supported in my free time, so it can not be ideal.

[pawelryznar]

I changed my code to the following:

import io.github.bucket4j.grid.jcache.JCacheProxyManager

    private val cache: Cache<String, ByteArray> = cacheManager.getCache(rateLimitProperties.cacheName)
    private val buckets = JCacheProxyManager(cache)
.
.
.
val bucket = buckets.builder().build(principal.name, configuration)
val probe = bucket.tryConsumeAndReturnRemaining(1)

and removed key-type and value-type from ehcache.xml:

    <cache alias="rate-limit-buckets">
        <expiry>
            <ttl>3600</ttl>
        </expiry>
        <heap>1000000</heap>
        <jsr107:mbeans enable-statistics="true"/>
    </cache>

It's working now, so I hope it's correct.

[vladimir-bukhtoyarov]

Yes. It is right way.