Transfer to Es modules (#1125)

* Transfer to es modules for lib/ and app.js

* Transfer to es modules for test/

* Add eslint rinore as specberus

* fix test .eslintrc.js

* close eslint no-unpublished-import

* convert setGlobalInfo into function

* fix mailer not found

* fix __dirname not found

* fix test-job

* fix test-orchestrator

* resolve Immutable

* fix sendFile undefined

* fix test-history

* fix test-jobs

* use process.env for config; delete console

* apply suggestion #1125

* use import for global config

* fix test config file

* file-type 18.4.0

* named export

---------

Co-authored-by: Denis Ah-Kang <[email protected]>

Author: jennyliang220

.eslintrc.js

@@ -0,0 +1,45 @@
+{
+  "extends": ["airbnb-base", "prettier", "plugin:node/recommended"],
+  "plugins": ["prettier", "node"],
+  "env": {
+    "node": true,
+    "es2022": true
+  },
+  "parserOptions": {
+    "ecmaVersion": 2022,
+    "allowImportExportEverywhere": true
+  },
+  "rules": {
+    "prettier/prettier": "error",
+    "strict": "off",
+    "consistent-return": "off",
+    "import/extensions": "off",
+    "global-require": "off",
+    "no-restricted-syntax": "warn",
+    "guard-for-in": "warn",
+    "prefer-destructuring": "warn",
+    "import/prefer-default-export": "off",
+    "no-unpublished-import": "off",
+    "node/no-unsupported-features/es-syntax": [
+      "warn",
+      {
+        "version": ">=18.0.0",
+        "ignores": ["modules"]
+      }
+    ]
+  },
+  "overrides": [
+    {
+      "files": ["test/**/*.js"],
+      "env": {
+        "mocha": true
+      }
+    },
+    {
+      "files": ["assets/**/*.js"],
+      "env": {
+        "browser": true
+      }
+    }
+  ]
+}

.eslintrc.json

@@ -5,32 +5,30 @@
 
 'use strict';
 
-const express = require('express');
-const compression = require('compression');
-const bodyParser = require('body-parser');
-const multer = require('multer');
-const path = require('path');
-const Fs = require('fs');
-const { Map } = require('immutable');
-const { v4: uuidv4 } = require('uuid');
-
-const passport = require('passport');
-const LdapAuth = require('ldapauth-fork');
-const { BasicStrategy } = require('passport-http');
-const Job = require('./lib/job');
-const Orchestrator = require('./lib/orchestrator');
-const RequestState = require('./lib/request-state');
-const SpecberusWrapper = require('./lib/specberus-wrapper');
-const mailer = require('./lib/mailer');
-
-const meta = require('./package.json');
-
-// Configuration file
-const config = process.env.CONFIG || 'config.js';
-// eslint-disable-next-line import/no-dynamic-require
-require(`./${config}`);
-// eslint-disable-next-line no-console
-console.log(`Loading config: ${config}`);
+import express from 'express';
+import compression from 'compression';
+import bodyParser from 'body-parser';
+import multer from 'multer';
+import path from 'path';
+import Fs from 'fs';
+import pkg from 'immutable';
+import { v4 as uuidv4 } from 'uuid';
+import passport from 'passport';
+
+import LdapAuth from 'ldapauth-fork';
+import { BasicStrategy } from 'passport-http';
+import Job from './lib/job.js';
+import Orchestrator from './lib/orchestrator.js';
+import RequestState from './lib/request-state.js';
+import SpecberusWrapper from './lib/specberus-wrapper.js';
+import sendMessage from './lib/mailer.js';
+
+import { importJSON } from './lib/util.js';
+
+await import(`${process.cwd()}/${process.env.CONFIG || 'config.js'}`);
+
+const { Map } = pkg;
+const meta = importJSON('./package.json', import.meta.url);
 
 const app = express();
 const requests = {};
@@ -66,12 +64,14 @@ app.set('trust proxy', true);
 
 // Index Page
 app.get('/', (request, response) => {
-  response.sendFile(`${__dirname}/views/index.html`);
+  // eslint-disable-next-line no-undef
+  response.sendFile(`${process.cwd()}/views/index.html`);
 });
 
 // New UI
 app.get('/ui', (request, response) => {
-  response.sendFile(`${__dirname}/views/web-interface.html`);
+  // eslint-disable-next-line no-undef
+  response.sendFile(`${process.cwd()}/views/web-interface.html`);
 });
 
 // API methods
@@ -204,7 +204,7 @@ const processRequest = (req, res, isTar) => {
       },
       requests[id].results,
     )
