Add simple filters for collections

CHANGELOG.md

@@ -22,6 +22,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - YOLO v7 serverless feature added using ONNX backend (<https://github.com/opencv/cvat/pull/5552>)
 - Cypress test for social account authentication (<https://github.com/opencv/cvat/pull/5444>)
 - Dummy github and google authentication servers (<https://github.com/opencv/cvat/pull/5444>)
+- \[Server API\] Simple filters for object collection endpoints
+  (<https://github.com/opencv/cvat/pull/5575>)
 
 ### Changed
 - The Docker Compose files now use the Compose Specification version
@@ -31,18 +33,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   The corresponding arguments are keyword-only now.
   (<https://github.com/opencv/cvat/pull/5502>)
 - \[Server API\] Added missing pagination or pagination parameters in
-  `/project/{id}/tasks`, `/tasks/{id}/jobs`, `/jobs/{id}/issues`,
-  `/jobs/{id}/commits`, `/issues/{id}/comments`, `/organizations`
+  `/jobs/{id}/commits`, `/organizations`
   (<https://github.com/opencv/cvat/pull/5557>)
 - Windows Installation Instructions adjusted to work around <https://github.com/nuclio/nuclio/issues/1821>
 - The contour detection function for semantic segmentation (<https://github.com/opencv/cvat/pull/4665>)
 - Delete newline character when generating a webhook signature (<https://github.com/opencv/cvat/pull/5622>)
 - DL models UI (<https://github.com/opencv/cvat/pull/5635>)
 
 ### Deprecated
-- TDB
+- TBD
 
 ### Removed
+- \[Server API\] Endpoints with collections are removed in favor of their full variants
+  `/project/{id}/tasks`, `/tasks/{id}/jobs`, `/jobs/{id}/issues`, `/issues/{id}/comments`.
+  Corresponding fields are added or changed to provide a link to the child collection
+  in `/projects/{id}`, `/tasks/{id}`, `/jobs/{id}`, `/issues/{id}`
+  (<https://github.com/opencv/cvat/pull/5575>)
 - Limit on the maximum number of manifest files that can be added for cloud storage (<https://github.com/opencv/cvat/pull/5660>)
 
 ### Fixed
@@ -53,6 +59,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix the type of the credentials parameter of make_client from the Python SDK
 - Reduced number of noisy information on ortho views for 3D canvas (<https://github.com/opencv/cvat/pull/5608>)
 - Clean up disk space after a project is removed (<https://github.com/opencv/cvat/pull/5632>)
+- \[Server API\] Various errors in the generated schema (<https://github.com/opencv/cvat/pull/5575>)
 - SiamMask and TransT serverless functions (<https://github.com/opencv/cvat/pull/5658>)
 
 ### Security

cvat-core/src/api-implementation.ts

@@ -20,7 +20,6 @@ import {
 
 import User from './user';
 import { AnnotationFormats } from './annotation-formats';
-import { ArgumentError } from './exceptions';
 import { Task, Job } from './session';
 import Project from './project';
 import CloudStorage from './cloud-storage';
@@ -167,8 +166,8 @@ export default function implementAPI(cvat) {
         return users;
     };
 
-    cvat.jobs.get.implementation = async (filter) => {
-        checkFilter(filter, {
+    cvat.jobs.get.implementation = async (query) => {
+        checkFilter(query, {
             page: isInteger,
             filter: isString,
             sort: isString,
@@ -177,30 +176,24 @@ export default function implementAPI(cvat) {
             jobID: isInteger,
         });
 
-        if ('taskID' in filter && 'jobID' in filter) {
-            throw new ArgumentError('Filter fields "taskID" and "jobID" are not permitted to be used at the same time');
-        }
-
-        if ('taskID' in filter) {
-            const [task] = await serverProxy.tasks.get({ id: filter.taskID });
-            if (task) {
-                return new Task(task).jobs;
+        checkExclusiveFields(query, ['jobID', 'taskID', 'filter', 'search'], ['page', 'sort']);
+        if ('jobID' in query) {
+            const job = await serverProxy.jobs.get({ id: query.jobID });
+            if (job) {
+                return [new Job(job)];
             }
 
             return [];
         }
 
-        if ('jobID' in filter) {
-            const job = await serverProxy.jobs.get({ id: filter.jobID });
-            if (job) {
-                return [new Job(job)];
-            }
+        if ('taskID' in query) {
+            query.filter = JSON.stringify({ and: [{ '==': [{ var: 'task_id' }, query.taskID] }] });
         }
 
         const searchParams = {};
-        for (const key of Object.keys(filter)) {
+        for (const key of Object.keys(query)) {
             if (['page', 'sort', 'search', 'filter'].includes(key)) {
-                searchParams[key] = filter[key];
+                searchParams[key] = query[key];
             }
         }
 
@@ -229,8 +222,7 @@ export default function implementAPI(cvat) {
             }
         }
 
-        let tasksData = null;
-        if (filter.projectId) {
+        if ('projectId' in filter) {
             if (searchParams.filter) {
                 const parsed = JSON.parse(searchParams.filter);
                 searchParams.filter = JSON.stringify({ and: [parsed, { '==': [{ var: 'project_id' }, filter.projectId] }] });
@@ -239,8 +231,19 @@ export default function implementAPI(cvat) {
             }
         }
 
-        tasksData = await serverProxy.tasks.get(searchParams);
-        const tasks = tasksData.map((task) => new Task(task));
+        const tasksData = await serverProxy.tasks.get(searchParams);
+        const tasks = await Promise.all(tasksData.map(async (taskItem) => {
+            // Temporary workaround for UI
+            // Fixme: too much requests on tasks page
+            let jobs = { results: [] };
+            if ('id' in filter) {
+                jobs = await serverProxy.jobs.get({
+                    filter: JSON.stringify({ and: [{ '==': [{ var: 'task_id' }, taskItem.id] }] }),
+                }, true);
+            }
+            return new Task({ ...taskItem, jobs: jobs.results });
+        }));
+
         tasks.count = tasksData.count;
         return tasks;
     };
@@ -263,11 +266,7 @@ export default function implementAPI(cvat) {
         }
 
         const projectsData = await serverProxy.projects.get(searchParams);
-        const projects = projectsData.map((project) => {
-            project.task_ids = project.tasks;
-            return project;
-        }).map((project) => new Project(project));
-
+        const projects = projectsData.map((project) => new Project(project));
         projects.count = projectsData.count;
 
         return projects;

cvat-core/src/cloud-storage.ts

@@ -1,14 +1,14 @@
 // Copyright (C) 2021-2022 Intel Corporation
-// Copyright (C) 2022 CVAT.ai Corporation
+// Copyright (C) 2022-2023 CVAT.ai Corporation
 //
 // SPDX-License-Identifier: MIT
 
-import { isBrowser, isNode } from 'browser-or-node';
 import PluginRegistry from './plugins';
 import serverProxy from './server-proxy';
 import { ArgumentError } from './exceptions';
 import { CloudStorageCredentialsType, CloudStorageProviderType, CloudStorageStatus } from './enums';
 import User from './user';
+import { decodePreview } from './frames';
 
 function validateNotEmptyString(value: string): void {
     if (typeof value !== 'string') {
@@ -362,17 +362,7 @@ Object.defineProperties(CloudStorage.prototype.getPreview, {
             return new Promise((resolve, reject) => {
                 serverProxy.cloudStorages
                     .getPreview(this.id)
-                    .then((result) => {
-                        if (isNode) {
-                            resolve(global.Buffer.from(result, 'binary').toString('base64'));
-                        } else if (isBrowser) {
-                            const reader = new FileReader();
-                            reader.onload = () => {
-                                resolve(reader.result);
-                            };
-                            reader.readAsDataURL(result);
-                        }
-                    })
+                    .then((result) => decodePreview(result))
                     .catch((error) => {
                         reject(error);
                     });

cvat-core/src/common.ts

@@ -51,10 +51,10 @@ export function checkExclusiveFields(obj, exclusive, ignore): void {
         exclusive: [],
         other: [],
     };
-    for (const field in Object.keys(obj)) {
-        if (!(field in ignore)) {
-            if (field in exclusive) {
-                if (fields.other.length) {
+    for (const field in obj) {
+        if (!(ignore.includes(field))) {
+            if (exclusive.includes(field)) {
+                if (fields.other.length || fields.exclusive.length) {
                     throw new ArgumentError(`Do not use the filter field "${field}" with others`);
                 }
                 fields.exclusive.push(field);

cvat-core/src/frames.ts

@@ -618,26 +618,20 @@ export async function getContextImage(jobID, frame) {
     return frameDataCache[jobID].frameBuffer.getContextImage(frame);
 }
 
-export async function getPreview(taskID = null, jobID = null) {
+export function decodePreview(preview: Blob): Promise<string> {
     return new Promise((resolve, reject) => {
-        // Just go to server and get preview (no any cache)
-        serverProxy.frames
-            .getPreview(taskID, jobID)
-            .then((result) => {
-                if (isNode) {
-                    // eslint-disable-next-line no-undef
-                    resolve(global.Buffer.from(result, 'binary').toString('base64'));
-                } else if (isBrowser) {
-                    const reader = new FileReader();
-                    reader.onload = () => {
-                        resolve(reader.result);
-                    };
-                    reader.readAsDataURL(result);
-                }
-            })
-            .catch((error) => {
+        if (isNode) {
+            resolve(global.Buffer.from(preview, 'binary').toString('base64'));
+        } else if (isBrowser) {
+            const reader = new FileReader();
+            reader.onload = () => {
+                resolve(reader.result as string);
+            };
+            reader.onerror = (error) => {
                 reject(error);
-            });
+            };
+            reader.readAsDataURL(preview);
+        }
     });
 }
 

cvat-core/src/issue.ts

@@ -1,48 +1,48 @@
 // Copyright (C) 2020-2022 Intel Corporation
-// Copyright (C) 2022 CVAT.ai Corporation
+// Copyright (C) 2022-2023 CVAT.ai Corporation
 //
 // SPDX-License-Identifier: MIT
 
 import quickhull from 'quickhull';
 
-import { Job } from 'session';
 import PluginRegistry from './plugins';
 import Comment, { RawCommentData } from './comment';
 import User from './user';
 import { ArgumentError } from './exceptions';
 import serverProxy from './server-proxy';
 
 interface RawIssueData {
+    job: number;
+    position: number[];
+    frame: number;
     id?: number;
-    job?: any;
-    position?: number[];
-    comments?: any;
-    frame?: number;
+    comments?: RawCommentData[];
     owner?: any;
     resolved?: boolean;
     created_date?: string;
 }
 
 export default class Issue {
-    public readonly id: number;
-    public readonly job: Job;
-    public readonly comments: Comment[];
+    public readonly id?: number;
+    public readonly job: number;
     public readonly frame: number;
-    public readonly owner: User;
-    public readonly resolved: boolean;
-    public readonly createdDate: string;
-    public position: number[];
+    public readonly owner?: User;
+    public readonly comments: Comment[];
+    public readonly resolved?: boolean;
+    public readonly createdDate?: string;
+    public position?: number[];
+    private readonly __internal: RawIssueData & { comments: Comment[] };
 
     constructor(initialData: RawIssueData) {
-        const data: RawIssueData = {
+        const data: RawIssueData & { comments: Comment[] } = {
             id: undefined,
             job: undefined,
             position: undefined,
-            comments: [],
             frame: undefined,
             created_date: undefined,
             owner: undefined,
             resolved: undefined,
+            comments: undefined,
         };
 
         for (const property in data) {
@@ -53,14 +53,16 @@ export default class Issue {
 
         if (data.owner && !(data.owner instanceof User)) data.owner = new User(data.owner);
 
-        if (data.comments) {
-            data.comments = data.comments.map((comment) => new Comment(comment));
-        }
-
         if (typeof data.created_date === 'undefined') {
             data.created_date = new Date().toISOString();
         }
 
+        if (Array.isArray(initialData.comments)) {
+            data.comments = initialData.comments.map((comment: RawCommentData): Comment => new Comment(comment));
+        } else {
+            data.comments = [];
+        }
+
         Object.defineProperties(
             this,
             Object.freeze({
@@ -80,7 +82,7 @@ export default class Issue {
                     get: () => data.job,
                 },
                 comments: {
-                    get: () => [...data.comments],
+                    get: () => data.comments,
                 },
                 frame: {
                     get: () => data.frame,
@@ -144,19 +146,15 @@ export default class Issue {
     }
 
     public serialize(): RawIssueData {
-        const { comments } = this;
         const data: RawIssueData = {
+            job: this.job,
             position: this.position,
             frame: this.frame,
-            comments: comments.map((comment) => comment.serialize()),
         };
 
         if (typeof this.id === 'number') {
             data.id = this.id;
         }
-        if (typeof this.job === 'number') {
-            data.job = this.job;
-        }
         if (typeof this.createdDate === 'string') {
             data.created_date = this.createdDate;
         }
@@ -175,23 +173,24 @@ Object.defineProperties(Issue.prototype.comment, {
     implementation: {
         writable: false,
         enumerable: false,
-        value: async function implementation(data: RawCommentData) {
+        value: async function implementation(this: Issue, data: RawCommentData) {
             if (typeof data !== 'object' || data === null) {
                 throw new ArgumentError(`The argument "data" must be an object. Got "${data}"`);
             }
             if (typeof data.message !== 'string' || data.message.length < 1) {
                 throw new ArgumentError(`Comment message must be a not empty string. Got "${data.message}"`);
             }
 
+            const internalData = Object.getOwnPropertyDescriptor(this, '__internal').get();
             const comment = new Comment(data);
             if (typeof this.id === 'number') {
                 const serialized = comment.serialize();
                 serialized.issue = this.id;
                 const response = await serverProxy.comments.create(serialized);
                 const savedComment = new Comment(response);
-                this.__internal.comments.push(savedComment);
+                internalData.comments.push(savedComment);
             } else {
-                this.__internal.comments.push(comment);
+                internalData.comments.push(comment);
             }
         },
     },