@finos/legend-application 7.2.1 → 8.0.1

package/src/components/shared/TextSearchAdvancedConfigMenu.tsx

@@ -0,0 +1,73 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { BaseRadioGroup, InfoCircleIcon } from '@finos/legend-art';
+import { observer } from 'mobx-react-lite';
+import { LEGEND_APPLICATION_DOCUMENTATION_KEY } from '../../stores/LegendApplicationDocumentation.js';
+import {
+  ADVANCED_TEXT_SEARCH_MODE,
+  type TextSearchAdvancedConfigState,
+} from '../../stores/shared/TextSearchAdvancedConfigState.js';
+import { useApplicationStore } from '../ApplicationStoreProvider.js';
+
+export const TextSearchAdvancedConfigMenu = observer(
+  (props: { configState: TextSearchAdvancedConfigState }) => {
+    const { configState } = props;
+    const applicationStore = useApplicationStore();
+
+    const handleSearchMode: React.ChangeEventHandler<HTMLInputElement> = (
+      event,
+    ): void => {
+      const searchMode = event.target.value as ADVANCED_TEXT_SEARCH_MODE;
+      configState.setCurrentMode(searchMode);
+    };
+    const seeDocumentation = (): void =>
+      applicationStore.assistantService.openDocumentationEntry(
+        LEGEND_APPLICATION_DOCUMENTATION_KEY.QUESTION_HOW_TO_USE_ADVANCED_SEARCH_SYNTAX,
+      );
+
+    return (
+      <div className="text-search-advanced-config__panel">
+        <div className="text-search-advanced-config__panel__header__label">
+          search config
+          <button
+            className="text-search-advanced-config__panel__header__hint"
+            tabIndex={-1}
+            onClick={seeDocumentation}
+            title="Click to see more details on advanced search"
+          >
+            <InfoCircleIcon />
+          </button>
+        </div>
+        <div>
+          <BaseRadioGroup
+            className="text-search-advanced-config__options"
+            value={configState.currentMode}
+            onChange={handleSearchMode}
+            row={false}
+            options={[
+              ADVANCED_TEXT_SEARCH_MODE.STANDARD,
+              ADVANCED_TEXT_SEARCH_MODE.INCLUDE,
+              ADVANCED_TEXT_SEARCH_MODE.EXACT,
+              ADVANCED_TEXT_SEARCH_MODE.INVERSE,
+            ]}
+            size={1}
+          />
+        </div>
+      </div>
+    );
+  },
+);

package/src/components/shared/execution-plan-viewer/ExecutionPlanViewer.tsx

