feat: make fields configurable for determining whether or not to fetc…

…h edges (#614) * docs: fix link to types file * feat: make fields configurable for determining whether or not to fetch edges * Add changeset
gajus · May 29, 2024 · ce9b19c · ce9b19c
1 parent 0750527
commit ce9b19c
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 5 deletions.
diff --git a/.changeset/moody-apricots-wonder.md b/.changeset/moody-apricots-wonder.md
@@ -0,0 +1,5 @@
+---
+"@slonik/dataloaders": minor
+---
+
+feat: make fields configurable for determining whether or not to fetch edges
diff --git a/packages/slonik-dataloaders/src/factories/createConnectionLoaderClass.test.ts b/packages/slonik-dataloaders/src/factories/createConnectionLoaderClass.test.ts
@@ -456,7 +456,7 @@ describe('createConnectionLoaderClass', () => {
     expect(results[1].count).toEqual(2);
   });
 
-  it('gets the edges without fetching edges', async () => {
+  it('gets the edges without fetching count', async () => {
     const loader = new PersonConnectionLoader(pool);
     const results = await Promise.all([
       loader.load({
@@ -474,6 +474,38 @@ describe('createConnectionLoaderClass', () => {
     expect(results[1].count).toEqual(0);
     expect(results[1].edges.length).toEqual(2);
   });
+
+  it('fetches edges for fields provided in resolverFieldsThatRequireFetchingEdges config variable', async () => {
+    const loaderClass = createConnectionLoaderClass({
+      query: sql.type(
+        z
+          .object({
+            id: z.number(),
+            name: z.string(),
+            uid: z.string(),
+          })
+          .strict(),
+      )`
+        SELECT
+          id,
+          uid,
+          name
+        FROM person
+      `,
+      resolverFieldsThatRequireFetchingEdges: ['data'],
+    });
+
+    const loader = new loaderClass(pool);
+    const result = await loader.load({
+      info: getInfo(['data']),
+    });
+
+    expect(countTaggedQueries('@count-query')).toEqual(0);
+    expect(countTaggedQueries('@edges-query')).toEqual(1);
+
+    expect(result.count).toEqual(0);
+    expect(result.edges.length).toEqual(10);
+  });
 });
 
 describe('createConnectionLoaderClass (with validation)', () => {

diff --git a/packages/slonik-dataloaders/src/factories/createConnectionLoaderClass.ts b/packages/slonik-dataloaders/src/factories/createConnectionLoaderClass.ts
@@ -37,9 +37,13 @@ const TABLE_ALIAS = 't1';
 export const createConnectionLoaderClass = <T extends ZodTypeAny>(config: {
   columnNameTransformer?: (column: string) => string;
   query: QuerySqlToken<T>;
+  resolverFieldsThatRequireFetchingEdges?: string[];
 }) => {
   const { columnNameTransformer = snakeCase, query } = config;
 
+  const fieldsThatRequireFetchingEdges =
+    config.resolverFieldsThatRequireFetchingEdges ?? ['pageInfo', 'edges'];
+
   const columnIdentifiers = getColumnIdentifiers<z.infer<T>>(
     TABLE_ALIAS,
     columnNameTransformer,
@@ -105,10 +109,11 @@ export const createConnectionLoaderClass = <T extends ZodTypeAny>(config: {
               countQueries.push(null);
             }
 
-            if (
-              requestedFields.has('pageInfo') ||
-              requestedFields.has('edges')
-            ) {
+            const shouldFetchEdges = fieldsThatRequireFetchingEdges.some(
+              (field) => requestedFields.has(field),
+            );
+
+            if (shouldFetchEdges) {
               const orderByExpressions: Array<[SqlToken, OrderDirection]> =
                 orderBy ? orderBy(columnIdentifiers) : [];