Merge pull request #183 from topcoder-platform/PM-5049_engagements-release-window

PM-5049 - make release window configurable for engagement payments

Author: vas3a

src/api/winnings/winnings.service.spec.ts

@@ -1,5 +1,6 @@
 jest.mock('src/config', () => ({
   ENV_CONFIG: {
+    ENGAGEMENT_PAYMENT_RELEASE_WINDOW_DAYS: 5,
     SENDGRID_TEMPLATE_ID_PAYMENT_SETUP_NOTIFICATION: 'template-id',
     TGBillingAccounts: [80000062, 80002800],
     TOPCODER_WALLET_URL: 'https://wallet.topcoder.com',
@@ -256,6 +257,73 @@ describe('WinningsService', () => {
     });
   });
 
+  it('applies a short release window to engagement payments', async () => {
+    const beforeCreate = Date.now();
+
+    await service.createWinningWithPayments(
+      {
+        winnerId: 'user-1',
+        type: WinningsType.PAYMENT,
+        origin: 'Topcoder',
+        category: WinningsCategory.ENGAGEMENT_PAYMENT,
+        title: 'Engagement work',
+        description: 'Engagement payment',
+        externalId: 'assignment-1',
+        details: [
+          {
+            totalAmount: 100,
+            grossAmount: 100,
+            installmentNumber: 1,
+            currency: PrizeType.USD,
+            billingAccount: '123456',
+          },
+        ],
+      } as any,
+      'creator-1',
+    );
+
+    const persistedPayment =
+      tx.winnings.create.mock.calls[0][0].data.payment.create[0];
+
+    const releaseDate = new Date(persistedPayment.release_date).getTime();
+    const daysUntilRelease = (releaseDate - beforeCreate) / (24 * 60 * 60 * 1000);
+
+    expect(daysUntilRelease).toBeGreaterThanOrEqual(4.99);
+    expect(daysUntilRelease).toBeLessThanOrEqual(5.01);
+  });
+
+  it('keeps the default release window for non-engagement payments', async () => {
+    await service.createWinningWithPayments(
+      {
+        winnerId: 'user-1',
+        type: WinningsType.PAYMENT,
+        origin: 'Topcoder',
+        category: WinningsCategory.CONTEST_PAYMENT,
+        title: 'Contest payout',
+        description: 'Contest payment',
+        externalId: 'challenge-1',
+        details: [
+          {
+            totalAmount: 100,
+            grossAmount: 100,
+            installmentNumber: 1,
+            currency: PrizeType.USD,
+            billingAccount: '80001012',
+          },
+        ],
+      } as any,
+      'creator-1',
+    );
+
+    const persistedPayment =
+      tx.winnings.create.mock.calls[0][0].data.payment.create[0];
+
+    expect(persistedPayment.release_date).toBeUndefined();
+    expect(
+      Object.prototype.hasOwnProperty.call(persistedPayment, 'release_date'),
+    ).toBe(false);
+  });
+
   it('rejects engagement payment details that do not match the assignment billing account', async () => {
     await expect(
       service.createWinningWithPayments(

src/api/winnings/winnings.service.ts

@@ -69,13 +69,18 @@ interface ChallengeBillingAccountSyncPlan {
   status: string;
 }
 
+const DAY_IN_MS = 24 * 60 * 60 * 1000;
+
 /**
  * The winning service.
  */
 @Injectable()
 export class WinningsService {
   private readonly logger = new Logger(WinningsService.name);
 
+  private readonly engagementPaymentReleaseWindowDays =
+    ENV_CONFIG.ENGAGEMENT_PAYMENT_RELEASE_WINDOW_DAYS;
+
   /**
    * Constructs the admin winning service with the given dependencies.
    * @param prisma the prisma service.
@@ -276,6 +281,18 @@ export class WinningsService {
     return attributes?.[CHALLENGE_BUDGET_SYNC_SKIP_ATTRIBUTE] === true;
   }
 
+  /**
+   * Calculates the default release date for engagement payments.
+   *
+   * @returns A Date offset from now by the configured engagement release
+   * window.
+   */
+  private buildEngagementReleaseDate(): Date {
+    return new Date(
+      Date.now() + this.engagementPaymentReleaseWindowDays * DAY_IN_MS,
+    );
+  }
+
   /**
    * Normalizes the billing-account id from a challenge payment detail.
    *
@@ -1242,6 +1259,7 @@ export class WinningsService {
             | 'billing_account'
             | 'challenge_markup'
             | 'challenge_fee'
+            | 'release_date'
           >[],
         },
       };
@@ -1271,6 +1289,9 @@ export class WinningsService {
           tx,
         );
 
+      const engagementReleaseDate = isEngagementPayment
+        ? this.buildEngagementReleaseDate()
+        : undefined;
       for (const [detailIndex, detail] of (body.details || []).entries()) {
         const challengeFee = engagementConsumePlan
           ? this.calculateEngagementChallengeFee(
@@ -1294,6 +1315,9 @@ export class WinningsService {
             ? Prisma.Decimal(engagementConsumePlan.challengeMarkup)
             : null,
           challenge_fee: Prisma.Decimal(challengeFee),
+          ...(engagementReleaseDate !== undefined
+            ? { release_date: engagementReleaseDate }
+            : {}),
         };
 
         paymentModel.net_amount = Prisma.Decimal(detail.grossAmount);

src/config/config.env.ts

@@ -96,6 +96,12 @@ export class ConfigEnv {
   @IsString()
   TOPCODER_WALLET_URL = 'https://wallet.topcoder.com';
 
+  @IsInt()
+  @Min(3)
+  @Max(5)
+  @IsOptional()
+  ENGAGEMENT_PAYMENT_RELEASE_WINDOW_DAYS: number = 5;
+
   @IsInt()
   @Min(0)
   @Max(99)