Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change CacheState.register to a fluent API #1920

Merged
merged 2 commits into from Mar 27, 2024
Merged

Conversation

pkoenig10
Copy link
Member

@pkoenig10 pkoenig10 commented Mar 27, 2024

Follow up from #1919

This is a slightly less obvious but more ergonomic API for consumers.

@pkoenig10 pkoenig10 changed the title Fix metrics docs Change CacheState.register to a fluent API Mar 27, 2024
@changelog-app
Copy link

changelog-app bot commented Mar 27, 2024

Generate changelog in changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

CacheState.register has been changed to be a more fluent API.

Check the box to generate changelog(s)

  • Generate changelog entry

*/
public <K, V, C extends Cache<K, V>> C register(C cache) {
public <K, V, C extends Cache<K, V>> C register(Function<CacheStats, C> cacheFactory) {
Copy link
Contributor

Choose a reason for hiding this comment

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

nice

@bulldozer-bot bulldozer-bot bot merged commit d781dee into develop Mar 27, 2024
5 checks passed
@bulldozer-bot bulldozer-bot bot deleted the pkoenig/metrics branch March 27, 2024 15:31
@svc-autorelease
Copy link
Collaborator

Released 0.85.0

@pkoenig10
Copy link
Member Author

One nice thing about this API is that it makes it difficult to forget to call recordStats, since the provided CacheStats variable will be unused otherwise.

@carterkozak
Copy link
Contributor

Before this rolls out broadly, could we add a check to throw if stats aren't being recorded (which implies the cacheStats value hasn't been provided to the builder)?

@pkoenig10
Copy link
Member Author

#1922

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants