Modify the adding sample data part for timeline by zhyuanqi · Pull Request #6919 · opensearch-project/OpenSearch-Dashboards

zhyuanqi · 2024-06-05T07:34:28Z

Description

Modify the adding sample data part for timeline to add data source name if customer has enabled MDS

Issues Resolved

#6123

Screenshot

Screen.Recording.2024-06-05.at.12.26.50.AM.mov

Testing the changes

Please see screenshot

Changelog

fix: Modify the adding sample data part for timeline

Check List

All tests pass
- yarn test:jest
- yarn test:jest_integration
New functionality includes testing.
New functionality has been documented.
Update CHANGELOG.md
Commits are signed per the DCO using --signoff

codecov · 2024-06-05T07:52:50Z

Codecov Report

Attention: Patch coverage is 92.59259% with 2 lines in your changes missing coverage. Please review.

Project coverage is 67.43%. Comparing base (0188efe) to head (e4bce6b).

Files	Patch %	Lines
src/core/server/saved_objects/import/utils.ts	90.47%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6919   +/-   ##
=======================================
  Coverage   67.42%   67.43%           
=======================================
  Files        3443     3443           
  Lines       67782    67806   +24     
  Branches    11027    11031    +4     
=======================================
+ Hits        45705    45723   +18     
- Misses      19412    19417    +5     
- Partials     2665     2666    +1

Flag	Coverage Δ
Linux_1	`33.09% <14.28%> (-0.01%)`	⬇️
Linux_2	`55.06% <66.66%> (+<0.01%)`	⬆️
Linux_3	`45.20% <14.28%> (-0.02%)`	⬇️
Linux_4	`34.88% <85.18%> (+0.03%)`	⬆️
Windows_1	`33.11% <14.28%> (-0.01%)`	⬇️
Windows_2	`55.01% <66.66%> (-0.02%)`	⬇️
Windows_3	`45.21% <14.28%> (-0.02%)`	⬇️
Windows_4	`34.88% <85.18%> (+0.03%)`	⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

huyaboo · 2024-06-05T20:16:58Z

