From 1564a110e02357cf1c4d26ab6b1fee6ac2506651 Mon Sep 17 00:00:00 2001 From: bee! Date: Sun, 24 Sep 2023 13:32:14 -0700 Subject: [PATCH 1/6] allow for publishing entire front instead Signed-off-by: bee! --- .env_example | 3 ++- README.md | 1 + dataManager.js | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++ index.js | 8 +++++-- 4 files changed, 73 insertions(+), 3 deletions(-) diff --git a/.env_example b/.env_example index e8c8531..894f144 100644 --- a/.env_example +++ b/.env_example @@ -8,4 +8,5 @@ userId="abcd1234" pk_token= "PLURALKIT_TOKEN" heartbeat=4500000 max_workers=1 -silence_connections=true \ No newline at end of file +silence_connections=true +full_swap=false \ No newline at end of file diff --git a/README.md b/README.md index d52522d..b4c458c 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,4 @@ These can be set either in the .env file, in terminal, or in the config vars sec | 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/dataManager.js b/dataManager.js index 5e844b5..209cd5e 100644 --- a/dataManager.js +++ b/dataManager.js @@ -106,6 +106,69 @@ 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 = [] + for (member of front) { + let m = await system.getMemberById(member.content.member) + + if (m.content.pkId) { + // fronting member pkID has been found + newFront.push(m.content.pkId) + } + } + + // shift primary fronter to first in list + let primary = await findPrimary() + if (primary) { + if (newFront.indexOf(primary) > 0) { + newFront.splice(newFront.indexOf(primary), 1) + newFront.unshift(primary) + } + } + + // 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 { + console.log('::SimplyWS:: SP\'s front has been published to PK.') + } + }) + .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 fronters = await getPKFronters() @@ -275,6 +338,7 @@ module.exports = { getPKFronters, findPrimary, determineAction, + swapFront, insertFront, removeFront, updateCustomStatus, diff --git a/index.js b/index.js index ea23807..9c82e08 100644 --- a/index.js +++ b/index.js @@ -3,7 +3,7 @@ dotenv.config() const { Config, System } = require('simplyapi') const { Util } = require('simplyapi') -const { initializeCache, determineAction, insertFront, removeFront, updateCustomStatus } = require('./dataManager') +const { initializeCache, determineAction, swapFront, insertFront, removeFront, updateCustomStatus } = require('./dataManager') const { isMainThread, @@ -95,8 +95,12 @@ 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 (o.operationType == "insert") { + if (swap) { + swapFront() + } + else if (o.operationType == "insert") { insertFront(member) } else { From 5e0fe8aa0ce6b91fad31fe3eff41b66314041892 Mon Sep 17 00:00:00 2001 From: bee! Date: Sun, 22 Oct 2023 16:31:10 -0700 Subject: [PATCH 2/6] docker: add dockerfile, format log --- .dockerignore | 2 ++ Dockerfile | 16 ++++++++++++++++ dataManager.js | 36 +++++++++++++++++++++++------------- 3 files changed, 41 insertions(+), 13 deletions(-) create mode 100644 .dockerignore create mode 100644 Dockerfile diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..5171c54 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,2 @@ +node_modules +npm-debug.log \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..1ece624 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,16 @@ +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/dataManager.js b/dataManager.js index 209cd5e..ec1cc5f 100644 --- a/dataManager.js +++ b/dataManager.js @@ -52,7 +52,7 @@ async function findPrimary() { if (fronter.content.customStatus) { if (fronter.content.customStatus.toLowerCase().includes("primary")) { let member = await system.getMemberById(fronter.content.member) - resolve(member.content.pkId) + resolve({ name: member.content.name, pkId: member.content.pkId }) found = true } } @@ -112,21 +112,30 @@ async function swapFront() { // start forming new front list let newFront = [] + let frontNames = [] for (member of front) { let m = await system.getMemberById(member.content.member) if (m.content.pkId) { // fronting member pkID has been found newFront.push(m.content.pkId) + frontNames.push(m.content.name) } } // shift primary fronter to first in list let primary = await findPrimary() - if (primary) { - if (newFront.indexOf(primary) > 0) { - newFront.splice(newFront.indexOf(primary), 1) - newFront.unshift(primary) + 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) } } @@ -146,7 +155,8 @@ async function swapFront() { await swapFront() return } else { - console.log('::SimplyWS:: SP\'s front has been published to PK.') + let formattedNames = frontNames.toString().replace(',',', ') + console.log(`::SimplyWS:: SimplyPlural -> PluralKit: ${formattedNames}`) } }) .catch(async err => { @@ -180,7 +190,7 @@ async function insertFront(member) { } // find the "primary" fronter to move to the first element in the list - let primary = await findPrimary() + let primary = await findPrimary().pkId if (primary) { if (fronters.indexOf(primary) > 0) { fronters.splice(fronters.indexOf(primary), 1) @@ -241,11 +251,11 @@ async function removeFront(member) { } // find the "primary" fronter to move to the first element in the list - let p = await findPrimary() - if (p) { - if (fronters.indexOf(p) > 0) { - fronters.splice(fronters.indexOf(p), 1) - fronters.unshift(p) + let primary = await findPrimary().pkId + if (primary) { + if (fronters.indexOf(primary) > 0) { + fronters.splice(fronters.indexOf(primary), 1) + fronters.unshift(primary) } } @@ -285,7 +295,7 @@ async function removeFront(member) { async function updateCustomStatus(member) { // find the "primary" fronter to move to the first element in the list let fronters = await getPKFronters() - let primary = await findPrimary() + let primary = await findPrimary().pkId if (primary && fronters.length > 1 && (member.content.pkId == primary)) { if (fronters.indexOf(primary) >= 0) { fronters.splice(fronters.indexOf(primary), 1) From 2983fb83e3033640f467ce5e72890030f90d15f9 Mon Sep 17 00:00:00 2001 From: bee! Date: Wed, 19 Jun 2024 21:59:49 -0700 Subject: [PATCH 3/6] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b4c458c..9a8cd91 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ This project already has a Procfile set up, so it's super easy to get started. O These can be set either in the .env file, in terminal, or in the config vars section of Heroku. | Setting | Default | Description | | ---------| ------- | ------------------ | -| url_override | https://v2.apparyllis.com | The base URL for all SimplyPlural API requests. Unless you are running your own fork of Simply Plural, you shouldn't change this. | +| url_override | https://api.apparyllis.com | The base URL for all SimplyPlural API requests. Unless you are running your own fork of Simply Plural, you shouldn't change this. | | api_version | v1 | The target SimplyPlural API version. Unless you are running your own fork of Simply Plural, you shouldn't change this. | -| socket | wss://v2.apparyllis.com/v1/socket | The socket URL for SimplyPlural. Unless you are running your own fork of Simply Plural, you shouldn't change this. | +| socket | wss://api.apparyllis.com/v1/socket | The socket URL for SimplyPlural. Unless you are running your own fork of Simply Plural, you shouldn't change this. | | pk_url | https://api.pluralkit.me/v2 | The base URL for all PluralKit API requests. Unless you are running your own fork of PluralKit, you shouldn't change this. | | 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. | From 0f00694d2e1669f15c8afe0c4c88f494b41a6df1 Mon Sep 17 00:00:00 2001 From: bee! Date: Wed, 19 Jun 2024 22:00:50 -0700 Subject: [PATCH 4/6] Update .env_example --- .env_example | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.env_example b/.env_example index 894f144..ad0e951 100644 --- a/.env_example +++ b/.env_example @@ -1,7 +1,7 @@ # Compatiplural -url_override="https://v2.apparyllis.com" +url_override="https://api.apparyllis.com" api_version="v1" -socket="wss://v2.apparyllis.com/v1/socket" +socket="wss://api.apparyllis.com/v1/socket" pk_url="https://api.pluralkit.me/v2" token="SIMPLYPLURAL_TOKEN" userId="abcd1234" @@ -9,4 +9,5 @@ pk_token= "PLURALKIT_TOKEN" heartbeat=4500000 max_workers=1 silence_connections=true -full_swap=false \ No newline at end of file +full_swap=false +primary_tag="primary " From a764d7b21ce67c4afa0db0888113968c5ca1a9c6 Mon Sep 17 00:00:00 2001 From: bee! Date: Wed, 19 Jun 2024 22:01:14 -0700 Subject: [PATCH 5/6] Update dataManager.js --- dataManager.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dataManager.js b/dataManager.js index ec1cc5f..83c95bf 100644 --- a/dataManager.js +++ b/dataManager.js @@ -50,7 +50,7 @@ async function findPrimary() { return new Promise(async (resolve) => { await Util.asyncForEach(fronters, async (fronter) => { if (fronter.content.customStatus) { - if (fronter.content.customStatus.toLowerCase().includes("primary")) { + if (fronter.content.customStatus.toLowerCase().includes(Config.primary_tag)) { let member = await system.getMemberById(fronter.content.member) resolve({ name: member.content.name, pkId: member.content.pkId }) found = true @@ -353,4 +353,4 @@ module.exports = { removeFront, updateCustomStatus, calculateDiff -} \ No newline at end of file +} From b33335d18a1287d6af8879f6867f03eb75c6f420 Mon Sep 17 00:00:00 2001 From: Bee Date: Thu, 2 Jan 2025 12:22:37 -0800 Subject: [PATCH 6/6] fix: crash when custom front is activated --- .env_example | 7 ++++--- .gitignore | 2 ++ README.md | 4 ++-- dataManager.js | 7 +++++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/.env_example b/.env_example index 894f144..7bf1e2f 100644 --- a/.env_example +++ b/.env_example @@ -1,7 +1,7 @@ # Compatiplural -url_override="https://v2.apparyllis.com" +url_override="https://api.apparyllis.com" api_version="v1" -socket="wss://v2.apparyllis.com/v1/socket" +socket="wss://api.apparyllis.com/v1/socket" pk_url="https://api.pluralkit.me/v2" token="SIMPLYPLURAL_TOKEN" userId="abcd1234" @@ -9,4 +9,5 @@ pk_token= "PLURALKIT_TOKEN" heartbeat=4500000 max_workers=1 silence_connections=true -full_swap=false \ No newline at end of file +full_swap=false +primary_tag="primary" \ No newline at end of file diff --git a/.gitignore b/.gitignore index 0befe13..33014e4 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,5 @@ config.json package-lock.json .env .vercel +docker_build.bat +docker_run.bat diff --git a/README.md b/README.md index b4c458c..9a8cd91 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ This project already has a Procfile set up, so it's super easy to get started. O These can be set either in the .env file, in terminal, or in the config vars section of Heroku. | Setting | Default | Description | | ---------| ------- | ------------------ | -| url_override | https://v2.apparyllis.com | The base URL for all SimplyPlural API requests. Unless you are running your own fork of Simply Plural, you shouldn't change this. | +| url_override | https://api.apparyllis.com | The base URL for all SimplyPlural API requests. Unless you are running your own fork of Simply Plural, you shouldn't change this. | | api_version | v1 | The target SimplyPlural API version. Unless you are running your own fork of Simply Plural, you shouldn't change this. | -| socket | wss://v2.apparyllis.com/v1/socket | The socket URL for SimplyPlural. Unless you are running your own fork of Simply Plural, you shouldn't change this. | +| socket | wss://api.apparyllis.com/v1/socket | The socket URL for SimplyPlural. Unless you are running your own fork of Simply Plural, you shouldn't change this. | | pk_url | https://api.pluralkit.me/v2 | The base URL for all PluralKit API requests. Unless you are running your own fork of PluralKit, you shouldn't change this. | | 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. | diff --git a/dataManager.js b/dataManager.js index ec1cc5f..203df1d 100644 --- a/dataManager.js +++ b/dataManager.js @@ -50,7 +50,7 @@ async function findPrimary() { return new Promise(async (resolve) => { await Util.asyncForEach(fronters, async (fronter) => { if (fronter.content.customStatus) { - if (fronter.content.customStatus.toLowerCase().includes("primary")) { + if (fronter.content.customStatus.toLowerCase().includes(Config.primary_tag)) { let member = await system.getMemberById(fronter.content.member) resolve({ name: member.content.name, pkId: member.content.pkId }) found = true @@ -116,11 +116,14 @@ async function swapFront() { for (member of front) { let m = await system.getMemberById(member.content.member) - if (m.content.pkId) { + 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