Google 会使用 AI 技术将内容翻译成您偏好的语言。AI 翻译可能包含错误。

使用 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，以便进行本地开发。

您还将学习如何：

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

2. 设置

获取源代码

在此 Codelab 中，您将从一个几乎完成的 The Fire Store 示例版本开始，因此您需要做的第一件事是克隆源代码：

$ 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 或更高版本，但更高版本包含更多问题修复。

$ firebase --version
9.6.0

关联到您的 Firebase 项目

创建 Firebase 项目

使用您的 Google 账号登录 Firebase 控制台。
点击相应按钮以创建新项目，然后输入项目名称（例如 Emulators Codelab）。
此项目名称将用作 Firebase 界面中的显示名称，Firebase 会基于该项目名称自动生成唯一的项目 ID。请注意，您现在可以点击修改图标设置首选项目 ID，但在项目创建后将无法再更改此 ID。

请记住您的项目 ID，因为稍后您需要在 Firebase CLI 中使用它来识别您的 Firebase 项目。如果您忘记了 ID，以后可以随时在项目设置中找到它。
点击继续。
如果看到相关提示，请查看并接受 Firebase 条款，然后点击继续。
（可选）在 Firebase 控制台中启用 AI 辅助功能（称为“Gemini in Firebase”）。
对于此 Codelab，您不需要使用 Google Analytics，因此请关闭 Google Analytics 选项。
点击创建项目，等待您的项目完成预配，然后点击继续。

将代码关联到 Firebase 项目

现在，我们需要将此代码连接到您的 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.

看到所有模拟器均已启动消息后，应用即可使用。

将 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 集合中已包含数据。

4. 运行应用

打开应用

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

使用应用

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

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

5. 调试应用

查找 bug

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

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;
    }

    // ...
  }

测试应用

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

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

不过，这些数字看起来完全不正确：

别担心，我们很快就会修复该 bug。首先，我们来深入了解一下，当您将商品添加到购物车时，实际发生了什么。

6. 本地函数触发器

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

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

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

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 Write - Admin

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

4) Firestore 读取 - 客户端

Web 前端已订阅，可接收有关购物车更改的更新。在 Cloud Functions 函数写入新的总数并更新界面后，它会收到实时更新，如 public/js/homepage.js 中所示：

public/js/homepage.js

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

回顾

太棒了！您刚刚设置了一个完全本地化的应用，该应用使用三个不同的 Firebase 模拟器进行完全本地化的测试。

还不止于此！在下一部分中，您将了解：

如何编写使用 Firebase 模拟器的单元测试。
如何使用 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

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

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;
    }

    // ...
  }
}

现在，这些规则仅允许购物车所有者拥有读写权限。

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

request 对象包含有关正在尝试的操作的数据和元数据。
如果 Firebase 项目使用的是 Firebase Authentication，则 request.auth 对象描述的是发出请求的用户。

10. 测试购物车访问权限

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

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

$ 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, 上运行的 Web 界面，尝试将商品添加到购物车。您会收到 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. 再次检查“添加到购物车”流程

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

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

回顾

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

且慢，还有更多益处！

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

如何编写由 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：

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. 使用 Storefront 界面进行试用

最后，返回 Web 应用 (http://127.0.0.1:5000/)，将一件商品添加到购物车。

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

回顾

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

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

使用 Firebase Emulator Suite 进行本地开发 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

1. 准备工作

前提条件

您将执行的操作

2. 设置

获取源代码

获取 Firebase CLI

关联到您的 Firebase 项目

创建 Firebase 项目

将代码关联到 Firebase 项目

3. 运行模拟器

启动模拟器

将 Web 应用连接到模拟器

打开 EmulatorUI

4. 运行应用

打开应用

使用应用

5. 调试应用

查找 bug

测试应用

6. 本地函数触发器

回顾

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

8. 运行模拟器和测试

启动模拟器

运行测试

9. 安全访问购物车

10. 测试购物车访问权限

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

12. 允许访问购物车商品

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

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

回顾

15. 设置 Cloud Functions 测试

16. 演示 Functions 测试

17. 运行测试

18. 编写函数

19. 重新运行测试

20. 使用 Storefront 界面进行试用

回顾

使用 Firebase Emulator Suite 进行本地开发