使用 Firebase Emulator Suite 进行本地开发

1.准备工作

Cloud Firestore 和 Cloud Functions 等无服务器后端工具非常易于使用，但可能很难测试。借助 Firebase Local Emulator Suite，您可以在开发机器上运行这些服务的本地版本，以便快速、安全地开发应用。

前提条件

  • 简单的编辑器，如 Visual Studio Code、Atom 或 Sublime Text
  • Node.js 10.0.0 或更高版本（如需安装 Node.js，请使用 nvm；如需检查版本，请运行 node --version）
  • Java 7 或更高版本（如需安装 Java，请参阅这些说明；如需查看你的版本，请运行 java -version）

您将执行的操作

在此 Codelab 中，您将运行和调试一个简单的在线购物应用，该应用由多项 Firebase 服务提供支持：

  • Cloud Firestore：一种全球可扩缩的无服务器 NoSQL 数据库，具有实时功能。
  • Cloud Functions：一种无服务器后端代码，用于响应事件或 HTTP 请求。
  • Firebase Authentication：与其他 Firebase 产品集成的代管式身份验证服务。
  • Firebase Hosting：快速安全的 Web 应用托管服务。

您将应用连接到 Emulator Suite，以便进行本地开发。

2589e2f95b74fa88.png

您还将了解如何：

  • 如何将应用连接到模拟器套件，以及各种模拟器的连接方式。
  • Firebase 安全规则的工作原理以及如何针对本地模拟器测试 Firestore 安全规则。
  • 如何编写由 Firestore 事件触发的 Firebase 函数，以及如何编写针对 Emulator Suite 运行的集成测试。

2. 设置

获取源代码

在此 Codelab 中，您将从一个几乎完整的 Firestore 示例版本开始，因此您首先需要做的是克隆源代码：

$ git clone https://github.com/firebase/emulators-codelab.git

然后，进入 Codelab 目录，在此 Codelab 的其余部分中，您将在此目录中工作：

$ cd emulators-codelab/codelab-initial-state

现在，安装依赖项，以便运行代码。如果您的互联网连接速度较慢，这可能需要一两分钟：

# Move into the functions directory
$ cd functions

# Install dependencies
$ npm install

# Move back into the previous directory
$ cd ../

获取 Firebase CLI

Emulator Suite 是 Firebase CLI（命令行界面）的一部分，可使用以下命令安装到您的机器上：

$ npm install -g firebase-tools

接下来，请确认您拥有最新版本的 CLI。此 Codelab 应当适用于 9.0.0 或更高版本，但后续版本修复了更多 bug。

$ firebase --version
9.6.0

关联到您的 Firebase 项目

如果您还没有 Firebase 项目，请在 Firebase 控制台中创建一个新的 Firebase 项目。记下您选择的项目 ID，稍后需要用到。

现在，我们需要将此代码与您的 Firebase 项目相关联。首先，运行以下命令以登录 Firebase CLI：

$ firebase login

接下来，运行以下命令以创建项目别名。将 $YOUR_PROJECT_ID 替换为您的 Firebase 项目的 ID。

$ firebase use $YOUR_PROJECT_ID

现在，您可以运行应用了！

3. 运行模拟器

在本部分中，您将在本地运行应用。这意味着，现在可以启动 Emulator Suite 了。

启动模拟器

从 Codelab 源目录内部，运行以下命令来启动模拟器：

$ firebase emulators:start --import=./seed

您应该会看到类似以下内容的输出：

$ firebase emulators:start --import=./seed
i  emulators: Starting emulators: auth, functions, firestore, hosting
⚠  functions: The following emulators are not running, calls to these services from the Functions emulator will affect production: database, pubsub
i  firestore: Importing data from /Users/samstern/Projects/emulators-codelab/codelab-initial-state/seed/firestore_export/firestore_export.overall_export_metadata
i  firestore: Firestore Emulator logging to firestore-debug.log
i  hosting: Serving hosting files from: public
✔  hosting: Local server: http://127.0.0.1:5000
i  ui: Emulator UI logging to ui-debug.log
i  functions: Watching "/Users/samstern/Projects/emulators-codelab/codelab-initial-state/functions" for Cloud Functions...
✔  functions[calculateCart]: firestore function initialized.

