aboutsummaryrefslogtreecommitdiff
path: root/src/modules/releases.js
diff options
context:
space:
mode:
author0neGal <mail@0negal.com>2024-01-24 12:03:25 +0100
committer0neGal <mail@0negal.com>2024-01-24 12:03:25 +0100
commit5b3e218d446ac805685e43c8c95ca524755b6601 (patch)
treedf90ee0ebbb2f96582b1817f35535d87eb35b70b /src/modules/releases.js
parente61e640dafdaf5472dee487cc9141f5ae70f0a2e (diff)
downloadViper-5b3e218d446ac805685e43c8c95ca524755b6601.tar.gz
Viper-5b3e218d446ac805685e43c8c95ca524755b6601.zip
entirely refactor src/modules/requests.js
Its now been split into 2, requests.js and releases.js, the latter simply gets relevant info from GitHub release pages. The prior however gives simple functions for doing `GET` requests, and caching the result, and then transparently it'll use that cache when you request it next time. On top of this, some requests made by the renderer will now also use this, and this in turn ends up making loading the mod browser much faster. As instead of having to request the list of packages from Thunderstore, we can simply load the result of an old request. The current lifetime of the cache is 5 minutes, however this can also easily be adjusted. This also moves the cached requests away from <cache_folder>/viper-requests.json, and over to <cache_folder>/Viper/cached-requests.json
Diffstat (limited to 'src/modules/releases.js')
-rw-r--r--src/modules/releases.js80
1 files changed, 80 insertions, 0 deletions
diff --git a/src/modules/releases.js b/src/modules/releases.js
new file mode 100644
index 0000000..c071970
--- /dev/null
+++ b/src/modules/releases.js
@@ -0,0 +1,80 @@
+const requests = require("./requests");
+
+let releases = {
+ notes: {},
+ latest: {}
+}
+
+// gets and returns the release notes of a GitHub repo
+async function github_releases(repo) {
+ let request = false;
+
+ // attempt to perform the request, while caching it
+ try {
+ request = JSON.parse(await requests.get(
+ "api.github.com", `/repos/${repo}/releases`,
+ "release-notes-" + repo
+ ))
+ }catch(err) {
+ // request or parsing failed, return `false`
+ return false;
+ }
+
+ // request is somehow falsy, return `false`
+ if (! request) {
+ return false;
+ }
+
+ // return the actual request as parsed JSON
+ return request;
+}
+
+// returns release notes for Viper
+releases.notes.viper = async () => {
+ return await github_releases("0neGal/viper");
+}
+
+// returns release notes for Northstar
+releases.notes.northstar = async () => {
+ return await github_releases("R2Northstar/Northstar");
+}
+
+// gets and returns some details of the latest release of a GitHub repo
+async function github_latest(repo) {
+ let request = false;
+
+ // attempt to perform the request, while caching it
+ try {
+ request = JSON.parse(await requests.get(
+ "api.github.com", `/repos/${repo}/releases/latest`,
+ "latest-release-" + repo
+ ))
+ }catch(err) {
+ // request or parsing failed, return `false`
+ return false;
+ }
+
+ // request is somehow falsy, return `false`
+ if (! request) {
+ return false;
+ }
+
+ // return the actual request as parsed JSON
+ return {
+ notes: request.body,
+ version: request.tag_name,
+ download_link: request.assets[0].browser_download_url
+ }
+}
+
+// returns latest release for Viper
+releases.latest.viper = async () => {
+ return await github_latest("0neGal/viper");
+}
+
+// returns latest release for Northstar
+releases.latest.northstar = async () => {
+ return await github_latest("R2Northstar/Northstar");
+}
+
+module.exports = releases;