Merge pull request #66 from ornato-t/main

Optional flag to disable logs

Author: SleeplessOne1917

src/bot.ts

@@ -43,6 +43,7 @@ class LemmyBot {
   #timeouts: NodeJS.Timeout[] = [];
   #auth?: string;
   #markAsBot: boolean;
+  #enableLogs: boolean;
   #defaultMinutesUntilReprocess?: number;
   #federationOptions: BotFederationOptions;
   #tasks: ScheduledTask[] = [];
@@ -391,7 +392,8 @@ class LemmyBot {
     dbFile,
     federation,
     schedule,
-    markAsBot = true
+    markAsBot = true,
+    enableLogs = true
   }: BotOptions) {
     switch (federation) {
       case undefined:
@@ -468,6 +470,7 @@ class LemmyBot {
     this.#defaultSecondsBetweenPolls = defaultSecondsBetweenPolls;
     this.#isRunning = false;
     this.#markAsBot = markAsBot;
+    this.#enableLogs = enableLogs;
     this.#instance = instance;
     this.#defaultMinutesUntilReprocess = defaultMinutesUntilReprocess;
     this.#httpClient = new LemmyHttp(
@@ -540,7 +543,7 @@ class LemmyBot {
       modBanFromSite: modBanFromSiteOptions
     } = this.#handlers;
 
-    await setupDB(this.#dbFile);
+    await setupDB(this.#log, this.#dbFile);
 
     if (this.#credentials) {
       await this.#login();
@@ -678,9 +681,7 @@ class LemmyBot {
                     read: true
                   });
 
-                  console.log(
-                    `Marked private message ID ${messageView.private_message.id} from ${messageView.creator.id} as read`
-                  );
+                  this.#log(`Marked private message ID ${messageView.private_message.id} from ${messageView.creator.id} as read`);
 
                   return promise;
                 }
@@ -1151,29 +1152,29 @@ class LemmyBot {
   }
 
   start() {
-    console.log('Starting bot');
+    this.#log('Starting bot');
     this.#isRunning = true;
     this.#runBot();
   }
 
   stop() {
-    console.log('stopping bot');
+    this.#log('Stopping bot');
     this.#isRunning = false;
   }
 
   async #login() {
     if (this.#credentials) {
-      console.log('logging in');
+      this.#log('Logging in');
       const loginRes = await this.#httpClient.login({
         password: this.#credentials.password,
         username_or_email: this.#credentials.username
       });
       this.#auth = loginRes.jwt;
       if (this.#auth) {
-        console.log('logged in');
+        this.#log('Logged in');
 
         if (this.#markAsBot) {
-          console.log('Marking account as bot account');
+          this.#log('Marking account as bot account');
 
           await this.#httpClient
             .saveUserSettings({
@@ -1377,10 +1378,16 @@ class LemmyBot {
     action: () => Promise<T>;
   }) {
     if (this.#auth) {
-      console.log(logMessage);
+      this.#log(logMessage);
       await action();
     }
   }
+
+  #log = (output: string) => {
+    if (this.#enableLogs) {
+      console.log(output);
+    }
+  }
 }
 
 export default LemmyBot;

src/db.ts

@@ -154,9 +154,9 @@ const createTable = (db: Database, table: string) => {
   db.run(`CREATE UNIQUE INDEX IF NOT EXISTS idx_${table}_id ON ${table} (id);`);
 };
 
-export const setupDB = async (dbPath?: string) => {
+export const setupDB = async (log: (output: string) => void, dbPath?: string) => {
   if (dbPath && !existsSync(dbPath)) {
-    console.log('Creating database file');
+    log('Creating database file');
 
     try {
       await mkdir(path.dirname(dbPath), { recursive: true });
@@ -170,7 +170,7 @@ export const setupDB = async (dbPath?: string) => {
 
   await useDatabase(async (db) => {
     db.serialize(() => {
-      console.log('Initializing DB');
+      log('Initializing DB');
       for (const table of tableTypes) {
         createTable(db, table);
       }

src/types.ts

@@ -82,6 +82,13 @@ export type BotOptions = {
    * @default true
    */
   markAsBot?: boolean;
+  /**
+   * If true, the bot will output verbose logs for any operation it conducts.
+   * If set to false, no internal logs will be produced.
+   *
+   * @default true
+   */
+  enableLogs?: boolean;
 };
 
 export type ParentType = 'post' | 'comment';