✨ custom preview file format & error handling

botConfig.json.example

@@ -4,6 +4,9 @@
     "devs": [
         "youruserid"
     ],
-    "showImageAuthor": true,
-    "progressUpdateIntervalMs": 2500
+    "generation": {
+        "showImageAuthor": true,
+        "progressUpdateIntervalMs": 2500,
+        "imagePreviewFormat": "jpg"
+    }
 }

src/utils/SD/base64ToBuffer.js

@@ -2,14 +2,15 @@
 const sharp = require('sharp');
 
 /**
- * 
- * @param {String} encoded Base64 encoded image string.
+ * Turns a Base64 encoded image into a buffer.
+ * @param {String} encodedString Base64 encoded image string.
+ * @param {keyof sharp.FormatEnum} resultFormat The image format to return the buffer as, default png.
  * @returns {Promise<Buffer>}
  */
-module.exports = async (encoded) => {
-    const buffer = Buffer.from(encoded, 'base64');
+module.exports = async (encodedString, resultFormat = "png") => {
+    const buffer = Buffer.from(encodedString, 'base64');
 
-    const imagePromise = sharp(buffer).png().toBuffer();
+    const imagePromise = sharp(buffer).toFormat(resultFormat).toBuffer();
 
     return imagePromise;
 };

src/utils/SD/createImageEmbed.js

@@ -46,7 +46,9 @@ module.exports = async (data, settings = {upscaleBtn: true, redoBtn: false, addi
         .setFooter({ text: imageParams.infotexts[0].match(/Model: ([^,]+)/)[1] })
         .setColor(cancelled ? "#bb0000" : "#00bb00")
 
-    if (botConfig.showImageAuthor) { embed.setAuthor({name: user.username, iconURL: `https://cdn.discordapp.com/avatars/${user.id}/${user.avatar}?size=256`}); }
+    if (botConfig.generation.showImageAuthor) { 
+        embed.setAuthor({name: user.username, iconURL: `https://cdn.discordapp.com/avatars/${user.id}/${user.avatar}?size=256`}); 
+    }
 
     const row = new ActionRowBuilder()
 

src/utils/SD/getProgressEmbed.js

@@ -28,7 +28,9 @@ module.exports = async (user, context = "", addCancelButton = true) => {
             .setColor('Yellow')
             .setTitle('Starting...')
 
-        if (botConfig.showImageAuthor) { embed.setAuthor({name: user.username, iconURL: `https://cdn.discordapp.com/avatars/${user.id}/${user.avatar}?size=256`}); }
+        if (botConfig.generation.showImageAuthor) { 
+            embed.setAuthor({name: user.username, iconURL: `https://cdn.discordapp.com/avatars/${user.id}/${user.avatar}?size=256`}); 
+        }
 
         return {content: "", embeds: [embed]};
     }
@@ -37,17 +39,22 @@ module.exports = async (user, context = "", addCancelButton = true) => {
     const progress = Math.round(data.progress*100);
     const progressBarCompletion = Math.ceil(progress/10);
 
-    const imageBuffer = await base64ToBuffer(data.current_image);
+    const imagePreviewFormat = botConfig.generation.imagePreviewFormat;
+    const previewImageFilename = 'progress.' + imagePreviewFormat;
+
+    const imageBuffer = await base64ToBuffer(data.current_image, imagePreviewFormat);
 
-    const image = new AttachmentBuilder(imageBuffer, {name: 'progress.png'});
+    const image = new AttachmentBuilder(imageBuffer, {name: previewImageFilename});
 
     const embed = new EmbedBuilder()
         .setTitle(`${context}${progress}%\n|${"▓".repeat(progressBarCompletion)}${"░".repeat(10 - progressBarCompletion)}|`)
         .setFooter({text: `ETA: ${data.eta_relative.toFixed(1)}s`})
-        .setImage('attachment://progress.png')
+        .setImage(`attachment://${previewImageFilename}`)
         .setColor("Yellow")
 
-    if (botConfig.showImageAuthor) { embed.setAuthor({name: user.username, iconURL: `https://cdn.discordapp.com/avatars/${user.id}/${user.avatar}?size=256`}); }
+    if (botConfig.generation.showImageAuthor) { 
+        embed.setAuthor({name: user.username, iconURL: `https://cdn.discordapp.com/avatars/${user.id}/${user.avatar}?size=256`}); 
+    }
 
     //Buttons
     const row = new ActionRowBuilder();

src/utils/SD/progressUpdater.js

@@ -12,12 +12,12 @@ const { ChatInputCommandInteraction, ButtonInteraction } = require("discord.js")
 module.exports = async (imagePromise, interaction) => {
     let interval;
 
-    if (botConfig.progressUpdateIntervalMs !== -1) {
+    if (botConfig.generation.progressUpdateIntervalMs !== -1) {
         interval = setInterval( async () => {
 
             interaction.editReply(await getProgressEmbed(interaction.user, "Generating... ", true));
 
-        }, botConfig.progressUpdateIntervalMs);
+        }, botConfig.generation.progressUpdateIntervalMs);
     }
 
     const imageData = await imagePromise;

src/utils/SD/sendRequest.js

@@ -2,18 +2,24 @@ const { baseUrl, port } = require('../../../sdConfig.json');
 const axios = require('axios');
 
 /**
+ * Make a request to the SD API.
  * 
  * @param {string} path API URL path e.g 'sdapi/v1/txt2img'
  * @param {object} data Data to be sent with request.
  * @param {import('axios').Method} method 
  * @returns {Promise<object>}
  */
 module.exports = async (path, data = {}, method = "post") => {
-    const response = await axios({
-        method: method,
-        url: `${baseUrl}:${port}/${path}`,
-        data: data
-    });
-
-    return response.data;
+    try {
+        const response = await axios({
+            method: method,
+            url: `${baseUrl}:${port}/${path}`,
+            data: data
+        });
+
+        return response.data;
+    } catch (error) {
+        console.error(`Request to ${path} failed:`, error.message);
+        return null;
+    }
 };