feat: add remaining modifiers to NoteLookup (#1056)

hikchoi · web-flow · commit 49c6005d2a2c · 2021-08-03T17:31:01.000-07:00
* feat: Add horizontal split modifier to lookup v3 (#1045) * feat: add horizontal split modifier * chore: add tests for horizontal split modifier * fix: remove .only from test * feat: add effects modifier to lookup v3 (#1046) * feat: add copy note link button to lookup v3 * chore: add test for copy note link button * chore: add tests for journal and selection2link interactions * chore: add tests for scratch and selection2link interactions * chore: add tests for note modifiers and selectionExtract interactions * chore: add tests for multiselect and split interaction * chore: add tests for multiselect and copyNoteLink interaction * chore: fix typo * spike: fix test * chore: skip copyNoteLink basic test * chore: change button sequence to match v2 * fix: make note type modifier buttons idempotent * chore: enable skipped tests * chore: remove debug log * spike: copyNoteLink failing test * fix: addBehavior not applied to quickpick values * fix: remove unnecessary .show() calls * fix: properly check empty initial value when creating quickpick * fix: dispose quickpick before calling controller onHide
diff --git a/packages/plugin-core/src/commands/CreateDailyJournal.ts b/packages/plugin-core/src/commands/CreateDailyJournal.ts
@@ -24,7 +24,7 @@ export class CreateDailyJournalCommand extends BaseCommand<
   key = DENDRON_COMMANDS.CREATE_DAILY_JOURNAL_NOTE.key;
   async gatherInputs(): Promise<CommandInput | undefined> {
     const dailyJournalDomain = getWS().config.journal.dailyDomain;
-    const fname = DendronClientUtilsV2.genNoteName("JOURNAL", {
+    const { noteName: fname } = DendronClientUtilsV2.genNoteName("JOURNAL", {
       overrides: { domain: dailyJournalDomain },
     });
     return { title: fname };
diff --git a/packages/plugin-core/src/commands/LookupCommand.ts b/packages/plugin-core/src/commands/LookupCommand.ts
@@ -8,10 +8,18 @@ import { AnalyticsUtils } from "../utils/analytics";
 import { BasicCommand } from "./base";
 
 export type LookupEffectType = "copyNoteLink" | "copyNoteRef" | "multiSelect";
+export enum LookupEffectTypeEnum {
+  "copyNoteLink" = "copyNoteLink",
+  "copyNoteRef" = "copyNoteRef",
+  "multiSelect" = "multiSelect",
+}
 export type LookupFilterType = "directChildOnly";
 export type LookupSelectionType = "selection2link" | "selectionExtract";
 export type LookupNoteType = LookupNoteTypeEnum;
 export type LookupSplitType = "horizontal";
+export enum LookupSplitTypeEnum {
+  "horizontal" = "horizontal",
+}
 export type LookupNoteExistBehavior = "open" | "overwrite";
 export enum LookupNoteTypeEnum {
   "journal" = "journal",
diff --git a/packages/plugin-core/src/commands/NoteLookupCommand.ts b/packages/plugin-core/src/commands/NoteLookupCommand.ts
@@ -13,8 +13,10 @@ import {
   JournalBtn,
   ScratchBtn,
   MultiSelectBtn,
+  CopyNoteLinkBtn,
   Selection2LinkBtn,
   SelectionExtractBtn,
+  HorizontalSplitBtn,
 } from "../components/lookup/buttons";
 import { LookupControllerV3 } from "../components/lookup/LookupControllerV3";
 import {
@@ -39,15 +41,18 @@ import {
   LookupNoteTypeEnum,
   LookupSelectionType,
   LookupSelectionTypeEnum,
+  LookupSplitType,
+  LookupSplitTypeEnum,
 } from "./LookupCommand";
 
-type CommandRunOpts = {
+export type CommandRunOpts = {
   initialValue?: string;
   noConfirm?: boolean;
   fuzzThreshold?: number;
   multiSelect?: boolean;
   noteType?: LookupNoteType;
   selectionType?: LookupSelectionType;
+  splitType?: LookupSplitType;
   /**
    * NOTE: currently, only one filter is supported
    */
@@ -137,14 +142,16 @@ export class NoteLookupCommand extends BaseCommand<
       ),
       extraButtons: [
         //todo: mirror v2 button sequence
-        JournalBtn.create(copts.noteType === LookupNoteTypeEnum.journal),
-        ScratchBtn.create(copts.noteType === LookupNoteTypeEnum.scratch),
         MultiSelectBtn.create(copts.multiSelect),
+        CopyNoteLinkBtn.create(),
         DirectChildFilterBtn.create(
           copts.filterMiddleware?.includes("directChildOnly")
         ),
-        Selection2LinkBtn.create(copts.selectionType === LookupSelectionTypeEnum.selection2link),
         SelectionExtractBtn.create(copts.selectionType === LookupSelectionTypeEnum.selectionExtract),
+        Selection2LinkBtn.create(copts.selectionType === LookupSelectionTypeEnum.selection2link),
+        JournalBtn.create(copts.noteType === LookupNoteTypeEnum.journal),
+        ScratchBtn.create(copts.noteType === LookupNoteTypeEnum.scratch),
+        HorizontalSplitBtn.create(copts.splitType === LookupSplitTypeEnum.horizontal),
       ],
     });
     this._provider = new NoteLookupProvider("lookup", {
diff --git a/packages/plugin-core/src/components/lookup/LookupControllerV2.ts b/packages/plugin-core/src/components/lookup/LookupControllerV2.ts
@@ -267,16 +267,18 @@ export class LookupControllerV2 {
 
     switch (noteResp?.type) {
       case "journal": {
-        onUpdateValue = DendronClientUtilsV2.genNoteName("JOURNAL", {
+        const { noteName } = DendronClientUtilsV2.genNoteName("JOURNAL", {
           overrides: { domain: quickPickValue },
         });
+        onUpdateValue = noteName;
         onUpdateReason = "updatePickerBehavior:journal";
         break;
       }
       case "scratch": {
-        onUpdateValue = DendronClientUtilsV2.genNoteName("SCRATCH", {
+        const { noteName } = DendronClientUtilsV2.genNoteName("SCRATCH", {
           overrides: { domain: quickPickValue },
         });
+        onUpdateValue = noteName;
         onUpdateReason = "updatePickerBehavior:scratch";
         break;
       }
diff --git a/packages/plugin-core/src/components/lookup/LookupControllerV3.ts b/packages/plugin-core/src/components/lookup/LookupControllerV3.ts
@@ -117,7 +117,10 @@ export class LookupControllerV3 {
     PickerUtilsV2.refreshButtons({ quickpick, buttons, buttonsPrev });
     await PickerUtilsV2.refreshPickerBehavior({ quickpick, buttons });
     quickpick.onDidTriggerButton(this.onTriggerButton);
-    quickpick.onDidHide(this.onHide);
+    quickpick.onDidHide(() => {
+      quickpick.dispose();
+      this.onHide();
+    });
     provider.provide(this);
     return { quickpick };
   }
@@ -160,14 +163,10 @@ export class LookupControllerV3 {
   }
 
   onHide() {
-    const { _quickpick: quickpick } = this;
-    if (!quickpick) {
-      return;
-    }
-    quickpick.dispose();
     this._quickpick = undefined;
     this._cancelTokenSource?.dispose();
   }
+  
 
   onTriggerButton = async (btn: QuickInputButton) => {
     const { _quickpick: quickpick } = this;
diff --git a/packages/plugin-core/src/components/lookup/buttons.ts b/packages/plugin-core/src/components/lookup/buttons.ts
@@ -19,7 +19,7 @@ import {
 } from "../../commands/LookupCommand";
 import { clipboard, DendronClientUtilsV2, VSCodeUtils } from "../../utils";
 import { DendronQuickPickerV2 } from "./types";
-import { PickerUtilsV2 } from "./utils";
+import { NotePickerUtils, PickerUtilsV2 } from "./utils";
 
 export type ButtonType =
   | LookupEffectType
@@ -83,7 +83,6 @@ function isSplitButton(button: DendronBtn) {
   return _.includes(["horizontal", "vertical"], button.type);
 }
 
-// TODO: make it into a utils method?
 const selectionToNoteProps = async (opts: {
   selectionType: string;
   note: NoteProps;
@@ -93,7 +92,7 @@ const selectionToNoteProps = async (opts: {
   const { document, range } = resp || {};
   const { selectionType, note } = opts;
   const { selection, text } = VSCodeUtils.getSelection();
-  //TODO: split these up?
+
   switch(selectionType) {
     case "selectionExtract": {
       if (!_.isUndefined(document)) {
@@ -209,16 +208,25 @@ export class Selection2LinkBtn extends DendronBtn {
       });
     };
     
-    quickPick.rawValue = quickPick.value;
+    quickPick.prevValue = quickPick.value;
     const { text } = VSCodeUtils.getSelection();
     const slugger = getSlugger();
-    quickPick.value = [quickPick.value, slugger.slug(text!)].join(".");
+    quickPick.selectionModifierValue = slugger.slug(text!);
+    if (quickPick.noteModifierValue || quickPick.prefix) {
+      quickPick.value = NotePickerUtils.getPickerValue(quickPick);
+    } else {
+      quickPick.value = [
+        quickPick.rawValue,
+        NotePickerUtils.getPickerValue(quickPick)
+      ].join(".");
+    }
     return;
   }
 
   async onDisable({ quickPick }: ButtonHandleOpts) {
     quickPick.selectionProcessFunc = undefined;
-    quickPick.value = quickPick.rawValue;
+    quickPick.selectionModifierValue = undefined;
+    quickPick.value = NotePickerUtils.getPickerValue(quickPick);
     return;
   }
 }
@@ -262,18 +270,21 @@ export class JournalBtn extends DendronBtn {
   }
 
   async onEnable({ quickPick }: ButtonHandleOpts) {
-    quickPick.modifyPickerValueFunc = (value: string) => {
-      return DendronClientUtilsV2.genNoteName("JOURNAL", {
-        overrides: { domain: value },
-      });
+    quickPick.modifyPickerValueFunc = () => {
+      return DendronClientUtilsV2.genNoteName("JOURNAL");
     };
-    quickPick.rawValue = quickPick.value;
-    quickPick.value = quickPick.modifyPickerValueFunc(quickPick.rawValue);
+    const { noteName, prefix } = quickPick.modifyPickerValueFunc();
+    quickPick.noteModifierValue = _.difference(noteName.split("."), prefix.split(".")).join(".");
+    quickPick.prevValue = quickPick.value;
+    quickPick.prefix = prefix;
+    quickPick.value = NotePickerUtils.getPickerValue(quickPick);
     return;
   }
 
   async onDisable({ quickPick }: ButtonHandleOpts) {
     quickPick.modifyPickerValueFunc = undefined;
+    quickPick.noteModifierValue = undefined;
+    quickPick.prevValue = quickPick.value;
     quickPick.value = quickPick.rawValue;
   }
 }
@@ -290,31 +301,47 @@ export class ScratchBtn extends DendronBtn {
   }
 
   async onEnable({ quickPick }: ButtonHandleOpts) {
-    quickPick.modifyPickerValueFunc = (value: string) => {
-      return DendronClientUtilsV2.genNoteName("SCRATCH", {
-        overrides: { domain: value },
-      });
+    quickPick.modifyPickerValueFunc = () => {
+      return DendronClientUtilsV2.genNoteName("SCRATCH");
     };
-    quickPick.rawValue = quickPick.value;
-    quickPick.value = quickPick.modifyPickerValueFunc(quickPick.rawValue);
+    quickPick.prevValue = quickPick.value;
+    const { noteName, prefix } = quickPick.modifyPickerValueFunc();
+    quickPick.noteModifierValue = _.difference(noteName.split("."), prefix.split(".")).join(".");
+    quickPick.prefix = prefix;
+    quickPick.value = NotePickerUtils.getPickerValue(quickPick);
     return;
   }
 
   async onDisable({ quickPick }: ButtonHandleOpts) {
     quickPick.modifyPickerValueFunc = undefined;
+    quickPick.noteModifierValue = undefined;
+    quickPick.prevValue = quickPick.value;
     quickPick.value = quickPick.rawValue;
   }
 }
-class HorizontalSplitBtn extends DendronBtn {
+export class HorizontalSplitBtn extends DendronBtn {
   static create(pressed?: boolean) {
-    return new DendronBtn({
+    return new HorizontalSplitBtn({
       title: "Split Horizontal",
       iconOff: "split-horizontal",
       iconOn: "menu-selection",
       type: "horizontal",
       pressed,
     });
   }
+
+  async onEnable({ quickPick }: ButtonHandleOpts) {
+    quickPick.showNote = async (uri) => vscode.window.showTextDocument(
+      uri, 
+      { viewColumn: vscode.ViewColumn.Beside }
+    );
+    return;
+  }
+
+  async onDisable({ quickPick }: ButtonHandleOpts) {
+    quickPick.showNote = async (uri) => vscode.window.showTextDocument(uri);
+    return;
+  }
 }
 
 export class DirectChildFilterBtn extends DendronBtn {
@@ -366,9 +393,9 @@ export class MultiSelectBtn extends DendronBtn {
   }
 }
 
-export class CopyNoteLinkButton extends DendronBtn {
+export class CopyNoteLinkBtn extends DendronBtn {
   static create(pressed?: boolean) {
-    return new CopyNoteLinkButton({
+    return new CopyNoteLinkBtn({
       title: "Copy Note Link",
       iconOff: "clippy",
       iconOn: "menu-selection",
@@ -429,7 +456,7 @@ export function createAllButtons(
 ): DendronBtn[] {
   const buttons = [
     MultiSelectBtn.create(),
-    CopyNoteLinkButton.create(),
+    CopyNoteLinkBtn.create(),
     DirectChildFilterBtn.create(),
     SelectionExtractBtn.create(),
     Selection2LinkBtn.create(),
diff --git a/packages/plugin-core/src/components/lookup/types.ts b/packages/plugin-core/src/components/lookup/types.ts
@@ -14,7 +14,10 @@ export type LookupControllerState = {
 };
 
 type FilterQuickPickFunction = (items: NoteQuickInput[]) => NoteQuickInput[];
-type ModifyPickerValueFunc = (value: string) => string;
+type ModifyPickerValueFunc = (value?: string) => {
+  noteName: string,
+  prefix: string,
+};
 type SelectionProcessFunc = (note: NoteProps) => Promise<NoteProps | undefined>;
 
 export type DendronQuickPickItemV2 = QuickPick<DNodePropsQuickInputV2>;
@@ -40,6 +43,9 @@ export type DendronQuickPickerV2 = DendronQuickPickItemV2 & {
    * Value before being modified
    */
   rawValue: string;
+  prefix: string;
+  noteModifierValue?: string;
+  selectionModifierValue?: string;
   onCreate?: (note: DNodeProps) => Promise<DNodeProps | undefined>;
   /**
    @deprecated, replace with filterResults
diff --git a/packages/plugin-core/src/components/lookup/utils.ts b/packages/plugin-core/src/components/lookup/utils.ts
@@ -249,10 +249,11 @@ export class PickerUtilsV2 {
     quickPick.matchOnDetail = false;
     quickPick.sortByLabel = false;
     quickPick.showNote = async (uri) => window.showTextDocument(uri);
-    if (initialValue) {
+    if (initialValue !== undefined) {
       quickPick.rawValue = initialValue;
+      quickPick.prefix = initialValue;
       quickPick.value = initialValue;
-    }
+    } 
     return quickPick;
   }
 
@@ -615,12 +616,12 @@ export class PickerUtilsV2 {
     // they don't modify state of the quickpick after onEnable.
     await Promise.all(
       buttonsDisabled.map((bt) => {
-        bt.onDisable({ quickPick: opts.quickpick });
+        return bt.onDisable({ quickPick: opts.quickpick });
       })
     );
     await Promise.all(
       buttonsEnabled.map((bt) => {
-        bt.onEnable({ quickPick: opts.quickpick });
+        return bt.onEnable({ quickPick: opts.quickpick });
       })
     );
   }
@@ -715,4 +716,12 @@ export class NotePickerUtils {
     Logger.info({ ctx, msg: "engine.query", profile });
     return updatedItems;
   }
+
+  static getPickerValue(picker: DendronQuickPickerV2) {
+    return [
+      picker.prefix,
+      picker.noteModifierValue,
+      picker.selectionModifierValue
+    ].filter((ent) => !_.isEmpty(ent)).join(".");
+  }
 }
diff --git a/packages/plugin-core/src/test/suite-integ/LookupCommand.test.ts b/packages/plugin-core/src/test/suite-integ/LookupCommand.test.ts
@@ -1106,7 +1106,7 @@ suite("selectionExtract", function () {
 //         (_.find(lc.state.buttons, {
 //           type: "multiSelect",
 //         }) as MultiSelectBtn).pressed = true;
-//         await lc.onTriggerButton(CopyNoteLinkButton.create(true));
+//         await lc.onTriggerButton(CopyNoteLinkBtn.create(true));
 //         assert.strictEqual(
 //           clipboardy.readSync(),
 //           "[[Foo|foo]]\n[[Ch1|foo.ch1]]"
diff --git a/packages/plugin-core/src/test/suite-integ/NoteLookupCommand.test.ts b/packages/plugin-core/src/test/suite-integ/NoteLookupCommand.test.ts
diff --git a/packages/plugin-core/src/utils.ts b/packages/plugin-core/src/utils.ts
