Merge pull request #326 from psteinroe/fix/enrich-filter-paths-with-d…

…eclaration

fix: enrich filter paths with declaration from query paths

.changeset/itchy-suits-live.md

@@ -0,0 +1,5 @@
+---
+"@supabase-cache-helpers/postgrest-core": patch
+---
+
+fix: enrich parsed filter paths with declaration from query paths

packages/postgrest-core/__tests__/lib/extract-paths-from-filters.spec.ts

@@ -0,0 +1,28 @@
+import { SupabaseClient, createClient } from '@supabase/supabase-js';
+
+import { extractPathsFromFilters } from '../../src/lib/extract-paths-from-filter';
+import { PostgrestParser } from '../../src/postgrest-parser';
+
+describe('extractPathsFromFilters', () => {
+  let c: SupabaseClient;
+
+  beforeAll(() => {
+    c = createClient('https://localhost', '1234');
+  });
+
+  it('should add declarations from path to matching filter path', () => {
+    const parser = new PostgrestParser(
+      c
+        .from('conversation')
+        .select('inbox:inbox_id!inner(id,name,emoji)')
+        .eq('inbox_id.id', 'inbox-id'),
+    );
+    expect(extractPathsFromFilters(parser.filters, parser.paths)).toEqual([
+      {
+        alias: 'inbox.id',
+        declaration: 'inbox:inbox_id!inner.id',
+        path: 'inbox_id.id',
+      },
+    ]);
+  });
+});

packages/postgrest-core/src/fetch/build-normalized-query.ts

@@ -50,7 +50,10 @@ export const buildNormalizedQuery = <Q extends string = '*'>({
 
   if (!disabled) {
     for (const tableQuery of queriesForTable()) {
-      for (const filterPath of extractPathsFromFilters(tableQuery.filters)) {
+      for (const filterPath of extractPathsFromFilters(
+        tableQuery.filters,
+        tableQuery.paths,
+      )) {
         // add paths used in filter
         const path = tableQuery.paths.find(
           (p) => p.path === filterPath.path && p.alias === filterPath.alias,

packages/postgrest-core/src/lib/extract-paths-from-filter.ts

@@ -6,21 +6,31 @@ import {
   FilterDefinitions,
 } from './query-types';
 
-export const extractPathsFromFilters = (f: FilterDefinitions) => {
+export const extractPathsFromFilters = (f: FilterDefinitions, p: Path[]) => {
   return f.reduce<Path[]>((prev, filter) => {
     if (isAndFilter(filter)) {
-      prev.push(...extractPathsFromFilters(filter.and));
+      prev.push(...extractPathsFromFilters(filter.and, p));
     } else if (isOrFilter(filter)) {
-      prev.push(...extractPathsFromFilters(filter.or));
+      prev.push(...extractPathsFromFilters(filter.or, p));
     } else if (isFilterDefinition(filter)) {
+      const relatedPath = p.find((p) => p.path === filter.path);
       const pathElements = filter.path.split('.');
       const aliasElements = filter.alias?.split('.');
       const declaration = pathElements
         .map(
-          (el, idx) => `${aliasElements ? `${aliasElements[idx]}:` : ''}${el}`,
+          (el, idx) =>
+            `${
+              aliasElements && aliasElements[idx] !== el
+                ? `${aliasElements[idx]}:`
+                : ''
+            }${el}`,
         )
         .join('.');
-      prev.push({ path: filter.path, alias: filter.alias, declaration });
+      prev.push({
+        path: filter.path,
+        alias: filter.alias,
+        declaration: relatedPath ? relatedPath.declaration : declaration,
+      });
     }
     return prev;
   }, []);

packages/postgrest-core/src/postgrest-filter.ts

@@ -29,7 +29,10 @@ export class PostgrestFilter<Result extends Record<string, unknown>> {
   constructor(
     public readonly params: { filters: FilterDefinitions; paths: Path[] },
   ) {
-    this._filterPaths = extractPathsFromFilters(this.params.filters);
+    this._filterPaths = extractPathsFromFilters(
+      this.params.filters,
+      this.params.paths,
+    );
   }
 
   public static fromQuery(query: string, opts?: PostgrestQueryParserOptions) {