feat(settings): hide temp files used in diff from recently opened list

Signed-off-by: Konstantinos Maninakis <[email protected]>

Author: maninak

.vscode/settings.json

@@ -14,7 +14,7 @@
     "repo",
     "ts",
     "log",
-    "config",
+    "settings",
     "scm",
     "onboarding",
     "publish",

CHANGELOG.md

@@ -8,6 +8,7 @@
   - use more subtle styling when a reaction involves the local radicle identity (italic text vs border & background)
   - show "you" instead of local identity's alias
   - on hover show the truncated DId next to each identity
+- **settings:** add config to toggle excluding temporary files created by the extension, e.g. those used to produce the diff of a patch's changed files, from the list of recently opened files. This is enabled by default. This currently works only partly, but should automatically be fully working when [the underlying VS Code bug](https://github.com/microsoft/vscode/issues/157395#issuecomment-2080293320) is fixed. ([#94](https://github.com/cytechmobile/radicle-vscode-extension/issues/94))
 - **patch-list:** show diff for copied and moved files of a patch too when available ([#100](https://github.com/cytechmobile/radicle-vscode-extension/issues/100))
 - **patch-list:** show path to containing directory for each changed file of a patch ([#100](https://github.com/cytechmobile/radicle-vscode-extension/issues/100))
 - **patch-list:** feat(patch-list): increase count of fetched patches per status to 500 ([#100](https://github.com/cytechmobile/radicle-vscode-extension/issues/100))
@@ -35,7 +36,7 @@
 - update readme links and marketplace metadata to point to Radicle instead of GitHub ([#113](https://github.com/cytechmobile/radicle-vscode-extension/pull/113))
 - **readme:** add badges showcasing current published version, installation count & repository identifier (RID) of the extension ([#113](https://github.com/cytechmobile/radicle-vscode-extension/pull/113))
 - **contributing:** suggest `rad clone` instead of git clone from GitHub ([#113](https://github.com/cytechmobile/radicle-vscode-extension/pull/113))
-- **contributing:** major improvement with new sections referencing zulip, creating a Radicle Issue and more
+- **contributing:** major improvement with new sections referencing zulip, creating a Radicle Issue and more ([#122](https://github.com/cytechmobile/radicle-vscode-extension/issues/122))
 
 -----
 
@@ -412,26 +413,26 @@
 - **auth:** securely store passphrase after successful user input and autotomatically re-use next time (if available) ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
 - **commands:** new VS Code command to de-authenticate / re-lock the currently used Radicle identity and remove the associated passphrase from Secret Storage ([#33](https://github.com/cytechmobile/radicle-vscode-extension/issues/33))
 - **log:** indicate in logs and notifications if an identity was pre-unlocked, got auto-unlocked using stored passphrase, got unlocked with user provided passphrase, or got created anew ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
-- **config:** new `pathToNodeHome` setting, which sets the `RAD_HOME` env variable ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
-- **config:**  new `httpApiEndpoint` setting, useful when reverse-proxies are running in front of `radicle-httpd` etc ([#26](https://github.com/cytechmobile/radicle-vscode-extension/issues/26))
+- **settings:** new `pathToNodeHome` setting, which sets the `RAD_HOME` env variable ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
+- **settings:**  new `httpApiEndpoint` setting, useful when reverse-proxies are running in front of `radicle-httpd` etc ([#26](https://github.com/cytechmobile/radicle-vscode-extension/issues/26))
 - **commands:** new VS Code command to clone a Radicle project from a filterable list of all seeded ones ([#27](https://github.com/cytechmobile/radicle-vscode-extension/issues/27))
 - **commands:** show rad clone command in the native Source Control three-dot-menu's Radicle submenu ([#27](https://github.com/cytechmobile/radicle-vscode-extension/issues/27))
 - **onboarding:** when opening VS Code without any folder in the workspace show in the dedicated Welcome View an additional button to clone from Radicle ([#27](https://github.com/cytechmobile/radicle-vscode-extension/issues/27))
-- **config:** set default value for existing config `pathToRadBinary` ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
+- **settings:** set default value for existing config `pathToRadBinary` ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
 - **log:** log auth status on extension init as well as on `pathToCliBinary` and `pathToNodeHome` configs' change ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
 
 ### 🩹 Fixes
 
-- **config:** use previously ignored config `pathToCliBinary` to resolve Radicle CLI before executing commands ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
+- **settings:** use previously ignored config `pathToCliBinary` to resolve Radicle CLI before executing commands ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
 - **log:** don't log `body` param if it is empty string
 - **log:** escalate user notification shown when Radicle CLI is not resolved from warning to error ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
 
 ### 💅 Refactors
 
 - **store:** create new global store for extension context and replace func param drilling with new getter ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
 - **exec:** completely rewrite foundational logic for shell script execution to be simpler, more powerful and result in cleaner client code ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
-- **config:** use new typesafe getter and setter for accessing VS Code configuration options ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
-- **config:** rename config `pathToBinary` -> `pathToCliBinary` ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
+- **settings:** use new typesafe getter and setter for accessing VS Code configuration options ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
+- **settings:** rename config `pathToBinary` -> `pathToCliBinary` ([#28](https://github.com/cytechmobile/radicle-vscode-extension/issues/28))
 - **repo:** move functions out of overgrown `utils` directory and into new `helpers` and `ux` directories ([#34](https://github.com/cytechmobile/radicle-vscode-extension/issues/34))
 - **repo:** add readme files documenting the intended contents of `utils`, `helpers` and `ux` directories ([8da729e](https://github.com/cytechmobile/radicle-vscode-extension/commit/8da729ee16726484859cf4c56592c7d7189699f8))
 

package.json

@@ -444,30 +444,30 @@
     ],
     "configuration": [
       {
-        "title": "Radicle",
         "properties": {
-          "radicle.advanced.pathToRadBinary": {
-            "scope": "machine-overridable",
-            "type": "string",
-            "default": "",
-            "markdownDescription": "Specifies the path to the Radicle CLI binary stored on your machine. \n\nLeave empty to use the default path or if command `rad` is already globally available in your shell."
+          "radicle.hideTempFiles": {
+            "scope": "application",
+            "type": "boolean",
+            "default": "true",
+            "description": "Exclude temporary files generated by the extension (e.g. old/new versions of files changed in patches) from being listed among the recently opened or in search."
           }
         }
       },
       {
-        "title": "Radicle",
+        "title": "Advanced",
         "properties": {
+          "radicle.advanced.pathToRadBinary": {
+            "scope": "machine-overridable",
+            "type": "string",
+            "default": "",
+            "markdownDescription": "Specifies the path to the Radicle CLI binary stored on your machine. \n\nLeave empty to use the default path or if command `rad` is already globally available in your shell."
+          },
           "radicle.advanced.pathToNodeHome": {
             "scope": "machine-overridable",
             "type": "string",
             "default": "",
             "markdownDescription": "Specifies the path to the Radicle node's home directory. \n\nLeave empty to use the default path or if environment variable `RAD_HOME` is already globally available in your shell."
-          }
-        }
-      },
-      {
-        "title": "Radicle",
-        "properties": {
+          },
           "radicle.advanced.httpApiEndpoint": {
             "scope": "machine-overridable",
             "type": "string",

src/constants.ts

@@ -0,0 +1,4 @@
+import { sep } from 'node:path'
+import { tmpdir } from 'node:os'
+
+export const extTempDir = `${tmpdir()}${sep}radicle`

src/helpers/config.ts

@@ -13,6 +13,7 @@ export interface ExtensionConfig {
   'radicle.advanced.pathToRadBinary': string
   'radicle.advanced.pathToNodeHome': string
   'radicle.advanced.httpApiEndpoint': string
+  'radicle.hideTempFiles': boolean
 }
 
 /**
@@ -23,15 +24,19 @@ export interface ExtensionConfig {
  */
 export function getConfig<K extends keyof ExtensionConfig>(
   configKey: K,
-): ExtensionConfig[typeof configKey] | undefined {
+): ExtensionConfig[K] | undefined {
   const config = workspace.getConfiguration()
 
   switch (configKey) {
     case 'radicle.advanced.pathToRadBinary':
     case 'radicle.advanced.pathToNodeHome':
     case 'radicle.advanced.httpApiEndpoint':
       // if the config has the value of the empty string (default) then return `undefined`
-      return config.get<ExtensionConfig[typeof configKey]>(configKey)?.trim() || undefined
+      // @ts-expect-error
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call
+      return config.get<ExtensionConfig[K]>(configKey)?.trim() || undefined
+    case 'radicle.hideTempFiles':
+      return config.get<ExtensionConfig[K]>(configKey)
     default:
       return assertUnreachable(configKey)
   }
@@ -42,7 +47,7 @@ export function getConfig<K extends keyof ExtensionConfig>(
  */
 export function setConfig<K extends keyof ExtensionConfig>(
   configKey: K,
-  value: ExtensionConfig[typeof configKey],
+  value: ExtensionConfig[K],
 ): Thenable<void> {
   const config = workspace.getConfiguration()
 
@@ -51,6 +56,8 @@ export function setConfig<K extends keyof ExtensionConfig>(
     case 'radicle.advanced.pathToNodeHome':
     case 'radicle.advanced.httpApiEndpoint':
       return config.update(configKey, value, ConfigurationTarget.Global)
+    case 'radicle.hideTempFiles':
+      return config.update(configKey, value, ConfigurationTarget.Global)
     default:
       return assertUnreachable(configKey)
   }

src/helpers/configWatcher.ts

@@ -1,5 +1,6 @@
 import { workspace } from 'vscode'
 import {
+  validateHideTempFilesConfigAlignment,
   validateHttpdConnection,
   validateRadCliInstallation,
   validateRadicleIdentityAuthentication,
@@ -22,34 +23,40 @@ function onConfigChange(
 
 interface OnConfigChangeParam {
   configKey: Parameters<typeof onConfigChange>['0']
-  onChangeCallback: Parameters<typeof onConfigChange>['1']
+  onConfigChange: Parameters<typeof onConfigChange>['1']
+  onBeforeWatcherRegistration?: () => void
 }
 
 // TODO: maninak instead of calling stuff directly to change, onChange set the values in a new configStore and have other things depend on it
 const configWatchers = [
   {
     configKey: 'radicle.advanced.pathToRadBinary',
-    onChangeCallback: () => {
+    onConfigChange: () => {
       validateRadCliInstallation()
       validateRadicleIdentityAuthentication({ minimizeUserNotifications: true })
     },
   },
   {
     configKey: 'radicle.advanced.pathToNodeHome',
-    onChangeCallback: () => {
+    onConfigChange: () => {
       // no need to notify since we check AND notify on rad command execution
       validateRadicleIdentityAuthentication({ minimizeUserNotifications: true })
       usePatchStore().resetAllPatches()
     },
   },
   {
     configKey: 'radicle.advanced.httpApiEndpoint',
-    onChangeCallback: () => {
+    onConfigChange: () => {
       resetHttpdConnection()
       validateHttpdConnection()
       usePatchStore().resetAllPatches()
     },
   },
+  {
+    configKey: 'radicle.hideTempFiles',
+    onConfigChange: validateHideTempFilesConfigAlignment,
+    onBeforeWatcherRegistration: validateHideTempFilesConfigAlignment,
+  },
 ] satisfies OnConfigChangeParam[]
 
 /**
@@ -58,6 +65,7 @@ const configWatchers = [
  */
 export function registerAllConfigWatchers(): void {
   configWatchers.forEach((cw) => {
-    onConfigChange(cw.configKey, cw.onChangeCallback)
+    cw.onBeforeWatcherRegistration?.()
+    onConfigChange(cw.configKey, cw.onConfigChange)
   })
 }

src/ux/patchesView.ts

@@ -1,5 +1,4 @@
 import Path, { sep } from 'node:path'
-import { tmpdir } from 'node:os'
 import * as fs from 'node:fs/promises'
 import {
   EventEmitter,
@@ -12,6 +11,7 @@ import {
   TreeItemCollapsibleState,
   Uri,
 } from 'vscode'
+import { extTempDir } from '../constants'
 import { usePatchStore } from '../stores'
 import {
   debouncedClearMemoizedGetCurrentProjectIdCache,
@@ -155,8 +155,7 @@ export const patchesTreeDataProvider: TreeDataProvider<
       }
 
       // create a placeholder empty file used to diff added or removed files
-      const tempFileUrlPrefix = `${tmpdir()}${sep}radicle`
-      const emptyFileUrl = `${tempFileUrlPrefix}${sep}empty`
+      const emptyFileUrl = `${extTempDir}${sep}empty`
 
       try {
         await fs.mkdir(Path.dirname(emptyFileUrl), { recursive: true })
@@ -178,11 +177,11 @@ export const patchesTreeDataProvider: TreeDataProvider<
           const fileDir = Path.dirname(filePath)
           const filename = Path.basename(filePath)
 
-          const oldVersionUrl = `${tempFileUrlPrefix}${sep}${shortenHash(
+          const oldVersionUrl = `${extTempDir}${sep}${shortenHash(
             oldVersionCommitSha,
           )}${sep}${fileDir}${sep}${filename}`
           // TODO: should the newVersionUrl be just the filechange.path (with full path to the actual file on the fs) if the current git commit is same as newVersionCommitSha and the file isn't on the git (un-)staged changes?
-          const newVersionUrl = `${tempFileUrlPrefix}${sep}${shortenHash(
+          const newVersionUrl = `${extTempDir}${sep}${shortenHash(
             newVersionCommitSha,
           )}${sep}${fileDir}${sep}${filename}`
 

src/ux/settings.ts

@@ -1,5 +1,8 @@
-import { commands, workspace } from 'vscode'
-import type { getConfig } from '../helpers'
+import { sep } from 'node:path'
+import { ConfigurationTarget, commands, workspace } from 'vscode'
+import { extTempDir } from '../constants'
+import { getConfig } from '../helpers'
+import { log } from '../utils'
 
 /**
  * Opens the Settings UI with the options filtered to show only the specified config
@@ -16,3 +19,48 @@ export function openSettingsFocusedAtConfig(config: Parameters<typeof getConfig>
     config,
   )
 }
+
+/**
+ * Checks extension config for user's desired behaviour and ensure's the
+ * native vscode config is set to match.
+ */
+export function validateHideTempFilesConfigAlignment() {
+  const excludeGlob = `${extTempDir}${sep}**`
+
+  const shouldExclude = getConfig('radicle.hideTempFiles')
+
+  const searchExcludeConfigKey = 'search.exclude'
+  const searchExcludeConfig = workspace.getConfiguration().get<object>(searchExcludeConfigKey)
+
+  if (!searchExcludeConfig) {
+    log(
+      `Didn't find any configuration for key "${searchExcludeConfigKey}". Bailing validation of config alignment.`,
+      'warn',
+    )
+
+    return
+  }
+
+  const isAlreadyConfigedToExclude = Boolean(
+    Object.entries(searchExcludeConfig).find(
+      ([key, value]) => key === excludeGlob && value === true,
+    ),
+  )
+
+  if (shouldExclude && !isAlreadyConfigedToExclude) {
+    const newSearchExcludeConfig = { ...searchExcludeConfig, [excludeGlob]: true }
+    workspace
+      .getConfiguration()
+      .update(searchExcludeConfigKey, newSearchExcludeConfig, ConfigurationTarget.Global)
+  } else if (!shouldExclude && isAlreadyConfigedToExclude) {
+    // @ts-expect-error Type '{}' has no matching index signature for type 'string'.
+    const { [excludeGlob]: _, ...searchExcludeConfigWithoutExcludeGlob } = searchExcludeConfig
+    workspace
+      .getConfiguration()
+      .update(
+        searchExcludeConfigKey,
+        searchExcludeConfigWithoutExcludeGlob,
+        ConfigurationTarget.Global,
+      )
+  }
+}