dynamo-query-engine 1.0.5 → 1.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dynamo-query-engine",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Type-safe DynamoDB query builder for GraphQL with support for filtering, sorting, pagination, and relation expansion",
   "type": "module",
   "main": "index.js",

package/src/core/expandResolver.js

@@ -4,9 +4,7 @@
 
 import "../types/jsdoc.js";
 import { modelRegistry } from "./modelRegistry.js";
-import { buildGridQuery } from "./gridQueryBuilder.js";
-import { validateExpandField } from "../utils/validation.js";
-import { extractGridConfig } from "./gridQueryBuilder.js";
+import { buildGridQuery, extractGridConfig } from "./gridQueryBuilder.js";
 
 /**
  * Extract expand policy from schema
@@ -62,6 +60,15 @@ export async function resolveExpand({
   // Get target model from registry
   const targetModel = modelRegistry.get(policy.type);
 
+  // Get the GraphQL type name from the schema (if defined)
+  const attributes = parentModel.schema.getAttributes();
+  const fieldConfig = attributes[field];
+  const graphqlTypeName = fieldConfig?.graphql?.type || policy.type;
+  
+  // Determine which property name to use for storing the expanded data
+  // If graphql.type is defined, use it as the property name, otherwise use the field name
+  const expandPropertyName = fieldConfig?.graphql?.type || field;
+
   // Determine limit based on args and policy
   const requestedLimit = args.pagination?.pageSize ?? policy.defaultLimit;
   const limit = Math.min(requestedLimit, policy.maxLimit);
@@ -69,41 +76,95 @@ export async function resolveExpand({
   // Resolve relations for each parent item
   const expandPromises = parentItems.map(async (parent) => {
     try {
-      // For MANY relations, we need a partition key value
-      // This should be either parent.pk or a specific field based on the relation
+      // Get partition key value from parent
+      // This should be either parent.pk or the first field (usually tenantId)
       const partitionKeyValue = parent.pk || parent[Object.keys(parent)[0]];
 
       if (!partitionKeyValue) {
         console.warn(
           `Cannot expand '${field}' for parent: missing partition key value`
         );
-        parent[field] = [];
+        parent[expandPropertyName] = policy.relation === "ONE" ? null : [];
         return;
       }
 
-      // Build query for expanded items
-      const { query } = buildGridQuery({
-        model: targetModel,
-        partitionKeyValue,
-        filterModel: args.filter,
-        sortModel: args.sort,
-        paginationModel: { pageSize: limit },
-        // No cursor for nested expands
-      });
+      let results;
+
+      // For ONE relations with a foreignKey, we can optimize by directly querying for that specific item
+      if (policy.relation === "ONE" && policy.foreignKey) {
+        const foreignKeyValue = parent[policy.foreignKey];
+        
+        if (!foreignKeyValue) {
+          console.warn(
+            `Cannot expand '${field}' for parent: missing foreign key value '${policy.foreignKey}'`
+          );
+          parent[expandPropertyName] = null;
+          return;
+        }
+
+        // Build a query that filters for the specific range key value
+        const targetAttributes = targetModel.schema.getAttributes();
+        const rangeKeyName = Object.keys(targetAttributes).find(
+          (key) => targetAttributes[key].rangeKey === true
+        );
 
-      // Execute query
-      const results = await query.exec();
+        if (!rangeKeyName) {
+          console.warn(
+            `Cannot expand '${field}': target model '${policy.type}' has no range key defined`
+          );
+          parent[expandPropertyName] = null;
+          return;
+        }
+
+        // Build query with range key filter
+        const filterModel = JSON.stringify({
+          items: [
+            {
+              field: rangeKeyName,
+              operator: "equals",
+              value: foreignKeyValue,
+            },
+          ],
+        });
+
+        const { query } = buildGridQuery({
+          model: targetModel,
+          partitionKeyValue,
+          filterModel,
+          limit: 1,
+        });
+
+        results = await query.exec();
+      } else {
+        // For MANY relations or ONE without foreignKey, use standard query
+        const { query } = buildGridQuery({
+          model: targetModel,
+          partitionKeyValue,
+          filterModel: args.filter,
+          sortModel: args.sort,
+          paginationModel: { pageSize: limit },
+          // No cursor for nested expands
+        });
+
+        results = await query.exec();
+      }
+
+      // Add __typename to each result
+      const resultsWithTypename = results.map((item) => ({
+        ...item,
+        __typename: graphqlTypeName,
+      }));
 
       // Assign results to parent
       if (policy.relation === "ONE") {
-        parent[field] = results.length > 0 ? results[0] : null;
+        parent[expandPropertyName] = resultsWithTypename.length > 0 ? resultsWithTypename[0] : null;
       } else {
-        parent[field] = results;
+        parent[expandPropertyName] = resultsWithTypename;
       }
     } catch (error) {
       console.error(`Error expanding '${field}' for parent:`, error);
       // Gracefully handle errors - set empty result
-      parent[field] = policy.relation === "ONE" ? null : [];
+      parent[expandPropertyName] = policy.relation === "ONE" ? null : [];
     }
   });
 
@@ -111,6 +172,27 @@ export async function resolveExpand({
   await Promise.all(expandPromises);
 }
 
+/**
+ * Create a mapping from GraphQL field names to schema field names
+ * @param {*} schema - Dynamoose schema
+ * @returns {Object.<string, string>} Map of GraphQL field name to schema field name
+ */
+function createGraphQLToSchemaFieldMap(schema) {
+  const attributes = schema.getAttributes();
+  const map = {};
+
+  for (const [fieldName, config] of Object.entries(attributes)) {
+    // If the field has a graphql.type config, map from graphql type to field name
+    if (config?.graphql?.type) {
+      map[config.graphql.type] = fieldName;
+    }
+    // Also keep the original field name mapping (for backward compatibility)
+    map[fieldName] = fieldName;
+  }
+
+  return map;
+}
+
 /**
  * Resolve multiple expands from GraphQL resolve info
  * @param {Array} parentItems - Parent items to expand
@@ -137,18 +219,29 @@ export async function resolveExpands(
 
   // Get expand policy to filter only expandable fields
   const expandPolicy = extractExpandPolicy(parentModel.schema);
+  
+  // Create mapping from GraphQL field names to schema field names
+  const graphqlToSchemaMap = createGraphQLToSchemaFieldMap(parentModel.schema);
 
   // Resolve all expands in parallel
   const expandPromises = Object.entries(fields)
-    .filter(([fieldName]) => expandPolicy[fieldName])
-    .map(([fieldName, fieldInfo]) =>
-      resolveExpand({
+    .map(([graphqlFieldName, fieldInfo]) => {
+      // Map GraphQL field name to schema field name
+      const schemaFieldName = graphqlToSchemaMap[graphqlFieldName];
+      
+      // Check if this field is expandable
+      if (!schemaFieldName || !expandPolicy[schemaFieldName]) {
+        return null;
+      }
+
+      return resolveExpand({
         parentItems,
         parentModel,
-        field: fieldName,
+        field: schemaFieldName,
         args: fieldInfo.args || {},
-      })
-    );
+      });
+    })
+    .filter(Boolean); // Remove null entries
 
   await Promise.all(expandPromises);
 }

package/tests/unit/expandResolver.test.js

@@ -0,0 +1,356 @@
+/**
+ * @fileoverview Tests for expand resolver with GraphQL type names
+ */
+
+import { describe, it, expect, beforeEach, vi } from "vitest";
+import { resolveExpand, resolveExpands } from "../../src/core/expandResolver.js";
+import { modelRegistry } from "../../src/core/modelRegistry.js";
+import { createMockSchema, createMockModel, createMockQuery } from "../mocks/dynamoose.mock.js";
+
+describe("ExpandResolver", () => {
+  describe("resolveExpand with GraphQL type names", () => {
+    let parentModel;
+    let targetModel;
+    let parentItems;
+
+    beforeEach(() => {
+      // Clear registry
+      modelRegistry.clear();
+
+      // Create parent schema with unitId field that has graphql.type config
+      const parentSchema = createMockSchema({
+        tenantId: {
+          type: String,
+          hashKey: true,
+        },
+        reservationId: {
+          type: String,
+          rangeKey: true,
+        },
+        unitId: {
+          type: String,
+          query: {
+            expand: {
+              type: "Unit",
+              relation: "ONE",
+              foreignKey: "unitId", // Field in parent that references the child
+              defaultLimit: 1,
+              maxLimit: 1,
+            },
+          },
+          graphql: {
+            type: "Unit", // GraphQL type name
+          },
+        },
+      });
+
+      // Create target schema (Unit)
+      const targetSchema = createMockSchema({
+        tenantId: {
+          type: String,
+          hashKey: true,
+        },
+        unitId: {
+          type: String,
+          rangeKey: true,
+        },
+        name: {
+          type: String,
+        },
+      });
+
+      // Create parent model
+      parentModel = createMockModel(parentSchema);
+
+      // Create target model with mock query result
+      const unitData = [
+        {
+          tenantId: "tenant-1",
+          unitId: "unit-1",
+          name: "Unit A",
+        },
+      ];
+      targetModel = createMockModel(targetSchema, unitData);
+
+      // Register target model
+      modelRegistry.register("Unit", targetModel);
+
+      // Create parent items
+      parentItems = [
+        {
+          tenantId: "tenant-1",
+          reservationId: "res-1",
+          unitId: "unit-1",
+        },
+      ];
+    });
+
+    it("should store expanded data under GraphQL type name (Unit) not field name (unitId)", async () => {
+      await resolveExpand({
+        parentItems,
+        parentModel,
+        field: "unitId",
+      });
+
+      // The expanded data should be under 'Unit', not 'unitId'
+      expect(parentItems[0].Unit).toBeDefined();
+      expect(parentItems[0].Unit).toEqual({
+        tenantId: "tenant-1",
+        unitId: "unit-1",
+        name: "Unit A",
+        __typename: "Unit",
+      });
+    });
+
+    it("should add __typename field to expanded data", async () => {
+      await resolveExpand({
+        parentItems,
+        parentModel,
+        field: "unitId",
+      });
+
+      expect(parentItems[0].Unit.__typename).toBe("Unit");
+    });
+
+    it("should handle ONE relation correctly", async () => {
+      await resolveExpand({
+        parentItems,
+        parentModel,
+        field: "unitId",
+      });
+
+      // ONE relation should return a single object, not an array
+      expect(parentItems[0].Unit).toBeDefined();
+      expect(Array.isArray(parentItems[0].Unit)).toBe(false);
+    });
+
+    it("should handle MANY relation correctly", async () => {
+      // Clear and re-register with different config
+      modelRegistry.clear();
+      
+      // Update parent schema for MANY relation
+      const parentSchemaMany = createMockSchema({
+        tenantId: {
+          type: String,
+          hashKey: true,
+        },
+        reservationId: {
+          type: String,
+          rangeKey: true,
+        },
+        unitId: {
+          type: String,
+          query: {
+            expand: {
+              type: "Unit",
+              relation: "MANY",
+              defaultLimit: 10,
+              maxLimit: 100,
+            },
+          },
+          graphql: {
+            type: "Units", // Plural for MANY relation
+          },
+        },
+      });
+
+      const unitsData = [
+        { tenantId: "tenant-1", unitId: "unit-1", name: "Unit A" },
+        { tenantId: "tenant-1", unitId: "unit-2", name: "Unit B" },
+      ];
+
+      const parentModelMany = createMockModel(parentSchemaMany);
+      const targetModelMany = createMockModel(targetModel.schema, unitsData);
+
+      modelRegistry.register("Unit", targetModelMany);
+
+      await resolveExpand({
+        parentItems,
+        parentModel: parentModelMany,
+        field: "unitId",
+      });
+
+      // MANY relation should return an array
+      expect(parentItems[0].Units).toBeDefined();
+      expect(Array.isArray(parentItems[0].Units)).toBe(true);
+      expect(parentItems[0].Units).toHaveLength(2);
+      expect(parentItems[0].Units[0].__typename).toBe("Units");
+      expect(parentItems[0].Units[1].__typename).toBe("Units");
+    });
+
+    it("should use foreignKey to filter for specific item in ONE relation", async () => {
+      await resolveExpand({
+        parentItems,
+        parentModel,
+        field: "unitId",
+      });
+
+      // Should have expanded exactly one unit
+      expect(parentItems[0].Unit).toBeDefined();
+      expect(parentItems[0].Unit.unitId).toBe("unit-1");
+      expect(parentItems[0].Unit.name).toBe("Unit A");
+      
+      // Verify that buildGridQuery was called with a filterModel
+      // (This would require spy/mock inspection in a more detailed test)
+    });
+
+    it("should fallback to field name when graphql.type is not defined", async () => {
+      // Clear and re-register with different config
+      modelRegistry.clear();
+      
+      // Create schema without graphql.type config
+      const parentSchemaNoGraphQL = createMockSchema({
+        tenantId: {
+          type: String,
+          hashKey: true,
+        },
+        reservationId: {
+          type: String,
+          rangeKey: true,
+        },
+        unitId: {
+          type: String,
+          query: {
+            expand: {
+              type: "Unit",
+              relation: "ONE",
+              defaultLimit: 1,
+              maxLimit: 1,
+            },
+          },
+          // No graphql config
+        },
+      });
+
+      const unitData = [
+        { tenantId: "tenant-1", unitId: "unit-1", name: "Unit A" },
+      ];
+
+      const parentModelNoGraphQL = createMockModel(parentSchemaNoGraphQL);
+      const targetModelNoGraphQL = createMockModel(targetModel.schema, unitData);
+
+      modelRegistry.register("Unit", targetModelNoGraphQL);
+
+      await resolveExpand({
+        parentItems,
+        parentModel: parentModelNoGraphQL,
+        field: "unitId",
+      });
+
+      // Should fallback to field name 'unitId'
+      expect(parentItems[0].unitId).toBeDefined();
+      expect(parentItems[0].unitId.__typename).toBe("Unit");
+    });
+  });
+
+  describe("resolveExpands with GraphQL field mapping", () => {
+    let parentModel;
+    let targetModel;
+    let parentItems;
+
+    beforeEach(() => {
+      modelRegistry.clear();
+
+      const parentSchema = createMockSchema({
+        tenantId: {
+          type: String,
+          hashKey: true,
+        },
+        reservationId: {
+          type: String,
+          rangeKey: true,
+        },
+        unitId: {
+          type: String,
+          query: {
+            expand: {
+              type: "Unit",
+              relation: "ONE",
+              defaultLimit: 1,
+              maxLimit: 1,
+            },
+          },
+          graphql: {
+            type: "Unit",
+          },
+        },
+      });
+
+      const targetSchema = createMockSchema({
+        tenantId: {
+          type: String,
+          hashKey: true,
+        },
+        unitId: {
+          type: String,
+          rangeKey: true,
+        },
+        name: {
+          type: String,
+        },
+      });
+
+      const unitData = [
+        { tenantId: "tenant-1", unitId: "unit-1", name: "Unit A" },
+      ];
+
+      parentModel = createMockModel(parentSchema);
+      targetModel = createMockModel(targetSchema, unitData);
+
+      modelRegistry.register("Unit", targetModel);
+
+      parentItems = [
+        {
+          tenantId: "tenant-1",
+          reservationId: "res-1",
+          unitId: "unit-1",
+        },
+      ];
+    });
+
+    it("should map GraphQL field name (Unit) to schema field name (unitId)", async () => {
+      // Simulate GraphQL resolve info with field name 'Unit'
+      const fieldsByTypeName = {
+        Reservation: {
+          Unit: {
+            // GraphQL field name
+            fieldsByTypeName: {
+              Unit: {
+                unitId: {},
+                name: {},
+              },
+            },
+          },
+        },
+      };
+
+      await resolveExpands(parentItems, parentModel, fieldsByTypeName);
+
+      // Should map 'Unit' -> 'unitId' and store result under 'Unit'
+      expect(parentItems[0].Unit).toBeDefined();
+      expect(parentItems[0].Unit.__typename).toBe("Unit");
+    });
+
+    it("should skip non-expandable fields", async () => {
+      const fieldsByTypeName = {
+        Reservation: {
+          reservationId: {}, // Not an expandable field
+          Unit: {
+            fieldsByTypeName: {
+              Unit: {
+                unitId: {},
+                name: {},
+              },
+            },
+          },
+        },
+      };
+
+      await resolveExpands(parentItems, parentModel, fieldsByTypeName);
+
+      // Only Unit should be expanded
+      expect(parentItems[0].Unit).toBeDefined();
+      expect(parentItems[0].reservationId).toBe("res-1"); // Original value unchanged
+    });
+  });
+});