Append fields to where in v4 publish

Author: minottic

src/published-data/interfaces/published-data.interface.ts

@@ -1,18 +1,15 @@
 import { ApiProperty, ApiPropertyOptional } from "@nestjs/swagger";
 import { FilterQuery } from "mongoose";
 import { PublishedDataDocument } from "../schemas/published-data.schema";
+import { ILimitsFilter } from "src/common/interfaces/common.interface";
 
 export interface IPublishedDataFilters {
   where?: FilterQuery<PublishedDataDocument>;
   include?: { relation: string }[];
   fields?: {
     status: string;
   };
-  limits?: {
-    skip: number;
-    limit: number;
-    order: string;
-  };
+  limits?: ILimitsFilter;
 }
 
 export class ICount {

src/published-data/pipes/filter.pipe.ts

@@ -1,14 +1,32 @@
 import { FilterPipe } from "src/common/pipes/filter.pipe";
-import { PublishedData } from "../schemas/published-data.schema";
+import {
+  PublishedData,
+  PublishedDataDocument,
+} from "../schemas/published-data.schema";
 import { publishedDataV3toV4FieldMap } from "../dto/published-data.obsolete.dto";
-import { JsonToStringPipe } from "src/common/pipes/json-to-string.pipe";
+import { PipeTransform } from "@nestjs/common";
+import { isEmpty } from "lodash";
+import { IPublishedDataFilters } from "../interfaces/published-data.interface";
+import { FilterQuery } from "mongoose";
+
+class AppendFieldsToFilterPipe implements PipeTransform {
+  transform(value: {
+    filter: IPublishedDataFilters;
+    fields: FilterQuery<PublishedDataDocument>;
+  }) {
+    if (isEmpty(value.fields)) return value;
+    const filter = value.filter ?? {};
+    if (isEmpty(filter.where)) filter.where = value.fields;
+    else filter.where = { $and: [value.fields, filter.where] };
+    return { ...value, filter };
+  }
+}
 
 export const V3_FILTER_PIPE = [
   new FilterPipe<PublishedData>({ apiToDBMap: publishedDataV3toV4FieldMap }),
 ];
 
 export const V4_FILTER_PIPE = [
   new FilterPipe<PublishedData>({ allowObjectFields: false }),
-  new JsonToStringPipe("fields"),
-  new JsonToStringPipe("limits"),
+  new AppendFieldsToFilterPipe(),
 ];

src/published-data/published-data.v4.controller.ts

@@ -57,6 +57,7 @@ import {
   PublishedDataDocument,
 } from "./schemas/published-data.schema";
 import { V4_FILTER_PIPE } from "./pipes/filter.pipe";
+import { ILimitsFilter } from "src/common/interfaces/common.interface";
 
 @ApiBearerAuth()
 @ApiTags("published data v4")
@@ -120,24 +121,20 @@ export class PublishedDataV4Controller {
     @Query(...V4_FILTER_PIPE, RegisteredFilterPipe)
     filter?: {
       filter: IPublishedDataFilters;
-      fields: string;
-      limits: string;
+      fields: FilterQuery<PublishedDataDocument>;
+      limits: ILimitsFilter;
     },
   ) {
     const publishedDataFilters: IPublishedDataFilters = filter?.filter ?? {};
     const publishedDataLimits: {
-      skip: number;
-      limit: number;
-      order: string;
-    } = JSON.parse(filter?.limits ?? "{}");
-    const publishedDataFields = JSON.parse(filter?.fields ?? "{}");
+      skip?: number;
+      limit?: number;
+      order?: string;
+    } = filter?.limits ?? {};
 
     if (!publishedDataFilters.limits) {
       publishedDataFilters.limits = publishedDataLimits;
     }
-    if (!publishedDataFilters.fields) {
-      publishedDataFilters.fields = publishedDataFields;
-    }
 
     const ability = this.caslAbilityFactory.publishedDataInstanceAccess(
       request.user as JWTUser,
@@ -180,13 +177,10 @@ export class PublishedDataV4Controller {
     @Query(...V4_FILTER_PIPE, RegisteredFilterPipe)
     filter?: {
       filter: IPublishedDataFilters;
-      fields: string;
+      fields: FilterQuery<PublishedDataDocument>;
     },
   ) {
     const jsonFilters: IPublishedDataFilters = filter?.filter ?? {};
-    const jsonFields: FilterQuery<PublishedDataDocument> = filter?.fields
-      ? JSON.parse(filter.fields)
-      : {};
 
     const ability = this.caslAbilityFactory.datasetInstanceAccess(
       request.user as JWTUser,
@@ -207,17 +201,15 @@ export class PublishedDataV4Controller {
       };
     }
 
-    const filters: FilterQuery<PublishedDataDocument> = {
-      where: jsonFilters.where,
-      fields: jsonFields,
-    };
-
     const options: QueryOptions = {
       limit: jsonFilters?.limits?.limit,
       skip: jsonFilters?.limits?.skip,
     };
 
-    return this.publishedDataService.countDocuments(filters, options);
+    return this.publishedDataService.countDocuments(
+      { where: jsonFilters.where },
+      options,
+    );
   }
 
   // GET /publisheddata/formpopulate

test/PublishedDataV4.js

@@ -103,8 +103,9 @@ describe("1600: PublishedDataV4: Test of access to published data v4 endpoints",
 
   it("0023: should fetch all published data as admin ingestor with fields", async () => {
     const limits = { skip: 0 };
+    const fields = {createdBy: {$regex: "admin", $options: "i"}}
     return request(appUrl)
-      .get(`/api/v4/PublishedData?fields=${encodeURIComponent(JSON.stringify({}))}&limits=${encodeURIComponent(JSON.stringify(limits))}`)
+      .get(`/api/v4/PublishedData?fields=${encodeURIComponent(JSON.stringify(fields))}&limits=${encodeURIComponent(JSON.stringify(limits))}`)
       .set("Accept", "application/json")
       .set({ Authorization: `Bearer ${accessTokenAdminIngestor}` })
       .expect(TestData.SuccessfulGetStatusCode)
@@ -114,7 +115,7 @@ describe("1600: PublishedDataV4: Test of access to published data v4 endpoints",
       });
   });
 
-    it("0026: should fetch all published data as unatuh", async () => {
+  it("0026: should fetch all published data as unatuh", async () => {
     return request(appUrl)
       .get("/api/v4/PublishedData")
       .set("Accept", "application/json")