gulpfile.js

/**
 * Copyright (c) Forward Email LLC
 * SPDX-License-Identifier: BUSL-1.1
 */

const process = require('node:process');
const path = require('node:path');
const fs = require('node:fs');

// required to disable watching of I18N files in @ladjs/i18n
// otherwises tasks will fail to exit due to watchers running
process.env.I18N_SYNC_FILES = true;
process.env.I18N_AUTO_RELOAD = false;
process.env.I18N_UPDATE_FILES = true;

// eslint-disable-next-line import/no-unassigned-import
require('#config/env');

// eslint-disable-next-line import/no-unassigned-import
require('#config/mongoose');

const Graceful = require('@ladjs/graceful');
const Mandarin = require('mandarin');
const RevAll = require('gulp-rev-all');
const babel = require('gulp-babel');
const browserify = require('browserify');
const concat = require('gulp-concat');
const cssnano = require('cssnano');
const del = require('del');
const discardFonts = require('postcss-discard-font-face');
const discardUnused = require('postcss-discard-unused');
const comments = require('postcss-discard-comments');
const cssVariables = require('postcss-css-variables');
const envify = require('@ladjs/gulp-envify');
const filter = require('gulp-filter');
const getStream = require('get-stream');
const globby = require('globby');
const gulpRemark = require('gulp-remark');
const gulpXo = require('gulp-xo');
const isCI = require('is-ci');
const lr = require('gulp-livereload');
const makeDir = require('make-dir');
const ms = require('ms');
const nested = require('postcss-nested');
const order = require('gulp-order');
const pWaitFor = require('p-wait-for');
const postcss = require('gulp-postcss');
const postcss100VHFix = require('postcss-100vh-fix');
const postcssInlineBase64 = require('postcss-inline-base64');
const postcssPresetEnv = require('postcss-preset-env');
const postcssViewportHeightCorrection = require('postcss-viewport-height-correction');
const postcssStripFontFace = require('postcss-strip-font-face');
const prettier = require('gulp-prettier');
const pruneVar = require('postcss-prune-var');
const pugLinter = require('gulp-pug-linter');
const pump = require('pump');
const purgeFromPug = require('purgecss-from-pug');
const purgecss = require('gulp-purgecss');
const rename = require('gulp-rename');
const replace = require('gulp-replace');
const reporter = require('postcss-reporter');
const rev = require('gulp-rev');
const revSri = require('gulp-rev-sri');
const sass = require('gulp-sass')(require('node-sass'));
const sourcemaps = require('gulp-sourcemaps');
const stylelint = require('@ronilaukkarinen/gulp-stylelint');
const terser = require('gulp-terser');
const through2 = require('through2');
const unassert = require('gulp-unassert');
const { lastRun, watch, series, parallel, src, dest } = require('gulp');

const env = require('#config/env');
const config = require('#config');
const logger = require('#helpers/logger');
const i18n = require('#helpers/i18n');
const { developerDocs } = require('#config/utilities');

const PROD = config.env === 'production';
const DEV = config.env === 'development';
const TEST = config.env === 'test';

// dynamically import file-type
let imagemin;

import('gulp-imagemin').then((obj) => {
  imagemin = obj.default;
});

// inspired by postcss-remove-selectors
function removeClasses(regex) {
  return {
    postcssPlugin: 'remove-classes',
    prepare() {
      return {
        AtRule(atrule) {
          const str = atrule.toString().split('{')[0];
          if (regex.test(str)) {
            atrule.remove();
          }
        },
        Rule(rule) {
          const str = rule.toString().split('{')[0];
          if (regex.test(str)) {
            rule.remove();
          }
        }
      };
    }
  };
}

const developerDocsIcons = [
  ...new Set(
    developerDocs
      .filter((doc) => doc.icon)
      .flatMap((doc) => doc.icon.split(' '))
  )
];

const CONCAT_CSS_ORDER = [
  `${config.buildBase}/css/app-light.css`,
  `${config.buildBase}/css/app-dark.css`
];

const staticAssets = [
  'assets/**/*',
  '!assets/css/**/*',
  '!assets/img/**/*',
  '!assets/js/**/*'
];

