INTERNAL: Upgrade ehcache version

[cheesecrust]

🔗 Related Issue

• https://github.com/jam2in/arcus-works/issues/600

⌨️ What I did

• ehcache version 3 로 업그레이드

  • cacheManger 변경 ehcache2 에서는 cacheManger 를 싱글톤으로 관리하며 전체 어플리케이션에서 하나의 cacheManger 만을 사용합니다. 하지만, ehcache3 의 경우에는 여러 cacheManger 를 둘 수 있습니다. 따라서 이번 버전업 에서는 코드 자체에 싱글톤 패턴을 적용시켜 기존과 동일하게 cacheManger 를 어플리케이션에서 하나만 가지도록 하였습니다.

  • Element 객체의 삭제 ehcahce2 의 Element 객체가 ehcache3 에서는 삭제되었습니다. 삭제된 후에 Cache 에 직접 저장하는 형태로 바뀌어 이를 수정하였습니다.

  • CacheConfiguration 변경 기존 설정이 사라지거나 기본 디폴트 설정으로 변경되었습니다. .copyOnRead(copyOnRead), .copyOnWrite(copyOnWrite) : 이 설정은 사라지고 원래 false 로 설정을 하였는데 이것이 기본동작이 되었습니다. diskExpiryThreadIntervalSeconds : 해당 설정은 사라졌습니다. LRU policy : 해당 설정은 디폴트 값입니다. 이 외 설정은 인터페이스가 바뀌어 그에 따라 수정하였습니다.

• 기존의 ehcahe2 에서는 cacheManger가 하나로 이를 싱글톤으로 관리하였는데 이를 생성자 마다 하나씩 가지도록 변경했습니다.

• TTL 만을 설정하도록 변경했습니다.

[uhm0311]

커밋 메세지 수정해주세요.

Upgrade to ehcache version => Upgrade ehcache version

[oliviarla]

@cheesecrust ehcache2 -> ehcache3 업그레이드하면서 제거된 기능과 추가된 기능을 정리해 what i did 부분을 개선해주세요.

@uhm0311 왜 커밋 타입이 TEST인가요? 전반적으로 의존성과 인터페이스 자체가 변경되었기 때문에 기존과 같이 INTERNAL로 두어야할 것 같은데요.

[cheesecrust]

@cheesecrust ehcache2 -> ehcache3 업그레이드하면서 제거된 기능과 추가된 기능을 정리해 what i did 부분을 개선해주세요.

추가하였습니다.

603 관련 코드도 추가하였습니다.

[uhm0311]

@cheesecrust

커밋 메세지는 다시 INTERNAL로 변경해주세요.

[jhpark816]

@cheesecrust

ehcache3 의 구현에서는 만료시간을 재는 변수를 ttl 과 tti 설정이 공유합니다. 따라서 뒤에 설정하는 설정으로 덮어씌워지고 ehcache2 의 경우에는 두개중 하나의 조건만 성립하면 만료시킵니다.

위의 내용이 모호합니다.

TTL, TTI 설정에 관한 ehcache2 vs. ehcache3 차이점을 알고 싶은 데요.

• ehcache manual에 기술된 내용을 바탕으로 차이점이 있나요?
• 테스트로 확인한 차이점은 무엇인가요?
• 그 외의 방법으로 확인한 차이점이 있나요?

[cheesecrust]

@jhpark816

TTL, TTI 설정에 관한 ehcache2 vs. ehcache3 차이점을 알고 싶은 데요.

• ehcache manual에 기술된 내용을 바탕으로 차이점이 있나요?
• 테스트로 확인한 차이점은 무엇인가요?
• 그 외의 방법으로 확인한 차이점이 있나요?

