feat: prettier

scripts/env.js

@@ -6,7 +6,7 @@ const {writeFileSync, existsSync} = require("fs");
 const ENV_PATH = process.cwd() + "./.env";
 const DEFAULT_PLACEHOLDER = "YOUR_VALUE";
 
-if (process.env !== 'production') process.exit(0);
+if (process.env !== "production") process.exit(0);
 
 writeFileSync(
   `${process.cwd()}/.env`,

src/constants/env.ts

@@ -10,4 +10,3 @@ const ENV = {
 };
 
 export default ENV;
-

src/constants/errors.ts

@@ -1,7 +1,7 @@
-import ENV  from "./env";
+import ENV from "./env";
 
 const ERRORS = {
-  INVALID_COOKIE: new Error(`Invalid Cookie (Php Session Id) '${ENV.PHPSESSID}'`)
-}
+  INVALID_COOKIE: new Error(`Invalid Cookie (Php Session Id) '${ENV.PHPSESSID}'`),
+};
 
-export default ERRORS;
+export default ERRORS;

src/constants/index.ts

@@ -2,8 +2,4 @@ import WEEK_DAYS_NAME from "./week-days-name";
 import ERRORS from "./errors";
 import ENV from "./env";
 
-export {
-  WEEK_DAYS_NAME, ERRORS, ENV
-}
-
-
+export {WEEK_DAYS_NAME, ERRORS, ENV};

src/constants/week-days-name.ts

@@ -1,11 +1,3 @@
-const WEEK_DAYS_NAME = [
-  'Monday',
-  'Tuesday',
-  'Wednesday',
-  'Thursday',
-  'Friday',
-  'Saturday',
-  'Sunday'
-];
+const WEEK_DAYS_NAME = ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"];
 
 export default WEEK_DAYS_NAME;

src/crawlers/Crawler.ts

@@ -1,7 +1,7 @@
 import {FetchOptions, ofetch} from "ofetch";
 import request_headers from "../static/request_headers.json";
 import {EventEmitter} from "stream";
-import { ENV } from "../constants";
+import {ENV} from "../constants";
 
 type CrawlerEvents = "crawl";
 
@@ -45,7 +45,7 @@ abstract class Crawler<T = any> {
     ...request_headers,
     Cookie: `PHPSESSID=${ENV.PHPSESSID}`,
   };
