fix: time filter db migration optimization

[ktmud]

SUMMARY

Optimizes free-text time range filter db migration added by #12505

1. Update the validation Exception so it can be exposed to the frontend (when migration hasn't applied).
2. Update the migration script so it handle cases like 100 years : 30 years ago. Previously it will incorrectly change it to 100 years ago : 30 years later when it should be 100 years ago : 30 years ago.

These are edge cases nonetheless.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Before

When opening a chart with "100 years" (i.e. periods without "ago" or "before/after"), it shows "Fatal error":

After

The error is more actionable:

(Still need some optimization here in order to render the backend validation error more properly but let's do it in another PR for other fields as well. Ideally the backend validation errors should come back to each control based on field name.)

TEST PLAN

#12552 is for fixing legacy charts. You will not be able to add bad data anymore because of the backend validation. You'd need to either find a legacy bad chart, or manually add one. A quick way to do it is this:

1. Connect to your Superset db using any database manager

For example I use psql:

psql "postgresql://superset:superset@127.0.0.1:5432/superset_test"

2. Run following SQL command:

INSERT INTO
  slices (
    created_on,
    changed_on,
    slice_name,
    datasource_type,
    datasource_name,
    viz_type,
    params,
    perm,
    datasource_id
  )
VALUES
  (
    '2021-01-25T13:21:40.763807',
    '2021-01-25T13:21:40.763807',
    'Test time period',
    'table',
    null,
    'table',
    '{ "compare_lag": "10", "compare_suffix": "o10Y", "country_fieldtype": "cca3", "entity": "country_code", "granularity_sqla": "year", "groupby": [ "country_name" ], "limit": "25", "markup_type": "markdown", "metrics": [ "sum__SP_POP_TOTL" ], "row_limit": 50000, "show_bubbles": true, "time_range": "100 years : 30 years ago", "time_range_endpoints": [ "inclusive", "exclusive" ], "viz_type": "table" }',
    '[examples].[wb_health_population](id:2)',
    2
  );

Note we set the time range to be "100 years : 30 years ago"

4. Find the ID of the chart you just inserted:

SELECT *
FROM slices
WHERE slice_name like 'Test time period'

3. Go to /superset/slice/{slice_id}

Before migration, you should see the "Unexpected error" when you open the chart.

After migration, you should see the chart render correctly.

Note: if you have already upgraded superset db, you need to downgrade it first:

superset db downgrade c878781977c6 
superset db upgrade

When in current master, after migration, you will also see the filter being updated to "100 years ago : 30 years later":

With this PR, after migration, you should see the filter being updated to "100 years ago : 30 years ago":

ADDITIONAL INFORMATION

• Has associated issue:
• Changes UI
• Requires DB Migration.
• Confirm DB Migration upgrade and downgrade tested.
• Introduces new feature or API
• Removes existing feature or API

[ktmud]

Bycatch, lazy text cannot be properly formatted by Marshmallow.

[ktmud]

Bycatch: should use field_name instead of field_names.

[codecov-io]

Codecov Report

Merging #13015 (0be83f0) into master (50fa100) will increase coverage by 14.32%.
The diff coverage is 60.00%.

@@             Coverage Diff             @@
##           master   #13015       +/-   ##
===========================================
+ Coverage   52.64%   66.97%   +14.32%     
===========================================
  Files         480      489        +9     
  Lines       17300    28766    +11466     
  Branches     4481        0     -4481     
===========================================
+ Hits         9108    19266    +10158     
- Misses       8192     9500     +1308     

Flag	Coverage Δ
cypress	?
python	66.97% <60.00%> (?)

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

Impacted Files	Coverage Δ
...s/260bf0649a77_migrate_x_dateunit_in_time_range.py	0.00% <0.00%> (ø)
superset/charts/commands/exceptions.py	92.85% <77.77%> (ø)
superset/utils/date_parser.py	96.87% <100.00%> (ø)
superset-frontend/src/SqlLab/constants.ts
...rset-frontend/src/components/ImportModal/index.tsx
...end/src/dashboard/util/getKeyForFilterScopeTree.js
.../controls/MetricControl/FilterDefinitionOption.jsx
...rc/explore/components/controls/ColorMapControl.jsx
...tend/src/dashboard/containers/DashboardBuilder.jsx
superset-frontend/src/chart/chartReducer.js
... and 944 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eb5dc38...0be83f0. Read the comment docs.

[zhaoyongjie]

LGTM, thanks for fixing it!

[zhaoyongjie]

One nit, add a test case :

[zhaoyongjie]

I will merge when the CI completed