Linting and commenting Linting and commenting Linting and commenting Linting and commenting Linting and commenting

0383ea52e98213ff73a74545acf4b182bf662781

ceruleandeep <deep@cerulean.navy>

Parents: 669ba2fd36dd6d3a52380fd1c8ae8e903d653fe7

public/script.js+30 -11 Viewed

             quietName: quietName,
         };
         originalResponseLength = responseLengthCustomized ? saveResponseLength(main_api, responseLength) : -1;
-        const generateFinished = await Generate('quiet', options);
+        return await Generate('quiet', options);
-        return generateFinished;
     } finally {
         if (responseLengthCustomized) {
             restoreResponseLength(main_api, originalResponseLength);

         let data = {};
-        if (api == 'koboldhorde') {
+        if (api === 'koboldhorde') {
             data = await generateHorde(prompt, generateData, abortController.signal, false);
-        } else if (api == 'openai') {
+        } else if (api === 'openai') {
             data = await sendOpenAIRequest('quiet', generateData, abortController.signal);
         } else {
             const generateUrl = getGenerateUrl(api);

@@ -3343,13 +3342,15 @@ export async function generateRaw(prompt, api, instructOverride, quietToLoud, sy
3343	});	3342	});
3344		3343
3345	if (!response.ok) {	3344	if (!response.ok) {
3346	const error = await response.json();	3345	throw await response.json();
3347	throw error;
3348	}	3346	}
3349		3347
3350	data = await response.json();	3348	data = await response.json();
3351	}	3349	}
3352		3350
		3351	// should only happen for text completions
		3352	// other frontend paths do not return data if calling the backend fails,
		3353	// they throw things instead
3353	if (data.error) {	3354	if (data.error) {
3354	throw new Error(data.response);	3355	throw new Error(data.response);
3355	}	3356	}

         return Promise.resolve();
