Jobs page: advanced filtration and implemented sorting

CHANGELOG.md

@@ -35,6 +35,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Basic page with jobs list, basic filtration to this list (<https://github.com/openvinotoolkit/cvat/pull/4258>)
 - Added OpenCV.js TrackerMIL as tracking tool (<https://github.com/openvinotoolkit/cvat/pull/4200>)
 - Ability to continue working from the latest frame where an annotator was before (<https://github.com/openvinotoolkit/cvat/pull/4297>)
+- Advanced filtration and sorting for a list of jobs (<https://github.com/openvinotoolkit/cvat/pull/4319>)
+
 
 
 ### Changed

cvat-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cvat-core",
-  "version": "4.2.0",
+  "version": "4.2.1",
   "description": "Part of Computer Vision Tool which presents an interface for client-side integration",
   "main": "babel.config.js",
   "scripts": {

cvat-core/src/api-implementation.js

@@ -11,22 +11,13 @@ const config = require('./config');
     const {
         isBoolean,
         isInteger,
-        isEnum,
         isString,
         checkFilter,
         checkExclusiveFields,
         camelToSnake,
         checkObjectType,
     } = require('./common');
 
-    const {
-        TaskStatus,
-        TaskMode,
-        DimensionType,
-        CloudStorageProviderType,
-        CloudStorageCredentialsType,
-    } = require('./enums');
-
     const User = require('./user');
     const { AnnotationFormats } = require('./annotation-formats');
     const { ArgumentError } = require('./exceptions');
@@ -153,9 +144,9 @@ const config = require('./config');
         cvat.jobs.get.implementation = async (filter) => {
             checkFilter(filter, {
                 page: isInteger,
-                stage: isString,
-                state: isString,
-                assignee: isString,
+                filter: isString,
+                sort: isString,
+                search: isString,
                 taskID: isInteger,
                 jobID: isInteger,
             });
@@ -190,32 +181,22 @@ const config = require('./config');
             checkFilter(filter, {
                 page: isInteger,
                 projectId: isInteger,
-                name: isString,
                 id: isInteger,
-                owner: isString,
-                assignee: isString,
                 search: isString,
+                filter: isString,
                 ordering: isString,
-                status: isEnum.bind(TaskStatus),
-                mode: isEnum.bind(TaskMode),
-                dimension: isEnum.bind(DimensionType),
             });
 
-            checkExclusiveFields(filter, ['id', 'search', 'projectId'], ['page']);
+            checkExclusiveFields(filter, ['id', 'projectId'], ['page']);
 
             const searchParams = {};
             for (const field of [
-                'name',
-                'owner',
-                'assignee',
+                'filter',
                 'search',
                 'ordering',
-                'status',
-                'mode',
                 'id',
                 'page',
                 'projectId',
-                'dimension',
             ]) {
                 if (Object.prototype.hasOwnProperty.call(filter, field)) {
                     searchParams[camelToSnake(field)] = filter[field];
@@ -234,17 +215,14 @@ const config = require('./config');
             checkFilter(filter, {
                 id: isInteger,
                 page: isInteger,
-                name: isString,
-                assignee: isString,
-                owner: isString,
                 search: isString,
-                status: isEnum.bind(TaskStatus),
+                filter: isString,
             });
 
-            checkExclusiveFields(filter, ['id', 'search'], ['page']);
+            checkExclusiveFields(filter, ['id'], ['page']);
 
             const searchParams = {};
-            for (const field of ['name', 'assignee', 'owner', 'search', 'status', 'id', 'page']) {
+            for (const field of ['filter', 'search', 'status', 'id', 'page']) {
                 if (Object.prototype.hasOwnProperty.call(filter, field)) {
                     searchParams[camelToSnake(field)] = filter[field];
                 }
@@ -267,38 +245,25 @@ const config = require('./config');
         cvat.cloudStorages.get.implementation = async (filter) => {
             checkFilter(filter, {
                 page: isInteger,
-                displayName: isString,
-                resourceName: isString,
-                description: isString,
+                filter: isString,
                 id: isInteger,
-                owner: isString,
                 search: isString,
-                providerType: isEnum.bind(CloudStorageProviderType),
-                credentialsType: isEnum.bind(CloudStorageCredentialsType),
             });
 
             checkExclusiveFields(filter, ['id', 'search'], ['page']);
 
             const searchParams = new URLSearchParams();
             for (const field of [
-                'displayName',
-                'credentialsType',
-                'providerType',
-                'owner',
+                'filter',
                 'search',
                 'id',
                 'page',
-                'description',
             ]) {
                 if (Object.prototype.hasOwnProperty.call(filter, field)) {
                     searchParams.set(camelToSnake(field), filter[field]);
                 }
             }
 
-            if (Object.prototype.hasOwnProperty.call(filter, 'resourceName')) {
-                searchParams.set('resource', filter.resourceName);
-            }
-
             const cloudStoragesData = await serverProxy.cloudStorages.get(searchParams.toString());
             const cloudStorages = cloudStoragesData.map((cloudStorage) => new CloudStorage(cloudStorage));
             cloudStorages.count = cloudStoragesData.count;

cvat-core/src/api.js

@@ -1,4 +1,4 @@
-// Copyright (C) 2019-2021 Intel Corporation
+// Copyright (C) 2019-2022 Intel Corporation
 //
 // SPDX-License-Identifier: MIT
 
@@ -773,7 +773,7 @@ function build() {
             /**
              * @typedef {Object} CloudStorageFilter
              * @property {string} displayName Check if displayName contains this value
-             * @property {string} resourceName Check if resourceName contains this value
+             * @property {string} resource Check if resource name contains this value
              * @property {module:API.cvat.enums.ProviderType} providerType Check if providerType equal this value
              * @property {integer} id Check if id equals this value
              * @property {integer} page Get specific page

cvat-core/src/cloud-storage.js

@@ -1,4 +1,4 @@
-// Copyright (C) 2021 Intel Corporation
+// Copyright (C) 2021-2022 Intel Corporation
 //
 // SPDX-License-Identifier: MIT
 
@@ -174,13 +174,13 @@
                     },
                     /**
                      * Unique resource name
-                     * @name resourceName
+                     * @name resource
                      * @type {string}
                      * @memberof module:API.cvat.classes.CloudStorage
                      * @instance
                      * @throws {module:API.cvat.exceptions.ArgumentError}
                      */
-                    resourceName: {
+                    resource: {
                         get: () => data.resource,
                         set: (value) => {
                             validateNotEmptyString(value);
@@ -456,7 +456,7 @@
             display_name: this.displayName,
             credentials_type: this.credentialsType,
             provider_type: this.providerType,
-            resource: this.resourceName,
+            resource: this.resource,
             manifests: this.manifests,
         };
 

cvat-core/src/common.js

@@ -1,4 +1,4 @@
-// Copyright (C) 2019-2021 Intel Corporation
+// Copyright (C) 2019-2022 Intel Corporation
 //
 // SPDX-License-Identifier: MIT
 
@@ -36,7 +36,7 @@
                 if (!(prop in fields)) {
                     throw new ArgumentError(`Unsupported filter property has been received: "${prop}"`);
                 } else if (!fields[prop](filter[prop])) {
-                    throw new ArgumentError(`Received filter property "${prop}" is not satisfied for checker`);
+                    throw new ArgumentError(`Received filter property "${prop}" does not satisfy API`);
                 }
             }
         }

cvat-core/src/organization.js

@@ -1,4 +1,4 @@
-// Copyright (C) 2021 Intel Corporation
+// Copyright (C) 2021-2022 Intel Corporation
 //
 // SPDX-License-Identifier: MIT
 
@@ -360,7 +360,13 @@ Organization.prototype.deleteMembership.implementation = async function (members
 Organization.prototype.leave.implementation = async function (user) {
     checkObjectType('user', user, null, User);
     if (typeof this.id === 'number') {
-        const result = await serverProxy.organizations.members(this.slug, 1, 10, { user: user.id });
+        const result = await serverProxy.organizations.members(this.slug, 1, 10, {
+            filter: JSON.stringify({
+                and: [{
+                    '==': [{ var: 'user' }, user.id],
+                }],
+            }),
+        });
         const [membership] = result.results;
         if (!membership) {
             throw new ServerError(`Could not find membership for user ${user.username} in organization ${this.slug}`);

cvat-core/src/session.js

@@ -1891,7 +1891,7 @@
             return '';
         }
 
-        const frameData = await getPreview(this.taskId, this.jobID);
+        const frameData = await getPreview(this.taskId, this.id);
         return frameData;
     };
 

cvat-core/tests/api/cloud-storages.js

@@ -1,4 +1,4 @@
-// Copyright (C) 2021 Intel Corporation
+// Copyright (C) 2021-2022 Intel Corporation
 //
 // SPDX-License-Identifier: MIT
 
@@ -36,7 +36,7 @@ describe('Feature: get cloud storages', () => {
         expect(cloudStorage.id).toBe(1);
         expect(cloudStorage.providerType).toBe('AWS_S3_BUCKET');
         expect(cloudStorage.credentialsType).toBe('KEY_SECRET_KEY_PAIR');
-        expect(cloudStorage.resourceName).toBe('bucket');
+        expect(cloudStorage.resource).toBe('bucket');
         expect(cloudStorage.displayName).toBe('Demonstration bucket');
         expect(cloudStorage.manifests).toHaveLength(1);
         expect(cloudStorage.manifests[0]).toBe('manifest.jsonl');
@@ -61,41 +61,18 @@ describe('Feature: get cloud storages', () => {
     });
 
     test('get cloud storages by filters', async () => {
-        const filters = [
-            new Map([
-                ['providerType', 'AWS_S3_BUCKET'],
-                ['resourceName', 'bucket'],
-                ['displayName', 'Demonstration bucket'],
-                ['credentialsType', 'KEY_SECRET_KEY_PAIR'],
-                ['description', 'It is first bucket'],
-            ]),
-            new Map([
-                ['providerType', 'AZURE_CONTAINER'],
-                ['resourceName', 'container'],
-                ['displayName', 'Demonstration container'],
-                ['credentialsType', 'ACCOUNT_NAME_TOKEN_PAIR'],
-            ]),
-            new Map([
-                ['providerType', 'GOOGLE_CLOUD_STORAGE'],
-                ['resourceName', 'gcsbucket'],
-                ['displayName', 'Demo GCS'],
-                ['credentialsType', 'KEY_FILE_PATH'],
-            ]),
-        ];
-
-        const ids = [1, 2, 3];
-
-        await Promise.all(filters.map(async (_, idx) => {
-            const result = await window.cvat.cloudStorages.get(Object.fromEntries(filters[idx]));
-            const [cloudStorage] = result;
-            expect(Array.isArray(result)).toBeTruthy();
-            expect(result).toHaveLength(1);
-            expect(cloudStorage).toBeInstanceOf(CloudStorage);
-            expect(cloudStorage.id).toBe(ids[idx]);
-            filters[idx].forEach((value, key) => {
-                expect(cloudStorage[key]).toBe(value);
-            });
-        }));
+        const filter = {
+            and: [
+                { '==': [{ var: 'display_name' }, 'Demonstration bucket'] },
+                { '==': [{ var: 'resource_name' }, 'bucket'] },
+                { '==': [{ var: 'description' }, 'It is first bucket'] },
+                { '==': [{ var: 'provider_type' }, 'AWS_S3_BUCKET'] },
+                { '==': [{ var: 'credentials_type' }, 'KEY_SECRET_KEY_PAIR'] },
+            ],
+        };
+
+        const result = await window.cvat.cloudStorages.get({ filter: JSON.stringify(filter) });
+        expect(result).toBeInstanceOf(Array);
     });
 
     test('get cloud storage by invalid filters', async () => {

cvat-core/tests/api/projects.js

@@ -1,4 +1,4 @@
-// Copyright (C) 2019-2021 Intel Corporation
+// Copyright (C) 2019-2022 Intel Corporation
 //
 // SPDX-License-Identifier: MIT
 
@@ -54,16 +54,12 @@ describe('Feature: get projects', () => {
 
     test('get projects by filters', async () => {
         const result = await window.cvat.projects.get({
-            status: 'completed',
+            filter: '{"and":[{"==":[{"var":"status"},"completed"]}]}',
         });
-        expect(Array.isArray(result)).toBeTruthy();
-        expect(result).toHaveLength(1);
-        expect(result[0]).toBeInstanceOf(Project);
-        expect(result[0].id).toBe(2);
-        expect(result[0].status).toBe('completed');
+        expect(result).toBeInstanceOf(Array);
     });
 
-    test('get projects by invalid filters', async () => {
+    test('get projects by invalid query', async () => {
         expect(
             window.cvat.projects.get({
                 unknown: '5',