Add extra plugin for query enhancements (#6869)

* add query enhancements plugin Signed-off-by: Kawika Avilla <[email protected]> * no submodule Signed-off-by: Kawika Avilla <[email protected]> --------- Signed-off-by: Kawika Avilla <[email protected]>
opensearch-project · May 30, 2024 · 05d399a · 05d399a
1 parent 2925d5c
commit 05d399a
Show file tree

Hide file tree

Showing 66 changed files with 8,294 additions and 2,017 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -291,6 +291,7 @@ module.exports = {
                   'src/legacy/**/*',
                   '(src)/plugins/**/(public|server)/**/*',
                   'examples/**/*',
+                  'plugins-extra/**/*',
                 ],
                 from: [
                   'src/core/public/**/*',
@@ -322,6 +323,7 @@ module.exports = {
                   'src/legacy/**/*',
                   '(src)/plugins/**/(public|server)/**/*',
                   'examples/**/*',
+                  'plugins-extra/**/*',
                   '!(src)/**/*.test.*',
                 ],
                 from: [
@@ -338,13 +340,16 @@ module.exports = {
                   '!(src)/plugins/**/server/**/*',
 
                   'examples/**/*',
+                  'plugins-extra/**/*',
                   '!examples/**/server/**/*',
+                  '!plugins-extra/**/server/**/*',
                 ],
                 from: [
                   'src/core/server',
                   'src/core/server/**/*',
                   '(src)/plugins/*/server/**/*',
                   'examples/**/server/**/*',
+                  'plugins-extra/**/server/*',
                 ],
                 errorMessage:
                   'Server modules cannot be imported into client modules or shared modules.',

diff --git a/config/opensearch_dashboards.yml b/config/opensearch_dashboards.yml
@@ -334,3 +334,25 @@
 
 # Set the value to true to enable enhancements for the data plugin
 # data.enhancements.enabled: false
+# Set the value to true to enable enhancements for the data plugin
+data.enhancements.enabled: true
+# # uiSettings:
+# #   overrides:o
+# #     "timepicker:quickRanges": []
+opensearch_alerting.enabled: false
+opensearch_security.enabled: false
+# ql_dashboards.enabled: false
+
+# opensearch.hosts: [https://localhost:9200]fea
+# opensearch.ssl.verificationMode: none
+# opensearch.username: kibanaserver
+# opensearch.password: kibanaserver
+# opensearch.requestHeadersWhitelist: [authorization, securitytenant]
+
+# opensearch_security.multitenancy.enabled: true
+# opensearch_security.multitenancy.tenants.preferred: [Private, Global]
+# opensearch_security.readonly_mode.roles: [kibana_read_only]
+# # Use this setting if you are running opensearch-dashboards without https
+# opensearch_security.cookie.secure: false
+
+
diff --git a/package.json b/package.json
@@ -121,6 +121,7 @@
     "packages": [
       "packages/*",
       "examples/*",
+      "plugins-extra/*",
       "test/plugin_functional/plugins/*",
       "test/interpreter_functional/plugins/*"
     ],

diff --git a/packages/osd-config/src/__mocks__/env.ts b/packages/osd-config/src/__mocks__/env.ts
@@ -49,6 +49,7 @@ export function getEnvOptions(options: DeepPartial<EnvOptions> = {}): EnvOptions
       disableOptimizer: true,
       cache: true,
       dist: false,
+      extraPlugins: false,
       runExamples: false,
       ...(options.cliArgs || {}),
     },

diff --git a/packages/osd-config/src/env.ts b/packages/osd-config/src/env.ts
@@ -52,6 +52,7 @@ export interface CliArgs {
   basePath: boolean;
   /** @deprecated use disableOptimizer to know if the @osd/optimizer is disabled in development */
   optimize?: boolean;
+  extraPlugins: boolean;
   runExamples: boolean;
   disableOptimizer: boolean;
   cache: boolean;
@@ -133,6 +134,7 @@ export class Env {
     this.pluginSearchPaths = [
       resolve(this.homeDir, 'src', 'plugins'),
       resolve(this.homeDir, 'plugins'),
+      ...(options.cliArgs.extraPlugins ? [resolve(this.homeDir, 'plugins-extra')] : []),
       ...(options.cliArgs.runExamples ? [resolve(this.homeDir, 'examples')] : []),
       resolve(this.homeDir, '..', 'opensearch-dashboards-extra'),
     ];

diff --git a/packages/osd-optimizer/src/cli.ts b/packages/osd-optimizer/src/cli.ts
@@ -64,6 +64,11 @@ run(
       throw createFlagError('expected --dist to have no value');
     }
 
+    const extraPlugins = flags.extraPlugins ?? false;
+    if (typeof extraPlugins !== 'boolean') {
+      throw createFlagError('expected --extraPlugins to have no value');
+    }
+
     const examples = flags.examples ?? false;
     if (typeof examples !== 'boolean') {
       throw createFlagError('expected --no-examples to have no value');
@@ -117,6 +122,7 @@ run(
       maxWorkerCount,
       dist: dist || updateLimits,
       cache,
+      extraPlugins: extraPlugins && !(validateLimits || updateLimits),
       examples: examples && !(validateLimits || updateLimits),
       profileWebpack,
       extraPluginScanDirs,
@@ -153,6 +159,7 @@ run(
       boolean: [
         'core',
         'watch',
+        'extraPlugins',
         'examples',
         'dist',
         'cache',
@@ -165,6 +172,7 @@ run(
       string: ['workers', 'scan-dir', 'filter'],
       default: {
         core: true,
+        extraPlugins: false,
         examples: true,
         cache: true,
         'inspect-workers': true,
@@ -177,6 +185,7 @@ run(
         --no-core          disable generating the core bundle
         --no-cache         disable the cache
         --filter           comma-separated list of bundle id filters, results from multiple flags are merged, * and ! are supported
+        --extra-plugins    build the extra plugins
         --no-examples      don't build the example plugins
         --dist             create bundles that are suitable for inclusion in the OpenSearch Dashboards distributable, enabled when running with --update-limits
         --scan-dir         add a directory to the list of directories scanned for plugins (specify as many times as necessary)

diff --git a/packages/osd-optimizer/src/node/node_auto_tranpilation.ts b/packages/osd-optimizer/src/node/node_auto_tranpilation.ts
@@ -64,6 +64,10 @@ const IGNORE_PATTERNS = [
   // is `x-pack` and `b` is not `node_modules`
   /[\/\\]node_modules[\/\\](?!x-pack[\/\\](?!node_modules)([^\/\\]+))([^\/\\]+[\/\\][^\/\\]+)/,
 
+  // ignore paths matching `/node_modules/{a}/{b}`, unless `a`
+  // is `plugins-extra` and `b` is not `node_modules`
+  /[\/\\]node_modules[\/\\](?!plugins-extra[\/\\](?!node_modules)([^\/\\]+))([^\/\\]+[\/\\][^\/\\]+)/,
+
   // ignore any path in the packages, unless it is in the package's
   // root `src` directory, in any test or __tests__ directory, or it
   // ends with .test.js, .test.ts, or .test.tsx

diff --git a/packages/osd-optimizer/src/optimizer/optimizer_config.ts b/packages/osd-optimizer/src/optimizer/optimizer_config.ts
@@ -96,6 +96,8 @@ interface Options {
   /** set to true to inspecting workers when the parent process is being inspected */
   inspectWorkers?: boolean;
 
+  /** include extra plugins in default scan dirs */
+  extraPlugins?: boolean;
   /** include examples in default scan dirs */
   examples?: boolean;
   /** absolute paths to specific plugins that should be built */
@@ -153,6 +155,7 @@ export class OptimizerConfig {
   static parseOptions(options: Options): ParsedOptions {
     const watch = !!options.watch;
     const dist = !!options.dist;
+    const extraPlugins = !!options.extraPlugins;
     const examples = !!options.examples;
     const profileWebpack = !!options.profileWebpack;
     const inspectWorkers = !!options.inspectWorkers;
@@ -178,6 +181,7 @@ export class OptimizerConfig {
     const pluginScanDirs = options.pluginScanDirs || [
       Path.resolve(repoRoot, 'src/plugins'),
       Path.resolve(repoRoot, 'plugins'),
+      ...(extraPlugins ? [Path.resolve('plugins-extra')] : []),
       ...(examples ? [Path.resolve('examples')] : []),
       Path.resolve(repoRoot, 'opensearch-dashboards-extra'),
     ];

diff --git a/packages/osd-plugin-generator/src/ask_questions.ts b/packages/osd-plugin-generator/src/ask_questions.ts
@@ -42,6 +42,10 @@ export interface Answers {
 }
 
 export const INTERNAL_PLUGIN_LOCATIONS: Array<{ name: string; value: string }> = [
+  {
+    name: 'OpenSearch Dashboards Extra',
+    value: Path.resolve(REPO_ROOT, 'plugins-extra'),
+  },
   {
     name: 'OpenSearch Dashboards Example',
     value: Path.resolve(REPO_ROOT, 'examples'),

diff --git a/packages/osd-plugin-generator/src/plugin_types.ts b/packages/osd-plugin-generator/src/plugin_types.ts
@@ -42,6 +42,10 @@ export const PLUGIN_TYPE_OPTIONS: Array<{ name: string; value: PluginType }> = [
     name: 'Installable plugin',
     value: { thirdParty: true, installDir: Path.resolve(REPO_ROOT, 'plugins') },
   },
+  {
+    name: 'OpenSearch Dashboards Extra',
+    value: { thirdParty: false, installDir: Path.resolve(REPO_ROOT, 'plugins-extra') },
+  },
   {
     name: 'OpenSearch Dashboards Example',
     value: { thirdParty: false, installDir: Path.resolve(REPO_ROOT, 'examples') },

diff --git a/packages/osd-plugin-helpers/src/load_opensearch_dashboards_platform_plugin.ts b/packages/osd-plugin-helpers/src/load_opensearch_dashboards_platform_plugin.ts
@@ -43,10 +43,11 @@ export function loadOpenSearchDashboardsPlatformPlugin(pluginDir: string) {
   const parentDir = Path.resolve(pluginDir, '..');
 
   const isFixture = pluginDir.includes('__fixtures__');
+  const isExtra = Path.basename(parentDir) === 'plugins-extra';
   const isExample = Path.basename(parentDir) === 'examples';
   const isRootPlugin = parentDir === Path.resolve(REPO_ROOT, 'plugins');
 
-  if (isFixture || isExample || isRootPlugin) {
+  if (isFixture || isExtra || isExample || isRootPlugin) {
     return parseOpenSearchDashboardsPlatformPlugin(
       Path.resolve(pluginDir, 'opensearch_dashboards.json')
     );