┌─────────────────────────────────────────────────────────────┐
│ ✔  All emulators ready! It is now safe to connect your app. │
│ i  View Emulator UI at http://127.0.0.1:4000                │
└─────────────────────────────────────────────────────────────┘

┌────────────────┬────────────────┬─────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI             │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Authentication │ 127.0.0.1:9099 │ http://127.0.0.1:4000/auth      │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Functions      │ 127.0.0.1:5001 │ http://127.0.0.1:4000/functions │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Firestore      │ 127.0.0.1:8080 │ http://127.0.0.1:4000/firestore │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Hosting        │ 127.0.0.1:5000 │ n/a                             │
└────────────────┴────────────────┴─────────────────────────────────┘
  Emulator Hub running at 127.0.0.1:4400
  Other reserved ports: 4500

Issues? Report them at https://github.com/firebase/firebase-tools/issues and attach the *-debug.log files.

看到 All emulators started 消息后，即可使用该应用。

将 Web 应用连接到模拟器

根据日志中的表格，我们可以看到 Cloud Firestore 模拟器在监听端口 8080，Authentication 模拟器在监听端口 9099。

┌────────────────┬────────────────┬─────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI             │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Authentication │ 127.0.0.1:9099 │ http://127.0.0.1:4000/auth      │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Functions      │ 127.0.0.1:5001 │ http://127.0.0.1:4000/functions │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Firestore      │ 127.0.0.1:8080 │ http://127.0.0.1:4000/firestore │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Hosting        │ 127.0.0.1:5000 │ n/a                             │
└────────────────┴────────────────┴─────────────────────────────────┘

让我们将您的前端代码连接到模拟器，而不是连接到生产环境。打开 public/js/homepage.js 文件并找到 onDocumentReady 函数。我们可以看到，该代码访问了标准 Firestore 和 Auth 实例：

public/js/homepage.js

  const auth = firebaseApp.auth();
  const db = firebaseApp.firestore();

我们将更新 db 和 auth 对象，使其指向本地模拟器：

public/js/homepage.js

  const auth = firebaseApp.auth();
  const db = firebaseApp.firestore();

  // ADD THESE LINES
  if (location.hostname === "127.0.0.1") {
    console.log("127.0.0.1 detected!");
    auth.useEmulator("http://127.0.0.1:9099");
    db.useEmulator("127.0.0.1", 8080);
  }

现在，当应用在本地机器上运行（由 Hosting 模拟器提供服务）时，Firestore 客户端也会指向本地模拟器，而不是指向生产数据库。

打开 EmulatorUI

在网络浏览器中，导航到 http://127.0.0.1:4000/。您应该会看到 Emulator Suite 界面。

模拟器界面主屏幕

点击查看 Firestore 模拟器的界面。由于使用 --import 标志导入了数据，因此 items 集合中已包含数据。

4ef88d0148405d36

4. 运行应用

打开应用

在网络浏览器中，导航到 http://127.0.0.1:5000，您应该会看到 The Fire Store 在您的机器本地运行！

939f87946bac2ee4.png

使用应用

在首页上选择一件商品，然后点击添加到购物车。很遗憾，您会遇到以下错误：

a11bd59933a8e885.png

让我们来修复这个 bug！由于一切都在模拟器中运行，因此我们可以进行实验，而不必担心影响真实数据。

5. 调试应用

查找 bug

我们来看一下 Chrome 开发者控制台。按 Control+Shift+J（Windows、Linux、ChromeOS）或 Command+Option+J（Mac），在控制台中查看错误：

74c45df55291dab1.png

addToCart 方法似乎存在一些错误，我们来看一下。我们在该方法中的哪个位置尝试访问名为 uid 的对象？为什么是 null？目前，该方法在 public/js/homepage.js 中的显示如下所示：

public/js/homepage.js

  addToCart(id, itemData) {
    console.log("addToCart", id, JSON.stringify(itemData));
    return this.db
      .collection("carts")
      .doc(this.auth.currentUser.uid)
      .collection("items")
      .doc(id)
      .set(itemData);
  }

啊哈！我们未登录应用。根据 Firebase Authentication 文档，在我们未登录时，auth.currentUser 为 null。我们来添加一个检查：

public/js/homepage.js

  addToCart(id, itemData) {
    // ADD THESE LINES
    if (this.auth.currentUser === null) {
      this.showError("You must be signed in!");
      return;
    }

    // ...
  }

