feat: removes queue logic from post record and splits it out into pos…

…t-queue (#322)

* feat: post queue separated from post record ledger

* feat: place most post record logic into post queue

* test: adds tests for post queue

* test: some fixes, improvements, and tests for post queue

apps/client-server/src/app/database/entities/directory-watcher.entity.ts

@@ -10,6 +10,7 @@ import {
   DirectoryWatcherDto,
   DirectoryWatcherImportAction,
   IDirectoryWatcher,
+  ISubmission,
 } from '@postybirb/types';
 import { PostyBirbRepository } from '../repositories/postybirb-repository';
 import { PostyBirbEntity } from './postybirb-entity';
@@ -36,13 +37,13 @@ export class DirectoryWatcher
     serializer: (s) => s?.id,
     cascade: [],
   })
-  template?: Rel<Submission>;
+  template?: Rel<ISubmission>;
 
   constructor(directoryWatcher: IDirectoryWatcher) {
     super();
     this.path = directoryWatcher.path;
     this.importAction = directoryWatcher.importAction;
-    this.template = directoryWatcher.template as Submission;
+    this.template = directoryWatcher.template;
   }
 
   toJSON(): DirectoryWatcherDto {

apps/client-server/src/app/database/entities/index.ts

@@ -1,5 +1,6 @@
 export * from './account.entity';
 export * from './directory-watcher.entity';
+export * from './post-queue-record.entity';
 export * from './post-record.entity';
 export * from './settings.entity';
 export * from './submission-file.entity';
@@ -10,3 +11,4 @@ export * from './user-specified-website-options.entity';
 export * from './website-data.entity';
 export * from './website-options.entity';
 export * from './website-post-record.entity';
+

apps/client-server/src/app/database/entities/post-queue-record.entity.ts

@@ -0,0 +1,39 @@
+import { Entity, OneToOne, Rel, serialize } from '@mikro-orm/core';
+import {
+  IPostQueueRecord,
+  IPostRecord,
+  ISubmission,
+  PostQueueRecordDto,
+} from '@postybirb/types';
+import { PostRecord } from './post-record.entity';
+import { PostyBirbEntity } from './postybirb-entity';
+import { Submission } from './submission.entity';
+
+@Entity()
+export class PostQueueRecord
+  extends PostyBirbEntity
+  implements IPostQueueRecord
+{
+  @OneToOne(() => PostRecord, {
+    nullable: true,
+    orphanRemoval: false,
+    serializer: (pr) => pr.id,
+    eager: true,
+    inversedBy: 'postQueueRecord',
+  })
+  postRecord?: Rel<IPostRecord>;
+
+  @OneToOne({
+    entity: () => Submission,
+    nullable: false,
+    serializer: (s) => s.id,
+    mappedBy: 'postQueueRecord',
+    orphanRemoval: false,
+    eager: true,
+  })
+  submission: Rel<ISubmission>;
+
+  toJSON(): PostQueueRecordDto {
+    return serialize(this) as PostQueueRecordDto;
+  }
+}

apps/client-server/src/app/database/entities/post-record.entity.ts

@@ -4,11 +4,13 @@ import {
   EntityRepositoryType,
   ManyToOne,
   OneToMany,
+  OneToOne,
   Property,
   Rel,
   serialize,
 } from '@mikro-orm/core';
 import {
+  IPostQueueRecord,
   IPostRecord,
   ISubmission,
   IWebsitePostRecord,
@@ -17,6 +19,7 @@ import {
   PostRecordState,
 } from '@postybirb/types';
 import { PostyBirbRepository } from '../repositories/postybirb-repository';
+import { PostQueueRecord } from './post-queue-record.entity';
 import { PostyBirbEntity } from './postybirb-entity';
 import { Submission } from './submission.entity';
 import { WebsitePostRecord } from './website-post-record.entity';
@@ -52,6 +55,14 @@ export class PostRecord extends PostyBirbEntity implements IPostRecord {
   })
   children: Collection<IWebsitePostRecord>;
 
+  @OneToOne(() => PostQueueRecord, {
+    orphanRemoval: true,
+    eager: true,
+    nullable: true,
+    mappedBy: 'postRecord',
+  })
+  postQueueRecord?: Rel<IPostQueueRecord>;
+
   @Property({ type: 'string', nullable: false })
   state: PostRecordState = PostRecordState.PENDING;
 
@@ -61,7 +72,7 @@ export class PostRecord extends PostyBirbEntity implements IPostRecord {
   constructor(
     postRecord: Pick<
       IPostRecord,
-      'parent' | 'completedAt' | 'state' | 'resumeMode'
+      'parent' | 'completedAt' | 'state' | 'resumeMode' | 'postQueueRecord'
     >,
   ) {
     super();
@@ -73,6 +84,8 @@ export class PostRecord extends PostyBirbEntity implements IPostRecord {
 
   toJSON(): PostRecordDto {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    return serialize(this as any, { populate: ['children'] }) as PostRecordDto;
+    return serialize(this as any, {
+      populate: ['children', 'postQueueRecord'],
+    }) as PostRecordDto;
   }
 }

apps/client-server/src/app/database/entities/submission.entity.ts

@@ -3,8 +3,9 @@ import {
   Entity,
   EntityRepositoryType,
   OneToMany,
+  OneToOne,
   Property,
-  serialize,
+  serialize
 } from '@mikro-orm/core';
 import {
   IPostRecord,
@@ -14,11 +15,12 @@ import {
   ISubmissionMetadata,
   ISubmissionScheduleInfo,
   IWebsiteFormFields,
-  SubmissionType,
+  SubmissionType
 } from '@postybirb/types';
 
 import { PostyBirbRepository } from '../repositories/postybirb-repository';
 import { DirectoryWatcher } from './directory-watcher.entity';
+import { PostQueueRecord } from './post-queue-record.entity';
 import { PostRecord } from './post-record.entity';
 import { PostyBirbEntity } from './postybirb-entity';
 import { SubmissionFile } from './submission-file.entity';
@@ -73,6 +75,13 @@ export class Submission<T extends ISubmissionMetadata = ISubmissionMetadata>
   })
   posts: Collection<IPostRecord>;
 
+  @OneToOne(() => PostQueueRecord, {
+    orphanRemoval: true,
+    eager: true,
+    nullable: true,
+  })
+  postQueueRecord?: PostQueueRecord;
+
   @Property({ type: 'number', nullable: true })
   order: number;
 
@@ -87,7 +96,13 @@ export class Submission<T extends ISubmissionMetadata = ISubmissionMetadata>
   toJSON(): ISubmissionDto<T> {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     return serialize(this as any, {
-      populate: ['files', 'options', 'options.account', 'posts'],
+      populate: [
+        'files',
+        'options',
+        'options.account',
+        'posts',
+        'postQueueRecord',
+      ],
     }) as ISubmissionDto<T>;
   }
 }

apps/client-server/src/app/database/mikro-orm.providers.ts

@@ -6,6 +6,7 @@ import {
   Account,
   AltFile,
   DirectoryWatcher,
+  PostQueueRecord,
   PostRecord,
   PrimaryFile,
   Settings,
@@ -36,6 +37,7 @@ const entities = [
   WebsiteData,
   PostRecord,
   WebsitePostRecord,
+  PostQueueRecord,
 ];
 
 const mikroOrmOptions: MikroOrmModuleSyncOptions = {

apps/client-server/src/app/post/dtos/post-queue-action.dto.ts

@@ -0,0 +1,10 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IPostQueueActionDto } from '@postybirb/types';
+import { ArrayNotEmpty, IsArray } from 'class-validator';
+
+export class PostQueueActionDto implements IPostQueueActionDto {
+  @ApiProperty()
+  @IsArray()
+  @ArrayNotEmpty()
+  submissionIds: string[];
+}

apps/client-server/src/app/post/post.controller.ts

@@ -1,8 +1,7 @@
-import { Body, Controller, Post } from '@nestjs/common';
-import { ApiOkResponse, ApiTags } from '@nestjs/swagger';
+import { Controller } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
 import { PostyBirbController } from '../common/controller/postybirb-controller';
 import { PostRecord } from '../database/entities';
-import { QueuePostRecordRequestDto } from './dtos/queue-post-record.dto';
 import { PostService } from './post.service';
 
 /**
@@ -15,16 +14,4 @@ export class PostController extends PostyBirbController<PostRecord> {
   constructor(readonly service: PostService) {
     super(service);
   }
-
-  @Post('enqueue')
-  @ApiOkResponse({ description: 'Post(s) queued.' })
-  async enqueue(@Body() request: QueuePostRecordRequestDto) {
-    return this.service.enqueue(request);
-  }
-
-  @Post('dequeue')
-  @ApiOkResponse({ description: 'Post(s) dequeued.' })
-  async dequeue(@Body() request: QueuePostRecordRequestDto) {
-    this.service.dequeue(request);
-  }
 }

apps/client-server/src/app/post/post.module.ts

@@ -2,14 +2,17 @@ import { Module } from '@nestjs/common';
 import { DatabaseModule } from '../database/database.module';
 import { FileConverterModule } from '../file-converter/file-converter.module';
 import { PostParsersModule } from '../post-parsers/post-parsers.module';
+import { SettingsModule } from '../settings/settings.module';
 import { ValidationModule } from '../validation/validation.module';
 import { WebsiteOptionsModule } from '../website-options/website-options.module';
 import { WebsiteImplProvider } from '../websites/implementations';
 import { WebsitesModule } from '../websites/websites.module';
-import { PostFileResizerService } from './post-file-resizer.service';
-import { PostManagerService } from './post-manager.service';
 import { PostController } from './post.controller';
 import { PostService } from './post.service';
+import { PostFileResizerService } from './services/post-file-resizer/post-file-resizer.service';
+import { PostManagerService } from './services/post-manager/post-manager.service';
+import { PostQueueController } from './services/post-queue/post-queue.controller';
+import { PostQueueService } from './services/post-queue/post-queue.service';
 
 @Module({
   imports: [
@@ -19,13 +22,15 @@ import { PostService } from './post.service';
     PostParsersModule,
     ValidationModule,
     FileConverterModule,
+    SettingsModule,
   ],
-  controllers: [PostController],
+  controllers: [PostController, PostQueueController],
   providers: [
     PostService,
     PostManagerService,
     PostFileResizerService,
     WebsiteImplProvider,
+    PostQueueService,
   ],
 })
 export class PostModule {}

apps/client-server/src/app/post/post.service.spec.ts

@@ -14,10 +14,10 @@ import { UserSpecifiedWebsiteOptionsModule } from '../user-specified-website-opt
 import { ValidationModule } from '../validation/validation.module';
 import { WebsiteOptionsModule } from '../website-options/website-options.module';
 import { WebsitesModule } from '../websites/websites.module';
-import { PostFileResizerService } from './post-file-resizer.service';
-import { PostManagerService } from './post-manager.service';
 import { PostModule } from './post.module';
 import { PostService } from './post.service';
+import { PostFileResizerService } from './services/post-file-resizer/post-file-resizer.service';
+import { PostManagerService } from './services/post-manager/post-manager.service';
 
 describe('PostService', () => {
   let service: PostService;