fix: annotation layer json #9915
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
Codecov Report
@@ Coverage Diff @@
## master #9915 +/- ##
==========================================
- Coverage 71.23% 71.20% -0.04%
==========================================
Files 585 585
Lines 30870 30742 -128
Branches 3239 3239
==========================================
- Hits 21990 21889 -101
+ Misses 8771 8744 -27
Partials 109 109
Continue to review full report at Codecov.
|
john-bodley
reviewed
May 26, 2020
There was a problem hiding this comment.
@etr2460 could you add/modify a unit test which would prevent this from happening in the future?
|
I had a lot of trouble building an annotation layer mock for this, but i'll try some more to get a unit test out |
|
@john-bodley, I tried my best to add a test here, but wasn't able to get it to work due to an issue (maybe with FAB?). Here's my test code (also added in a commit to this PR): def test_annotation_json_endpoint(self):
# Something is broken with annotations and RLS, teardown will undo this
app.config["ENABLE_ROW_LEVEL_SECURITY"] = False
self.login(username="admin")
# Set up an annotation layer and annotation
self.get_resp(
"/annotationlayermodelview/add",
{"form_data": json.dumps({"name": "foo", "descr": "bar"})},
)
self.get_resp(
"/annotationmodelview/add",
{
"form_data": json.dumps(
{
"layer": "1",
"short_descr": "my_annotation",
"start_dttm": "2020-05-20 18:21:51",
"end_dttm": "2020-05-20 18:31:51",
}
)
},
)
resp = self.get_resp(
"/superset/annotation_json/1?form_data=%7B%22time_range%22%3A%22100+years+ago+%3A+now%22%7D"
)
assert "my_annotation" in respAnd the error I saw: It looks like when I'm trying to create an annotation inside the annotation layer, it's rendering a template instead of creating the new annotation. Maybe @dpgaspar has thoughts here? |
|
Thanks for the test fix @john-bodley! I confirmed that the test fails without my fix, and works with it |
john-bodley
approved these changes
May 27, 2020
auxten
pushed a commit
to auxten/incubator-superset
that referenced
this pull request
Nov 20, 2020
* fix: annotation layer json * attempt to add a test * [tests] Fixing test Co-authored-by: John Bodley <john.bodley@airbnb.com>
mistercrunch
added
🏷️ bot
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.
SUMMARY
The
annotation_jsonAPI makes use of the TableViz to structure the data returned from it. However, in #9122, we started limiting the columns that were returned, breaking this API. No one caught it because annotations were broken for a variety of other reasons, but I believe that this change should resolve all annotation layer issues remainingBEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Before:
After:
TEST PLAN
Test a chart with an annotation layer added and see the annotation display on the chart
ADDITIONAL INFORMATION
to: @john-bodley @graceguo-supercat @villebro