Fixed comments

cvat-ai · nmanovic · Aug 6, 2021 · Jun 22, 2021 · Jun 23, 2021 · Jun 24, 2021
commit dc45b9f73b3a25b4366017252b0814b31080e6d3
@@ -10,7 +10,7 @@
     const { checkObjectType } = require('./common');
     const { Project } = require('./project');
     const { Task, Job } = require('./session');
-    const { Loader, Dumper } = require('./annotation-formats');
+    const { Loader } = require('./annotation-formats');
     const { ScriptingError, DataError, ArgumentError } = require('./exceptions');
 
     const jobCache = new WeakMap();
@@ -234,22 +234,6 @@
         await serverProxy.annotations.uploadAnnotations(sessionType, session.id, file, loader.name);
     }
 
-    async function dumpAnnotations(session, name, dumper) {
-        if (!(dumper instanceof Dumper)) {
-            throw new ArgumentError('A dumper must be instance of Dumper class');
-        }
-
-        let result = null;
-        const sessionType = session instanceof Task ? 'task' : 'job';
-        if (sessionType === 'job') {
-            result = await serverProxy.annotations.dumpAnnotations(session.task.id, name, dumper.name);
-        } else {
-            result = await serverProxy.annotations.dumpAnnotations(session.id, name, dumper.name);
-        }
-
-        return result;
-    }
-
     function importAnnotations(session, data) {
         const sessionType = session instanceof Task ? 'task' : 'job';
         const cache = getCache(sessionType);
@@ -282,7 +266,7 @@
             throw new ArgumentError('Format must be a string');
         }
         if (!(instance instanceof Task || instance instanceof Project || instance instanceof Job)) {
-            throw new ArgumentError('A dataset can only be created from a task or project');
+            throw new ArgumentError('A dataset can only be created from a job, task or project');
         }
         if (typeof saveImages !== 'boolean') {
             throw new ArgumentError('Save images parameter must be a boolean');
@@ -379,7 +363,6 @@
         annotationsStatistics,
         selectObject,
         uploadAnnotations,
-        dumpAnnotations,
         importAnnotations,
         exportAnnotations,
         exportDataset,

@@ -18,7 +18,7 @@ function build() {
     const Review = require('./review');
     const { Job, Task } = require('./session');
     const { Project } = require('./project');
-    require('./project-implementation');
+    const implementProject = require('./project-implementation');
     const { Attribute, Label } = require('./labels');
     const MLModel = require('./ml-model');
 
@@ -754,7 +754,7 @@ function build() {
          */
         classes: {
             User,
-            Project,
+            Project: implementProject(Project),
             Task,
             Job,
             Log,

@@ -1,7 +1,3 @@
-// Copyright (C) 2021 Intel Corporation
-//
-// SPDX-License-Identifier: MIT
-
 // Copyright (C) 2019-2021 Intel Corporation
 //
 // SPDX-License-Identifier: MIT
@@ -13,58 +9,66 @@
     const { Project } = require('./project');
     const { exportDataset } = require('./annotations');
 
-    Project.prototype.save.implementation = async function () {
-        const trainingProjectCopy = this.trainingProject;
-        if (typeof this.id !== 'undefined') {
-            // project has been already created, need to update some data
-            const projectData = {
+    function implementProject(projectClass) {
+        projectClass.prototype.save.implementation = async function () {
+            const trainingProjectCopy = this.trainingProject;
+            if (typeof this.id !== 'undefined') {
+                // project has been already created, need to update some data
+                const projectData = {
+                    name: this.name,
+                    assignee_id: this.assignee ? this.assignee.id : null,
+                    bug_tracker: this.bugTracker,
+                    labels: [...this._internalData.labels.map((el) => el.toJSON())],
+                };
+
+                if (trainingProjectCopy) {
+                    projectData.training_project = trainingProjectCopy;
+                }
+
+                await serverProxy.projects.save(this.id, projectData);
+                return this;
+            }
+
+            // initial creating
+            const projectSpec = {
                 name: this.name,
-                assignee_id: this.assignee ? this.assignee.id : null,
-                bug_tracker: this.bugTracker,
-                labels: [...this._internalData.labels.map((el) => el.toJSON())],
+                labels: [...this.labels.map((el) => el.toJSON())],
             };
 
-            if (trainingProjectCopy) {
-                projectData.training_project = trainingProjectCopy;
+            if (this.bugTracker) {
+                projectSpec.bug_tracker = this.bugTracker;
             }
 
-            await serverProxy.projects.save(this.id, projectData);
-            return this;
-        }
+            if (trainingProjectCopy) {
+                projectSpec.training_project = trainingProjectCopy;
+            }
 
-        // initial creating
-        const projectSpec = {
-            name: this.name,
-            labels: [...this.labels.map((el) => el.toJSON())],
+            const project = await serverProxy.projects.create(projectSpec);
+            return new Project(project);
         };
 
-        if (this.bugTracker) {
-            projectSpec.bug_tracker = this.bugTracker;
-        }
-
-        if (trainingProjectCopy) {
-            projectSpec.training_project = trainingProjectCopy;
-        }
+        projectClass.prototype.delete.implementation = async function () {
+            const result = await serverProxy.projects.delete(this.id);
+            return result;
+        };
 
-        const project = await serverProxy.projects.create(projectSpec);
-        return new Project(project);
-    };
+        projectClass.prototype.preview.implementation = async function () {
+            if (!this._internalData.task_ids.length) {
+                return '';
+            }
+            const frameData = await getPreview(this._internalData.task_ids[0]);
+            return frameData;
+        };
 
-    Project.prototype.delete.implementation = async function () {
-        const result = await serverProxy.projects.delete(this.id);
-        return result;
-    };
+        projectClass.prototype.annotations.exportDataset.implementation = async function (
+            format, saveImages, customName,
+        ) {
+            const result = exportDataset(this, format, customName, saveImages);
+            return result;
+        };
 
-    Project.prototype.preview.implementation = async function () {
-        if (!this._internalData.task_ids.length) {
-            return '';
-        }
-        const frameData = await getPreview(this._internalData.task_ids[0]);
-        return frameData;
-    };
+        return projectClass;
+    }
 
-    Project.prototype.annotations.exportDataset.implementation = async function (format, saveImages, customName) {
-        const result = exportDataset(this, format, customName, saveImages);
-        return result;
-    };
+    module.exports = implementProject;
 })();
@@ -201,7 +201,7 @@
                         },
                     },
                     /**
-                     * Tasks linked with the project
+                     * Tasks related with the project
                      * @name tasks
                      * @type {module:API.cvat.classes.Task[]}
                      * @memberof module:API.cvat.classes.Project
@@ -212,7 +212,7 @@
                         get: () => [...data.tasks],
                     },
                     /**
-                     * Subsets array for linked tasks
+                     * Subsets array for related tasks
                      * @name subsets
                      * @type {string[]}
                      * @memberof module:API.cvat.classes.Project
@@ -253,8 +253,8 @@
                 }),
             );
 
-            // When we call a function, for example: task.annotations.get()
-            // In the method get we lose the task context
+            // When we call a function, for example: project.annotations.get()
+            // In the method get we lose the project context
             // So, we need return it
             this.annotations = {
                 exportDataset: Object.getPrototypeOf(this).annotations.exportDataset.bind(this),
@@ -294,7 +294,7 @@
         }
 
         /**
-         * Method deletes a task from a server
+         * Method deletes a project from a server
          * @method delete
          * @memberof module:API.cvat.classes.Project
          * @readonly

@@ -1145,8 +1145,9 @@
 
                     const closureId = Date.now();
                     predictAnnotations.latestRequest.id = closureId;
-                    // eslint-disable-next-line max-len
-                    const predicate = () => !predictAnnotations.latestRequest.fetching || predictAnnotations.latestRequest.id !== closureId;
+                    const predicate = () => (
+                        !predictAnnotations.latestRequest.fetching || predictAnnotations.latestRequest.id !== closureId
+                    );
                     if (predictAnnotations.latestRequest.fetching) {
                         waitFor(5, predicate).then(() => {
                             if (predictAnnotations.latestRequest.id !== closureId) {

@@ -42,16 +42,6 @@
                         return result;
                     },
 
-                    async dump(dumper, name = null) {
-                        const result = await PluginRegistry.apiWrapper.call(
-                            this,
-                            prototype.annotations.dump,
-                            dumper,
-                            name,
-                        );
-                        return result;
-                    },
-
                     async statistics() {
                         const result = await PluginRegistry.apiWrapper.call(this, prototype.annotations.statistics);
                         return result;
@@ -331,21 +321,6 @@
              * @instance
              * @async
              */
-            /**
-             * Dump of annotations to a file.
-             * Method always dumps annotations for a whole task.
-             * @method dump
-             * @memberof Session.annotations
-             * @param {module:API.cvat.classes.Dumper} dumper - a dumper
-             * @param {string} [name = null] - a name of a file with annotations
-             * which will be used to dump
-             * @returns {string} URL which can be used in order to get a dump file
-             * @throws {module:API.cvat.exceptions.PluginError}
-             * @throws {module:API.cvat.exceptions.ServerError}
-             * @throws {module:API.cvat.exceptions.ArgumentError}
-             * @instance
-             * @async
-             */
             /**
              * Collect short statistics about a task or a job.
              * @method statistics
@@ -879,7 +854,6 @@
                 get: Object.getPrototypeOf(this).annotations.get.bind(this),
                 put: Object.getPrototypeOf(this).annotations.put.bind(this),
                 save: Object.getPrototypeOf(this).annotations.save.bind(this),
-                dump: Object.getPrototypeOf(this).annotations.dump.bind(this),
                 merge: Object.getPrototypeOf(this).annotations.merge.bind(this),
                 split: Object.getPrototypeOf(this).annotations.split.bind(this),
                 group: Object.getPrototypeOf(this).annotations.group.bind(this),
@@ -1577,7 +1551,6 @@
                 get: Object.getPrototypeOf(this).annotations.get.bind(this),
                 put: Object.getPrototypeOf(this).annotations.put.bind(this),
                 save: Object.getPrototypeOf(this).annotations.save.bind(this),
-                dump: Object.getPrototypeOf(this).annotations.dump.bind(this),
                 merge: Object.getPrototypeOf(this).annotations.merge.bind(this),
                 split: Object.getPrototypeOf(this).annotations.split.bind(this),
                 group: Object.getPrototypeOf(this).annotations.group.bind(this),
@@ -1717,7 +1690,6 @@
         selectObject,
         annotationsStatistics,
         uploadAnnotations,
-        dumpAnnotations,
         importAnnotations,
         exportAnnotations,
         exportDataset,
@@ -1950,11 +1922,6 @@
         return result;
     };
 
-    Job.prototype.annotations.dump.implementation = async function (dumper, name) {
-        const result = await dumpAnnotations(this, name, dumper);
-        return result;
-    };
-
     Job.prototype.annotations.exportDataset.implementation = async function (format, saveImages, customName) {
         const result = await exportDataset(this.task, format, customName, saveImages);
         return result;
@@ -2254,11 +2221,6 @@
         return result;
     };
 
-    Task.prototype.annotations.dump.implementation = async function (dumper, name) {
-        const result = await dumpAnnotations(this, name, dumper);
-        return result;
-    };
-
     Task.prototype.annotations.import.implementation = function (data) {
         const result = importAnnotations(this, data);
         return result;

@@ -15,15 +15,14 @@ export enum ExportActionTypes {
 export const exportActions = {
     openExportModal: (instance: any) => createAction(ExportActionTypes.OPEN_EXPORT_MODAL, { instance }),
     closeExportModal: () => createAction(ExportActionTypes.CLOSE_EXPORT_MODAL),
-    exportDataset: (instance: any, format: any, saveImages: boolean) =>
-        createAction(ExportActionTypes.EXPORT_DATASET, { instance, format, saveImages }),
-    exportDatasetSuccess: (instance: any, format: any, saveImages: boolean) =>
-        createAction(ExportActionTypes.EXPORT_DATASET_SUCCESS, { instance, format, saveImages }),
-    exportDatasetFailed: (instance: any, format: any, saveImages: boolean, error: any) =>
+    exportDataset: (instance: any, format: string) =>
+        createAction(ExportActionTypes.EXPORT_DATASET, { instance, format }),
+    exportDatasetSuccess: (instance: any, format: string) =>
+        createAction(ExportActionTypes.EXPORT_DATASET_SUCCESS, { instance, format }),
+    exportDatasetFailed: (instance: any, format: string, error: any) =>
         createAction(ExportActionTypes.EXPORT_DATASET_FAILED, {
             instance,
             format,
-            saveImages,
             error,
         }),
 };
@@ -34,16 +33,16 @@ export const exportDatasetAsync = (
     name: string,
     saveImages: boolean,
 ): ThunkAction => async (dispatch) => {
-    dispatch(exportActions.exportDataset(instance, format, saveImages));
+    dispatch(exportActions.exportDataset(instance, format));
 
     try {
         const url = await instance.annotations.exportDataset(format, saveImages, name);
         const downloadAnchor = window.document.getElementById('downloadAnchor') as HTMLAnchorElement;
         downloadAnchor.href = url;
         downloadAnchor.click();
-        dispatch(exportActions.exportDatasetSuccess(instance, format, saveImages));
+        dispatch(exportActions.exportDatasetSuccess(instance, format));
     } catch (error) {
-        dispatch(exportActions.exportDatasetFailed(instance, format, saveImages, error));
+        dispatch(exportActions.exportDatasetFailed(instance, format, error));
     }
 };
 

@@ -19,8 +19,6 @@ interface Props {
     loaders: any[];
     dumpers: any[];
     loadActivity: string | null;
-    dumpActivities: string[] | null;
-    exportActivities: string[] | null;
     inferenceIsActive: boolean;
     taskDimension: DimensionType;
     onClickMenu: (params: MenuInfo, file?: File) => void;
@@ -108,14 +106,14 @@ export default function ActionsMenuComponent(props: Props): JSX.Element {
                 menuKey: Actions.LOAD_TASK_ANNO,
                 taskDimension,
             })}
-            <Menu.Item key={Actions.EXPORT_TASK_DATASET}>Export Task dataset</Menu.Item>
+            <Menu.Item key={Actions.EXPORT_TASK_DATASET}>Export task dataset</Menu.Item>
             {!!bugTracker && <Menu.Item key={Actions.OPEN_BUG_TRACKER}>Open bug tracker</Menu.Item>}
             <Menu.Item disabled={inferenceIsActive} key={Actions.RUN_AUTO_ANNOTATION}>
                 Automatic annotation
             </Menu.Item>
             <Menu.Item key={Actions.EXPORT_TASK} disabled={exportIsActive}>
                 {exportIsActive && <LoadingOutlined id='cvat-export-task-loading' />}
-                Export Task
+                Export task
             </Menu.Item>
             <hr />
             <Menu.Item key={Actions.MOVE_TASK_TO_PROJECT}>Move to project</Menu.Item>