Add concept of block events and some design notes #1059
Merged
Conversation
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
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #1059 +/- ##
==========================================
+ Coverage 74.56% 74.95% +0.38%
==========================================
Files 67 67
Lines 4561 4659 +98
==========================================
+ Hits 3401 3492 +91
- Misses 1160 1167 +7
🚀 New features to boost your workflow:
|
datalab
|
||||||||||||||||||||||||||||
| Project |
datalab
|
| Branch Review |
ml-evs/blocks
|
| Run status |
|
| Run duration | 10m 25s |
| Commit |
|
| Committer | Matthew Evans |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
336
|
| View all changes introduced in this branch ↗︎ | |
2f892ca to
f765a97
Compare
|
Just pinging @BenjaminCharmes and @jdbocarsly for review on this one! |
BenjaminCharmes
previously approved these changes
Mar 20, 2025
jdbocarsly
reviewed
Mar 21, 2025
|
Made some fixes post-discussion with @jdbocarsly. Known limitations still:
|
f7fc272 to
34c71dd
Compare
827928a to
3f6c7e2
Compare
45e5591 to
9ae754c
Compare
f642195 to
2147107
Compare
BenjaminCharmes
previously approved these changes
Jul 31, 2025
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.
This PR adds the concept of "events" that can be registered on block types; essentially, server-side functions that can be triggered separately from parsing/ingestion for things like setting parameters. It also introduces the handling of particular events raised by Bokeh plots in the base data block in Vue.
This is all described in a new design document for this current version of datablocks, also committed in this PR.
I think eventually we can add several lifecycle hooks to the base block for handling certain things (remake block from scratch etc) that can be reused by derived block types, though I haven't put any effort into doing this now. I'm already using this functionality in a custom block that sets some parameters based on user feedback that requires reanalysing all block data (essentially a slider setting some offset time parameter).
For review, I recommend reading the design doc in the rtd preview at https://the-datalab--1059.org.readthedocs.build/en/1059/design/blocks/.
There's still a few open questions about how errors in events should be handled, and what methods should be triggered afterwards (mostly due to the fact we always call the
to_web()block method in the update-block route.