Merge pull request #83 from yeatmanlab/enh/add-reliable-by-block

update addEngagementByBlock method to store reliableByBlock attribute for block-scoped assessments

src/firestore/app/appkit.ts

@@ -192,9 +192,9 @@ export class RoarAppkit {
    * Please note that calling this function with a new set of engagement flags will
    * overwrite the previous set.
    */
-  async updateEngagementFlags(flagNames: string[], markAsReliable = false) {
+  async updateEngagementFlags(flagNames: string[], markAsReliable = false, reliableByBlock = undefined) {
     if (this._started) {
-      return this.run!.addEngagementFlags(flagNames, markAsReliable);
+      return this.run!.addEngagementFlags(flagNames, markAsReliable, reliableByBlock);
     } else {
       throw new Error('This run has not started. Use the startRun method first.');
     }

src/firestore/app/run.ts

@@ -216,11 +216,14 @@ export class RoarRun {
    * @async
    * @param {string[]} engagementFlags - Engagement flags to add to the run
    * @param {boolean} markAsReliable - Whether or not to mark the run as reliable, defaults to false
+   * @param {Object} reliableByBlock - Stores the reliability of the run by block
+   * This is an optional parameter that needs only to be passed in for block scoped tasks
+   * For Example: {DEL: false, FSM: true, LSM: false}
    *
    * Please note that calling this function with a new set of engagement flags will
    * overwrite the previous set.
    */
-  async addEngagementFlags(engagementFlags: string[], markAsReliable = false) {
+  async addEngagementFlags(engagementFlags: string[], markAsReliable = false, reliableByBlock = undefined) {
     if (!this.started) {
       throw new Error('Run has not been started yet. Use the startRun method first.');
     }
@@ -231,12 +234,20 @@ export class RoarRun {
     }, {});
 
     if (!this.aborted) {
-      return updateDoc(this.runRef, { engagementFlags: engagementObj, reliable: markAsReliable });
+      // In cases that the run is non-block-scoped and should only have the reliable attribute stored
+      if (reliableByBlock === undefined) {
+        return updateDoc(this.runRef, { engagementFlags: engagementObj, reliable: markAsReliable });
+      }
+      // In cases we want to store reliability by block, we need to store the reliable attribute as well as the reliableByBlock attribute
+      else {
+        return updateDoc(this.runRef, { engagementFlags: engagementObj, reliable: markAsReliable, reliableByBlock: reliableByBlock });
+      }
     } else {
       throw new Error('Run has already been aborted.');
     }
   }
 
+
   /**
    * Mark this run as complete on Firestore
    * @method