-  
+
   /**
    * Fetchs content by making http request
    * @param url target URL

src/crawlers/TimetableCrawler.ts

@@ -26,11 +26,11 @@ class TimetableCrawler extends Crawler<TimetableDocType> {
 
     const timetable: TimetableDocType = {
       updatedAt: new Date(),
-      payload: { semester, section, program },
+      payload: {semester, section, program},
       uid: `${semester} ${program} ${section}`.replaceAll("/", ""),
       timetable: this.timetableParser.parse(res),
     };
-    
+
     this.event.emit(Crawler.ON_CRAWL, timetable);
     return timetable;
   }

src/index.ts

@@ -1,21 +1,21 @@
-import { ERRORS } from "./constants";
+import {ERRORS} from "./constants";
 import Worker from "./lib/worker";
 import TimetableRepository from "./lib/TimetableRepository";
-import { logOnCrawlTimetable } from "./lib/logger";
+import {logOnCrawlTimetable} from "./lib/logger";
 
 new Worker()
 
-.onCrawlMetaData(({metaData,  timeTableRequestPayloads}) => {
-  if(timeTableRequestPayloads.length == 0) throw ERRORS.INVALID_COOKIE;
-  TimetableRepository.writeMetaData(metaData)
-})
+  .onCrawlMetaData(({metaData, timeTableRequestPayloads}) => {
+    if (timeTableRequestPayloads.length == 0) throw ERRORS.INVALID_COOKIE;
+    TimetableRepository.writeMetaData(metaData);
+  })
 
-.onCrawlTimetable(logOnCrawlTimetable)
+  .onCrawlTimetable(logOnCrawlTimetable)
 
-.onFinish((allTimetables) => TimetableRepository
-  .writeTimetables(allTimetables)
-  .writeTeachersTimetable(allTimetables)
-  .writeRoomsTimetable(allTimetables)
-)
+  .onFinish((allTimetables) =>
+    TimetableRepository.writeTimetables(allTimetables)
+      .writeTeachersTimetable(allTimetables)
+      .writeRoomsTimetable(allTimetables)
+  )
 
-.start();
+  .start();

src/lib/TimetableRepository.ts

@@ -1,63 +1,105 @@
-import { writeDB } from "../local-db";
-import { hashStr } from "../local-db/cipher";
+import {writeDB} from "../local-db";
+import {hashStr} from "../local-db/cipher";
 import MetaDataType from "../types/MetaDataType";
 import TimetableDocType from "../types/TimetableDocType";
-import { computeRoomTimetable, computeRooms, computeTeacherTimetable, computeTeachers } from "./computes";
-import { isJsonString } from "./util";
+import {computeRoomTimetable, computeRooms, computeTeacherTimetable, computeTeachers} from "./computes";
+import {isJsonString} from "./util";
+import {WEEK_DAYS_NAME} from "../constants";
+import TimetableType from "../types/TimetableType";
 
 class TimetableRepository {
-
-
   public static writeMetaData(metaData: MetaDataType) {
-    writeDB("meta_data", metaData, { hash: false });
+    writeDB("meta_data", metaData, {hash: false});
   }
 
   public static writeTimetables(timetables: TimetableDocType[]) {
-    writeDB("all_timetables", timetables, { hash: false })
-    writeDB("timetable_paths", timetables.map(t=> t.uid).map(hashStr), { hash: false })
+    writeDB("all_timetables", timetables, {hash: false});
+    writeDB("timetable_paths", timetables.map((t) => t.uid).map(hashStr), {hash: false});
 
-    const timetableSnapShot = timetables.map((timetable)=> writeDB(timetable.uid, timetable,{
-      compare: TimetableRepository.compareDBTimetable
-    }))
-    const newTimetableChanges = timetableSnapShot.filter(({ similarity })=> similarity === 'different')
-    writeDB("timetables_new_changes", newTimetableChanges.map(({ content })=> hashStr(content.uid)), { hash: false });
+    const timetableSnapShot = timetables.map((timetable) =>
+      writeDB(timetable.uid, timetable, {
+        compare: TimetableRepository.compareDBTimetable,
+      })
+    );
+    const newTimetableChanges = timetableSnapShot.filter(({similarity}) => similarity === "different");
+    writeDB(
+      "timetables_new_changes",
+      newTimetableChanges.map(({content}) => hashStr(content.uid)),
+      {hash: false}
+    );
 
     return this;
   }
-  
+
   public static writeTeachersTimetable(timetables: TimetableDocType[]) {
     const teachers = computeTeachers(timetables);
-    writeDB("teachers", teachers, { hash: false });
-    writeDB("teacher_paths", teachers.map(hashStr), { hash: false })
+    writeDB("teachers", teachers, {hash: false});
+    writeDB("teacher_paths", teachers.map(hashStr), {hash: false});
 
-    const teachersSnapShot = teachers.map((teacher) => writeDB(teacher, computeTeacherTimetable(teacher, timetables),{
-      compare: TimetableRepository.compareDBTimetable
-    }));
-    const teacherNewChanges = teachersSnapShot.filter(({ similarity }) => similarity === 'different')
-    writeDB("teachers_new_changes", teacherNewChanges.map(({ content}) => hashStr(content.uid)), { hash: false })  
+    const teachersSnapShot = teachers.map((teacher) =>
+      writeDB(teacher, computeTeacherTimetable(teacher, timetables), {
+        compare: TimetableRepository.compareDBTimetable,
+      })
+    );
+    const teacherNewChanges = teachersSnapShot.filter(({similarity}) => similarity === "different");
+    writeDB(
+      "teachers_new_changes",
+      teacherNewChanges.map(({content}) => hashStr(content.uid)),
+      {hash: false}
+    );
 
     return this;
   }
-  
+
   public static writeRoomsTimetable(timetables: TimetableDocType[]) {
     const rooms = computeRooms(timetables);
-    writeDB("rooms", rooms, { hash: false });
-    writeDB("rooms_paths", rooms.map(hashStr), { hash: false })
+    writeDB("rooms", rooms, {hash: false});
+    writeDB("rooms_paths", rooms.map(hashStr), {hash: false});
 
-    const roomsSnapShot = rooms.map((room) => writeDB(room, computeRoomTimetable(room, timetables), {
-      compare: TimetableRepository.compareDBTimetable
-    }));
-    const roomsNewChanges = roomsSnapShot.filter(({ similarity })=> similarity == 'different')
-    writeDB("rooms_new_changes", roomsNewChanges.map(({ content })=> hashStr(content.uid)), { hash: false })
+    const roomsSnapShot = rooms.map((room) =>
+      writeDB(room, computeRoomTimetable(room, timetables), {
+        compare: TimetableRepository.compareDBTimetable,
+      })
+    );
+    const roomsNewChanges = roomsSnapShot.filter(({similarity}) => similarity == "different");
+    writeDB(
+      "rooms_new_changes",
+      roomsNewChanges.map(({content}) => hashStr(content.uid)),
+      {hash: false}
+    );
 
     return this;
   }
-
-  public static compareDBTimetable(curr: TimetableDocType, dbContent: string) {
-    if(!isJsonString(dbContent)) return false;
-    const timetable = JSON.parse(dbContent) as any
-    if(!Object.hasOwn(timetable, 'timetable' as (keyof TimetableDocType))) return false;
-    return JSON.stringify(curr.timetable) === JSON.stringify((timetable as TimetableDocType).timetable);
+
+  private static compareDBTimetable(curr: TimetableDocType, dbContent: string) {
+    if (!isJsonString(dbContent)) return false;
+    const timetable = JSON.parse(dbContent) as any;
+    if (!Object.hasOwn(timetable, "timetable" as keyof TimetableDocType)) return false;
+    return (
+      JSON.stringify(TimetableRepository.removeSameTimingLectures(curr.timetable)) ===
+      JSON.stringify(TimetableRepository.removeSameTimingLectures((timetable as TimetableDocType).timetable))
+    );
+  }
+
+  /**
+   * Helper method to remove same timing lectures.
+   * On the Official Website we have scenario where one teacher have two lecture at a same time
+   * @param timetable
+   */
+  private static removeSameTimingLectures(timetable: TimetableType) {
+    WEEK_DAYS_NAME.forEach((week) => {
+      timetable[week] = timetable[week].filter((lecture, idx, self) => {
+        return !self
+          .slice(idx + 1)
+          .some(
+            (other) =>
+              other.startTime.hours === lecture.startTime.hours &&
+              other.startTime.minutes === lecture.startTime.minutes &&
+              other.endTime.hours === lecture.endTime.hours &&
+              other.endTime.minutes === lecture.endTime.minutes
+          );
+      });
+    });
   }
 }
 

