add "Passive Mining" dialog on mining finished (#2595)

* Create 20260130124036_passive_mining.sql

* Update MinePanel.vue

* refactor autoextract tag

* Update 20260130124036_passive_mining.sql

* rename file

* add returrn type

* i18n

* use "Passive Mining" instead of "Auto Extract"

* use "Passive Mining" instead of "Auto Extract"

* prettier

Author: J43fura

backend/src/controllers/mining.controller.ts

@@ -2,10 +2,12 @@ import { User } from '@supabase/supabase-js';
 import { NextFunction, Request, Response } from 'express';
 import { decode } from 'jsonwebtoken';
 import ENV from '../config';
+import { Contacts } from '../db/interfaces/Contacts';
 import {
   MiningSources,
   OAuthMiningSourceProvider
 } from '../db/interfaces/MiningSources';
+import RedisQueuedEmailsCache from '../services/cache/redis/RedisQueuedEmailsCache';
 import { ContactFormat } from '../services/extractors/engines/FileImport';
 import TaskManagerFile from '../services/tasks-manager/TaskManagerFile';
 import TasksManager from '../services/tasks-manager/TasksManager';
@@ -15,7 +17,9 @@ import { ImapAuthError } from '../utils/errors';
 import validateType from '../utils/helpers/validation';
 import logger from '../utils/logger';
 import redis from '../utils/redis';
+import RedisStreamProducer from '../utils/streams/redis/RedisStreamProducer';
 import supabaseClient from '../utils/supabase';
+import { EmailVerificationData } from '../workers/email-verification/emailVerificationHandlers';
 import {
   generateErrorObjectFromImapError,
   getValidImapLogin,
@@ -27,10 +31,6 @@ import {
   getTokenWithScopeValidation,
   validateFileContactsData
 } from './mining.helpers';
-import RedisStreamProducer from '../utils/streams/redis/RedisStreamProducer';
-import { EmailVerificationData } from '../workers/email-verification/emailVerificationHandlers';
-import { Contacts } from '../db/interfaces/Contacts';
-import RedisQueuedEmailsCache from '../services/cache/redis/RedisQueuedEmailsCache';
 
 /**
  * Exchanges an OAuth authorization code for tokens and extracts user email
@@ -275,7 +275,8 @@ export default function initializeMiningController(
 
         const sources = sourcesData.map((s) => ({
           email: s.email,
-          type: s.type
+          type: s.type,
+          passive_mining: s.passive_mining
         }));
 
         return res.status(200).send({

backend/src/db/interfaces/MiningSources.ts

@@ -31,6 +31,7 @@ export interface MiningSources {
       email: string;
       type: MiningSourceType;
       credentials: ImapMiningSourceCredentials | OAuthMiningSourceCredentials;
+      passive_mining: boolean;
     }[]
   >;
   getCredentialsBySourceEmail(

backend/src/db/pg/PgMiningSources.ts

@@ -3,8 +3,8 @@ import { Logger } from 'winston';
 import {
   ImapMiningSourceCredentials,
   MiningSource,
-  MiningSourceType,
   MiningSources,
+  MiningSourceType,
   OAuthMiningSourceCredentials
 } from '../interfaces/MiningSources';
 
@@ -16,7 +16,7 @@ export default class PgMiningSources implements MiningSources {
     DO UPDATE SET credentials=excluded.credentials,type=excluded.type;`;
 
   private static readonly GET_BY_USER_SQL = `
-    SELECT email, type, pgp_sym_decrypt(credentials, $1) as credentials
+    SELECT email, type, pgp_sym_decrypt(credentials, $1) as credentials, passive_mining
     FROM private.mining_sources
     WHERE user_id = $2;`;
 
@@ -59,6 +59,7 @@ export default class PgMiningSources implements MiningSources {
       email: string;
       type: MiningSourceType;
       credentials: ImapMiningSourceCredentials | OAuthMiningSourceCredentials;
+      passive_mining: boolean;
     }[]
   > {
     try {
@@ -70,6 +71,7 @@ export default class PgMiningSources implements MiningSources {
         email: string;
         type: MiningSourceType;
         credentials: ImapMiningSourceCredentials | OAuthMiningSourceCredentials;
+        passive_mining: boolean;
       }[];
     } catch (error) {
       if (error instanceof Error) {

frontend/src/app.vue

@@ -59,13 +59,16 @@
       </div>
     </template>
   </Toast>
+
+  <PassiveMiningDialog />
 </template>
 
 <script setup lang="ts">
+import PassiveMiningDialog from '@/components/Mining/PassiveMiningDialog.vue';
 import { useIdle } from '@vueuse/core';
 import { reloadNuxtApp } from 'nuxt/app';
-import { signOutManually } from './utils/auth';
 import Normalizer from '~/utils/normalizer';
+import { signOutManually } from './utils/auth';
 
 const $user = useSupabaseUser();
 const $leadminerStore = useLeadminerStore();

frontend/src/components/Mining/PassiveMiningDialog.vue

@@ -0,0 +1,87 @@
+<template>
+  <Dialog
+    v-model:visible="$leadminerStore.passiveMiningDialog"
+    modal
+    :header="t('header')"
+    class="w-full sm:w-[35rem]"
+  >
+    <p>
+      {{ t('paragraph_1') }} <br />
+      {{ t('paragraph_2') }}
+    </p>
+    <template #footer>
+      <div class="flex flex-col sm:flex-row justify-between w-full gap-2">
+        <Button
+          :label="t('yes_enable')"
+          class="w-full sm:w-auto"
+          @click="enablePassiveMining()"
+        />
+        <Button
+          :label="$t('common.cancel')"
+          class="w-full sm:w-auto"
+          severity="secondary"
+          @click="closePassiveMiningDialog()"
+        />
+      </div>
+    </template>
+  </Dialog>
+</template>
+
+<script setup lang="ts">
+import type { MiningSource } from '~/types/mining';
+
+const miningSource = ref<MiningSource>();
+
+const $leadminerStore = useLeadminerStore();
+const $supabase = useSupabaseClient();
+
+const { t } = useI18n({
+  useScope: 'local',
+});
+
+watch(
+  () => $leadminerStore.passiveMiningDialog,
+  (newVal) => {
+    if (newVal) {
+      miningSource.value = $leadminerStore.activeMiningSource;
+    }
+  },
+);
+
+function closePassiveMiningDialog() {
+  $leadminerStore.passiveMiningDialog = false;
+}
+
+async function enablePassiveMining() {
+  if (miningSource.value) {
+    const { error } = await $supabase
+      // @ts-expect-error: Issue with nuxt/supabase
+      .schema('private')
+      .from('mining_sources')
+      .update({ passive_mining: true })
+      .match({ email: miningSource.value.email });
+
+    if (error) {
+      throw error;
+    }
+  }
+  closePassiveMiningDialog();
+}
+</script>
+
+<i18n lang="json">
+{
+  "en": {
+    "header": "Continuous Contact Extraction",
+    "paragraph_1": "Enable continuous contact extraction from future emails?",
+    "paragraph_2": "New contacts found in incoming emails will be automatically saved.",
+    "yes_enable": "Yes, enable"
+  },
+  "fr": {
+    "header": "Extraction continue des contacts",
+    "paragraph_1": "Activer l'extraction continue des contacts à partir des futurs e-mails ?",
+    "paragraph_2": "Les nouveaux contacts trouvés dans les e-mails entrants seront automatiquement enregistrés.",
+    "yes_enable": "Oui, activer"
+  }
+}
+</i18n>

frontend/src/components/Mining/StepperPanels/MinePanel.vue

@@ -97,7 +97,7 @@ const { t: $t } = useI18n({
 });
 
 const { miningSource } = defineProps<{
-  miningSource: MiningSource;
+  miningSource: MiningSource | undefined;
 }>();
 
 const sourceType = computed(() => $leadminerStore.miningType);
@@ -206,7 +206,7 @@ onMounted(async () => {
   } catch (error: any) {
     if (error?.statusCode === 502 || error?.statusCode === 503) {
       $stepper.prev();
-    } else {
+    } else if (miningSource) {
       $consentSidebar.show(miningSource.type, miningSource.email, '/mine');
     }
   }
@@ -249,10 +249,12 @@ watch(extractionFinished, async (finished) => {
     });
     $stepper.next();
   } else if (finished) {
+    if (miningSource && !miningSource.passive_mining)
+      $leadminerStore.passiveMiningDialog = true;
     $toast.add({
       severity: 'info',
       summary: t('mining_done'),
-      detail: totalExtractedNotificationMessage,
+      detail: totalExtractedNotificationMessage.value,
       group: 'achievement',
       life: 8000,
     });

frontend/src/stores/leadminer.ts

@@ -64,6 +64,8 @@ export const useLeadminerStore = defineStore('leadminer', () => {
       activeMiningTask.value || isLoadingBoxes.value || activeEnrichment.value,
   );
 
+  const passiveMiningDialog = ref(false);
+
   const miningStartedAndFinished = computed(() =>
     Boolean(miningStartedAt.value && miningCompleted.value),
   );
@@ -104,6 +106,8 @@ export const useLeadminerStore = defineStore('leadminer', () => {
 
     miningType.value = 'email';
 
+    passiveMiningDialog.value = false;
+
     errors.value = {};
   }
 
@@ -538,6 +542,7 @@ export const useLeadminerStore = defineStore('leadminer', () => {
     miningCompleted,
     activeMiningTask,
     activeTask,
+    passiveMiningDialog,
     miningStartedAndFinished,
     miningInterrupted,
     errors,

frontend/src/types/mining.ts

@@ -13,6 +13,7 @@ export interface MiningSource {
   type: MiningSourceType;
   email: string;
   isValid?: boolean;
+  passive_mining: boolean;
 }
 
 export interface MiningProgress {

frontend/src/utils/oauth.ts

@@ -24,7 +24,7 @@ export async function addOAuthAccount(
  * Redirects to the OAuth consent error page.
  * @returns {Promise<string>} The URL of the OAuth consent error page with provider and referrer parameters.
  */
-export async function redirectOauthConsentPage() {
+export async function redirectOauthConsentPage(): Promise<string> {
   const provider = useLeadminerStore().activeMiningSource?.type;
   const referrer = (await useSupabaseClient().auth.getSession()).data.session
     ?.user.id;

frontend/src/utils/sources.ts

@@ -17,7 +17,7 @@ export function updateMiningSourcesValidity(
    * @param {MiningSource} current - The current mining source being processed.
    * @returns {MiningSource} The updated mining source.
    */
-  function updateValidity(current: MiningSource) {
+  function updateValidity(current: MiningSource): MiningSource {
     if (current.email === activeMiningSource?.email) {
       current.isValid = isValid;
     }