Support injecting `DataStructureMeta` from `QueryEditorExtensions` for Query Assist #7871

joshuali925 · 2024-08-27T23:51:28Z

Description

fix query editor extensions enhance key
add query assist icons to clusters if available
allow custom icon for DATA_STRUCTURE_META_TYPES.FEATURE

TODO items:

replace the query assist icon. @canascar if we have a new icon, do you have the svg file for it? and is there a preferred tooltip for query assist?

confirm usage of DataStructureMeta @ashwin-pc @kavilla

OpenSearch-Dashboards/src/plugins/data/common/datasets/types.ts

Lines 137 to 161 in 73339c5

    
           /** 
        
            * Metadata for a data structure, used for additional properties like icons or tooltips. 
        
            */ 
        
           export interface DataStructureFeatureMeta { 
        
             type: DATA_STRUCTURE_META_TYPES.FEATURE; 
        
             icon?: string; 
        
             tooltip?: string; 
        
           } 
        
           /** 
        
            * Metadata for dataset type 
        
            */ 
        
           export interface DataStructureDataTypeMeta { 
        
             type: DATA_STRUCTURE_META_TYPES.TYPE; 
        
             icon: EuiIconProps; 
        
             tooltip: string; 
        
           } 
        
           /** 
        
            * Metadata for a data structure with CUSTOM type, allowing any additional fields. 
        
            */ 
        
           export interface DataStructureCustomMeta { 
        
             type: DATA_STRUCTURE_META_TYPES.CUSTOM; 
        
             [key: string]: any; 
        
           }

To use custom icons, I changed type to TYPE, which should be "metadata for dataset type". But for extensions I think FEATURE would make more sense. Is it on purpose to only support built-in OUI icons for FEATURE?
Currently index patterns have type CUSTOM, is it intentional to not support icons for it?

Issues Resolved

Screenshot

Testing the changes

Changelog

feat: Support injecting DataStructureMeta from QueryEditorExtensions for Query Assist

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

Signed-off-by: Joshua Li <joshuali925@gmail.com>

codecov · 2024-08-28T00:07:05Z

Codecov Report

Attention: Patch coverage is 13.15789% with 33 lines in your changes missing coverage. Please review.

Project coverage is 64.21%. Comparing base (930e244) to head (a249227).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...ic/query/query_string/dataset_service/lib/utils.ts	6.25%	15 Missing ⚠️
...nts/public/query_assist/utils/create_extension.tsx	22.22%	14 Missing ⚠️
...y_string/dataset_service/lib/index_pattern_type.ts	0.00%	2 Missing ⚠️
...ery/query_string/dataset_service/lib/index_type.ts	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7871      +/-   ##
==========================================
- Coverage   64.22%   64.21%   -0.02%     
==========================================
  Files        3672     3673       +1     
  Lines       81152    81175      +23     
  Branches    12938    12940       +2     
==========================================
+ Hits        52121    52127       +6     
- Misses      25822    25840      +18     
+ Partials     3209     3208       -1

Flag	Coverage Δ
Linux_1	`30.20% <5.00%> (-0.01%)`	⬇️
Linux_2	`56.08% <ø> (ø)`
Linux_3	`40.55% <5.00%> (+<0.01%)`	⬆️
Linux_4	`31.31% <13.15%> (-0.01%)`	⬇️
Windows_1	`30.21% <5.00%> (-0.01%)`	⬇️
Windows_2	`56.03% <ø> (ø)`
Windows_3	`40.55% <5.00%> (-0.02%)`	⬇️
Windows_4	`31.31% <13.15%> (-0.01%)`	⬇️

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.

Signed-off-by: Joshua Li <joshuali925@gmail.com>

ashwin-pc

The code looks good. Looks like you have a failing unit test though.

ashwin-pc · 2024-08-28T05:26:32Z

src/plugins/query_enhancements/public/query_assist/utils/create_extension.tsx

