Add maps saved object for sample datasets #240

naveentatikonda · 2023-02-10T06:59:43Z

Description

This PR includes the changes which adds the dashboards-maps saved object to the existing sample dataset. When the user install a sample dataset then in the dashboards-maps panel, we can see a default saved map which will help maps users to explore maps with that dataset instead of creating a new map from scratch.

We have two videos below which shows the dashboards-maps panel before adding these changes and after adding these changes for flights sample dataset. Similarly, we can add saved objects for other sample datasets.

Before.adding.changes.mov

After.adding.changes.mov

Testing

Tested it to make sure the saved object consumes the latest changes in config(dataUrl and styleUrl):

Firstly, without makes any changes to config values, such that it consumes default values from config.ts
Passing it as a command line argument

yarn start --custom_import_map_dashboards.opensearchVectorTileDataUrl="...."

Setting it's value in the config/opensearch_dashboards.yml

Issues Resolved

opensearch-project/OpenSearch-Dashboards#3244

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Naveen Tatikonda <navtat@amazon.com>

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

Signed-off-by: Naveen Tatikonda <navtat@amazon.com>

codecov-commenter · 2023-02-10T07:07:22Z

Codecov Report

Merging #240 (55ee6d4) into main (ffb12e6) will increase coverage by 0.06%.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##             main     #240      +/-   ##
==========================================
+ Coverage   91.60%   91.66%   +0.06%     
==========================================
  Files           9       10       +1     
  Lines         262      264       +2     
  Branches       34       34              
==========================================
+ Hits          240      242       +2     
  Misses         16       16              
  Partials        6        6

Impacted Files	Coverage Δ
...ponents/layer_control_panel/delete_layer_modal.tsx	`100.00% <0.00%> (ø)`

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

cypress/integration/add_saved_object.spec.js

server/plugin.ts

junqiu-lei · 2023-02-13T21:06:01Z

server/services/sample_data/flights_saved_objects.ts

+    description: 'Shows cancelled flights',
+    type: 'documents',
+    id: 'f3ae28ce-2494-4e50-ae31-4603cfcbfd7d',
+    zoomRange: [2, 22],


How about make the example of document layer to be visible when user initially open it at zoom 0, like [0, 5]? IMO, as a demo example, it should be visualization friendly when at first glance.

IMO, We should have use case why some layers can be invisible from beginning. User might not notice if everything is visible starting from 0.

Agree, so that we can show layer is invisible after like zoom 5. I think the initially display on demo example is important for new users to show the main features. But yeah, any choice should be good.

Lets make it between [0 - 14] like junqiu suggested.

Sure, I will set the zoom range to [0-14] in the sample object of actual default map while checking it into the repo. As this is a dummy sample object just to validate the changes. For now, I'm leaving it as it is.

VijayanB · 2023-02-13T21:06:11Z

server/services/sample_data/flights_saved_objects.ts

