Firestore exp release script (#3444)

* Add ReactNative and Browser builds

* prepare script for firestore exp release

* add firestore to the exp release script

* add exp release rollup config

* misc changes

* fix typo

* add module field

* handle peerDeps

* fix typo

* replace app-types-exp with app-types

* fix typo

* fix typo

* remove unused fields

* testing only. remove before making PR

* fix merge

* fix issue

* Revert "testing only. remove before making PR"

This reverts commit 5837dab.

* revert dev changes

* remove unnecessary rollup config

* update script

* for test

* add firestore to firebase-exp

* use existing package as placeholder

* add firestore to firebase-exp

* build firestore first

* update release config

* use script name

* get script name correctly

* use componentName

* show output of build

* fix bug

* make it better

* add missing script

* fix

* add missing script

* fix build issue

* change order

* revert dev change

* use umd build for main

* update comment

* add comments

* address comments

Co-authored-by: Sebastian Schmidt <[email protected]>

Author: Feiyang1

packages-exp/firebase-exp/functions/index.cdn.ts renamed to packages-exp/firebase-exp/firestore/index.ts

@@ -14,4 +14,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from '@firebase/functions-exp';
+
+export * from '@firebase/firestore';

packages-exp/firebase-exp/firestore/lite/index.ts

@@ -0,0 +1,18 @@
+/**
+ * @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.
+ */
+
+export * from '@firebase/firestore/lite';

packages-exp/firebase-exp/firestore/lite/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "firebase-exp/firestore/lite",
+  "main": "dist/index.cjs.js",
+  "browser": "dist/index.esm.js",
+  "module": "dist/index.esm.js",
+  "typings": "dist/firestore/lite/index.d.ts"
+}

packages-exp/firebase-exp/firestore/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "firebase-exp/firestore",
+  "main": "dist/index.cjs.js",
+  "browser": "dist/index.esm.js",
+  "module": "dist/index.esm.js",
+  "typings": "dist/firestore/index.d.ts"
+}

packages-exp/firebase-exp/gulpfile.js

@@ -21,9 +21,10 @@ var sourcemaps = require('gulp-sourcemaps');
 
 const OUTPUT_FILE = 'firebase.js';
 const pkgJson = require('./package.json');
-const files = [
-  ...pkgJson.components.map(component => `firebase-${component}.js`)
-];
+const files = pkgJson.components.map(component => {
+  const componentName = component.replace('/', '-');
+  return `firebase-${componentName}.js`;
+});
 
 gulp.task('firebase-js', function () {
   return gulp

packages-exp/firebase-exp/package.json

@@ -36,7 +36,8 @@
   },
   "dependencies": {
     "@firebase/app-exp": "0.0.800",
-    "@firebase/functions-exp": "0.0.800"
+    "@firebase/functions-exp": "0.0.800",
+    "@firebase/firestore": "1.16.1"
   },
   "devDependencies": {
     "rollup": "2.21.0",
@@ -54,6 +55,8 @@
   },
   "components": [
     "app",
-    "functions"
+    "functions",
+    "firestore",
+    "firestore/lite"
   ]
 }

packages-exp/firebase-exp/rollup.config.release.js

@@ -28,7 +28,7 @@ import pkg from './package.json';
 import appPkg from './app/package.json';
 
 // remove -exp from dependencies name
-const external = Object.keys(pkg.dependencies || {}).map(name =>
+const deps = Object.keys(pkg.dependencies || {}).map(name =>
   name.replace('-exp', '')
 );
 
@@ -99,7 +99,7 @@ const appBuilds = [
       { file: resolve('app', appPkg.module), format: 'es', sourcemap: true }
     ],
     plugins: [...plugins, typescriptPlugin],
-    external
+    external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   },
   /**
    * App UMD Builds
@@ -121,6 +121,9 @@ const componentBuilds = pkg.components
   .filter(component => component !== 'app')
   .map(component => {
     const pkg = require(`./${component}/package.json`);
+    // It is needed for handling sub modules, for example firestore/lite which should produce firebase-firestore-lite.js
+    // Otherwise, we will create a directory with '/' in the name.
+    const componentName = component.replace('/', '-');
     return [
       {
         input: `${component}/index.ts`,
@@ -137,11 +140,14 @@ const componentBuilds = pkg.components
           }
         ],
         plugins: [...plugins, typescriptPlugin],
-        external
+        external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
       },
       {
         input: `${component}/index.ts`,
-        output: createUmdOutputConfig(`firebase-${component}.js`, component),
+        output: createUmdOutputConfig(
+          `firebase-${componentName}.js`,
+          componentName
+        ),
         plugins: [...plugins, typescriptPluginUMD],
         external: ['@firebase/app']
       }

packages-exp/functions-exp/package.json

@@ -14,6 +14,7 @@
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "build": "rollup -c && yarn api-report",
     "build:deps": "lerna run --scope @firebase/functions-exp --include-dependencies build",
+    "build:release": "rollup -c rollup.config.release.js && yarn api-report",
     "dev": "rollup -c -w",
     "test": "yarn type-check && run-p lint test:browser test:node",
     "test:ci": "node ../../scripts/run_tests_in_ci.js",
@@ -22,7 +23,7 @@
     "test:browser:debug": "karma start --browsers=Chrome --auto-watch",
     "test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'src/{,!(browser)/**/}*.test.ts' --file src/index.node.ts --config ../../config/mocharc.node.js",
     "test:emulator": "env FIREBASE_FUNCTIONS_EMULATOR_ORIGIN=http://localhost:5005 run-p test:node",
