updated database service to static method

pull/1/head
sloppyjosh 2024-03-07 01:52:44 -05:00
parent 1603c7bf07
commit 28e280556e
7 changed files with 76 additions and 64 deletions

View File

@ -1,19 +1,26 @@
import { Database } from 'sqlite'; import { Database } from 'sqlite';
import { Comment } from '../../rdrama/models/Comment'; import { Comment } from '../../rdrama/models/Comment';
import { DatabaseInitializer } from '../initializeDatabase';
/** /**
* Service for interacting with the SQLite database for operations related to comments and user mentions. * Service for interacting with the SQLite database for operations related to comments and user mentions.
*/ */
export class DatabaseService { export class DatabaseService {
private db: Database;
/** /**
* Creates a new DatabaseService instance with a provided database connection. * Retrieves the singleton instance of the database.
* This method ensures that a single database instance is used throughout the application,
* following the singleton pattern for managing database connections.
* *
* @param {Database} db - The SQLite database connection. * @returns A promise that resolves to the initialized database instance.
* @throws Will throw an error if the database cannot be initialized.
*/ */
public constructor(db: Database) { private static async getDatabase(): Promise<Database> {
this.db = db; const databaseInitializer = DatabaseInitializer.getInstance();
const db = await databaseInitializer.getDbInstance()
if (!db) {
throw new Error('Failed to initialize the database.');
}
return db
} }
/** /**
@ -24,7 +31,8 @@ export class DatabaseService {
* *
* @param {Comment} comment - The comment object to insert. * @param {Comment} comment - The comment object to insert.
*/ */
public async insertComment(comment: Comment): Promise<void> { public static async insertComment(comment: Comment): Promise<void> {
const db = await DatabaseService.getDatabase()
const sql = ` const sql = `
INSERT INTO comments ( INSERT INTO comments (
id, author_id, author_name, body, body_html, created_utc, deleted_utc, id, author_id, author_name, body, body_html, created_utc, deleted_utc,
@ -36,7 +44,7 @@ export class DatabaseService {
?, ?, ?, ?, ?, ?, ? ?, ?, ?, ?, ?, ?, ?
) )
`; `;
await this.db.run(sql, [ await db.run(sql, [
comment.id, comment.author_id, comment.author_name, comment.body, comment.body_html, comment.created_utc, comment.deleted_utc, comment.id, comment.author_id, comment.author_name, comment.body, comment.body_html, comment.created_utc, comment.deleted_utc,
comment.distinguished ? 1 : 0, comment.downvotes, comment.edited_utc, comment.is_banned ? 1 : 0, comment.is_bot ? 1 : 0, comment.is_nsfw ? 1 : 0, comment.level, comment.distinguished ? 1 : 0, comment.downvotes, comment.edited_utc, comment.is_banned ? 1 : 0, comment.is_bot ? 1 : 0, comment.is_nsfw ? 1 : 0, comment.level,
comment.permalink, comment.pinned, comment.post_id, JSON.stringify(comment.replies), JSON.stringify(comment.reports), comment.score, comment.upvotes comment.permalink, comment.pinned, comment.post_id, JSON.stringify(comment.replies), JSON.stringify(comment.reports), comment.score, comment.upvotes
@ -45,23 +53,35 @@ export class DatabaseService {
/** /**
* Inserts a new user mention into the database. * Inserts a new user mention into the database.
* This method is static and can be called without creating an instance of the class.
* It uses `getDatabase` method internally to ensure that database operations
* are performed on the same database instance throughout the application.
* *
* @param {Object} mention - The user mention object to insert, containing rdrama_comment_id, username, and optionally message. * @param mention - The user mention object to insert. It must include:
* - rdrama_comment_id: The ID of the comment from the r/Drama platform.
* - username: The mentioned Reddit username in a standardized format (e.g., u/username).
* - message: (Optional) The content of the message sent to the mentioned user.
*
* @throws Will throw an error if the database cannot be initialized or the insert operation fails.
*/ */
public async insertUserMention(mention: { rdrama_comment_id: number; username: string; message?: string }): Promise<void> { public static async insertUserMention(mention: { rdrama_comment_id: number; username: string; message?: string }): Promise<void> {
const db = await DatabaseService.getDatabase()
const sql = `INSERT INTO user_mentions (rdrama_comment_id, username, message) VALUES (?, ?, ?)`; const sql = `INSERT INTO user_mentions (rdrama_comment_id, username, message) VALUES (?, ?, ?)`;
await this.db.run(sql, [mention.rdrama_comment_id, mention.username, mention.message]); await db.run(sql, [mention.rdrama_comment_id, mention.username, mention.message]);
} }
/** /**
* Queries the database for an existing comment. * Queries the database for an existing comment.
* *
* @param {string} commentId - The ID of the comment to search for. * @param {string} commentId - The ID of the comment to search for.
* @returns {Promise<boolean>} A boolean indicating whether the comment exists. * @returns {Promise<boolean>} A boolean indicating whether the comment exists.
*/ */
public async commentExists(commentId: string): Promise<boolean> { public static async commentExists(commentId: string): Promise<boolean> {
const db = await DatabaseService.getDatabase()
const sql = `SELECT 1 FROM comments WHERE id = ?`; const sql = `SELECT 1 FROM comments WHERE id = ?`;
const result = await this.db.get(sql, [commentId]); const result = await db.get(sql, [commentId]);
return !!result; return !!result;
} }
@ -71,9 +91,10 @@ export class DatabaseService {
* @param {string} username - The username to search for. * @param {string} username - The username to search for.
* @returns {Promise<boolean>} A boolean indicating whether the username has been mentioned. * @returns {Promise<boolean>} A boolean indicating whether the username has been mentioned.
*/ */
public async userMentionExists(username: string): Promise<boolean> { public static async userMentionExists(username: string): Promise<boolean> {
const db = await DatabaseService.getDatabase()
const sql = `SELECT 1 FROM user_mentions WHERE username = ?`; const sql = `SELECT 1 FROM user_mentions WHERE username = ?`;
const result = await this.db.get(sql, [username]); const result = await db.get(sql, [username]);
return !!result; return !!result;
} }
@ -84,8 +105,9 @@ export class DatabaseService {
* @param {string} taskName - The name of the maintenance task for which to retrieve the last run timestamp. * @param {string} taskName - The name of the maintenance task for which to retrieve the last run timestamp.
* @returns {Promise<Date | null>} A promise that resolves to the Date of the last run if found, or null if not found. * @returns {Promise<Date | null>} A promise that resolves to the Date of the last run if found, or null if not found.
*/ */
public async getLastRunTimestamp(taskName: string): Promise<Date | null> { public static async getLastRunTimestamp(taskName: string): Promise<Date | null> {
const result = await this.db.get(`SELECT last_run FROM maintenance_log WHERE task_name = ?`, [taskName]); const db = await DatabaseService.getDatabase()
const result = await db.get(`SELECT last_run FROM maintenance_log WHERE task_name = ?`, [taskName]);
return result ? new Date(result.last_run) : null; return result ? new Date(result.last_run) : null;
} }
@ -98,9 +120,10 @@ export class DatabaseService {
* @param {string} taskName - The name of the maintenance task for which to update the last run timestamp. * @param {string} taskName - The name of the maintenance task for which to update the last run timestamp.
* @returns {Promise<void>} A promise that resolves when the operation is complete. * @returns {Promise<void>} A promise that resolves when the operation is complete.
*/ */
public async updateLastRunTimestamp(taskName: string): Promise<void> { public static async updateLastRunTimestamp(taskName: string): Promise<void> {
// Assumes an "upsert" approach for the maintenance_log table // Assumes an "upsert" approach for the maintenance_log table
await this.db.run( const db = await DatabaseService.getDatabase()
await db.run(
`INSERT INTO maintenance_log (task_name, last_run) `INSERT INTO maintenance_log (task_name, last_run)
VALUES (?, ?) VALUES (?, ?)
ON CONFLICT(task_name) ON CONFLICT(task_name)
@ -115,9 +138,10 @@ export class DatabaseService {
* *
* @param {number} [days=1] - The age of comments to be purged, in days. Defaults to 30 days. * @param {number} [days=1] - The age of comments to be purged, in days. Defaults to 30 days.
*/ */
public async purgeOldComments(days: number = 1): Promise<void> { public static async purgeOldComments(days: number = 1): Promise<void> {
const db = await DatabaseService.getDatabase()
console.log(`Purging comments older than ${days} days...`); console.log(`Purging comments older than ${days} days...`);
await this.db.run(` await db.run(`
DELETE FROM comments DELETE FROM comments
WHERE datetime(created_utc, 'unixepoch') < datetime('now', '-${days} days') WHERE datetime(created_utc, 'unixepoch') < datetime('now', '-${days} days')
`); `);
@ -129,7 +153,8 @@ export class DatabaseService {
* @param {string} token_identifier - The baseurl for the axios instance. * @param {string} token_identifier - The baseurl for the axios instance.
* @param {Object} tokenData - The OAuth token data. * @param {Object} tokenData - The OAuth token data.
*/ */
async upsertOAuthToken(token_identifier: string, tokenData: any) { public static async upsertOAuthToken(token_identifier: string, tokenData: any) {
const db = await DatabaseService.getDatabase()
const { access_token, token_type, expires_in, scope } = tokenData; const { access_token, token_type, expires_in, scope } = tokenData;
const expiryTimestamp = Math.floor(Date.now() / 1000) + expires_in; const expiryTimestamp = Math.floor(Date.now() / 1000) + expires_in;
console.log('token_identifier', token_identifier) console.log('token_identifier', token_identifier)
@ -138,7 +163,7 @@ export class DatabaseService {
console.log('expires_in', expires_in) console.log('expires_in', expires_in)
console.log('scope', scope) console.log('scope', scope)
await this.db.run(` await db.run(`
INSERT INTO oauth_tokens (token_identifier, access_token, token_type, expires_in, expiry_timestamp, scope) INSERT INTO oauth_tokens (token_identifier, access_token, token_type, expires_in, expiry_timestamp, scope)
VALUES (?, ?, ?, ?, ?, ?) VALUES (?, ?, ?, ?, ?, ?)
ON CONFLICT(token_identifier) DO UPDATE SET ON CONFLICT(token_identifier) DO UPDATE SET
@ -155,8 +180,9 @@ export class DatabaseService {
* @param {string} token_identifier - The baseurl for the axios instance. * @param {string} token_identifier - The baseurl for the axios instance.
* @returns {Promise<Object|null>} The current OAuth token data or null if expired or not found. * @returns {Promise<Object|null>} The current OAuth token data or null if expired or not found.
*/ */
async getCurrentOAuthToken(token_identifier: string) { public static async getCurrentOAuthToken(token_identifier: string) {
const tokenRow = await this.db.get(` const db = await DatabaseService.getDatabase()
const tokenRow = await db.get(`
SELECT access_token, token_type, scope, expiry_timestamp FROM oauth_tokens SELECT access_token, token_type, scope, expiry_timestamp FROM oauth_tokens
WHERE token_identifier = ? WHERE token_identifier = ?
`, token_identifier); `, token_identifier);
@ -169,13 +195,14 @@ export class DatabaseService {
* *
* @returns {Promise<boolean>} True if the cooldown has passed, allowing new notifications to be sent. * @returns {Promise<boolean>} True if the cooldown has passed, allowing new notifications to be sent.
*/ */
public async canSendNotification(): Promise<boolean> { public static async canSendNotification(): Promise<boolean> {
const db = await DatabaseService.getDatabase()
const cooldownHours = process.env.NOTIFICATION_COOLDOWN_HOURS || 4; const cooldownHours = process.env.NOTIFICATION_COOLDOWN_HOURS || 4;
const sql = ` const sql = `
SELECT MAX(sent_time) as last_notification_time SELECT MAX(sent_time) as last_notification_time
FROM user_mentions FROM user_mentions
`; `;
const result = await this.db.get(sql); const result = await db.get(sql);
if (!result || !result.last_notification_time) { if (!result || !result.last_notification_time) {
// No notifications have been sent yet, or unable to retrieve the last sent time. // No notifications have been sent yet, or unable to retrieve the last sent time.

View File

@ -5,15 +5,7 @@ import { DatabaseService } from './Database';
* This service is responsible for periodically running maintenance tasks based on specified intervals. * This service is responsible for periodically running maintenance tasks based on specified intervals.
*/ */
export class DatabaseMaintenanceService { export class DatabaseMaintenanceService {
private databaseService: DatabaseService;
/**
* Initializes a new instance of the DatabaseMaintenanceService.
* @param {DatabaseService} databaseService - An instance of DatabaseService for database operations.
*/
constructor(databaseService: DatabaseService) {
this.databaseService = databaseService;
}
/** /**
* A list of maintenance tasks to be executed, each with a name, action, and interval. * A list of maintenance tasks to be executed, each with a name, action, and interval.
@ -49,7 +41,7 @@ export class DatabaseMaintenanceService {
*/ */
private async shouldRunTask(taskName: string, interval: number): Promise<boolean> { private async shouldRunTask(taskName: string, interval: number): Promise<boolean> {
// Use the DatabaseService to check the last run timestamp from the maintenance_log table // Use the DatabaseService to check the last run timestamp from the maintenance_log table
const lastRun = await this.databaseService.getLastRunTimestamp(taskName); const lastRun = await DatabaseService.getLastRunTimestamp(taskName);
if (!lastRun) return true; // Task has never run if (!lastRun) return true; // Task has never run
const now = Date.now(); const now = Date.now();
@ -62,7 +54,7 @@ export class DatabaseMaintenanceService {
private async purgeOldComments() { private async purgeOldComments() {
console.log("Purging old comments..."); console.log("Purging old comments...");
// Use the DatabaseService for the SQL operation // Use the DatabaseService for the SQL operation
await this.databaseService.purgeOldComments(); await DatabaseService.purgeOldComments();
} }
/** /**
@ -72,6 +64,6 @@ export class DatabaseMaintenanceService {
*/ */
private async updateLastRunTimestamp(taskName: string) { private async updateLastRunTimestamp(taskName: string) {
// Use the DatabaseService to update the last run timestamp in the maintenance_log table // Use the DatabaseService to update the last run timestamp in the maintenance_log table
await this.databaseService.updateLastRunTimestamp(taskName); await DatabaseService.updateLastRunTimestamp(taskName);
} }
} }

View File

@ -20,8 +20,7 @@ async function startApplication() {
if (!db) { if (!db) {
throw new Error('Failed to initialize the database.'); throw new Error('Failed to initialize the database.');
} }
const databaseService = new DatabaseService(db) const canSend = await DatabaseService.canSendNotification();
const canSend = await databaseService.canSendNotification();
const coolDownHours = process.env.NOTIFICATION_COOLDOWN_HOURS const coolDownHours = process.env.NOTIFICATION_COOLDOWN_HOURS
if (!canSend) { if (!canSend) {
console.log(`Last Message Sent less than ${coolDownHours ? coolDownHours : 4} hours ago. Set NOTIFICATION_COOLDOWN_HOURS to change this`) console.log(`Last Message Sent less than ${coolDownHours ? coolDownHours : 4} hours ago. Set NOTIFICATION_COOLDOWN_HOURS to change this`)
@ -37,14 +36,14 @@ async function startApplication() {
rDramaSessionManager.setAuthorizationToken(process.env.RDRAMA_API_KEY); rDramaSessionManager.setAuthorizationToken(process.env.RDRAMA_API_KEY);
console.log('Database Maintenance Start') console.log('Database Maintenance Start')
const databaseMaintenance = new DatabaseMaintenanceService(databaseService) const databaseMaintenance = new DatabaseMaintenanceService()
await databaseMaintenance.runMaintenanceTasks() await databaseMaintenance.runMaintenanceTasks()
console.log('Reddit Session Start') console.log('Reddit Session Start')
await redditSession.getInstance(databaseService) await redditSession.getInstance()
// Initialize services with any required dependencies // Initialize services with any required dependencies
const commentFetcher = new CommentProcessor(databaseService); const commentFetcher = new CommentProcessor();
const commentParser = new CommentParser(); const commentParser = new CommentParser();
const commentPoster = new CommentPoster() const commentPoster = new CommentPoster()
const messageService = new MessageService(); const messageService = new MessageService();
@ -54,8 +53,7 @@ async function startApplication() {
commentFetcher, commentFetcher,
commentParser, commentParser,
commentPoster, commentPoster,
messageService, messageService
databaseService,
); );
await workflowOrchestrator.executeWorkflow(); await workflowOrchestrator.executeWorkflow();
} }

View File

@ -9,15 +9,13 @@ import { CommentFetcher } from './CommentFetcher';
*/ */
export class CommentProcessor { export class CommentProcessor {
private maxPages: number; private maxPages: number;
private databaseService: DatabaseService;
/** /**
* Creates an instance of CommentProcessor. * Creates an instance of CommentProcessor.
* @param {DatabaseService} databaseService - The service for database operations. * @param {DatabaseService} databaseService - The service for database operations.
* @param {number} maxPages - The maximum number of pages to fetch from the r/Drama API. Defaults to 10. * @param {number} maxPages - The maximum number of pages to fetch from the r/Drama API. Defaults to 10.
*/ */
constructor(databaseService: DatabaseService, maxPages: number = 10) { constructor(maxPages: number = 10) {
this.databaseService = databaseService;
this.maxPages = maxPages; this.maxPages = maxPages;
} }
@ -41,12 +39,12 @@ export class CommentProcessor {
// Check if the comment was already processed in this batch // Check if the comment was already processed in this batch
if (comments.some(c => c.id === comment.id)) continue; if (comments.some(c => c.id === comment.id)) continue;
const exists = await this.databaseService.commentExists(comment.id.toString()); const exists = await DatabaseService.commentExists(comment.id.toString());
if (exists) { if (exists) {
stopFetching = true; stopFetching = true;
break; // Stop processing this batch of comments break; // Stop processing this batch of comments
} }
await this.databaseService.insertComment(comment) await DatabaseService.insertComment(comment)
comments.push(comment); comments.push(comment);
} }

View File

@ -10,10 +10,8 @@ dotenv.config();
class RedditSessionManager { class RedditSessionManager {
private static instance: RedditSessionManager; private static instance: RedditSessionManager;
public axiosInstance: AxiosInstance; public axiosInstance: AxiosInstance;
private databaseService: DatabaseService;
private constructor(databaseService: DatabaseService) { private constructor() {
this.databaseService = databaseService;
axiosThrottle.use(axios, { requestsPerSecond: 1 }); // Throttle setup axiosThrottle.use(axios, { requestsPerSecond: 1 }); // Throttle setup
this.axiosInstance = axios.create({ this.axiosInstance = axios.create({
@ -29,9 +27,9 @@ class RedditSessionManager {
}); });
} }
public static async getInstance(databaseService: DatabaseService): Promise<RedditSessionManager> { public static async getInstance(): Promise<RedditSessionManager> {
if (!RedditSessionManager.instance) { if (!RedditSessionManager.instance) {
RedditSessionManager.instance = new RedditSessionManager(databaseService); RedditSessionManager.instance = new RedditSessionManager();
await RedditSessionManager.instance.initializeAuthentication(); await RedditSessionManager.instance.initializeAuthentication();
} }
return RedditSessionManager.instance; return RedditSessionManager.instance;
@ -39,7 +37,7 @@ class RedditSessionManager {
private async initializeAuthentication() { private async initializeAuthentication() {
// Check the database for an existing token // Check the database for an existing token
const currentToken = await this.databaseService.getCurrentOAuthToken(this.axiosInstance.defaults.baseURL as string); const currentToken = await DatabaseService.getCurrentOAuthToken(this.axiosInstance.defaults.baseURL as string);
if (currentToken && new Date() < new Date(currentToken.expiry_timestamp * 1000)) { if (currentToken && new Date() < new Date(currentToken.expiry_timestamp * 1000)) {
this.axiosInstance.defaults.headers.common['Authorization'] = `Bearer ${currentToken.access_token}`; this.axiosInstance.defaults.headers.common['Authorization'] = `Bearer ${currentToken.access_token}`;
console.log('Using existing Reddit API token from database.'); console.log('Using existing Reddit API token from database.');
@ -76,7 +74,7 @@ class RedditSessionManager {
}); });
// Upsert the new token into the database // Upsert the new token into the database
await this.databaseService.upsertOAuthToken( await DatabaseService.upsertOAuthToken(
this.axiosInstance.defaults.baseURL as string, this.axiosInstance.defaults.baseURL as string,
{ {
access_token: response.data.access_token, access_token: response.data.access_token,

View File

@ -5,7 +5,7 @@ import { DatabaseService } from '../db/services/Database';
// Load environment variables from .env file // Load environment variables from .env file
dotenv.config(); dotenv.config();
export async function shouldNotifyUser(username: string, redditService: RedditService, databaseService: DatabaseService): Promise<boolean> { export async function shouldNotifyUser(username: string, redditService: RedditService): Promise<boolean> {
const userInfo = await redditService.getUserInfo(username); const userInfo = await redditService.getUserInfo(username);
if (!userInfo) return false; if (!userInfo) return false;
@ -15,7 +15,7 @@ export async function shouldNotifyUser(username: string, redditService: RedditSe
const excludeEmployees = process.env.EXCLUDE_EMPLOYEES !== 'false'; // Defaults to true unless explicitly set to 'false' const excludeEmployees = process.env.EXCLUDE_EMPLOYEES !== 'false'; // Defaults to true unless explicitly set to 'false'
const notifyAcceptPms = accept_pms !== false; // Notify if accept_pms is true or undefined const notifyAcceptPms = accept_pms !== false; // Notify if accept_pms is true or undefined
const karmaThreshold = parseInt(process.env.KARMA_THRESHOLD || '100000', 10); const karmaThreshold = parseInt(process.env.KARMA_THRESHOLD || '100000', 10);
const hasBeenNotifiedBefore = await databaseService.userMentionExists(username); const hasBeenNotifiedBefore = await DatabaseService.userMentionExists(username);
const meetsCriteria = const meetsCriteria =
(!excludeMods || !is_mod) && // Notify unless we're excluding mods and the user is a mod (!excludeMods || !is_mod) && // Notify unless we're excluding mods and the user is a mod

View File

@ -13,7 +13,6 @@ class WorkflowOrchestrator {
private commentParser: CommentParser, private commentParser: CommentParser,
private commentPoster: CommentPoster, private commentPoster: CommentPoster,
private messageService: MessageService, private messageService: MessageService,
private databaseService: DatabaseService,
) { } ) { }
/** /**
@ -38,15 +37,15 @@ class WorkflowOrchestrator {
author_name: comment.author_name, author_name: comment.author_name,
}; };
for (const redditUser of redditUsers) { for (const redditUser of redditUsers) {
const userMentionExists = await this.databaseService.userMentionExists(redditUser) const userMentionExists = await DatabaseService.userMentionExists(redditUser)
if (userMentionExists) continue if (userMentionExists) continue
const commentResponseRdrama = this.messageService.getRandomRdramaMessage(placeholdersRdrama) const commentResponseRdrama = this.messageService.getRandomRdramaMessage(placeholdersRdrama)
const postedComment = await this.commentPoster.postComment(`c_${comment.id}`, `##### TEST MESSAGE NO REDDITOR PINGED (YET...)\n${commentResponseRdrama}`) const postedComment = await this.commentPoster.postComment(`c_${comment.id}`, `##### TEST MESSAGE NO REDDITOR PINGED (YET...)\n${commentResponseRdrama}`)
//const postedComment = await this.commentPoster.postComment(`c_${comment.id}`, ${commentResponse}`) //TODO uncomment after golive //const postedComment = await this.commentPoster.postComment(`c_${comment.id}`, ${commentResponse}`) //TODO uncomment after golive
console.log(`Sent Comment to`, JSON.stringify(postedComment, null, 4)) console.log(`Sent Comment to`, JSON.stringify(postedComment, null, 4))
const redditSession = await RedditSessionManager.getInstance(this.databaseService) const redditSession = await RedditSessionManager.getInstance()
const redditService = new RedditService(redditSession) const redditService = new RedditService(redditSession)
const resultshouldNotifyUser = await shouldNotifyUser(redditUser, redditService, this.databaseService) const resultshouldNotifyUser = await shouldNotifyUser(redditUser, redditService)
if (!resultshouldNotifyUser) continue if (!resultshouldNotifyUser) continue
const placeholdersReddit = { const placeholdersReddit = {
author_name: comment.author_name, author_name: comment.author_name,
@ -54,7 +53,7 @@ class WorkflowOrchestrator {
permalink: comment.permalink permalink: comment.permalink
}; };
const redditMessage = this.messageService.getRandomRedditMessage(placeholdersReddit) const redditMessage = this.messageService.getRandomRedditMessage(placeholdersReddit)
await this.databaseService.insertUserMention({ await DatabaseService.insertUserMention({
rdrama_comment_id: comment.id, rdrama_comment_id: comment.id,
username: redditUser, username: redditUser,
message: redditMessage, message: redditMessage,