测试应用

现在，刷新页面，然后点击添加到购物车。这次，您应该会得到一个更好的错误信息：

c65f6c05588133f7.png

但是，如果您点击上方工具栏中的登录，然后再次点击添加到购物车，就会看到购物车已更新。

但是，这些数字似乎完全不正确：

239f26f02f959eef.png

不用担心，我们很快就会修复该错误。首先，让我们来深入了解一下您将商品添加到购物车时实际发生的情况。

6. 本地函数触发器

点击 Add to Cart 会启动涉及多个模拟器的事件链。将商品添加到购物车后，您应该会在 Firebase CLI 日志中看到如下消息：

i  functions: Beginning execution of "calculateCart"
i  functions: Finished "calculateCart" in ~1s

发生了以下四个关键事件，产生了这些日志和您观察到的界面更新：

68c9323f2ad10f7a.png

1) Firestore 写入 - 客户端

系统会将新文档添加到 Firestore 集合 /carts/{cartId}/items/{itemId}/。您可以在 public/js/homepage.js 内的 addToCart 函数中看到以下代码：

public/js/homepage.js

  addToCart(id, itemData) {
    // ...
    console.log("addToCart", id, JSON.stringify(itemData));
    return this.db
      .collection("carts")
      .doc(this.auth.currentUser.uid)
      .collection("items")
      .doc(id)
      .set(itemData);
  }

2) 由 Cloud Functions 函数触发

Cloud Functions 函数 calculateCart 会使用 onWrite 触发器来监听购物车商品发生的任何写入事件（创建、更新或删除），您可以在 functions/index.js 中看到这些事件：

functions/index.js

exports.calculateCart = functions.firestore
    .document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      try {
        let totalPrice = 125.98;
        let itemCount = 8;

        const cartRef = db.collection("carts").doc(context.params.cartId);

        await cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    }
);

3) Firestore 写入 - 管理员

calculateCart 函数会读取购物车中的所有商品，并计算总数量和总价格，然后使用新的总数更新“购物车”文档（请参阅上文中的 cartRef.update(...)）。

4) Firestore 读取 - 客户端

网页前端已订阅以接收有关购物车更改的更新。在 Cloud Functions 函数写入新总和并更新界面后，该值会实时更新，如 public/js/homepage.js 所示：

public/js/homepage.js

this.cartUnsub = cartRef.onSnapshot(cart => {
   // The cart document was changed, update the UI
   // ...
});

回顾

非常棒！您只需设置一个完全本地的应用，该应用使用三个不同的 Firebase 模拟器进行完全本地测试。

db82eef1706c9058.gif

等一下，还有更多贴纸！在下一部分中，您将了解：

  • 如何编写使用 Firebase Emulator 的单元测试。
  • 如何使用 Firebase 模拟器调试安全规则。

7. 创建专为您的应用量身定制的安全规则

虽然我们的 Web 应用可以读取和写入数据，但到目前为止，我们还没有真正担心过安全性。Cloud Firestore 使用名为“安全规则”的系统来声明谁有权限读取和写入数据。Emulator Suite 非常适合用于设计这些规则的原型。

在编辑器中，打开 emulators-codelab/codelab-initial-state/firestore.rules 文件。您会发现，我们的规则分为三个主要部分：

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // User's cart metadata
    match /carts/{cartID} {
      // TODO: Change these! Anyone can read or write.
      allow read, write: if true;
    }

    // Items inside the user's cart
    match /carts/{cartID}/items/{itemID} {
      // TODO: Change these! Anyone can read or write.
      allow read, write: if true;
    }

    // All items available in the store. Users can read
    // items but never write them.
    match /items/{itemID} {
      allow read: if true;
    }
  }
}

现在，任何人都可以从我们的数据库读取数据以及向其中写入数据！我们希望确保只有有效的操作才能通过，并且我们不会泄露任何敏感信息。

在此 Codelab 中，我们将遵循最小权限原则，锁定所有文档，并逐步添加访问权限，直到所有用户都拥有所需的所有访问权限，但不会超出此范围。我们将条件设置为 false，以更新前两个规则以拒绝访问：

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // User's cart metadata
    match /carts/{cartID} {
      // UPDATE THIS LINE
      allow read, write: if false;
    }

    // Items inside the user's cart
    match /carts/{cartID}/items/{itemID} {
      // UPDATE THIS LINE
      allow read, write: if false;
    }

    // All items available in the store. Users can read
    // items but never write them.
    match /items/{itemID} {
      allow read: if true;
    }
  }
}

