windmill/frontend/src/lib/components/VariableEditor.svelte

<script lang="ts">
	import Password from './Password.svelte'
	import { sendUserToast } from '$lib/utils'
	import { VariableService } from '$lib/gen'
	import AutosizedTextarea from './AutosizedTextarea.svelte'
	import Path from './Path.svelte'
	import Modal from './Modal.svelte'
	import { createEventDispatcher } from 'svelte'
	import { workspaceStore } from '$lib/stores'
	import Required from './Required.svelte'
	import Tooltip from './Tooltip.svelte'
	import { Button } from './common'

	const dispatch = createEventDispatcher()

	let path: string = ''

	let variable: {
		value: string
		is_secret: boolean
		description: string
	} = {
		value: '',
		is_secret: true,
		description: ''
	}
	let valid = true

	let modal: Modal
	let edit = false
	let initialPath: string
	let pathError = ''

	export function initNew(): void {
		variable = {
			value: '',
			is_secret: true,
			description: ''
		}
		edit = false
		initialPath = ''
		path = ''
		modal.openModal()
	}

	export async function editVariable(path: string): Promise<void> {
		edit = true
		const getV = await VariableService.getVariable({
			workspace: $workspaceStore ?? '',
			path,
			decryptSecret: false
		})
		variable = {
			value: getV.value ?? '',
			is_secret: getV.is_secret,
			description: getV.description ?? ''
		}
		initialPath = path
		modal.openModal()
	}

	const MAX_VARIABLE_LENGTH = 3000

	$: valid = variable.value.length <= MAX_VARIABLE_LENGTH

	async function createVariable(): Promise<void> {
		await VariableService.createVariable({
			workspace: $workspaceStore!,
			requestBody: {
				path,
				value: variable.value,
				is_secret: variable.is_secret,
				description: variable.description
			}
		})
		sendUserToast(`Successfully created variable ${path}`)
		dispatch('create')
		modal.closeModal()
	}

	async function updateVariable(): Promise<void> {
		try {
			const getV = await VariableService.getVariable({
				workspace: $workspaceStore ?? '',
				path: initialPath,
				decryptSecret: false
			})

			await VariableService.updateVariable({
				workspace: $workspaceStore!,
				path: initialPath,
				requestBody: {
					path: getV.path != path ? path : undefined,
					value: variable.value == '' ? undefined : variable.value,
					is_secret: getV.is_secret != variable.is_secret ? variable.is_secret : undefined,
					description: getV.description != variable.description ? variable.description : undefined
				}
			})
			sendUserToast(`Successfully updated variable at ${initialPath}`)
			dispatch('create')
			modal.closeModal()
		} catch (err) {
			sendUserToast(`Could not update variable: ${err.body}`, true)
		}
	}
</script>

<Modal z="z-50" bind:this={modal}>
	<div slot="title">
		{#if edit}
			Update variable at {initialPath}
		{:else}
			Add a variable
		{/if}
	</div>

	<div slot="content">
		<div class="flex flex-col gap-6">
			<div>
				<div>
					<div class="mb-1 font-semibold text-gray-700">General</div>
					<Path
						bind:error={pathError}
						bind:path
						{initialPath}
						namePlaceholder="my_variable"
						kind="variable"
					/>
				</div>
				<div class="mt-4">
					<label class="block">
						<span class="text-sm mr-1">Secret</span>
						<input type="checkbox" bind:checked={variable.is_secret} />
					</label>
					{#if variable.is_secret}
						<div
							class="bg-orange-100 border-l-4 border-orange-500 text-orange-700 p-1 mt-1 text-sm"
							role="alert"
						>
							If the variable is a secret, you will not be able to read the value of it from the
							variable editor UI but only within scripts.
							<Tooltip>
								Within scripts, every read of the value create the audit log:
								'variables.decrypt_secret'
							</Tooltip>
						</div>
					{/if}
				</div>
			</div>

			{#if variable.is_secret}
				<div class="mb-1 col-span-10">
					<Password
						bind:password={variable.value}
						placeholder={'******** (only fill to update value)'}
						label={`<span class="font-semibold text-gray-700">Secret value</span>
							<span class="text-sm text-gray-500">(${variable.value.length}/3000 characters)</span>`}
					/>
				</div>
			{:else}
				<div>
					<div class="mb-1">
						<span class="font-semibold text-gray-700">Variable value</span>
						<span class="text-sm text-gray-500">({variable.value.length}/3000 characters)</span>
					</div>
					<AutosizedTextarea bind:value={variable.value} minRows={5} />
				</div>
			{/if}

			<div>
				<div class="mb-1 font-semibold text-gray-700">
					Description
					<Required required={false} />
				</div>
				<AutosizedTextarea bind:value={variable.description} placeholder={''} minRows={3} />
			</div>
		</div>
	</div>
	<div slot="submission">
		<Button
			size="sm"
			on:click={() => (edit ? updateVariable() : createVariable())}
			disabled={!valid || pathError != ''}
		>
			{edit ? 'Save' : 'Add a variable'}
		</Button>
	</div>
</Modal>