gitlab-radiator 3.3.5 → 3.3.9

package/.babelrc

@@ -0,0 +1,4 @@
+{
+  "presets": ["@babel/env", "@babel/react"],
+  "plugins": ["@babel/plugin-transform-runtime"]
+}

package/.eslintrc

@@ -0,0 +1,13 @@
+{
+  "env": {
+    "es6": true,
+    "mocha": true,
+    "node": true
+  },
+  "parser": "@babel/eslint-parser",
+  "plugins": [
+    "mocha",
+    "react"
+  ],
+  "extends": ["eslint:recommended"]
+}

package/.github/workflows/test.yml

@@ -0,0 +1,20 @@
+name: Run tests
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x]
+    steps:
+     - uses: actions/checkout@v2
+     - uses: actions/setup-node@v1
+       with:
+         node-version: ${{ matrix.node-version }}
+     - run: npm ci
+     - run: npm audit
+     - run: npm run eslint
+     - run: npm test
+     - run: npm run build

package/.nvmrc

@@ -0,0 +1 @@
+14.17.0

package/README.md

@@ -1,3 +1,4 @@
+
 # The missing GitLab build radiator view
 
 ## Introduction
@@ -122,13 +123,6 @@ colors:
 
 See [releases](https://github.com/heikkipora/gitlab-radiator/releases).
 
-## Breaking changes from 2.x to 3.0
-
-- Configuration file syntax has changed so that you now can define multiple gitlab instances to poll from.
-  E.g. polling from https://gitlab.com and from your own hosted https://gitlab.yourdomain.com instance of gitlab.
-  Unfortunately all existing configurations for single gitlab polling have to be adjusted slightly.
-- Also config param `order` has moved from `projects.order` to global `projectsOrder`, as the order has effect on all projects and not per gitlab config.
-
 ## Contributing
 
 Pull requests are welcome. Kindly check that your code passes ESLint checks by running `npm run eslint` first.

package/build-npm

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+rm -fr build
+mkdir -p build/src
+
+# Copy static resources
+cp -r public build
+
+# Copy LICENSE, README and package.json
+cp LICENSE package.json README.md build
+
+# Copy bin script
+cp -r bin build
+
+# Bundle and minify client JS
+npx webpack --config webpack.prod.js
+
+# Transpile server
+node_modules/.bin/babel src --ignore **/client/*.js,**/dev-assets.js --out-dir build/src

package/package.json

@@ -5,7 +5,7 @@
     "email": "heikki.pora@gmail.com"
   },
   "description": "The missing GitLab build radiator view",