8. 运行模拟器和测试

启动模拟器

在命令行中，确保您位于 emulators-codelab/codelab-initial-state/ 中。您可能仍然可以通过前面的步骤运行模拟器。如果不是，请重新启动模拟器：

$ firebase emulators:start --import=./seed

模拟器运行后，您可以在本地针对它们运行测试。

运行测试

从目录 emulators-codelab/codelab-initial-state/ 的新终端标签页中运行命令行

首先进入 functions 目录（我们将在此目录中完成本 Codelab 的其余部分）：

$ cd functions

现在，在 functions 目录中运行 Mocha 测试，并滚动到输出结果顶部：

# Run the tests
$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping carts
    1) can be created and updated by the cart owner
    2) can be read only by the cart owner

  shopping cart items
    3) can be read only by the cart owner
    4) can be added only by the cart owner

  adding an item to the cart recalculates the cart total. 
    - should sum the cost of their items


  0 passing (364ms)
  1 pending
  4 failing

目前，我们有 4 项测试失败。在构建规则文件时，您可以通过观察更多测试通过来衡量进度。

9. 安全访问购物车

前两项失败的是“购物车”用于测试：

  • 用户只能自行创建和更新自己的购物车
  • 用户只能读取自己的购物车

functions/test.js

  it('can be created and updated by the cart owner', async () => {
    // Alice can create her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart").set({
      ownerUID: "alice",
      total: 0
    }));

    // Bob can't create Alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart").set({
      ownerUID: "alice",
      total: 0
    }));

    // Alice can update her own cart with a new total
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart").update({
      total: 1
    }));

    // Bob can't update Alice's cart with a new total
    await firebase.assertFails(bobDb.doc("carts/alicesCart").update({
      total: 1
    }));
  });

  it("can be read only by the cart owner", async () => {
    // Setup: Create Alice's cart as admin
    await admin.doc("carts/alicesCart").set({
      ownerUID: "alice",
      total: 0
    });

    // Alice can read her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart").get());

    // Bob can't read Alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart").get());
  });

让我们让这些测试通过。在编辑器中，打开安全规则文件 firestore.rules，然后更新 match /carts/{cartID} 中的语句：

firestore.rules

rules_version = '2';
service cloud.firestore {
    // UPDATE THESE LINES
    match /carts/{cartID} {
      allow create: if request.auth.uid == request.resource.data.ownerUID;
      allow read, update, delete: if request.auth.uid == resource.data.ownerUID;
    }

    // ...
  }
}

这些规则现在仅允许购物车所有者进行读写访问。

为了验证传入数据和用户的身份验证，我们使用两个在每条规则的上下文中都可用的对象：

10. 测试购物车访问权限

每次保存 firestore.rules 时，Emulator Suite 都会自动更新规则。您可以在运行模拟器的标签页中查找 Rules updated 消息，确认模拟器是否已更新规则：

5680da418b420226.png

重新运行测试，并检查前两项测试现在是否通过：

$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping carts
    ✓ can be created and updated by the cart owner (195ms)
    ✓ can be read only by the cart owner (136ms)

  shopping cart items
    1) can be read only by the cart owner
    2) can be added only by the cart owner

  adding an item to the cart recalculates the cart total. 
    - should sum the cost of their items

  2 passing (482ms)
  1 pending
  2 failing

做得好！您现在可以访问购物车了。我们继续下一个失败的测试。

11. 检查界面中的“添加到购物车”流程

目前，虽然购物车所有者可以读取和写入购物车中的商品，但无法读取或写入购物车中的个别商品。这是因为所有者虽然有权访问购物车文档，但无法访问购物车的商品子集合。

对用户而言，这是一种损坏状态。

返回 http://127.0.0.1:5000, 上运行的网页界面，然后尝试将商品添加到购物车。您收到 Permission Denied 错误（可以在调试控制台中看到），因为我们尚未向用户授予访问 items 子集合中已创建文档的权限。

12. 允许访问购物车商品

