[Console] Convert all non-autocomplete lib files to typescript (#4150)

* Convert non-autocomplete part to TS Signed-off-by: Sirazh Gabdullin <[email protected]> * Update CHANGELOG.md Signed-off-by: Sirazh Gabdullin <[email protected]> * refactor and improve typing Signed-off-by: Sirazh Gabdullin <[email protected]> --------- Signed-off-by: Sirazh Gabdullin <[email protected]>
opensearch-project · Jul 26, 2023 · 5c2b22b · 5c2b22b
1 parent d94d7cb
commit 5c2b22b
Show file tree

Hide file tree

Showing 14 changed files with 206 additions and 132 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -101,6 +101,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [Saved Objects Management] Add new or remove extra tags and styles ([#4069](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4069))
 - [Console] Migrate `/lib/mappings/` module to TypeScript ([#4008](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4008))
 - [Console] Migrate `/lib/autocomplete/` module to TypeScript ([#4148](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4148))
+- [Console] Migrate `/lib/!autocomplete/` module to TypeScript ([#4150](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4150))
 - [Dashboard] Restructure the `Dashboard` plugin folder to be more cohesive with the project ([#4575](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4575))
 
 ### 🔩 Tests

diff --git a/src/plugins/console/public/lib/autocomplete/__jest__/url_autocomplete.test.ts b/src/plugins/console/public/lib/autocomplete/__jest__/url_autocomplete.test.ts
@@ -38,7 +38,7 @@ import {
 
 import { populateContext } from '../../autocomplete/engine';
 import { PartialAutoCompleteContext } from '../components/autocomplete_component';
-import { ComponentFactory, ParametrizedComponentFactories } from '../../osd';
+import { ComponentFactory, ParametrizedComponentFactories } from '../types';
 
 describe('Url autocomplete', () => {
   function patternsTest(

diff --git a/src/plugins/console/public/lib/autocomplete/body_completer.ts b/src/plugins/console/public/lib/autocomplete/body_completer.ts
@@ -38,7 +38,7 @@ import {
   ConditionalProxy,
   GlobalOnlyComponent,
 } from './components';
-import { ParametrizedComponentFactories } from '../osd/osd';
+import { ParametrizedComponentFactories } from './types';
 import { AutoCompleteContext, Template, Term } from './types';
 import { CoreEditor, Token } from '../../types';
 import { MatchResult } from './components/autocomplete_component';
@@ -265,7 +265,7 @@ function compileParametrizedValue(
   if (!componentFactory) {
     throw new Error("no factory found for '" + value + "'");
   }
-  let component = componentFactory(value, null, template);
+  let component = componentFactory(value, null, !!template);
   if (!_.isUndefined(template)) {
     component = wrapComponentWithDefaults(component, { template });
   }
@@ -345,7 +345,7 @@ export function globalsOnlyAutocompleteComponents() {
 export function compileBodyDescription(
   endpointId: string,
   description: Description,
-  parametrizedComponentFactories: ParametrizedComponentFactories
+  parametrizedComponentFactories?: ParametrizedComponentFactories
 ) {
   return compileDescription(
     description,

diff --git a/src/plugins/console/public/lib/autocomplete/components/url_pattern_matcher.ts b/src/plugins/console/public/lib/autocomplete/components/url_pattern_matcher.ts
@@ -39,7 +39,7 @@ import {
 
 import { FullRequestComponent } from './full_request_component';
 import { Endpoint, UrlComponent, UrlObjectComponent } from '../types';
-import { ComponentFactory, ParametrizedComponentFactories } from '../../osd/osd';
+import { ComponentFactory, ParametrizedComponentFactories } from '../types';
 
 interface MethodData {
   rootComponent: SharedComponent;

diff --git a/src/plugins/console/public/lib/autocomplete/types.ts b/src/plugins/console/public/lib/autocomplete/types.ts
@@ -5,6 +5,15 @@
 
 import { Token, Position, Range } from '../../types';
 import { Description } from './body_completer';
+import {
+  FieldAutocompleteComponent,
+  IdAutocompleteComponent,
+  IndexAutocompleteComponent,
+  ListComponent,
+  TemplateAutocompleteComponent,
+  TypeAutocompleteComponent,
+  UsernameAutocompleteComponent,
+} from './components';
 import { SharedComponent } from './components/shared_component';
 
 export interface UrlObjectComponent {
@@ -75,3 +84,38 @@ export interface TermObject {
 }
 
 export type Term = string | TermObject;
+
+export type IdAutocompleteComponentFactory = (
+  name: string,
+  parent: SharedComponent,
+  multiValued?: boolean
+) => IdAutocompleteComponent;
+
+export type ComponentFactory = (
+  name: string,
+  parent: SharedComponent | null,
+  multiValued?: boolean
+) => SharedComponent;
+
+export interface ParametrizedComponentFactories {
+  getComponent: (
+    name: string,
+    parent?: SharedComponent | boolean,
+    provideDefault?: boolean
+  ) => ComponentFactory | undefined;
+  index?: (name: string, parent: ListComponent) => IndexAutocompleteComponent | undefined;
+  indices?: (name: string, parent: ListComponent) => IndexAutocompleteComponent | undefined;
+  type?: (name: string, parent: ListComponent) => TypeAutocompleteComponent;
+  types?: (name: string, parent: ListComponent) => TypeAutocompleteComponent;
+  id?: (name: string, parent: SharedComponent) => IdAutocompleteComponent;
+  transform_id?: (name: string, parent: SharedComponent) => IdAutocompleteComponent;
+  username?: (name: string, parent: ListComponent) => UsernameAutocompleteComponent;
+  user?: (name: string, parent: ListComponent) => UsernameAutocompleteComponent;
+  template?: (name: string, parent: ListComponent) => TemplateAutocompleteComponent;
+  task_id?: (name: string, parent: SharedComponent) => IdAutocompleteComponent;
+  ids?: (name: string, parent: SharedComponent) => IdAutocompleteComponent;
+  fields?: (name: string, parent: ListComponent) => FieldAutocompleteComponent;
+  field?: (name: string, parent: ListComponent) => FieldAutocompleteComponent;
+  nodes?: (name: string, parent: SharedComponent) => ListComponent;
+  node?: (name: string, parent: SharedComponent) => ListComponent;
+}
diff --git a/...rl_parsing/__tests__/curl_parsing.test.js → ...rl_parsing/__tests__/curl_parsing.test.ts b/...rl_parsing/__tests__/curl_parsing.test.js → ...rl_parsing/__tests__/curl_parsing.test.ts
@@ -44,10 +44,10 @@ describe('CURL', () => {
     if (fixture.trim() === '') {
       return;
     }
-    fixture = fixture.split(/^-+$/m);
-    const name = fixture[0].trim();
-    const curlText = fixture[1];
-    const response = fixture[2].trim();
+    const fixtureParts = fixture.split(/^-+$/m);
+    const name = fixtureParts[0].trim();
+    const curlText = fixtureParts[1];
+    const response = fixtureParts[2].trim();
 
     test('cURL Detection - ' + name, function () {
       expect(detectCURL(curlText)).toBe(true);

diff --git a/...s/console/public/lib/curl_parsing/curl.js → ...s/console/public/lib/curl_parsing/curl.ts b/...s/console/public/lib/curl_parsing/curl.js → ...s/console/public/lib/curl_parsing/curl.ts
@@ -28,12 +28,12 @@
  * under the License.
  */
 
-function detectCURLinLine(line) {
+function detectCURLinLine(line: string) {
   // returns true if text matches a curl request
   return line.match(/^\s*?curl\s+(-X[A-Z]+)?\s*['"]?.*?['"]?(\s*$|\s+?-d\s*?['"])/);
 }
 
-export function detectCURL(text) {
+export function detectCURL(text: string) {
   // returns true if text matches a curl request
   if (!text) return false;
   for (const line of text.split('\n')) {
@@ -44,10 +44,10 @@ export function detectCURL(text) {
   return false;
 }
 
-export function parseCURL(text) {
+export function parseCURL(text: string) {
   let state = 'NONE';
-  const out = [];
-  let body = [];
+  const out: string[] = [];
+  let body: string[] = [];
   let line = '';
   const lines = text.trim().split('\n');
   let matches;
@@ -79,12 +79,12 @@ export function parseCURL(text) {
     if (lines.length === 0) {
       return false;
     }
-    line = lines.shift().replace(/[\r\n]+/g, '\n') + '\n';
+    line = lines.shift()!.replace(/[\r\n]+/g, '\n') + '\n';
     return true;
   }
 
   function unescapeLastBodyEl() {
-    const str = body.pop().replace(/\\([\\"'])/g, '$1');
+    const str = (body.pop() as string).replace(/\\([\\"'])/g, '$1');
     body.push(str);
   }
 
@@ -115,11 +115,11 @@ export function parseCURL(text) {
   // If the pattern matches, then the state is about to change,
   // so add the capture to the body and detect the next state
   // Otherwise add the whole line
-  function consumeMatching(pattern) {
-    const matches = line.match(pattern);
-    if (matches) {
-      body.push(matches[1]);
-      line = line.substr(matches[0].length);
+  function consumeMatching(pattern: RegExp) {
+    const patternMatches = line.match(pattern);
+    if (patternMatches) {
+      body.push(patternMatches[1]);
+      line = line.substr(patternMatches[0].length);
       detectQuote();
     } else {
       body.push(line);
@@ -130,9 +130,9 @@ export function parseCURL(text) {
   function parseCurlLine() {
     let verb = 'GET';
     let request = '';
-    let matches;
-    if ((matches = line.match(CurlVerb))) {
-      verb = matches[1];
+    let curlMatches: RegExpMatchArray | null;
+    if ((curlMatches = line.match(CurlVerb))) {
+      verb = curlMatches[1];
     }
 
     // JS regexen don't support possessive quantifiers, so

diff --git a/...opensearch/__tests__/content_type.test.js → ...opensearch/__tests__/content_type.test.ts b/...opensearch/__tests__/content_type.test.js → ...opensearch/__tests__/content_type.test.ts
diff --git a/...nsole/public/lib/osd/__tests__/kb.test.js → ...nsole/public/lib/osd/__tests__/kb.test.ts b/...nsole/public/lib/osd/__tests__/kb.test.js → ...nsole/public/lib/osd/__tests__/kb.test.ts
@@ -32,8 +32,10 @@ import _ from 'lodash';
 import { populateContext } from '../../autocomplete/engine';
 
 import '../../../application/models/sense_editor/sense_editor.test.mocks';
-import * as osd from '../../osd';
+import * as osd from '../osd';
 import * as mappings from '../../mappings/mappings';
+import { PartialAutoCompleteContext } from '../../autocomplete/components/autocomplete_component';
+import { Term } from '../../autocomplete/types';
 
 describe('Knowledge base', () => {
   beforeEach(() => {
@@ -67,37 +69,41 @@ describe('Knowledge base', () => {
     },
   };
 
-  function testUrlContext(tokenPath, otherTokenValues, expectedContext) {
+  function testUrlContext(
+    tokenPath: Array<string | string[]>,
+    otherTokenValues: string[],
+    expectedContext: PartialAutoCompleteContext
+  ) {
     if (expectedContext.autoCompleteSet) {
-      expectedContext.autoCompleteSet = _.map(expectedContext.autoCompleteSet, function (t) {
-        if (_.isString(t)) {
-          t = { name: t };
+      expectedContext.autoCompleteSet = _.map(expectedContext.autoCompleteSet, function (term) {
+        if (_.isString(term)) {
+          term = { name: term };
         }
-        return t;
+        return term;
       });
     }
 
-    const context = { otherTokenValues: otherTokenValues };
+    const context: PartialAutoCompleteContext = { otherTokenValues };
     populateContext(
       tokenPath,
       context,
       null,
-      expectedContext.autoCompleteSet,
+      !!expectedContext.autoCompleteSet,
       osd.getTopLevelUrlCompleteComponents('GET')
     );
 
     // override context to just check on id
     if (context.endpoint) {
-      context.endpoint = context.endpoint.id;
+      context.endpoint = (context as any).endpoint.id;
     }
 
     delete context.otherTokenValues;
 
-    function norm(t) {
-      if (_.isString(t)) {
-        return { name: t };
+    function norm(term: Term) {
+      if (_.isString(term)) {
+        return { name: term };
       }
-      return t;
+      return term;
     }
 
     if (context.autoCompleteSet) {
@@ -113,34 +119,35 @@ describe('Knowledge base', () => {
     expect(context).toEqual(expectedContext);
   }
 
-  function t(term) {
+  function t(term: string) {
     return { name: term, meta: 'type' };
   }
 
-  function i(term) {
+  function i(term: string) {
     return { name: term, meta: 'index' };
   }
 
-  function indexTest(name, tokenPath, otherTokenValues, expectedContext) {
+  function indexTest(
+    name: string,
+    tokenPath: Array<string | string[]>,
+    otherTokenValues: string[],
+    expectedContext: PartialAutoCompleteContext
+  ) {
     test(name, function () {
-      // eslint-disable-next-line new-cap
-      const testApi = new osd._test.loadApisFromJson(
-        {
-          indexTest: {
-            endpoints: {
-              _multi_indices: {
-                patterns: ['{indices}/_multi_indices'],
-              },
-              _single_index: { patterns: ['{index}/_single_index'] },
-              _no_index: {
-                // testing default patters
-                //  patterns: ["_no_index"]
-              },
+      const testApi = osd._test.loadApisFromJson({
+        indexTest: {
+          endpoints: {
+            _multi_indices: {
+              patterns: ['{indices}/_multi_indices'],
+            },
+            _single_index: { patterns: ['{index}/_single_index'] },
+            _no_index: {
+              // testing default patters
+              //  patterns: ["_no_index"]
             },
           },
         },
-        osd._test.globalUrlComponentFactories
-      );
+      });
 
       osd.setActiveApi(testApi);
 
@@ -171,20 +178,22 @@ describe('Knowledge base', () => {
     autoCompleteSet: ['_multi_indices'],
   });
 
-  function typeTest(name, tokenPath, otherTokenValues, expectedContext) {
+  function typeTest(
+    name: string,
+    tokenPath: Array<string | string[]>,
+    otherTokenValues: string[],
+    expectedContext: PartialAutoCompleteContext
+  ) {
     test(name, function () {
-      const testApi = osd._test.loadApisFromJson(
-        {
-          typeTest: {
-            endpoints: {
-              _multi_types: { patterns: ['{indices}/{types}/_multi_types'] },
-              _single_type: { patterns: ['{indices}/{type}/_single_type'] },
-              _no_types: { patterns: ['{indices}/_no_types'] },
-            },
+      const testApi = osd._test.loadApisFromJson({
+        typeTest: {
+          endpoints: {
+            _multi_types: { patterns: ['{indices}/{types}/_multi_types'] },
+            _single_type: { patterns: ['{indices}/{type}/_single_type'] },
+            _no_types: { patterns: ['{indices}/_no_types'] },
           },
         },
-        osd._test.globalUrlComponentFactories
-      );
+      });
       osd.setActiveApi(testApi);
 
       mappings.loadMappings(MAPPING);