fix: make WorldEvent async, parseAsyncArray build usage

WFCD · Jun 23, 2024 · 405ec91 · 405ec91
1 parent 67bc70e
commit 405ec91
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 44 deletions.
diff --git a/.commitlintrc.ts b/.commitlintrc.ts
@@ -6,7 +6,12 @@ export default {
   ],
   rules: {
     'body-max-line-length': [
-      RuleConfigSeverity.Error
+      RuleConfigSeverity.Disabled
+    ],
+    'subject-case': [
+      RuleConfigSeverity.Error,
+      'never',
+      ['sentence-case', 'start-case']
     ]
   }
 }
diff --git a/lib/WorldState.js b/lib/WorldState.js
@@ -73,7 +73,7 @@ export function parseArray(ParserClass, dataArray, deps, uniqueField) {
 
 /**
  * Parse array of objects that requires async parsing
- * @param {object} ParserClass class for parsing data
+ * @param {object} ParserClass class for parsing data - must expose a static build method
  * @param {Array<BaseContentObject>} dataArray array of raw data
  * @param {Dependency} deps shared dependency object
  * @param {*} [uniqueField] field to treat as unique
@@ -83,7 +83,7 @@ export const parseAsyncArray = async (ParserClass, dataArray, deps, uniqueField)
   const arr = [];
   // eslint-disable-next-line no-restricted-syntax
   for await (const d of dataArray ?? []) {
-    arr.push(await new ParserClass(d, deps));
+    arr.push(await ParserClass.build(d, deps));
   }
   if (uniqueField) {
     const utemp = {};

diff --git a/lib/models/SyndicateJob.js b/lib/models/SyndicateJob.js
@@ -105,7 +105,7 @@ export default class SyndicateJob extends WorldstateObject {
    * @param {object} deps The dependencies object
    * @param {string} deps.locale Locale to use for translations
    *
-   * This DOES NOT populate the reward pool or the
+   * This DOES NOT populate the reward pool
    */
   constructor(data, expiry, { locale = 'en' }) {
     super({

diff --git a/lib/models/SyndicateMission.js b/lib/models/SyndicateMission.js
@@ -10,6 +10,27 @@ import WorldstateObject from './WorldstateObject.js';
  * @augments {WorldstateObject}
  */
 export default class SyndicateMission extends WorldstateObject {
+  /**
+   * Build a new SyndicateMission with async operations & data
+   * @param   {object}             data            The syndicate mission data
+   * @param   {object}             deps            The dependencies object
+   * @param   {string}             deps.locale     Locale to use for translations
+   * @returns {Promise.<SyndicateMission>}         SyndicateMission object w/ async resolution of jobs
+   */
+  static async build(data, deps) {
+    const syndicateMission = new SyndicateMission(data, deps);
+    if (data.Jobs) {
+      const jobs = [];
+      // eslint-disable-next-line no-restricted-syntax
+      for await (const job of data.Jobs ?? []) {
+        jobs.push(await SyndicateJob.build(job, syndicateMission.expiry, deps));
+      }
+      syndicateMission.jobs = jobs;
+    }
+
+    return syndicateMission;
+  }
+
   /**
    * @param   {object}             data            The syndicate mission data
    * @param   {object}             deps            The dependencies object
@@ -18,10 +39,6 @@ export default class SyndicateMission extends WorldstateObject {
   constructor(data, { locale = 'en' } = { locale: 'en' }) {
     super(data);
 
-    const deps = {
-      locale,
-    };
-
     /**
      * The date and time at which the syndicate mission starts
      * @type {Date}
@@ -69,21 +86,6 @@ export default class SyndicateMission extends WorldstateObject {
      * @type {string} time delta string from now to the expiry
      */
     this.eta = this.getETAString();
-
-    // Async stuff!
-    // eslint-disable-next-line no-constructor-return
-    return Promise.resolve(
-      (async () => {
-        if (data.Jobs) {
-          // eslint-disable-next-line no-restricted-syntax
-          for await (const job of data.Jobs ?? []) {
-            this.jobs.push(await new SyndicateJob(job, this.expiry, deps));
-          }
-        }
-
-        return this;
-      })()
-    );
   }
 
   /**

diff --git a/lib/models/WorldEvent.js b/lib/models/WorldEvent.js
@@ -27,6 +27,34 @@ import Reward from './Reward.js';
  * @augments {WorldstateObject}
  */
 export default class WorldEvent extends WorldstateObject {
+  /**
+   * Asynchronously build a new WorldEvent
+   * @param   {object}            data            The event data
+   * @param   {object}            deps            The dependencies object
+   * @param   {string}            deps.locale     Locale to use for translations
+   * @returns {Promise.<WorldEvent>}              The created WorldEvent object
+   */
+  static async build(data, deps) {
+    const event = new WorldEvent(data, deps);
+    if (data.Jobs) {
+      const jobs = [];
+      // eslint-disable-next-line no-restricted-syntax
+      for await (const job of data.Jobs ?? []) {
+        jobs.push(await SyndicateJob.build(job, event.expiry, deps));
+      }
+      event.jobs = jobs;
+    }
+    if (data.PreviousJobs) {
+      const previousJobs = [];
+      // eslint-disable-next-line no-restricted-syntax
+      for await (const job of data.PreviousJobs ?? []) {
+        previousJobs.push(await SyndicateJob.build(job, event.expiry, deps));
+      }
+      event.previousJobs = previousJobs;
+    }
+    return event;
+  }
+
   /**
    * @param   {object}            data            The event data
    * @param   {object}            deps            The dependencies object
@@ -201,7 +229,7 @@ export default class WorldEvent extends WorldstateObject {
      */
     this.isCommunity = data.Community;
 
-    /**
+    /*
      * Affectors for this mission
      * @type {string[]}
      */
@@ -237,26 +265,9 @@ export default class WorldEvent extends WorldstateObject {
       activation: parseDate(data.NextAltActivation),
     };
 
-    // Async stuff!
-    // eslint-disable-next-line no-constructor-return
-    return Promise.resolve(
-      (async () => {
-        if (data.JobAffiliationTag) {
-          this.affiliatedWith = syndicate(data.JobAffiliationTag, locale);
-          if (data.Jobs) {
-            // eslint-disable-next-line no-restricted-syntax
-            for await (const job of data.Jobs ?? []) {
-              this.jobs.push(await new SyndicateJob(job, this.expiry, opts));
-            }
-            // eslint-disable-next-line no-restricted-syntax
-            for await (const job of data.PreviousJobs ?? []) {
-              this.previousJobs.push(await new SyndicateJob(job, this.expiry, opts));
-            }
-          }
-        }
-        return this;
-      })()
-    );
+    if (data.JobAffiliationTag) {
+      this.affiliatedWith = syndicate(data.JobAffiliationTag, locale);
+    }
   }
 
   /**