CP-51692: use Event.from instead of Event.next #6125
Merged
Conversation
This file contains 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
No functional change. Signed-off-by: Edwin Török <[email protected]>
…n flag This is more efficient: we can watch a single task, instead of everything in the DB. Feature-flag: use-event-next No functional change. Signed-off-by: Edwin Török <[email protected]>
int32_of_rpc doesn't accept Int32 as input, just Int because none of the current deserializers actually produce an Int32. (Int32 is only used by serializers to emit something different). This is an upstream ocaml-rpc bug that should be fixed, meanwhile convert Rpc.Int32 to Rpc.Int, so that the 'fake_rpc' inside XAPI can use Event.from. Otherwise you get this error: ``` Expected int32, got 'I32(0) ``` Signed-off-by: Edwin Török <[email protected]>
…vent.next This is more efficient: we can watch a single task, instead of everything in the DB. Feature-flag: use-event-next Signed-off-by: Edwin Török <[email protected]>
|
|
The above comment should go into the API documentation |
lindig
approved these changes
Nov 19, 2024
… of Event.next Feature flag: use-event-next Signed-off-by: Edwin Török <[email protected]>
edwintorok
force-pushed
the
pr/CP-51692
branch
2 times, most recently
from
6a97fd6 to
ace50ae
Compare
robhoes
approved these changes
Nov 19, 2024
|
Upstream bugfix here: mirage/ocaml-rpc#182, though probably still useful to keep the workaround too for now. |
robhoes
added a commit
that referenced
this pull request
Nov 21, 2024
Describe EVENTS_LOST in Event.next. Remove EVENTS_LOST and SESSION_NOT_REGISTERED from Event.from: these are only raised by Event.next. Document the actual errors that Event.from can raise. As requested in #6125 (comment), based on #6125 (comment)
edwintorok
added a commit
to edwintorok/xen-api
that referenced
this pull request
Dec 3, 2024
Event.next can lose events, and we try to encourage our API users to always use Event.from instead. My understanding (which could be wrong) is that Event.from will give you the events since a given point in time (token), whereas Event.next only gives you even from when you called the API (missing events between API calls). This PR introduces a feature flag that we can use to switch the interal users of Event.next to Event.from. Doing so I've discovered a bug in ocaml-rpc, where `int32_of_rpc` doesn't accept Int32 as input, just Int. There is a workaround here for now, but I intend to fix this upstream instead, hence the draft PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Event.next can lose events, and we try to encourage our API users to always use Event.from instead.
My understanding (which could be wrong) is that Event.from will give you the events since a given point in time (token), whereas Event.next only gives you even from when you called the API (missing events between API calls).
This PR introduces a feature flag that we can use to switch the interal users of Event.next to Event.from.
Doing so I've discovered a bug in ocaml-rpc, where
int32_of_rpcdoesn't accept Int32 as input, just Int.There is a workaround here for now, but I intend to fix this upstream instead, hence the draft PR.