retry more slowly but for longer (every 30s up to 2hrs) [MARXAN-1771]

api/apps/geoprocessing/src/legacy-project-import/legacy-piece-importers/features-specification.legacy-piece-importer.ts

@@ -47,6 +47,8 @@ type ApiEventSelectResult = {
 
 type FeatureIdByIntegerId = Record<number, string>;
 
+export const retriesIntervalForSpecificationStatusInSeconds = 30;
+
 @Injectable()
 @LegacyProjectImportPieceProcessorProvider()
 export class FeaturesSpecificationLegacyProjectPieceImporter
@@ -246,11 +248,11 @@ export class FeaturesSpecificationLegacyProjectPieceImporter
 
   private async waitUntilSpecificationEnds(
     scenarioId: string,
-    retries = 20,
+    retries = 240,
   ): Promise<Either<string, true>> {
     const timeout = left('specification timeout');
     const failure = left('specification failed');
-    const intervalSeconds = 3;
+    const intervalSeconds = retriesIntervalForSpecificationStatusInSeconds;
     let triesLeft = retries;
 
     return new Promise<Either<string, true>>((resolve) => {
@@ -289,6 +291,7 @@ export class FeaturesSpecificationLegacyProjectPieceImporter
     specRows: PropSpecDatRow[],
     projectId: string,
     scenarioId: string,
+    retries?: number,
   ): Promise<void> {
     const featureIdByIntegerId = await this.getFeatureIdByIntegerIdMap(
       projectId,
@@ -328,6 +331,7 @@ export class FeaturesSpecificationLegacyProjectPieceImporter
 
     const specificationResult = await this.waitUntilSpecificationEnds(
       scenarioId,
+      retries
     );
     if (isLeft(specificationResult)) {
       this.logAndThrow(
@@ -393,6 +397,7 @@ export class FeaturesSpecificationLegacyProjectPieceImporter
 
   async run(
     input: LegacyProjectImportJobInput,
+    retries?: number,
   ): Promise<LegacyProjectImportJobOutput> {
     const { files, projectId, scenarioId } = input;
 
@@ -413,7 +418,7 @@ export class FeaturesSpecificationLegacyProjectPieceImporter
     }
 
     const specRows = this.getPropSpecRows(specRowsOrError, puvsprRowsOrError);
-    await this.runSpecification(specRows, projectId, scenarioId);
+    await this.runSpecification(specRows, projectId, scenarioId, retries);
     await this.updateScenarioFeaturesData(specRows, scenarioId);
 
     return input;

api/apps/geoprocessing/test/integration/legacy-project-import/features-specification.legacy-piece-importer.e2e-spec.ts

@@ -38,7 +38,7 @@ import { Either, isLeft, left, right } from 'fp-ts/lib/Either';
 import { Readable } from 'stream';
 import { EntityManager, In, Repository } from 'typeorm';
 import { v4 } from 'uuid';
-import { FeaturesSpecificationLegacyProjectPieceImporter } from '../../../src/legacy-project-import/legacy-piece-importers/features-specification.legacy-piece-importer';
+import { FeaturesSpecificationLegacyProjectPieceImporter, retriesIntervalForSpecificationStatusInSeconds } from '../../../src/legacy-project-import/legacy-piece-importers/features-specification.legacy-piece-importer';
 import {
   specDatFeatureIdPropertyKey,
   specDatPuidPropertyKey,
@@ -54,6 +54,9 @@ import {
 } from '../cloning/fixtures';
 
 let fixtures: FixtureType<typeof getFixtures>;
+// needs to be comfortably > than the retries interval when polling for
+// status
+const timeoutForTestsThatNeedToCheckSpecificationJobStatus = 2 * retriesIntervalForSpecificationStatusInSeconds * 1000;
 
 describe(FeaturesSpecificationLegacyProjectPieceImporter, () => {
   beforeEach(async () => {
@@ -224,9 +227,9 @@ describe(FeaturesSpecificationLegacyProjectPieceImporter, () => {
       .WhenPieceImporterIsInvoked(job)
       .AndSpecificationProcessFails()
       .ThenASpecificationDidntFinishErrorShouldBeThrown();
-  });
+  }, timeoutForTestsThatNeedToCheckSpecificationJobStatus);
 
-  it(`fails when specification async job timeouts`, async () => {
+  it(`fails when specification async job times out`, async () => {
     const specDatFileType = LegacyProjectImportFileType.SpecDat;
     const puvsprDatFileType = LegacyProjectImportFileType.PuvsprDat;
 
@@ -245,10 +248,10 @@ describe(FeaturesSpecificationLegacyProjectPieceImporter, () => {
     fixtures.GivenValidPuvsprDatFile();
 
     await fixtures
-      .WhenPieceImporterIsInvoked(job)
-      .AndSpecificationProcessTimeouts()
+      .WhenPieceImporterIsInvoked(job, 2)
+      .AndSpecificationProcessTimesOut()
       .ThenASpecificationDidntFinishErrorShouldBeThrown();
-  }, 70_000);
+  }, timeoutForTestsThatNeedToCheckSpecificationJobStatus * 2);
 
   it(`fails if features data records does not contain required properties`, async () => {
     const specDatFileType = LegacyProjectImportFileType.SpecDat;
@@ -275,7 +278,7 @@ describe(FeaturesSpecificationLegacyProjectPieceImporter, () => {
       .WhenPieceImporterIsInvoked(job)
       .AndSpecificationProcessSucceeds()
       .ThenAMissingRequiredPropertiesErrorShouldBeThrown();
-  });
+  }, timeoutForTestsThatNeedToCheckSpecificationJobStatus);
 
   it('fails if puvspr.dat contains features not present in spec.dat', async () => {
     const specDatFileType = LegacyProjectImportFileType.SpecDat;
@@ -329,7 +332,7 @@ describe(FeaturesSpecificationLegacyProjectPieceImporter, () => {
       .WhenPieceImporterIsInvoked(job)
       .AndSpecificationProcessSucceeds()
       .ThenScenarioFeaturesDataShouldBeImported();
-  });
+  }, timeoutForTestsThatNeedToCheckSpecificationJobStatus);
 });
 
 const getFixtures = async () => {
@@ -682,7 +685,7 @@ const getFixtures = async () => {
         }),
       );
     },
-    WhenPieceImporterIsInvoked: (input: LegacyProjectImportJobInput) => {
+    WhenPieceImporterIsInvoked: (input: LegacyProjectImportJobInput, retries?: number) => {
       return {
         ThenADatFileNotFoundErrorShouldBeThrown: async (
           file: LegacyProjectImportFileType,
@@ -729,10 +732,10 @@ const getFixtures = async () => {
             },
           };
         },
-        AndSpecificationProcessTimeouts: () => {
+        AndSpecificationProcessTimesOut: () => {
           return {
             ThenASpecificationDidntFinishErrorShouldBeThrown: async () => {
-              await expect(sut.run(input)).rejects.toThrow(
+              await expect(sut.run(input, retries)).rejects.toThrow(
                 /specification didn't finish: specification timeout/gi,
               );
             },

api/libs/legacy-project-import/src/legacy-project-import-piece-processor.port.ts

@@ -1,7 +1,7 @@
 import { LegacyProjectImportPiece } from './domain/legacy-project-import-piece';
 
 export abstract class LegacyProjectImportPieceProcessor<I, O> {
-  abstract run(input: I): Promise<O>;
+  abstract run(input: I, retries?: number): Promise<O>;
 
   abstract isSupported(piece: LegacyProjectImportPiece): boolean;
 }