src/lib/computes.ts

@@ -1,5 +1,5 @@
 import TimetableDocType from "../types/TimetableDocType";
-import { WEEK_DAYS_NAME } from "../constants";
+import {WEEK_DAYS_NAME} from "../constants";
 
 export function computeTeachers(timetables: TimetableDocType[]) {
   const teachers = timetables
@@ -19,8 +19,10 @@ export function computeTeacherTimetable(teacher: string, timetables: TimetableDo
     uid: teacher,
     timetable: {},
   };
-
-  WEEK_DAYS_NAME.forEach(name => { teacherTimetable.timetable[name]= []  })
+
+  WEEK_DAYS_NAME.forEach((name) => {
+    teacherTimetable.timetable[name] = [];
+  });
 
   timetables.forEach(({uid, timetable}) => {
     Object.entries(timetable).forEach(([day, lectures]) => {
@@ -33,7 +35,15 @@ export function computeTeacherTimetable(teacher: string, timetables: TimetableDo
       });
     });
   });
-
+
+  // sorts lectures
+  WEEK_DAYS_NAME.forEach((day) => {
+    teacherTimetable.timetable[day] = teacherTimetable.timetable[day].sort(
+      (lhs, rhs) =>
+        lhs.startTime.hours * 60 + lhs.startTime.minutes - (rhs.startTime.hours * 60 + rhs.startTime.minutes)
+    );
+  });
+
   return teacherTimetable;
 }
 
