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/workflows/ci.yml

@@ -1,86 +0,0 @@
-on: push
-name: CI
-jobs:
-  npm-tests:
-    env:
-      CHROME_BIN: /usr/bin/chromium
-    runs-on: [self-hosted]
-    strategy:
-      matrix:
-        node: ['14', '16', '18']
-    name: Node Tests
-    steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-node@v2
-      with:
-        node-version: ${{matrix.node}}
-    - run: npm install
-    - name: test
-      continue-on-error: true
-      id: test
-      run: npm test
-    - name: retry
-      continue-on-error: true
-      id: retry1
-      if: steps.test.outcome=='failure'
-      run: npm test
-    - name: set the status
-      if: always()
-      run: |
-        if ${{ steps.test.outcome=='success' || steps.retry1.outcome=='success' }}; then
-           echo "Tests Passed"
-        else
-           exit 1
-        fi
-  docker-tests:
-    runs-on: [self-hosted]
-    timeout-minutes: 5
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v3
-      - name: Docker test
-        run: |
-          wget https://github.com/tkp1n/chromium-ci/raw/41510dc154c4184f7e09461ba76f86f61c460070/seccomp/chromium.json
-          docker build -t prom-act-test .
-          container_name=$(docker run --security-opt seccomp=chromium.json --detach prom-act-test)
-          echo $container_name
-          docker inspect $container_name
-          docker ps --no-trunc
-          until [ "`docker inspect -f {{.State.Health.Status}} $container_name`" == "healthy" ]; do
-              sleep 10;
-              echo "Waiting for container to be healthy"
-              docker inspect -f {{.State.Health}} $container_name
-              docker logs $container_name
-          done;
-          docker inspect $container_name
-          sleep 5
-          # Show usage
-          docker exec $container_name wget -q -O- localhost:3000/metrics | grep act_fup
-          # Check logs
-          docker logs $container_name
-          # Stop and kill the test container
-          docker stop $container_name && docker rm $container_name && docker rmi prom-act-test
-  publish:
-    needs: [npm-tests, docker-tests]
-    runs-on: [self-hosted]
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v3
-      - name: Login to GitHub Container Registry
-        uses: docker/login-action@v2
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-      - name: Push to GitHub Container Registry
-        uses: docker/build-push-action@v2
-        if: ${{github.ref_name != 'master'}}
-        with:
-          push: true
-          tags: ghcr.io/${{ github.repository }}:${{github.ref_name}}
-      - name: Push to GitHub Container Registry (latest)
-        uses: docker/build-push-action@v2
-        if: ${{github.ref_name == 'master'}}
-        with:
-          push: true
-          tags: ghcr.io/${{ github.repository }}:latest

.gitignore

@@ -1,3 +1,2 @@
 node_modules
-screenshots/
-chromium.json
+screenshots/

Dockerfile

@@ -1,43 +1,15 @@
-FROM alpine
+FROM schliflo/docker-puppeteer:21.3.4
 
 LABEL maintainer "Nemo <docker@captnemo.in>"
 
-RUN apk add --no-cache \
-      chromium \
-      nss \
-      freetype \
-      harfbuzz \
-      ca-certificates \
-      ttf-freefont \
-      nodejs \
-      npm
-
-# Tell Puppeteer to skip installing Chrome. We'll be using the installed package.
-ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true \
-    PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium-browser \
-    CHROME_BIN=/usr/bin/chromium-browser
-
-# Add user so we don't need --no-sandbox.
-RUN addgroup -S pptruser && adduser -S -G pptruser pptruser \
-    && addgroup pptruser audio \
-    && addgroup pptruser video \
-    && mkdir -p /home/pptruser/Downloads /app \
-    && chown -R pptruser:pptruser /home/pptruser \
-    && chown -R pptruser:pptruser /app
-
-USER pptruser
-
 WORKDIR /app
 
