Merge pull request #16548 from rwjblue/move-ember-debug

Migrate ember-debug to @ember/debug and @ember/canary-features.

Author: rwjblue

.gitignore

@@ -40,7 +40,7 @@ publish_to_bower/
 bower_components/
 npm-debug.log
 .ember-cli
-DEBUG/
+/DEBUG/
 *.tgz
 *.tar.gz
 *.log

RELEASE.md

@@ -128,11 +128,11 @@ end
 1. Branch locally to `beta`
     1. `git checkout -b beta`
 1. Manually disable features
-    1. Change everything in `features.json` from `null` to `false` to ensure they are stripped
+    1. Change everything in `packages/@ember/canary-features.ts`'s `DEFAULT_FEATURES` export from `null` to `false` to ensure they are stripped
     1. Any feature that has been GOed gets changed to true
 1. Run `ember s -prod`
 1. Run tests at `http://localhost:4200/tests/index.html`
-1. Run production tests `http://localhost:4200/tests/index.htmlskipPackage=container,ember-testing,ember-debug&dist=prod&prod=true`
+1. Run production tests `http://localhost:4200/tests/index.htmlskipPackage=container,ember-testing,@ember/debug&dist=prod&prod=true`
 1. In `.travis.yml`, remove `branches:` section e.g. [this commit](https://github.com/emberjs/ember.js/commit/e38ec5d910721a9e02a819b4105a4875723f4b1b).
 1. Now we have to look at the commit just prior to branching 2.4.0.beta-1. Then find the commit after that to start the new branch at.
 

bin/feature-flag-yuidoc-filter.js

@@ -1,4 +1,4 @@
-var fs = require('fs');
+var FEATURES = require('../broccoli/features');
 
 function isClassToBeIncluded(item, featuresToFilter) {
   if (item.category) {
@@ -14,8 +14,7 @@ function isClassToBeIncluded(item, featuresToFilter) {
 }
 
 function gatherFeatures() {
-  var featuresJson = JSON.parse(fs.readFileSync('features.json'));
-  var featuresObj = featuresJson.features;
+  var featuresObj = Object.assign({}, FEATURES);
   var featuresToFilter = [];
   for (var feature in featuresObj) {
     if (featuresObj[feature] === null || featuresObj[feature] === false) {

bin/run-tests.js

@@ -233,8 +233,8 @@ function generateEachPackageTests() {
 
 function generateBuiltTests() {
   // Container isn't publicly available.
-  // ember-testing/ember-debug are stripped from prod/min.
-  var common = 'skipPackage=container,ember-testing,ember-debug';
+  // ember-testing and @ember/debug are stripped from prod/min.
+  var common = 'skipPackage=container,ember-testing,@ember/debug';
   testFunctions.push(function() {
     return run(common + '&nolint=true');
   });

broccoli/features.js

@@ -1,7 +1,46 @@
 'use strict';
 
-function getFeatures(isDebug) {
-  let features = Object.assign({}, require('../features').features);
+const resolve = require('resolve');
+const fs = require('fs');
+const path = require('path');
+
+function getFeatures() {
+  let fileName = 'packages/@ember/canary-features/index.ts';
+  let fileContents = fs.readFileSync(fileName).toString();
+
+  // our typescript version comes from a dependency in
+  // broccoli-typescript-compiler, so we look typescript up
+  // from there...
+  let broccoliTypescriptCompilerRoot = path.dirname(
+    resolve.sync('broccoli-typescript-compiler/package.json'),
+    { basedir: __dirname }
+  );
+  let typescriptEntryPoint = resolve.sync('typescript', {
+    basedir: broccoliTypescriptCompilerRoot,
+  });
+
+  let ts = require(typescriptEntryPoint);
+  let sourceFile = ts.createSourceFile(
+    fileName,
+    fileContents,
+    ts.ScriptTarget.ES2017,
+    /*setParentNodes */ true
+  );
+
+  let features;
+
+  ts.forEachChild(sourceFile, processVariableDeclarations);
+
+  function processVariableDeclarations(node) {
+    if (node.kind === ts.SyntaxKind.VariableDeclaration && node.name.text === 'DEFAULT_FEATURES') {
+      let featuresText = node.initializer.getFullText();
+      features = new Function(`return ${featuresText}`)();
+      return;
+    }
+
+    ts.forEachChild(node, processVariableDeclarations);
+  }
+
   let featureName;
 
   if (process.env.BUILD_TYPE === 'alpha') {
@@ -21,20 +60,7 @@ function getFeatures(isDebug) {
     }
   }
 
-  features['ember-glimmer-detect-backtracking-rerender'] = isDebug;
-
   return features;
 }
 
-function toConst(features) {
-  let consted = {};
-  Object.keys(features).forEach(feature => {
-    consted[feature.toUpperCase().replace(/-/g, '_')] = features[feature];
-  });
-
-  return consted;
-}
-
-module.exports.toConst = toConst;
-module.exports.RELEASE = getFeatures(false);
-module.exports.DEBUG = getFeatures(true);
+module.exports = getFeatures();

broccoli/packages.js

@@ -13,10 +13,8 @@ const funnelLib = require('./funnel-lib');
 const { VERSION } = require('./version');
 const WriteFile = require('broccoli-file-creator');
 const StringReplace = require('broccoli-string-replace');
-const { RELEASE, DEBUG, toConst } = require('./features');
 const GlimmerTemplatePrecompiler = require('./glimmer-template-compiler');
 const VERSION_PLACEHOLDER = /VERSION_STRING_PLACEHOLDER/g;
-const { stripIndent } = require('common-tags');
 
 const debugTree = BroccoliDebug.buildDebugCallback('ember-source');
 
@@ -296,27 +294,6 @@ module.exports.emberLicense = function _emberLicense() {
   });
 };
 
-module.exports.emberFeaturesES = function _emberFeaturesES(production = false) {
-  let FEATURES = production ? RELEASE : DEBUG;
-  let content = stripIndent`
-    import { ENV } from 'ember-environment';
-    import { assign } from '@ember/polyfills';
-    export const DEFAULT_FEATURES = ${JSON.stringify(FEATURES)};
-    export const FEATURES = assign(DEFAULT_FEATURES, ENV.FEATURES);
-
-
-    ${Object.keys(toConst(FEATURES))
-      .map(FEATURE => {
-        return `export const ${FEATURE} = FEATURES["${FEATURE.replace(/_/g, '-').toLowerCase()}"];`;
-      })
-      .join('\n')}
-  `;
-
-  return new WriteFile('ember/features.js', content, {
-    annotation: `ember/features ${production ? 'production' : 'debug'}`,
-  });
-};
-
 module.exports.nodeTests = function _nodeTests() {
   return new Funnel('tests', {
     include: ['**/*/*.js'],

broccoli/to-es5.js

@@ -4,7 +4,7 @@ const Babel = require('broccoli-babel-transpiler');
 const injectBabelHelpers = require('./transforms/inject-babel-helpers');
 const injectNodeGlobals = require('./transforms/inject-node-globals');
 const enifed = require('./transforms/transform-define');
-const { RELEASE, DEBUG, toConst } = require('./features');
+const FEATURES = require('./features');
 const stripClassCallCheck = require('./transforms/strip-class-call-check');
 const resolveModuleSource = require('amd-name-resolver').moduleResolve;
 
@@ -24,7 +24,7 @@ module.exports = function toES5(tree, _options) {
       'debug-macros',
       {
         debugTools: {
-          source: 'ember-debug',
+          source: '@ember/debug',
           assertPredicateIndex: 1,
         },
         envFlags: {
@@ -33,8 +33,18 @@ module.exports = function toES5(tree, _options) {
         },
         features: {
           name: 'ember',
-          source: 'ember/features',
-          flags: options.environment === 'production' ? toConst(RELEASE) : toConst(DEBUG),
+          source: '@ember/canary-features',
+          flags: Object.assign(
+            // explicit list of additional exports within @ember/canary-features
+            // without adding this (with a null value) an error is thrown during
+            // the feature replacement process (e.g. XYZ is not a supported flag)
+            {
+              FEATURES: null,
+              DEFAULT_FEATURES: null,
+              isEnabled: null,
+            },
+            FEATURES
+          ),
         },
         externalizeHelpers: {
           module: true,

ember-cli-build.js

@@ -29,7 +29,6 @@ const {
   nodeModuleUtils,
   emberVersionES,
   emberLicense,
-  emberFeaturesES,
   nodeTests,
   buildEmberEnvFlagsES,
   getPackagesES,
@@ -66,12 +65,9 @@ module.exports = function() {
     getPackagesES(),
   ]);
 
-  let es = new MergeTrees(
-    [packagesES, emberFeaturesES(), dependenciesES, templateCompilerDependenciesES],
-    {
-      overwrite: true,
-    }
-  );
+  let es = new MergeTrees([packagesES, dependenciesES, templateCompilerDependenciesES], {
+    overwrite: true,
+  });
   let pkgAndTestESInAMD = toNamedAMD(es);
   let emberEnvFlagsDebug = toNamedAMD(buildEmberEnvFlagsES({ DEBUG: true }));
 
@@ -118,7 +114,6 @@ module.exports = function() {
   let packagesES5 = toES5(packagesESRollup);
   let dependenciesES5 = toES5(dependenciesES);
   let templateCompilerDependenciesES5 = toES5(templateCompilerDependenciesES);
-  let emberDebugFeaturesES5 = toES5(emberFeaturesES());
 
   // Bundling
   let emberTestsBundle = new MergeTrees([
@@ -141,7 +136,6 @@ module.exports = function() {
       exclude: ['*/tests/**', 'ember-template-compiler/**', 'internal-test-helpers/**'],
     }),
     dependenciesES5,
-    emberDebugFeaturesES5,
     loader,
     license,
     nodeModule,
@@ -155,7 +149,13 @@ module.exports = function() {
 
   let emberTestingBundle = new MergeTrees([
     new Funnel(packagesES5, {
-      include: ['ember-debug/**', 'ember-testing/**', 'license.js'],
+      include: [
+        '@ember/debug/lib/**',
+        '@ember/debug/index.js',
+        'ember-testing/index.js',
+        'ember-testing/lib/**',
+        'license.js',
+      ],
     }),
     loader,
     license,
@@ -179,12 +179,13 @@ module.exports = function() {
     return new MergeTrees([
       new Funnel(packagesES5, {
         include: [
-          '@ember/error/index.js',
+          '@ember/canary-features/**',
           '@ember/debug/index.js',
+          '@ember/debug/lib/**',
+          '@ember/error/index.js',
           '@ember/polyfills/index.js',
           '@ember/polyfills/lib/**',
           'ember/version.js',
-          'ember-debug/**',
           'ember-environment.js',
           'ember-browser-environment.js',
           'ember-template-compiler/**',
@@ -202,9 +203,6 @@ module.exports = function() {
     let babelProdHelpersES5 = toES5(babelHelpers('prod'), {
       environment: 'production',
     });
-    let productionFeatures = toES5(emberFeaturesES(true), {
-      environment: 'production',
-    });
 
     let emberProdBundle = new MergeTrees([
       new Funnel(prodPackagesES5, {
@@ -221,7 +219,6 @@ module.exports = function() {
       nodeModule,
       bootstrapModule('ember'),
       babelProdHelpersES5,
-      productionFeatures,
     ]);
 
     emberProdBundle = concatBundle(emberProdBundle, {
@@ -261,7 +258,6 @@ module.exports = function() {
       license,
       babelProdHelpersES5,
       nodeModule,
-      productionFeatures,
     ]);
 
     emberTemplateCompilerBundle = concatBundle(emberTemplateCompilerBundle, {
@@ -276,7 +272,6 @@ module.exports = function() {
       license,
       babelDebugHelpersES5,
       nodeModule,
-      emberDebugFeaturesES5,
     ]);
 
     emberTemplateCompilerBundle = concatBundle(emberTemplateCompilerBundle, {

features.json

@@ -1,16 +1,4 @@
 {
-  "features": {
-    "features-stripped-test": null,
-    "ember-libraries-isregistered": null,
-    "ember-improved-instrumentation": null,
-    "ember-glimmer-named-arguments": true,
-    "ember-routing-router-service": true,
-    "ember-engines-mount-params": true,
-    "ember-module-unification": null,
-    "glimmer-custom-component-manager": null,
-    "ember-template-block-let-helper": true,
-    "ember-metal-tracked-properties": null
-  },
   "deprecations": {
     "container-lookupFactory": "2.12.0",
     "ember-application.injected-container": "2.3.0",

packages/@ember/application/globals-resolver.js

@@ -4,7 +4,7 @@
 
 import { dictionary } from 'ember-utils';
 import { get, findNamespace } from 'ember-metal';
-import { assert, info } from 'ember-debug';
+import { assert, info } from '@ember/debug';
 import { capitalize, classify, dasherize, decamelize } from '@ember/string';
 import { Object as EmberObject } from 'ember-runtime';
 import validateType from './lib/validate-type';

packages/@ember/application/lib/application.js

@@ -5,7 +5,7 @@
 import { dictionary } from 'ember-utils';
 import { ENV } from 'ember-environment';
 import { hasDOM } from 'ember-browser-environment';
-import { assert, isTesting } from 'ember-debug';
+import { assert, isTesting } from '@ember/debug';
 import { DEBUG } from '@glimmer/env';
 import { bind, join, once, run, schedule } from '@ember/runloop';
 import { libraries, processAllNamespaces, setNamespaceSearchDisabled } from 'ember-metal';
@@ -26,7 +26,7 @@ import Engine from '@ember/engine';
 import { privatize as P } from 'container';
 import { setupApplicationRegistry } from 'ember-glimmer';
 import { RouterService } from 'ember-routing';
-import { EMBER_ROUTING_ROUTER_SERVICE } from 'ember/features';
+import { EMBER_ROUTING_ROUTER_SERVICE } from '@ember/canary-features';
 
 let librariesRegistered = false;
 

packages/@ember/application/lib/validate-type.js

@@ -1,4 +1,4 @@
-import { assert } from 'ember-debug';
+import { assert } from '@ember/debug';
 
 const VALIDATED_TYPES = {
   route: ['assert', 'isRouteFactory', 'Ember.Route'],

packages/@ember/application/tests/application_instance_test.js

@@ -6,7 +6,7 @@ import { privatize as P } from 'container';
 import { factory } from 'internal-test-helpers';
 import { Object as EmberObject } from 'ember-runtime';
 import { moduleFor, AbstractTestCase as TestCase } from 'internal-test-helpers';
-import { getDebugFunction, setDebugFunction } from 'ember-debug';
+import { getDebugFunction, setDebugFunction } from '@ember/debug';
 
 const originalDebug = getDebugFunction('debug');
 const noop = function() {};

packages/@ember/application/tests/application_test.js

@@ -2,7 +2,7 @@
 import VERSION from 'ember/version';
 import { ENV, context } from 'ember-environment';
 import { libraries, setNamespaceSearchDisabled } from 'ember-metal';
-import { getDebugFunction, setDebugFunction } from 'ember-debug';
+import { getDebugFunction, setDebugFunction } from '@ember/debug';
 import Application from '..';
 import { Router, NoneLocation, Route as EmberRoute } from 'ember-routing';
 import { jQuery } from 'ember-views';

packages/@ember/application/tests/dependency_injection/default_resolver_test.js

@@ -7,7 +7,7 @@ import Service from '@ember/service';
 import { Object as EmberObject, Namespace } from 'ember-runtime';
 import { Route } from 'ember-routing';
 import { Component, Helper, helper as makeHelper } from 'ember-glimmer';
-import { getDebugFunction, setDebugFunction } from 'ember-debug';
+import { getDebugFunction, setDebugFunction } from '@ember/debug';
 
 moduleFor(
   'Application Dependency Injection - Integration - default resolver',