[Feature] Expressions example plugin #1438

ashwin-pc · 2022-04-09T03:17:49Z

Description

We have a few example plugins that demonstrate how to use the various OpenSearch Dashboards features like UIActions, Embeddables, etc. This add to that list by creating an example plugin for expressions. It has 3 basic example for the main 3 features for embeddables, a playground to explore expressions and finally an explorer to explore and discover all the registered expression functions

expressions.example.mp4

Issues Resolved

Check List

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

kavilla · 2022-04-11T17:47:50Z

examples/expressions_example/.i18nrc.json

+  "paths": {
+    "expressionsExample": "."
+  },
+  "translations": ["translations/ja-JP.json"]


nit: probably can remove this. i know this scaffolded on generation

I wasn't sure if we were going to use these files for the localization that we are reintroducing. Figured if we were, its easier to start from this boilerplate, and if not we can just nuke this and all other .i18nrc.json files

kavilla

Awesome!! TY so much. Given that it is an example and not an end user functionality I think most follow-ups can be handle subsequently.

In the developer docs to run and access examples, or specifically to access this example?

ashwin-pc · 2022-04-13T06:00:54Z

@kavilla I'll add to the expression plugin's readme in a followup PR because i dont have all the details i want to add in it yet. As for how to run example plugins, we already have these instructions in the Example plugin folder's readme. I will update this readme too in that followup PR.

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

ashwin-pc · 2022-04-20T09:54:17Z

While the initial PR only made changes to the examples directory, this revision makes 3 changes to the expressions plugin itself. 2 of those changes are w.r.t ReactExpressionRenderer which is current not used anywhere application and safe to include for 2.0. The other change is to uiState. This was a bug and prevented the uiState from initializing correctly when used outside the context of Visualize. It should also not be an issue for 2.0, but i can remove that if necessary so that this is included in the release.

zengyan-amazon · 2022-04-20T20:21:54Z

examples/expressions_example/.eslintrc.js

