fix(upgrade-componentsjs): fix configs and tests

.componentsignore

@@ -4,6 +4,7 @@
   "HttpErrorOptions",
   "WinstonLogger",
   "TypeOrmRepository",
+  "EntitySchemaOptions",
   "ConfiguredJobOptions",
   "MigrationInterface",
   "BullQueueSettings",

config/default.json

@@ -9,9 +9,7 @@
     "sor:config/http/handler/default.json",
     "sor:config/http/static/default.json",
     "sor:config/http/routes/default.json",
-    "sor:config/http/error-handler.json",
     "sor:config/http/response-writer.json",
-    "sor:config/http/request-parser.json",
     "sor:config/server/middleware/default.json",
     "sor:config/server/server-factory/default.json",
     "sor:config/storage/key-value/memory.json",

config/jobs/bull-no-processing.json

@@ -4,21 +4,13 @@
     {
       "@id": "urn:solid-on-rails:default:QueueAdapter",
       "@type": "BullQueueAdapter",
-      "args_queues": [
-        {
-          "BullQueueAdapter:_args_queues_key": "default",
-          "BullQueueAdapter:_args_queues_value": {}
-        }
+      "queues": {
+        "default": {}
+      },
+      "jobs": [
+        { "@type": "VoidJob" }
       ],
-      "args_jobs": [
-        {
-          "BullQueueAdapter:_args_jobs_key": "Void",
-          "BullQueueAdapter:_args_jobs_value": {
-            "@type": "VoidJob"
-          }
-        }
-      ],
-      "args_queueProcessor": {
+      "queueProcessor": {
         "@type": "VoidQueueProcessor"
       }
     },

config/jobs/bull.json

@@ -4,21 +4,13 @@
     {
       "@id": "urn:solid-on-rails:default:QueueAdapter",
       "@type": "BullQueueAdapter",
-      "args_queues": [
-        {
-          "BullQueueAdapter:_args_queues_key": "default",
-          "BullQueueAdapter:_args_queues_value": {}
-        }
+      "queues": {
+        "default": {}
+      },
+      "jobs": [
+        { "@type": "VoidJob" }
       ],
-      "args_jobs": [
-        {
-          "BullQueueAdapter:_args_jobs_key": "Void",
-          "BullQueueAdapter:_args_jobs_value": {
-            "@type": "VoidJob"
-          }
-        }
-      ],
-      "args_queueProcessor": {
+      "queueProcessor": {
         "@type": "BullQueueProcessor"
       }
     },

config/jobs/scheduler/default.json

@@ -10,7 +10,8 @@
       "comment": "Logs a warning if the base URL changes.",
       "@id": "urn:solid-on-rails:default:JobSchedulesInitializer",
       "@type": "JobSchedulesInitializer",
-      "scheduler": { "@id": "urn:solid-on-rails:default:JobScheduler" }
+      "scheduler": { "@id": "urn:solid-on-rails:default:JobScheduler" },
+      "schedules": {}
     },
     {
       "comment": "Ensure the preconfigured Job schedules get initialized.",

package.json

@@ -57,7 +57,8 @@
     "test:deploy": "chmod +x ./test/deploy/validate-package.sh && ./test/deploy/validate-package.sh",
     "test:ts": "tsc -p test --noEmit",
     "test:integration": "jest --coverageReporters text-summary -- test/integration",
-    "test:unit": "jest --config=./jest.coverage.config.js test/unit"
+    "test:unit": "jest --config=./jest.coverage.config.js test/unit",
+    "prepare": "npm run build"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.0.3",

src/jobs/Job.ts

@@ -5,6 +5,7 @@ import type { ConfiguredJobOptions } from './JobOptions';
  * A single asyncronous Job.
  */
 export abstract class Job {
+  public abstract readonly name: string;
   public readonly options: ConfiguredJobOptions = { queue: 'default' };
 
   /**

src/jobs/VoidJob.ts

@@ -5,6 +5,8 @@ import type { ConfiguredJobOptions } from './JobOptions';
  * A job that does nothing.
  */
 export class VoidJob extends Job {
+  public readonly name: string = 'Void';
+
   public constructor(options?: ConfiguredJobOptions) {
     super(options);
   }

src/jobs/adapter/BullQueueAdapter.ts

@@ -1,3 +1,4 @@
+/* eslint-disable tsdoc/syntax */
 import type { Queue } from 'bull';
 import Bull from 'bull';
 import { getLoggerFor } from '../../logging/LogUtil';
@@ -53,13 +54,6 @@ export interface BullQueueSettings {
   isSharedChildPool?: boolean;
 }
 
-export interface BullQueueAdapterArgs {
-  jobs: Record<string, Job>;
-  queues: Record<string, BullQueueSettings>;
-  redisConfig: RedisConfig;
-  queueProcessor: BullQueueProcessor;
-}
-
 const DEFAULT_BACKOFF_DELAY = 2000;
 
 /**
@@ -68,22 +62,33 @@ const DEFAULT_BACKOFF_DELAY = 2000;
  */
 export class BullQueueAdapter implements QueueAdapter {
   protected readonly logger = getLoggerFor(this);
-  private readonly jobs: Record<string, Job>;
+  private readonly jobs: Job[];
   private readonly queues: Record<string, Queue> = {};
 
-  public constructor(args: BullQueueAdapterArgs) {
-    this.jobs = args.jobs;
-
-    for (const [ queue, settings ] of Object.entries(args.queues)) {
+  /**
+   * @param jobs - The jobs which can be run.
+   * @param queues - The queues which jobs can be run on. @range {json}
+   * @param redisConfig - The configuration for redis to store job and queue details.
+   * @param queueProcessor - The queue processor.
+   */
+  public constructor(
+    jobs: Job[],
+    queues: Record<string, BullQueueSettings>,
+    redisConfig: RedisConfig,
+    queueProcessor: BullQueueProcessor,
+  ) {
+    this.jobs = jobs;
+
+    for (const [ queue, settings ] of Object.entries(queues)) {
       this.queues[queue] = new Bull(
         queue,
         {
-          redis: args.redisConfig,
+          redis: redisConfig,
           settings,
         },
       );
     }
-    args.queueProcessor.processJobsOnQueues(this.queues, this.jobs, this);
+    queueProcessor.processJobsOnQueues(this.queues, this.jobs, this);
   }
 
   public async finalize(): Promise<void> {
@@ -98,7 +103,7 @@ export class BullQueueAdapter implements QueueAdapter {
     data: Record<string, any> = {},
     overrideOptions: Partial<JobOptions> = {},
   ): Promise<void> {
-    const job = this.jobs[jobName];
+    const job = this.jobs.find((jobIter): boolean => jobIter.name === jobName);
     if (!job) {
       throw new Error(`Job '${jobName}' is not defined`);
     }

src/jobs/processor/BullQueueProcessor.ts

@@ -9,14 +9,14 @@ export class BullQueueProcessor implements QueueProcessor<Queue> {
 
   public processJobsOnQueues(
     queues: Record<string, Queue>,
-    jobs: Record<string, Job>,
+    jobs: Job[],
     queueAdapter: QueueAdapter,
   ): void {
     for (const queue of Object.keys(queues)) {
       let isFirst = true;
-      for (const jobName of Object.keys(jobs)) {
-        queues[queue].process(jobName, isFirst ? 1 : 0, async(bullJob): Promise<void> =>
-          jobs[jobName].perform(bullJob.data, queueAdapter)) as any;
+      for (const job of jobs) {
+        queues[queue].process(job.name, isFirst ? 1 : 0, async(bullJob): Promise<void> =>
+          job.perform(bullJob.data, queueAdapter)) as any;
         isFirst = false;
       }
       this.initializeQueueEvents(queues[queue]);

src/jobs/processor/QueueProcessor.ts

@@ -4,7 +4,7 @@ import type { Job } from '../Job';
 export interface QueueProcessor<TQueue> {
   processJobsOnQueues: (
     queues: Record<string, TQueue>,
-    jobs: Record<string, Job>,
+    jobs: Job[],
     queueAdapter: QueueAdapter,
   ) => void;
 }

src/jobs/processor/VoidQueueProcessor.ts

@@ -9,7 +9,7 @@ export class VoidQueueProcessor implements QueueProcessor<any> {
 
   public processJobsOnQueues(
     queues: Record<string, any>,
-    jobs: Record<string, Job>,
+    jobs: Job[],
     queueAdapter: QueueAdapter,
   ): void {
     // Do nothing

test/integration/ConfiguredJobs.test.ts

@@ -40,19 +40,18 @@ describe('An http server with preconfigured jobs', (): void => {
     bullConstructor = jest.fn().mockImplementation((): Bull.Queue => ({ process, add, on } as any));
     (Bull as jest.Mock).mockImplementation(bullConstructor);
 
-    const adapter = new BullQueueAdapter({
-      queues: { default: {}},
-      jobs: {
-        Void: {
-          options: { queue: 'default' },
-          perform: jest.fn().mockImplementation(async({ value }: { value: string }): Promise<void> => {
-            jobValue = value;
-          }),
-        },
-      },
-      queueProcessor: new BullQueueProcessor(),
+    const adapter = new BullQueueAdapter(
+      [{
+        name: 'Void',
+        options: { queue: 'default' },
+        perform: jest.fn().mockImplementation(async({ value }: { value: string }): Promise<void> => {
+          jobValue = value;
+        }),
+      }],
+      { default: {}},
       redisConfig,
-    });
+      new BullQueueProcessor(),
+    );
 
     const instances = await instantiateFromConfig(
       'urn:solid-on-rails:test:Instances',

test/integration/config/configured-jobs.json

@@ -11,16 +11,10 @@
 
     "sor:config/http/handler/no-routes.json",
     "sor:config/http/static/default.json",
-
-    "sor:config/http/error-handler.json",
-    "sor:config/http/response-writer.json",
-    "sor:config/http/request-parser.json",
-
+
     "sor:config/server/middleware/default.json",
     "sor:config/server/server-factory/default.json",
 
-    "sor:config/jobs/scheduler/default.json",
-
     "sor:config/storage/key-value/memory.json",
 
     "sor:config/util/variables/default.json",
@@ -42,8 +36,15 @@
       ]
     },
     {
+      "@id": "urn:solid-on-rails:default:JobScheduler",
+      "@type": "AdapterBasedScheduler",
+      "adapter": { "@id": "urn:solid-on-rails:default:QueueAdapter" }
+    },
+    {
+      "comment": "Logs a warning if the base URL changes.",
       "@id": "urn:solid-on-rails:default:JobSchedulesInitializer",
       "@type": "JobSchedulesInitializer",
+      "scheduler": { "@id": "urn:solid-on-rails:default:JobScheduler" },
       "schedules": {
         "Void": {
           "jobName": "Void",
@@ -53,6 +54,14 @@
           }
         }
       }
+    },
+    {
+      "comment": "Ensure the preconfigured Job schedules get initialized.",
+      "@id": "urn:solid-on-rails:default:ParallelInitializer",
+      "@type": "ParallelHandler",
+      "handlers": [
+        { "@id": "urn:solid-on-rails:default:JobSchedulesInitializer" }
+      ]
     }
   ]
 }

test/integration/config/data-mapper.json

@@ -11,9 +11,7 @@
     "sor:config/http/handler/default.json",
     "sor:config/http/static/default.json",
     "sor:config/http/routes/default.json",
-    "sor:config/http/error-handler.json",
     "sor:config/http/response-writer.json",
-    "sor:config/http/request-parser.json",
     "sor:config/server/middleware/default.json",
     "sor:config/server/server-factory/default.json",
     "sor:config/storage/key-value/memory.json",

test/integration/config/migration.json

@@ -11,9 +11,7 @@
     "sor:config/http/handler/default.json",
     "sor:config/http/static/default.json",
     "sor:config/http/routes/default.json",
-    "sor:config/http/error-handler.json",
     "sor:config/http/response-writer.json",
-    "sor:config/http/request-parser.json",
     "sor:config/server/middleware/default.json",
     "sor:config/server/server-factory/default.json",
     "sor:config/storage/key-value/memory.json",

test/integration/config/websocket-server.json

@@ -7,7 +7,6 @@
     "sor:config/app/variables/default.json",
     "sor:config/app/path/default.json",
     "sor:config/http/static/default.json",
-    "sor:config/http/error-handler.json",
     "sor:config/server/server-factory/default.json",
     "sor:config/storage/key-value/memory.json",
     "sor:config/util/variables/default.json",