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.

Sign up for GitHub

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

Jump to bottom

Refreshable values shouldn't be logged #511

Merged
merged 4 commits into from
Aug 22, 2023
Merged

Refreshable values shouldn't be logged #511

merged 4 commits into from
Aug 22, 2023

Conversation

carterkozak
Copy link
Contributor

Refreshable may be used with secrets, which are best not to log, even as unsafe.

==COMMIT_MSG==
Refreshable values shouldn't be logged
==COMMIT_MSG==

@carterkozak
Refreshable values shouldn't be logged
4b0d33b 
Refreshable may be used with secrets, which are best not to
log, even as unsafe.
@changelog-app
Copy link

changelog-app bot commented Aug 22, 2023 •
edited by carterkozak

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

Refreshable values shouldn't be logged

Check the box to generate changelog(s)

  • Generate changelog entry

carterkozak
carterkozak commented Aug 22, 2023
View reviewed changes
refreshable/src/main/java/com/palantir/refreshable/DefaultRefreshable.java
@@ -242,7 +243,7 @@ private void preSubscribeLogging() {
* Purely for GC purposes - this class holds a reference to its parent refreshable. Instances of this class are
* themselves tracked by the {@link RootSubscriberTracker}.
*/
private static class SideEffectSubscriber<T> implements Consumer<T> {
private static class SideEffectSubscriber<@DoNotLog T> implements Consumer<T> {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These annotations prevent us from regressing

mpritham
mpritham approved these changes Aug 22, 2023
View reviewed changes
Copy link

@mpritham mpritham left a comment

Choose a reason for hiding this comment

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

lgtm!

@bulldozer-bot bulldozer-bot bot merged commit 5c5999c into develop Aug 22, 2023
8 checks passed
@bulldozer-bot bulldozer-bot bot deleted the ckozak/avoid_logging_refreshable_values branch August 22, 2023 17:33
@svc-autorelease
Copy link
Collaborator

Released 2.3.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mpritham mpritham mpritham approved these changes

Assignees
No one assigned
Labels
autorelease merge when ready
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@carterkozak @svc-autorelease @mpritham @svc-changelog