+  const replaceCallback = (match: string, funcName: string, args: string) => {
+    if (!args.includes('data_source_name')) {
+      args = args.trim();
+      args = `${args}, data_source_name=${dataSourceTitle}`;


We should wrap the dataSourceTitle in "" since titles can have spaces (ex: dataSourceTitle="Some DataSource A")

Suggested change

args = `${args}, data_source_name=${dataSourceTitle}`;

args = `${args}, data_source_name="${dataSourceTitle}"`;

And update relevant test cases as well

Thanks for pointing this out! Did not realize we can have name with space. Would modify and update test case

huyaboo · 2024-06-05T20:18:49Z


-const isVegaVisualization = (savedObject: SavedObject) => {
+export const extractTimelineExpression = (savedObject: SavedObject) => {
+  if (confirmVisualizationType(savedObject, 'timelion')) {


Nit: Logic should be the other way around. We should terminate early and return undefined if the visualization is not timelion

Sure. Would make the change

BionIT · 2024-06-05T21:36:00Z

+  const replaceCallback = (match: string, funcName: string, args: string) => {
+    if (!args.includes('data_source_name')) {
+      args = args.trim();
+      args = `${args}, data_source_name="${dataSourceTitle}"`;


As best practice, we should not mutate the input, can we assign a new variable?

Sure. Let me change the variable name.

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> (cherry picked from commit 48144c8) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

(cherry picked from commit 48144c8) Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

) Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

zhyuanqi requested review from AMoo-Miki, BionIT, Flyingliuhub, SuZhou-Joe, ZilongX, abbyhu2000, ananzh, ashwin-pc, bandinib-amzn, curq, joshuarrrr, kavilla, manasvinibs, mengweieric, ruanyl, xinruiba, zengyan-amazon and zhongnansu as code owners June 5, 2024 07:34

zhyuanqi added the v2.15.0 label Jun 5, 2024

github-actions bot added the seasoned-contributor label Jun 5, 2024

zhyuanqi added multiple datasource multiple datasource project backport 2.x and removed seasoned-contributor labels Jun 5, 2024

opensearch-changeset-bot bot added a commit to zhyuanqi/OpenSearch-Dashboards that referenced this pull request Jun 5, 2024

Changeset file for PR opensearch-project#6919 created/updated

aee2814

zhyuanqi force-pushed the timeline branch 2 times, most recently from d62d922 to d8fc98e Compare June 5, 2024 07:39

zhyuanqi force-pushed the timeline branch from d8fc98e to d9c29d4 Compare June 5, 2024 18:09

BionIT assigned zhongnansu and huyaboo Jun 5, 2024

BionIT self-assigned this Jun 5, 2024

zhyuanqi force-pushed the timeline branch 2 times, most recently from 4732241 to dcb93eb Compare June 5, 2024 20:14

huyaboo reviewed Jun 5, 2024

View reviewed changes

BionIT mentioned this pull request Jun 5, 2024

[Meta] [2.15] Security, bug fix and enhancemanet for dashboards anywhere #6600

Closed

45 tasks

zhyuanqi force-pushed the timeline branch 2 times, most recently from 0150d0e to dc94610 Compare June 5, 2024 21:17

huyaboo approved these changes Jun 5, 2024

View reviewed changes

BionIT reviewed Jun 5, 2024

View reviewed changes

Comment thread src/core/server/saved_objects/import/utils.ts

zhyuanqi force-pushed the timeline branch 2 times, most recently from bf4ab28 to 8aa3af9 Compare June 5, 2024 21:31

BionIT reviewed Jun 5, 2024

View reviewed changes

zhyuanqi force-pushed the timeline branch 4 times, most recently from f88aca7 to df5591d Compare June 5, 2024 21:55

Modify the adding sample data part for timeline

e4bce6b

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

zhyuanqi force-pushed the timeline branch from df5591d to e4bce6b Compare June 5, 2024 21:56

BionIT approved these changes Jun 5, 2024

View reviewed changes

xinruiba approved these changes Jun 5, 2024

View reviewed changes

zhyuanqi merged commit 48144c8 into opensearch-project:main Jun 5, 2024

opensearch-trigger-bot bot mentioned this pull request Jun 5, 2024

[Backport 2.x] Modify the adding sample data part for timeline #6934

Merged

zhongnansu mentioned this pull request Jun 6, 2024

[BUG] Sample visualization based on saved search could not find correct index pattern when added via add sample data page #6857

Closed

zhyuanqi added a commit to zhyuanqi/OpenSearch-Dashboards that referenced this pull request Jun 6, 2024

Modify the adding sample data part for timeline (opensearch-project#6919

f8a17fd

) Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

zhyuanqi mentioned this pull request Jun 6, 2024

Modify the import for timeline visualization to includes data source name in MDS scenario #6954

Merged

7 tasks

zhongnansu mentioned this pull request Jun 10, 2024

Add missing change log for 2.15 MDS PRs #6986

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Modify the adding sample data part for timeline#6919

Modify the adding sample data part for timeline#6919
zhyuanqi merged 1 commit intoopensearch-project:mainfrom
zhyuanqi:timeline

zhyuanqi commented Jun 5, 2024

Uh oh!

codecov bot commented Jun 5, 2024 •

edited

Loading

Uh oh!

huyaboo Jun 5, 2024

Uh oh!

huyaboo Jun 5, 2024

Uh oh!

zhyuanqi Jun 5, 2024

Uh oh!

huyaboo Jun 5, 2024

Uh oh!

zhyuanqi Jun 5, 2024

Uh oh!

Uh oh!

BionIT Jun 5, 2024

Uh oh!

zhyuanqi Jun 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	args = `${args}, data_source_name=${dataSourceTitle}`;
	args = `${args}, data_source_name="${dataSourceTitle}"`;

Conversation

zhyuanqi commented Jun 5, 2024

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

Uh oh!

codecov bot commented Jun 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

huyaboo Jun 5, 2024

Choose a reason for hiding this comment

Uh oh!

huyaboo Jun 5, 2024

Choose a reason for hiding this comment

Uh oh!

zhyuanqi Jun 5, 2024

Choose a reason for hiding this comment

Uh oh!

huyaboo Jun 5, 2024

Choose a reason for hiding this comment

Uh oh!

zhyuanqi Jun 5, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BionIT Jun 5, 2024

Choose a reason for hiding this comment

Uh oh!

zhyuanqi Jun 5, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Jun 5, 2024 •

edited

Loading