add "EXPORT" as engagement_type and add service name (#2572)

* add new column "service" and add "EXPORT" to engagement_type

* use engagement_type "EXPORT" & insert service

* insert "service" for engagement "ENRICH" & update unittest

Author: malek10xdev

backend/src/controllers/contacts.controller.ts

@@ -1,7 +1,7 @@
 import { User } from '@supabase/supabase-js';
 import { NextFunction, Request, Response } from 'express';
 import { Contacts } from '../db/interfaces/Contacts';
-import { Contact } from '../db/types';
+import { Contact, ExportService } from '../db/types';
 import Billing from '../utils/billing-plugin';
 import { ExportOptions, ExportType } from '../services/export/types';
 import ExportFactory from '../services/export';
@@ -146,13 +146,15 @@ async function verifyCredits(
 
 async function registerAndDeductCredits(
   userId: string,
+  exportType: ExportType,
   availableUnits: number,
   contacts: Contacts,
   availableContacts: Contact[]
 ) {
   if (availableContacts.length) {
     await contacts.registerExportedContacts(
       availableContacts.map(({ email }) => email),
+      exportType as unknown as ExportService,
       userId
     );
     await Billing!.deductCustomerCredits(userId, availableUnits);
@@ -181,9 +183,10 @@ async function respondWithConfirmedContacts(
 
     await registerAndDeductCredits(
       userId,
+      exportType,
       availableUnits,
       contacts,
-      availableContacts
+      selectedContacts
     );
 
     return res

backend/src/db/interfaces/Contacts.ts

@@ -1,5 +1,11 @@
 import { Status } from '../../services/email-status/EmailStatusVerifier';
-import { Contact, EmailStatus, ExtractionResult, Tag } from '../types';
+import {
+  Contact,
+  EmailStatus,
+  ExportService,
+  ExtractionResult,
+  Tag
+} from '../types';
 
 export interface Contacts {
   create(
@@ -18,5 +24,9 @@ export interface Contacts {
   getUnverifiedContacts(userId: string, emails: string[]): Promise<Contact[]>;
   getExportedContacts(userId: string, emails?: string[]): Promise<Contact[]>;
   getNonExportedContacts(userId: string, emails?: string[]): Promise<Contact[]>;
-  registerExportedContacts(contactIds: string[], userId: string): Promise<void>;
+  registerExportedContacts(
+    contactIds: string[],
+    exportService: ExportService,
+    userId: string
+  ): Promise<void>;
 }

backend/src/db/pg/PgContacts.ts

@@ -8,6 +8,7 @@ import {
   Contact,
   EmailExtractionResult,
   EmailStatus,
+  ExportService,
   ExtractionResult,
   FileExtractionResult,
   Tag
@@ -26,7 +27,7 @@ export default class PgContacts implements Contacts {
       JOIN private.engagement e
         ON e.email = contacts.email
         AND e.user_id = $1
-        AND e.engagement_type = 'CSV'
+        AND e.engagement_type = 'EXPORT'
     `;
 
   private static readonly SELECT_NON_EXPORTED_CONTACTS = `
@@ -35,7 +36,7 @@ export default class PgContacts implements Contacts {
       LEFT JOIN private.engagement e
         ON e.email = contacts.email
         AND e.user_id = $1
-        AND e.engagement_type = 'CSV'
+        AND e.engagement_type = 'EXPORT'
     WHERE e.email IS NULL;
     `;
 
@@ -51,7 +52,7 @@ export default class PgContacts implements Contacts {
       JOIN private.engagement e
         ON e.email = contacts.email
         AND e.user_id = $1
-        AND e.engagement_type = 'CSV'
+        AND e.engagement_type = 'EXPORT'
     `;
 
   private static readonly SELECT_NON_EXPORTED_CONTACTS_BY_EMAILS = `
@@ -60,7 +61,7 @@ export default class PgContacts implements Contacts {
       LEFT JOIN private.engagement e
         ON e.email = contacts.email
         AND e.user_id = $1
-        AND e.engagement_type = 'CSV'
+        AND e.engagement_type = 'EXPORT'
     WHERE e.email IS NULL;
     `;
 
@@ -71,7 +72,7 @@ export default class PgContacts implements Contacts {
     WHERE persons.email = update.email AND persons.user_id = %L AND persons.status IS NULL`;
 
   private static readonly INSERT_EXPORTED_CONTACT =
-    'INSERT INTO private.engagement (user_id, email, engagement_type) VALUES %L ON  CONFLICT (email, user_id, engagement_type) DO NOTHING;';
+    'INSERT INTO private.engagement (user_id, email, engagement_type, service) VALUES %L ON  CONFLICT (email, user_id, engagement_type, service) DO NOTHING;';
 
   private static readonly INSERT_MESSAGE_SQL = `
     INSERT INTO private.messages("channel","folder_path","date","message_id","references","list_id","conversation","user_id") 
@@ -452,10 +453,11 @@ export default class PgContacts implements Contacts {
 
   async registerExportedContacts(
     contactIds: string[],
+    service: ExportService,
     userId: string
   ): Promise<void> {
     try {
-      const values = contactIds.map((id) => [userId, id, 'CSV']);
+      const values = contactIds.map((id) => [userId, id, 'EXPORT', service]);
       await this.pool.query(format(PgContacts.INSERT_EXPORTED_CONTACT, values));
     } catch (error) {
       this.logger.error(error);

backend/src/db/supabase/engagements.ts

@@ -9,17 +9,19 @@ export default class Engagements {
     private readonly logger: Logger
   ) {}
 
-  async register(userId: string, emails: string[], type: EngagementType) {
+  async register(
+    enriched: {
+      email: string;
+      user_id: string;
+      engagement_type: EngagementType;
+      service: string;
+    }[]
+  ) {
     try {
-      const data = emails.map((email) => ({
-        email,
-        user_id: userId,
-        engagement_type: type
-      }));
       const { error } = await this.client
         .schema('private')
         .from('engagement')
-        .upsert(data);
+        .upsert(enriched);
       if (error) throw error;
     } catch (err) {
       const message = (err as Error).message || 'Unexpected error.';

backend/src/db/supabase/enrichments.ts

@@ -153,18 +153,26 @@ export default class Enrichments {
     try {
       const task = this.ensureTask();
 
-      const enriched = result.map(({ data }) => data).flat();
+      const enriched = result
+        .map(({ data, engine }) => ({ data, engine }))
+        .flat();
       task.details.total_enriched += enriched.length;
+
       this.mergeTaskDetailsResult(result);
 
       await this.tasks.update(task);
 
       if (enriched.length) {
-        await this.updateContacts(enriched);
+        await this.updateContacts(enriched.map(({ data }) => data).flat());
         await this.engagements.register(
-          task.userId,
-          enriched.map((contact) => contact.email as string),
-          'ENRICH'
+          enriched.flatMap(({ data, engine }) =>
+            data.map((contact) => ({
+              email: contact.email as string,
+              user_id: task.userId,
+              engagement_type: 'ENRICH',
+              service: engine
+            }))
+          )
         );
       }
     } catch (err) {

backend/src/db/types.ts

@@ -190,3 +190,9 @@ export type Organization = {
   founder?: string;
   _domain?: string;
 };
+
+export enum ExportService {
+  CSV = 'csv',
+  VCARD = 'vcard',
+  GOOGLE_CONTACTS = 'google_contacts'
+}

backend/test/unit/database/enrichments.test.ts

@@ -217,11 +217,14 @@ describe('Enrichments Class', () => {
           name: 'hello'
         }
       ]);
-      expect(mockEngagements.register).toHaveBeenCalledWith(
-        userId,
-        ['test@example.com'],
-        'ENRICH'
-      );
+      expect(mockEngagements.register).toHaveBeenCalledWith([
+        {
+          email: 'test@example.com',
+          engagement_type: 'ENRICH',
+          service: 'test',
+          user_id: 'user-id'
+        }
+      ]);
       expect(task.details.total_enriched).toBe(1);
     });
   });

supabase/migrations/20260109124058_add_new_engagement_type_engagement_type_enum.sql

@@ -0,0 +1,28 @@
+ALTER TABLE private.engagement DROP CONSTRAINT engagement_pkey;
+ALTER TABLE private.engagement ADD COLUMN service TEXT;
+
+UPDATE private.engagement
+SET service = CASE 
+    WHEN engagement_type::text = 'ENRICH' THEN 'thedig'
+    WHEN engagement_type::text = 'CSV' THEN 'csv'
+END;
+
+
+ALTER TYPE private.engagement_type_enum RENAME TO engagement_type_enum_old;
+
+CREATE TYPE private.engagement_type_enum AS ENUM ('EXPORT', 'ENRICH');
+
+ALTER TABLE private.engagement 
+  ALTER COLUMN engagement_type TYPE private.engagement_type_enum 
+  USING (
+    CASE 
+      WHEN engagement_type::text = 'CSV' THEN 'EXPORT'::private.engagement_type_enum
+      ELSE engagement_type::text::private.engagement_type_enum
+    END
+  );
+
+DROP TYPE private.engagement_type_enum_old;
+
+ALTER TABLE private.engagement ALTER COLUMN service SET NOT NULL;
+ALTER TABLE private.engagement 
+ADD CONSTRAINT engagement_pkey PRIMARY KEY (email, user_id, engagement_type, service);