logan/Emmelia-Link-Flayer-Rewrite
1
0
Fork 0
Code Issues 6 Pull Requests Packages Projects 2 Releases Wiki Activity

Updated storage for feeds and posts

Browse Source
This commit is contained in:
Logan Cusano
2023-02-25 14:47:45 -05:00
parent e157fc94e0
commit 12b4a566c7
3 changed files with 233 additions and 191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

215
libStorage.js
View File

@@ -4,11 +4,14 @@
// Import modules
const { DebugBuilder } = require("./utilities/debugBuilder");
const log = new DebugBuilder("server", "libStorage");
const { RSSSourceRecord, RSSPostRecord } = require("./utilities/recordHelper");
// Storage Specific Modules
// MySQL
const mysql = require("mysql");
const rssFeedsTable = process.env.DB_RSS_FEEDS_TABLE;
const rssPostsTable = process.env.DB_RSS_POSTS_TABLE;
// Helper Functions
// Function to run and handle SQL errors
@@ -17,87 +20,100 @@ function runSQL(sqlQuery, connection, callback = (err, rows) => {
throw err;
}) {
// Start the MySQL Connection
//connection.connect();
connection.query(sqlQuery, (err, rows) => {
if (err) {
log.ERROR("SQL Error:", err)
callback(err, undefined);
return callback(err, undefined);
}
log.DEBUG("RunSQL Returned Rows:", rows);
callback(undefined, rows);
log.VERBOSE("RunSQL Returned Rows:", rows);
return callback(undefined, rows);
})
//connection.
}
class RSSRecord {
/**
*
* @param {*} _id
* @param {*} _title
* @param {*} _link
* @param {*} _category
* @param {*} _guild_id
* @param {*} _channel_id
*/
constructor(_id, _title, _link, _category, _guild_id, _channel_id) {
this.id = _id;
this.title = _title;
this.link= _link;
this.category = _category;
this.guild_id = _guild_id;
this.channel_id = _channel_id;
}
getId() {
return this.id;
}
get(key) {
if (!Object.keys(this).includes(key)) throw new Error("Key is invalid", key);
return this[key]
}
}
exports.RSSRecord = RSSRecord;
exports.Storage = class Storage {
class Storage {
constructor(_dbTable) {
this.connection = mysql.createPool({
host: process.env.DB_HOST,
user: process.env.DB_USER,
password: process.env.DB_PASS,
database: process.env.DB_NAME
});
// Set the DB Table for later use
});
this.dbTable = _dbTable
}
/**
* Get a record by a specified key
* @param {*} key The key to search for
* @param {*} keyValue The value of the key to search for
* @param {*} callback The callback function
*/
getRecordBy(key, keyValue, callback) {
const validKeys = ["link", "title", "category", "id"];
if (!validKeys.includes(key)) return callback(new Error("Given key not valid"), undefined);
const sqlQuery = `SELECT * FROM ${this.dbTable} WHERE ${key} = '${keyValue}'`;
runSQL(sqlQuery, this.connection, (err, rows) => {
if (err) return callback(err, undefined);
if (rows[0]?.title) return callback(undefined, rows[0]);
else return callback(undefined, false);
})
}
/**
* Get all records stored
* @param {function} callback
*/
getAllRecords(callback) {
log.INFO("Getting all records");
const sqlQuery = `SELECT * FROM ${this.dbTable}`
let rssRecords = [];
runSQL(sqlQuery, this.connection, (err, rows) => {
if (err) return callback(err, undefined);
for (const row of rows) {
log.VERBOSE("Row from SQL query:", row);
rssRecords.push(new RSSSourceRecord(row.id, row.title, row.link, row.category, row.guild_id, row.channel_id));
}
log.VERBOSE("All records:", rssRecords);
return callback(undefined, rssRecords);
});
}
}
exports.feedStorage = class feedStorage extends Storage {
constructor() {
super(rssFeedsTable);
}
/**
* Wrapper to save a new entry using the storage method configured
* @param {Array} toBeSaved Entry or Entries to be added
* @param {function} callback The callback function to be called with the record when saved
*/
create(toBeSaved, callback) {
create(toBeSaved, callback) {
log.DEBUG("To be saved:", toBeSaved);
log.DEBUG("to be saved length:", toBeSaved.length);
if (!toBeSaved[0].fields?.title) callback(Error("No title given"), undefined);
// If the request was for the Feeds Table
if (!toBeSaved[0].fields?.title) return callback(Error("No title given"), undefined);
let newRecords = []
for (var entry of toBeSaved) {
entry = entry.fields
entry = entry.fields;
log.DEBUG("Entry:", entry);
this.returnRecord(undefined, entry.title, entry.link, entry.category, entry.guild_id, entry.channel_id, (err, record) => {
if (err) callback(err, undefined);
if (err) return callback(err, undefined);
newRecords.push(record);
if (toBeSaved.length === 1) {
log.DEBUG("One record to callback with:", record);
callback(undefined, record);
return callback(undefined, record);
}
})
}, false)
}
if (!toBeSaved.length === 1) {
callback(undefined, newRecords);
}
return callback(undefined, newRecords);
}
}
/**
@@ -106,12 +122,12 @@ exports.Storage = class Storage {
* @param {function} callback The callback function to be called with the record when deleted
*/
destroy(entryID, callback) {
if (!entryID) callback(Error("No entry ID given"), undefined);
if (!entryID) return callback(Error("No entry ID given"), undefined);
this.getRecordBy('id', entryID, (err, entryRecord) => {
this.removeEntry(entryRecord.id, (err, results) => {
if (err) callback(err, undefined);
callback(undefined, results);
if (err) return callback(err, undefined);
return callback(undefined, results);
});
});
}
@@ -122,29 +138,11 @@ exports.Storage = class Storage {
* @returns {true|false|*}
*/
checkForTitle(title, callback) {
if (!title) callback(new Error("No title given when checking for title"), undefined);
if (!title) return callback(new Error("No title given when checking for title"), undefined)
this.getRecordBy("title", title, callback);
}
/**
* Get a record by a specified key
* @param {*} key The key to search for
* @param {*} keyValue The value of the key to search for
*/
getRecordBy(key, keyValue, callback) {
const validKeys = ["link", "title", "category", "id"];
if (!validKeys.includes(key)) callback(new Error("Given key not valid"), undefined);
const sqlQuery = `SELECT * FROM ${this.dbTable} WHERE ${key} = '${keyValue}'`;
runSQL(sqlQuery, this.connection, (err, rows) => {
if (err) callback(err, undefined);
if (rows[0]?.title) callback(undefined, rows[0]);
else callback(undefined, false);
})
}
/**
* Save the given entry to the storage medium
* @param {Object} entryObject The entry object to be saved
@@ -153,7 +151,7 @@ exports.Storage = class Storage {
saveEntry(entryObject, callback) {
log.DEBUG("Saving entry:", entryObject);
if (!entryObject?.title || !entryObject?.link || !entryObject?.category) {
callback(new Error("Entry object malformed, check the object before saving it"), undefined)
return callback(new Error("Entry object malformed, check the object before saving it"), undefined)
}
const sqlQuery = `INSERT INTO ${this.dbTable} (title, link, category, guild_id, channel_id) VALUES ('${entryObject.title}', '${entryObject.link}', '${entryObject.category}', '${entryObject.guild_id}', '${entryObject.channel_id}');`;
@@ -161,8 +159,8 @@ exports.Storage = class Storage {
log.DEBUG(`Adding new entry with SQL query: '${sqlQuery}'`)
runSQL(sqlQuery, this.connection, (err, rows) => {
if (err) callback(err, undefined);
callback(undefined, rows);
if (err) return callback(err, undefined);
return callback(undefined, rows);
})
}
@@ -173,9 +171,9 @@ exports.Storage = class Storage {
*/
updateEntry(entryObject, callback) {
let queryParams = [];
if (!entryObject.title) callback(new Error("No title given before updating"), undefined);
if (!entryObject.title) return callback(new Error("No title given before updating"), undefined);
queryParams.push(`title = '${entryObject.title}'`);
if (!entryObject.link) callback(new Error("No link given before updating"), undefined);
if (!entryObject.link) return callback(new Error("No link given before updating"), undefined);
queryParams.push(`link = '${entryObject.link}'`);
if (entryObject.category) queryParams.push(`category = '${entryObject.category}'`);
if (entryObject.guild_id) queryParams.push(`guild_id = '${entryObject.guild_id}'`);
@@ -200,8 +198,8 @@ exports.Storage = class Storage {
log.DEBUG(`Updating entry with SQL query: '${sqlQuery}'`)
runSQL(sqlQuery, this.connection, (err, rows) => {
if (err) callback(err, undefined);
callback(undefined, rows);
if (err) return callback(err, undefined);
return callback(undefined, rows);
})
}
@@ -212,14 +210,14 @@ exports.Storage = class Storage {
*/
removeEntry(title, callback) {
if (!title) {
callback(new Error("No entry title given before deleting"), undefined)
return callback(new Error("No entry title given before deleting"), undefined)
}
const sqlQuery = `DELETE FROM ${this.dbTable} WHERE title = '${title}';`;
runSQL(sqlQuery, this.connection, (err, rows) => {
if (err) callback(err, undefined);
callback(undefined, rows[0]);
if (err) return callback(err, undefined);
return callback(undefined, rows[0]);
})
}
@@ -231,9 +229,9 @@ exports.Storage = class Storage {
* @param {*} _category The category of the record
* @param {*} callback Callback function to return an error or the record
*/
returnRecord(_id, _title, _link, _category, _guild_id, _channel_id, callback) {
log.DEBUG(`Return record for these values: ID: '${_id}', Title: '${_title}', Category: '${_category}', Link: '${_link}', Guild: '${_guild_id}', Channel:'${_channel_id}'`)
if (!_link && !_title && !_guild_id && !_channel_id) callback(new Error("No link or title given when creating a record"), undefined);
returnRecord(_id, _title, _link, _category, _guild_id, _channel_id, callback, updateEnabled = true) {
log.DEBUG(`Return record for these values: ID: '${_id}', Title: '${_title}', Category: '${_category}', Link: '${_link}', Guild: '${_guild_id}', Channel:'${_channel_id}', Update Enabled: `, updateEnabled)
if (!_link && !_title && !_guild_id && !_channel_id) return callback(new Error("No link or title given when creating a record"), undefined);
let entryObject = {
"title": _title,
"link": _link,
@@ -244,58 +242,41 @@ exports.Storage = class Storage {
if (_id) {
entryObject.id = _id;
if (!updateEnabled) return callback(undefined, undefined);
this.updateEntry(entryObject, (err, rows) => {
if (err) callback(err, undefined);
if (err) return callback(err, undefined);
this.getRecordBy('id', entryObject.id, (err, record) => {
if (err) callback(err, undefined);
callback(undefined, new RSSRecord(record.id, record.title, record.link, record.category, record.guild_id, record.channel_id));
if (err) return callback(err, undefined);
return callback(undefined, new RSSSourceRecord(record.id, record.title, record.link, record.category, record.guild_id, record.channel_id));
})
})
})
}
else {
this.checkForTitle(_title, (err, titleExists) => {
if (!titleExists) {
log.DEBUG("Entry doesn't exist, making one now", entryObject);
this.saveEntry(entryObject, (err, rows) => {
if (err) callback(err, undefined);
if (err) return callback(err, undefined);
this.getRecordBy("title", entryObject.title, (err, record) => {
if (err) callback(err, undefined);
callback(undefined, new RSSRecord(record.id, record.title, record.link, record.category, record.guild_id, record.channel_id));
if (err) return callback(err, undefined);
return callback(undefined, new RSSSourceRecord(record.id, record.title, record.link, record.category, record.guild_id, record.channel_id));
})
});
}
else{
if (!updateEnabled) return callback(undefined, undefined);
this.updateEntry(entryObject, (err, rows) => {
if (err) callback(err, undefined);
if (err) return callback(err, undefined);
this.getRecordBy('title', entryObject.title, (err, record) => {
if (err) callback(err, undefined);
callback(undefined, new RSSRecord(record.id, record.title, record.link, record.category, record.guild_id, record.channel_id));
if (err) return callback(err, undefined);
return callback(undefined, new RSSSourceRecord(record.id, record.title, record.link, record.category, record.guild_id, record.channel_id));
})
})
})
}
})
}
}
/**
* Get all records stored
* @param {function} callback
*/
getAllRecords(callback) {
log.INFO("Getting all records");
const sqlQuery = `SELECT * FROM ${this.dbTable}`
let rssRecords = [];
runSQL(sqlQuery, this.connection, (err, rows) => {
if (err) callback(err, undefined);
for (const row of rows) {
log.DEBUG("Row from SQL query:", row);
rssRecords.push(new RSSRecord(row.id, row.title, row.link, row.category, row.guild_id, row.channel_id));
}
log.DEBUG("All records:", rssRecords);
callback(undefined, rssRecords);
});
}
}
}
}