-COPY --chown=pptruser package.json package-lock.json /app/
+COPY package.json package-lock.json /app/
 
 RUN npm install
 
-COPY --chown=pptruser index.js server.js prom.js *.md /app/
+COPY index.js server.js prom.js *.md /app/
 
-ENTRYPOINT ["/usr/bin/node", "server.js"]
+ENTRYPOINT ["/usr/local/bin/node", "server.js"]
 
 EXPOSE 3000
-
-HEALTHCHECK --interval=1m --timeout=5s \
-    CMD wget -q http://localhost:3000/ || exit 1

README.md

@@ -1,9 +1,11 @@
 # prometheus-act-exporter
 
-![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/) [![CI](https://github.com/captn3m0/prometheus-act-exporter/actions/workflows/ci.yml/badge.svg)](https://github.com/captn3m0/prometheus-act-exporter/actions/workflows/ci.yml)
+![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](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
 - Only tested for ACT Bangalore connections.
@@ -42,7 +44,17 @@ act_fup_aggregate_total_bytes 900000000
 
 Install it with `npm i prometheus-act-exporter`.
 
-See `test.js` for sample usage.
+```js
+const act = require("prometheus-act-exporter");
+let m = await act.getUsage();
+// Returns
+// {
+//   live: { usedBytes: 0, totalBytes: 800000000 },
+//   flexibytes: { usedBytes: 102580000, totalBytes: 100000000 },
+//   aggregate: { usedBytes: 102580000, totalBytes: 900000000 }
+// }
+// calculations made assuming ACT is using SI GB (exactly 1 billion bytes)
+```
 
 # Configuration
 
@@ -58,14 +70,20 @@ You can pass the following environment variables:
 
 If running via Docker, here are some simple cookbook configurations:
 
-```
-wget https://github.com/tkp1n/chromium-ci/raw/41510dc154c4184f7e09461ba76f86f61c460070/seccomp/chromium.json
-docker run --security-opt seccomp=chromium.json -it -p 3000:3000 -e captn3m0/prometheus-act-exporter
-```
+`docker run -it -p 3000:3000 -e captn3m0/prometheus-act-exporter`
 
-Note that the above uses a [minimal secure seccomp profile for running Chromium inside Docker](https://github.com/docker/for-linux/issues/496#issuecomment-441149510).
+Run a simple test server locally in debug mode and test it on `http://localhost:3000/metrics`
 
-**Warning**: You should [not be running](https://ndportmann.com/chrome-in-docker/) this using `--privileged` or `--cap-add=SYS_ADMIN`, or `--no-sandbox`.
+## 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
 

index.js

@@ -1,4 +1,5 @@
 const puppeteer = require("puppeteer-core");
+const containerized = require("containerized");
 
 const MY_PACKAGE_SELECTOR_ID =
   'table[style="margin-top:-10px;"] tr:first-child+tr';
@@ -27,15 +28,12 @@ async function getUsage() {
   };
 
   try {
-    await page.goto(MY_ACCOUNT_URL, {timeout: 10000});
-    await page.waitForTimeout(5000);
-    await page.waitForSelector(MY_PACKAGE_SELECTOR_ID)
+    await page.goto(MY_ACCOUNT_URL, {timeout: 5000});
     await page.click(MY_PACKAGE_SELECTOR_ID);
     // Wait for the page to switch
-    await page.waitForFunction(()=>{
-      return document.querySelector(".dtl-header-text").innerText === "My Package" &&
-      document.getElementById('_ACTMyAccount_WAR_ACTMyAccountportlet_:processingPanel').style.display === 'none'
-    });
+    await page.waitForFunction(
+      'document.querySelector(".dtl-header-text").innerText === "My Package"'
+    );
 
     dataUsage = await page.evaluate(sel => {
       let elements = document.getElementsByClassName(sel);
@@ -73,7 +71,6 @@ async function getUsage() {
     metrics = dataUsage;
     return metrics
   } catch (e) {
-    console.log(e)
     throw new Error("Failed scraping data from ACT");
   } finally {
     page.close();
@@ -81,7 +78,10 @@ async function getUsage() {
 }
 
 function chromeLaunchConfig() {
-  let defaultArgs = ['--disable-dev-shm-usage'];
+  let defaultArgs = [];
+  if (containerized()) {
+    defaultArgs = ["--no-sandbox", "--disable-setuid-sandbox"];
+  }
   var options = {
     // These are set for Docker usage
     // https://github.com/alekzonder/docker-puppeteer#before-usage
@@ -106,11 +106,12 @@ function chromeLaunchConfig() {
   return options;
 }
 
+// Async IIFE FTW
+(async () => {
+  browser = await puppeteer.launch(chromeLaunchConfig());
+  console.log("Browser Initialized");
+})();
+
 module.exports = {
-  getUsage: getUsage,
-  onReady: async (cb)=>{
-    browser = await puppeteer.launch(chromeLaunchConfig());
-    console.log("Browser Initialized");
-    cb(browser)
-  }
+  getUsage: getUsage
 };

package.json

@@ -4,7 +4,7 @@
   "description": "Exports ACT Fibernet data usage as prometheus metrics",
   "main": "index.js",
   "scripts": {
-    "test": "node test.js"
+    "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [
     "actcorp",
@@ -14,15 +14,16 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+ssh://github.com/captn3m0/prometheus-act-exporter.git"
+    "url": "git+ssh://git@git.captnemo.in/nemo/prometheus-act-exporter.git"
   },
   "bugs": {
-    "url": "https://github.com/captn3m0/prometheus-act-exporter/issues"
+    "url": "https://git.captnemo.in/nemo/prometheus-act-exporter/issues"
   },
   "author": "Nemo <npm@captnemo.in>",
   "license": "WTFPL",
   "dependencies": {
+    "containerized": "^1.0.2",
     "prom-client": "^14.0.1",
-    "puppeteer-core": "^17.1.1"
+    "puppeteer-core": "^21.0.1"
   }
 }

server.js

@@ -3,15 +3,32 @@ const port = 3000;
 const metrics = require("./index");
 const promFormatter = require("./prom");
 
-CACHE = null;
+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);
-      promFormatter.format(CACHE).then((data) => {
-        res.end(data);
-      });
+      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, {
@@ -24,29 +41,10 @@ const requestHandler = async (req, res) => {
 
 const server = http.createServer(requestHandler);
 
-metrics.onReady((browser) => {
-  let t;
-  (function refreshCache() {
-    metrics.getUsage().then((data) => {
-      let date = new Date(Date.now()).toLocaleString();
-      console.log(`${date}: Updated Cache`);
-      // Start server now if this is the first run
-      if (!CACHE) {
-        server.listen(port, (err) => {
-          if (err) {
-            return console.log("could not initialize web server", err);
-          }
-          console.log(`server is listening on ${port}`);
-        });
-      }
-      CACHE = data;
-    }).finally(()=>{
-      t = setTimeout(refreshCache, 15 * 60 * 1000);
-    });
-  })();
+server.listen(port, (err) => {
+  if (err) {
+    return console.log("could not initialize web server", err);
+  }
 
-  process.on("exit", function () {
-    browser.close();
-    clearTimeout(t)
-  });
+  console.log(`server is listening on ${port}`);
 });

test.js

@@ -1,12 +0,0 @@
-const act = require("./index");
-const assert = require('assert')
-act.onReady(async (browser)=>{
-  metrics = await act.getUsage();
-  console.log(metrics);
-  for (i of ['live', 'aggregate', 'flexibytes']) {
-    console.log(i)
-    assert.ok(typeof metrics[i]['usedBytes'] === 'number')
-    assert.ok(typeof metrics[i]['totalBytes'] === 'number')
-  }
-  browser.close();
-});