Merge pull request #255 from the-hideout/historical-prices-days

Add ability to specify number of days for historical prices

.github/dependabot.yml

@@ -6,9 +6,9 @@ updates:
   - package-ecosystem: "npm"
     directory: "/"
     schedule:
-      interval: "weekly"
+      interval: "monthly"
 
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "weekly"
+      interval: "monthly"

.github/workflows/branch-deploy.yml

@@ -35,7 +35,7 @@ jobs:
 
       - name: setup node
         if: ${{ steps.branch-deploy.outputs.continue == 'true' }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: .node-version
           cache: npm
@@ -55,7 +55,7 @@ jobs:
           environment: "development"
 
       # Post comment on PR with development deploy info
-      - uses: GrantBirki/[email protected].7
+      - uses: GrantBirki/[email protected].8
         if: ${{ steps.branch-deploy.outputs.continue == 'true' &&
           steps.branch-deploy.outputs.noop != 'true' &&
           steps.branch-deploy.outputs.environment == 'development' }}
@@ -81,7 +81,7 @@ jobs:
           apiToken: ${{ secrets.CF_API_TOKEN }}
 
       # Post comment on PR with production deploy info
-      - uses: GrantBirki/[email protected].7
+      - uses: GrantBirki/[email protected].8
         if: ${{ steps.branch-deploy.outputs.continue == 'true' &&
           steps.branch-deploy.outputs.noop != 'true' &&
           steps.branch-deploy.outputs.environment == 'production' }}

.github/workflows/deploy.yml

@@ -34,7 +34,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: .node-version
           cache: npm

.github/workflows/new-pr.yml

@@ -19,7 +19,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: comment
-        uses: GrantBirki/[email protected].7
+        uses: GrantBirki/[email protected].8
         continue-on-error: true
         with:
           file: .github/new-pr-comment.md

.github/workflows/test.yml

@@ -18,7 +18,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: .node-version
           cache: npm

datasources/historical-prices.js

@@ -3,18 +3,40 @@ const WorkerKV = require('../utils/worker-kv');
 class historicalPricesAPI extends WorkerKV {
     constructor(dataSource) {
         super('historical_price_data', dataSource);
+        this.defaultDays = 7;
+        this.maxDays = 7;
+        this.itemLimitDays = 2;
     }
 
-    async getByItemId(requestId, itemId, limit = 0) {
-        await this.init(requestId);
+    async getByItemId(context, itemId, days = this.defaultDays, halfResults = false) {
+        await this.init(context);
         if (!this.cache) {
             return Promise.reject(new Error('Historical prices cache is empty'));
         }
-        if (!this.cache.historicalPricePoint[itemId]) return [];
-        if (limit) {
-            return this.cache.historicalPricePoint[itemId].slice(Math.max(this.cache.historicalPricePoint[itemId].length - limit, 0));
+
+        if (days > this.maxDays || days < 1) {
+            const warningMessage = `Historical prices days argument of ${days} must be 1-${this.maxDays}; defaulting to ${this.defaultDays}.`;
+            days = this.defaultDays;
+            if (!context.warnings.some(warning => warning.message === warningMessage)) {
+                context.warnings.push({message: warningMessage});
+            }
+        }
+
+        let prices = this.cache.historicalPricePoint[itemId];
+        if (!prices) {
+            return [];
+        }
+        else if (days === this.maxDays) {
+            return prices;
+        }
+        else {
+            const cutoffTimestamp = new Date().setDate(new Date().getDate() - days);
+            let dayFiltered = prices.filter(hp => hp.timestamp >= cutoffTimestamp);
+            if (halfResults) {
+                dayFiltered = dayFiltered.filter((hp, index) => index % 2 === 0);
+            }
+            return dayFiltered;
         }
-        return this.cache.historicalPricePoint[itemId];
     }
 }
 

package.json

@@ -19,12 +19,12 @@
     "license": "ISC",
     "devDependencies": {
         "newman": "^6.0.0",
-        "prettier": "^3.0.3",
+        "prettier": "^3.1.0",
         "wrangler": "^3.10.1"
     },
     "dependencies": {
-        "@graphql-tools/merge": "9.0.0",
-        "@graphql-tools/schema": "10.0.0",
+        "@graphql-tools/merge": "9.0.1",
+        "@graphql-tools/schema": "10.0.2",
         "graphql": "^15.8.0",
         "uuid": "9.0.1"
     }

resolvers/itemResolver.js

@@ -76,7 +76,7 @@ module.exports = {
             return context.data.item.getItemsByBsgCategoryId(context, args.bsgCategoryId, undefined);
         },
         historicalItemPrices(obj, args, context, info) {
-            return context.util.paginate(context.data.historicalPrice.getByItemId(context, args.id), args);
+            return context.util.paginate(context.data.historicalPrice.getByItemId(context, args.id, args.days), args);
         },
         armorMaterials(obj, args, context) {
             return context.data.item.getArmorMaterials(context);
@@ -191,11 +191,11 @@ module.exports = {
         },
         async historicalPrices(data, args, context, info) {
             context.util.testDepthLimit(info, 1);
-            const warningMessage = 'Querying historicalPrices on the Item object will return only the 10 most recent prices. For a full list of historical prices, use the historicalItemPrices query.';
+            const warningMessage = `Querying historicalPrices on the Item object will only provide half the prices from the last ${context.data.historicalPrice.itemLimitDays} days. For up to ${context.data.historicalPrice.maxDays} days of historical prices, use the historicalItemPrices query.`;
             if (!context.warnings.some(warning => warning.message === warningMessage)) {
                 context.warnings.push({message: warningMessage});
             }
-            return context.data.historicalPrice.getByItemId(context, data.id, 10);
+            return context.data.historicalPrice.getByItemId(context, data.id, context.data.historicalPrice.itemLimitDays, true);
         },
         imageLink(data) {
             return data.inspectImageLink;