Improve Join Condition Parsing for Complex Queries

.github/workflows/main.yml

@@ -1,57 +1,45 @@
 # This is a basic workflow to help you get started with Actions
-
 name: Tests
-
 # Controls when the action will run.
 on:
   # Triggers the workflow on push or pull request events but only for the master branch
   push:
     branches: [master]
   pull_request:
     branches: [master]
-
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
-
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   # This workflow contains a single job called "build"
   test:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
     container: node:20
-    # env:
-    #   COMPOSE_FILE: ./docker-compose.yml
-
+    env:
+      COMPOSE_FILE: ./docker-compose.yml
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v2
-
       # Runs a single command using the runners shell
       - name: build docker db
         run: docker compose up -d
-
       - name: install
         run: yarn install
-
       - name: build
         run: yarn build
-
       - name: check docker
         run: docker compose up -d
-
       # Runs a set of commands using the runners shell
       - name: tests
         run: yarn test:coverage
-
       - name: Coveralls Parallel
         uses: coverallsapp/github-action@master
         with:
           github-token: ${{ secrets.github_token }}
           flag-name: run-${{ matrix.test_number }}
           parallel: true
-
   coverage:
     needs: test
     runs-on: ubuntu-latest

docs/requests.md

@@ -222,7 +222,7 @@ _Examples:_
 
 The join parameter now supports specifying a WHERE condition within the ON clause of the join using the on property. This allows for more granular control over the joined data.
 
-> ?join[]=**relation**||**field1**,**field2**,...||on[0]=**field**||**\$condition**||**value**,on[1]=**field**||**\$condition**...&join[]=...
+> ?join[]=**relation**||**field1**,**field2**,...||on[0]=**field**||**\$condition**||**value**&on[1]=**field**||**\$condition**...&join[]=...
 
 _Examples:_
 
