Initialize extraction results & stub passing around

Author: CarsonF

src/components/periodic-report/events/periodic-report-uploaded.event.ts

@@ -1,5 +1,7 @@
+import { LazyGetter as Once } from 'lazy-get-decorator';
 import { Session } from '~/common';
 import { Downloadable, FileNode } from '../../file/dto';
+import { PnpProgressExtractionResult } from '../../pnp/extraction-result';
 import { PeriodicReport } from '../dto';
 
 /**
@@ -11,4 +13,8 @@ export class PeriodicReportUploadedEvent {
     readonly file: Downloadable<FileNode>,
     readonly session: Session,
   ) {}
+
+  @Once() get pnpResult() {
+    return new PnpProgressExtractionResult();
+  }
 }

src/components/product-progress/handlers/extract-pnp-progress.handler.ts

@@ -23,10 +23,12 @@ export class ExtractPnpProgressHandler {
       return;
     }
 
+    const result = event.pnpResult;
+
     // parse progress data from pnp spreadsheet
     let progressRows;
     try {
-      progressRows = await this.extractor.extract(event.file);
+      progressRows = await this.extractor.extract(event.file, result);
     } catch (e) {
       this.logger.warning(e.message, {
         name: event.file.name,

src/components/product-progress/step-progress-extractor.service.ts

@@ -14,6 +14,7 @@ import {
   ProgressSheet,
   WrittenScripturePlanningSheet,
 } from '../pnp';
+import { PnpProgressExtractionResult } from '../pnp/extraction-result';
 import { ProductStep as Step } from '../product/dto';
 import { ScriptureRange } from '../scripture/dto';
 import { StepProgressInput } from './dto';
@@ -42,7 +43,10 @@ type ExtractedRow = MergeExclusive<
 
 @Injectable()
 export class StepProgressExtractor {
-  async extract(file: Downloadable<unknown>) {
+  async extract(
+    file: Downloadable<unknown>,
+    result: PnpProgressExtractionResult,
+  ) {
     const pnp = await Pnp.fromDownloadable(file);
     const sheet = pnp.progress;
 

src/components/product/handlers/extract-products-from-pnp.handler.ts

@@ -4,6 +4,7 @@ import {
   EngagementUpdatedEvent,
 } from '../../engagement/events';
 import { FileService } from '../../file';
+import { PnpPlanningExtractionResult } from '../../pnp/extraction-result';
 import { getAvailableSteps } from '../dto';
 import { PnpProductSyncService } from '../pnp-product-sync.service';
 
@@ -39,10 +40,13 @@ export class ExtractProductsFromPnpHandler
     );
     const pnp = this.files.asDownloadable(fv);
 
+    const result = new PnpPlanningExtractionResult();
+
     const actionableProductRows = await this.syncer.parse({
       engagementId: engagement.id,
       availableSteps,
       pnp,
+      result,
     });
 
     await this.syncer.save({

src/components/product/pnp-product-sync.service.ts

@@ -6,6 +6,7 @@ import { DateTime } from 'luxon';
 import { ID, Session } from '~/common';
 import { ILogger, Logger } from '~/core';
 import { Downloadable, FileVersion } from '../file/dto';
+import { PnpExtractionResult } from '../pnp/extraction-result';
 import { StoryService } from '../story';
 import {
   CreateDerivativeScriptureProduct,
@@ -36,14 +37,16 @@ export class PnpProductSyncService {
     engagementId,
     availableSteps,
     pnp,
+    result,
   }: {
     engagementId: ID<'LanguageEngagement'>;
     availableSteps: readonly ProductStep[];
     pnp: Downloadable<FileVersion>;
+    result: PnpExtractionResult;
   }) {
     let productRows;
     try {
-      productRows = await this.extractor.extract(pnp, availableSteps);
+      productRows = await this.extractor.extract(pnp, availableSteps, result);
     } catch (e) {
       this.logger.warning(e.message, {
         id: pnp.id,
@@ -52,10 +55,15 @@ export class PnpProductSyncService {
       return [];
     }
     if (productRows.length === 0) {
+      // TODO: PnP Extraction Problem
       return [];
     }
 
-    return await this.matchRowsToProductChanges(engagementId, productRows);
+    return await this.matchRowsToProductChanges(
+      engagementId,
+      productRows,
+      result,
+    );
   }
 
   /**
@@ -65,6 +73,7 @@ export class PnpProductSyncService {
   private async matchRowsToProductChanges(
     engagementId: ID<'LanguageEngagement'>,
     rows: readonly ExtractedRow[],
+    result: PnpExtractionResult,
   ) {
     const scriptureProducts = rows[0].bookName
       ? await this.products.loadProductIdsForBookAndVerse(

src/components/product/product.extractor.ts

@@ -17,14 +17,16 @@ import {
   stepPlanCompleteDate,
   WrittenScripturePlanningSheet,
 } from '../pnp';
+import { PnpPlanningExtractionResult } from '../pnp/extraction-result';
 import { ScriptureRange, UnspecifiedScripturePortion } from '../scripture/dto';
-import { ProductStep as Step } from './dto';
+import { ProductStep, ProductStep as Step } from './dto';
 
 @Injectable()
 export class ProductExtractor {
   async extract(
     file: Downloadable<unknown>,
-    availableSteps: readonly Step[],
+    availableSteps: readonly ProductStep[],
+    result: PnpPlanningExtractionResult,
   ): Promise<readonly ExtractedRow[]> {
     const pnp = await Pnp.fromDownloadable(file);
     const sheet = pnp.planning;

src/components/progress-summary/handlers/extract-pnp-file-on-upload.handler.ts

@@ -18,6 +18,8 @@ export class ExtractPnpFileOnUploadHandler {
       return;
     }
 
+    const result = event.pnpResult;
+
     this.logger.info('Extracting progress summary', {
       report: event.report.id,
       userId: event.session.userId,
@@ -26,7 +28,11 @@ export class ExtractPnpFileOnUploadHandler {
 
     let extracted;
     try {
-      extracted = await this.extractor.extract(event.file, event.report.start);
+      extracted = await this.extractor.extract(
+        event.file,
+        event.report.start,
+        result,
+      );
     } catch (e) {
       this.logger.warning(e.message, {
         name: event.file.name,

src/components/progress-summary/progress-summary.extractor.ts

@@ -5,11 +5,16 @@ import { CalendarDate, fiscalQuarter, fiscalYear } from '~/common';
 import { Column, Row } from '~/common/xlsx.util';
 import { Downloadable } from '../file/dto';
 import { Pnp, ProgressSheet } from '../pnp';
+import { PnpProgressExtractionResult } from '../pnp/extraction-result';
 import { ProgressSummary as Progress } from './dto';
 
 @Injectable()
 export class ProgressSummaryExtractor {
-  async extract(file: Downloadable<unknown>, date: CalendarDate) {
+  async extract(
+    file: Downloadable<unknown>,
+    date: CalendarDate,
+    result: PnpProgressExtractionResult,
+  ) {
     const pnp = await Pnp.fromDownloadable(file);
     const sheet = pnp.progress;