Feature: graphql server (#3)

* add promise / eager to relationships

* add graphql support

Author: oott123

package-lock.json

@@ -28,10 +28,14 @@
     "typescript": "^2.6.2"
   },
   "dependencies": {
+    "@omega-bbs/spec": "0.0.6",
     "cookie-session": "^1.3.2",
     "debug": "^3.1.0",
     "es6-shim": "^0.35.3",
     "express": "^4.16.2",
+    "express-graphql": "^0.6.11",
+    "glob": "^7.1.2",
+    "graphql": "^0.11.7",
     "jsonwebtoken": "^8.1.0",
     "lodash": "^4.17.4",
     "morgan": "^1.9.0",

package.json

@@ -28,5 +28,5 @@ export class Board {
   // relationships
   /** topics of the board */
   @OneToMany(type => Topic, topic => topic.board)
-  public topics: Topic[]
+  public topics: Promise<Topic[]>
 }

src/entities/Board.ts

@@ -27,9 +27,9 @@ export class Comment {
 
   // relationships
   @ManyToOne(type => User, user => user.comments)
-  public author: User
+  public author: Promise<User>
 
   /** post of the comment belongs to */
   @ManyToOne(type => Post, post => post.comments)
-  public post: Post
+  public post: Promise<Post>
 }

src/entities/Comment.ts

@@ -42,16 +42,16 @@ export class File {
 
   // relationships
   @ManyToOne(type => User, user => user.files)
-  public author: User
+  public author: Promise<User>
 
   /** get the user if this file using(used) as avatar */
   @ManyToOne(type => User, user => user.avatarFiles)
-  public usedInUser: User
+  public usedInUser: Promise<User>
 
   /** get the post if this file using in a post */
   @ManyToOne(type => Post, post => post.files)
   @Index() // post.files
-  public usedInPost: Post
+  public usedInPost: Promise<Post>
 
   // calculated fields
   /** get the public accessed url of the file (use the storageDriver and path) */

src/entities/File.ts

@@ -20,5 +20,5 @@ export class Permission {
 
   // relationships
   @ManyToMany(type => Role, role => role.permissions)
-  public roles: Role
+  public roles: Promise<Role>
 }

src/entities/Permission.ts

@@ -42,25 +42,25 @@ export class Post {
   // relationships
   @ManyToOne(type => User, user => user.posts)
   @Index() // user.posts
-  public author: User
+  public author: Promise<User>
 
   @ManyToOne(type => Topic, topic => topic.posts)
   @Index() // topic.posts
-  public topic: Topic
+  public topic: Promise<Topic>
 
   @OneToMany(type => Comment, comment => comment.post)
-  public comments: Comment[]
+  public comments: Promise<Comment[]>
 
   /** files used in this post */
   @OneToMany(type => File, file => file.author)
-  public files: File[]
+  public files: Promise<File[]>
 
   /** posts which referenced to this post */
   @ManyToMany(type => Post, post => post.postsReferencedBy)
   @JoinTable()
-  public postsReferenced: Post[]
+  public postsReferenced: Promise<Post[]>
 
   /** posts which referenced by this post */
   @ManyToMany(type => Post, post => post.postsReferenced)
-  public postsReferencedBy: Post[]
+  public postsReferencedBy: Promise<Post[]>
 }

src/entities/Post.ts

@@ -18,9 +18,11 @@ export class Role {
 
   // relationships
   @ManyToOne(type => User, user => user.role)
-  public users: User[]
+  public users: Promise<User[]>
 
-  @ManyToMany(type => Permission, permission => permission.roles)
+  @ManyToMany(type => Permission, permission => permission.roles, {
+    eager: true
+  })
   @JoinTable()
   public permissions: Permission[]
 }

src/entities/Role.ts

@@ -2,8 +2,10 @@ import {
   Column,
   Entity,
   Index,
+  JoinColumn,
   ManyToOne,
   OneToMany,
+  OneToOne,
   PrimaryGeneratedColumn
 } from 'typeorm'
 import { Board } from './Board'
@@ -23,10 +25,14 @@ export class Topic {
   @Column() public deletedAt: Date
 
   // relationships
+  @OneToOne(type => Post, { eager: true })
+  @JoinColumn()
+  public rootPost: Post
+
   @ManyToOne(type => Board, board => board.topics)
   @Index() // board.topics
-  public board: Board
+  public board: Promise<Board>
 
   @OneToMany(type => Post, post => post.topic)
-  public posts: Post[]
+  public posts: Promise<Post[]>
 }

src/entities/Topic.ts

@@ -40,27 +40,27 @@ export class User {
 
   // relationships
   @OneToMany(type => File, file => file.usedInUser)
-  public avatarFiles: File[]
+  public avatarFiles: Promise<File[]>
 
   @OneToMany(type => File, file => file.author)
-  public files: File[]
+  public files: Promise<File[]>
 
   @OneToMany(type => Post, post => post.author)
-  public posts: Post[]
+  public posts: Promise<Post[]>
 
   @OneToMany(type => Comment, comment => comment.author)
-  public comments: Comment[]
+  public comments: Promise<Comment[]>
 
   @OneToOne(type => File)
   @JoinColumn()
-  public currentAvatarFile: File
+  public currentAvatarFile: Promise<File>
 
   @ManyToOne(type => Role, role => role.users)
-  public role: Role
+  public role: Promise<Role>
 
   // calculated fileds
   /** get user's current avatar public url */
-  public getAvatarUrl(): string {
+  public async getAvatarUrl(): Promise<string> {
     const methods = {
       [UserAvatarType.file]: this.getAvatarUrlFile,
       [UserAvatarType.gravatar]: this.getAvatarUrlGravatar,
@@ -69,15 +69,15 @@ export class User {
     return methods[this.avatarType].call(this)
   }
 
-  private getAvatarUrlGravatar(): string {
-    return 'https://gravatar.com'
+  private getAvatarUrlGravatar(): Promise<string> {
+    return Promise.resolve('https://gravatar.com')
   }
 
-  private getAvatarUrlFile(): string {
-    return this.currentAvatarFile.getUrl()
+  private async getAvatarUrlFile(): Promise<string> {
+    return (await this.currentAvatarFile).getUrl()
   }
 
-  private getAvatarUrlUnset(): string {
+  private async getAvatarUrlUnset(): Promise<string> {
     return 'about:blank'
   }
 }