@@ -31,6 +31,7 @@ import {
   MenuContent,
   DropdownMenu,
   BlankPanelContent,
+  PanelContent,
 } from '@finos/legend-art';
 import {
   addUniqueEntry,
@@ -517,14 +518,14 @@ export const ExecutionPlanViewer = observer(
                         </div>
                       </div>
                     </div>
-                    <div className="panel__content">
+                    <PanelContent>
                       <TextInputEditor
                         inputValue={executionPlanState.debugText}
                         isReadOnly={true}
                         language={EDITOR_LANGUAGE.TEXT}
                         showMiniMap={true}
                       />
-                    </div>
+                    </PanelContent>
                   </div>
                 </ResizablePanel>
               </ResizablePanelGroup>

package/src/const.ts

@@ -15,6 +15,8 @@
  */
 
 export const TAB_SIZE = 2;
+export const DEFAULT_TYPEAHEAD_SEARCH_MINIMUM_SEARCH_LENGTH = 2;
+export const DEFAULT_TYPEAHEAD_SEARCH_LIMIT = 10;
 
 export const MONOSPACED_FONT_FAMILY = 'Roboto Mono';
 

package/src/index.ts

@@ -39,6 +39,9 @@ export * from './stores/AssistantService.js';
 export * from './stores/ApplicationNavigationContextService.js';
 export * from './stores/LegendApplicationPlugin.js';
 
+export * from './components/shared/TextSearchAdvancedConfigMenu.js';
+export * from './stores/shared/TextSearchAdvancedConfigState.js';
+
 export * from './stores/ApplicationStoreTestUtils.js';
 
 // ------------------------------------------- Shared components -------------------------------------------

package/src/stores/ApplicationStore.ts

@@ -25,7 +25,7 @@ import {
   isString,
   ApplicationError,
 } from '@finos/legend-shared';
-import { makeAutoObservable, action } from 'mobx';
+import { action, makeObservable, observable } from 'mobx';
 import { APPLICATION_EVENT } from './ApplicationEvent.js';
 import type { LegendApplicationConfig } from '../application/LegendApplicationConfig.js';
 import type { WebApplicationNavigator } from './WebApplicationNavigator.js';
@@ -105,15 +105,15 @@ export class Notification {
 
 export type GenericLegendApplicationStore = ApplicationStore<
   LegendApplicationConfig,
-  LegendApplicationPlugin
+  LegendApplicationPluginManager<LegendApplicationPlugin>
 >;
 
 export class ApplicationStore<
   T extends LegendApplicationConfig,
-  V extends LegendApplicationPlugin,
+  V extends LegendApplicationPluginManager<LegendApplicationPlugin>,
 > {
-  pluginManager: LegendApplicationPluginManager<V>;
   config: T;
+  pluginManager: V;
 
   // navigation
   navigator: WebApplicationNavigator;
@@ -144,13 +144,12 @@ export class ApplicationStore<
    */
   TEMPORARY__isLightThemeEnabled = false;
 
-  constructor(
-    config: T,
-    navigator: WebApplicationNavigator,
-    pluginManager: LegendApplicationPluginManager<V>,
-  ) {
-    makeAutoObservable(this, {
-      navigator: false,
+  constructor(config: T, navigator: WebApplicationNavigator, pluginManager: V) {
+    makeObservable(this, {
+      notification: observable,
+      blockingAlertInfo: observable,
+      actionAlertInfo: observable,
+      TEMPORARY__isLightThemeEnabled: observable,
       setBlockingAlert: action,
       setActionAlertInfo: action,
       setNotification: action,

package/src/stores/ApplicationStoreTestUtils.ts

@@ -52,10 +52,10 @@ export const TEST__getGenericApplicationConfig = (
 
 export const TEST__getTestApplicationStore = <
   T extends LegendApplicationConfig,
-  V extends LegendApplicationPlugin,
+  V extends LegendApplicationPluginManager<LegendApplicationPlugin>,
 >(
   config: T,
-  pluginManager: LegendApplicationPluginManager<V>,
+  pluginManager: V,
 ): ApplicationStore<T, V> =>
   new ApplicationStore(
     config,

package/src/stores/ApplicationTelemetry.ts

@@ -18,6 +18,11 @@ import type { TelemetryService } from '@finos/legend-shared';
 import { APPLICATION_EVENT } from './ApplicationEvent.js';
 
 type ApplicationLoaded_TelemetryData = {
+  application: {
+    name: string;
+    version: string;
+    env: string;
+  };
   browser: {
     userAgent: string;
   };

package/src/stores/AssistantService.ts

@@ -25,12 +25,15 @@ import {
   isNonNullable,
   ActionState,
 } from '@finos/legend-shared';
+import { TextSearchAdvancedConfigState } from './shared/TextSearchAdvancedConfigState.js';
 
 export enum VIRTUAL_ASSISTANT_TAB {
   SEARCH = 'SEARCH',
   CONTEXTUAL_SUPPORT = 'CONTEXTUAL_SUPPORT',
 }
 
+export const DOCUMENTATION_SEARCH_RESULTS_LIMIT = 100;
+
 export class VirtualAssistantDocumentationEntry {
   uuid = uuid();
   documentationKey: string;
@@ -77,9 +80,28 @@ export class VirtualAssistantContextualDocumentationEntry {
   }
 }
 
+/**
+ * NOTE: since we're displaying the documentation entry in virtual assistant
+ * we want only user-friendly docs, we will discard anything that doesn't
+ * come with a title, or does not have any content/url
+ */
+export const isValidVirtualAssistantDocumentationEntry = (
+  entry: DocumentationEntry,
+): boolean =>
+  Boolean(entry.title && (entry.url ?? entry.text ?? entry.markdownText));
+
+/**
+ * Check if the documentation entry should be displayed in virtual assistant,
+ * i.e. it has some text content, rather just a link
+ */
+export const shouldDisplayVirtualAssistantDocumentationEntry = (
+  entry: DocumentationEntry,
+): boolean =>
+  isValidVirtualAssistantDocumentationEntry(entry) &&
+  Boolean(entry.text ?? entry.markdownText);
+
 export class AssistantService {
   readonly applicationStore: GenericLegendApplicationStore;
-  private readonly searchEngine: Fuse<DocumentationEntry>;
   /**
    * This key is used to allow programmatic re-rendering of the assistant panel
    */
@@ -87,19 +109,28 @@ export class AssistantService {
   isHidden = false;
   isOpen = false;
   selectedTab = VIRTUAL_ASSISTANT_TAB.SEARCH;
+  currentDocumentationEntry: VirtualAssistantDocumentationEntry | undefined;
 
-  searchResults: VirtualAssistantDocumentationEntry[] = [];
-  searchState = ActionState.create().pass();
+  // search text
+  private readonly searchEngine: Fuse<DocumentationEntry>;
+  searchConfigurationState: TextSearchAdvancedConfigState;
+  searchState = ActionState.create();
   searchText = '';
+  searchResults: VirtualAssistantDocumentationEntry[] = [];
+  showSearchConfigurationMenu = false;
+  isOverSearchLimit = false;
 
   constructor(applicationStore: GenericLegendApplicationStore) {
     makeObservable(this, {
       isHidden: observable,
       isOpen: observable,
       panelRenderingKey: observable,
+      isOverSearchLimit: observable,
       selectedTab: observable,
       searchText: observable,
       searchResults: observable,
+      currentDocumentationEntry: observable,
+      showSearchConfigurationMenu: observable,
       currentContextualDocumentationEntry: computed,
       setIsHidden: action,
       setIsOpen: action,
@@ -107,17 +138,16 @@ export class AssistantService {
       setSearchText: action,
       resetSearch: action,
       search: action,
+      openDocumentationEntry: action,
       refreshPanelRendering: action,
+      setShowSearchConfigurationMenu: action,
     });
 
     this.applicationStore = applicationStore;
     this.searchEngine = new Fuse(
-      this.applicationStore.documentationService.getAllDocEntries().filter(
-        (entry) =>
-          // NOTE: since we're searching for user-friendly docs, we will discard anything that
-          // doesn't come with a title, or does not have any content/url
-          entry.title && (entry.url ?? entry.text ?? entry.markdownText),
-      ),
+      this.applicationStore.documentationService
+        .getAllDocEntries()
+        .filter(isValidVirtualAssistantDocumentationEntry),
       {
         includeScore: true,
         shouldSort: true,
@@ -143,8 +173,14 @@ export class AssistantService {
             weight: 1,
           },
         ],
+        // extended search allows for exact word match through single quote
+        // See https://fusejs.io/examples.html#extended-search
+        useExtendedSearch: true,
       },
     );
+    this.searchConfigurationState = new TextSearchAdvancedConfigState(() => {
+      this.search();
+    });
   }
 
   get currentContextualDocumentationEntry():
@@ -159,6 +195,7 @@ export class AssistantService {
       this.applicationStore.documentationService.getContextualDocEntry(
         currentContext,
       );
+
     return currentContextualDocumentationEntry
       ? new VirtualAssistantContextualDocumentationEntry(
           currentContext,
@@ -168,19 +205,28 @@ export class AssistantService {
               this.applicationStore.documentationService.getDocEntry(entry),
             )
             .filter(isNonNullable)
-            .filter(
-              (entry) =>
-                // NOTE: since we're searching for user-friendly docs, we will discard anything that
-                // doesn't come with a title, or does not have any content/url
-                //
-                // We could also consider having a flag in each documentation entry to be hidden from users
-                entry.title && (entry.url ?? entry.text ?? entry.markdownText),
-            )
+            .filter(isValidVirtualAssistantDocumentationEntry)
             .map((entry) => new VirtualAssistantDocumentationEntry(entry)),
         )
       : undefined;
   }
 
+  openDocumentationEntry(docKey: string): void {
+    const matchingDocEntry = this.applicationStore.documentationService
+      .getAllDocEntries()
+      .find((entry) => entry._documentationKey === docKey);
+
+    if (matchingDocEntry) {
+      this.setIsOpen(true);
+      this.setIsHidden(false);
+      this.currentDocumentationEntry = new VirtualAssistantDocumentationEntry(
+        matchingDocEntry,
+      );
+      this.currentDocumentationEntry.setIsOpen(true);
+      this.resetSearch();
+    }
+  }
+
   setIsHidden(val: boolean): void {
     this.isHidden = val;
   }
@@ -222,10 +268,39 @@ export class AssistantService {
   }
 
   search(): void {
+    if (!this.searchText) {
+      this.searchResults = [];
+      return;
+    }
+    this.currentDocumentationEntry = undefined;
     this.searchState.inProgress();
     this.searchResults = Array.from(
-      this.searchEngine.search(this.searchText).values(),
+      this.searchEngine
+        .search(
+          this.searchConfigurationState.generateSearchText(this.searchText),
+          {
+            // NOTE: search for limit + 1 item so we can know if there are more search results
+            limit: DOCUMENTATION_SEARCH_RESULTS_LIMIT + 1,
+          },
+        )
+        .values(),
     ).map((result) => new VirtualAssistantDocumentationEntry(result.item));
+
+    // check if the search results exceed the limit
+    if (this.searchResults.length > DOCUMENTATION_SEARCH_RESULTS_LIMIT) {
+      this.isOverSearchLimit = true;
+      this.searchResults = this.searchResults.slice(
+        0,
+        DOCUMENTATION_SEARCH_RESULTS_LIMIT,
+      );
+    } else {
+      this.isOverSearchLimit = false;
+    }
+
     this.searchState.complete();
   }
+
+  setShowSearchConfigurationMenu(val: boolean): void {
+    this.showSearchConfigurationMenu = val;
+  }
 }

package/src/stores/LegendApplicationDocumentation.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export enum LEGEND_APPLICATION_DOCUMENTATION_KEY {
+  QUESTION_HOW_TO_USE_ADVANCED_SEARCH_SYNTAX = 'question.how-to-use-advanced-search-syntax',
+}

package/src/stores/PureLanguageSupport.ts

@@ -124,10 +124,7 @@ const generateLanguageMonarch = (
       PURE_ELEMENT_NAME.MEASURE,
       PURE_ELEMENT_NAME.PROFILE,
       PURE_ELEMENT_NAME.FUNCTION,
-      PURE_ELEMENT_NAME.FLAT_DATA,
-      PURE_ELEMENT_NAME.DATABASE,
       PURE_ELEMENT_NAME.MAPPING,
-      PURE_ELEMENT_NAME.SERVICE,
       PURE_ELEMENT_NAME.RUNTIME,
       PURE_ELEMENT_NAME.CONNECTION,
       PURE_ELEMENT_NAME.FILE_GENERATION,
@@ -148,6 +145,9 @@ const generateLanguageMonarch = (
        * @modularize
        * See https://github.com/finos/legend-studio/issues/65
        */
+      PURE_ELEMENT_NAME.SERVICE,
+      PURE_ELEMENT_NAME.FLAT_DATA,
+      PURE_ELEMENT_NAME.DATABASE,
       PURE_CONNECTION_NAME.FLAT_DATA_CONNECTION,
       PURE_CONNECTION_NAME.RELATIONAL_DATABASE_CONNECTION,
       'Relational',

package/src/stores/shared/LambdaParameterState.ts

@@ -38,11 +38,13 @@ import {
 import {
   addUniqueEntry,
   deleteEntry,
+  type Hashable,
+  hashArray,
   IllegalStateError,
   isNonNullable,
   uuid,
 } from '@finos/legend-shared';
-import { makeObservable, observable, action } from 'mobx';
+import { makeObservable, observable, action, computed } from 'mobx';
 import {
   genericType_setRawType,
   multiplicity_setLowerBound,
@@ -54,6 +56,11 @@ export enum PARAMETER_SUBMIT_ACTION {
   EXPORT = 'EXPORT',
 }
 
+enum LAMABA_PARAMETER_HASH_STRUCTURE {
+  LAMBDA_PARAMETER_STATE = 'LAMBDA_PARAMETER_STATE',
+  LAMBDA_PARAMETERS_STATE = 'LAMBDA_PARAMETERS_STATE',
+}
+
 export const buildParametersLetLambdaFunc = (
   graph: PureModel,
   lambdaParametersStates: LambdaParameterState[],
@@ -87,11 +94,13 @@ export const buildParametersLetLambdaFunc = (
     .filter(isNonNullable);
   return letlambdaFunction;
 };
-export class LambdaParameterState {
+
+export class LambdaParameterState implements Hashable {
   readonly uuid = uuid();
   readonly parameter: VariableExpression;
   readonly graph: PureModel;
-  observableContext: ObserverContext;
+  readonly observableContext: ObserverContext;
+
   value: ValueSpecification | undefined;
 
   constructor(
@@ -103,12 +112,20 @@ export class LambdaParameterState {
       value: observable,
       setValue: action,
       mockParameterValue: action,
+      hashCode: computed,
     });
     this.observableContext = observableContext;
     this.parameter = observe_VariableExpression(variableExpression);
     this.graph = graph;
   }
 
+  get hashCode(): string {
+    return hashArray([
+      LAMABA_PARAMETER_HASH_STRUCTURE.LAMBDA_PARAMETER_STATE,
+      this.parameter,
+    ]);
+  }
+
   mockParameterValue(): void {
     this.setValue(
       generateVariableExpressionMockValue(this.parameter, this.graph),
@@ -204,10 +221,24 @@ export class ParameterInstanceValuesEditorState {
     this.setShowModal(false);
   }
 }
-export class LambdaParametersState {
+
+export class LambdaParametersState implements Hashable {
   parameterStates: LambdaParameterState[] = [];
   parameterValuesEditorState = new ParameterInstanceValuesEditorState();
 
+  constructor() {
+    makeObservable(this, {
+      hashCode: computed,
+    });
+  }
+
+  get hashCode(): string {
+    return hashArray([
+      LAMABA_PARAMETER_HASH_STRUCTURE.LAMBDA_PARAMETERS_STATE,
+      hashArray(this.parameterStates),
+    ]);
+  }
+
   addParameter(val: LambdaParameterState): void {
     addUniqueEntry(this.parameterStates, val);
   }
@@ -215,6 +246,7 @@ export class LambdaParametersState {
   removeParameter(val: LambdaParameterState): void {
     deleteEntry(this.parameterStates, val);
   }
+
   setParameters(val: LambdaParameterState[]): void {
     this.parameterStates = val;
   }

package/src/stores/shared/TextSearchAdvancedConfigState.ts

@@ -0,0 +1,65 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { action, computed, makeObservable, observable } from 'mobx';
+
+export enum ADVANCED_TEXT_SEARCH_MODE {
+  STANDARD = 'standard',
+  INCLUDE = 'include match',
+  EXACT = 'exact match',
+  INVERSE = 'excludes exact match',
+}
+
+export class TextSearchAdvancedConfigState {
+  currentMode = ADVANCED_TEXT_SEARCH_MODE.STANDARD;
+  onSearchModeChange: () => void;
+
+  constructor(onSearchModeChange: () => void) {
+    makeObservable(this, {
+      currentMode: observable,
+      isAdvancedSearchActive: computed,
+      setCurrentMode: action,
+    });
+
+    this.onSearchModeChange = onSearchModeChange;
+  }
+
+  get isAdvancedSearchActive(): boolean {
+    return this.currentMode !== ADVANCED_TEXT_SEARCH_MODE.STANDARD;
+  }
+
+  generateSearchText(val: string): string {
+    switch (this.currentMode) {
+      case ADVANCED_TEXT_SEARCH_MODE.INCLUDE: {
+        return `'"${val}"`;
+      }
+      case ADVANCED_TEXT_SEARCH_MODE.EXACT: {
+        return `="${val}"`;
+      }
+      case ADVANCED_TEXT_SEARCH_MODE.INVERSE: {
+        return `!"${val}"`;
+      }
+      default: {
+        return val;
+      }
+    }
+  }
+
+  setCurrentMode(val: ADVANCED_TEXT_SEARCH_MODE): void {
+    this.currentMode = val;
+    this.onSearchModeChange();
+  }
+}

package/tsconfig.json

@@ -40,6 +40,7 @@
     "./src/stores/AssistantService.ts",
     "./src/stores/DocumentationService.ts",
     "./src/stores/EventService.ts",
+    "./src/stores/LegendApplicationDocumentation.ts",
     "./src/stores/LegendApplicationPlugin.ts",
     "./src/stores/PureLanguageSupport.ts",
     "./src/stores/WebApplicationNavigator.ts",
@@ -47,6 +48,7 @@
     "./src/stores/shared/LambdaEditorState.ts",
     "./src/stores/shared/LambdaParameterState.ts",
     "./src/stores/shared/PackageableElementOption.ts",
+    "./src/stores/shared/TextSearchAdvancedConfigState.ts",
     "./src/stores/shared/ValueSpecificationModifierHelper.ts",
     "./src/application/LegendApplication.tsx",
     "./src/application/LegendApplicationPluginManager.tsx",
@@ -67,6 +69,7 @@
     "./src/components/shared/LambdaParameterValuesEditor.tsx",
     "./src/components/shared/PackageableElementOptionRenderer.tsx",
     "./src/components/shared/TextInputEditor.tsx",
+    "./src/components/shared/TextSearchAdvancedConfigMenu.tsx",
     "./src/components/shared/execution-plan-viewer/ExecutionPlanViewer.tsx",
     "./src/components/shared/execution-plan-viewer/SQLExecutionNodeViewer.tsx",
     "./src/stores/CJS__Fuse.cts"