diff --git a/.dockerignore b/.dockerignore deleted file mode 100644 index 5171c54..0000000 --- a/.dockerignore +++ /dev/null @@ -1,2 +0,0 @@ -node_modules -npm-debug.log \ No newline at end of file diff --git a/.env_example b/.env_example index ad0e951..44e4dda 100644 --- a/.env_example +++ b/.env_example @@ -3,11 +3,8 @@ url_override="https://api.apparyllis.com" api_version="v1" socket="wss://api.apparyllis.com/v1/socket" pk_url="https://api.pluralkit.me/v2" -token="SIMPLYPLURAL_TOKEN" -userId="abcd1234" -pk_token= "PLURALKIT_TOKEN" -heartbeat=4500000 -max_workers=1 -silence_connections=true -full_swap=false -primary_tag="primary " +token="AAAAAAAAAAAAAAAAAAAA" +userId="AAAAAAAAAAAAAAAAAAA" +pk_token= "AAAAAAAAAAAAAAAA" +pk_system="AAAAAAAAAAAAAAAA" +heartbeat=4500000 \ No newline at end of file diff --git a/.gitignore b/.gitignore index 33014e4..0befe13 100644 --- a/.gitignore +++ b/.gitignore @@ -5,5 +5,3 @@ config.json package-lock.json .env .vercel -docker_build.bat -docker_run.bat diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index 1ece624..0000000 --- a/Dockerfile +++ /dev/null @@ -1,16 +0,0 @@ -FROM node:18 - -WORKDIR /usr/src/app - -COPY package*.json ./ -RUN npm install - -# If you are building your code for production -# RUN npm ci --omit=dev - -# Bundle app source -COPY . . - -#EXPOSE 8080 - -CMD [ "node", "index.js" ] \ No newline at end of file diff --git a/README.md b/README.md index 9a8cd91..246a115 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,5 @@ These can be set either in the .env file, in terminal, or in the config vars sec | token | token_here | Your SimplyPlural account token. As of now, the only permission necessary is the Read permission. | | userId | user_id | Your SimplyPlural account/system ID. You can find it in account info near the bottom. | | pk_token | pluralkit_token_here | Your PluralKit token. Get it by using `pk;token`. | +| pk_system | pluralkit_system_id | Your Pluralkit system ID. This can be either your Discord account ID or your 5 letter ID shown by using pk;system. | | heartbeat | 4500000 | The time in miliseconds before the websocket client reconnects to the websocket server. | -| max_workers | 1 | Max number of workers for processing enqueued tasks. This probably shouldn't be changed. | -| silence_connections | true | Whether or not to silence the websocket connection and authentication messages. | -| full_swap | false | Determines whether to completely overwrite PluralKit's front with SimplyPlural's. No individual changes. | diff --git a/WebsocketClient.js b/WebsocketClient.js index bc40b9e..f10f9f5 100644 --- a/WebsocketClient.js +++ b/WebsocketClient.js @@ -7,7 +7,7 @@ function WebSocketClient(url) { let connecting = false let backoff = 250 const init = () => { - if (!process.env.silence_connections) console.error(`::SimplyWS:: [${timestamp()}] connecting`) + console.error(`::SimplyWS:: [${timestamp()}] connecting`) connecting = false if (client !== undefined) { client.removeAllListeners() @@ -21,14 +21,14 @@ function WebSocketClient(url) { timeout = setTimeout(() => client.terminate(), process.env.heartbeat || 350000) } client.on('ping', () => { - if (!process.env.silence_connections) console.log(`::SimplyWS:: [${timestamp()}] pinged`) + console.log(`::SimplyWS:: [${timestamp()}] pinged`) heartbeat() }) client.on('open', (e) => { if (typeof this.onOpen === 'function') { this.onOpen() } else { - if (!process.env.silence_connections) console.log(`::SimplyWS:: [${timestamp()}] opened`) + console.log(`::SimplyWS:: [${timestamp()}] opened`) console.log(e) } heartbeat() @@ -37,7 +37,7 @@ function WebSocketClient(url) { if (typeof this.onMessage === 'function') { this.onMessage(e) } else { - if (!process.env.silence_connections) console.log(`::SimplyWS:: [${timestamp()}] messaged`) + console.log(`::SimplyWS:: [${timestamp()}] messaged`) } heartbeat() }) diff --git a/dataManager.js b/dataManager.js index 64f13c4..56ef124 100644 --- a/dataManager.js +++ b/dataManager.js @@ -1,9 +1,9 @@ const axios = require('axios') -const { Config, System, Util } = require('simplyapi') +const { Config, System, Util } = require('SimplyAPI') const pkUrl = Config.pk_url const pkHeader = { - 'Content-Type': 'application/json; charset=UTF-8', + 'Content-Type': 'application/json', 'Authorization': Config.pk_token } @@ -13,6 +13,10 @@ async function initializeCache() { cache.frontHistory = await system.getFronters() } +function unknownError400() { + return +} + function unknownTarget(target) { console.log('::SimplyWS:: Unknown update target: ' + target + '\n::SimplyWS:: Full message: ' + e) } @@ -21,9 +25,15 @@ function unrecognizedMessage(msg) { console.log('::SimplyWS:: Unrecognized message: ' + msg + '\n::SimplyWS:: Full message: ' + e) } +// async function asyncForEach(array, callback) { +// for (let index = 0; index < array.length; index++) { +// await callback(array[index], index, array) +// } +// } + async function getPKFronters() { let members = [] - let fronters = await axios.get(`${pkUrl}/systems/@me/fronters`, { + let fronters = await axios.get(`${pkUrl}/systems/${Config.pk_system}/fronters`, { headers: pkHeader }) .catch((err) => { @@ -50,9 +60,9 @@ async function findPrimary() { return new Promise(async (resolve) => { await Util.asyncForEach(fronters, async (fronter) => { if (fronter.content.customStatus) { - if (fronter.content.customStatus.toLowerCase().includes(Config.primary_tag)) { + if (fronter.content.customStatus.toLowerCase().includes("primary")) { let member = await system.getMemberById(fronter.content.member) - resolve({ name: member.content.name, pkId: member.content.pkId }) + resolve(member.content.pkId) found = true } } @@ -106,94 +116,14 @@ async function determineAction(eventData, frontData = []) { return action } -async function swapFront() { - let system = new System(Config) - let front = await system.getFronters() - - // start forming new front list - let newFront = [] - let frontNames = [] - for (member of front) { - let m = await system.getMemberById(member.content.member) - - if (m.content && m.content.pkId) { - // fronting member pkID has been found - newFront.push(m.content.pkId) - frontNames.push(m.content.name) - } - else { - console.warn('::SimplyWS:: System member not found, this may be a custom front which is unsupported.') - } - } - - // shift primary fronter to first in list - let primary = await findPrimary() - let primaryPK = primary.pkId - let primaryName = primary.name - if (primaryPK) { - if (newFront.indexOf(primaryPK) > 0) { - newFront.splice(newFront.indexOf(primaryPK), 1) - newFront.unshift(primaryPK) - } - - if (frontNames.indexOf(primaryName) > 0) { - frontNames.splice(frontNames.indexOf(primaryName), 1) - frontNames.unshift(primaryName) - } - } - - // post the new switch - let url = `${pkUrl}/systems/@me/switches` - await axios.post(url, JSON.stringify({ "members": newFront }), { - headers: pkHeader - }) - .then(async (res) => { - // check if current front equals the new front - let front = await getPKFronters() - var equal = (front.length == newFront.length) && front.every(function(element, index) { - return element === newFront[index]; - }) - if (!equal) { - console.log('::SimplyWS:: Failed to swap front: ' + newFront) - await swapFront() - return - } else { - let formattedNames = frontNames.toString().replace(',',', ') - console.log(`::SimplyWS:: SimplyPlural -> PluralKit: ${formattedNames}`) - } - }) - .catch(async err => { - let status = err.status || err.toJSON().status - if (status == 400) { - // if the fronter is already in the front, do nothing - return - } - else if (status == 404) { - return - } - else if (status == 429) { - // Too many requests - console.warn("::SimplyWS:: Too many requests, waiting to try again.") - setTimeout(async function () { - await swapFront() - }, 1000) - return - } - }) -} - async function insertFront(member) { // get current fronters and add new fronter + let system = new System(Config) let fronters = await getPKFronters() - if (!fronters.includes(member.content.pkId)) { - fronters.push(member.content.pkId) - } else { - console.warn('::SimplyWS:: Member already in fronters: ' + member.content.pkId) - return - } + fronters.push(member.content.pkId) // find the "primary" fronter to move to the first element in the list - let primary = await findPrimary().pkId + let primary = await findPrimary() if (primary) { if (fronters.indexOf(primary) > 0) { fronters.splice(fronters.indexOf(primary), 1) @@ -201,117 +131,97 @@ async function insertFront(member) { } } - // post the new switch - let url = `${pkUrl}/systems/@me/switches` - await axios.post(url, JSON.stringify({ "members": fronters }), { + // cache front + cache.frontHistory = await system.getFronters() + + // post the new switch + axios.post(`${pkUrl}/systems/${Config.pk_system}/switches`, JSON.stringify({ "members": fronters }), { headers: pkHeader }) - .then(async (res) => { - let front = await getPKFronters() - if (!front.includes(member.content.pkId)) { - console.log('::SimplyWS:: Failed to insert fronter: ' + member.content.pkId) - await insertFront(member) - return - } else { - console.log('::SimplyWS:: ' + member.content.name + ' was added to the front.') - } - }) - .catch(async err => { - let status = err.status || err.toJSON().status - if (status == 400) { - // if the fronter is already in the front, do nothing - return - } - else if (status == 404) { - // member not found - console.error("::SimplyWS:: Could not find member: " + member.content.pkId) - let index = fronters.indexOf(member.content.pkId) - fronters.splice(index, 1) - return - } - else if (status == 429) { + .catch(err => { + if (err.toJSON().status == 400) + unknownError400() + else if (err.toJSON().status == 429) // Too many requests - console.warn("::SimplyWS:: Too many requests, waiting to try again.") - let index = fronters.indexOf(member.content.pkId) - fronters.splice(index, 1) - setTimeout(async function () { - await insertFront(member) + setTimeout(function () { + insertFront(member) }, 1000) return - } }) + + let checkFront = await getPKFronters() + if (!checkFront.includes(member.content.pkId)) { + await insertFront(member) + return + } else { + console.log('::SimplyWS:: ' + member.content.name + ' was added to the front.') + } } async function removeFront(member) { + let system = new System(Config) let fronters = await getPKFronters() - - if (fronters.includes(member.content.pkId)) { - let index = fronters.indexOf(member.content.pkId) - fronters.splice(index, 1) - } else { - console.warn('::SimplyWS:: Member is not in front: ' + member.content.pkId) - return - } + let index = fronters.indexOf(member.content.pkId) + fronters.splice(index, 1) // find the "primary" fronter to move to the first element in the list - let primary = await findPrimary().pkId - if (primary) { - if (fronters.indexOf(primary) > 0) { - fronters.splice(fronters.indexOf(primary), 1) - fronters.unshift(primary) + let p = await findPrimary() + if (p) { + if (fronters.indexOf(p) > 0) { + fronters.splice(fronters.indexOf(p), 1) + fronters.unshift(p) } } - let url = `${pkUrl}/systems/@me/switches` - await axios.post(url, JSON.stringify({ "members": fronters }), { + // cache front + cache.frontHistory = await system.getFronters() + + // post the new switch + axios.post(`${pkUrl}/systems/${Config.pk_system}/switches`, JSON.stringify({ "members": fronters }), { headers: pkHeader }) - .then(async (res) => { - let front = await getPKFronters() - if (front.includes(member.content.pkId)) { - console.log('::SimplyWS:: Failed to remove fronter: ' + member.content.pkId) - await removeFront(member) - return - } else { - console.log('::SimplyWS:: ' + member.content.name + ' was removed from the front.') - } - }) - .catch(async err => { - let status = err.status || err.toJSON().status - if (status == 400) { - // fronter is already not in front - console.warn("::SimplyWS:: " + member.content.name + " is not in the front.") - return - } - else if (status == 429) { + .catch(err => { + if (err.toJSON().status == 400) + unknownError400() + else if (err.toJSON().status == 429) // Too many requests - console.warn("::SimplyWS:: Too many requests, waiting to try again.") - fronters.push(member.content.pkId) - setTimeout(async function () { - await removeFront(member) + setTimeout(function () { + removeFront(member) }, 1000) return - } }) + + let checkFront = await getPKFronters() + if (checkFront.includes(member.content.pkId)) { + await removeFront(member) + return + } else { + console.log('::SimplyWS:: ' + member.content.name + ' was removed from the front.') + } } async function updateCustomStatus(member) { // find the "primary" fronter to move to the first element in the list + let system = new System(Config) let fronters = await getPKFronters() - let primary = await findPrimary().pkId - if (primary && fronters.length > 1 && (member.content.pkId == primary)) { + let primary = await findPrimary() + if (primary && fronters.length > 1) { if (fronters.indexOf(primary) >= 0) { fronters.splice(fronters.indexOf(primary), 1) fronters.unshift(primary) + // cache front + cache.frontHistory = await system.getFronters() + // post the new switch - axios.post(`${pkUrl}/systems/@me/switches`, JSON.stringify({ "members": fronters }), { + axios.post(`${pkUrl}/systems/${Config.pk_system}/switches`, JSON.stringify({ "members": fronters }), { headers: pkHeader }) - .catch(async err => { - if (err.toJSON().status == 429) - //Too many requests - console.warn("::SimplyWS:: Too many requests, waiting to try again.") + .catch(err => { + if (err.toJSON().status == 400) + unknownError400() + else if (err.toJSON().status == 429) + // Too many requests setTimeout(function () { updateCustomStatus(member) }, 1000) @@ -326,16 +236,19 @@ async function updateCustomStatus(member) { } } +const { inspect } = require('util') const transform = require('lodash.transform') const isEqual = require('lodash.isequal') +const isArray = require('lodash.isarray') const isObject = require('lodash.isobject') +const { PassThrough } = require('stream') async function calculateDiff(origObj, newObj) { return new Promise(function (resolve) { changes = (newObj, origObj) => { let arrayIndexCounter = 0 return transform(newObj, function (result, value, key) { if (!isEqual(value, origObj[key])) { - let resultKey = Array.isArray(origObj) ? arrayIndexCounter++ : key + let resultKey = isArray(origObj) ? arrayIndexCounter++ : key result[resultKey] = (isObject(value) && isObject(origObj[key])) ? changes(value, origObj[key]) : value } }) @@ -346,14 +259,14 @@ async function calculateDiff(origObj, newObj) { module.exports = { initializeCache, + unknownError400, unknownTarget, unrecognizedMessage, getPKFronters, findPrimary, determineAction, - swapFront, insertFront, removeFront, updateCustomStatus, calculateDiff -} +} \ No newline at end of file diff --git a/index.js b/index.js index 9c82e08..db416bd 100644 --- a/index.js +++ b/index.js @@ -1,66 +1,23 @@ const dotenv = require('dotenv') dotenv.config() -const { Config, System } = require('simplyapi') -const { Util } = require('simplyapi') -const { initializeCache, determineAction, swapFront, insertFront, removeFront, updateCustomStatus } = require('./dataManager') - -const { - isMainThread, - BroadcastChannel, - Worker -} = require('node:worker_threads') +const { Config, System } = require('SimplyAPI') +const { Util } = require('SimplyAPI') +const { initializeCache, determineAction, insertFront, removeFront, updateCustomStatus } = require('./dataManager') let e -main = () => { - initiateWorkerPool() +main = async () => { + openWebSocket() } -// Queue -const async = require('async') -const queue = async.queue((task, completed) => { - let error = { status: false, message: '' } - update(task.data) - .catch(err => { - error.status = true - error.message = err - }) - completed(error, task) - -}, Config.max_workers) - -initiateWorkerPool = () => { - // Worker Pool - const bc = new BroadcastChannel('plural') - - if (isMainThread) { - openWebSocket() - - bc.onmessage = (event) => { - //console.log('::SimplyWS:: received message from worker') - queue.push(event.data, (error, task) => { - // task completed - if (error.status) { - console.log(`An error occurred while processing task ${error.message}`) - } - }) - } - for (let n = 0; n < Config.max_workers; n++) - new Worker(__filename) - } -} - -// Socket -openWebSocket = () => { +openWebSocket = async () => { const WebSocketClient = require('./WebsocketClient') - const wss = new WebSocketClient(Config.socket) + const wss = new WebSocketClient(Config.socket); let initialPacket = { "op": "authenticate", "token": Config.token } wss.onOpen = (_) => { wss.send(JSON.stringify(initialPacket)); } wss.onClose = (e) => { console.log('SimplyWS/onClose :: %s', e); e = '' } wss.onError = (e) => { console.log('SimplyWS/onError :: %s', e) } - const bc = new BroadcastChannel('plural') - let first_auth = true wss.onMessage = (raw) => { e = raw let data = JSON.parse(e) @@ -68,16 +25,15 @@ openWebSocket = () => { switch (data.msg) { case "Successfully authenticated": - if (!process.env.silence_connections || first_auth) console.log('::SimplyWS:: authenticated') - first_auth = false + console.log('::SimplyWS:: authenticated') // cache current front initializeCache() break case "Authentication violation: Token is missing or invalid. Goodbye :)": - console.error('::SimplyWS:: invalid token, exiting..') + console.log('::SimplyWS:: invalid token, exiting..') process.exit(1) case "update": - bc.postMessage({data: data}) + update(data) break default: //unrecognizedMessage(data.msg) @@ -86,7 +42,6 @@ openWebSocket = () => { } } -// Data Processing update = async (data) => { let target = data.target switch (target) { @@ -95,12 +50,8 @@ update = async (data) => { await Util.asyncForEach(data.results, async (o) => { let system = new System(Config) let member = await system.getMemberById(o.content.member) - let swap = Config.full_swap // insert - if (swap) { - swapFront() - } - else if (o.operationType == "insert") { + if (o.operationType == "insert") { insertFront(member) } else { diff --git a/package.json b/package.json index 1b81ed4..5cf0e9c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "Compatiplural", - "version": "1.1.0", + "version": "1.0.0", "description": "SimplyPlural -> PluralKit Connectivity", "main": "index.js", "scripts": { @@ -12,13 +12,13 @@ "repository": "github:padlocks/Compatiplural", "dependencies": { "ajv": "^8.10.0", - "async": "^3.2.3", "axios": "^0.26.0", "dotenv": "^16.0.0", + "lodash.isarray": "^4.0.0", "lodash.isequal": "^4.5.0", "lodash.isobject": "^3.0.2", "lodash.transform": "^4.6.0", - "simplyapi": "^0.1.4", + "simplyapi": "^0.1.1", "ws": "^8.5.0" }, "optionalDependencies": {