summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorJulien Dessaux2023-05-24 23:03:19 +0200
committerJulien Dessaux2023-05-24 23:03:19 +0200
commit9963ab79b7c7392d5f87c98cd55953ffa004efd9 (patch)
treeefcd42cbe0f2614c863a05c77d797c7a4645b003 /lib
parentImplemented a basic extraction loop (diff)
downloadspacetraders-9963ab79b7c7392d5f87c98cd55953ffa004efd9.tar.gz
spacetraders-9963ab79b7c7392d5f87c98cd55953ffa004efd9.tar.bz2
spacetraders-9963ab79b7c7392d5f87c98cd55953ffa004efd9.zip
Rewrote the api rate limiter with promises instead of callbacks
Diffstat (limited to 'lib')
-rw-r--r--lib/api.js67
-rw-r--r--lib/systems.js36
2 files changed, 67 insertions, 36 deletions
diff --git a/lib/api.js b/lib/api.js
index b1cdcb8..bbb2977 100644
--- a/lib/api.js
+++ b/lib/api.js
@@ -5,32 +5,28 @@ let busy = false; // lets us know if we are already sending api requests or not.
let headers = undefined; // a file scope variable so that we only evaluate these once.
let queue = new PriorityQueue(); // a priority queue to hold api calls we want to send, allows for throttling.
-// chain takes an array of actions as argument. For each one it sets the `next` property.
-// example action: {
-// action: function to call,
-// next: optional nested action object, would get overriden by this function, except for the last action,
-// ... other attributes as required by the action function (for example ship or waypoing symbol...)
-// }
-export function chain(actions) {
- for(let i=actions.length-1;i>0;--i) {
- actions[i-1].next = actions[i];
- }
- actions[0].action(actions[0]);
-}
-
-// send takes a data object as argument
-// example data: {
+// send takes a request object as argument and an optional context ctx
+// example request: {
// endpoint: the url endpoint to call,
// method: HTTP method for `fetch` call, defaults to 'GET',
-// next: optional nested action object, as specified above with the chain function,
// payload: optional json object that will be send along with the request,
+// priority: optional priority value (defaults to 10, lower than 10 means the message will be sent faster)
// }
-export function send(data) {
- if (!busy) {
- send_this(data);
- } else {
- queue.enqueue(data, data.priority ? data.priority : 10);
- }
+export function send(request, ctx) {
+ return new Promise((resolve, reject) => {
+ let data = {
+ ctx: ctx,
+ reject: reject,
+ request: request,
+ resolve: resolve,
+ };
+ if (!busy) {
+ busy = true;
+ send_this(data);
+ } else {
+ queue.enqueue(data, request.priority ? request.priority : 10);
+ }
+ });
}
function send_next() {
@@ -41,6 +37,7 @@ function send_next() {
}
}
+// send_this take a data object as argument built in the send function above
function send_this(data) {
if (headers === undefined) {
const token = getToken();
@@ -55,22 +52,20 @@ function send_this(data) {
let options = {
headers: headers,
};
- if (data.method !== undefined) {
- options['method'] = data.method;
+ if (data.request.method !== undefined) {
+ options['method'] = data.request.method;
}
- if (data.payload !== undefined) {
- options['body'] = JSON.stringify(data.payload);
+ if (data.request.payload !== undefined) {
+ options['body'] = JSON.stringify(data.request.payload);
}
- busy = true;
- fetch(`https://api.spacetraders.io/v2${data.endpoint}`, options)
+ fetch(`https://api.spacetraders.io/v2${data.request.endpoint}`, options)
.then(response => response.json())
- .then(response => {
- if (data.next !== undefined) { // if we have a next action, call it now
- data.next.action(data.next, response);
- } else { // otherwise use this debug action
- console.log(JSON.stringify(response, null, 2));
- }
- })
- .catch(err => console.error(err));
+ .then(response => data.resolve(response))
+ .catch(err => data.reject(err));
setTimeout(send_next, 500);
}
+
+export function debugLog(ctx) {
+ console.log(`--- ${Date()} -----------------------------------------------------------------------------`);
+ console.log(JSON.stringify(ctx, null, 2));
+}
diff --git a/lib/systems.js b/lib/systems.js
new file mode 100644
index 0000000..ad354e4
--- /dev/null
+++ b/lib/systems.js
@@ -0,0 +1,36 @@
+import * as api from './api.js';
+import * as db from '../database/systems.js';
+
+// Retrieves a list of waypoints that have a specific ctx.trait like a SHIPYARD or a MARKETPLACE in the system ctx.symbol
+export async function trait(ctx) {
+ const s = await getSystem(ctx);
+ return s.filter(s => s.traits.some(t => t.symbol === ctx.trait));
+}
+
+// Retrieves a list of waypoints that have a specific ctx.type like ASTEROID_FIELD in the system ctx.symbol
+export async function type(ctx, response) {
+ const s = await getSystem(ctx);
+ return s.filter(s => s.type === ctx.type);
+}
+
+// Retrieves the system's information for ctx.symbol and cache it in the database
+async function getSystem(ctx) {
+ let s = db.getSystem(ctx.symbol);
+ if (s === null) {
+ const response = await api.send({endpoint: `/systems/${ctx.symbol}/waypoints?limit=20&page=1`});
+ if (response.error !== undefined) {
+ switch(response.error.code) {
+ case 404:
+ throw `Error retrieving waypoints for system ${ctx.symbol}: ${response.error.message}`;
+ default: // yet unhandled error
+ throw response;
+ }
+ }
+ if (response.meta !== undefined && response.meta.total > response.meta.limit) {
+ throw `Error retrieving waypoints for system ${ctx.symbol}: Pagination is not implemented yet!`;
+ }
+ s = response.data;
+ db.setSystem(ctx.symbol, s);
+ }
+ return s;
+}