cleanup

Author: cdleveille

.env.example

@@ -1,4 +1,5 @@
-API_BASE_URL=http://localhost:5000 # Must match host name and port number of discit-api server
-API_KEY=any_string_value # Must match API_KEY value in discit-api server
+API_URL=http://localhost:5000 # must match host name and port number of discit-api server
+API_KEY=any_string_value # must match API_KEY value in discit-api server
 REFRESH_DISCS_START=true
 REFRESH_DISCS_CRON=true
+BACKUP_DIR=/absolue/path/to/backup/dir # absolute path of directory for disc data backups (defaults to /backup in project root)

README.md

@@ -4,10 +4,11 @@
 
 -   Install [bun](https://bun.sh).
 -   Install package dependencies: `bun i`
--   Clone, set up, and start running the [discit-api](https://github.com/cdleveille/discit-api) project locally.
+-   Clone, set up, and start running the [discit-api](https://github.com/DiscIt-API/discit-api) project locally.
 -   Create and populate a `.env` file based on the `.env.example` file in the root directory.
-    -   The `API_BASE_URL` value must match the URL of the discit-api project (http://localhost:5000 by default if running locally).
+    -   The `API_URL` value must match the URL of the discit-api project (http://localhost:5000 by default if running locally).
     -   The `API_KEY` value can be any string value, but must match the API_KEY in the discit-api project.
     -   The `REFRESH_DISCS_START` value can be set to `true` to run the disc refresh process when the app starts.
     -   The `REFRESH_DISCS_CRON` value can be set to `true` to automatically run the disc refresh process every night at midnight.
+	-   The `BACKUP_DIR` value can be set to an abosolute path for a directoy where the backup files will be stored.
 -   Start the refresh process: `bun start`

src/api.ts

@@ -4,20 +4,17 @@ import type { IDisc } from "./types";
 const headers = { Authorization: `Bearer ${Config.API_KEY}`, "Content-Type": "application/json" };
 
 export const getAllDiscs = async () =>
-	(await fetch(`${Config.API_BASE_URL}/disc`)).json() as Promise<IDisc[]>;
+	(await fetch(`${Config.API_URL}/disc`)).json() as Promise<IDisc[]>;
 
 export const insertDiscs = (discs: IDisc[]) =>
-	fetch(`${Config.API_BASE_URL}/disc`, {
+	fetch(`${Config.API_URL}/disc`, {
 		method: "POST",
 		headers,
 		body: JSON.stringify(discs)
 	});
 
 export const deleteAllDiscs = () =>
-	fetch(`${Config.API_BASE_URL}/disc`, {
+	fetch(`${Config.API_URL}/disc`, {
 		method: "DELETE",
 		headers
 	});
-
-export const revalidateDiscItCache = () =>
-	fetch(`${Config.DISCIT_URL}/api/revalidate`, { method: "POST", headers });

src/config.ts

@@ -3,11 +3,10 @@ import path from "node:path";
 import type { IConfig } from "./types";
 
 export const Config = {
-	API_BASE_URL: Bun.env.API_BASE_URL || "http://localhost:5000",
+	API_URL: Bun.env.API_URL || "http://localhost:5000",
 	API_KEY: Bun.env.API_KEY || undefined,
 	REFRESH_DISCS_START: Bun.env.REFRESH_DISCS_START?.toLowerCase() === "true",
 	REFRESH_DISCS_CRON: Bun.env.REFRESH_DISCS_CRON?.toLowerCase() === "true",
-	DISCIT_URL: Bun.env.DISCIT_URL,
 	BACKUP_DIR: Bun.env.BACKUP_DIR || path.resolve("./backup")
 } as IConfig;
 

src/refresh.ts

@@ -1,6 +1,6 @@
 import jsdom from "jsdom";
 
-import { deleteAllDiscs, getAllDiscs, insertDiscs, revalidateDiscItCache } from "./api";
+import { deleteAllDiscs, getAllDiscs, insertDiscs } from "./api";
 import { Config } from "./config";
 import { DISC_FETCH_URL, Site } from "./constants";
 import {
@@ -31,7 +31,6 @@ export const refreshDiscs = async () => {
 		if (discsToInsert.length >= existingDiscs.length) {
 			await doDeleteAllDiscs();
 			await doInsertDiscs(discsToInsert);
-			await doRevalidateDiscItCache();
 		} else {
 			console.log("Database is up-to-date. No further action needed.");
 		}
@@ -217,18 +216,3 @@ const doInsertDiscs = async (discsToInsert: IDisc[]) => {
 		throw new Error(`${error} - Error inserting discs into database.`);
 	}
 };
-
-const doRevalidateDiscItCache = async () => {
-	try {
-		if (!Config.DISCIT_URL) {
-			console.log("DISCIT_URL env var is not defined. Skipping DiscIt cache revalidation.");
-			return;
-		}
-		console.log("Revalidating DiscIt cache...");
-		const { ok, status } = await revalidateDiscItCache();
-		if (!ok) throw `Bad response status: ${status}`;
-		console.log("DiscIt cache revalidated.");
-	} catch (error) {
-		throw new Error(`${error} - Error revalidating DiscIt cache.`);
-	}
-};

src/types.ts

@@ -8,10 +8,9 @@ export interface IDiscCollections {
 }
 
 export interface IConfig {
-	API_BASE_URL: string;
+	API_URL: string;
 	API_KEY: string;
 	REFRESH_DISCS_START: boolean;
 	REFRESH_DISCS_CRON: boolean;
-	DISCIT_URL: string;
 	BACKUP_DIR: string;
 }