Merge pull request #2886 from SeedCompany/file-hydrate-root-attachment

Author: CarsonF

src/components/file/dto/node.ts

@@ -4,6 +4,7 @@ import { DateTime } from 'luxon';
 import { Readable } from 'stream';
 import { keys as keysOf } from 'ts-transformer-keys';
 import { MergeExclusive, Opaque } from 'type-fest';
+import { BaseNode } from '~/core/database/results';
 import { RegisterResource } from '~/core/resources';
 import {
   DateTimeField,
@@ -69,6 +70,12 @@ abstract class FileNode extends Resource {
   readonly public: boolean;
 
   readonly createdById: ID;
+
+  /** The root FileNode. This could be self */
+  readonly root: BaseNode;
+
+  /** The resource the root FileNode is attached to */
+  readonly rootAttachedTo: [resource: BaseNode, relationName: string];
 }
 
 // class name has to match schema name for interface resolvers to work.

src/components/file/events/after-file-upload.event.ts

@@ -0,0 +1,9 @@
+import { File } from '../dto';
+
+/**
+ * Emitted as the last step of the file upload process.
+ * Feel free to throw to abort mutation.
+ */
+export class AfterFileUploadEvent {
+  constructor(readonly file: File) {}
+}

src/components/file/file.repository.ts

@@ -11,7 +11,7 @@ import {
 } from 'cypher-query-builder';
 import { Direction } from 'cypher-query-builder/dist/typings/clauses/order-by';
 import { AnyConditions } from 'cypher-query-builder/dist/typings/clauses/where-utils';
-import { isEmpty } from 'lodash';
+import { isEmpty, keyBy } from 'lodash';
 import { DateTime } from 'luxon';
 import {
   ID,
@@ -26,6 +26,7 @@ import {
   ILogger,
   Logger,
   OnIndex,
+  ResourceRef,
 } from '../../core';
 import {
   ACTIVE,
@@ -174,7 +175,27 @@ export class FileRepository extends CommonRepository {
             .where({ node: hasLabel(FileNodeType.Directory) })
             .apply(this.hydrateDirectory()),
         )
-        .return<{ dto: FileNode }>('dto');
+        .subQuery('node', (sub) =>
+          sub
+            .raw('MATCH p=(node)-[:parent*0..]->(root:FileNode)')
+            .return('root')
+            .orderBy('length(p)', 'DESC')
+            .raw('LIMIT 1'),
+        )
+        .subQuery('root', (sub) =>
+          sub
+            .raw('MATCH (resource:BaseNode)-[rel]->(root)')
+            // Need to filter out FileNodes which are children of this dir
+            // (the schema was mistakenly pointing these relationships in the wrong direction)
+            // Also filter to ACTIVE, if applicable.
+            .raw(
+              'WHERE NOT resource:FileNode AND coalesce(rel.active, true) <> false',
+            )
+            .return('[resource, type(rel)] as rootAttachedTo'),
+        )
+        .return<{ dto: FileNode }>(
+          merge('dto', keyBy(['root', 'rootAttachedTo'])).as('dto'),
+        );
   }
 
   private hydrateFile() {
@@ -386,6 +407,42 @@ export class FileRepository extends CommonRepository {
     return result.id;
   }
 
+  async createRootDirectory({
+    resource,
+    relation,
+    name,
+    public: isPublic,
+    session,
+  }: {
+    resource: ResourceRef<any>;
+    relation: string;
+    name: string;
+    public?: boolean;
+    session: Session;
+  }) {
+    const initialProps = {
+      name,
+      public: isPublic,
+    };
+
+    const query = this.db
+      .query()
+      .apply(await createNode(Directory, { initialProps }))
+      .apply(
+        createRelationships(Directory, {
+          in: { [relation]: ['BaseNode', resource.id] },
+          out: { createdBy: ['User', session.userId] },
+        }),
+      )
+      .return<{ id: ID }>('node.id as id');
+
+    const result = await query.first();
+    if (!result) {
+      throw new ServerException('Failed to create directory');
+    }
+    return result.id;
+  }
+
   async createFile({
     fileId,
     name,

src/components/file/file.service.ts

@@ -8,7 +8,6 @@ import { Connection } from 'cypher-query-builder';
 import { intersection } from 'lodash';
 import { Duration } from 'luxon';
 import { Readable } from 'stream';
-import { withAddedPath } from '~/common/url.util';
 import {
   DuplicateException,
   DurationIn,
@@ -19,8 +18,9 @@ import {
   ServerException,
   Session,
   UnauthorizedException,
-} from '../../common';
-import { ConfigService, ILogger, Logger } from '../../core';
+} from '~/common';
+import { withAddedPath } from '~/common/url.util';
+import { ConfigService, IEventBus, ILogger, Logger } from '~/core';
 import { FileBucket } from './bucket';
 import {
   CreateDefinedFileVersionInput,
@@ -41,6 +41,7 @@ import {
   RenameFileInput,
   RequestUploadOutput,
 } from './dto';
+import { AfterFileUploadEvent } from './events/after-file-upload.event';
 import { FileUrlController as FileUrl } from './file-url.controller';
 import { FileRepository } from './file.repository';
 import { MediaService } from './media/media.service';
@@ -53,6 +54,7 @@ export class FileService {
     private readonly db: Connection,
     private readonly config: ConfigService,
     private readonly mediaService: MediaService,
+    private readonly eventBus: IEventBus,
     @Logger('file:service') private readonly logger: ILogger,
   ) {}
 
@@ -225,6 +227,12 @@ export class FileService {
     return await this.getDirectory(id, session);
   }
 
+  async createRootDirectory(
+    ...args: Parameters<FileRepository['createRootDirectory']>
+  ) {
+    return await this.repo.createRootDirectory(...args);
+  }
+
   async requestUpload(): Promise<RequestUploadOutput> {
     const id = await generateId();
     const url = await this.bucket.getSignedUrl(PutObject, {
@@ -361,7 +369,11 @@ export class FileService {
     // Change the file's name to match the latest version name
     await this.rename({ id: fileId, name }, session);
 
-    return await this.getFile(fileId, session);
+    const file = await this.getFile(fileId, session);
+
+    await this.eventBus.publish(new AfterFileUploadEvent(file));
+
+    return file;
   }
 
   private async validateParentNode(

src/components/file/handlers/attach-project-root-directory.handler.ts

@@ -1,6 +1,4 @@
-import { node, relation } from 'cypher-query-builder';
-import { DateTime } from 'luxon';
-import { DatabaseService, EventsHandler, IEventHandler } from '../../../core';
+import { DatabaseService, EventsHandler, IEventHandler } from '~/core';
 import { ProjectCreatedEvent } from '../../project/events';
 import { FileService } from '../file.service';
 
@@ -15,32 +13,17 @@ export class AttachProjectRootDirectoryHandler
 
   async handle(event: ProjectCreatedEvent) {
     const { project, session } = event;
-    const { id } = project;
 
-    const rootDir = await this.files.createDirectory(
-      undefined,
-      `${id} root directory`,
+    const rootDirId = await this.files.createRootDirectory({
+      resource: project,
+      relation: 'rootDirectory',
+      name: `${project.id} root directory`,
       session,
-    );
+    });
 
-    await this.db
-      .query()
-      .match([
-        [node('project', 'Project', { id })],
-        [node('dir', 'Directory', { id: rootDir.id })],
-      ])
-      .create([
-        node('project'),
-        relation('out', '', 'rootDirectory', {
-          active: true,
-          createdAt: DateTime.local(),
-        }),
-        node('dir'),
-      ])
-      .run();
     event.project = {
       ...event.project,
-      rootDirectory: rootDir.id,
+      rootDirectory: rootDirId,
     };
 
     const folders = [
@@ -50,7 +33,7 @@ export class AttachProjectRootDirectoryHandler
       'Photos',
     ];
     for (const folder of folders) {
-      await this.files.createDirectory(rootDir.id, folder, session);
+      await this.files.createDirectory(rootDirId, folder, session);
     }
   }
 }

test/utility/create-directory.ts

@@ -14,14 +14,14 @@ export async function createRootDirectory(app: TestApp, name?: string) {
     .get(AuthenticationService)
     .resumeSession(app.graphql.authToken);
   const session = loggedInSession(rawSession);
-  const actual = await app
-    .get(FileService)
-    .createDirectory(undefined, name, session);
-
-  expect(actual).toBeTruthy();
-  expect(actual.name).toBe(name);
-
-  return actual;
+  const id = await app.get(FileService).createRootDirectory({
+    // An attachment point is required, so just use the current user.
+    resource: { __typename: 'User', id: session.userId },
+    relation: 'dir',
+    name,
+    session,
+  });
+  return await app.get(FileService).getDirectory(id, session);
 }
 
 export async function createDirectory(