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

Don't write locks if both the locks and props change #67

Merged
merged 17 commits into from
Nov 12, 2024

Conversation

FinlayRJW
Copy link
Contributor

@FinlayRJW FinlayRJW commented Nov 1, 2024

Before this PR

Issue #47 outlined how changing branch triggered a write lock if both props and locks where different

After this PR

We now track both props and locks changes and only trigger locks writes if the locks file has not changed within 350ms of the props file changing

This was slightly more complex than expected as the events that prepareChange are batched so you cannot guarantee that the change to props and locks will be in the same call to prepareChange so you must track state

==COMMIT_MSG==
Don't write locks if both the locks and props change
==COMMIT_MSG==

Possible downsides?

This could prevent intentional locks writing if the props and locks change within 350ms of one another

@changelog-app
Copy link

changelog-app bot commented Nov 1, 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

Don't write locks if both the locks and props change

Check the box to generate changelog(s)

  • Generate changelog entry

@CRogers
Copy link
Contributor

CRogers commented Nov 12, 2024

👍

@bulldozer-bot bulldozer-bot bot merged commit 3b8f38f into develop Nov 12, 2024
5 checks passed
@bulldozer-bot bulldozer-bot bot deleted the finlayw/dont_refresh_on_lock branch November 12, 2024 14:44
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.

3 participants