Merge pull request #3506 from SeedCompany/better-handle-non-pnp-uploads

Author: CarsonF

src/components/pnp/pnp.ts

@@ -1,37 +1,54 @@
-import { WorkBook } from '~/common/xlsx.util';
-import { type Downloadable } from '../file/dto';
+import { InputException, NotFoundException } from '~/common';
+import { type Sheet, WorkBook } from '~/common/xlsx.util';
+import { type Downloadable, type FileVersion } from '../file/dto';
 import { PlanningSheet } from './planning-sheet';
 import { ProgressSheet } from './progress-sheet';
 
 const ParsedPnp = Symbol('Parsed PnP');
 
 export class Pnp {
-  constructor(protected workbook: WorkBook) {}
+  constructor(protected workbook: WorkBook, protected fileName?: string) {}
 
   /**
    * Create PnP from Downloadable.
    * Will reuse an existing instance from a previous call.
    */
-  static async fromDownloadable(obj: Downloadable<unknown>) {
+  static async fromDownloadable(obj: Downloadable<FileVersion>) {
     const promise = obj.download() as Promise<Buffer> & { [ParsedPnp]?: Pnp };
     if (!promise[ParsedPnp]) {
-      promise[ParsedPnp] = Pnp.fromBuffer(await promise);
+      promise[ParsedPnp] = Pnp.fromBuffer(await promise, obj.name);
     }
     return promise[ParsedPnp]!;
   }
 
-  static fromBuffer(buffer: Buffer) {
+  static fromBuffer(buffer: Buffer, name?: string) {
     const book = WorkBook.fromBuffer(buffer);
     PlanningSheet.register(book);
     ProgressSheet.register(book);
-    return new Pnp(book);
+    return new Pnp(book, name);
   }
 
   get planning() {
-    return this.workbook.sheet<PlanningSheet>('Planning');
+    return this.sheet<PlanningSheet>('Planning');
   }
 
   get progress() {
-    return this.workbook.sheet<ProgressSheet>('Progress');
+    return this.sheet<ProgressSheet>('Progress');
+  }
+
+  protected sheet<TSheet extends Sheet>(name: string): TSheet {
+    try {
+      return this.workbook.sheet(name);
+    } catch (e) {
+      if (e instanceof NotFoundException && this.fileName?.match(/\bUBT\b/)) {
+        throw new NotPnPFile(
+          `It appears you are uploading a _budget_ excel file, not a _PnP_ file.`,
+          e,
+        );
+      }
+      throw e;
+    }
   }
 }
+
+export class NotPnPFile extends InputException {}

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

@@ -3,7 +3,7 @@ import { entries } from '@seedcompany/common';
 import { assert } from 'ts-essentials';
 import type { MergeExclusive } from 'type-fest';
 import type { Cell, Column, Row } from '~/common/xlsx.util';
-import type { Downloadable } from '../file/dto';
+import type { Downloadable, FileVersion } from '../file/dto';
 import {
   extractScripture,
   findStepColumns,
@@ -45,7 +45,7 @@ type ExtractedRow = MergeExclusive<
 @Injectable()
 export class StepProgressExtractor {
   async extract(
-    file: Downloadable<unknown>,
+    file: Downloadable<FileVersion>,
     result: PnpProgressExtractionResult,
   ) {
     const pnp = await Pnp.fromDownloadable(file);

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

@@ -7,6 +7,7 @@ import { DateTime } from 'luxon';
 import { DateInterval, type ID } from '~/common';
 import { ILogger, Logger, ResourceLoader } from '~/core';
 import { type Downloadable, type FileVersion } from '../file/dto';
+import { NotPnPFile } from '../pnp';
 import {
   type PnpExtractionResult,
   PnpProblemType,
@@ -67,10 +68,12 @@ export class PnpProductSyncService {
         result,
       );
     } catch (e) {
-      this.logger.error(e.message, {
-        id: pnp.id,
-        exception: e,
-      });
+      if (!(e instanceof NotPnPFile)) {
+        this.logger.error(e.message, {
+          id: pnp.id,
+          exception: e,
+        });
+      }
       return [];
     }
     if (productRows.length === 0) {

src/components/product/product.extractor.ts

@@ -5,7 +5,7 @@ import { assert } from 'ts-essentials';
 import { type MergeExclusive } from 'type-fest';
 import { type CalendarDate, type DateInterval } from '~/common';
 import { type Cell, type Column, type Row } from '~/common/xlsx.util';
-import { type Downloadable } from '../file/dto';
+import { type Downloadable, type FileVersion } from '../file/dto';
 import {
   extractScripture,
   findStepColumns,
@@ -31,7 +31,7 @@ import { type ProductStep, type ProductStep as Step } from './dto';
 @Injectable()
 export class ProductExtractor {
   async extract(
-    file: Downloadable<unknown>,
+    file: Downloadable<FileVersion>,
     engagementRange: DateInterval | null,
     availableSteps: readonly ProductStep[],
     result: PnpPlanningExtractionResult,

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

@@ -8,7 +8,7 @@ import {
   fiscalYear,
 } from '~/common';
 import { type Column, type Row } from '~/common/xlsx.util';
-import { type Downloadable } from '../file/dto';
+import { type Downloadable, type FileVersion } from '../file/dto';
 import { Pnp, type ProgressSheet } from '../pnp';
 import {
   PnpProblemType,
@@ -19,7 +19,7 @@ import { type ProgressSummary as Progress } from './dto';
 @Injectable()
 export class ProgressSummaryExtractor {
   async extract(
-    file: Downloadable<unknown>,
+    file: Downloadable<FileVersion>,
     date: CalendarDate,
     result: PnpProgressExtractionResult,
   ) {

src/repl.ts

@@ -6,6 +6,7 @@ import * as fs from 'fs/promises';
 // eslint-disable-next-line no-restricted-imports
 import * as lodash from 'lodash';
 import { DateTime, Duration, Interval } from 'luxon';
+import { basename } from 'node:path';
 import { CalendarDate, DateInterval } from '~/common';
 import * as common from '~/common';
 import './polyfills';
@@ -46,7 +47,8 @@ runRepl({
       session,
       sessionFor: session.withRoles,
       Resources,
-      loadPnp: (filepath: string) => Pnp.fromBuffer(readFileSync(filepath)),
+      loadPnp: (filepath: string) =>
+        Pnp.fromBuffer(readFileSync(filepath), basename(filepath)),
     };
   },
 });