Add satisfaction survey link to help menu #3676

abbyhu2000 · 2023-03-23T19:26:56Z

Add a link to the survey under the help menu on the top navigation bar. Also change the helper menu UI according to issue #3521

The link can be configurable in config/opensearch_dashboards.yml
#opensearchDashboards.survey.url: "https://survey.opensearch.org"

The default is to show the survey Give feedback in the helper menu
If admin wishes to disable the survey, they can edit the value in opensearch_dashboards.yml and set:
opensearchDashboards.survey.url: ""
If admin wishes to configure the survey, they can change the link in opensearch_dashboards.yml and set:
opensearchDashboards.survey.url: "/newSurveyLink"

Issues Resolved

resolves #3521

Check List

codecov-commenter · 2023-03-23T20:09:31Z

Codecov Report

Merging #3676 (04cb82c) into main (4e14aae) will increase coverage by 0.00%.
The diff coverage is 66.66%.

📣 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    #3676   +/-   ##
=======================================
  Coverage   66.41%   66.41%           
=======================================
  Files        3209     3209           
  Lines       61732    61733    +1     
  Branches     9533     9534    +1     
=======================================
+ Hits        41002    41003    +1     
  Misses      18442    18442           
  Partials     2288     2288

Flag	Coverage Δ
Linux	`66.36% <66.66%> (+<0.01%)`	⬆️
Windows	`66.37% <66.66%> (+<0.01%)`	⬆️

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

Impacted Files	Coverage Δ
src/core/public/chrome/chrome_service.tsx	`91.66% <ø> (ø)`
src/core/public/chrome/ui/header/header.tsx	`73.33% <ø> (ø)`
...njected_metadata/injected_metadata_service.mock.ts	`100.00% <ø> (ø)`
...lic/injected_metadata/injected_metadata_service.ts	`56.25% <0.00%> (-3.75%)`	⬇️
src/core/server/opensearch_dashboards_config.ts	`100.00% <ø> (ø)`
src/core/server/rendering/rendering_service.tsx	`66.23% <ø> (ø)`
src/legacy/server/config/schema.js	`100.00% <ø> (ø)`
...ation/angular/doc_table/create_doc_table_react.tsx	`0.00% <ø> (ø)`
...public/application/doc_views/doc_views_helpers.tsx	`0.00% <ø> (ø)`
src/core/public/chrome/constants.ts	`100.00% <100.00%> (ø)`
... and 1 more

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

kavilla

I think I would want the ability to at minimum disable this feature.

The next level would be able to configure the link utilized.

Not really a reason to block

abbyhu2000 · 2023-03-24T18:27:20Z

I think I would want the ability to at minimum disable this feature.

The next level would be able to configure the link utilized.

Added a config #opensearchDashboards.isSurveyAllowed: true in the yml file to enable/disable the survey link. @kavilla

config/opensearch_dashboards.yml

src/legacy/server/config/schema.js

src/core/public/chrome/ui/header/header_help_menu.tsx

joshuarrrr

Some minor changes requested

CHANGELOG.md

joshuarrrr · 2023-04-05T00:47:52Z

src/core/public/chrome/ui/header/header_help_menu.tsx

@@ -328,7 +332,7 @@ class HeaderHelpMenuUI extends Component<Props, State> {
        })}
        onClick={this.onMenuButtonClick}
      >
-        <EuiIcon type="help" size="m" />
+        <EuiIcon type="questionInCircle" size="l" />


Did you validate this icon size across various break points? If the UX guidance is to take this from m to l, we should also definitely update https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/core/public/chrome/ui/header/home_icon.tsx#L40-L41 and maybe check any other icons in the menu.

Need confirmation from the UX team, @KrooshalUX for his help menu icon, should we make it size 'm' or 'l'? Size 'm' looks kinda small to me

@kgcreative @joshuarrrr For reference, the first image is size 'l' and the second image is size 'm'.

joshuarrrr · 2023-04-05T00:53:33Z

src/core/public/chrome/ui/header/header_help_menu.tsx

-            defaultMessage="Give feedback"
-          />
-        </EuiButtonEmpty>
+        {opensearchSurvey}


you could just conditionally render inline:

Suggested change

