Merge pull request #1016 from pascalbreuninger/feat/additional-env-vars

feat(desktop): add experimental extra environment variables setting

Author: 89luca89

desktop/src-tauri/Cargo.toml

@@ -12,7 +12,7 @@ tauri-build = { version = "1.2", features = [] }
 
 [dependencies]
 # Tauri
-tauri = { version = "1.2.4", features = [ "updater",
+tauri = { version = "1.2.4", features = [
         "process-relaunch",
         "window-close",
         "notification-all",

desktop/src-tauri/src/settings.rs

@@ -29,6 +29,7 @@ pub struct Settings {
     #[serde(rename = "experimental_devPodPro")]
     experimental_devpod_pro: bool,
     additional_cli_flags: String,
+    additional_env_vars: String,
 }
 
 #[derive(Debug, Serialize, TS)]

desktop/src/client/command.ts

@@ -20,10 +20,26 @@ export class Command implements TCommand<ChildProcess> {
   private childProcess?: Child
   private args: string[]
 
+  public static ADDITIONAL_ENV_VARS: string = ""
+
   constructor(args: string[]) {
     debug("commands", "Creating Devpod command with args: ", args)
+    const extraEnvVars = Command.ADDITIONAL_ENV_VARS.split(",")
+      .map((envVarStr) => envVarStr.split("="))
+      .reduce((acc, pair) => {
+        const [key, value] = pair
+        if (key === undefined || value === undefined) {
+          return acc
+        }
+
+        return { ...acc, [key]: value }
+      }, {})
+
     this.sidecarCommand = ShellCommand.sidecar(DEVPOD_BINARY, args, {
-      env: { [DEVPOD_UI_ENV_VAR]: "true" },
+      env: {
+        ...extraEnvVars,
+        [DEVPOD_UI_ENV_VAR]: "true",
+      },
     })
     this.args = args
   }

desktop/src/contexts/SettingsContext.tsx

@@ -37,14 +37,17 @@ const initialSettings: TSettings = {
   experimental_vscodeInsiders: true,
   experimental_devPodPro: false,
   additionalCliFlags: "",
+  additionalEnvVars: "",
 }
 function getSettingKeys(): readonly TSetting[] {
   return getKeys(initialSettings)
 }
 
 // WARN: needs to match the filename on the rust side
 const SETTING_STORE_KEY = "settings"
-const settingsStore = new Store(new LocalStorageToFileMigrationBackend(SETTING_STORE_KEY))
+const settingsStore = new Store<Record<TSetting, string | boolean | unknown>>(
+  new LocalStorageToFileMigrationBackend(SETTING_STORE_KEY)
+)
 
 export function SettingsProvider({ children }: Readonly<{ children?: ReactNode }>) {
   const [settings, setSettings] = useState(initialSettings)

desktop/src/gen/Settings.ts

@@ -16,4 +16,5 @@ export interface Settings {
   experimental_vscodeInsiders: boolean
   experimental_devPodPro: boolean
   additionalCliFlags: string
+  additionalEnvVars: string
 }

desktop/src/views/Settings/Settings.tsx

@@ -37,7 +37,12 @@ import {
   useVersion,
 } from "../../lib"
 import { useWelcomeModal } from "../../useWelcomeModal"
-import { useCLIFlagsOption, useAgentURLOption, useTelemetryOption } from "./useContextOptions"
+import {
+  useCLIFlagsOption,
+  useAgentURLOption,
+  useTelemetryOption,
+  useExtraEnvVarsOption,
+} from "./useContextOptions"
 import { useIDESettings } from "./useIDESettings"
 
 const SETTINGS_TABS = [
@@ -319,6 +324,7 @@ function UpdateSettings() {
 
 function ExperimentalSettings() {
   const { input: cliFlagsInput, helpText: cliFlagsHelpText } = useCLIFlagsOption()
+  const { input: extraEnvVarsInput, helpText: extraEnvVarsHelpText } = useExtraEnvVarsOption()
   const { settings, set } = useChangeSettings()
 
   return (
@@ -365,10 +371,14 @@ function ExperimentalSettings() {
         </HStack>
       </SettingSection>
 
-      <SettingSection title="CLI Additional Flags" description={cliFlagsHelpText}>
+      <SettingSection title="Additional CLI Flags" description={cliFlagsHelpText}>
         {cliFlagsInput}
       </SettingSection>
 
+      <SettingSection title="Additional Environment Variables" description={extraEnvVarsHelpText}>
+        {extraEnvVarsInput}
+      </SettingSection>
+
       <SettingSection
         showDivider={false}
         title="DevPod Pro (alpha)"

desktop/src/views/Settings/useContextOptions.tsx

@@ -14,6 +14,7 @@ import { client } from "../../client"
 import { useChangeSettings } from "../../contexts"
 import { QueryKeys } from "../../queryKeys"
 import { TContextOptionName } from "../../types"
+import { Command } from "../../client/command"
 
 const DEFAULT_DEVPOD_AGENT_URL = "https://github.com/loft-sh/devpod/releases/latest/download/"
 
@@ -40,34 +41,22 @@ export function useContextOptions() {
     [options, updateOption]
   )
 }
-
-export function useSettingsOptions() {
+export function useCLIFlagsOption() {
   const { settings, set } = useChangeSettings()
-  const { mutate: updateOption } = useMutation({
-    mutationFn: async ({ value }: { value: string }) => {
+  const updateOption = useCallback(
+    (value: string) => {
       set("additionalCliFlags", value)
       client.setSetting("additionalCliFlags", value)
     },
-  })
-
-  return useMemo(
-    () => ({
-      settings,
-      updateOption,
-    }),
-    [settings, updateOption]
+    [set]
   )
-}
-
-export function useCLIFlagsOption() {
-  const { settings, updateOption } = useSettingsOptions()
   const [hasFocus, setHasFocus] = useState(false)
   const inputRef = useRef<HTMLInputElement>(null)
 
   const handleBlur = useCallback(
     (e: FocusEvent<HTMLInputElement>) => {
       const value = e.target.value.trim()
-      updateOption({ value })
+      updateOption(value)
       setHasFocus(false)
     },
     [updateOption]
@@ -96,7 +85,7 @@ export function useCLIFlagsOption() {
         <Input
           ref={inputRef}
           spellCheck={false}
-          placeholder="CLI Additional Flags"
+          placeholder="Additional CLI Flags"
           defaultValue={settings.additionalCliFlags}
           onBlur={handleBlur}
           onKeyUp={handleKeyUp}
@@ -129,10 +118,11 @@ export function useCLIFlagsOption() {
     ]
   )
 
-  const helpText = useMemo(() => <>Set the additional CLI Flags to use.</>, [])
+  const helpText = useMemo(() => <>Set additional CLI Flags to use.</>, [])
 
   return { input, helpText }
 }
+
 export function useAgentURLOption() {
   const { options, updateOption } = useContextOptions()
   const [hasFocus, setHasFocus] = useState(false)
@@ -244,3 +234,80 @@ export function useTelemetryOption() {
 
   return { input, helpText }
 }
+
+export function useExtraEnvVarsOption() {
+  const { settings, set } = useChangeSettings()
+  const [hasFocus, setHasFocus] = useState(false)
+  const inputRef = useRef<HTMLInputElement>(null)
+
+  const handleBlur = useCallback(
+    (e: FocusEvent<HTMLInputElement>) => {
+      const value = e.target.value.trim()
+      set("additionalEnvVars", value)
+      Command.ADDITIONAL_ENV_VARS = value
+      setHasFocus(false)
+    },
+    [set]
+  )
+
+  const handleKeyUp = useCallback((e: KeyboardEvent<HTMLInputElement>) => {
+    if (e.key !== "Enter") return
+
+    e.currentTarget.blur()
+  }, [])
+
+  const handleFocus = useCallback(() => {
+    setHasFocus(true)
+  }, [])
+
+  const handleClear = useCallback(() => {
+    const el = inputRef.current
+    if (!el) return
+
+    el.value = ""
+  }, [])
+
+  const input = useMemo(
+    () => (
+      <InputGroup maxWidth="72">
+        <Input
+          ref={inputRef}
+          spellCheck={false}
+          placeholder="Additional Environment Variables"
+          defaultValue={settings.additionalEnvVars}
+          onBlur={handleBlur}
+          onKeyUp={handleKeyUp}
+          onFocus={handleFocus}
+        />
+        <InputRightElement>
+          <IconButton
+            visibility={hasFocus ? "visible" : "hidden"}
+            size="xs"
+            borderRadius="full"
+            icon={<CloseIcon />}
+            aria-label="clear"
+            onMouseDown={(e) => {
+              // needed to prevent losing focus from input
+              e.stopPropagation()
+              e.preventDefault()
+            }}
+            onClick={handleClear}
+          />
+        </InputRightElement>
+      </InputGroup>
+    ),
+    [settings.additionalEnvVars, handleBlur, handleKeyUp, handleFocus, hasFocus, handleClear]
+  )
+
+  const helpText = useMemo(
+    () => (
+      <>
+        Set additional environment variables DevPod passes to all commands. Accepts a comma
+        separated list, e.g. FOO=bar,BAZ=false
+      </>
+    ),
+    []
+  )
+
+  return { input, helpText }
+}