这两项测试可确认用户只能向自己的购物车中添加商品或从中读取商品：

  it("can be read only by the cart owner", async () => {
    // Alice can read items in her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart/items/milk").get());

    // Bob can't read items in alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart/items/milk").get())
  });

  it("can be added only by the cart owner",  async () => {
    // Alice can add an item to her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart/items/lemon").set({
      name: "lemon",
      price: 0.99
    }));

    // Bob can't add an item to alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart/items/lemon").set({
      name: "lemon",
      price: 0.99
    }));
  });

因此，我们可以编写一个规则，如果当前用户的 UID 与购物车文档中的 ownerUID 相同，则允许访问。由于无需为 create, update, delete 指定不同的规则，因此您可以使用 write 规则，该规则适用于修改数据的所有请求。

更新 items 子集合中文档的规则。条件中的 get 正在从 Firestore 读取一个值，在本例中为购物车文档中的 ownerUID。

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // ...

    // UPDATE THESE LINES
    match /carts/{cartID}/items/{itemID} {
      allow read, write: if get(/databases/$(database)/documents/carts/$(cartID)).data.ownerUID == request.auth.uid;
    }

    // ...
  }
}

13. 测试购物车商品访问权限

现在，我们可以重新运行测试。滚动到输出顶部，检查是否有更多测试通过：

$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping carts
    ✓ can be created and updated by the cart owner (195ms)
    ✓ can be read only by the cart owner (136ms)

  shopping cart items
    ✓ can be read only by the cart owner (111ms)
    ✓ can be added only by the cart owner


  adding an item to the cart recalculates the cart total. 
    - should sum the cost of their items


  4 passing (401ms)
  1 pending

好极了！现在，我们的所有测试均已通过。我们有一项待处理的测试，但我们会在几个步骤后进行该测试。

14. 再次检查“添加到购物车”流程

返回网络前端 ( http://127.0.0.1:5000)，将商品添加到购物车。这是一个重要的步骤，用于确认我们的测试和规则是否符合客户所需的功能。（请注意，上次我们试用此界面时，用户无法向购物车添加商品！）

69ad26cee520bf24

保存 firestore.rules 时，客户端会自动重新加载规则。因此，请尝试将商品添加到购物车。

回顾

真棒！您刚刚提高了应用的安全性，这是让应用做好正式发布准备的重要一步！如果这是一个正式版应用，我们可以将这些测试添加到持续集成流水线中。这样，我们就可以确信，即使其他人正在修改规则，我们的购物车数据也将拥有这些访问权限控制。

ba5440b193e75967.gif

且慢，还有更多益处！

如果您继续学习，将会了解：

  • 如何编写由 Firestore 事件触发的函数
  • 如何创建跨多个模拟器运行的测试

15. 设置 Cloud Functions 测试

到目前为止，我们重点介绍了 Web 应用的前端和 Firestore 安全规则。不过，此应用还使用 Cloud Functions 函数来及时更新用户的购物车，因此我们也需要测试该代码。

有了 Emulator Suite，您可以轻松测试 Cloud Functions 函数，甚至是使用 Cloud Firestore 和其他服务的函数。

在编辑器中，打开 emulators-codelab/codelab-initial-state/functions/test.js 文件并滚动到文件中的最后一个测试。目前，该请求被标记为待处理：

//  REMOVE .skip FROM THIS LINE
describe.skip("adding an item to the cart recalculates the cart total. ", () => {
  // ...

  it("should sum the cost of their items", async () => {
    ...
  });
});

如需启用测试，请移除 .skip，使其如下所示：

describe("adding an item to the cart recalculates the cart total. ", () => {
  // ...

  it("should sum the cost of their items", async () => {
    ...
  });
});

接下来，在文件顶部找到 REAL_FIREBASE_PROJECT_ID 变量，并将其更改为您的真实 Firebase 项目 ID：

// CHANGE THIS LINE
const REAL_FIREBASE_PROJECT_ID = "changeme";

如果忘记了项目 ID，您可以在 Firebase 控制台的“项目设置”中找到 Firebase 项目 ID：

d6d0429b700d2b21.png

16. 浏览 Functions 测试

由于此测试用于验证 Cloud Firestore 与 Cloud Functions 之间的交互，因此与之前的 Codelab 中的测试相比，需要进行更多设置。我们来演示一下这项测试，了解一下它的预期结果。

创建购物车

Cloud Functions 函数在可信服务器环境中运行，可以使用 Admin SDK 使用的服务账号身份验证。首先，使用 initializeAdminApp（而不是 initializeApp）初始化应用。然后，为要添加商品的购物车创建 DocumentReference 并初始化购物车：

it("should sum the cost of their items", async () => {
    const db = firebase
        .initializeAdminApp({ projectId: REAL_FIREBASE_PROJECT_ID })
        .firestore();

    // Setup: Initialize cart
    const aliceCartRef = db.doc("carts/alice")
    await aliceCartRef.set({ ownerUID: "alice", totalPrice: 0 });

    ...
  });

触发函数

然后，将文档添加到购物车文档的 items 子集合中，以触发该函数。添加两个项，以确保您测试的是函数中发生的加法。

it("should sum the cost of their items", async () => {
    const db = firebase
        .initializeAdminApp({ projectId: REAL_FIREBASE_PROJECT_ID })
        .firestore();

    // Setup: Initialize cart
    const aliceCartRef = db.doc("carts/alice")
    await aliceCartRef.set({ ownerUID: "alice", totalPrice: 0 });

    //  Trigger calculateCart by adding items to the cart
    const aliceItemsRef = aliceCartRef.collection("items");
    await aliceItemsRef.doc("doc1").set({name: "nectarine", price: 2.99});
    await aliceItemsRef.doc("doc2").set({ name: "grapefruit", price: 6.99 });

    ...
    });
  });

