Allow saving empty secrets via secret manager and slash command (#4580) * Allow saving empty secrets via secret manager and slash command Closes #4577 * Fix logic on cancel * Fix /secrets-read with empty secret value

1d279e500e99ffd6fab955a780433c474f3a1ec8

Cohee <18619528+Cohee1207@users.noreply.github.com>

Signed

public/scripts/secrets.js+26 -8 Viewed

 import { event_types, eventSource, getRequestHeaders } from '../script.js';
 import { t } from './i18n.js';
 import { chat_completion_sources } from './openai.js';
-import { callGenericPopup, Popup, POPUP_TYPE } from './popup.js';
+import { callGenericPopup, Popup, POPUP_RESULT, POPUP_TYPE } from './popup.js';
 import { SlashCommand } from './slash-commands/SlashCommand.js';
 import { ARGUMENT_TYPE, SlashCommandArgument, SlashCommandNamedArgument } from './slash-commands/SlashCommandArgument.js';
 import { enumIcons } from './slash-commands/SlashCommandCommonEnumsProvider.js';

  * @param {string} key Secret key
  * @param {string} value Secret value to write
  * @param {string} [label] (Optional) Label for the key. If not provided, generated automatically.
+ * @param {Object} [options] Additional options
+ * @param {boolean} [options.allowEmpty] Whether to allow writing empty values. If false and value is empty, the secret will be deleted.
  * @return {Promise<string?>} The ID of the newly created secret key, or null if no value is provided.
  */
-export async function writeSecret(key, value, label) {
+export async function writeSecret(key, value, label, { allowEmpty } = {}) {
     try {
-        if (!value) {
+        if (!value && !allowEmpty) {
             console.warn(`No value provided for ${key} in writeSecret, redirecting to deleteSecret`);
             await deleteSecret(key);
             return null;

     const template = $(await renderTemplateAsync('secretKeyManager', { name, key }));
     template.find('button[data-action="add-secret"]').on('click', async function () {
         let label = '';
-        const value = await Popup.show.input(t`Add Secret`, t`Enter the secret value:`, '', {
+        let result = POPUP_RESULT.CANCELLED;
+        const value = await Popup.show.input(t`Add Secret`, t`Enter the secret value (can be empty):`, '', {
             customInputs: [{
                 id: 'newSecretLabel',
                 type: 'text',

             onClose: popup => {
                 if (popup.result) {
                     label = popup.inputResults.get('newSecretLabel').toString().trim();
+                    result = popup.result;
+                }
             },
         });
         if (!value) {
-            return;
+            if (result !== POPUP_RESULT.AFFIRMATIVE) {
+                return;
+            }
+            const allowEmpty = await Popup.show.confirm(t`No value entered`, t`No value was entered for the secret. Do you want to add an empty secret?`);
+            if (!allowEmpty) {
+                return;
+            }
+        }
-        await writeSecret(key, value, label);
+        await writeSecret(key, value, label, { allowEmpty: true });
         await renderSecretsList();
     });

                 isRequired: false,
                 typeList: [ARGUMENT_TYPE.STRING],
             }),
+            SlashCommandNamedArgument.fromProps({
+                name: 'empty',
+                description: t`Whether to allow empty values.`,
+                isRequired: false,
+                typeList: [ARGUMENT_TYPE.BOOLEAN],
+                defaultValue: String(false),
+            }),
         ],
         unnamedArgumentList: [
             SlashCommandArgument.fromProps({

         ],
         callback: async (args, value) => {
             const quiet = isTrueBoolean(args?.quiet?.toString());
+            const allowEmpty = isTrueBoolean(args?.empty?.toString());
             const key = args?.key?.toString()?.trim() || resolveSecretKey();
             if (!key) {

@@ -849,7 +867,7 @@ function registerSecretSlashCommands() {
849	}	867	}
850		868
851	const valueStr = value?.toString()?.trim();	869	const valueStr = value?.toString()?.trim();
852	if (!valueStr) {	870	if (!valueStr && !allowEmpty) {
853	if (!quiet) {	871	if (!quiet) {
854	toastr.error(t`No value provided for the secret key: ${key}`);	872	toastr.error(t`No value provided for the secret key: ${key}`);
855	}	873	}

+            }
             const label = args?.label?.toString()?.trim() || getLabel();
-            const id = await writeSecret(key, valueStr, label);
+            const id = await writeSecret(key, valueStr, label, { allowEmpty });
             if (!quiet) {
                 toastr.success(t`Secret has been written for the key: ${key}`);

src/endpoints/secrets.js+3 -2 Viewed

+        }
         const manager = new SecretManager(request.user.directories);
-        const secretValue = manager.readSecret(key, id);
+        const state = manager.getSecretState();
-        if (!secretValue) {
+        if (!state[key]) {
             return response.sendStatus(404);
+        }
+        const secretValue = manager.readSecret(key, id);
         return response.send({ value: secretValue });
     } catch (error) {
         console.error('Error finding secret:', error);