테스트로 확인한 차이점을 기술하겠습니다.

      CacheConfiguration config =
              new CacheConfiguration(name, max)
                      .copyOnRead(copyOnRead)
                      .copyOnWrite(copyOnWrite)
                      .memoryStoreEvictionPolicy(MemoryStoreEvictionPolicy.LRU)
                      .eternal(false)
                      .timeToLiveSeconds(exptime)
                      .timeToIdleSeconds(exptime)
                      .diskExpiryThreadIntervalSeconds(60)
                      .persistence(new PersistenceConfiguration().strategy(
                          PersistenceConfiguration.Strategy.NONE));

  protected void setUp() throws Exception {
    super.setUp();
    ConnectionFactoryBuilder cfb = new ConnectionFactoryBuilder();
    cfb.setFrontCacheExpireTime(5);
    ...
  }
  public void testGet() throws Exception {
    for (String k : keys) {
      client.set(k, 2, k + "_value").get();
    }

    String key = keys.get(0);

    Future<Object> f = client.asyncGet(key);
    Object result = f.get();

    Object cached = client.getLocalCacheManager().get(key);

    assertNotNull(result);
    assertNotNull(cached);
    assertSame("not the same result", result, cached);

    // after 3 seconds : remote expired, locally cached
    Thread.sleep(3000);

    f = client.asyncGet(key);
    result = f.get();

    cached = client.getLocalCacheManager().get(key);

    assertNotNull(result);
    assertNotNull(cached);
    assertEquals("not the same result", result, cached);

    // after another 3 seconds : both remote and local expired
    Thread.sleep(3000);

    f = client.asyncGet(key);
    result = f.get();

    cached = client.getLocalCacheManager().get(key);

    assertNull(result);
    assertNull(cached);
  }

위는 현재 develop 브랜치의 LocalCahceManager 설정과 테스트 코드 입니다. 테스트 코드는 아이템을 생성하고 3초 후에 요청하면 반환을 성공하고 3초를 더 기다린 후에 요청하면 실패하는 테스트 코드 입니다. 따라서 위 처럼 설정을 하면 TTL 만이 적용되는것을 알 수 있습니다. TTI 를 적용한다면 최초 3 초를 기다린 후에 요청 하였을때 만료시간이 초기화 되어 마지막 assertNull 에서 실패해야 하기 때문입니다. 이는 두 설정의 순서를 바꿔도 같습니다. (코드 상에서 ttl 다음에 tti 를 하거나 tti 후에 ttl 을 설정)

이에 따라 설정에서 .timeToLiveSeconds(exptime) 를 제거한다면 해당 테스트 코드는 실패 합니다. 마지막 assertNull(result); 에서 실패합니다. TTI 만이 설정 되었기 때문입니다.

반면 ehcache3 로 넘어올때 아래 처럼 문법만 바꾸게 되면 TTI 만이 설정되었을 때와 같은 곳에서 실패 합니다.

                    .withExpiry(ExpiryPolicyBuilder
                            .timeToLiveExpiration(Duration.of(exptime, ChronoUnit.SECONDS)))
                    .withExpiry(ExpiryPolicyBuilder
                            .timeToIdleExpiration(Duration.of(exptime, ChronoUnit.SECONDS)));

하지만 위 코드에서 두 설정의 순서를 바꾸면 테스트 코드를 수정하지 않아도 성공합니다. (TTL, TTI -> TTI, TTL) 그 이유는 ehcache3 에서는 만료 시간을 측정할때 create, access, update 라는 내부 인자를 활용하는데 TTL 과 TTI 모두 같은 곳을 수정하기 때문에 나중에 설정한 정책이 적용됩니다.

따라서 ehcahe2 에서는 TTL 과 TTI 를 모두 적용하게 되면 순서에 상관없이 항상 TTL 이 적용되고 ehcache3 에서는 TTL 과 TTI 를 적용할때 마지막에 적용한 정책이 적용됩니다.

[jhpark816]

아래 형태로 설정이 가능하나요?

                    .withExpiry(ExpiryPolicyBuilder
                            .timeToLiveExpiration(Duration.of(exptime, ChronoUnit.SECONDS))
                            .timeToIdleExpiration(Duration.of(exptime, ChronoUnit.SECONDS)));

