Update README.md

Bumps schliflo/docker-puppeteer from 21.2.0 to 21.3.4.

---
updated-dependencies:
- dependency-name: schliflo/docker-puppeteer
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "23:30"
+- package-ecosystem: docker
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "23:30"

.github/workflows/auto-merge-dependabot.yml

@@ -0,0 +1,27 @@
+name: Dependabot auto-merge release-updates
+on: pull_request
+
+# Based on https://docs.github.com/en/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions#enable-auto-merge-on-a-pull-request
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.3.1
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - uses: actions/checkout@v3
+        name: Clone self repository
+        with:
+          ref: ${{ github.head_ref }}
+      - name: Enable auto-merge for Dependabot PRs for release data
+        run: gh pr merge --auto --rebase "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.npmignore

@@ -1,3 +1,9 @@
 .git
 node_modules
-METRICS.md
+METRICS.md
+hooks/
+.editorconfig
+.github
+CHANGELOG.md
+Dockerfile
+SECURITY.md

CHANGELOG.md

@@ -1,40 +1,64 @@
 # CHANGELOG
 
-# 2.0.9
+# 3.0.1
+## Changed
+- Puppeteer update
 
+# 3.0.0
+## Changed
+- Dependency updates
+- Changed timeout to 5 seconds for page load (was set to default of 30 seconds)
+- Adds caching so it returns the last best response instead of a 500
+## Fixed
+- Breaking API Change: Returned promise now works better by throwing errors in case of failures (instead of returning null)
+
+# 2.0.13
+## Changed
+- Dependency updates
+
+# 2.0.12
+## Changed
+- Dependency updates
+
+# 2.0.11
+## Changed
+- Dependency updates
+
+# 2.0.9
+## Changed
 - Bumps puppeteer to 3.0.1
 
 # 2.0.0
-
+## Changed
 - Bumps puppeteer to `1.20.0`
 
 # 2.0.7
-
+## Changed
 - Bumps puppeteer to `1.18.0`
 
 # 2.0.6
-
+## Changed
 - Dependency updates and Docker fixes
 
 # 2.0.5
-
+## Changed
 - Upgrade puppeteer to 1.17.0
 
 # 2.0.4
-
+## Changed
 - Upgrade puppeteer to 1.16.0
 
 # 2.0.3
-
+## Changed
 - Upgrade puppeteer to 1.15.0
 - Switches docker base image from `alekzonder/puppeteer` to `schliflo/docker-puppeteer` since the former is unmaintained
 
 # 2.0.2
-
+## Changed
 - Upgrade puppeteer to 1.8.0
 
 # 2.0.0-beta
