-
Notifications
You must be signed in to change notification settings - Fork 29
feat(beholder): backward-compat type shims for durable event store [SHARED-2644] #2095
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
Open
dvashchuk
wants to merge
4
commits into
main
Choose a base branch
from
fix/beholder-backward-compat
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
8393879
feat(beholder): add backward-compat type shims for durable event store
dvashchuk 1bf4298
ci: trigger fresh run after PR body fix
dvashchuk 61c91ce
Merge branch 'main' into fix/beholder-backward-compat
dvashchuk 780ef90
chore: exclude beholder compat shim from SonarQube duplication check
dvashchuk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| package beholder | ||
|
|
||
| import ( | ||
| "context" | ||
| "time" | ||
| ) | ||
|
|
||
| // Backward-compatibility types for downstream consumers (e.g. chainlink node). | ||
| // These were moved to pkg/durableemitter in PR #2081. They are re-declared here | ||
| // (not aliases) to avoid an import cycle through test utilities. | ||
| // | ||
| // TODO(SHARED-2644): Remove this file once chainlink node migrates imports to | ||
| // pkg/durableemitter (tracked in chainlink PR #22562). These duplicate declarations | ||
| // have no compile-time sync check against the canonical types. | ||
|
|
||
| // DurableEvent represents a persisted event awaiting delivery to Chip. | ||
| type DurableEvent struct { | ||
| ID int64 | ||
| Payload []byte | ||
| CreatedAt time.Time | ||
| } | ||
|
|
||
| // DurableQueueStats is a point-in-time snapshot of the pending queue for metrics. | ||
| type DurableQueueStats struct { | ||
| Depth int64 | ||
| PayloadBytes int64 | ||
| OldestPendingAge time.Duration | ||
| NearTTLCount int64 | ||
| } | ||
|
|
||
| // DurableQueueObserver is optionally implemented by DurableEventStore implementations | ||
| // so DurableEmitter can export queue depth and age gauges when metrics are enabled. | ||
| type DurableQueueObserver interface { | ||
| ObserveDurableQueue(ctx context.Context, eventTTL, nearExpiryLead time.Duration) (DurableQueueStats, error) | ||
| } | ||
|
|
||
| // BatchInserter is optionally implemented by DurableEventStore implementations | ||
| // to support multi-row inserts for higher throughput. | ||
| type BatchInserter interface { | ||
| InsertBatch(ctx context.Context, payloads [][]byte) ([]int64, error) | ||
| } | ||
|
|
||
| // DurableEventStore abstracts the persistence layer for durable chip events. | ||
| type DurableEventStore interface { | ||
| Insert(ctx context.Context, payload []byte) (int64, error) | ||
| Delete(ctx context.Context, id int64) error | ||
| MarkDelivered(ctx context.Context, id int64) error | ||
| MarkDeliveredBatch(ctx context.Context, ids []int64) (int64, error) | ||
| PurgeDelivered(ctx context.Context, batchLimit int) (deleted int64, err error) | ||
| ListPending(ctx context.Context, createdBefore time.Time, limit int) ([]DurableEvent, error) | ||
| DeleteExpired(ctx context.Context, ttl time.Duration) (int64, error) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch. DurableEventStoreConfig does not exist in pkg/durableemitter — the PR description was wrong. Updated the description to list the actual types: DurableEvent, DurableQueueStats, DurableQueueObserver, BatchInserter, DurableEventStore.