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

KB notifications endpoint improvements #1735

Merged
merged 19 commits into from
Jan 17, 2024
Merged

KB notifications endpoint improvements #1735

merged 19 commits into from
Jan 17, 2024

Conversation

lferran
Copy link
Contributor

@lferran lferran commented Jan 17, 2024

Description

  • Improve notification models to be more precise and explicit (were too generic before)
  • Control when the stream is closed with a timeout
  • Extend the payload to indicate whether there were processing errors
  • Add documentation
  • Return an explicit 204 if the endpoint is called on standalone mode

How was this PR tested?

Unit and integration tests

@lferran
Copy link
Contributor Author

lferran commented Jan 17, 2024

related tickets [sc-8413] [sc-8414]

Copy link

codecov bot commented Jan 17, 2024

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (8e42cb2) 82.18% compared to head (b799936) 82.19%.

Files Patch % Lines
nucliadb/nucliadb/reader/reader/notifications.py 94.73% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1735      +/-   ##
==========================================
+ Coverage   82.18%   82.19%   +0.01%     
==========================================
  Files         334      334              
  Lines       19570    19587      +17     
==========================================
+ Hits        16084    16100      +16     
- Misses       3486     3487       +1     
Flag Coverage Δ
ingest 69.05% <ø> (ø)
nucliadb 70.32% <19.04%> (-0.07%) ⬇️
reader 79.41% <95.23%> (+0.39%) ⬆️
sdk 40.58% <ø> (ø)
search 79.04% <ø> (ø)
standalone 88.29% <ø> (ø)
train 63.71% <ø> (ø)
utils 81.25% <ø> (ø)
writer 85.15% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lferran lferran requested a review from a team January 17, 2024 10:00
docs/tutorials/KB_NOTIFICATIONS.md Outdated Show resolved Hide resolved
nucliadb/nucliadb/reader/api/v1/services.py Show resolved Hide resolved
nucliadb/nucliadb/reader/api/v1/services.py Outdated Show resolved Hide resolved
@lferran lferran merged commit 7db59a7 into main Jan 17, 2024
83 checks passed
@lferran lferran deleted the timeout-notifications branch January 17, 2024 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants