rollbar/Gruntfile.js

Effortlessly track and debug errors in your JavaScript applications with Rollbar. This package includes advanced error tracking features and an intuitive interface to help you identify and fix issues more quickly.

/**
 * Build and test rollbar.js
 */

'use strict';

var glob = require('glob');
var path = require('path');
var pkg = require('./package.json');
var fs = require('fs');

var webpackConfig = require('./webpack.config.js');

function findTests(context) {
  if (context !== 'browser') {
    return {};
  }
  var files = glob.sync('test/**/!(server.)*.test.js');
  var mapping = {};

  files.forEach(function (file) {
    var testName = path.basename(file, '.test.js');
    mapping[testName] = file;
  });

  return mapping;
}

function buildGruntKarmaConfig(singleRun, tests, reporters) {
  var config = {
    options: {
      configFile: './karma.conf.js',
      singleRun: singleRun,
      files: [
        // Files that the tests will load
        {
          pattern: 'dist/**/*.js',
          included: false,
          served: true,
          watched: false,
        },
        {
          pattern: 'src/**/*.js',
          included: false,
          served: true,
          watched: false,
        },
        {
          pattern: 'examples/**/*.js',
          included: false,
          served: true,
          watched: false,
        },

        // Examples HTML, set `included: true`, but they won't be executed or added
        // to the DOM until loaded explicitly during a test.
        {
          pattern: 'examples/**/*.html',
          included: true,
          served: true,
          watched: false,
        },
      ],
    },
  };

  if (reporters && reporters.length) {
    config.options.reporters = reporters;
  }

  for (var testName in tests) {
    var testFile = tests[testName];
    var testConfig = (config[testName] = {});

    // Special case for testing requirejs integration.
    // Include the requirejs module as a framework so
    // Karma will inclue it in the web page.
    if (testName === 'requirejs') {
      testConfig.files = [{ src: './dist/rollbar.umd.js', included: false }];
      // NOTE: requirejs should go first in case the subsequent libraries
      // check for the existence of `define()`
      testConfig.frameworks = ['requirejs', 'expect', 'mocha'];
    } else {
      testConfig.files = [{ src: [testFile] }];
    }

    // Special config for BrowserStack IE tests
    if (testName.slice(0, 3) === 'bs' && testName.indexOf('ie_') >= 0) {
      // Long timeout since IE 6/7/8 is slow
      testConfig.captureTimeout = 60000 * 10;
    }
  }

  return config;
}

module.exports = function (grunt) {
  require('time-grunt')(grunt);

  var browserTests = findTests('browser');

  var singleRun = grunt.option('singleRun');
  if (singleRun === undefined) {
    singleRun = true;
  }

  var reporters = grunt.option('reporters');
  if (reporters !== undefined) {
    reporters = reporters.split(',');
  }

  grunt.loadNpmTasks('grunt-karma');
  grunt.loadNpmTasks('grunt-webpack');
  grunt.loadNpmTasks('grunt-text-replace');

  var rollbarJsSnippet = fs.readFileSync('dist/rollbar.snippet.js');
  var rollbarjQuerySnippet = fs.readFileSync('dist/plugins/jquery.min.js');

  grunt.initConfig({
    pkg: pkg,
    webpack: webpackConfig,

    karma: buildGruntKarmaConfig(singleRun, browserTests, reporters),

    replace: {
      snippets: {
        src: [
          '*.md',
          'src/**/*.js',
          'examples/*.+(html|js)',
          'examples/*/*.+(html|js)',
          'docs/**/*.md',
        ],
        overwrite: true,
        replacements: [
          // Main rollbar snippet
          {
            from: new RegExp(
              '^(.*// Rollbar Snippet)[\n\r]+(.*[\n\r])*(.*// End Rollbar Snippet)',
              'm',
            ),
            to: function (match, index, fullText, captures) {
              captures[1] = rollbarJsSnippet;
              return captures.join('\n');
            },
          },
          // jQuery rollbar plugin snippet
          {
            from: new RegExp(
              '^(.*// Rollbar jQuery Snippet)[\n\r]+(.*[\n\r])*(.*// End Rollbar jQuery Snippet)',
              'm',
            ),
            to: function (match, index, fullText, captures) {
              captures[1] = rollbarjQuerySnippet;
              return captures.join('\n');
            },
          },
          // README CI link
          {
            from: new RegExp(
              '(https://github\\.com/rollbar/rollbar\\.js/workflows/Rollbar\\.js%20CI/badge\\.svg\\?branch=v)([0-9a-zA-Z.-]+)',
            ),
            to: function (match, index, fullText, captures) {
              captures[1] = pkg.version;
              return captures.join('');
            },
          },
        ],
      },
    },
  });

  grunt.registerTask('build', ['webpack', 'replace:snippets']);
  grunt.registerTask('default', ['build']);
  grunt.registerTask('test', [
    'test-browser',
  ]);
  grunt.registerTask('release', ['build', 'copyrelease']);


  grunt.registerTask('test-browser', function (target) {
    var karmaTask = 'karma' + (target ? ':' + target : '');
    var tasks = [karmaTask];
    grunt.task.run.apply(grunt.task, tasks);
  });

  function findReplayTests() {
    return Object.keys(browserTests).filter(function (testName) {
      var testPath = browserTests[testName];
      return (
        testPath.includes('test/replay/') ||
        testPath.includes('test/tracing/') ||
        testPath.match(/test\/browser\.replay\..*\.test\.js/)
      );
    });
  }

  grunt.registerTask('test-replay', function () {
    var replayTests = findReplayTests();

    grunt.log.writeln('Running all replay-related tests:');
    replayTests.forEach(function (testName) {
      grunt.log.writeln('- ' + testName + ' (' + browserTests[testName] + ')');
    });

    replayTests.forEach(function (testName) {
      grunt.task.run('karma:' + testName);
    });
  });

  grunt.registerTask('test-replay-unit', function () {
    var unitTests = findReplayTests().filter(function (testName) {
      var testPath = browserTests[testName];
      return testPath.includes('/replay/unit/');
    });

    grunt.log.writeln('Running replay unit tests:');
    unitTests.forEach(function (testName) {
      grunt.log.writeln('- ' + testName + ' (' + browserTests[testName] + ')');
    });

    unitTests.forEach(function (testName) {
      grunt.task.run('karma:' + testName);
    });
  });

  grunt.registerTask('test-replay-integration', function () {
    var integrationTests = findReplayTests().filter(function (testName) {
      var testPath = browserTests[testName];
      return testPath.includes('/replay/integration/');
    });

    grunt.log.writeln('Running replay integration tests:');
    integrationTests.forEach(function (testName) {
      grunt.log.writeln('- ' + testName + ' (' + browserTests[testName] + ')');
    });

    integrationTests.forEach(function (testName) {
      grunt.task.run('karma:' + testName);
    });
  });

  grunt.registerTask('copyrelease', function createRelease() {
    var version = pkg.version;
    var builds = ['', '.umd'];

    builds.forEach(function (buildName) {
      var js = 'dist/rollbar' + buildName + '.js';
      var minJs = 'dist/rollbar' + buildName + '.min.js';

      var releaseJs = 'release/rollbar' + buildName + '-' + version + '.js';
      var releaseMinJs =
        'release/rollbar' + buildName + '-' + version + '.min.js';

      grunt.file.copy(js, releaseJs);
      grunt.file.copy(minJs, releaseMinJs);
    });
  });
};