设置测试预期

使用 onSnapshot() 注册一个监听器，以监听购物车文档的任何更改。onSnapshot() 会返回一个函数，您可以调用该函数来取消注册监听器。

在此测试中，添加两件总价为 9.98 美元的商品。然后，检查购物车中是否包含预期的 itemCount 和 totalPrice。如果是，则函数已能胜任其工作。

it("should sum the cost of their items", (done) => {
    const db = firebase
        .initializeAdminApp({ projectId: REAL_FIREBASE_PROJECT_ID })
        .firestore();

    // Setup: Initialize cart
    const aliceCartRef = db.doc("carts/alice")
    aliceCartRef.set({ ownerUID: "alice", totalPrice: 0 });

    //  Trigger calculateCart by adding items to the cart
    const aliceItemsRef = aliceCartRef.collection("items");
    aliceItemsRef.doc("doc1").set({name: "nectarine", price: 2.99});
    aliceItemsRef.doc("doc2").set({ name: "grapefruit", price: 6.99 });
    
    // Listen for every update to the cart. Every time an item is added to
    // the cart's subcollection of items, the function updates `totalPrice`
    // and `itemCount` attributes on the cart.
    // Returns a function that can be called to unsubscribe the listener.
    await new Promise((resolve) => {
      const unsubscribe = aliceCartRef.onSnapshot(snap => {
        // If the function worked, these will be cart's final attributes.
        const expectedCount = 2;
        const expectedTotal = 9.98;
  
        // When the `itemCount`and `totalPrice` match the expectations for the
        // two items added, the promise resolves, and the test passes.
        if (snap.data().itemCount === expectedCount && snap.data().totalPrice == expectedTotal) {
          // Call the function returned by `onSnapshot` to unsubscribe from updates
          unsubscribe();
          resolve();
        };
      });
    });
   });
 });

17. 运行测试

您可能仍在运行之前的测试中的模拟器。如果没有，请启动模拟器。在命令行中，运行

$ firebase emulators:start --import=./seed

打开新的终端标签页（让模拟器保持运行状态），然后进入 functions 目录。您可能仍要在安全规则测试中将其打开。

$ cd functions

现在运行单元测试，您应该会看到总共有 5 项测试：

$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping cart creation
    ✓ can be created by the cart owner (82ms)

  shopping cart reads, updates, and deletes
    ✓ cart can be read by the cart owner (42ms)

  shopping cart items
    ✓ items can be read by the cart owner (40ms)
    ✓ items can be added by the cart owner

  adding an item to the cart recalculates the cart total. 
    1) should sum the cost of their items

  4 passing (2s)
  1 failing

如果您查看具体失败情况，会发现这似乎是超时错误。这是因为测试在等待函数正确更新，但实际上从不需要更新。现在，我们可以编写函数来满足测试要求了。