+    }
+    /**
+     * Saves itemized prompt bits and calls streaming or non-streaming generation API.
+     * @returns {Promise<void|*|Awaited<*>|String|{fromStream}|string|undefined|Object>}
+     * @throws {Error|object} Error with message text, or Error with response JSON (OAI/Horde), or the actual response JSON (novel|textgenerationwebui|kobold)
+     */
     async function finishGenerating() {
         if (power_user.console_log_prompts) {
             console.log(generate_data.prompt);

     return finishGenerating().then(onSuccess, onError);
+    /**
+     * Handles the successful response from the generation API.
+     * @param data
+     * @returns {Promise<String|{fromStream}|*|string|string|void|Awaited<*>|undefined>}
+     * @throws {Error} Throws an error if the response data contains an error message
+     */
     async function onSuccess(data) {
         if (!data) return;

         let messageChunk = '';
+        // if an error was returned in data (textgenwebui), show it and throw it
         if (data.error) {
             unblockGeneration(type);
             generatedPromptCache = '';

         return Object.defineProperty(new String(getMessage), 'messageChunk', { value: messageChunk });
+    }
+    /**
+     * Exception handler for finishGenerating
+     * @param {Error|object} exception Error or response JSON
+     * @throws {Error|object} Re-throws the exception
+     */
     function onError(exception) {
+        // if the response JSON was thrown (novel|textgenerationwebui|kobold), show the error message
         if (typeof exception?.error?.message === 'string') {
-            toastr.error(exception.error.message, t`Error`, { timeOut: 10000, extendedTimeOut: 20000 });
+            toastr.error(exception.error.message, t`Text generation error`, { timeOut: 10000, extendedTimeOut: 20000 });
+        }
         generatedPromptCache = '';

  * @param {string} type Generation type
  * @param {object} data Generation data
  * @returns {Promise<object>} Response data from the API
+ * @throws {Error|object}
  */
 export async function sendGenerationRequest(type, data) {
     if (main_api === 'openai') {

@@ -5324,12 +5344,10 @@ export async function sendGenerationRequest(type, data) {
5324	});	5344	});
5325		5345
5326	if (!response.ok) {	5346	if (!response.ok) {
5327	const error = await response.json();	5347	throw await response.json();
5328	throw error;
5329	}	5348	}
5330		5349
5331	const responseData = await response.json();	5350	return await response.json();
5332	return responseData;
5333	}	5351	}
5334		5352
5335	/**	5353	/**

  * Gets the generation endpoint URL for the specified API.
  * @param {string} api API name
  * @returns {string} Generation URL
+ * @throws {Error} If the API is unknown
  */
 function getGenerateUrl(api) {
     switch (api) {

public/scripts/extensions/stable-diffusion/index.js+8 -4 Viewed

  * @param {string} [message] Chat message
  * @param {function} [callback] Callback function
  * @returns {Promise<string>} Image path
+ * @throws {Error} If the prompt or image generation fails
  */
 async function generatePicture(initiator, args, trigger, message, callback) {
     if (!trigger || trigger.trim().length === 0) {

     trigger = trigger.trim();
     const generationType = getGenerationType(trigger);
-    console.log('Generation mode', generationType, 'triggered with', trigger);
+    console.log('Image generation mode', generationType, 'triggered with', trigger);
     const quietPrompt = getQuietPrompt(generationType, trigger);
     const context = getContext();

         ? context.groups[Object.keys(context.groups).filter(x => context.groups[x].id === context.groupId)[0]]?.id?.toString()
         : context.characters[context.characterId]?.name;
-    if (generationType == generationMode.BACKGROUND) {
+    if (generationType === generationMode.BACKGROUND) {
         const callbackOriginal = callback;
         callback = async function (prompt, imagePath, generationType, _negativePromptPrefix, _initiator, prefixedPrompt) {
             const imgUrl = `url("${encodeURI(imagePath)}")`;

     try {
         const combineNegatives = (prefix) => { negativePromptPrefix = combinePrefixes(negativePromptPrefix, prefix); };
+        // generate the text prompt for the image
         const prompt = await getPrompt(generationType, message, trigger, quietPrompt, combineNegatives);
         console.log('Processed image prompt:', prompt);

             args._abortController.addEventListener('abort', stopListener);
+        }
+        // generate the image
         imagePath = await sendGenerationRequest(generationType, prompt, negativePromptPrefix, characterName, callback, initiator, abortController.signal);
     } catch (err) {
         console.trace(err);

  */
 async function getPrompt(generationType, message, trigger, quietPrompt, combineNegatives) {
     let prompt;
+    console.log('getPrompt: Generation mode', generationType, 'triggered with', trigger);
     switch (generationType) {
         case generationMode.RAW_LAST:
             prompt = message || getRawLastMessage();

@@ -2718,7 +2722,7 @@ async function sendGenerationRequest(generationType, prompt, additionalNegativeP
2718	throw new Error('Endpoint did not return image data.');	2722	throw new Error('Endpoint did not return image data.');
2719	}	2723	}
2720	} catch (err) {	2724	} catch (err) {
2721	console.error(err);	2725	console.error('Image generation request error: ', err);
2722	toastr.error('Image generation failed. Please try again.' + '\n\n' + String(err), 'Image Generation');	2726	toastr.error('Image generation failed. Please try again.' + '\n\n' + String(err), 'Image Generation');
2723	return;	2727	return;
2724	}	2728	}

public/scripts/horde.js+8 -0 Viewed

+    }
+}
+/** Generates text using the Horde API.
+ * @param {string} prompt
+ * @param params
+ * @param signal
+ * @param reportProgress
+ * @returns {Promise<{text: *, workerName: string}>}
+ * @throws {Error}
+ */
 async function generateHorde(prompt, params, signal, reportProgress) {
     validateHordeModel();
     delete params.prompt;

public/scripts/openai.js+27 -1 Viewed

     return [chat, promptManager.tokenHandler.counts];
+}
+/**
+ * Handles errors during streaming requests.
+ * @param {Response} response
+ * @param {string} decoded - response text or decoded stream data
+ */
 function tryParseStreamingError(response, decoded) {
     try {
         const data = JSON.parse(decoded);

             return;
+        }
-        checkQuotaError(data);
+        void checkQuotaError(data);
         checkModerationError(data);
+        // these do not throw correctly (equiv to Error("[object Object]"))
+        // if trying to fix "[object Object]" displayed to users, start here
         if (data.error) {
             toastr.error(data.error.message || response.statusText, 'Chat Completion API');
             throw new Error(data);

+    }
+}
+/**
+ * Checks if the response contains a quota error and displays a popup if it does.
+ * @param data
+ * @returns {Promise<void>}
+ * @throws {object} - response JSON
+ */
 async function checkQuotaError(data) {
     const errorText = await renderTemplateAsync('quotaError');

@@ -1347,6 +1361,9 @@ async function checkQuotaError(data) {
1347		1361
1348	if (data.quota_error) {	1362	if (data.quota_error) {
1349	callPopup(errorText, 'text');	1363	callPopup(errorText, 'text');
		1364
		1365	// this does not throw correctly (equiv to Error("[object Object]"))
		1366	// if trying to fix "[object Object]" displayed to users, start here
1350	throw new Error(data);	1367	throw new Error(data);
1351	}	1368	}
1352	}	1369	}

     return data.output;
+}
+/**
+ * Send a chat completion request to backend
+ * @param {string} type (impersonate, quiet, continue, etc)
+ * @param {Array} messages
+ * @param {AbortSignal?} signal
+ * @returns {Promise<unknown>}
+ * @throws {Error}
+ */
 async function sendOpenAIRequest(type, messages, signal) {
     // Provide default abort signal
     if (!signal) {

public/scripts/textgen-settings.js+8 -0 Viewed

+    }
+}
+/**
+ * Sends a streaming request for textgenerationwebui.
+ * @param generate_data
+ * @param signal
+ * @returns {Promise<(function(): AsyncGenerator<{swipes: [], text: string, toolCalls: [], logprobs: {token: string, topLogprobs: Candidate[]}|null}, void, *>)|*>}
+ * @throws {Error} - If the response status is not OK, or from within the generator
+ */
 async function generateTextGenWithStreaming(generate_data, signal) {
     generate_data.stream = true;

  * @param {Response} response - Response from the server.
  * @param {string} decoded - Decoded response body.
  * @returns {void} Nothing.
+ * @throws {Error} If the response contains an error message, throws Error with the message.
  */
 function tryParseStreamingError(response, decoded) {
     let data = {};