Release Firestore Bundles as a prototype patched feature. #4168

wu-hui · 2020-12-04T18:09:34Z

No description provided.

… as a separate module (#4120) * Add bundles to d.ts and rearrange bundles source code for building it as a separate module.

Build firestore sdks with prebuilt to support bundle as a prototype patched feature.

changeset-bot · 2020-12-04T18:09:37Z

🦋 Changeset detected

Latest commit: e830a23

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages

Name	Type
firebase	Minor
@firebase/firestore-types	Minor
@firebase/firestore	Minor
@firebase/rules-unit-testing	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Add JSDoc for bundles.

# Conflicts: # packages/firestore/exp-types/index.d.ts # packages/firestore/package.json

google-oss-bot · 2020-12-04T18:51:14Z

Size Analysis Report

Affected Products

No changes between base commit (3754371) and head commit (4d9e963).

Test Logs

Base (37543717): https://github.com/firebase/firebase-js-sdk/actions/runs/401551389
Head (4d9e963b): https://github.com/firebase/firebase-js-sdk/actions/runs/407155776

github-actions · 2020-12-04T18:55:49Z

Changeset File Check ✅

No modified packages are missing from the changeset file.
No changeset formatting errors detected.

schmidt-sebastian

Basically LGTM, but I think the memory/bundle build might not work as is. Can you take a look?

schmidt-sebastian · 2020-12-04T19:30:52Z

packages/firestore/rollup.config.node.js

+  {
+    input: {
+      index: path.resolve('./memory', memoryPkg['main-esm2017']),
+      bundle: path.resolve('./bundle', memoryBundlePkg['main-esm2017'])


If you still have the test app, can you verify the memory build works?

It should be "@firebase/firestore/memory" and @firebase/firestore/memory/bundle" (I believe).

I think we are still missing "memory/bundle".

schmidt-sebastian · 2020-12-04T19:31:39Z

packages/firestore/src/api/bundle.ts

@@ -138,3 +119,30 @@ export class LoadBundleTask
    }
  }
 }