+  root: true,
+  extends: ['@elastic/eslint-config-kibana', 'plugin:@elastic/eui/recommended'],
+  rules: {
+    '@osd/eslint/require-license-header': 'off',


don't we require license header for example code?

None of the example files currently have license headers and our linter does not catch them either. Not sure why the examples were skipped, but i can add them to this and the other examples in a followup PR once i confirm the reason.

zengyan-amazon · 2022-04-20T20:27:03Z

examples/expressions_example/opensearch_dashboards.json

+    "navigation",
+    "expressions",
+    "developerExamples",
+    "opensearchDashboardsReact"


I didn't understand your comment @zengyan-amazon. These plugins are used in the expressions-example plugin. Hence marked as required dependencies.

zengyan-amazon · 2022-04-20T22:25:23Z

src/plugins/expressions/public/_expression_renderer.scss

 .expExpressionRenderer__expression {
+  display: flex;
+  flex-direction: column;
  width: 100%;
  height: 100%;
+  overflow: auto;
+  position: relative;
+  flex: 1 1 100%;
 }


Will this scss change impact the style of UI components in other places?

No they will not. These styles only affect ReactExpressionRenderer which is currently not used anywhere in the application and is only used in the example plugin and in ReactExpressionRenderer unit tests.

* feat(Expressions): Initial demo plugin Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * feat(Expressions): Adds handlers tab Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * feat(Expressions): Adds playground tab Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * chore: Better expression playground messaging Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * feat(Expressions): Adds expression explorer Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * feat(Expressions): A better explorer Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * fix(Expressions): Fix basic demo abort error Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * Updates readme and fixes rendering visualizations Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

* feat(Expressions): Initial demo plugin Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * feat(Expressions): Adds handlers tab Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * feat(Expressions): Adds playground tab Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * chore: Better expression playground messaging Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * feat(Expressions): Adds expression explorer Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * feat(Expressions): A better explorer Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * fix(Expressions): Fix basic demo abort error Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * Updates readme and fixes rendering visualizations Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> (cherry picked from commit b7ca138)

* feat(Expressions): Initial demo plugin Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * feat(Expressions): Adds handlers tab Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * feat(Expressions): Adds playground tab Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * chore: Better expression playground messaging Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * feat(Expressions): Adds expression explorer Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * feat(Expressions): A better explorer Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * fix(Expressions): Fix basic demo abort error Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> * Updates readme and fixes rendering visualizations Signed-off-by: Ashwin Pc <ashwinpc@amazon.com> (cherry picked from commit b7ca138) Co-authored-by: Ashwin P Chandran <ashwinpc@amazon.com>

ashwin-pc added 7 commits April 5, 2022 09:13

feat(Expressions): Initial demo plugin

abd381f

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

feat(Expressions): Adds handlers tab

fe4f0c1

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

feat(Expressions): Adds playground tab

65c63e1

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

chore: Better expression playground messaging

611b336

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

feat(Expressions): Adds expression explorer

44a69a6

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

feat(Expressions): A better explorer

9ce68cb

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

fix(Expressions): Fix basic demo abort error

346626a

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

ashwin-pc requested a review from a team as a code owner April 9, 2022 03:17

kavilla reviewed Apr 11, 2022

View reviewed changes

kavilla previously approved these changes Apr 11, 2022

View reviewed changes

Updates readme and fixes rendering visualizations

2be0d41

Signed-off-by: Ashwin Pc <ashwinpc@amazon.com>

ashwin-pc dismissed kavilla’s stale review via 2be0d41 April 20, 2022 09:45

kavilla approved these changes Apr 20, 2022

View reviewed changes

zengyan-amazon approved these changes Apr 20, 2022

View reviewed changes

ashwin-pc merged commit b7ca138 into opensearch-project:main Apr 20, 2022

tmarkley mentioned this pull request Jun 8, 2022

[BUG] Updates needed in README.md, CONTRIBUTING.md, etc. #592

Closed

30 tasks

ashwin-pc added the backport 2.x label Oct 18, 2022

opensearch-trigger-bot bot mentioned this pull request Oct 18, 2022

[Backport 2.x] [Feature] Expressions example plugin #2602

Merged

joshuarrrr added the v2.4.0 'Issues and PRs related to version v2.4.0' label Apr 5, 2023

ashwin-pc added the docs Improvements or additions to documentation label Apr 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feature] Expressions example plugin #1438

[Feature] Expressions example plugin #1438

ashwin-pc commented Apr 9, 2022

kavilla Apr 11, 2022

ashwin-pc Apr 12, 2022

kavilla left a comment •

edited

Loading

ashwin-pc commented Apr 13, 2022

ashwin-pc commented Apr 20, 2022

zengyan-amazon Apr 20, 2022

ashwin-pc Apr 20, 2022 •

edited

Loading

zengyan-amazon Apr 20, 2022

ashwin-pc Apr 20, 2022

zengyan-amazon Apr 20, 2022

ashwin-pc Apr 20, 2022 •

edited

Loading

[Feature] Expressions example plugin #1438

[Feature] Expressions example plugin #1438

Conversation

ashwin-pc commented Apr 9, 2022

Description

Issues Resolved

Check List

kavilla Apr 11, 2022

Choose a reason for hiding this comment

ashwin-pc Apr 12, 2022

Choose a reason for hiding this comment

kavilla left a comment • edited Loading

Choose a reason for hiding this comment

ashwin-pc commented Apr 13, 2022

ashwin-pc commented Apr 20, 2022

zengyan-amazon Apr 20, 2022

Choose a reason for hiding this comment

ashwin-pc Apr 20, 2022 • edited Loading

Choose a reason for hiding this comment

zengyan-amazon Apr 20, 2022

Choose a reason for hiding this comment

ashwin-pc Apr 20, 2022

Choose a reason for hiding this comment

zengyan-amazon Apr 20, 2022

Choose a reason for hiding this comment

ashwin-pc Apr 20, 2022 • edited Loading

Choose a reason for hiding this comment

kavilla left a comment •

edited

Loading

ashwin-pc Apr 20, 2022 •

edited

Loading

ashwin-pc Apr 20, 2022 •

edited

Loading