+import { i18n } from '@osd/i18n';
+import { ConfigSchema } from '../../../common/config';
+
+const layerList = (config: ConfigSchema) => [


nit: can this be destructured?

I tried. But, not able to destructure it.

Signed-off-by: Naveen Tatikonda <navtat@amazon.com>

VijayanB

LGTM! Thanks.

server/services/sample_data/flights_saved_objects.ts

* Add Default Saved object for Maps Signed-off-by: Naveen Tatikonda <navtat@amazon.com> * Consume config and output result Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * Refactor the code Signed-off-by: Naveen Tatikonda <navtat@amazon.com> * Address Review Comments Signed-off-by: Naveen Tatikonda <navtat@amazon.com> --------- Signed-off-by: Naveen Tatikonda <navtat@amazon.com> Signed-off-by: Kawika Avilla <kavilla414@gmail.com> Co-authored-by: Kawika Avilla <kavilla414@gmail.com> (cherry picked from commit 816ce79)

* Add Default Saved object for Maps Signed-off-by: Naveen Tatikonda <navtat@amazon.com> * Consume config and output result Signed-off-by: Kawika Avilla <kavilla414@gmail.com> * Refactor the code Signed-off-by: Naveen Tatikonda <navtat@amazon.com> * Address Review Comments Signed-off-by: Naveen Tatikonda <navtat@amazon.com> --------- Signed-off-by: Naveen Tatikonda <navtat@amazon.com> Signed-off-by: Kawika Avilla <kavilla414@gmail.com> Co-authored-by: Kawika Avilla <kavilla414@gmail.com> (cherry picked from commit 816ce79) Co-authored-by: Naveen Tatikonda <navtat@amazon.com>

naveentatikonda and others added 3 commits February 9, 2023 18:23

Add Default Saved object for Maps

51be26c

Signed-off-by: Naveen Tatikonda <navtat@amazon.com>

Consume config and output result

729dd73

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

Refactor the code

c9cad2a

Signed-off-by: Naveen Tatikonda <navtat@amazon.com>

naveentatikonda requested a review from a team February 10, 2023 06:59

naveentatikonda added feature backport 2.x v2.6.0 labels Feb 10, 2023

naveentatikonda changed the title ~~Add maps saved object~~ Add maps saved object for sample datasets Feb 10, 2023

VijayanB reviewed Feb 13, 2023

View reviewed changes

cypress/integration/add_saved_object.spec.js Outdated Show resolved Hide resolved

VijayanB reviewed Feb 13, 2023

View reviewed changes

server/plugin.ts Show resolved Hide resolved

VijayanB reviewed Feb 13, 2023

View reviewed changes

server/plugin.ts Outdated Show resolved Hide resolved

junqiu-lei reviewed Feb 13, 2023

View reviewed changes

VijayanB reviewed Feb 13, 2023

View reviewed changes

VijayanB added enhancement New feature or request and removed feature labels Feb 13, 2023

Address Review Comments

55ee6d4

Signed-off-by: Naveen Tatikonda <navtat@amazon.com>

naveentatikonda requested review from VijayanB and junqiu-lei February 14, 2023 05:48

VijayanB reviewed Feb 14, 2023

View reviewed changes

VijayanB approved these changes Feb 14, 2023

View reviewed changes

VijayanB reviewed Feb 14, 2023

View reviewed changes

server/services/sample_data/flights_saved_objects.ts Show resolved Hide resolved

junqiu-lei approved these changes Feb 14, 2023

View reviewed changes

naveentatikonda merged commit 816ce79 into opensearch-project:main Feb 14, 2023

opensearch-trigger-bot bot mentioned this pull request Feb 14, 2023

[Backport 2.x] Add maps saved object for sample datasets #249

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add maps saved object for sample datasets #240

Add maps saved object for sample datasets #240

naveentatikonda commented Feb 10, 2023 •

edited

Loading

codecov-commenter commented Feb 10, 2023 •

edited

Loading

junqiu-lei Feb 13, 2023

VijayanB Feb 13, 2023

junqiu-lei Feb 13, 2023

VijayanB Feb 14, 2023

naveentatikonda Feb 14, 2023

VijayanB Feb 13, 2023

naveentatikonda Feb 14, 2023

VijayanB left a comment

Add maps saved object for sample datasets #240

Add maps saved object for sample datasets #240

Conversation

naveentatikonda commented Feb 10, 2023 • edited Loading

Description

Testing

Issues Resolved

codecov-commenter commented Feb 10, 2023 • edited Loading

Codecov Report

junqiu-lei Feb 13, 2023

Choose a reason for hiding this comment

VijayanB Feb 13, 2023

Choose a reason for hiding this comment

junqiu-lei Feb 13, 2023

Choose a reason for hiding this comment

VijayanB Feb 14, 2023

Choose a reason for hiding this comment

naveentatikonda Feb 14, 2023

Choose a reason for hiding this comment

VijayanB Feb 13, 2023

Choose a reason for hiding this comment

naveentatikonda Feb 14, 2023

Choose a reason for hiding this comment

VijayanB left a comment

Choose a reason for hiding this comment

naveentatikonda commented Feb 10, 2023 •

edited

Loading

codecov-commenter commented Feb 10, 2023 •

edited

Loading