Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add a max size for normalize cache#2878

Merged
guizmaii merged 2 commits intozio:masterfrom
wb14123:cache-fix
Sep 29, 2023
Merged

Add a max size for normalize cache#2878
guizmaii merged 2 commits intozio:masterfrom
wb14123:cache-fix

Conversation

@wb14123
Copy link
Contributor

@wb14123 wb14123 commented Sep 27, 2023 •
edited
Loading

Fixes #2484

Problem

There is no bound for normalize cache which results memory usage increase without limit for dynamic queries.

Solution

Added a capacity to normalize cache. Default to 1024 and can be override by quill.query.cacheDynamicMaxSize.

Notes

Added a new dependency Google Guava to use its cache implementation. I know it's better to avoid new dependency but Google Guava is a pretty widely adopted library. It's cache implementation is widely tested. For such a critical use case in quill, I think it's better to have a widely tested implementation than reinventing the wheel.

Checklist

  • Unit test all changes
  • Update README.md if applicable
  • Add [WIP] to the pull request title if it's work in progress
  • Squash commits that aren't meaningful changes
  • Run sbt scalariformFormat test:scalariformFormat to make sure that the source files are formatted

@getquill/maintainers

Note:

sbt scalariformFormat test:scalariformFormat give me error:

[error] Not a valid command: scalariformFormat                                                                                                                                       
[error] Not a valid project ID: scalariformFormat                                         
[error] Expected ':'                                                                                                                                                                 
[error] Not a valid key: scalariformFormat (similar: scalaArtifacts, scalafmt, scalafmtDoFormatOnCompile)                                                                            
[error] scalariformFormat                                                                                                                                                            
[error]

@CLAassistant
Copy link

CLAassistant commented Sep 27, 2023 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@wb14123 wb14123 force-pushed the cache-fix branch 3 times, most recently from f8da003 to 19412f0 Compare September 27, 2023 21:39
@wb14123
Copy link
Contributor Author

wb14123 commented Sep 27, 2023 •
edited
Loading

Pushed a new commit to make the default cache size 1024. However from my profiling, each AST seems to have pretty different sizes. I'm wondering if there is a way to get memory footprint from an AST efficiently so that we can use CacheBuilder.weigher(Weigher) to make the cache size smarter

@wb14123
Copy link
Contributor Author

wb14123 commented Sep 28, 2023

The GC looks much normal after this fix as well:

image

guizmaii
guizmaii reviewed Sep 28, 2023
View reviewed changes
guizmaii
guizmaii requested changes Sep 29, 2023
View reviewed changes
Copy link
Member

@guizmaii guizmaii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use Caffeine (See Guava doc https://guava.dev/releases/31.0-jre/api/docs/com/google/common/cache/CacheBuilder.html#:~:text=Caffeine's%20types%20are%20better%20than,backed%20by%20a%20Guava%20CacheLoader%20.)

@guizmaii guizmaii mentioned this pull request Sep 29, 2023
Closed
5 tasks
@wb14123 wb14123 force-pushed the cache-fix branch 2 times, most recently from 03a8850 to 2b81fc5 Compare September 29, 2023 12:12
@wb14123 wb14123 requested a review from guizmaii September 29, 2023 12:12
@wb14123
Copy link
Contributor Author

wb14123 commented Sep 29, 2023

Oh seems f.asJava doesn't compile against Scala 2.12. Will push a fix. Sorry for rushing it ...

@guizmaii
Copy link
Member

guizmaii commented Sep 29, 2023

Oh seems f.asJava doesn't compile against Scala 2.12

We're sorry for you and we're sorry to have to maintain Scala 2.12 compat 😄
Thanks for your work 🙏

@guizmaii
Copy link
Member

guizmaii commented Sep 29, 2023 •
edited
Loading

Latest version of Caffeine doesn't support Java8 anymore apparently:

[error] java.lang.UnsupportedClassVersionError: com/github/benmanes/caffeine/cache/Caffeine has been compiled by a more recent version of the Java Runtime (class file version 55.0), this version of the Java Runtime only recognizes class file versions up to 52.0

The good news is that we're about to drop support of JDK8 too!

FYI: #2878

@wb14123
Add a max size for normalize cache
13ba5eb 
This fixes zio#2484. Added a capacity to normalize cache. Default to 1024
and can be override by `quill.query.cacheDynamicMaxSize`.

Added a new dependency Caffeine to use its cache implementation, which
is recommended by Guava. For a critical use case in quill, I think
it's better to have a widely tested implementation than reinventing the wheel.
@guizmaii guizmaii mentioned this pull request Sep 29, 2023
Merged
@wb14123
Copy link
Contributor Author

wb14123 commented Sep 29, 2023

@guizmaii oh I didn't realize you are working on dropping Java 8. I added a check for Java version so we can use it without breaking Java 8

@guizmaii
Copy link
Member

guizmaii commented Sep 29, 2023

oh I didn't realize you are working on dropping Java 8

The ZIO environment in its entirety decided to remove Java8 support (triggered by some needs in zio-quill)
Your work is just the motivation I needed to make this change 🙂

@guizmaii guizmaii merged commit 5402d84 into zio:master Sep 29, 2023
@guizmaii
Copy link
Member

guizmaii commented Sep 29, 2023

Thanks again for your work @wb14123! ❤️

@wb14123 wb14123 mentioned this pull request Oct 1, 2023
Closed
jilen pushed a commit that referenced this pull request Jun 11, 2024
@wb14123 @guizmaii
Add a max size for normalize cache (#2878)
d5833bd 
This fixes #2484. Added a capacity to normalize cache. Default to 1024
and can be override by `quill.query.cacheDynamicMaxSize`.

Added a new dependency Caffeine to use its cache implementation, which
is recommended by Guava. For a critical use case in quill, I think
it's better to have a widely tested implementation than reinventing the wheel.

Co-authored-by: Jules Ivanic <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@guizmaii guizmaii guizmaii approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

NormalizeCaching cache grows without bound

3 participants

@wb14123 @CLAassistant @guizmaii