feat: add verbose map to get /dataset/ endpoint

[lilykuang]

SUMMARY

• verbose_map field is missing in /v1/dataset/{id} response, the chart in drill by modal doesn't have access to verbose column and metric names.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

• Has associated issue:
• Required feature flags:
• Changes UI
• Includes DB Migration (follow approval process in SIP-59)
  • Migration is atomic, supports rollback & is backwards-compatible
  • Confirm DB migration upgrade and downgrade tested
  • Runtime estimates and downtime expectations provided
• Introduces new feature or API
• Removes existing feature or API

[villebro]

Functional changes LGTM, but we need to add + update the schema. Also, we might want to consider DRYing the creation of verbose_map into a util.

[codecov]

Codecov Report

Merging #23655 (b307445) into master (6d55955) will increase coverage by 0.00%.
The diff coverage is 87.50%.

❗ Current head b307445 differs from pull request most recent head e02c80d. Consider uploading reports for the commit e02c80d to get more accurate results

@@           Coverage Diff           @@
##           master   #23655   +/-   ##
=======================================
  Coverage   68.02%   68.02%           
=======================================
  Files        1936     1937    +1     
  Lines       74929    74937    +8     
  Branches     8141     8143    +2     
=======================================
+ Hits        50970    50977    +7     
- Misses      21871    21872    +1     
  Partials     2088     2088           

Flag	Coverage Δ
javascript	54.29% <87.50%> (+<0.01%)	⬆️

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

Impacted Files	Coverage Δ
...tend/src/components/Chart/DrillBy/DrillByChart.tsx	100.00% <ø> (ø)
...tend/src/components/Chart/DrillBy/DrillByModal.tsx	72.54% <ø> (ø)
...perset-frontend/src/hooks/apiResources/datasets.ts	85.71% <85.71%> (ø)
.../src/components/Chart/DrillBy/DrillByMenuItems.tsx	90.14% <100.00%> (+0.14%)	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[villebro]

The schema still appears to be broken:

Btw, as the elements of both columns and metrics contain verbose_name, could it potentially be more simple to just create a useVerboseName(dataset) hook in the frontend that extracts the verboseMap from the requested dataset?

[kgabryje]

Btw, as the elements of both columns and metrics contain verbose_name, could it potentially be more simple to just create a useVerboseName(dataset) hook in the frontend that extracts the verboseMap from the requested dataset?

+1 to that! I had no clue that each column/metric contains its verbose_name, I assumed we can only take them from verbose_names on top level of dataset endpoint response

[kgabryje]

I tested the PR and the charts in drill by modal still don't use the verbose names. I think in order to achieve that, we also need to pass the dataset object that contains verbose map to <SuperChart ... /> in DrillByChart

[kgabryje]

Could we move that to a separate file/hook? Like useVerboseMap?
The we could call it in DrillByChart like const verboseMap = useVerboseMap(dataset) and pass dataset to SuperChart like { ...dataset, verbose_map: verboseMap }
WDYT?

[kgabryje]

And since that hook might have a more generic purpose, we could place it in src/hooks or src/utils instead of drill by directories

[kgabryje]

LGTM