{opensearchSurvey}

{ surveyLink && (

<div>

<EuiButtonEmpty href={surveyLink} target="_blank" size="xs" flush="left">

<FormattedMessage

id="core.ui.chrome.headerGlobalNav.helpMenuSatisfactionSurveyTitle"

defaultMessage="Give feedback"

/>

</EuiButtonEmpty>

<EuiSpacer size="xs" />

</div>

)}

src/core/public/chrome/ui/header/header_help_menu.tsx

joshuarrrr · 2023-04-05T00:57:48Z

src/core/public/chrome/ui/header/header.test.tsx

@@ -75,6 +75,7 @@ function mockProps() {
      mark: { defaultUrl: '/' },
      applicationTitle: 'OpenSearch Dashboards',
    },
+    survey: '/',


I'm not sure what kind of unit tests we have for the header or help menu, but I'd expect our coverage to validate cases where the survey value is set and when it's undefined. Looks like we only have the first path covered.

There is no unit tests that are covering the helper menu itself. Added a test file header_help_menu.test.tsx and added two unit tests for displaying and hiding the survey link. @joshuarrrr

config/opensearch_dashboards.yml

seanneumann · 2023-04-05T01:16:16Z

Did we investigate setting the url to something like "survey.opensearch.org" so the survey endpoint can be updated via DNS?

AMoo-Miki · 2023-04-05T16:05:46Z

Did we investigate setting the url to something like "survey.opensearch.org" so the survey endpoint can be updated via DNS?

This would be exceptionally simple to do. Though, I would prefer some specificity in the URL so we can use the domain for other stuff too; so while the domain will be survey.opensearch.org, at runtime we would append osd-version=2.7.0 which will tell us that (1) it came from OSD and (2) it was OSD 2.7.0.

seanneumann · 2023-04-05T16:59:43Z

I like it Miki. let's do it.

Any other params to append?

src/core/public/chrome/ui/header/header_help_menu.tsx

abbyhu2000 · 2023-04-13T20:24:59Z

Currently the cypress tests for multiple datasource are failing, added a line in cypress_workflow.yml to skip multiple data source cypress tests so the cypress tests action can pass. Created an issue to solve the cypress test failure.#3843

abbyhu2000 · 2023-04-13T20:28:42Z

.github/workflows/cypress_workflow.yml

@@ -12,7 +12,7 @@ env:
  START_CMD: 'node ../scripts/opensearch_dashboards --dev --no-base-path --no-watch'
  OPENSEARCH_SNAPSHOT_CMD: 'node ../scripts/opensearch snapshot'
  SPEC: 'cypress/integration/core-opensearch-dashboards/opensearch-dashboards/**/*.js,'
-  CYPRESS_ENV: 'env CYPRESS_VISBUILDER_ENABLED=true '
+  CYPRESS_ENV: 'env CYPRESS_VISBUILDER_ENABLED=true,DATASOURCE_MANAGEMENT_ENABLED=false'


This can be removed once the MD cypress tests are fixed. #3843

abbyhu2000 · 2023-04-13T20:37:58Z

Also Link checker fail because it references Roubenmeschian and Roubenmeschian server is down. Will delete Roubenmeschian reference in the code. (it exists in two comments in discover plugin)

src/plugins/discover/public/application/angular/doc_table/create_doc_table_react.tsx

Add a link to the survey under the help menu on the top navigation bar Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

User can disable the display of the survey in the helper menu. Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

Add a new config in the yml file so user can enable/disable the survey link in the helper menu. Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

* Add satisfaction survey link to help menu Add a link to the survey under the help menu on the top navigation bar Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * Make survey link configurable User can disable the display of the survey in the helper menu. Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * update snapshot Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * modify config Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * Make survey link configuration Add a new config in the yml file so user can enable/disable the survey link in the helper menu. Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * address comments and add unit test for helper menu Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * change survey link to custom domain Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * disable md cypress tests for now Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> --------- Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> (cherry picked from commit 685c911) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