+ * @returns list of query assist supported languages for the given data source.
+ */
+const getAvailableLanguagesForDataSource = (() => {
+  const availableLanguagesByDataSource: Map<string | undefined, string[]> = new Map();


Nice way to cache the data

ashwin-pc · 2024-08-28T05:30:48Z

src/plugins/data/public/query/query_string/dataset_service/lib/utils.ts

Not a blocker but can we add some tests for this function?

kavilla · 2024-08-28T08:24:40Z

src/plugins/data/public/query/query_string/dataset_service/lib/utils.ts

+ * @param selectDataSourceId - function to get data source id given a data structure
+ * @returns data structures with meta
+ */
+export const injectMetaToDataStructures = async (


@ashwin-pc are we sure we don't want to do convert the dataset config to a class.

I was thinking it would be similar to the the interceptor class:

https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/plugins/data/public/search/search_interceptor.ts#L57

This way we don't have to ensure developers import this in their configs.

@joshuali925 could implement this in the base class and then it would be available for classes that extend the base class

agree. will think about it later, right now just trying to add instead of refactor..

kavilla · 2024-08-28T08:28:24Z

src/plugins/query_enhancements/public/plugin.tsx

@@ -95,7 +95,7 @@ export class QueryEnhancementsPlugin
    queryString.getLanguageService().registerLanguage(sqlLanguageConfig);

    data.__enhance({
-      ui: {
+      editor: {


sorry about that. Thanks for fixing.

…r Query Assist (#7871) * fix query editor extensions enhance key Signed-off-by: Joshua Li <joshuali925@gmail.com> * add query assist icons to clusters if available Signed-off-by: Joshua Li <joshuali925@gmail.com> * allow custom icon for `DATA_STRUCTURE_META_TYPES.FEATURE` Signed-off-by: Joshua Li <joshuali925@gmail.com> * Changeset file for PR #7871 created/updated --------- Signed-off-by: Joshua Li <joshuali925@gmail.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Co-authored-by: Ashwin P Chandran <ashwinpc@amazon.com> (cherry picked from commit 9bc2433) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…r Query Assist (#7871) (#7888) * fix query editor extensions enhance key * add query assist icons to clusters if available * allow custom icon for `DATA_STRUCTURE_META_TYPES.FEATURE` * Changeset file for PR #7871 created/updated --------- (cherry picked from commit 9bc2433) Signed-off-by: Joshua Li <joshuali925@gmail.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> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Co-authored-by: Ashwin P Chandran <ashwinpc@amazon.com>

joshuali925 added 2 commits August 27, 2024 23:41

fix query editor extensions enhance key

91c47c8

Signed-off-by: Joshua Li <joshuali925@gmail.com>

add query assist icons to clusters if available

03dcec7

Signed-off-by: Joshua Li <joshuali925@gmail.com>

github-actions bot added the seasoned-contributor label Aug 27, 2024

opensearch-changeset-bot bot added a commit to joshuali925/OpenSearch-Dashboards that referenced this pull request Aug 27, 2024

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

5a88864

joshuali925 marked this pull request as draft August 28, 2024 00:30

allow custom icon for DATA_STRUCTURE_META_TYPES.FEATURE

555c299

Signed-off-by: Joshua Li <joshuali925@gmail.com>

joshuali925 force-pushed the qa-ds-icon branch from 5a88864 to 555c299 Compare August 28, 2024 01:05

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

bd43fd0

joshuali925 marked this pull request as ready for review August 28, 2024 01:23

ashwin-pc approved these changes Aug 28, 2024

View reviewed changes

Merge branch 'main' into qa-ds-icon

a249227

kavilla reviewed Aug 28, 2024

View reviewed changes

kavilla approved these changes Aug 28, 2024

View reviewed changes

kavilla reviewed Aug 28, 2024

View reviewed changes

joshuali925 merged commit 9bc2433 into opensearch-project:main Aug 28, 2024
128 of 130 checks passed

joshuali925 added the backport 2.x label Aug 28, 2024

opensearch-trigger-bot bot mentioned this pull request Aug 28, 2024

[Backport 2.x] Support injecting DataStructureMeta from QueryEditorExtensions for Query Assist #7888

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support injecting `DataStructureMeta` from `QueryEditorExtensions` for Query Assist #7871

Support injecting `DataStructureMeta` from `QueryEditorExtensions` for Query Assist #7871

joshuali925 commented Aug 27, 2024 •

edited

Loading

codecov bot commented Aug 28, 2024 •

edited

Loading

ashwin-pc left a comment

ashwin-pc Aug 28, 2024

ashwin-pc Aug 28, 2024

kavilla Aug 28, 2024

joshuali925 Aug 28, 2024

kavilla Aug 28, 2024

	/**
	* Metadata for a data structure, used for additional properties like icons or tooltips.
	*/
	export interface DataStructureFeatureMeta {
	type: DATA_STRUCTURE_META_TYPES.FEATURE;
	icon?: string;
	tooltip?: string;
	}

	/**
	* Metadata for dataset type
	*/
	export interface DataStructureDataTypeMeta {
	type: DATA_STRUCTURE_META_TYPES.TYPE;
	icon: EuiIconProps;
	tooltip: string;
	}

	/**
	* Metadata for a data structure with CUSTOM type, allowing any additional fields.
	*/
	export interface DataStructureCustomMeta {
	type: DATA_STRUCTURE_META_TYPES.CUSTOM;
	[key: string]: any;
	}

Support injecting DataStructureMeta from QueryEditorExtensions for Query Assist #7871

Support injecting DataStructureMeta from QueryEditorExtensions for Query Assist #7871

Conversation

joshuali925 commented Aug 27, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

codecov bot commented Aug 28, 2024 • edited Loading

Codecov Report

ashwin-pc left a comment

Choose a reason for hiding this comment

ashwin-pc Aug 28, 2024

Choose a reason for hiding this comment

ashwin-pc Aug 28, 2024

Choose a reason for hiding this comment

kavilla Aug 28, 2024

Choose a reason for hiding this comment

joshuali925 Aug 28, 2024

Choose a reason for hiding this comment

kavilla Aug 28, 2024

Choose a reason for hiding this comment

Support injecting `DataStructureMeta` from `QueryEditorExtensions` for Query Assist #7871

Support injecting `DataStructureMeta` from `QueryEditorExtensions` for Query Assist #7871

joshuali925 commented Aug 27, 2024 •

edited

Loading

codecov bot commented Aug 28, 2024 •

edited

Loading