fix(providers): Sparkpost provider bugs (#3736)

* fix: sparkpost provider region issue

* fix(provider): reuse region field for sparkpost

* feat: render sparkpost region as dropdown

* feat(providers): transform legacy region values for sparkpost

---------

Co-authored-by: Dima Grossman <[email protected]>

apps/api/src/app/integrations/usecases/check-integration/check-integration.usecase.ts

@@ -1,7 +1,7 @@
 import { BadRequestException, Injectable, NotFoundException } from '@nestjs/common';
 import { CheckIntegrationEMail } from './check-integration-email.usecase';
 import { CheckIntegrationCommand } from './check-integration.command';
-import { ChannelTypeEnum, ICredentialsDto } from '@novu/shared';
+import { ChannelTypeEnum } from '@novu/shared';
 
 @Injectable()
 export class CheckIntegration {

apps/web/src/pages/integrations/components/IntegrationInput.tsx

@@ -2,7 +2,7 @@ import { useMantineTheme } from '@mantine/core';
 import styled from '@emotion/styled';
 import { CredentialsKeyEnum, IConfigCredentials, secureCredentials } from '@novu/shared';
 
-import { Input, PasswordInput, Switch, Textarea, Text, Tooltip } from '@novu/design-system';
+import { Input, PasswordInput, Switch, Textarea, Text, Tooltip, Select } from '@novu/design-system';
 import { IntegrationSecretTextarea } from './IntegrationSecretTextarea';
 
 const SwitchWrapper = styled.div`
@@ -67,6 +67,23 @@ export function IntegrationInput({
     );
   }
 
+  if (credential.type === 'dropdown') {
+    return (
+      <Select
+        {...field}
+        label={credential.displayName}
+        required={credential.required}
+        description={credential.description}
+        data-test-id={credential.key}
+        error={errors[credential.key]?.message}
+        data={credential.dropdown?.map((item) => ({
+          label: item.name,
+          value: item.value,
+        }))}
+      />
+    );
+  }
+
   if (credential.type === 'switch') {
     let switchComponent = (
       <Switch

libs/shared/src/consts/providers/credentials/provider-credentials.ts

@@ -249,10 +249,15 @@ export const sparkpostConfig: IConfigCredentials[] = [
   },
   {
     key: CredentialsKeyEnum.Region,
-    displayName: 'EU',
-    description: 'Use `eu` if your account is registered to SparkPost EU',
-    type: 'boolean',
+    displayName: 'Region',
+    description: 'Use EU if your account is registered to SparkPost EU',
+    type: 'dropdown',
     required: false,
+    value: null,
+    dropdown: [
+      { name: 'Default', value: null },
+      { name: 'EU', value: 'eu' },
+    ],
   },
   ...mailConfigBase,
 ];

libs/shared/src/consts/providers/provider.interface.ts

@@ -24,6 +24,10 @@ export interface IConfigCredentials {
     text: string;
     when?: boolean;
   };
+  dropdown?: Array<{
+    name: string;
+    value: string | null;
+  }>;
 }
 
 export interface ILogoFileName {

packages/application-generic/src/factories/mail/handlers/sparkpost.handler.ts

@@ -11,14 +11,10 @@ export class SparkPostHandler extends BaseHandler {
     const config = {
       from: from as string,
       apiKey: credentials.apiKey as string,
-      eu: false,
+      region: credentials.region as string,
       senderName: credentials.senderName as string,
     };
 
-    if (credentials.region?.toLowerCase() === 'eu') {
-      config.eu = true;
-    }
-
     this.provider = new SparkPostEmailProvider(config);
   }
 }

providers/sparkpost/src/lib/sparkpost.provider.spec.ts

@@ -3,7 +3,7 @@ import { SparkPostEmailProvider } from './sparkpost.provider';
 const mockConfig = {
   apiKey:
     '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',
-  eu: false,
+  region: undefined,
   from: '[email protected]',
   senderName: 'test',
 };

providers/sparkpost/src/lib/sparkpost.provider.ts

@@ -17,13 +17,14 @@ export class SparkPostEmailProvider implements IEmailProvider {
   constructor(
     private config: {
       apiKey: string;
-      eu: boolean;
+      region: string;
       from: string;
       senderName: string;
     }
   ) {
+    const endpoint = this.getEndpoint(config.region);
     this.client = new SparkPost(config.apiKey, {
-      endpoint: config.eu ? 'https://api.eu.sparkpost.com:443' : undefined,
+      endpoint,
     });
   }
 
@@ -41,7 +42,7 @@ export class SparkPostEmailProvider implements IEmailProvider {
 
     const files: Array<{ name: string; type: string; data: string }> = [];
 
-    attachments.forEach((attachment) => {
+    attachments?.forEach((attachment) => {
       files.push({
         name: attachment.name || randomUUID(),
         type: attachment.mime,
@@ -62,6 +63,7 @@ export class SparkPostEmailProvider implements IEmailProvider {
 
     return {
       id: sent.results.id,
+      date: new Date().toISOString(),
     };
   }
 
@@ -90,4 +92,21 @@ export class SparkPostEmailProvider implements IEmailProvider {
       };
     }
   }
+
+  private transformLegacyRegion(region: string | boolean) {
+    if (region === 'true' || region === true) return 'eu';
+
+    return region;
+  }
+
+  private getEndpoint(_region: string) {
+    const region = this.transformLegacyRegion(_region);
+
+    switch (region) {
+      case 'eu':
+        return 'https://api.eu.sparkpost.com:443';
+      default:
+        return;
+    }
+  }
 }