-      .then(state => {
+      .then(async state => {
         // eslint-disable-next-line no-console
         console.log(`[${state.get('status').toUpperCase()}] ${url}`);
         dumpJobResult(
@@ -214,7 +214,7 @@ const processRequest = (req, res, isTar) => {
         // eslint-disable-next-line no-console
         if (dryRun) console.log('Dry-run: omitting e-mail notification');
         else {
-          mailer.sendMessage(
+          sendMessage(
             id,
             state,
             requests[id],

app.js

@@ -42,4 +42,4 @@ global.LDAP_GROUPS = [
   'cn=32113,ou=groups,dc=w3,dc=org',
   'cn=49309,ou=groups,dc=w3,dc=org',
 ];
-global.SKIP_VALIDATION = false;
+global.SKIP_VALIDATION = false;

config-dev.js

@@ -1,5 +1,3 @@
-'use strict';
-
 global.DEFAULT_TEMP_LOCATION = '/var/www/';
 // DEFAULT_HTTP_LOCATION without trailing slash
 global.DEFAULT_HTTP_LOCATION = 'http://spec-server';
@@ -11,7 +9,8 @@ global.SPEC_GENERATOR = 'http://localhost:3002/';
 global.USERNAME = '';
 global.PASSWORD = '';
 global.W3C_PUBSYSTEM_URL = 'http://localhost:3001/publish';
-global.TR_INSTALL_CMD = 'mkdir -p /var/www/$dest && cp -R $source /var/www/$dest';
+global.TR_INSTALL_CMD =
+  'mkdir -p /var/www/$dest && cp -R $source /var/www/$dest';
 global.UPDATE_TR_SHORTLINK_CMD = '#';
 global.MAIL_SENDER = 'Echidna <[email protected]>';
 global.MAIL_REPLYTO = '[email protected]';
@@ -23,12 +22,12 @@ global.ALLOWED_CLIENTS = [
   // W3C:
   /https?:\/\/(www\.)?w3c?\.org/i,
   // GitHub:
-  /https?:\/\/w3c\.github\.io/i
+  /https?:\/\/w3c\.github\.io/i,
 ];
-global.LDAP_URL = "ldaps://localhost:636";
+global.LDAP_URL = 'ldaps://localhost:636';
 global.LDAP_SEARCH_BASE = 'ou=user,dc=example,dc=org';
 // LDAP_BIND_DN must contain the placeholder {{username}}
 global.LDAP_BIND_DN = 'uid={{username}},ou=user,dc=example,dc=org';
 global.GH_TOKEN = '123foobar';
 global.GH_DIRECTOR_TEAM_ID = '2797096';
-global.GH_COMM_TEAM_ID = '2794457';
+global.GH_COMM_TEAM_ID = '2794457';

config.js.example

@@ -4,15 +4,17 @@
 
 'use strict';
 
-const Fs = require('fs');
-const Request = require('request');
-const { List } = require('immutable');
-const Promise = require('promise');
-const Url = require('url');
-const Mkdirp = require('mkdirp');
-const { dirname } = require('path');
-const fileType = require('file-type');
-const tar = require('tar-stream');
+import Fs from 'fs';
+import Request from 'request';
+import pkg from 'immutable';
+import Promise from 'promise';
+import Url from 'url';
+import { mkdirp } from 'mkdirp';
+import { dirname } from 'path';
+import { fileTypeFromBuffer } from 'file-type';
+import tar from 'tar-stream';
+
+const { List } = pkg;
 
 /**
  * @exports lib/document-downloader
@@ -52,7 +54,7 @@ DocumentDownloader.fetchAll = urls =>
 DocumentDownloader.install = (dest, content) => {
   const path = dirname(dest);
 
-  Mkdirp.sync(path);
+  mkdirp.sync(path);
   return Promise.denodeify(Fs.writeFile)(dest, content);
 };
 
@@ -89,7 +91,7 @@ DocumentDownloader.fetchAndInstall = (url, dest) => {
     .then(pathExists => (!pathExists ? mkdir(dest) : null))
     .then(() =>
       _.fetch(url).then(content =>
-        fileType.fromBuffer(content).then(type => {
+        fileTypeFromBuffer(content).then(type => {
           if (type && type.mime !== 'application/x-tar') {
             throw new TypeError('Only tar, html and manifest are supported.');
           } else if (type && type.mime === 'application/x-tar') {
@@ -105,7 +107,7 @@ DocumentDownloader.fetchAndInstall = (url, dest) => {
                     }
                     const path = dirname(`${dest}/${header.name}`);
 
-                    Mkdirp.sync(path);
+                    mkdirp.sync(path);
                     Fs.writeFileSync(`${dest}/${header.name}`, data);
                   }
                 });
@@ -167,4 +169,4 @@ DocumentDownloader.getFilenames = function getFilenames(manifest) {
   }, new List());
 };
 
-module.exports = DocumentDownloader;
+export default DocumentDownloader;

lib/document-downloader.js

@@ -4,14 +4,13 @@
 
 'use strict';
 
-const Fs = require('fs');
-const Path = require('path');
-const { Stack } = require('immutable');
-const meta = require('../package.json');
+import Fs from 'fs';
+import Path from 'path';
+import pkg from 'immutable';
+import { importJSON } from './util.js';
 
-const config = process.env.CONFIG || 'config.js';
-// eslint-disable-next-line import/no-dynamic-require
-require(`../${config}`);
+const meta = importJSON('../package.json', import.meta.url);
+const { Stack } = pkg;
 
 // TODO Move this function out to keep the class pure
 function appendToLog(filename, message) {
@@ -74,4 +73,4 @@ History.prototype = {
   },
 };
 
-module.exports = History;
+export default History;

lib/history.js

@@ -4,11 +4,19 @@
 
 'use strict';
 
-const { List } = require('immutable');
-const Promise = require('promise');
-const { Octokit } = require('@octokit/core');
-const fs = require('fs');
-const ipRangeCheck = require('ip-range-check');
+import Promise from 'promise';
+import { Octokit } from '@octokit/core';
+import fs from 'fs';
+import ipRangeCheck from 'ip-range-check';
+import pkg from 'immutable';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const { List } = pkg;
+// eslint-disable-next-line no-underscore-dangle
+const __filenameNew = fileURLToPath(import.meta.url);
+// eslint-disable-next-line no-underscore-dangle
+const __dirname = path.dirname(__filenameNew);
 
 /**
  * @exports lib/ip-checker
@@ -27,6 +35,7 @@ IPChecker.check = ip =>
     const ghIp = octokit.request('GET /meta');
     // downloaded from https://www.microsoft.com/en-us/download/details.aspx?id=56519
     const azureIp = fs.promises
+      // eslint-disable-next-line no-undef
       .readFile(`${__dirname}/../ServiceTags_Public.json`)
       .then(JSON.parse);
     Promise.all([ghIp, azureIp])
@@ -57,4 +66,4 @@ IPChecker.check = ip =>
       .catch(e => console.error(e));
   });
 
-module.exports = IPChecker;
+export default IPChecker;

lib/ip-checker.js

@@ -1,7 +1,8 @@
 'use strict';
 
-const { List } = require('immutable');
+import pkg from 'immutable';
 
+const { List } = pkg;
 /**
  * @file A job is the state of a publication step, whether it is pending, finished or failed.
  *
@@ -32,6 +33,7 @@ function Job(status, errors) {
    * @param {*} v - The value to set
    * @returns {Job} The resulting job
    */
+  // eslint-disable-next-line consistent-return
   this.set = (k, v) => {
     switch (k) {
       case 'status':
@@ -53,4 +55,4 @@ function Job(status, errors) {
   Object.freeze(this);
 }
 
-module.exports = Job;
+export default Job;

lib/job.js

@@ -5,8 +5,8 @@
 
 'use strict';
 
-const Promise = require('promise');
-const Request = require('request');
+import Promise from 'promise';
+import Request from 'request';
 
 /**
  * @exports lib/json-http-service
@@ -62,4 +62,4 @@ JsonHttpService.prototype = {
   },
 };
 
-module.exports = JsonHttpService;
+export default JsonHttpService;