[jhpark816]

@cheesecrust 그리고, ehcache2와 ehcache3의 manual 설명을 확인하고 알려주세요.

[cheesecrust]

@jhpark816

아래 형태로 설정이 가능하나요?

                    .withExpiry(ExpiryPolicyBuilder
                            .timeToLiveExpiration(Duration.of(exptime, ChronoUnit.SECONDS))
                            .timeToIdleExpiration(Duration.of(exptime, ChronoUnit.SECONDS)));

위의 형태로는 설정 불가합니다. 두개의 설정을 남기고 TTL 만 설정하기 위해서는 아래와 같이 해야합니다.

                    .withExpiry(ExpiryPolicyBuilder
                            .timeToIdleExpiration(Duration.of(exptime, ChronoUnit.SECONDS)))
                    .withExpiry(ExpiryPolicyBuilder
                            .timeToLiveExpiration(Duration.of(exptime, ChronoUnit.SECONDS)));

ehcache2 manual 에서는

         <cache name="myCache"
      maxEntriesLocalDisk="10000" eternal="false" timeToIdleSeconds="3600"
      timeToLiveSeconds="0" memoryStoreEvictionPolicy="LFU">
</cache>

위와 같이 ttl 과 tti 를 동시에 설정할 경우 둘 중의 하나의 만료조건이 충족되면 만료된다고 안내하고 있습니다.

ehcache3 doc 에서는 위와 같은 예시를 제시하지 않는데, tti 는 ehcache3 부터 비공식적으로 더 이상 지원하지 않는 개념이라고 합니다. https://github.com/ehcache/ehcache3/issues/1097

TTL 설정은 다음과 같이 안내하고 있습니다.

CacheConfiguration<Long, String> cacheConfiguration = CacheConfigurationBuilder.newCacheConfigurationBuilder(Long.class, String.class,
        ResourcePoolsBuilder.heap(100)) 
    .withExpiry(ExpiryPolicyBuilder.timeToLiveExpiration(Duration.ofSeconds(20))) 
    .build();

TTI 설정을 아예 제거하도록 할까요?

[jhpark816]

@cheesecrust @oliviarla @brido4125 @uhm0311

• TTI 설정을 제거합시다.
• 다음의 궁금한 부분이 있습니다.
  • withExpiry() 메소드로 Expiry 값을 설정하는 것이며, 2번 나오면 뒤에 설정한 값이 덮어쓰기 하는 것 같습니다.
  • withExpiry() 메소드로 TTL or TTI 중의 하나를 설정하는 것으로 보입니다.
  • withExpiry() 메소드로 TTL과 TTI 모두를 설정하는 방법이 있을까요? withExpiry() 메소드와 해당 클래스 코드를 보면 확인 가능한지 궁금합니다.

                    .withExpiry(ExpiryPolicyBuilder
                            .timeToIdleExpiration(Duration.of(exptime, ChronoUnit.SECONDS)))
                    .withExpiry(ExpiryPolicyBuilder
                            .timeToLiveExpiration(Duration.of(exptime, ChronoUnit.SECONDS)));

[cheesecrust]

@jhpark816 .withExpiry() 메서드의 경우 ExpiryPolicy() 를 지정합니다. 그리고 해당 ExpiryPolicy() 를 .timeToLiveExpiration(), .timeToIdleExpiration() 에서 반환합니다. 따라서 .withExpiry() 를 할때 마다 새로운 정책을 지정하는것과 같습니다. 따라서 TTL 과 TTI 모두를 설정하는 방법은 없는것으로 보입니다.

[jhpark816]

ExpiryPolicyBuilder 코드를 보면, TTL과 TTI를 모두 설정할 방법은 있는 것 같습니다. 참고 바랍니다. https://github.com/tarantool/tarantool-jcache/blob/master/src/main/java/org/tarantool/jsr107/ExpiryPolicyBuilder.java

ARCUS에서는 TTL만 설정하면 될 것 같습니다.