// we have a modified version for emails
const purgeCssOptions = {
  // <https://github.com/FullHuman/purgecss/blob/55c26d2790b8502f115180cfe02aba5720c84b7b/docs/configuration.md>
  defaultExtractor: (content) => content.match(/[\w-/:]+(?<!:)/g) || [],
  extractors: [
    {
      extractor: purgeFromPug,
      extensions: ['pug']
    }
  ],
  sourceMap: false,
  // (since this does not detect variable-based class names in pug files)
  // the following list was filtered from:
  // `rg "class=" app`
  // `rg "class=" config`
  safelist: [
    ...new Set([
      ...developerDocsIcons,
      'active',
      'alert-danger',
      'alert-success',
      'alert-link',
      'alert-warning',
      'align-middle',
      'anchor',
      'badge-danger',
      'badge-primary',
      'badge-success',
      'badge-warning',
      'bg-danger',
      'bg-dark',
      'bg-secondary',
      'bg-success',
      'bg-warning',
      'bg-white',
      'border-dark',
      'border-md-top',
      'border-themed',
      'border-top',
      'btn',
      'btn-block',
      'btn-link',
      'btn-success',
      'close',
      'col',
      'col-12',
      'col-6',
      'col-lg-6',
      'col-md-6',
      'col-md-8',
      'col-sm-12',
      'collapse',
      'confirm-prompt',
      'container',
      'container-fluid',
      'd-block',
      'd-inline-block',
      'd-md-inline-block',
      'd-none',
      'd-print-block',
      'd-sm-block',
      'disabled',
      'dropdown-toggle',
      'fa',
      'fa-angle-right',
      'fa-check',
      'fa-search',
      'fa-sort',
      'fa-sort-down',
      'fa-sort-up',
      'fa-times',
      'fade',
      'fixed-bottom',
      'flex-grow-1',
      'floating-label',
      'font-weight-bold',
      'h4',
      'is-bot',
      'lazyframe',
      'list-inline',
      'list-inline-item',
      'markdown-body',
      'mb-0',
      'mb-3',
      'ml-0',
      'ml-4',
      'modal',
      'modal-body',
      'modal-content',
      'modal-dialog',
      'modal-header',
      'modal-lg',
      'mr-0',
      'mt-3',
      'mt-md-0',
      'navbar-dark',
      'navbar-light',
      'navbar-themed',
      'no-js',
      'octicon',
      'octicon-link',
      'offset-lg-3',
      'offset-md-2',
      'p-0',
      'pl-0',
      'p-2',
      'py-3',
      'px-3',
      'row',
      'table-danger',
      'table-primary',
      'table-warning',
      'table-success',
      'text-center',
      'text-danger',
      'text-dark',
      'text-decoration-underline',
      'text-left',
      'text-muted',
      'text-success',
      'text-themed',
      'text-warning',
      'text-white',
      'text-wrap',
      /-themed$/,
      /-themed-/,
      /^hljs/,
      /^language-/,
      'floating-animation',
      /^progress-bar/,
      'collapse',
      'navbar-collapse',
      'list-inline',
      'navbar-nav',
      'ml-auto',
      'mt-2',
      'mt-md-0',
      'navbar-dark',
      'bg-dark',
      'navbar-themed',
      'bg-themed',
      'navbar-expand-lg',
      'fixed-top',
      'card-columns-2',
      /swal2/,
      /^typed-/,
      'component-frame',
      // bootstrap-table icons for bs4
      'fa-minus',
      'fa-plus',
      'fa-sort',
      'pt-md-5'
    ])
  ]
};

//
// add a logger pre-hook to always ignore_hook so post-hooks don't fire
// (but only for development and testing environments)
//
if (!PROD) {
  for (const level of logger.config.logger.config.levels) {
    logger.config.logger.pre(level, function (err, message, meta) {
      meta.ignore_hook = true;
      return [err, message, meta];
    });
  }
}

function pug() {
  let stream = src(['app/views/**/*.pug', 'emails/**/*.pug'], {
    since: lastRun(pug)
  })
    .pipe(prettier())
    .pipe(pugLinter({ reporter: 'default', failAfterError: true }));

  if (DEV) stream = stream.pipe(lr(config.livereload));

  return stream;
}

async function img() {
  if (!imagemin) await pWaitFor(() => Boolean(imagemin), { timeout: ms('5s') });
  let stream = src('assets/img/**/*', {
    base: config.assetsBase,
    since: lastRun(img)
  })
    .pipe(
      // <https://github.com/sindresorhus/gulp-imagemin/tree/main#custom-plugin-options>
      // progressive: true,
      // svgoPlugins: [{ removeViewBox: false }, { cleanupIDs: false }],
      imagemin()
    )
    .pipe(dest(config.buildBase));

  if (DEV) stream = stream.pipe(lr(config.livereload));

  // convert to conventional stream
  stream = stream.pipe(through2.obj((chunk, enc, cb) => cb()));

  await getStream(stream);
}

