feat(crud): Bulk update modal COMPASS-7325 (#5007)

* WIP

* WIP

* WIP

* tweaks

* WIP

* fix existing tests

* run the update

* one line filter

* style tweaks

* tests

* tweak copy/pasted message..

* add updateMany type

* add a test for updateMany

* deps

* dep

* same styling for filter/query as delete modal

* don't replace

* align the preview and filter

* just pass change.after

* better hack

* Revert "just pass change.after"

This reverts commit 2e38636.

packages/compass-aggregations/src/components/stage-editor/stage-editor.tsx

@@ -35,14 +35,6 @@ const editorContainerStyles = css({
   height: '100%',
 });
 
-const codeEditorContainerStyles = css({
-  flex: 1,
-  flexShrink: 0,
-  margin: 0,
-  width: '100%',
-  minHeight: '230px',
-});
-
 const editorContainerStylesDark = css({
   background: palette.gray.dark4,
 });
@@ -51,6 +43,14 @@ const editorContainerStylesLight = css({
   background: palette.gray.light3,
 });
 
+const codeEditorContainerStyles = css({
+  flex: 1,
+  flexShrink: 0,
+  margin: 0,
+  width: '100%',
+  minHeight: '230px',
+});
+
 // We use custom color here so need to disable default one that we use
 // everywhere else
 const codeEditorStyles = css({

packages/compass-crud/package.json

@@ -82,6 +82,7 @@
     "chai-as-promised": "^7.1.1",
     "classnames": "^2.2.6",
     "depcheck": "^1.4.1",
+    "ejson-shell-parser": "^1.2.4",
     "electron": "^25.8.4",
     "enzyme": "^3.11.0",
     "eslint": "^7.25.0",

packages/compass-crud/src/actions/index.ts

@@ -5,6 +5,7 @@ const configureActions = () => {
     'addColumn',
     'cleanCols',
     'closeInsertDocumentDialog',
+    'closeBulkUpdateDialog',
     'copyToClipboard',
     'documentRemoved',
     'drillDown',
@@ -18,6 +19,9 @@ const configureActions = () => {
     'toggleInsertDocumentView',
     'toggleInsertDocument',
     'openInsertDocumentDialog',
+    'openBulkUpdateDialog',
+    'updateBulkUpdatePreview',
+    'runBulkUpdate',
     'openExportFileDialog',
     'openImportFileDialog',
     'pathChanged',

packages/compass-crud/src/components/bulk-update-dialog.tsx

@@ -0,0 +1,307 @@
+import React, { useMemo, useState } from 'react';
+import Document from './document';
+import HadronDocument from 'hadron-document';
+
+import { toJSString } from 'mongodb-query-parser';
+
+import {
+  FormModal,
+  css,
+  cx,
+  spacing,
+  palette,
+  Label,
+  Banner,
+  BannerVariant,
+  KeylineCard,
+  Description,
+  Link,
+  InfoSprinkle,
+  useDarkMode,
+  TextInput,
+} from '@mongodb-js/compass-components';
+
+import type { Annotation } from '@mongodb-js/compass-editor';
+import { CodemirrorMultilineEditor } from '@mongodb-js/compass-editor';
+
+import type { BSONObject } from '../stores/crud-store';
+import type { UpdatePreview } from 'mongodb-data-service';
+
+const columnsStyles = css({
+  marginTop: spacing[4],
+  display: 'grid',
+  width: '100%',
+  gap: spacing[4],
+  gridTemplateColumns: 'repeat(2, minmax(0, 1fr))',
+});
+
+const queryStyles = css({
+  display: 'flex',
+  gap: spacing[4],
+  flexDirection: 'column',
+});
+
+const queryFieldStyles = css({});
+
+const updateFieldStyles = css({
+  flex: 1,
+});
+
+const descriptionStyles = css({
+  marginBottom: spacing[2],
+});
+
+const previewStyles = css({
+  contain: 'size',
+  overflow: 'scroll',
+});
+
+const previewDescriptionStyles = css({
+  display: 'inline',
+});
+
+const codeContainerStyles = css({
+  paddingTop: spacing[2],
+  paddingBottom: spacing[2],
+});
+
+const codeDarkContainerStyles = css({
+  background: palette.gray.dark4,
+});
+
+const codeLightContainerStyles = css({
+  backgroundColor: palette.gray.light3,
+});
+
+const multilineContainerStyles = css({
+  maxHeight: spacing[4] * 20,
+});
+
+// We use custom color here so need to disable default one that we use
+// everywhere else
+const codeEditorStyles = css({
+  background: 'transparent !important',
+  '& .cm-gutters': {
+    background: 'transparent !important',
+  },
+  '& .cm-editor': {
+    background: 'transparent !important',
+  },
+});
+
+const bannerContainerStyles = css({
+  // don't jump when an error appears
+  minHeight: spacing[4] * 2 + 2,
+  overflow: 'hidden',
+});
+
+const bannerStyles = css({
+  flex: 'none',
+  marginTop: spacing[2],
+  marginLeft: spacing[2],
+  marginRight: spacing[2],
+  textAlign: 'left',
+});
+
+const updatePreviewStyles = css({
+  display: 'flex',
+  flexDirection: 'column',
+  gap: spacing[3],
+});
+
+export type BulkUpdateDialogProps = {
+  isOpen: boolean;
+  ns: string;
+  filter: BSONObject;
+  count?: number;
+  updateText: string;
+  preview: UpdatePreview;
+  syntaxError?: Error & { loc?: { index: number } };
+  serverError?: Error;
+  closeBulkUpdateDialog: () => void;
+  updateBulkUpdatePreview: (updateText: string) => void;
+  runBulkUpdate: () => void;
+};
+
+type QueryLabelProps = {
+  tooltip: string;
+  label: string;
+};
+
+const queryLabelStyles = css({
+  display: 'flex',
+  gap: spacing[2],
+  alignItems: 'center',
+  height: '17px', // align with the Preview label
+});
+
+const QueryLabel: React.FunctionComponent<QueryLabelProps> = ({
+  tooltip,
+  label,
+}) => {
+  return (
+    <div className={queryLabelStyles}>
+      <Label htmlFor="template-dropdown">{label}</Label>
+      <InfoSprinkle align="right">{tooltip}</InfoSprinkle>
+    </div>
+  );
+};
+
+export default function BulkUpdateDialog({
+  isOpen,
+  ns,
+  filter,
+  count,
+  updateText,
+  preview,
+  syntaxError,
+  serverError,
+  closeBulkUpdateDialog,
+  updateBulkUpdatePreview,
+  runBulkUpdate,
+}: BulkUpdateDialogProps) {
+  const darkMode = useDarkMode();
+
+  const [text, setText] = useState(updateText);
+
+  const previewDocuments = useMemo(() => {
+    return preview.changes.map(
+      (change) => new HadronDocument(change.after as Record<string, unknown>)
+    );
+  }, [preview]);
+
+  const onChangeText = (value: string) => {
+    setText(value);
+    updateBulkUpdatePreview(value);
+  };
+
+  const title =
+    count === undefined ? 'Update documents' : `Update documents (${count})`;
+
+  const annotations = useMemo<Annotation[]>(() => {
+    if (syntaxError?.loc?.index) {
+      return [
+        {
+          message: syntaxError.message,
+          severity: 'error',
+          from: syntaxError.loc.index,
+          to: syntaxError.loc.index,
+        },
+      ];
+    }
+
+    return [];
+  }, [syntaxError]);
+
+  return (
+    <FormModal
+      title={title}
+      subtitle={ns}
+      size="large"
+      open={isOpen}
+      onSubmit={runBulkUpdate}
+      onCancel={closeBulkUpdateDialog}
+      cancelButtonText="Close"
+      submitButtonText="Update documents"
+      submitDisabled={!!(syntaxError || serverError)}
+    >
+      <div className={columnsStyles}>
+        <div className={queryStyles}>
+          <div className={queryFieldStyles}>
+            <TextInput
+              // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+              // @ts-ignore the label can be any component, but it's weirdly typed to string
+              label={
+                <QueryLabel
+                  label="Filter"
+                  tooltip="Return to the Documents tab to edit this query."
+                />
+              }
+              disabled={true}
+              value={toJSString(filter) ?? ''}
+            />
+          </div>
+
+          <div className={cx(queryFieldStyles, updateFieldStyles)}>
+            <Label htmlFor="bulk-update-update">Update</Label>
+            <Description className={descriptionStyles}>
+              <Link href="https://www.mongodb.com/docs/manual/reference/method/db.collection.updateMany/#std-label-update-many-update">
+                Learn more about Update syntax
+              </Link>
+            </Description>
+            <KeylineCard
+              className={cx(
+                codeContainerStyles,
+                multilineContainerStyles,
+                darkMode ? codeDarkContainerStyles : codeLightContainerStyles
+              )}
+            >
+              <CodemirrorMultilineEditor
+                text={text}
+                onChangeText={onChangeText}
+                id="bulk-update-update"
+                data-testid="bulk-update-update"
+                onBlur={() => ({})}
+                className={codeEditorStyles}
+                annotations={annotations}
+              />
+
+              <div className={bannerContainerStyles}>
+                {syntaxError && (
+                  <Banner
+                    variant={BannerVariant.Warning}
+                    className={bannerStyles}
+                  >
+                    {syntaxError.message}
+                  </Banner>
+                )}
+                {serverError && !syntaxError && (
+                  <Banner
+                    variant={BannerVariant.Danger}
+                    className={bannerStyles}
+                  >
+                    {serverError.message}
+                  </Banner>
+                )}
+              </div>
+            </KeylineCard>
+          </div>
+        </div>
+        <div className={previewStyles}>
+          <Label htmlFor="bulk-update-preview">
+            Preview{' '}
+            <Description className={previewDescriptionStyles}>
+              (sample of {preview.changes.length} document
+              {preview.changes.length !== 1 && 's'})
+            </Description>
+          </Label>
+          <div className={updatePreviewStyles}>
+            {previewDocuments.map((doc: HadronDocument, index: number) => {
+              return (
+                <UpdatePreviewDocument
+                  key={`change=${index}`}
+                  data-testid="bulk-update-preview-document"
+                  doc={doc}
+                />
+              );
+            })}
+          </div>
+        </div>
+      </div>
+    </FormModal>
+  );
+}
+
+function UpdatePreviewDocument({
+  doc,
+  ...props
+}: {
+  'data-testid': string;
+  doc: HadronDocument;
+}) {
+  return (
+    <KeylineCard data-testid={props['data-testid']}>
+      <Document doc={doc} editable={false} />
+    </KeylineCard>
+  );
+}