feat: better env checking

Author: veigamann

.env.example

@@ -43,12 +43,16 @@ DATABASE_URL="file:./bot.db"
 # if you're having issues with puppeteer's bundled chromium.
 PUPPETEER_EXECUTABLE_PATH=""
 
+# Accepted values are "true" or "false"
+# Defaults to "true" if left blank
+ENABLE_SOURCES="true"
+
 # Accepted values are "true", "dms_only", "groups_only" or "false"
 # Defaults to "true" if left blank
 ENABLE_REACTIONS="true"
 
 # Change to your liking
-QUEUED_REACTION="🔁"       # Defalts to "🔁" if left blank
+QUEUED_REACTION="🔁"       # Defaults to "🔁" if left blank
 WORKING_REACTION="⚙️"      # Defaults to "⚙️" if left blank
 DONE_REACTION="✅"         # Defaults to "✅" if left blank
 ERROR_REACTION="⚠️"        # Defaults to "⚠️" if left blank
@@ -95,3 +99,4 @@ BLOCKED_USERS=""
 #   - If you set BLOCKED_USERS and ALLOWED_USERS, the bot will ignore users in the BLOCKED_USERS list,
 #     even if they are in the ALLOWED_USERS list.
 #
+#############################################################################################################

src/clients/bing.ts

@@ -3,9 +3,19 @@
 import { BingAIClient } from "@waylaidwanderer/chatgpt-api";
 import KeyvSqlite from "@keyv/sqlite";
 
-console.log(process.env.DATABASE_URL);
+function convertFileToSQLite(string: string) {
+  // Check if the inputString starts with "file:./"
+  if (string.startsWith("file:./")) {
+    // Replace "file:./" with "sqlite://./prisma/"
+    return string.replace("file:./", "sqlite://./prisma/");
+  } else {
+    // If it doesn't start with "file:./", return the original string
+    return string;
+  }
+}
+
 const store = new KeyvSqlite({
-  uri: "sqlite://./prisma/bot.db",
+  uri: convertFileToSQLite(process.env.DATABASE_URL as string),
   table: "cache",
 });
 

src/constants.ts

@@ -2,6 +2,8 @@ import dotenv from "dotenv";
 import dotenvExpand from "dotenv-expand";
 dotenvExpand.expand(dotenv.config());
 
+export const ENABLE_REACTIONS = process.env.ENABLE_REACTIONS || "true";
+export const ENABLE_SOURCES = process.env.ENABLE_SOURCES || "true";
 export const BOT_PREFIX = process.env.BOT_PREFIX?.trim() + " " || "[BOT]: ";
 export const ALLOWED_USERS = process.env.ALLOWED_USERS?.split(",") || [];
 export const BLOCKED_USERS = process.env.BLOCKED_USERS?.split(",") || [];

src/handlers/completion.ts

@@ -1,15 +1,15 @@
 // see src/types/bing-ai-client.d.ts
-// @ts-ignore
-import type { BingAIClientResponse, SuggestedResponse } from "@waylaidwanderer/chatgpt-api";
-
-// see src/types/bing-ai-client.d.ts
-// @ts-ignore
-import type { SourceAttribution } from "@waylaidwanderer/chatgpt-api";
+import type {
+  BingAIClientResponse,
+  SuggestedResponse,
+  SourceAttribution,
+  // @ts-ignore
+} from "@waylaidwanderer/chatgpt-api";
 
 import { Message } from "whatsapp-web.js";
 import { prisma } from "../clients/prisma";
 import { bing } from "../clients/bing";
-import { SYSTEM_MESSAGE } from "../constants";
+import { ENABLE_SOURCES, SYSTEM_MESSAGE } from "../constants";
 import { createConversation, getConversationFor } from "../crud/conversation";
 import { createChat, getChatFor } from "../crud/chat";
 
@@ -45,10 +45,13 @@ export async function getCompletionFor(message: Message, context: string, reply:
 
   const completion = await generateCompletionFor(message, context, onProgress);
   completion.response = removeFootnotes(completion.response);
-  completion.response = completion.response + "\n\n" + getSources(completion);
+
+  if (ENABLE_SOURCES === "true")
+    completion.response = completion.response + "\n\n" + getSources(completion);
 
   // TODO: suggestions will be added later; must have a way to select them when replying
-  // completion.response = completion.response + "\n\n" + getSuggestions(completion);
+  // if (ENABLE_SUGGESTIONS === "true")
+  //   completion.response = completion.response + "\n\n" + getSuggestions(completion);
 
   // @ts-ignore
   return Promise.all([completion, replyEditing]).then(([completion]) => completion);

src/handlers/reactions.ts

@@ -1,4 +1,5 @@
 import { Message } from "whatsapp-web.js";
+import { ENABLE_REACTIONS } from "../constants";
 
 export const REACTIONS = {
   queued: process.env.QUEUED_REACTION || "🔁",
@@ -9,14 +10,10 @@ export const REACTIONS = {
 
 export type Reaction = keyof typeof REACTIONS;
 
-export async function react(
-  message: Message,
-  reaction: keyof typeof REACTIONS
-) {
+export async function react(message: Message, reaction: keyof typeof REACTIONS) {
   const chat = await message.getChat();
-  const enableReactions = process.env.ENABLE_REACTIONS || "true";
 
-  switch (enableReactions) {
+  switch (ENABLE_REACTIONS) {
     case "false":
       break;
     case "true":

src/helpers/utils.ts

@@ -26,6 +26,10 @@ export function isEmoji(str: string) {
 }
 
 export function checkEnv() {
+  if (!process.env.DATABASE_URL)
+    throw new Error(
+      `Invalid database url "${process.env.DATABASE_URL}" provided. Please check the DATABASE_URL variable your .env file.`
+    );
   if (!process.env.BOT_PREFIX)
     throw new Error(
       `Invalid bot prefix "${process.env.BOT_PREFIX}" provided. Please check the BOT_PREFIX variable your .env file.`
@@ -41,12 +45,13 @@ export function checkEnv() {
       `Invalid system message "${process.env.SYSTEM_MESSAGE}" provided. Please check the SYSTEM_MESSAGE variable your .env file.`
     );
 
-  // Checks if all reactions are valid emojis
-  Object.values(REACTIONS).forEach((reaction) => {
-    if (!isEmoji(reaction)) {
-      throw new Error(
-        `Invalid reaction "${reaction}" provided. Please check the reactions variables your .env file. Make sure to only use emojis.`
-      );
-    }
-  });
+  if (process.env.ENABLE_REACTIONS !== "false")
+    // Checks if all reactions are valid emojis
+    Object.values(REACTIONS).forEach((reaction) => {
+      if (!isEmoji(reaction)) {
+        throw new Error(
+          `Invalid reaction "${reaction}" provided. Please check the reactions variables your .env file. Make sure to only use emojis.`
+        );
+      }
+    });
 }