* Add satisfaction survey link to help menu (#3676) * Add satisfaction survey link to help menu Add a link to the survey under the help menu on the top navigation bar Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * Make survey link configurable User can disable the display of the survey in the helper menu. Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * update snapshot Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * modify config Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * Make survey link configuration Add a new config in the yml file so user can enable/disable the survey link in the helper menu. Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * address comments and add unit test for helper menu Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * change survey link to custom domain Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * disable md cypress tests for now Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> --------- Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> (cherry picked from commit 685c911) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md * add changelog Signed-off-by: Josh Romero <rmerqg@amazon.com> --------- Signed-off-by: Josh Romero <rmerqg@amazon.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Josh Romero <rmerqg@amazon.com>

* Add satisfaction survey link to help menu Add a link to the survey under the help menu on the top navigation bar Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * Make survey link configurable User can disable the display of the survey in the helper menu. Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * update snapshot Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * modify config Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * Make survey link configuration Add a new config in the yml file so user can enable/disable the survey link in the helper menu. Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * address comments and add unit test for helper menu Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * change survey link to custom domain Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> * disable md cypress tests for now Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> --------- Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> Signed-off-by: David Sinclair <david@sinclair.tech>

abbyhu2000 self-assigned this Mar 23, 2023

abbyhu2000 force-pushed the add_survey_link_dashboard branch from 0887733 to 01e1d58 Compare March 23, 2023 19:28

abbyhu2000 marked this pull request as ready for review March 23, 2023 19:29

abbyhu2000 requested a review from a team as a code owner March 23, 2023 19:29

abbyhu2000 added backport 2.x v2.7.0 labels Mar 23, 2023

ashwin-pc previously approved these changes Mar 23, 2023

View reviewed changes

kavilla previously requested changes Mar 23, 2023

View reviewed changes

abbyhu2000 dismissed ashwin-pc’s stale review via cd1f61c March 24, 2023 18:13

abbyhu2000 force-pushed the add_survey_link_dashboard branch 2 times, most recently from cd1f61c to 065f298 Compare March 24, 2023 18:25

abbyhu2000 force-pushed the add_survey_link_dashboard branch from 065f298 to ac8f8da Compare March 24, 2023 18:28

kavilla reviewed Mar 24, 2023

View reviewed changes

config/opensearch_dashboards.yml Outdated Show resolved Hide resolved

abbyhu2000 mentioned this pull request Mar 29, 2023

Add Link to UX survey into Dashboards #3521

Closed

abbyhu2000 force-pushed the add_survey_link_dashboard branch from 4ec709f to b3c00de Compare March 30, 2023 20:43

kavilla reviewed Mar 30, 2023

View reviewed changes

src/legacy/server/config/schema.js Show resolved Hide resolved

kavilla reviewed Mar 30, 2023

View reviewed changes

src/core/public/chrome/ui/header/header_help_menu.tsx Outdated Show resolved Hide resolved

abbyhu2000 force-pushed the add_survey_link_dashboard branch from b3c00de to 96b86f4 Compare March 30, 2023 23:20

abbyhu2000 requested a review from seanneumann March 30, 2023 23:32

ashwin-pc mentioned this pull request Apr 5, 2023

2.7.0 Platform Upgrades for Plugins (O11y, MDS, Geospatial,+) #3674

Closed

23 tasks

joshuarrrr reviewed Apr 5, 2023

View reviewed changes

kavilla previously approved these changes Apr 8, 2023

View reviewed changes

src/core/public/chrome/ui/header/header_help_menu.tsx Outdated Show resolved Hide resolved

abbyhu2000 dismissed kavilla’s stale review via 1dcd22a April 13, 2023 04:14

abbyhu2000 force-pushed the add_survey_link_dashboard branch from 3c195a9 to 1dcd22a Compare April 13, 2023 04:14

abbyhu2000 requested a review from manasvinibs as a code owner April 13, 2023 04:14

abbyhu2000 force-pushed the add_survey_link_dashboard branch from 1dcd22a to 607844a Compare April 13, 2023 04:15

abbyhu2000 requested a review from kavilla April 13, 2023 04:16

abbyhu2000 commented Apr 13, 2023

View reviewed changes

joshuarrrr assigned AMoo-Miki and kavilla Apr 13, 2023

abbyhu2000 force-pushed the add_survey_link_dashboard branch 2 times, most recently from e3f0f3e to 04cb82c Compare April 14, 2023 14:53

kavilla previously approved these changes Apr 14, 2023

View reviewed changes

AMoo-Miki requested changes Apr 14, 2023

View reviewed changes

src/plugins/discover/public/application/angular/doc_table/create_doc_table_react.tsx Outdated Show resolved Hide resolved

abbyhu2000 added 8 commits April 14, 2023 16:31

Add satisfaction survey link to help menu

5d840e3

Add a link to the survey under the help menu on the top navigation bar Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

Make survey link configurable

13a2319

User can disable the display of the survey in the helper menu. Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

update snapshot

f2754d2

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

modify config

81f6eee

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

Make survey link configuration

53fbed2

Add a new config in the yml file so user can enable/disable the survey link in the helper menu. Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

address comments and add unit test for helper menu

6d9d407

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

change survey link to custom domain

e019e39

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

disable md cypress tests for now

df36005

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

abbyhu2000 dismissed kavilla’s stale review via df36005 April 14, 2023 16:32

abbyhu2000 force-pushed the add_survey_link_dashboard branch from 04cb82c to df36005 Compare April 14, 2023 16:32

ananzh approved these changes Apr 14, 2023

View reviewed changes

AMoo-Miki approved these changes Apr 14, 2023

View reviewed changes

abbyhu2000 merged commit 685c911 into opensearch-project:main Apr 14, 2023

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

[Backport 2.x] Add satisfaction survey link to help menu #3848

Merged

joshuarrrr mentioned this pull request Apr 21, 2023

[BUG] Duplicate help icons in main nav #3909

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add satisfaction survey link to help menu #3676

Add satisfaction survey link to help menu #3676

abbyhu2000 commented Mar 23, 2023 •

edited

Loading

codecov-commenter commented Mar 23, 2023 •

edited

Loading

kavilla left a comment

abbyhu2000 commented Mar 24, 2023

joshuarrrr left a comment

joshuarrrr Apr 5, 2023

abbyhu2000 Apr 5, 2023

abbyhu2000 Apr 5, 2023

joshuarrrr Apr 5, 2023

joshuarrrr Apr 5, 2023

abbyhu2000 Apr 5, 2023

seanneumann commented Apr 5, 2023

AMoo-Miki commented Apr 5, 2023

seanneumann commented Apr 5, 2023

abbyhu2000 commented Apr 13, 2023

abbyhu2000 Apr 13, 2023

abbyhu2000 commented Apr 13, 2023

-        {opensearchSurvey}
+        { surveyLink && (
+          <div>
+            <EuiButtonEmpty href={surveyLink} target="_blank" size="xs" flush="left">
+              <FormattedMessage
+                id="core.ui.chrome.headerGlobalNav.helpMenuSatisfactionSurveyTitle"
+                defaultMessage="Give feedback"
+               />
+            </EuiButtonEmpty>
+            <EuiSpacer size="xs" />
+          </div>
+        )}

Add satisfaction survey link to help menu #3676

Add satisfaction survey link to help menu #3676

Conversation

abbyhu2000 commented Mar 23, 2023 • edited Loading

Issues Resolved

Check List

codecov-commenter commented Mar 23, 2023 • edited Loading

Codecov Report

kavilla left a comment

Choose a reason for hiding this comment

abbyhu2000 commented Mar 24, 2023

joshuarrrr left a comment

Choose a reason for hiding this comment

joshuarrrr Apr 5, 2023

Choose a reason for hiding this comment

abbyhu2000 Apr 5, 2023

Choose a reason for hiding this comment

abbyhu2000 Apr 5, 2023

Choose a reason for hiding this comment

joshuarrrr Apr 5, 2023

Choose a reason for hiding this comment

joshuarrrr Apr 5, 2023

Choose a reason for hiding this comment

abbyhu2000 Apr 5, 2023

Choose a reason for hiding this comment

seanneumann commented Apr 5, 2023

AMoo-Miki commented Apr 5, 2023

seanneumann commented Apr 5, 2023

abbyhu2000 commented Apr 13, 2023

abbyhu2000 Apr 13, 2023

Choose a reason for hiding this comment

abbyhu2000 commented Apr 13, 2023

abbyhu2000 commented Mar 23, 2023 •

edited

Loading

codecov-commenter commented Mar 23, 2023 •

edited

Loading