-
+## Changed
 - Adds support for Flexibytes and aggregate metrics
 - Standardized Prometheus formatting to support 3 categories: `live/flexibytes/aggregate`
 - Added standard [schema labels](http://label-schema.org/) in Dockerfile
@@ -42,18 +66,18 @@
 - Changed return format of `.getUsage()` method
 
 # 1.0.2
-
+## Changed
 - Switches to bytes as the unit in the metrics endpoint
 - Removed `_total` as suffix from the metric labels
 - The API now returns 2 extra fields: `usedBytes/totalBytes`
 - Now added to the [Prometheus Miscellaneous Exporters list](https://prometheus.io/docs/instrumenting/exporters/#miscellaneous)
 
 # 1.0.1
-
+## Changed
 - Fixes a bug with only the first request giving a 200 on the metrics endpoint
 - Pre-build docker image available at `captn3m0/prometheus-act-exporter`
 - Disables Chrome sandbox only if running inside a container
 
 # 1.0.0
-
+## Changed
 - Initial version

COPYING

@@ -1,7 +1,7 @@
             DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
                     Version 2, December 2004
 
- Copyright (C) 2019 Abhay Rana <me@captnemo.in>
+ Copyright (C) 2022 Abhay Rana <me@captnemo.in>
 
  Everyone is permitted to copy and distribute verbatim or modified
  copies of this license document, and changing it is allowed as long

Dockerfile

@@ -1,25 +1,15 @@
-FROM schliflo/docker-puppeteer:3.0.1
+FROM schliflo/docker-puppeteer:21.3.4
 
 LABEL maintainer "Nemo <docker@captnemo.in>"
 
-ARG BUILD_DATE
-ARG VCS_REF
-
 WORKDIR /app
 
 COPY package.json package-lock.json /app/
 
 RUN npm install
 
-LABEL org.label-schema.build-date=$BUILD_DATE \
-      org.label-schema.name="Prometheus ACT Exporter" \
-      org.label-schema.vcs-url="https://git.captnemo.in/nemo/prometheus-act-exporter.git" \
-      org.label-schema.url="https://git.captnemo.in/nemo/prometheus-act-exporter" \
-      org.label-schema.vcs-ref=$VCS_REF \
-      org.label-schema.schema-version="1.0.0-rc1"
+COPY index.js server.js prom.js *.md /app/
 
-COPY index.js server.js prom.js *.md init.sh /app/
-
-ENTRYPOINT ["/app/init.sh"]
+ENTRYPOINT ["/usr/local/bin/node", "server.js"]
 
 EXPOSE 3000

README.md

@@ -1,8 +1,10 @@
 # prometheus-act-exporter
 
-[![](https://images.microbadger.com/badges/version/captn3m0/prometheus-act-exporter:2.0.8.svg)](https://microbadger.com/images/captn3m0/prometheus-act-exporter:2.0.8) [![npm version](https://badge.fury.io/js/prometheus-act-exporter.svg)](https://badge.fury.io/js/prometheus-act-exporter) [![License: WTFPL](https://img.shields.io/badge/License-WTFPL-blue.svg)](http://www.wtfpl.net/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+![Docker Image Version (latest semver)](https://img.shields.io/docker/v/captn3m0/prometheus-act-exporter) ![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/captn3m0/prometheus-act-exporter) [![npm version](https://badge.fury.io/js/prometheus-act-exporter.svg)](https://badge.fury.io/js/prometheus-act-exporter) [![License: WTFPL](https://img.shields.io/badge/License-WTFPL-blue.svg)](http://www.wtfpl.net/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
 
-Exposes your current ACT FUP usage as prometheus metrics. Scrapes the data from the ACT Portal website by using puppeteer.
+Exposes your current ACT FUP usage as prometheus metrics. Scrapes the data from the ACT Portal website by using [puppeteer](https://developers.google.com/web/tools/puppeteer/). This only supports [ACT Fibernet](https://www.actcorp.in/) in India.
+
+**Note**: Broken since the portal got redesigned and now requires authentication.
 
 - Supports flexibytes
 - Reports aggregate metrics as well
@@ -59,7 +61,7 @@ let m = await act.getUsage();
 You can pass the following environment variables:
 
 1.  `PROXY_SERVER`: Use a proxy server to connect to ACT. Use a `socks5` proxy, since ACT returns a 403 if you try to use a CONNECT proxy. `export PROXY_SERVER="socks5://10.8.0.14:1080"`
-2.  `CHROME_BIN`: Set Chrome/Chromium executable path.
+2.  `CHROME_BIN`: Set Chrome/Chromium executable path. Helpful if you have chromium already installed and don't want puppeteer to download it again. You can set `PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=1` before running `npm install` to disable puppeteer's chromium download.
 3.  `DISABLE_HEADLESS`: If set, chrome will not launch in headless mode.
 
 # Usage
@@ -68,11 +70,21 @@ You can pass the following environment variables:
 
 If running via Docker, here are some simple cookbook configurations:
 
-docker run -it -p 3000:3000 -e captn3m0/prometheus-act-exporter
-: Run a simple test server locally in debug mode and test it on http://localhost:3000
+`docker run -it -p 3000:3000 -e captn3m0/prometheus-act-exporter`
+
+Run a simple test server locally in debug mode and test it on `http://localhost:3000/metrics`
+
+## Node
+
+```sh
+export DISABLE_HEADLESS=1
+# Change to the correct invocation
+export CHROME_BIN=$(which chromium)
+npm install
+node server.js
+curl localhost:3000/metrics
+```
 
 # LICENSE
 
 This is licensed under WTFPL. See COPYING file for the full text.
-
-The canonical URL for this project is <https://git.captnemo.in/nemo/prometheus-act-exporter>.

SECURITY.md

@@ -4,7 +4,8 @@
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 2.0.x   | :white_check_mark: |
+| 3.0.x   | :white_check_mark: Yes |
+| 2.0.x   | :negative_squared_cross_mark: No |
 
 ## Reporting a Vulnerability
 

e.github/FUNDING.yml

@@ -0,0 +1,3 @@
+ko_fi: captn3m0
+liberapay: captn3m0
+github: captn3m0

index.js

@@ -28,7 +28,7 @@ async function getUsage() {
   };
 
   try {
-    await page.goto(MY_ACCOUNT_URL);
+    await page.goto(MY_ACCOUNT_URL, {timeout: 5000});
     await page.click(MY_PACKAGE_SELECTOR_ID);
     // Wait for the page to switch
     await page.waitForFunction(
@@ -69,13 +69,11 @@ async function getUsage() {
     });
 
     metrics = dataUsage;
+    return metrics
   } catch (e) {
-    console.log("Couldn't scrape ACT page, faced an error");
-    console.log(e);
-    return null;
+    throw new Error("Failed scraping data from ACT");
   } finally {
     page.close();
-    return metrics;
   }
 }
 

init.sh

@@ -1,5 +0,0 @@
-#!/bin/sh
-export CHROME_REVISION=$(node -e "console.log(require('/usr/local/share/.config/yarn/global/node_modules/puppeteer/package.json')['puppeteer']['chromium_revision'])")
-export CHROME_BIN="/usr/local/share/.config/yarn/global/node_modules/puppeteer/.local-chromium/linux-$CHROME_REVISION/chrome-linux/chrome"
-
-/usr/local/bin/node server.js $@

package.json

@@ -1,6 +1,6 @@
 {
   "name": "prometheus-act-exporter",
-  "version": "2.0.8",
+  "version": "3.1.2",
   "description": "Exports ACT Fibernet data usage as prometheus metrics",
   "main": "index.js",
   "scripts": {
@@ -23,7 +23,7 @@
   "license": "WTFPL",
   "dependencies": {
     "containerized": "^1.0.2",
-    "prom-client": "^12.0.0",
-    "puppeteer-core": "^3.0.0"
+    "prom-client": "^14.0.1",
+    "puppeteer-core": "^21.0.1"
   }
 }

prom.js

@@ -1,30 +1,30 @@
-const pClient = require('prom-client');
-const KEYS = ['live', 'flexibytes', 'aggregate'];
+const pClient = require("prom-client");
+const KEYS = ["live", "flexibytes", "aggregate"];
 
 // Initial Setup
 let gauges = {};
 pClient.collectDefaultMetrics({ timeout: 60000 });
 
-KEYS.map(key => {
-	gauges[`${key}_used`] = new pClient.Gauge({
-		name: `act_fup_${key}_usage_bytes`,
-		help: `ACT ${key} usage in bytes (precision GB)`,
-	});
+KEYS.map((key) => {
+  gauges[`${key}_used`] = new pClient.Gauge({
+    name: `act_fup_${key}_usage_bytes`,
+    help: `ACT ${key} usage in bytes (precision GB)`,
+  });
 
-	gauges[`${key}_total`] = new pClient.Gauge({
-		name: `act_fup_${key}_total_bytes`,
-		help: `ACT ${key} usage in bytes (precision GB)`,
-	});
+  gauges[`${key}_total`] = new pClient.Gauge({
+    name: `act_fup_${key}_total_bytes`,
+    help: `ACT ${key} usage in bytes (precision GB)`,
+  });
 });
 
 module.exports = {
-	format: function(metrics) {
-		KEYS.map(key => {
-			gauges[`${key}_used`].set(metrics[key].usedBytes);
-			gauges[`${key}_total`].set(metrics[key].totalBytes);
-		});
+  format: function (metrics) {
+    KEYS.map((key) => {
+      gauges[`${key}_used`].set(metrics[key].usedBytes);
+      gauges[`${key}_total`].set(metrics[key].totalBytes);
+    });
 
-		return pClient.register.metrics();
-	},
-	contentType: pClient.register.contentType,
+    return pClient.register.metrics();
+  },
+  contentType: pClient.register.contentType,
 };

server.js

@@ -1,32 +1,50 @@
-const http = require('http');
+const http = require("http");
 const port = 3000;
-const metrics = require('./index');
-const promFormatter = require('./prom');
+const metrics = require("./index");
+const promFormatter = require("./prom");
+
+CACHE = {};
 
 const requestHandler = async (req, res) => {
-    let date = new Date(Date.now()).toLocaleString();
-    console.log(`${date}: ${req.url}`);
-    switch (req.url) {
-        case '/metrics':
-            res.setHeader('Content-Type', promFormatter.contentType);
-            res.end(promFormatter.format(await metrics.getUsage()));
-            break;
-        default:
-            res.writeHead(302, {
-                Location:
-                    'https://git.captnemo.in/nemo/prometheus-act-exporter',
-            });
-            res.end();
-            break;
-    }
+  let date = new Date(Date.now()).toLocaleString();
+  console.log(`${date}: ${req.url}`);
+  switch (req.url) {
+    case "/metrics":
+      res.setHeader("Content-Type", promFormatter.contentType);
+      metrics.getUsage().then(
+        (data) => {
+          console.log(data);
+          console.log("Setting cache");
+          CACHE = data;
+          promFormatter.format(data).then((data) => {
+            res.end(data);
+          });
+        },
+        (err) => {
+          console.log(err);
+          console.log("Got error, using cache");
+          console.log(CACHE);
+          promFormatter.format(CACHE).then((data) => {
+            res.end(data);
+          });
+        }
+      );
+      break;
+    default:
+      res.writeHead(302, {
+        Location: "https://github.com/captn3m0/prometheus-act-exporter",
+      });
+      res.end();
+      break;
+  }
 };
 
 const server = http.createServer(requestHandler);
 
-server.listen(port, err => {
-    if (err) {
-        return console.log('could not initialize web server', err);
-    }
+server.listen(port, (err) => {
+  if (err) {
+    return console.log("could not initialize web server", err);
+  }
 
-    console.log(`server is listening on ${port}`);
+  console.log(`server is listening on ${port}`);
 });