Store import<->document relationship (#4415)

* Store import<->document relationship

* Update 20221112152649-import-document-relationship.js

* Store importId on collection, UI tweaks on import screen

server/commands/documentCreator.ts

@@ -9,6 +9,7 @@ export default async function documentCreator({
   collectionId,
   parentDocumentId,
   templateDocument,
+  importId,
   createdAt,
   // allows override for import
   updatedAt,
@@ -26,6 +27,7 @@ export default async function documentCreator({
   publish?: boolean;
   collectionId: string;
   parentDocumentId?: string;
+  importId?: string;
   templateDocument?: Document | null;
   publishedAt?: Date;
   template?: boolean;
@@ -54,6 +56,7 @@ export default async function documentCreator({
       template,
       templateId,
       publishedAt,
+      importId,
       title: templateDocument ? templateDocument.title : title,
       text: templateDocument ? templateDocument.text : text,
     },

server/migrations/20221112152649-import-document-relationship.js

@@ -0,0 +1,48 @@
+"use strict";
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.sequelize.transaction(async (transaction) => {
+      await queryInterface.addColumn("documents", "importId", {
+        type: Sequelize.UUID,
+        allowNull: true,
+        references: {
+          model: "file_operations",
+        },
+        transaction,
+      });
+      await queryInterface.addColumn("collections", "importId", {
+        type: Sequelize.UUID,
+        allowNull: true,
+        references: {
+          model: "file_operations",
+        },
+        transaction,
+      });
+      await queryInterface.addIndex("documents", ["importId"], {
+        transaction
+      });
+      await queryInterface.addIndex("collections", ["importId"], {
+        transaction
+      });
+    });
+
+  },
+
+  async down(queryInterface) {
+    await queryInterface.sequelize.transaction(async (transaction) => {
+      await queryInterface.removeIndex("collections", ["importId"], {
+        transaction
+      });
+      await queryInterface.removeIndex("documents", ["importId"], {
+        transaction
+      });
+      await queryInterface.removeColumn("collections", "importId", {
+        transaction
+      });
+      await queryInterface.removeColumn("documents", "importId", {
+        transaction
+      });
+    });
+  }
+};

server/models/Collection.ts

@@ -30,6 +30,7 @@ import type { NavigationNode, CollectionSort } from "~/types";
 import CollectionGroup from "./CollectionGroup";
 import CollectionUser from "./CollectionUser";
 import Document from "./Document";
+import FileOperation from "./FileOperation";
 import Group from "./Group";
 import GroupUser from "./GroupUser";
 import Team from "./Team";
@@ -272,6 +273,13 @@ class Collection extends ParanoidModel {
 
   // associations
 
+  @BelongsTo(() => FileOperation, "importId")
+  import: FileOperation | null;
+
+  @ForeignKey(() => FileOperation)
+  @Column(DataType.UUID)
+  importId: string | null;
+
   @HasMany(() => Document, "collectionId")
   documents: Document[];
 

server/models/Document.ts

@@ -39,6 +39,7 @@ import { DocumentValidation } from "@shared/validations";
 import slugify from "@server/utils/slugify";
 import Backlink from "./Backlink";
 import Collection from "./Collection";
+import FileOperation from "./FileOperation";
 import Revision from "./Revision";
 import Star from "./Star";
 import Team from "./Team";
@@ -342,6 +343,13 @@ class Document extends ParanoidModel {
 
   // associations
 
+  @BelongsTo(() => FileOperation, "importId")
+  import: FileOperation | null;
+
+  @ForeignKey(() => FileOperation)
+  @Column(DataType.UUID)
+  importId: string | null;
+
   @BelongsTo(() => Document, "parentDocumentId")
   parentDocument: Document | null;
 

server/presenters/fileOperation.ts

@@ -6,6 +6,7 @@ export default function present(data: FileOperation) {
   return {
     id: data.id,
     type: data.type,
+    format: data.format,
     name: data.collection?.name || path.basename(data.key || ""),
     state: data.state,
     error: data.error,

server/queues/tasks/ImportTask.ts

@@ -274,6 +274,7 @@ export default abstract class ImportTask extends BaseTask<Props> {
               }),
               createdById: fileOperation.userId,
               permission: CollectionPermission.ReadWrite,
+              importId: fileOperation.id,
             },
             transaction,
           });
@@ -294,6 +295,7 @@ export default abstract class ImportTask extends BaseTask<Props> {
                 createdById: fileOperation.userId,
                 name,
                 permission: CollectionPermission.ReadWrite,
+                importId: fileOperation.id,
               },
               { transaction }
             );
@@ -357,6 +359,7 @@ export default abstract class ImportTask extends BaseTask<Props> {
             updatedAt: item.updatedAt ?? item.createdAt,
             publishedAt: item.updatedAt ?? item.createdAt ?? new Date(),
             parentDocumentId: item.parentDocumentId,
+            importId: fileOperation.id,
             user,
             ip,
             transaction,

server/routes/api/fileOperations.ts

@@ -51,13 +51,13 @@ router.post(
     authorize(user, "manage", team);
 
     const [exports, total] = await Promise.all([
-      await FileOperation.findAll({
+      FileOperation.findAll({
         where,
         order: [[sort, direction]],
         offset: ctx.state.pagination.offset,
         limit: ctx.state.pagination.limit,
       }),
-      await FileOperation.count({
+      FileOperation.count({
         where,
       }),
     ]);