Migration from 6.4.1 to 7.1.0 - removed classes/functions #223

pawelryznar · 2022-01-31T08:08:26Z

pawelryznar
Jan 31, 2022

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>

Answered by pawelryznar

Jan 31, 2022

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.

View full answer

vladimir-bukhtoyarov · 2022-01-31T10:34:29Z

vladimir-bukhtoyarov
Jan 31, 2022
Maintainer

@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

2 replies

pawelryznar Jan 31, 2022
Author

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 Jan 31, 2022
Maintainer

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 · 2022-01-31T13:12:03Z

pawelryznar
Jan 31, 2022
Author

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.

1 reply

vladimir-bukhtoyarov Jan 31, 2022
Maintainer

Yes. It is right way.

gustavofariaas · 2024-07-01T22:40:23Z

gustavofariaas
Jul 1, 2024

Hey @vladimir-bukhtoyarov , I've recently refactoring some code from java 11 to java 17, and I'm working with Ignite and bucket4J.

This is how my configuration is implemented:

`@Bean
public ProxyManager getProxyManager(IgniteCache<String, byte[]> cache) {
return new IgniteProxyManager<>(cache);
}

@Bean
public IgniteCache<String, byte[]> getCache() {
    IgniteConfiguration cfg = new IgniteConfiguration();

    cfg.setMetricsLogFrequency(0);
    cfg.setPeerClassLoadingEnabled(true);
    cfg.setDeploymentMode(DeploymentMode.SHARED);
    cfg.setClientMode(true);
    cfg.setPeerClassLoadingEnabled(true);

    TcpDiscoverySpi discoverySpi = new TcpDiscoverySpi();

    TcpDiscoveryVmIpFinder ipFinder = new TcpDiscoveryVmIpFinder();

    ipFinder.setAddresses(Collections.singletonList("127.0.0.1:7373"));

    discoverySpi.setIpFinder(ipFinder);
    cfg.setDiscoverySpi(discoverySpi);
    org.apache.ignite.Ignite ignite = Ignition.start(cfg);
    ignite.cluster().state(ClusterState.ACTIVE);
    IgniteCache<String, byte[]> cache = ignite.getOrCreateCache("buckets");
    return cache;
}`

The issue I'm getting is when I call the function getProxyConfiguration which is returning to me an expecption:
javax.cache.processor.EntryProcessorException: class org.apache.ignite.binary.BinaryInvalidTypeException: io.github.bucket4j.grid.GridBucketState

Function: Optional buckConfig = proxyManager.getProxyConfiguration(bucketKey);

Even when GridBucketState is no longer available on the lib 8.0.1, I'm still getting this error, do you have some thoughts on this?

0 replies

vladimir-bukhtoyarov · 2024-07-02T12:27:58Z

vladimir-bukhtoyarov
Jul 2, 2024
Maintainer

Hello @gustavofariaas

I have two ideas according to BinaryInvalidTypeException:

You have not updated classpath on all nodes. Bucket4j jars should be present on every node in cluster.
If classpath on every node updatedm but you still getting this error, then most likely it is not possible to deserialize previously persisted state of bucket, that was serialized in incompatible form. In such case I would recommend to clear the cache, or use another cache.

1 reply

gustavofariaas Jul 2, 2024

thanks @vladimir-bukhtoyarov , I could resolve this issue by changing the cache to a new one, as the old was used by java 11 and GridBucketState, now it is working as expected.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migration from 6.4.1 to 7.1.0 - removed classes/functions #223

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 4 comments 4 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

Select a reply

Migration from 6.4.1 to 7.1.0 - removed classes/functions #223

pawelryznar Jan 31, 2022

Replies: 4 comments · 4 replies

vladimir-bukhtoyarov Jan 31, 2022 Maintainer

pawelryznar Jan 31, 2022 Author

vladimir-bukhtoyarov Jan 31, 2022 Maintainer

pawelryznar Jan 31, 2022 Author

vladimir-bukhtoyarov Jan 31, 2022 Maintainer

gustavofariaas Jul 1, 2024

vladimir-bukhtoyarov Jul 2, 2024 Maintainer

gustavofariaas Jul 2, 2024

pawelryznar
Jan 31, 2022

Replies: 4 comments 4 replies

vladimir-bukhtoyarov
Jan 31, 2022
Maintainer

pawelryznar Jan 31, 2022
Author

vladimir-bukhtoyarov Jan 31, 2022
Maintainer

pawelryznar
Jan 31, 2022
Author

vladimir-bukhtoyarov Jan 31, 2022
Maintainer

gustavofariaas
Jul 1, 2024

vladimir-bukhtoyarov
Jul 2, 2024
Maintainer