@finos/legend-application 15.0.75 → 15.1.0

package/src/components/ReleaseNotesManager.tsx

@@ -0,0 +1,247 @@
+/**
+ * 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 { observer } from 'mobx-react-lite';
+import { useApplicationStore } from './ApplicationStoreProvider.js';
+import {
+  ArrowCircleUpIcon,
+  BugIcon,
+  Dialog,
+  Modal,
+  ModalBody,
+  ModalFooter,
+  ModalFooterButton,
+  ModalHeader,
+  ShareIcon,
+  clsx,
+} from '@finos/legend-art';
+import {
+  RELEASE_UPDATE_TYPE,
+  type ReleaseNote,
+  type VersionReleaseNotes,
+} from '../stores/ReleaseNotesService.js';
+import {
+  isValidUrl,
+  prettyCONSTName,
+  returnUndefOnError,
+} from '@finos/legend-shared';
+
+const ReleaseNoteViewer = observer((props: { note: ReleaseNote }) => {
+  const { note } = props;
+  const applicationStore = useApplicationStore();
+  const isBug = note.type === RELEASE_UPDATE_TYPE.BUG_FIX;
+  const visitLink = (): void => {
+    if (note.docLink && isValidUrl(note.docLink)) {
+      applicationStore.navigationService.navigator.visitAddress(note.docLink);
+    }
+  };
+
+  return (
+    <div className="release-viewer__update__item" key={note.description}>
+      <div
+        className={clsx('release-viewer__update__item-btn', {
+          'release-viewer__update__item-btn-bug': isBug,
+        })}
+      >
+        {isBug ? <BugIcon /> : <ArrowCircleUpIcon />}
+      </div>
+      <div className="release-viewer__update__description">
+        {note.description}
+      </div>
+      {note.docLink && (
+        <div className="release-viewer__update__link">
+          <button
+            className="release-viewer__update__link-btn"
+            title="Visit..."
+            onClick={visitLink}
+          >
+            <ShareIcon />
+          </button>
+        </div>
+      )}
+    </div>
+  );
+});
+
+export const ReleaseViewer = observer(
+  (props: { releaseNotes: VersionReleaseNotes }) => {
+    const { releaseNotes } = props;
+    const enhancements =
+      releaseNotes.notes?.filter(
+        (r) => r.type === RELEASE_UPDATE_TYPE.ENHANCEMENT,
+      ) ?? [];
+    const bugFixes =
+      releaseNotes.notes?.filter(
+        (r) => r.type === RELEASE_UPDATE_TYPE.BUG_FIX,
+      ) ?? [];
+
+    return (
+      <div className="release-viewer">
+        <div className="release-viewer__version">
+          Version {releaseNotes.label ?? releaseNotes.version}
+        </div>
+        <div className="release-viewer__content">
+          {Boolean(enhancements.length) && (
+            <div className="release-viewer__update">
+              <div className="release-viewer__update-type">ENHANCEMENTS</div>
+              <div className="release-viewer__update__items">
+                {enhancements.map((e) => (
+                  <ReleaseNoteViewer note={e} key={e.description} />
+                ))}
+              </div>
+            </div>
+          )}
+          {Boolean(bugFixes.length) && (
+            <div className="release-viewer__update">
+              <div className="release-viewer__update-type">BUG FIXES</div>
+              <div className="release-viewer__update__items">
+                {bugFixes.map((e) => (
+                  <ReleaseNoteViewer note={e} key={e.description} />
+                ))}
+              </div>
+            </div>
+          )}
+        </div>
+      </div>
+    );
+  },
+);
+
+export const ReleaseNotesManager = observer(() => {
+  const applicationStore = useApplicationStore();
+  const releaseService = applicationStore.releaseNotesService;
+  const releaseNotes = releaseService.releaseNotes;
+  const version = applicationStore.config.appVersion;
+  const currentVersion = releaseNotes?.find((r) => r.version === version);
+  const storage = returnUndefOnError(() => releaseService.getViewedVersions());
+  const isOpen = releaseService.showCurrentReleaseModal;
+  if (
+    !releaseService.isConfigured ||
+    !isOpen ||
+    !currentVersion ||
+    storage === version
+  ) {
+    return null;
+  }
+
+  const closeModal = (): void => {
+    releaseService.updateViewedVersion(currentVersion.version);
+    releaseService.setShowCurrentRelease(false);
+  };
+  const title = `Legend ${prettyCONSTName(
+    applicationStore.config.appName,
+  )} has been upgraded !`;
+  return (
+    <Dialog
+      open={isOpen}
+      onClose={closeModal}
+      classes={{
+        root: 'release-notes__root-container',
+        container: 'release-notes__container',
+      }}
+    >
+      <Modal
+        darkMode={
+          !applicationStore.layoutService.TEMPORARY__isLightColorThemeEnabled
+        }
+        className="editor-modal release-notes__dialog"
+      >
+        <ModalHeader
+          className="release-notes__dialog__header__title"
+          title={title}
+        />
+
+        <ModalBody className="release-notes__dialog__body">
+          <div className="release-notes__dialog__content">
+            <div className="release-notes__dialog__content__title">
+              New features, enhancements and bug fixess that were released
+            </div>
+            <ReleaseViewer releaseNotes={currentVersion} />
+          </div>
+        </ModalBody>
+        <ModalFooter>
+          <ModalFooterButton
+            className="modal__footer__close-btn"
+            onClick={closeModal}
+            type={'primary'}
+          >
+            Close
+          </ModalFooterButton>
+        </ModalFooter>
+      </Modal>
+    </Dialog>
+  );
+});
+
+export const ReleaseLogManager = observer(() => {
+  const applicationStore = useApplicationStore();
+  const releaseService = applicationStore.releaseNotesService;
+
+  if (!releaseService.isConfigured || !releaseService.showReleaseLog) {
+    return null;
+  }
+  const releaseNotes = releaseService.releaseNotes ?? [];
+
+  const isOpen = releaseService.showCurrentReleaseModal;
+  const closeModal = (): void => {
+    releaseService.setReleaseLog(false);
+  };
+  const title = `Legend ${prettyCONSTName(
+    applicationStore.config.appName,
+  )} Release Log`;
+  return (
+    <Dialog
+      open={isOpen}
+      onClose={closeModal}
+      classes={{
+        root: 'release-notes__root-container',
+        container: 'release-notes__container',
+      }}
+    >
+      <Modal
+        darkMode={
+          !applicationStore.layoutService.TEMPORARY__isLightColorThemeEnabled
+        }
+        className="editor-modal release-notes__dialog"
+      >
+        <ModalHeader
+          className="release-notes__dialog__header__title"
+          title={title}
+        />
+
+        <ModalBody className="release-notes__dialog__body">
+          <div className="release-notes__dialog__content">
+            <div className="release-notes__dialog__content__title">
+              New features, enhancements and bug fixess that were released
+            </div>
+            {releaseNotes.map((e) => (
+              <ReleaseViewer key={e.version} releaseNotes={e} />
+            ))}
+          </div>
+        </ModalBody>
+        <ModalFooter>
+          <ModalFooterButton
+            className="modal__footer__close-btn"
+            onClick={closeModal}
+            type={'primary'}
+          >
+            Close
+          </ModalFooterButton>
+        </ModalFooter>
+      </Modal>
+    </Dialog>
+  );
+});

package/src/components/VirtualAssistant.tsx

@@ -768,6 +768,9 @@ export const VirtualAssistant = observer(() => {
       bounds="parent"
       onStart={onDragStart}
       onStop={onDragEnd}
+      // Avoid using deprecated findDOMNode method to rid of React warning
+      // See https://github.com/react-grid-layout/react-draggable/issues/749
+      nodeRef={assistantRef}
       // limit the dnd trigger to only the drag handle
       handle=".virtual-assistant__station__drag-handle"
     >

package/src/index.ts

@@ -55,6 +55,7 @@ export * from './stores/event/IframeEventNotifierPlugin.js';
 export * from './stores/TelemetryService.js';
 export * from './stores/NotificationService.js';
 export * from './stores/AlertService.js';
+export * from './stores/ReleaseNotesService.js';
 export * from './stores/AssistantService.js';
 export * from './stores/ApplicationNavigationContextService.js';
 export * from './stores/LegendApplicationPlugin.js';

package/src/stores/ApplicationStore.ts

@@ -49,6 +49,7 @@ import { SettingService } from './SettingService.js';
 import { DefaultNavigator } from './navigation/DefaultNavigator.js';
 import type { ApplicationPlatform } from './platform/ApplicationPlatform.js';
 import { UserDataService } from './UserDataService.js';
+import { ReleaseNotesService } from './ReleaseNotesService.js';
 
 export type GenericLegendApplicationStore = ApplicationStore<
   LegendApplicationConfig,
@@ -105,6 +106,9 @@ export class ApplicationStore<
   readonly documentationService: DocumentationService;
   readonly assistantService: AssistantService;
 
+  // release
+  readonly releaseNotesService: ReleaseNotesService;
+
   // event
   readonly eventService: EventService;
   readonly telemetryService: TelemetryService;
@@ -138,6 +142,7 @@ export class ApplicationStore<
 
     this.documentationService = new DocumentationService(this);
     this.assistantService = new AssistantService(this);
+    this.releaseNotesService = new ReleaseNotesService(this);
 
     this.eventService = new EventService();
     this.eventService.registerEventNotifierPlugins(

package/src/stores/ReleaseNotesService.ts

@@ -0,0 +1,104 @@
+/**
+ * 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 { guaranteeNonEmptyString } from '@finos/legend-shared';
+import type { GenericLegendApplicationStore } from './ApplicationStore.js';
+import { action, makeObservable, observable } from 'mobx';
+
+export enum RELEASE_UPDATE_TYPE {
+  BUG_FIX = 'BUG_FIX',
+  ENHANCEMENT = 'ENHANCEMENT',
+}
+
+export interface ReleaseNote {
+  type: RELEASE_UPDATE_TYPE;
+  description: string;
+  docLink?: string | undefined;
+}
+
+export interface VersionReleaseNotes {
+  version: string;
+  label?: string | undefined;
+  docLink?: string | undefined;
+  notes?: ReleaseNote[] | undefined;
+}
+
+export const collectReleaseNotes = (
+  releaseNotes: VersionReleaseNotes[],
+): VersionReleaseNotes[] =>
+  releaseNotes.map((release) => {
+    guaranteeNonEmptyString(
+      release.version,
+      "Release notes 'version' is missing",
+    );
+    release.notes?.map((note) => {
+      guaranteeNonEmptyString(note.type, "Release note 'type' is missing");
+      guaranteeNonEmptyString(
+        note.description,
+        "Release note 'description' is missing",
+      );
+      return note;
+    });
+    return release;
+  });
+
+export class ReleaseNotesService {
+  static STORAGE_NAME = 'application.release-notes.lastOpenedVersion';
+  applicationStore: GenericLegendApplicationStore;
+  releaseNotes: VersionReleaseNotes[] | undefined;
+  showCurrentReleaseModal = true;
+  showReleaseLog = false;
+  isConfigured = false;
+
+  constructor(applicationStore: GenericLegendApplicationStore) {
+    makeObservable(this, {
+      showCurrentReleaseModal: observable,
+      showReleaseLog: observable,
+      isConfigured: observable,
+      setShowCurrentRelease: action,
+      configure: action,
+      updateViewedVersion: action,
+      setReleaseLog: action,
+    });
+    this.applicationStore = applicationStore;
+  }
+
+  configure(releaseNotes: VersionReleaseNotes[]): void {
+    this.isConfigured = true;
+    this.releaseNotes = collectReleaseNotes(releaseNotes);
+  }
+
+  setShowCurrentRelease(val: boolean): void {
+    this.showCurrentReleaseModal = val;
+  }
+
+  setReleaseLog(val: boolean): void {
+    this.showReleaseLog = val;
+  }
+
+  getViewedVersions(): string | undefined {
+    return this.applicationStore.settingService.getStringValue(
+      ReleaseNotesService.STORAGE_NAME,
+    );
+  }
+
+  updateViewedVersion(version: string): void {
+    return this.applicationStore.settingService.persistValue(
+      ReleaseNotesService.STORAGE_NAME,
+      version,
+    );
+  }
+}

package/src/stores/terminal/XTerm.ts

@@ -567,8 +567,8 @@ export class XTerm extends Terminal {
       abs_cursorY > buffer.viewportY + rows
         ? abs_cursorY - (buffer.viewportY + rows)
         : abs_cursorY < buffer.viewportY
-        ? abs_cursorY - buffer.viewportY
-        : 0;
+          ? abs_cursorY - buffer.viewportY
+          : 0;
 
     return {
       // NOTE: currently, there is a design limitation with programmatically set the cursor using escape sequence

package/tsconfig.json

@@ -24,7 +24,23 @@
     "outDir": "./lib",
     "tsBuildInfoFile": "./build/prod.tsbuildinfo",
     "rootDir": "./src",
-    "jsx": "react-jsx"
+    "jsx": "react-jsx",
+    "moduleResolution": "nodenext",
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "preserveConstEnums": true,
+    "incremental": true,
+    "useDefineForClassFields": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": true,
+    "alwaysStrict": true,
+    "useUnknownInCatchVariables": true
   },
   "references": [
     {
@@ -58,6 +74,7 @@
     "./src/stores/LayoutService.ts",
     "./src/stores/LegendApplicationPlugin.ts",
     "./src/stores/NotificationService.ts",
+    "./src/stores/ReleaseNotesService.ts",
     "./src/stores/SettingService.ts",
     "./src/stores/TelemetryService.ts",
     "./src/stores/TerminalService.ts",
@@ -84,6 +101,7 @@
     "./src/components/BlockingAlert.tsx",
     "./src/components/BrowserEnvironmentProvider.tsx",
     "./src/components/NotificationManager.tsx",
+    "./src/components/ReleaseNotesManager.tsx",
     "./src/components/VirtualAssistant.tsx",
     "./src/components/useApplicationNavigationContext.tsx",
     "./src/components/useCommands.tsx",

package/tsconfig.package.json

@@ -23,7 +23,23 @@
     "forceConsistentCasingInFileNames": true,
     "outDir": "./lib",
     "tsBuildInfoFile": "./build/package.tsbuildinfo",
-    "rootDir": "./"
+    "rootDir": "./",
+    "moduleResolution": "nodenext",
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "preserveConstEnums": true,
+    "incremental": true,
+    "useDefineForClassFields": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": true,
+    "alwaysStrict": true,
+    "useUnknownInCatchVariables": true
   },
   "files": [
     "./package.json"