Apollo iOS 中 Mock 测试时指令（@include/@skip）失效问题解析

在 Apollo iOS 1.15.1 版本中，开发者在进行 GraphQL 查询测试时可能会遇到一个典型问题：当查询中包含 @include 或 @skip 指令时，Mock 测试无法正确返回预期的字段数据。本文将深入分析这个问题及其解决方案。

问题现象

在正常的应用运行中，带有条件指令的查询能够正常工作。例如以下查询会根据变量 loadWithId 和 loadWithToken 的值决定是否返回对应字段：

query GetTaskQuery(
    $taskId: Int!,
    $token: String!,
    $loadWithId: Boolean = false,
    $loadWithToken: Boolean = false
) {
    find_task(id: $taskId) @include(if: $loadWithId) {
        ...TaskItemView
    }

    find_task_by_token(token: $token) @include(if: $loadWithToken) {
        ...TaskItemView
    }
}

但在 Mock 测试环境中，无论变量值如何设置，带有 @include 或 @skip 指令的字段总是被忽略，导致测试失败。

问题根源

这个问题源于 Mock 测试环境没有正确处理查询变量与指令之间的关联。在常规的 Apollo 客户端执行中，查询引擎会自动将变量值应用到指令条件判断上，但在 Mock 测试中，这种关联需要显式配置。

解决方案

Apollo iOS 测试支持库提供了 from(_:withVariables:) 方法来解决这个问题。该方法允许开发者明确指定测试时使用的变量值，确保 Mock 数据能够正确响应指令条件。

使用示例：

let mock = Mock<Query>(
    find_task: Mock<Task>(id: 1, name: "Mock Task"),
    find_task_by_token: Mock<Task>(id: 1, name: "Mock Task")
)

let selectionSet = SelectionSet.from(
    mock,
    withVariables: [
        "loadWithId": true,
        "loadWithToken": false
    ]
)

通过这种方式，Mock 数据会正确识别 @include(if: $loadWithId) 和 @include(if: $loadWithToken) 指令，并返回符合条件的数据。

最佳实践

1. 始终为 Mock 测试提供变量值：即使查询有默认值，也建议在测试中显式指定变量值。

2. 保持测试环境一致性：确保测试中使用的变量值与实际应用场景一致。

3. 覆盖多种条件组合：编写测试时应该考虑所有可能的指令条件组合，验证各种边界情况。

4. 利用类型安全：Apollo 生成的代码提供了类型安全的变量定义，充分利用这一特性可以减少测试错误。

总结

在 Apollo iOS 中进行 Mock 测试时，正确处理 GraphQL 指令需要额外注意变量值的传递。通过使用 from(_:withVariables:) 方法，开发者可以确保 Mock 测试环境能够正确响应 @include 和 @skip 等指令，从而编写出更可靠、更接近真实场景的测试用例。

理解这一机制不仅有助于解决当前问题，也为后续处理更复杂的 GraphQL 查询测试提供了基础。在实际开发中，建议将这种变量传递方式作为 Mock 测试的标准实践之一。