function fonts() {
  return src('assets/fonts/**/*', {
    base: config.assetsBase,
    since: lastRun(fonts)
  }).pipe(dest(config.buildBase));
}

function faFonts() {
  return src(['node_modules/@fortawesome/fontawesome-free/webfonts/**/*']).pipe(
    dest(path.join(config.buildBase, 'fonts'))
  );
}

function css() {
  const f = filter(CONCAT_CSS_ORDER);
  return pump(
    [
      src('assets/css/**/*.scss', {
        base: config.assetsBase
      }),
      stylelint({
        reporters: [{ formatter: 'string', console: true }]
      }),
      // sourcemaps.init()
      sass().on('error', sass.logError),
      postcss([
        postcss100VHFix(),
        postcssViewportHeightCorrection(),
        postcssInlineBase64(),
        postcssPresetEnv({ browsers: 'extends @ladjs/browserslist-config' }),
        cssnano({ autoprefixer: false }),
        reporter()
      ]),
      // manual hack to override styling dark mode
      // <https://m2.material.io/design/color/dark-theme.html>
      // replace('#191d21', '#121212'),
      replace('#191d21', '#07191E'), // result of #121212 with 8% overlay with primary $cyan
      replace('#d3d3d3', 'rgba(253,255,255,.95)'),
      // replace('#343a40', '#07191E'),
      purgecss({
        ...purgeCssOptions,
        content: ['build/**/*.js', 'app/views/**/*.md', 'app/views/**/*.pug']
      }),
      dest(config.buildBase),
      ...(DEV ? [lr(config.livereload)] : []),
      // sourcemaps.write('./')
      f,
      order(CONCAT_CSS_ORDER, { base: './' }),
      concat('css/app.css'),
      postcss([
        postcss100VHFix(),
        postcssViewportHeightCorrection(),
        postcssInlineBase64(),
        postcssPresetEnv({ browsers: 'extends @ladjs/browserslist-config' }),
        cssnano({ autoprefixer: false }),
        reporter()
      ]),
      // TODO: this may not be necessary
      purgecss({
        ...purgeCssOptions,
        content: ['build/**/*.js', 'app/views/**/*.md', 'app/views/**/*.pug']
      }),
      dest(config.buildBase),
      ...(DEV ? [lr(config.livereload)] : []),
      // purge css for email specifically
      rename('css/app-email.css'),
      purgecss({
        ...purgeCssOptions,
        variables: true,
        content: [
          'emails/**/*.pug',
          'app/views/my-account/billing/_receipt.pug'
        ],
        fontFace: true,
        keyframes: true,
        // `rg "class=" app/models`
        // `rg "class=" config/index.js`
        safelist: [
          ...new Set([
            ...developerDocsIcons,
            'alert-link',
            'alert-danger',
            'alert-success',
            'alert-link',
            'alert-warning',
            'font-weight-bold',
            'text-decoration-underline',
            'text-monospace',
            'small',
            'code',
            'font-weight-bold',
            'markdown-body',
            'mb-0',
            'mb-3',
            'ml-0',
            'mr-0',
            'mt-3',
            'pre',
            'text-danger',
            'text-left',
            'col-lg-6',
            'col-lg-8',
            'col-lg-9',
            'col-md-9',
            'col-xl-6'
          ])
        ]
      }),
      //
      // NOTE: gmail only supports 16384 bytes in <style>
      // <https://www.caniemail.com/clients/gmail/>
      //
      // Limit on styles (16 KB):
      // <https://github.com/hteumeuleu/email-bugs/issues/90>
      //
      postcss([
        // gmail doesn't support dark mdoe
        // gmail does not support css variables
        // <https://www.caniemail.com/features/css-variables/>
        cssVariables(),
        pruneVar(),
        // gmail does not support inline base64 images
        // <https://www.caniemail.com/features/image-base64/>
        // postcssInlineBase64(),
        // TODO: once a majority of clients support this then add back
        // <https://www.caniemail.com/features/css-at-font-face/>
        discardFonts(() => false),
        // fixes for gmail
        postcssStripFontFace(),
        // fixes for gmail
        comments({ removeAll: true }),
        nested(),
        // gmail does not support attribute nor pseudo selectors
        // <https://stackoverflow.com/a/25104594>
        cssnano({
          autoprefixer: false,
          discardComments: { removeAll: true }
        }),
        removeClasses(/::?/),
        removeClasses(/\[/),
        removeClasses(/@font-face/),
        removeClasses(/@media print/),
        removeClasses(/@import/),
        removeClasses(/@keyframes/),
        removeClasses(/-webkit-device-pixel-ratio/),
        removeClasses(/prefers-color-scheme/),
        removeClasses(/prefers-reduced-motion/),
        discardUnused(),
        cssnano({
          autoprefixer: false,
          discardComments: { removeAll: true }
        }),
        reporter()
      ]),
      dest(config.buildBase)
    ],
    (err) => {
      if (err) throw err;
    }
  );
}

function xo() {
  return src('.', { since: lastRun(xo) })
    .pipe(gulpXo({ quiet: true, fix: true }))
    .pipe(gulpXo.format())
    .pipe(gulpXo.failAfterError());
}

// TODO: in the future use merge-streams and return a stream w/o through2
async function bundle() {
  const since = lastRun(bundle);

  await makeDir(path.join(config.buildBase, 'js'));
  await makeDir(path.join(config.buildBase, 'css'));

  async function getFactorBundle() {
    const paths = await globby('**/*.js', { cwd: 'assets/js' });
    const factorBundle = await new Promise((resolve, reject) => {
      browserify({
        entries: paths.map((string) => `assets/js/${string}`),
        debug: true
      })
        .plugin('bundle-collapser/plugin')
        .plugin('factor-bundle', {
          outputs: paths.map((string) =>
            path.join(config.buildBase, 'js', string)
          )
        })
        .bundle((err, data) => {
          if (err) return reject(err);
          resolve(data);
        });
    });
    await fs.promises.writeFile(
      path.join(config.buildBase, 'js', 'factor-bundle.js'),
      factorBundle
    );
  }

  await Promise.all([
    // babel polyfill
    fs.promises.copyFile(
      path.join(
        __dirname,
        'node_modules',
        '@babel',
        'polyfill',
        'dist',
        'polyfill.js'
      ),
      path.join(config.buildBase, 'js', 'polyfill.js')
    ),
    // lazyload
    fs.promises.copyFile(
      path.join(__dirname, 'node_modules', 'lazyload', 'lazyload.js'),
      path.join(config.buildBase, 'js', 'lazyload.js')
    ),
    // ekko-lightbox
    fs.promises.copyFile(
      path.join(
        __dirname,
        'node_modules',
        'ekko-lightbox',
        'dist',
        'ekko-lightbox.js'
      ),
      path.join(config.buildBase, 'js', 'ekko-lightbox.js')
    ),
    // bootstrap-table
    fs.promises.copyFile(
      path.join(
        __dirname,
        'node_modules',
        'bootstrap-table',
        'dist',
        'bootstrap-table.js'
      ),
      path.join(config.buildBase, 'js', 'bootstrap-table.js')
    ),
    fs.promises.copyFile(
      path.join(
        __dirname,
        'node_modules',
        'bootstrap-table',
        'dist',
        'bootstrap-table.css'
      ),
      path.join(config.buildBase, 'css', 'bootstrap-table.css')
    ),
    fs.promises.copyFile(
      path.join(
        __dirname,
        'node_modules',
        'bootstrap-table',
        'dist',
        'extensions',
        'sticky-header',
        'bootstrap-table-sticky-header.js'
      ),
      path.join(config.buildBase, 'js', 'bootstrap-table-sticky-header.js')
    ),
    fs.promises.copyFile(
      path.join(
        __dirname,
        'node_modules',
        'bootstrap-table',
        'dist',
        'extensions',
        'sticky-header',
        'bootstrap-table-sticky-header.css'
      ),
      path.join(config.buildBase, 'css', 'bootstrap-table-sticky-header.css')
    ),
    // factor bundle
    getFactorBundle()
  ]);

  // concatenate files
  await getStream(
    src([
      'build/js/polyfill.js',
      'build/js/factor-bundle.js',
      'build/js/uncaught.js',
      'build/js/core.js'
    ])
      .pipe(sourcemaps.init({ loadMaps: true }))
      .pipe(concat('build.js'))
      .pipe(sourcemaps.write('./'))
      .pipe(dest(path.join(config.buildBase, 'js')))
      .pipe(through2.obj((chunk, enc, cb) => cb()))
  );

  let stream = src('build/js/**/*.js', { base: config.buildBase, since })
    .pipe(sourcemaps.init({ loadMaps: true }))
    .pipe(unassert())
    .pipe(envify(env))
    .pipe(babel());

  if (PROD) stream = stream.pipe(terser());

  stream = stream.pipe(sourcemaps.write('./')).pipe(dest(config.buildBase));

  if (DEV) stream = stream.pipe(lr(config.livereload));

  stream = stream.pipe(dest(config.buildBase));

  // convert to conventional stream
  stream = stream.pipe(through2.obj((chunk, enc, cb) => cb()));

  await getStream(stream);
}

function remark() {
  return src('.', { since: lastRun(remark) })
    .pipe(
      gulpRemark({
        quiet: true,
        frail: true
      })
    )
    .pipe(dest('.'));
}

function static() {
  return src(staticAssets, {
    base: config.assetsBase,
    allowEmpty: true,
    since: lastRun(static),
    dot: true
  }).pipe(dest(config.buildBase));
}

async function markdown() {
  const mandarin = new Mandarin({
    i18n,
    logger,
    ...(isCI ? { redis: false } : {})
  });
  const graceful = new Graceful({
    ...(isCI ? {} : { redisClients: [mandarin.redisClient] }),
    logger
  });
  graceful.listen();
  await mandarin.markdown();
  await graceful.stopRedisClients();
}

async function sri() {
  await getStream(
    src('build/**/*.{css,js}', { base: config.buildBase })
      .pipe(RevAll.revision())
      .pipe(dest(config.buildBase))
      .pipe(RevAll.manifestFile())
      .pipe(dest(config.buildBase))
      .pipe(revSri({ base: config.buildBase }))
      .pipe(dest(config.buildBase))
      // convert to conventional stream
      .pipe(through2.obj((chunk, enc, cb) => cb()))
  );

  //
  // get all non css and non js files since rev-all ignores others
  // and merge rev-manifest.json with fonts and other non rev-all assets
  //
  // <https://github.com/smysnk/gulp-rev-all/blob/7fc61344df3b4377bf54b70d938cda8771096ebb/revisioner.js#L24
  // <https://github.com/smysnk/gulp-rev-all/issues/106>
  // <https://github.com/smysnk/gulp-rev-all/issues/165#issuecomment-338064409>
  //
  // note that we don't pipe fonts through gulp rev due to binary issues
  //
  await getStream(
    src(
      [
        'build/**/*',
        '!build/rev-manifest.json',
        '!build/sri-manifest.json',
        '!build/**/*.{css,js}',
        '!build/fonts/**/*',
        '!build/robots.txt',
        '!build/browserconfig.xml',
        '!build/opensearch.xml'
      ],
      { base: config.buildBase }
    )
      .pipe(rev())
      .pipe(dest(config.buildBase))
      .pipe(
        rev.manifest(config.manifest, {
          merge: true,
          base: config.buildBase
        })
      )
      .pipe(dest(config.buildBase))
      .pipe(revSri({ base: config.buildBase }))
      .pipe(dest(config.buildBase))
      // convert to conventional stream
      .pipe(through2.obj((chunk, enc, cb) => cb()))
  );
}

function clean() {
  return del([config.buildBase]);
}

const build = series(
  clean,
  parallel(
    ...(TEST ? [] : [xo, remark]),
    series(parallel(img, static, markdown, bundle, fonts, faFonts, css), sri)
  )
);

module.exports = {
  clean,
  build,
  bundle,
  sri,
  markdown,
  watch() {
    lr.listen(config.livereload);
    watch(['**/*.js', '!gulpfile.js', '!assets/js/**/*.js'], xo);
    watch(Mandarin.DEFAULT_PATTERNS, markdown);
    watch('assets/img/**/*', img);
    watch('assets/fonts/**/*', fonts);
    watch('assets/css/**/*.scss', css);
    watch('assets/js/**/*.js', series(xo, bundle));
    watch(['app/views/**/*.pug', 'emails/**/*.pug'], pug);
    watch(staticAssets, static);
  },
  pug,
  img,
  xo,
  static,
  remark,
  fonts,
  faFonts,
  css
};

exports.default = build;