@@ -295,6 +295,7 @@ import { RequestQueryBuilder } from '@dataui/crud-request';
 RequestQueryBuilder.setOptions({
   delim: '||',
   delimStr: ',',
+  delimArr: '&',
   paramNamesMap: {
     fields: ['fields', 'select'],
     search: 's',
@@ -356,6 +357,7 @@ qb.select(['foo', 'bar'])
     on: [
       { field: 'bar', operator: 'eq', value: 100 },
       { field: 'baz', operator: 'isnull' },
+      { field: 'date', operator: 'between', value: ['2023-01-01', '2023-12-31'] },
     ],
   })
   .sortBy({ field: 'bar', order: 'DESС' })

packages/crud-request/src/interfaces/request-query-builder-options.interface.ts

@@ -1,6 +1,7 @@
 export interface RequestQueryBuilderOptions {
   delim?: string;
   delimStr?: string;
+  delimArr?: string;
   paramNamesMap?: {
     fields?: string | string[];
     search?: string | string[];

packages/crud-request/src/request-query.builder.ts

@@ -40,6 +40,7 @@ export class RequestQueryBuilder {
   private static _options: RequestQueryBuilderOptions = {
     delim: '||',
     delimStr: ',',
+    delimArr: '&',
     paramNamesMap: {
       fields: ['fields', 'select'],
       search: 's',
@@ -58,11 +59,6 @@ export class RequestQueryBuilder {
   private paramNames: {
     [key in keyof RequestQueryBuilderOptions['paramNamesMap']]: string;
   } = {};
-  private joinConditionString: IStringifyOptions = {
-    encode: false,
-    delimiter: this.options.delimStr,
-    arrayFormat: 'indices',
-  };
   public queryObject: { [key: string]: any } = {};
   public queryString: string;
 
@@ -213,7 +209,12 @@ export class RequestQueryBuilder {
   }
 
   private addJoin(join: QueryJoin | QueryJoinArr): string {
-    const { delim, delimStr } = this.options;
+    const { delim, delimStr, delimArr } = this.options;
+    const conditionStringifyOptions: IStringifyOptions = {
+      encode: false,
+      delimiter: delimArr,
+      arrayFormat: 'indices',
+    };
 
     const normalizedJoin = Array.isArray(join)
       ? { field: join[0], select: join[1], on: join[2] }
@@ -230,7 +231,7 @@ export class RequestQueryBuilder {
       ? delim + normalizedJoin.select.join(delimStr)
       : '';
     const conditionsPart = conditions
-      ? delim + stringify(conditions, this.joinConditionString)
+      ? delim + stringify(conditions, conditionStringifyOptions)
       : '';
 
     return fieldPart + selectPart + conditionsPart;

packages/crud-request/src/request-query.parser.ts

@@ -67,10 +67,6 @@ export class RequestQueryParser implements ParsedRequestParams {
   private _paramNames: string[];
   private _paramsOptions: ParamsOptions;
 
-  private _joinConditionParseOptions: IParseOptions = {
-    delimiter: this._options.delimStr,
-  };
-
   private get _options(): RequestQueryBuilderOptions {
     return RequestQueryBuilder.getOptions();
   }
@@ -356,14 +352,14 @@ export class RequestQueryParser implements ParsedRequestParams {
   }
 
   private parseJoinConditions(conditionsString: string): QueryFilter[] {
-    const conditions: string[] = parse(conditionsString, this._joinConditionParseOptions)[
-      'on'
-    ];
+    const conditions: string[] = parse(conditionsString)['on'];
+
     return conditions.map((cond: string) => this.conditionParser('filter', {}, cond));
   }
 
   private joinParser(data: string): QueryJoin {
     const param = data.split(this._options.delim);
+
     const field = param[0];
     const selectString = param[1];
     const conditions = param.slice(2).join(this._options.delim);

packages/crud-request/test/request-query.builder.spec.ts

@@ -36,6 +36,12 @@ describe('#request-query', () => {
         const _options = (RequestQueryBuilder as any)._options;
         expect(_options.delim).toBe(override);
       });
+      it('should merge options, 3', () => {
+        const override = '#';
+        RequestQueryBuilder.setOptions({ delimArr: override });
+        const _options = (RequestQueryBuilder as any)._options;
+        expect(_options.delimArr).toBe(override);
+      });
     });
 
     describe('#select', () => {
@@ -223,7 +229,24 @@ describe('#request-query', () => {
             ],
           },
         ]);
-        const expected = ['baz||a,b,c||on[0]=bar||eq||100,on[1]=foo||isnull'];
+        const expected = ['baz||a,b,c||on[0]=bar||eq||100&on[1]=foo||isnull'];
+        expect(qb.queryObject.join).toIncludeSameMembers(expected);
+      });
+      it('should set join, 9', () => {
+        qb.setJoin([
+          {
+            field: 'qux',
+            select: ['a', 'b', 'c'],
+            on: [
+              { field: 'bar', operator: 'eq', value: 100 },
+              { field: 'foo', operator: 'isnull' },
+              { field: 'date', operator: 'between', value: ['2023-12-06', '2023-12-12'] },
+            ],
+          },
+        ]);
+        const expected = [
+          'qux||a,b,c||on[0]=bar||eq||100&on[1]=foo||isnull&on[2]=date||between||2023-12-06,2023-12-12',
+        ];
         expect(qb.queryObject.join).toIncludeSameMembers(expected);
       });
     });
@@ -384,6 +407,7 @@ describe('#request-query', () => {
             on: [
               { field: 'foo', operator: 'eq', value: 'baz' },
               { field: 'bar', operator: 'isnull' },
+              { field: 'qux', operator: 'between', value: [1000, 8000] },
             ],
           })
           .setLimit(1)
@@ -394,7 +418,7 @@ describe('#request-query', () => {
           .setIncludeDeleted(1)
           .query(false);
         const expected =
-          'fields=foo,bar&filter[0]=is||notnull&or[0]=ok||ne||false&join[0]=voo||h,data||on[0]=foo||eq||baz,on[1]=bar||isnull&limit=1&offset=2&page=3&sort[0]=foo,DESC&cache=0&include_deleted=1';
+          'fields=foo,bar&filter[0]=is||notnull&or[0]=ok||ne||false&join[0]=voo||h,data||on[0]=foo||eq||baz&on[1]=bar||isnull&on[2]=qux||between||1000,8000&limit=1&offset=2&page=3&sort[0]=foo,DESC&cache=0&include_deleted=1';
         expect(test).toBe(expected);
       });
     });
@@ -437,6 +461,7 @@ describe('#request-query', () => {
             on: [
               { field: 'foo', operator: 'eq', value: 'baz' },
               { field: 'bar', operator: 'isnull' },
+              { field: 'qux', operator: 'between', value: [1000, 8000] },
             ],
           },
           limit: 1,
@@ -446,7 +471,7 @@ describe('#request-query', () => {
           resetCache: true,
         }).query(false);
         const expected =
-          'fields=foo,bar&filter[0]=is||notnull&or[0]=ok||ne||false&join[0]=voo||h,data||on[0]=foo||eq||baz,on[1]=bar||isnull&limit=1&offset=2&page=3&sort[0]=foo,DESC&cache=0';
+          'fields=foo,bar&filter[0]=is||notnull&or[0]=ok||ne||false&join[0]=voo||h,data||on[0]=foo||eq||baz&on[1]=bar||isnull&on[2]=qux||between||1000,8000&limit=1&offset=2&page=3&sort[0]=foo,DESC&cache=0';
         expect(test).toBe(expected);
       });
       it('should return a valid query string, 2', () => {

packages/crud-request/test/request-query.parser.spec.ts

@@ -264,7 +264,7 @@ describe('#request-query', () => {
             join: [
               'foo',
               'bar||baz,boo',
-              'bar||baz,boo||on[0]=name||eq||jhon,on[1]=foo||isnull',
+              'bar||baz,boo||on[0]=name||eq||jhon&on[1]=foo||isnull',
             ],
           };
           const expected: QueryJoin[] = [
@@ -285,6 +285,45 @@ describe('#request-query', () => {
           expect(test.join[1]).toMatchObject(expected[1]);
           expect(test.join[2]).toMatchObject(expected[2]);
         });
+        it('should set array, 4', () => {
+          const query = {
+            join: [
+              'foo',
+              'bar||baz,boo',
+              'bar||baz,boo||on[0]=name||eq||jhon&on[1]=foo||isnull',
+              'qux||qubaz,quboo||on[0]=quux||between||06-12-2023,12-12-2023',
+            ],
+          };
+          const expected: QueryJoin[] = [
+            { field: 'foo' },
+            { field: 'bar', select: ['baz', 'boo'] },
+            {
+              field: 'bar',
+              select: ['baz', 'boo'],
+              on: [
+                { field: 'name', operator: 'eq', value: 'jhon' },
+                { field: 'foo', operator: 'isnull', value: '' },
+              ],
+            },
+            {
+              field: 'qux',
+              select: ['qubaz', 'quboo'],
+              on: [
+                {
+                  field: 'quux',
+                  operator: 'between',
+                  value: ['06-12-2023', '12-12-2023'],
+                },
+              ],
+            },
+          ];
+          const test = qp.parseQuery(query);
+
+          expect(test.join[0]).toMatchObject(expected[0]);
+          expect(test.join[1]).toMatchObject(expected[1]);
+          expect(test.join[2]).toMatchObject(expected[2]);
+          expect(test.join[3]).toMatchObject(expected[3]);
+        });
       });
 
       describe('#parse sort', () => {

packages/crud/src/crud/swagger.helper.ts

@@ -289,6 +289,7 @@ export class Swagger {
     const {
       delim: d,
       delimStr: coma,
+      delimArr: amp,
       fields,
       search,
       filter,
@@ -578,6 +579,7 @@ export class Swagger {
     return {
       delim: qbOptions.delim,
       delimStr: qbOptions.delimStr,
+      delimArr: qbOptions.delimArr,
       fields: name('fields'),
       search: name('search'),
       filter: name('filter'),

packages/crud/test/crud-config.service.spec.ts

@@ -26,13 +26,14 @@ describe('#crud', () => {
       const conf: CrudGlobalConfig = {
         queryParser: {
           delim: '__',
+          delimArr: '§',
         },
       };
       const expected = { ...CrudConfigService.config };
       CrudConfigService.load(conf);
       expect(CrudConfigService.config).toEqual(expect.objectContaining(expected));
       expect(RequestQueryBuilder.getOptions()).toEqual(
-        expect.objectContaining({ ...requestOptions, delim: '__' }),
+        expect.objectContaining({ ...requestOptions, delim: '__', delimArr: '§' }),
       );
     });
     it('should set query, routes, params', () => {