-    "prepare": "rollup -c rollup.config.release.js && yarn api-report",
+    "prepare": "yarn build:release",
     "api-report": "api-extractor run --local --verbose",
     "predoc": "node ../../scripts/exp/remove-exp.js temp",
     "doc": "api-documenter markdown --input temp --output docs",

packages/firestore/exp/package.json

@@ -2,7 +2,9 @@
   "name": "@firebase/firestore/exp",
   "description": "A tree-shakeable version of the Firestore SDK",
   "main": "../dist/exp/index.node.umd.js",
+  "module": "../dist/exp/index.browser.esm2017.js",
   "browser": "../dist/exp/index.browser.esm2017.js",
   "react-native": "../dist/exp/index.rn.esm2017.js",
+  "typings": "../exp-types/index.d.ts",
   "private": true
 }

packages/firestore/lite/package.json

@@ -1,8 +1,10 @@
 {
   "name": "@firebase/firestore/lite",
   "description": "A lite version of the Firestore SDK",
-  "main": "../dist/lite/index.node.umd.js",
+  "main": "../dist/lite/index.node.esm2017.js",
+  "module": "../dist/lite/index.browser.esm2017.js",
   "browser": "../dist/lite/index.browser.esm2017.js",
   "react-native": "../dist/lite/index.rn.esm2017.js",
+  "typings": "../lite-types/index.d.ts",
   "private": true
 }

packages/firestore/package.json

@@ -14,6 +14,7 @@
     "build:console": "node tools/console.build.js",
     "build:exp": "rollup -c rollup.config.exp.js",
     "build:lite": "rollup -c rollup.config.lite.js",
+    "build:exp:release": "yarn build:exp && yarn build:lite",
     "predev": "yarn prebuild",
     "dev": "rollup -c -w",
     "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",

packages/firestore/rollup.config.es2017.js

@@ -66,7 +66,7 @@ const browserBuildPlugins = [
       }
     },
     clean: true,
-    transformers: util.removeAssertAndPrefixInternalTransformer
+    transformers: [util.removeAssertAndPrefixInternalTransformer]
   }),
   json({ preferConst: true }),
   terser(util.manglePrivatePropertiesOptions)
@@ -139,7 +139,7 @@ const nodeBuildPlugins = [
       }
     },
     clean: true,
-    transformers: util.removeAssertTransformer
+    transformers: [util.removeAssertTransformer]
   }),
   json(),
   // Needed as we also use the *.proto files

packages/firestore/rollup.config.exp.js

@@ -21,6 +21,7 @@ import typescriptPlugin from 'rollup-plugin-typescript2';
 import typescript from 'typescript';
 import path from 'path';
 import { terser } from 'rollup-plugin-terser';
+import { importPathTransformer } from '../../scripts/exp/ts-transform-import-path';
 
 import pkg from './exp/package.json';
 
@@ -35,7 +36,8 @@ const nodePlugins = [
       }
     },
     clean: true,
-    transformers: util.removeAssertTransformer
+    abortOnError: false,
+    transformers: [util.removeAssertTransformer, importPathTransformer]
   }),
   json()
 ];
@@ -49,7 +51,11 @@ const browserPlugins = [
       }
     },
     clean: true,
-    transformers: util.removeAssertAndPrefixInternalTransformer
+    abortOnError: false,
+    transformers: [
+      util.removeAssertAndPrefixInternalTransformer,
+      importPathTransformer
+    ]
   }),
   json({ preferConst: true }),
   terser(util.manglePrivatePropertiesOptions)
