feat: web-ext --version now shows the commit hash it was built from, unless it's a production release (#565)

Author: saintsebastian

.travis.yml

@@ -14,7 +14,7 @@ before_script:
 - npm run nsp-check
 
 script:
-- COVERAGE=y npm test
+- COVERAGE=y NODE_ENV=production npm test
 - npm run changelog-lint
 
 after_script: npm run publish-coverage

CONTRIBUTING.md

@@ -59,6 +59,10 @@ breakpoint.
 Type `npm run build` to build a new version of the libraries used by the
 `./bin/web-ext` command. When successful, you will see newly built files in
 the `./dist/` directory. This is done automatically by `npm start`.
+By default, npm run build creates a development build of web-ext. To create a
+production build, use the NODE_ENV variable like this:
+
+    NODE_ENV=production npm run build
 
 ## Check for lint
 

package.json

@@ -52,6 +52,7 @@
     "es6-promisify": "5.0.0",
     "firefox-profile": "0.4.2",
     "fx-runner": "1.0.5",
+    "git-rev-sync": "1.6.0",
     "minimatch": "3.0.3",
     "mz": "2.4.0",
     "node-firefox-connect": "1.2.0",

src/program.js

@@ -10,6 +10,8 @@ import {createLogger, consoleStream as defaultLogStream} from './util/logger';
 const log = createLogger(__filename);
 const envPrefix = 'WEB_EXT';
 
+import git from 'git-rev-sync';
+
 
 /*
  * The command line program.
@@ -90,8 +92,8 @@ export class Program {
     let runCommand = this.commands[cmd];
 
     if (argv.verbose) {
-      log.info('Version:', getVersion(absolutePackageDir));
       logStream.makeVerbose();
+      log.info('Version:', getVersion(absolutePackageDir));
     }
 
     try {
@@ -123,11 +125,27 @@ export class Program {
   }
 }
 
+// A global variable generated by DefinePlugin, generated in webpack.config.js
+declare var WEBEXT_BUILD_ENV: string;
 
-export function defaultVersionGetter(absolutePackageDir: string): string {
-  let packageData: any = readFileSync(
-    path.join(absolutePackageDir, 'package.json'));
-  return JSON.parse(packageData).version;
+//A defintion of type of argument for defaultVersionGetter
+type versionGetterOptions = {
+  localEnv?: string,
+};
+
+export function defaultVersionGetter(
+  absolutePackageDir: string,
+  {localEnv = WEBEXT_BUILD_ENV}: versionGetterOptions = {}
+): string {
+  if (localEnv === 'production') {
+    log.debug('Getting the version from package.json');
+    let packageData: any = readFileSync(
+      path.join(absolutePackageDir, 'package.json'));
+    return JSON.parse(packageData).version;
+  } else {
+    log.debug('Getting version from the git revision');
+    return `${git.branch()}-${git.long()}`;
+  }
 }
 
 

tests/unit/test.program.js

@@ -12,6 +12,8 @@ import {onlyInstancesOf, UsageError} from '../../src/errors';
 import {fake, makeSureItFails} from './helpers';
 import {ConsoleStream} from '../../src/util/logger';
 
+import git from 'git-rev-sync';
+
 
 describe('program.Program', () => {
 
@@ -175,7 +177,7 @@ describe('program.Program', () => {
     });
     program.command('thing', 'does a thing', () => {});
 
-    return execProgram(program, {logStream})
+    return execProgram(program, {getVersion: spy(), logStream})
       .then(() => {
         assert.equal(logStream.makeVerbose.called, true);
       });
@@ -329,15 +331,23 @@ describe('program.main', () => {
 
 
 describe('program.defaultVersionGetter', () => {
+  let root = path.join(__dirname, '..', '..');
 
-  it('returns the package version', () => {
-    let root = path.join(__dirname, '..', '..');
+  it('returns the package version in production', () => {
     let pkgFile = path.join(root, 'package.json');
     return fs.readFile(pkgFile)
       .then((pkgData) => {
-        assert.equal(defaultVersionGetter(root),
-                     JSON.parse(pkgData).version);
+        const testBuildEnv = {localEnv: 'production'};
+        assert.equal(defaultVersionGetter(root, testBuildEnv),
+                   JSON.parse(pkgData).version);
       });
   });
 
+  it('returns git commit information in development', () => {
+    const commit = `${git.branch()}-${git.long()}`;
+    const testBuildEnv = {localEnv: 'development'};
+    assert.equal(defaultVersionGetter(root, testBuildEnv),
+                 commit);
+  });
+
 });

webpack.config.js

@@ -57,6 +57,11 @@ module.exports = {
     // This seems necessary to work with the 'when' module, which is
     // required by some things such as fx-runner.
     new webpack.IgnorePlugin(/vertx/),
+    // Global variables are necessary to print either verson number or
+    // git commit information for custom builds
+    new webpack.DefinePlugin({
+      WEBEXT_BUILD_ENV: JSON.stringify(process.env.NODE_ENV || 'development'),
+    }),
   ],
   resolve: {
     extensions: ['', '.js', '.json'],