Modular Export Binary Size Analysis - WIP

.github/workflows/test-changed.yml

@@ -8,10 +8,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Checkout
-      run: |
-        git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/*
+    - name: Checkout Repo
+      uses: actions/checkout@master
+      with:
+        # This makes Actions fetch all Git history so run-changed script can diff properly.
+        fetch-depth: 0
     - name: Set up Node (10)
       uses: actions/setup-node@v1
       with:

lerna.json

@@ -5,7 +5,8 @@
   "packages": [
     "packages/*",
     "packages-exp/*",
-    "integration/*"
+    "integration/*",
+    "repo-scripts/*"
   ],
   "useWorkspaces": true
 }

package.json

@@ -49,7 +49,8 @@
     "size-report": "node scripts/report_binary_size.js",
     "api-report": "lerna run --scope @firebase/*-exp api-report",
     "docgen:exp": "ts-node-script scripts/exp/docgen.ts",
-    "postinstall": "yarn --cwd repo-scripts/changelog-generator build"
+    "postinstall": "yarn --cwd repo-scripts/changelog-generator build",
+    "sa": "ts-node-script repo-scripts/size-analysis/analysis.ts"
   },
   "repository": {
     "type": "git",
@@ -154,4 +155,4 @@
       "pre-commit": "node tools/gitHooks/precommit.js"
     }
   }
-}
+}

packages/firestore/scripts/build-bundle.js

@@ -1,4 +1,4 @@
-"use strict";
+'use strict';
 /**
  * @license
  * Copyright 2020 Google LLC
@@ -14,4 +14,187 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */var __awaiter=this&&this.__awaiter||function(thisArg,_arguments,P,generator){function adopt(value){return value instanceof P?value:new P((function(resolve){resolve(value)}))}return new(P||(P=Promise))((function(resolve,reject){function fulfilled(value){try{step(generator.next(value))}catch(e){reject(e)}}function rejected(value){try{step(generator["throw"](value))}catch(e){reject(e)}}function step(result){result.done?resolve(result.value):adopt(result.value).then(fulfilled,rejected)}step((generator=generator.apply(thisArg,_arguments||[])).next())}))};var __generator=this&&this.__generator||function(thisArg,body){var _={label:0,sent:function(){if(t[0]&1)throw t[1];return t[1]},trys:[],ops:[]},f,y,t,g;return g={next:verb(0),throw:verb(1),return:verb(2)},typeof Symbol==="function"&&(g[Symbol.iterator]=function(){return this}),g;function verb(n){return function(v){return step([n,v])}}function step(op){if(f)throw new TypeError("Generator is already executing.");while(_)try{if(f=1,y&&(t=op[0]&2?y["return"]:op[0]?y["throw"]||((t=y["return"])&&t.call(y),0):y.next)&&!(t=t.call(y,op[1])).done)return t;if(y=0,t)op=[op[0]&2,t.value];switch(op[0]){case 0:case 1:t=op;break;case 4:_.label++;return{value:op[1],done:false};case 5:_.label++;y=op[1];op=[0];continue;case 7:op=_.ops.pop();_.trys.pop();continue;default:if(!(t=_.trys,t=t.length>0&&t[t.length-1])&&(op[0]===6||op[0]===2)){_=0;continue}if(op[0]===3&&(!t||op[1]>t[0]&&op[1]<t[3])){_.label=op[1];break}if(op[0]===6&&_.label<t[1]){_.label=t[1];t=op;break}if(t&&_.label<t[2]){_.label=t[2];_.ops.push(op);break}if(t[2])_.ops.pop();_.trys.pop();continue}op=body.call(thisArg,_)}catch(e){op=[6,e];y=0}finally{f=t=0}if(op[0]&5)throw op[1];return{value:op[0]?op[1]:void 0,done:true}}};exports.__esModule=true;var yargs=require("yargs");var rollup_1=require("rollup");var typescriptPlugin=require("rollup-plugin-typescript2");var alias=require("@rollup/plugin-alias");var json=require("rollup-plugin-json");var util=require("../rollup.shared");var argv=yargs.options({input:{type:"string",demandOption:true,desc:"The location of the index.ts file"},output:{type:"string",demandOption:true,desc:"The location for the transpiled JavaScript bundle"}}).argv;function buildBundle(input,output){return __awaiter(this,void 0,void 0,(function(){var bundle;return __generator(this,(function(_a){switch(_a.label){case 0:return[4,rollup_1.rollup({input:input,plugins:[alias(util.generateAliasConfig("node")),typescriptPlugin({tsconfigOverride:{compilerOptions:{target:"es2017"}},transformers:[util.removeAssertTransformer]}),json({preferConst:true})],external:util.resolveNodeExterns})];case 1:bundle=_a.sent();return[4,bundle.write({file:output,format:"es"})];case 2:_a.sent();return[2]}}))}))}buildBundle(argv.input,argv.output);
+ */ var __awaiter =
+  (this && this.__awaiter) ||
+  function (thisArg, _arguments, P, generator) {
+    function adopt(value) {
+      return value instanceof P
+        ? value
+        : new P(function (resolve) {
+            resolve(value);
+          });
+    }
+    return new (P || (P = Promise))(function (resolve, reject) {
+      function fulfilled(value) {
+        try {
+          step(generator.next(value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function rejected(value) {
+        try {
+          step(generator['throw'](value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function step(result) {
+        result.done
+          ? resolve(result.value)
+          : adopt(result.value).then(fulfilled, rejected);
+      }
+      step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+  };
+var __generator =
+  (this && this.__generator) ||
+  function (thisArg, body) {
+    var _ = {
+        label: 0,
+        sent: function () {
+          if (t[0] & 1) throw t[1];
+          return t[1];
+        },
+        trys: [],
+        ops: []
+      },
+      f,
+      y,
+      t,
+      g;
+    return (
+      (g = { next: verb(0), throw: verb(1), return: verb(2) }),
+      typeof Symbol === 'function' &&
+        (g[Symbol.iterator] = function () {
+          return this;
+        }),
+      g
+    );
+    function verb(n) {
+      return function (v) {
+        return step([n, v]);
+      };
+    }
+    function step(op) {
+      if (f) throw new TypeError('Generator is already executing.');
+      while (_)
+        try {
+          if (
+            ((f = 1),
+            y &&
+              (t =
+                op[0] & 2
+                  ? y['return']
+                  : op[0]
+                  ? y['throw'] || ((t = y['return']) && t.call(y), 0)
+                  : y.next) &&
+              !(t = t.call(y, op[1])).done)
+          )
+            return t;
+          if (((y = 0), t)) op = [op[0] & 2, t.value];
+          switch (op[0]) {
+            case 0:
+            case 1:
+              t = op;
+              break;
+            case 4:
+              _.label++;
+              return { value: op[1], done: false };
+            case 5:
+              _.label++;
+              y = op[1];
+              op = [0];
+              continue;
+            case 7:
+              op = _.ops.pop();
+              _.trys.pop();
+              continue;
+            default:
+              if (
+                !((t = _.trys), (t = t.length > 0 && t[t.length - 1])) &&
+                (op[0] === 6 || op[0] === 2)
+              ) {
+                _ = 0;
+                continue;
+              }
+              if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) {
+                _.label = op[1];
+                break;
+              }
+              if (op[0] === 6 && _.label < t[1]) {
+                _.label = t[1];
+                t = op;
+                break;
+              }
+              if (t && _.label < t[2]) {
+                _.label = t[2];
+                _.ops.push(op);
+                break;
+              }
+              if (t[2]) _.ops.pop();
+              _.trys.pop();
+              continue;
+          }
+          op = body.call(thisArg, _);
+        } catch (e) {
+          op = [6, e];
+          y = 0;
+        } finally {
+          f = t = 0;
+        }
+      if (op[0] & 5) throw op[1];
+      return { value: op[0] ? op[1] : void 0, done: true };
+    }
+  };
+exports.__esModule = true;
+var yargs = require('yargs');
+var rollup_1 = require('rollup');
+var typescriptPlugin = require('rollup-plugin-typescript2');
+var alias = require('@rollup/plugin-alias');
+var json = require('rollup-plugin-json');
+var util = require('../rollup.shared');
+var argv = yargs.options({
+  input: {
+    type: 'string',
+    demandOption: true,
+    desc: 'The location of the index.ts file'
+  },
+  output: {
+    type: 'string',
+    demandOption: true,
+    desc: 'The location for the transpiled JavaScript bundle'
+  }
+}).argv;
+function buildBundle(input, output) {
+  return __awaiter(this, void 0, void 0, function () {
+    var bundle;
+    return __generator(this, function (_a) {
+      switch (_a.label) {
+        case 0:
+          return [
+            4,
+            rollup_1.rollup({
+              input: input,
+              plugins: [
+                alias(util.generateAliasConfig('node')),
+                typescriptPlugin({
+                  tsconfigOverride: { compilerOptions: { target: 'es2017' } },
+                  transformers: [util.removeAssertTransformer]
+                }),
+                json({ preferConst: true })
+              ],
+              external: util.resolveNodeExterns
+            })
+          ];
+        case 1:
+          bundle = _a.sent();
+          return [4, bundle.write({ file: output, format: 'es' })];
+        case 2:
+          _a.sent();
+          return [2];
+      }
+    });
+  });
+}
+buildBundle(argv.input, argv.output);

packages/firestore/scripts/run-tests.js

@@ -1,4 +1,4 @@
-"use strict";
+'use strict';
 /**
  * @license
  * Copyright 2020 Google LLC
@@ -14,4 +14,49 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */exports.__esModule=true;var yargs=require("yargs");var path_1=require("path");var child_process_promise_1=require("child-process-promise");var argv=yargs.options({main:{type:"string",demandOption:true},platform:{type:"string",default:"node"},emulator:{type:"boolean"},persistence:{type:"boolean"}}).argv;var nyc=path_1.resolve(__dirname,"../../../node_modules/.bin/nyc");var mocha=path_1.resolve(__dirname,"../../../node_modules/.bin/mocha");process.env.TS_NODE_CACHE="NO";process.env.TS_NODE_COMPILER_OPTIONS='{"module":"commonjs"}';process.env.TEST_PLATFORM=argv.platform;var args=[mocha,"--require","ts-node/register","--require",argv.main,"--config","../../config/mocharc.node.js"];if(argv.emulator){process.env.FIRESTORE_EMULATOR_PORT="8080";process.env.FIRESTORE_EMULATOR_PROJECT_ID="test-emulator"}if(argv.persistence){process.env.USE_MOCK_PERSISTENCE="YES";args.push("--require","test/util/node_persistence.ts")}args=args.concat(argv._);var childProcess=child_process_promise_1.spawn(nyc,args,{stdio:"inherit",cwd:process.cwd()}).childProcess;process.once("exit",(function(){return childProcess.kill()}));process.once("SIGINT",(function(){return childProcess.kill("SIGINT")}));process.once("SIGTERM",(function(){return childProcess.kill("SIGTERM")}));
+ */ exports.__esModule = true;
+var yargs = require('yargs');
+var path_1 = require('path');
+var child_process_promise_1 = require('child-process-promise');
+var argv = yargs.options({
+  main: { type: 'string', demandOption: true },
+  platform: { type: 'string', default: 'node' },
+  emulator: { type: 'boolean' },
+  persistence: { type: 'boolean' }
+}).argv;
+var nyc = path_1.resolve(__dirname, '../../../node_modules/.bin/nyc');
+var mocha = path_1.resolve(__dirname, '../../../node_modules/.bin/mocha');
+process.env.TS_NODE_CACHE = 'NO';
+process.env.TS_NODE_COMPILER_OPTIONS = '{"module":"commonjs"}';
+process.env.TEST_PLATFORM = argv.platform;
+var args = [
+  mocha,
+  '--require',
+  'ts-node/register',
+  '--require',
+  argv.main,
+  '--config',
+  '../../config/mocharc.node.js'
+];
+if (argv.emulator) {
+  process.env.FIRESTORE_EMULATOR_PORT = '8080';
+  process.env.FIRESTORE_EMULATOR_PROJECT_ID = 'test-emulator';
+}
+if (argv.persistence) {
+  process.env.USE_MOCK_PERSISTENCE = 'YES';
+  args.push('--require', 'test/util/node_persistence.ts');
+}
+args = args.concat(argv._);
+var childProcess = child_process_promise_1.spawn(nyc, args, {
+  stdio: 'inherit',
+  cwd: process.cwd()
+}).childProcess;
+process.once('exit', function () {
+  return childProcess.kill();
+});
+process.once('SIGINT', function () {
+  return childProcess.kill('SIGINT');
+});
+process.once('SIGTERM', function () {
+  return childProcess.kill('SIGTERM');
+});

packages/firestore/src/local/indexeddb_persistence.ts

@@ -294,8 +294,8 @@ export class IndexedDbPersistence implements Persistence {
     debugAssert(!this.started, 'IndexedDbPersistence double-started!');
     debugAssert(this.window !== null, "Expected 'window' to be defined");
 
-    // NOTE: This is expected to fail sometimes (in the case of another tab 
-    // already having the persistence lock), so it's the first thing we should 
+    // NOTE: This is expected to fail sometimes (in the case of another tab
+    // already having the persistence lock), so it's the first thing we should
     // do.
     return this.updateClientMetadataAndTryBecomePrimary()
       .then(() => {

repo-scripts/size-analysis/.eslintrc.js

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+module.exports = {
+  extends: '../../config/.eslintrc.js',
+  parserOptions: {
+    project: 'tsconfig.json',
+    // to make vscode-eslint work with monorepo
+    // https://github.com/typescript-eslint/typescript-eslint/issues/251#issuecomment-463943250
+    tsconfigRootDir: __dirname
+  }
+};

repo-scripts/size-analysis/README.md

@@ -0,0 +1,28 @@
+# Modular Export Binary Size Calculator 
+
+## Command Line Option
+
+-  `--version`               Show version number                         [boolean]
+-  `--inputModule, --im`      The name of the module(s) to be analyzed. example: --inputModule "@firebase/functions-exp" "firebase/auth-exp" [array]
+-  `--inputDtsFile, --if`     Support for adhoc analysis. requires a path to dts file [string]
+-  `--inputBundleFile, --ib`  Support for adhoc analysis. requires a path to a bundle file [string]
+- `--output, -o`            The location where report(s) will be generated, a directory path if module(s) are analyzed; a file path if ad hoc analysis is to be performed [string]
+- `--help `                  Show help [boolean]
+
+
+
+## Commands To Run The Tool 
+
+### Adhoc Support 
+
+$firebase-js-sdk/repo-scripts/size-analysis  `ts-node-script analysis.ts --if <path to dts file> --ib <path to bundle file> -o <path to output FILE>`
+
+### To Do Analysis On One to Many Firebase Modules
+
+$firebase-js-sdk/repo-scripts/size-analysis  `ts-node-script analysis.ts --im "@firebase/module1-exp" "@firebase/module2-exp" -o <path to output DIRECTORY>`
+
+### To Do Analysis On All Firebase-Exp Modules
+
+$firebase-js-sdk/repo-scripts/size-analysis  `ts-node-script analysis.ts  -o <path to output DIRECTORY>`
+
+