Datahike项目中属性引用模式下Pull查询的Bug分析与修复

问题背景

在Datahike这个开源数据库项目中，当启用属性引用(attribute-refs)功能时，Pull查询返回的结果结构存在一个关键问题。具体表现为：当查询一个属性实体时，返回结果中嵌套的属性引用(如valueType和cardinality)没有被正确地展开为完整的实体映射，而是仅保留了它们的ID值。

问题现象

在测试案例中，开发者创建了一个新的属性实体:attribute-to-use，并为其指定了:db/valueType和:db/cardinality属性。当对这个属性实体执行Pull查询时，预期结果应该包含完整的嵌套结构，但实际上返回的结果中，这些属性引用仅显示为原始ID值。

实际返回结果示例：

[[#:db{:id 62,
       :ident :attribute-to-use,
       :valueType 23,          ; 应为嵌套映射
       :cardinality 11}]]       ; 应为嵌套映射

期望返回结果：

[[#:db{:id 62,
       :ident :attribute-to-use,
       :valueType #:db{:id 23, :ident :db.type/keyword},
       :cardinality #:db{:id 11, :ident :db.cardinality/one}}]]

技术分析

这个问题的核心在于Datahike的Pull查询处理器在属性引用模式下没有正确处理嵌套的属性引用。在Datahike/Datomic的数据模型中，某些属性(如:db/valueType和:db/cardinality)实际上是引用其他实体的，启用attribute-refs?选项时，这些引用应该被自动解析为完整的实体。

Pull查询处理器需要递归地处理这些属性引用，确保每个引用都被适当地解析和展开。当前的实现显然在递归处理环节存在缺陷，导致只返回了引用实体的ID而非完整的实体数据。

影响范围

这个Bug主要影响以下场景：

1. 当系统配置中启用了attribute-refs? true时
2. 对包含属性引用的实体执行Pull查询
3. 查询结果中包含:db/valueType、:db/cardinality等系统属性引用

解决方案思路

修复此问题需要修改Pull查询处理器的实现，确保在属性引用模式下：

1. 识别出所有属性引用字段
2. 对这些字段执行递归的实体解析
3. 将解析结果以嵌套映射的形式嵌入到最终结果中

具体实现需要考虑性能优化，避免对同一实体的重复解析，同时保持与Datomic的行为兼容性。

测试验证

为了验证修复效果，可以添加如下测试用例：

(deftest test-pull-attribute
  (testing "验证Pull查询能正确展开属性引用"
    (let [db (d/db-with ref-db [{:db/ident :attribute-to-use
                                 :db/cardinality :db.cardinality/one
                                 :db/valueType :db.type/keyword}])
          result (d/q '[:find (pull ?attr [*])
                        :in $ ?attr-name
                        :where
                        [?attr :db/ident ?attr-name]]
                      db :attribute-to-use)
          [[x]] result
          ids [(:db/id x)
               (-> x :db/valueType :db/id)
               (-> x :db/cardinality :db/id)]]
      (is (= 1 (count result)))
      (is (= 1 (count (first result))))
      (is (= #{:db/id :db/ident :db/valueType :db/cardinality} (set (keys x))))
      (is (number? (:db/id x)))
      (is (= :attribute-to-use (:db/ident x)))
      (is (= :db.type/keyword (-> x :db/valueType :db/ident)))
      (is (= :db.cardinality/one (-> x :db/cardinality :db/ident)))
      (is (every? number? ids))
      (is (= (count (set ids))
             (count ids))))))

这个测试用例全面验证了Pull查询结果的正确性，包括：

• 结果结构的完整性
• 嵌套属性引用的正确展开
• 各实体ID的唯一性
• 关键字段的存在性和正确性

总结

Datahike在属性引用模式下的Pull查询功能存在一个重要的行为偏差问题。这个问题影响了查询结果的完整性和可用性，特别是在需要获取完整属性元数据的场景下。通过深入分析问题本质并设计合理的修复方案，可以确保Datahike在这一功能上与Datomic保持兼容，为用户提供一致的使用体验。