@@ -65,7 +71,10 @@ const allBuilds = [
       name: 'firebase.firestore'
     },
     plugins: [alias(util.generateAliasConfig('node')), ...nodePlugins],
-    external: util.resolveNodeExterns
+    external: util.resolveNodeExterns,
+    treeshake: {
+      moduleSideEffects: false
+    }
   },
   // Browser build
   {
@@ -75,7 +84,10 @@ const allBuilds = [
       format: 'es'
     },
     plugins: [alias(util.generateAliasConfig('browser')), ...browserPlugins],
-    external: util.resolveBrowserExterns
+    external: util.resolveBrowserExterns,
+    treeshake: {
+      moduleSideEffects: false
+    }
   },
   // RN build
   {
@@ -85,7 +97,10 @@ const allBuilds = [
       format: 'es'
     },
     plugins: [alias(util.generateAliasConfig('rn')), ...browserPlugins],
-    external: util.resolveBrowserExterns
+    external: util.resolveBrowserExterns,
+    treeshake: {
+      moduleSideEffects: false
+    }
   }
 ];
 

packages/firestore/rollup.config.lite.js

@@ -21,6 +21,7 @@ import alias from '@rollup/plugin-alias';
 import typescriptPlugin from 'rollup-plugin-typescript2';
 import typescript from 'typescript';
 import { terser } from 'rollup-plugin-terser';
+import { importPathTransformer } from '../../scripts/exp/ts-transform-import-path';
 
 import pkg from './lite/package.json';
 
@@ -35,7 +36,8 @@ const nodePlugins = [
       }
     },
     clean: true,
-    transformers: util.removeAssertTransformer
+    abortOnError: false,
+    transformers: [util.removeAssertTransformer, importPathTransformer]
   }),
   json()
 ];
@@ -49,7 +51,11 @@ const browserPlugins = [
       }
     },
     clean: true,
-    transformers: util.removeAssertAndPrefixInternalTransformer
+    abortOnError: false,
+    transformers: [
+      util.removeAssertAndPrefixInternalTransformer,
+      importPathTransformer
+    ]
   }),
   json({ preferConst: true }),
   terser(util.manglePrivatePropertiesOptions)
@@ -65,7 +71,10 @@ const allBuilds = [
       name: 'firebase.firestore'
     },
     plugins: [alias(util.generateAliasConfig('node')), ...nodePlugins],
-    external: util.resolveNodeExterns
+    external: util.resolveNodeExterns,
+    treeshake: {
+      moduleSideEffects: false
+    }
   },
   // Browser build
   {
@@ -75,7 +84,10 @@ const allBuilds = [
       format: 'es'
     },
     plugins: [alias(util.generateAliasConfig('browser')), ...browserPlugins],
-    external: util.resolveBrowserExterns
+    external: util.resolveBrowserExterns,
+    treeshake: {
+      moduleSideEffects: false
+    }
   },
   // RN build
   {
@@ -85,7 +97,10 @@ const allBuilds = [
       format: 'es'
     },
     plugins: [alias(util.generateAliasConfig('rn')), ...browserPlugins],
-    external: util.resolveBrowserExterns
+    external: util.resolveBrowserExterns,
+    treeshake: {
+      moduleSideEffects: false
+    }
   }
 ];
 

packages/firestore/rollup.shared.js

@@ -63,29 +63,25 @@ const publicIdentifiers = extractPublicIdentifiers(externsPaths);
  * Transformers that remove calls to `debugAssert` and messages for 'fail` and
  * `hardAssert`.
  */
-exports.removeAssertTransformer = [
-  service => ({
-    before: [removeAsserts(service.getProgram())],
-    after: []
-  })
-];
+exports.removeAssertTransformer = service => ({
+  before: [removeAsserts(service.getProgram())],
+  after: []
+});
 
 /**
  * Transformers that remove calls to `debugAssert`, messages for 'fail` and
  * `hardAssert` and appends a __PRIVATE_ prefix to all internal symbols.
  */
-exports.removeAssertAndPrefixInternalTransformer = [
-  service => ({
-    before: [
-      removeAsserts(service.getProgram()),
-      renameInternals(service.getProgram(), {
-        publicIdentifiers,
-        prefix: '__PRIVATE_'
-      })
-    ],
-    after: []
-  })
-];
+exports.removeAssertAndPrefixInternalTransformer = service => ({
+  before: [
+    removeAsserts(service.getProgram()),
+    renameInternals(service.getProgram(), {
+      publicIdentifiers,
+      prefix: '__PRIVATE_'
+    })
+  ],
+  after: []
+});
 
 /**
  * Terser options that mangle all properties prefixed with __PRIVATE_.