18. 编写函数

如需修复此测试，您需要更新 functions/index.js 中的函数。尽管其中部分函数已编写完毕，但并不完整。该函数目前的样子如下所示：

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }

      let totalPrice = 125.98;
      let itemCount = 8;
      try {
        
        const cartRef = db.collection("carts").doc(context.params.cartId);

        await cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    });

该函数正确设置了购物车引用，但之后不会计算 totalPrice 和 itemCount 的值，而是将它们更新为硬编码的值。

获取并迭代优化

items 子合集

初始化一个新常量 itemsSnap，将其设为 items 子集合。然后，遍历集合中的所有文档。

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }


      try {
        let totalPrice = 125.98;
        let itemCount = 8;

        const cartRef = db.collection("carts").doc(context.params.cartId);
        // ADD LINES FROM HERE
        const itemsSnap = await cartRef.collection("items").get();

        itemsSnap.docs.forEach(item => {
          const itemData = item.data();
        })
        // TO HERE
       
        return cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    });

计算 totalPrice 和 itemCount

首先，我们将 totalPrice 和 itemCount 的值初始化为零。

然后，将逻辑添加到迭代代码块中。首先，检查商品是否有价格。如果商品没有指定数量，则将其默认设置为 1。然后，将数量添加到 itemCount 的累计总和中。最后，将商品价格乘以数量的结果添加到 totalPrice 的累计总金额中：

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }

      try {
        // CHANGE THESE LINES
        let totalPrice = 0;
        let itemCount = 0;

        const cartRef = db.collection("carts").doc(context.params.cartId);
        const itemsSnap = await cartRef.collection("items").get();

        itemsSnap.docs.forEach(item => {
          const itemData = item.data();
          // ADD LINES FROM HERE
          if (itemData.price) {
            // If not specified, the quantity is 1
            const quantity = itemData.quantity ? itemData.quantity : 1;
            itemCount += quantity;
            totalPrice += (itemData.price * quantity);
          }
          // TO HERE
        })

        await cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    });

您还可以添加日志记录以帮助调试成功和错误状态：

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }

      let totalPrice = 0;
      let itemCount = 0;
      try {
        const cartRef = db.collection("carts").doc(context.params.cartId);
        const itemsSnap = await cartRef.collection("items").get();

        itemsSnap.docs.forEach(item => {
          const itemData = item.data();
          if (itemData.price) {
            // If not specified, the quantity is 1
            const quantity = (itemData.quantity) ? itemData.quantity : 1;
            itemCount += quantity;
            totalPrice += (itemData.price * quantity);
          }
        });

        await cartRef.update({
          totalPrice,
          itemCount
        });

        // OPTIONAL LOGGING HERE
        console.log("Cart total successfully recalculated: ", totalPrice);
      } catch(err) {
        // OPTIONAL LOGGING HERE
        console.warn("update error", err);
      }
    });

19. 重新运行测试

在命令行中，确保模拟器仍在运行，然后重新运行测试。您无需重启模拟器，因为它们会自动获取函数的更改。您应该会看到所有测试均已通过：

$ npm test
> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping cart creation
    ✓ can be created by the cart owner (306ms)

  shopping cart reads, updates, and deletes
    ✓ cart can be read by the cart owner (59ms)

  shopping cart items
    ✓ items can be read by the cart owner
    ✓ items can be added by the cart owner

  adding an item to the cart recalculates the cart total. 
    ✓ should sum the cost of their items (800ms)


  5 passing (1s)

干得漂亮！

20. 使用店面界面试用该功能

进行最终测试时，请返回 Web 应用 (http://127.0.0.1:5000/)，然后将商品添加到购物车中。

69ad26cee520bf24.png

确认购物车中更新了正确的总金额。太好了！

回顾

您已经了解了 Cloud Functions for Firebase 与 Cloud Firestore 之间的复杂测试用例。您编写了一个 Cloud Functions 函数，以便让测试通过。您还确认了新功能在界面中正常运行！您已完成所有这些操作，并在您自己的机器上运行模拟器。

此外，您还创建了一个针对本地模拟器运行的 Web 客户端，定制了用于保护数据的安全规则，并使用本地模拟器测试了安全规则。

c6a7aeb91fe97a64.gif