+
+export function loadBundle(


It looks like we still need to add this to firestore-exp, but we can do this as a follow up.

Not sure what this means, can you elaborate?

It looks like we are at least missing the top-level exports in exp/index.ts.

schmidt-sebastian · 2020-12-04T19:33:19Z

packages/firestore/src/local/local_store.ts

@@ -1394,10 +1395,11 @@ export function hasNewerBundle(

 /**
 * Saves the given `BundleMetadata` to local persistence.
+ * @param bundleMetadata


Missing description. You can also just remove this line.

schmidt-sebastian · 2020-12-04T19:33:51Z

packages/firestore/src/core/sync_engine.ts

@@ -1537,8 +1537,8 @@ export function ensureWriteCallbacks(syncEngine: SyncEngine): SyncEngineImpl {
 * Loads a Firestore bundle into the SDK. The returned promise resolves when
 * the bundle finished loading.
 *
- * @param bundleReader - Bundle to load into the SDK.
- * @param task - LoadBundleTask used to update the loading progress to public API.
+ * @param bundleReader Bundle to load into the SDK.


API Extractor requires the dash. I don't like it either, but that's 2020 for you :)

schmidt-sebastian · 2020-12-04T19:36:24Z

.changeset/old-lobsters-pull.md

+"@firebase/firestore": minor
+---
+
+Release Firestore Bundles as a prototype patched feature.


You should describe in your Release Notes what this is ("bundles" is not a term that developers will understand - at least not yet) and how they can use it (mention the additional import). The Prototype Patching is an implementation detail that doesn't need to go into the release notes. We should focus on usage.

# Conflicts: # packages/firestore/rollup.shared.js

* Actually creates firebase/firestore/bundle package.json * Fix standard node/browser builds for bundles * Make it release from remote branch. * Add bundle to firebase complete build and fix missing proto for memory build. * Make rollup.config.js more organized. * Revert "Make it release from remote branch." This reverts commit 2c91fd1. * 2017 -> 2020 * Update comment.

.changeset/old-lobsters-pull.md

schmidt-sebastian · 2020-12-07T18:56:50Z

packages/firestore/src/api/bundle.ts

@@ -138,3 +119,30 @@ export class LoadBundleTask
    }
  }
 }
+
+export function loadBundle(


It looks like we are at least missing the top-level exports in exp/index.ts.

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

hsubox76

LG, one comment for docs, adding @egilmorez for doc approval.

hsubox76 · 2020-12-07T19:48:49Z

packages/firebase/index.d.ts

+   *
+   * The API is compatible with `Promise<LoadBundleTaskProgress>`.
+   */
+  export interface LoadBundleTask extends PromiseLike<LoadBundleTaskProgress> {


Need to create entries in https://github.com/firebase/firebase-js-sdk/blob/master/scripts/docgen/content-sources/js/toc.yaml for 2 new interfaces, LoadBundleTask and LoadBundleTaskProgress

Can just insert this alphabetically in the Firestore section:

- title: "LoadBundleTask" path: /docs/reference/js/firebase.firestore.LoadBundleTask - title: "LoadBundleTaskProgress" path: /docs/reference/js/firebase.firestore.LoadBundleTaskProgress

If this is available for Node, also here:
https://github.com/firebase/firebase-js-sdk/blob/master/scripts/docgen/content-sources/node/toc.yaml

wu-hui added 2 commits December 3, 2020 09:27

Add bundles to d.ts and rearrange bundles source code for building it…

cc8dd9c

… as a separate module (#4120) * Add bundles to d.ts and rearrange bundles source code for building it as a separate module.

Roll bundle with prebuilt (#4128)

a5b8d3a

Build firestore sdks with prebuilt to support bundle as a prototype patched feature.

wu-hui requested review from Feiyang1, hiranya911 and hsubox76 as code owners December 4, 2020 18:09

wu-hui and others added 2 commits December 4, 2020 13:13

Add JSDoc for bundles (#4155)

705b30f

Add JSDoc for bundles.

Merge branch 'master' into wuandy/ReleaseBundles

5910464

# Conflicts: # packages/firestore/exp-types/index.d.ts # packages/firestore/package.json

Create changeset

b4050e6

Update old-lobsters-pull.md

f8bb4d8

wu-hui requested a review from schmidt-sebastian December 4, 2020 18:56

wu-hui assigned schmidt-sebastian Dec 4, 2020

schmidt-sebastian reviewed Dec 4, 2020

View reviewed changes

schmidt-sebastian assigned wu-hui and unassigned schmidt-sebastian Dec 4, 2020

wu-hui and others added 3 commits December 4, 2020 21:26

Merge branch 'master' into wuandy/ReleaseBundles

aae9956

# Conflicts: # packages/firestore/rollup.shared.js

Address comments

cad128f

wu-hui assigned schmidt-sebastian Dec 7, 2020

schmidt-sebastian approved these changes Dec 7, 2020

View reviewed changes

wu-hui assigned hsubox76 Dec 7, 2020

wu-hui and others added 2 commits December 7, 2020 14:22

Update .changeset/old-lobsters-pull.md

bf49a5b

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

Update .changeset/old-lobsters-pull.md

d8543e3

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

hsubox76 requested a review from egilmorez December 7, 2020 19:49

hsubox76 reviewed Dec 7, 2020

View reviewed changes

Add toc.

0f8e555

hsubox76 approved these changes Dec 7, 2020

View reviewed changes

hsubox76 mentioned this pull request Dec 7, 2020

Use esm2017 bundles in unit tests #4179

Closed

Remove webpack change.

e830a23

wu-hui merged commit b662f8c into master Dec 8, 2020

google-oss-bot mentioned this pull request Dec 8, 2020

Version Packages #4186

Merged

firebase locked and limited conversation to collaborators Jan 7, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release Firestore Bundles as a prototype patched feature. #4168

Release Firestore Bundles as a prototype patched feature. #4168

wu-hui commented Dec 4, 2020

changeset-bot bot commented Dec 4, 2020 •

edited

Loading

google-oss-bot commented Dec 4, 2020 •

edited

Loading

github-actions bot commented Dec 4, 2020 •

edited

Loading

schmidt-sebastian left a comment

schmidt-sebastian Dec 4, 2020

wu-hui Dec 7, 2020

schmidt-sebastian Dec 4, 2020

wu-hui Dec 7, 2020

schmidt-sebastian Dec 7, 2020

schmidt-sebastian Dec 4, 2020

wu-hui Dec 7, 2020

schmidt-sebastian Dec 4, 2020

wu-hui Dec 7, 2020

schmidt-sebastian Dec 4, 2020

wu-hui Dec 7, 2020

schmidt-sebastian Dec 7, 2020

hsubox76 left a comment

hsubox76 Dec 7, 2020

wu-hui Dec 7, 2020

Release Firestore Bundles as a prototype patched feature. #4168

Release Firestore Bundles as a prototype patched feature. #4168

Conversation

wu-hui commented Dec 4, 2020

changeset-bot bot commented Dec 4, 2020 • edited Loading

🦋 Changeset detected

google-oss-bot commented Dec 4, 2020 • edited Loading

Size Analysis Report

Affected Products

Test Logs

github-actions bot commented Dec 4, 2020 • edited Loading

Changeset File Check ✅

schmidt-sebastian left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hsubox76 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

changeset-bot bot commented Dec 4, 2020 •

edited

Loading

google-oss-bot commented Dec 4, 2020 •

edited

Loading

github-actions bot commented Dec 4, 2020 •

edited

Loading