@@ -56,7 +66,9 @@ export function computeRoomTimetable(roomNo: string, timetables: TimetableDocTyp
     timetable: {},
   };
 
-  WEEK_DAYS_NAME.forEach(name => { roomTimetable.timetable[name]= []  })
+  WEEK_DAYS_NAME.forEach((name) => {
+    roomTimetable.timetable[name] = [];
+  });
 
   timetables.forEach(({uid, timetable}) => {
     Object.entries(timetable).forEach(([day, lectures]) => {
@@ -69,6 +81,14 @@ export function computeRoomTimetable(roomNo: string, timetables: TimetableDocTyp
       });
     });
   });
-
+
+  // sorts lectures
+  WEEK_DAYS_NAME.forEach((day) => {
+    roomTimetable.timetable[day] = roomTimetable.timetable[day].sort(
+      (lhs, rhs) =>
+        lhs.startTime.hours * 60 + lhs.startTime.minutes - (rhs.startTime.hours * 60 + rhs.startTime.minutes)
+    );
+  });
+
   return roomTimetable;
 }

src/lib/logger.ts

@@ -1,6 +1,6 @@
 import TimetableDocType from "../types/TimetableDocType";
-import pc from "picocolors"
+import pc from "picocolors";
 
 export function logOnCrawlTimetable(timetable: TimetableDocType) {
-  console.log(`🎯 ${pc.cyan('successfully crawled')} ${pc.magenta(timetable.uid)}`)
+  console.log(`🎯 ${pc.cyan("successfully crawled")} ${pc.magenta(timetable.uid)}`);
 }

src/lib/util.ts

@@ -18,6 +18,10 @@ export function clamp(num: number, min: number, max: number) {
 }
 
 export function isJsonString(str: string) {
-  try { JSON.parse(str);  } catch (e) { return false; }
+  try {
+    JSON.parse(str);
+  } catch (e) {
+    return false;
+  }
   return true;
 }

src/lib/worker.ts

@@ -39,7 +39,7 @@ class Worker {
   }
 
   public constructor() {
-    this.availableCores = clamp(os.cpus().length, 2, 120);
+    this.availableCores = clamp(os.cpus().length, 2, 2);
     this.onCrawlMetaDataEvent = new EventEmitter();
     this.onCrawlTimetableEvent = new EventEmitter();
     this.onCrawlFinishEvent = new EventEmitter();
@@ -50,7 +50,7 @@ class Worker {
     this.registerWorkers();
     return this;
   }
-  
+
   private scrapMetaData() {
     if (!cluster.isPrimary) return;
 

src/local-db/cipher.ts

@@ -3,7 +3,7 @@ import {ENV} from "../constants";
 import assert from "assert";
 
 export const CIPHER_ALGO = "aes-256-cbc";
-export const ENCRYPTED_DATA_ENCODING: Encoding = "hex"
+export const ENCRYPTED_DATA_ENCODING: Encoding = "hex";
 
 const getCredentials = () => ({
   key: Buffer.from(ENV.OPEN_DB_KEY || "", "hex"),
@@ -15,7 +15,7 @@ export function encrypt(data: string) {
   const cipher = createCipheriv(CIPHER_ALGO, key, iv);
   var crypted = cipher.update(data, "utf8", ENCRYPTED_DATA_ENCODING);
   crypted += cipher.final("hex");
-  assert(data === decrypt(crypted), '❌ decryption fail')
+  assert(data === decrypt(crypted), "❌ decryption fail");
   return crypted;
 }
 

src/local-db/index.ts

@@ -1,10 +1,7 @@
 import initLocalDB from "./initDB";
-import { writeDB } from "./writeDB";
-import { readDB } from "./readDB";
+import {writeDB} from "./writeDB";
+import {readDB} from "./readDB";
 
 initLocalDB();
 
-export {
-  writeDB, readDB
-}
-
+export {writeDB, readDB};