-  "version": "3.3.5",
+  "version": "3.3.9",
   "license": "MIT",
   "bin": {
     "gitlab-radiator": "bin/gitlab-radiator"
@@ -38,53 +38,53 @@
     }
   ],
   "dependencies": {
-    "@babel/runtime": "7.14.8",
-    "axios": "0.21.1",
+    "@babel/runtime": "7.16.3",
+    "axios": "0.24.0",
     "basic-auth": "2.0.1",
     "compression": "1.7.4",
-    "date-fns": "2.23.0",
+    "date-fns": "2.27.0",
     "esm": "3.2.25",
     "express": "4.17.1",
     "js-yaml": "4.1.0",
     "less-middleware": "3.1.0",
     "lodash": "4.17.21",
-    "socket.io": "4.1.3"
+    "socket.io": "4.4.0"
   },
   "devDependencies": {
-    "@babel/cli": "7.14.8",
-    "@babel/core": "7.14.8",
-    "@babel/node": "7.14.9",
-    "@babel/plugin-transform-runtime": "7.14.5",
-    "@babel/preset-env": "7.14.9",
-    "@babel/preset-react": "7.14.5",
-    "@babel/register": "7.14.5",
-    "@types/lodash": "4.14.171",
-    "@types/react": "17.0.15",
-    "@types/react-dom": "17.0.9",
-    "@types/webpack-env": "1.16.2",
-    "@typescript-eslint/eslint-plugin": "4.28.5",
-    "@typescript-eslint/parser": "4.28.5",
-    "babel-eslint": "10.1.0",
-    "babel-loader": "8.2.2",
+    "@babel/cli": "7.16.0",
+    "@babel/core": "7.16.0",
+    "@babel/node": "7.16.0",
+    "@babel/plugin-transform-runtime": "7.16.4",
+    "@babel/preset-env": "7.16.4",
+    "@babel/preset-react": "7.16.0",
+    "@babel/register": "7.16.0",
+    "@types/lodash": "4.14.177",
+    "@types/react": "17.0.37",
+    "@types/react-dom": "17.0.11",
+    "@types/webpack-env": "1.16.3",
+    "@typescript-eslint/eslint-plugin": "5.5.0",
+    "@typescript-eslint/parser": "5.5.0",
+    "@babel/eslint-parser": "7.16.3",
+    "babel-loader": "8.2.3",
     "chai": "4.3.4",
-    "css-loader": "6.2.0",
-    "eslint": "7.32.0",
+    "css-loader": "6.5.1",
+    "eslint": "8.3.0",
     "eslint-plugin-mocha": "9.0.0",
-    "eslint-plugin-react": "7.24.0",
-    "less": "4.1.1",
-    "less-loader": "10.0.1",
-    "mocha": "9.0.3",
+    "eslint-plugin-react": "7.27.1",
+    "less": "4.1.2",
+    "less-loader": "10.2.0",
+    "mocha": "9.1.3",
     "normalize.css": "8.0.1",
     "react": "17.0.2",
     "react-dom": "17.0.2",
-    "sinon": "11.1.2",
-    "style-loader": "3.2.1",
-    "ts-loader": "9.2.4",
-    "typescript": "4.3.5",
-    "webpack": "5.47.1",
-    "webpack-cli": "4.7.2",
-    "webpack-dev-middleware": "5.0.0",
-    "webpack-hot-middleware": "2.25.0",
+    "sinon": "12.0.1",
+    "style-loader": "3.3.1",
+    "ts-loader": "9.2.6",
+    "typescript": "4.5.2",
+    "webpack": "5.64.4",
+    "webpack-cli": "4.9.1",
+    "webpack-dev-middleware": "5.2.2",
+    "webpack-hot-middleware": "2.25.1",
     "webpack-merge": "5.8.0"
   },
   "browserslist": [

package/src/app.js

@@ -1,209 +1,100 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
-var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-
-var _auth = require("./auth");
-
-var _compression = _interopRequireDefault(require("compression"));
-
-var _config = require("./config");
-
-var _express = _interopRequireDefault(require("express"));
-
-var _runners = require("./gitlab/runners");
-
-var _http = _interopRequireDefault(require("http"));
-
-var _lessMiddleware = _interopRequireDefault(require("less-middleware"));
-
-var _os = _interopRequireDefault(require("os"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _socket = _interopRequireDefault(require("socket.io"));
-
-var _gitlab = require("./gitlab");
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
-
-var cacheDir = _path.default.join(_os.default.tmpdir(), 'gitlab-radiator-css-cache');
-
-var app = (0, _express.default)();
-
-var httpServer = _http.default.Server(app);
-
-var socketIoServer = (0, _socket.default)(httpServer);
+import {basicAuth} from './auth'
+import compression from 'compression'
+import {config} from './config'
+import express from 'express'
+import {fetchOfflineRunners} from './gitlab/runners'
+import http from 'http'
+import lessMiddleware from 'less-middleware'
+import os from 'os'
+import path from 'path'
+import socketIo from 'socket.io'
+import {update} from './gitlab'
+
+const cacheDir = path.join(os.tmpdir(), 'gitlab-radiator-css-cache')
+
+const app = express()
+const httpServer = http.Server(app)
+const socketIoServer = socketIo(httpServer)
 
 if (process.env.NODE_ENV !== 'production') {
   // eslint-disable-next-line global-require
-  var _require = require('./dev-assets'),
-      bindDevAssets = _require.bindDevAssets;
-
-  bindDevAssets(app);
+  const {bindDevAssets} = require('./dev-assets')
+  bindDevAssets(app)
 }
 
-app.disable('x-powered-by');
-app.use((0, _lessMiddleware.default)("".concat(__dirname, "/../public"), {
-  dest: cacheDir,
-  preprocess: {
-    less: function less(src) {
-      var colorLess = '';
-      Object.keys(_config.config.colors).forEach(function (stateName) {
-        colorLess += "@".concat(stateName, "-color:").concat(_config.config.colors[stateName], ";");
-      });
-      return src + colorLess;
+app.disable('x-powered-by')
+app.use(lessMiddleware(`${__dirname}/../public`, {
+    dest: cacheDir,
+    preprocess: {
+      less: (src) => {
+        let colorLess = ''
+        Object.keys(config.colors).forEach((stateName) => {
+          colorLess += `@${stateName}-color:${config.colors[stateName]};`
+        })
+        return src + colorLess
+      }
     }
   }
-}));
-app.use(_express.default.static(cacheDir));
-app.use(_express.default.static("".concat(__dirname, "/../public")));
-app.use((0, _compression.default)());
-app.use((0, _auth.basicAuth)(_config.config.auth));
-httpServer.listen(_config.config.port, function () {
+))
+app.use(express.static(cacheDir))
+app.use(express.static(`${__dirname}/../public`))
+app.use(compression())
+app.use(basicAuth(config.auth))
+
+httpServer.listen(config.port, () => {
   // eslint-disable-next-line no-console
-  console.log("Listening on port *:".concat(_config.config.port));
-});
-var globalState = {
+  console.log(`Listening on port *:${config.port}`)
+})
+
+const globalState = {
   projects: null,
   error: null,
-  zoom: _config.config.zoom,
-  projectsOrder: _config.config.projectsOrder,
-  columns: _config.config.columns,
-  groupSuccessfulProjects: _config.config.groupSuccessfulProjects
-};
-socketIoServer.on('connection', function (socket) {
-  socket.emit('state', withDate(globalState));
-});
-
-function runUpdate() {
-  return _runUpdate.apply(this, arguments);
+  zoom: config.zoom,
+  projectsOrder: config.projectsOrder,
+  columns: config.columns,
+  groupSuccessfulProjects: config.groupSuccessfulProjects
 }
 
-function _runUpdate() {
-  _runUpdate = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
-    return _regenerator.default.wrap(function _callee$(_context) {
-      while (1) {
-        switch (_context.prev = _context.next) {
-          case 0:
-            _context.prev = 0;
-            _context.next = 3;
-            return (0, _gitlab.update)(_config.config);
-
-          case 3:
-            globalState.projects = _context.sent;
-            _context.next = 6;
-            return errorIfRunnerOffline();
-
-          case 6:
-            globalState.error = _context.sent;
-            socketIoServer.emit('state', withDate(globalState));
-            _context.next = 15;
-            break;
-
-          case 10:
-            _context.prev = 10;
-            _context.t0 = _context["catch"](0);
-            // eslint-disable-next-line no-console
-            console.error(_context.t0.message);
-            globalState.error = "Failed to communicate with GitLab API: ".concat(_context.t0.message);
-            socketIoServer.emit('state', withDate(globalState));
+socketIoServer.on('connection', (socket) => {
+  socket.emit('state', withDate(globalState))
+})
 
-          case 15:
-            setTimeout(runUpdate, _config.config.interval);
-
-          case 16:
-          case "end":
-            return _context.stop();
-        }
-      }
-    }, _callee, null, [[0, 10]]);
-  }));
-  return _runUpdate.apply(this, arguments);
-}
-
-function errorIfRunnerOffline() {
-  return _errorIfRunnerOffline.apply(this, arguments);
+async function runUpdate() {
+  try {
+    globalState.projects = await update(config)
+    globalState.error = await errorIfRunnerOffline()
+    socketIoServer.emit('state', withDate(globalState))
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.error(error.message)
+    globalState.error = `Failed to communicate with GitLab API: ${error.message}`
+    socketIoServer.emit('state', withDate(globalState))
+  }
+  setTimeout(runUpdate, config.interval)
 }
 
-function _errorIfRunnerOffline() {
-  _errorIfRunnerOffline = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
-    var offlineRunnersPerGitlab, _offlineRunnersPerGit, offline, totalCount, names, counts;
-
-    return _regenerator.default.wrap(function _callee2$(_context2) {
-      while (1) {
-        switch (_context2.prev = _context2.next) {
-          case 0:
-            _context2.next = 2;
-            return Promise.all(_config.config.gitlabs.map(_runners.fetchOfflineRunners));
-
-          case 2:
-            offlineRunnersPerGitlab = _context2.sent;
-            _offlineRunnersPerGit = offlineRunnersPerGitlab.reduce(function (acc, runner) {
-              return {
-                offline: acc.offline.concat(runner.offline),
-                totalCount: acc.totalCount + runner.totalCount
-              };
-            }, {
-              offline: [],
-              totalCount: 0
-            }), offline = _offlineRunnersPerGit.offline, totalCount = _offlineRunnersPerGit.totalCount;
-
-            if (!(offline.length > 0)) {
-              _context2.next = 8;
-              break;
-            }
-
-            names = offline.map(function (r) {
-              return r.name;
-            }).sort().join(', ');
-            counts = offline.length === totalCount ? 'All' : "".concat(offline.length, "/").concat(totalCount);
-            return _context2.abrupt("return", "".concat(counts, " runners offline: ").concat(names));
-
-          case 8:
-            return _context2.abrupt("return", null);
+async function errorIfRunnerOffline() {
+  const offlineRunnersPerGitlab = await Promise.all(config.gitlabs.map(fetchOfflineRunners))
+  const {offline, totalCount} = offlineRunnersPerGitlab.reduce((acc, runner) => {
+    return {
+      offline: acc.offline.concat(runner.offline),
+      totalCount: acc.totalCount + runner.totalCount
+    }
+  }, {offline: [], totalCount: 0})
 
-          case 9:
-          case "end":
-            return _context2.stop();
-        }
-      }
-    }, _callee2);
-  }));
-  return _errorIfRunnerOffline.apply(this, arguments);
+  if (offline.length > 0) {
+    const names = offline.map(r => r.name).sort().join(', ')
+    const counts = offline.length === totalCount ? 'All' : `${offline.length}/${totalCount}`
+    return `${counts} runners offline: ${names}`
+  }
+  return null
 }
 
-runUpdate();
+runUpdate()
 
 function withDate(state) {
-  return _objectSpread(_objectSpread({}, state), {}, {
+  return {
+    ...state,
     now: Date.now()
-  });
-}
-
-var signals = {
-  'SIGINT': 2,
-  'SIGTERM': 15
-};
-
-function shutdown(signal, value) {
-  httpServer.close(function () {
-    // eslint-disable-next-line no-console
-    console.log("Server stopped by ".concat(signal, ".")); // eslint-disable-next-line no-process-exit
-
-    process.exit(128 + value);
-  });
+  }
 }
-
-Object.keys(signals).forEach(function (signal) {
-  process.on(signal, function () {
-    return shutdown(signal, signals[signal]);
-  });
-});

package/src/auth.js

@@ -1,35 +1,21 @@
-"use strict";
+import authenticate from 'basic-auth'
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.basicAuth = basicAuth;
-
-var _basicAuth = _interopRequireDefault(require("basic-auth"));
-
-function basicAuth(auth) {
+export function basicAuth(auth) {
   if (!auth || !auth.username || !auth.password) {
     // eslint-disable-next-line no-console
-    console.log('No authentication configured');
-    return function (req, res, next) {
-      return next();
-    };
-  } // eslint-disable-next-line no-console
-
-
-  console.log('HTTP basic auth enabled');
-  return function (req, res, next) {
-    var _ref = (0, _basicAuth.default)(req) || {},
-        name = _ref.name,
-        pass = _ref.pass;
+    console.log('No authentication configured')
+    return (req, res, next) => next()
+  }
 
+  // eslint-disable-next-line no-console
+  console.log('HTTP basic auth enabled')
+  return (req, res, next) => {
+    const {name, pass} = authenticate(req) || {}
     if (auth.username === name && auth.password === pass) {
-      next();
+      next()
     } else {
-      res.setHeader('WWW-Authenticate', 'Basic realm="gitlab-radiator"');
-      res.status(401).end();
+      res.setHeader('WWW-Authenticate', 'Basic realm="gitlab-radiator"')
+      res.status(401).end()
     }
-  };
-}
+  }
+}

package/src/client/.eslintrc

@@ -0,0 +1,21 @@
+{
+  "env": {
+    "browser": true,
+    "es6": true
+  },
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "settings": {
+    "react": {
+      "version": "17.0"
+    }
+  }
+}

package/src/client/arguments.ts

@@ -0,0 +1,75 @@
+interface ParsedQueryString {
+  [key: string]: string | undefined
+}
+
+export function argumentsFromDocumentUrl(): {override: {columns?: number, zoom?: number}, includedTags: string[] | null, screen: {id: number, total: number}} {
+  const args = parseQueryString(document.location.search)
+  return {
+    override: overrideArguments(args),
+    includedTags: tagArguments(args),
+    screen: screenArguments(args)
+  }
+}
+
+function tagArguments(args: ParsedQueryString): string[] | null {
+  if (args.tags === undefined) {
+    return null
+  }
+  return args.tags
+    .split(',')
+    .map(t => t.toLowerCase().trim())
+    .filter(t => t)
+}
+
+function overrideArguments(args: ParsedQueryString): {columns?: number, zoom?: number} {
+  return {
+    ...parseColumns(args),
+    ...parseZoom(args)
+  }
+}
+
+function parseColumns(args: ParsedQueryString) {
+  if (args.columns) {
+    const columns = Number(args.columns)
+    if (columns > 0 && columns <= 10) {
+      return {columns}
+    }
+  }
+  return {}
+}
+
+
+function parseZoom(args: ParsedQueryString) {
+  if (args.zoom) {
+    const zoom = Number(args.zoom)
+    if (zoom > 0 && zoom <= 2) {
+      return {zoom}
+    }
+  }
+  return {}
+}
+
+function screenArguments(args: ParsedQueryString): {id: number, total: number} {
+  const matches = (/(\d)of(\d)/).exec(args.screen || '')
+  let id = matches ? Number(matches[1]) : 1
+  const total = matches ? Number(matches[2]) : 1
+  if (id > total) {
+    id = total
+  }
+  return {
+    id,
+    total
+  }
+}
+
+function parseQueryString(search: string): ParsedQueryString {
+  const entries = search
+    .slice(1)
+    .split('&')
+    .filter(parameter => parameter)
+    .map((parameter: string): [string, string | undefined] => {
+      const [key, value] = parameter.split('=')
+      return [key, value]
+    })
+  return Object.fromEntries(entries)
+}