Bulk enrichment error messages (#477)

Author: joanagmaia

backend/src/services/premium/enrichment/memberEnrichmentService.ts

@@ -163,37 +163,44 @@ export default class MemberEnrichmentService extends LoggingBase {
           continue
         } else {
           this.log.error(`Failed to enrich member ${memberId}`, err)
-          apiPubSubEmitter.emit(
-            'user',
-            new ApiWebsocketMessage(
-              'bulk-enrichment',
-              JSON.stringify({
-                enrichedMembers,
-                tenantId: this.options.currentTenant.id,
-                success: false,
-              }),
-              undefined,
-              this.options.currentTenant.id,
-            ),
-          )
         }
       }
     }
 
-    // Send websocket message to frontend
-    apiPubSubEmitter.emit(
-      'user',
-      new ApiWebsocketMessage(
-        'bulk-enrichment',
-        JSON.stringify({
-          enrichedMembers,
-          tenantId: this.options.currentTenant.id,
-          success: true,
-        }),
-        undefined,
-        this.options.currentTenant.id,
-      ),
-    )
+    // Send websocket messages to frontend after all requests have been made
+    // Only send error message if all enrichments failed
+    if (!enrichedMembers) {
+      apiPubSubEmitter.emit(
+        'user',
+        new ApiWebsocketMessage(
+          'bulk-enrichment',
+          JSON.stringify({
+            failedEnrichedMembers: memberIds.length - enrichedMembers,
+            enrichedMembers,
+            tenantId: this.options.currentTenant.id,
+            success: false,
+          }),
+          undefined,
+          this.options.currentTenant.id,
+        ),
+      )
+    }
+    // Send success message if there were enrichedMembers
+    else {
+      apiPubSubEmitter.emit(
+        'user',
+        new ApiWebsocketMessage(
+          'bulk-enrichment',
+          JSON.stringify({
+            enrichedMembers,
+            tenantId: this.options.currentTenant.id,
+            success: true,
+          }),
+          undefined,
+          this.options.currentTenant.id,
+        ),
+      )
+    }
 
     return { enrichedMemberCount: enrichedMembers }
   }

frontend/src/modules/auth/auth-socket.js

@@ -8,6 +8,7 @@ import {
   showEnrichmentSuccessMessage,
   getEnrichmentMax
 } from '@/modules/member/member-enrichment'
+import pluralize from 'pluralize'
 
 let socketIoClient
 
@@ -79,16 +80,20 @@ export const connectSocket = (token) => {
     if (!data.success) {
       Message.closeAll()
       Message.error(
-        `Bulk enrichment failed. We managed to enrich ${data.enrichedMembers} members.`
+        `Failed to enrich ${pluralize(
+          'member',
+          data.failedEnrichedMembers,
+          true
+        )}.`
       )
     } else {
-      Message.closeAll()
       const planEnrichmentCountMax = getEnrichmentMax(
         updatedTenant.tenant.plan
       )
 
       // Show enrichment success message
       showEnrichmentSuccessMessage({
+        enrichedMembers: data.enrichedMembers,
         memberEnrichmentCount:
           updatedTenant.tenant.memberEnrichmentCount,
         planEnrichmentCountMax,

frontend/src/modules/member/components/list/member-list-toolbar.vue

@@ -22,13 +22,15 @@
           v-if="areSelectedMembersNotEnriched"
           placement="top"
           content="Selected members lack an associated GitHub profile or Email"
-          :disabled="elegibleEnrichmentMembers.length"
+          :disabled="elegibleEnrichmentMembersIds.length"
           popper-class="max-w-[260px]"
         >
           <span>
             <el-dropdown-item
               command="enrichMember"
-              :disabled="!elegibleEnrichmentMembers.length"
+              :disabled="
+                !elegibleEnrichmentMembersIds.length
+              "
               class="mb-1"
             >
               <app-svg
@@ -113,11 +115,14 @@ export default {
         ).edit === false
       )
     },
-    elegibleEnrichmentMembers() {
-      return this.selectedRows.filter(
-        (r) =>
-          (r.username?.github || r.email) && !r.lastEnriched
-      )
+    elegibleEnrichmentMembersIds() {
+      return this.selectedRows
+        .filter(
+          (r) =>
+            (r.username?.github || r.email) &&
+            !r.lastEnriched
+        )
+        .map((item) => item.id)
     },
     selectedIds() {
       return this.selectedRows
@@ -151,10 +156,12 @@ export default {
       } else if (command === 'enrichMember') {
         // All members are elegible for enrichment
         if (
-          this.elegibleEnrichmentMembers.length ===
+          this.elegibleEnrichmentMembersIds.length ===
           this.selectedIds.length
         ) {
-          await this.doBulkEnrich(this.selectedIds)
+          await this.doBulkEnrich(
+            this.elegibleEnrichmentMembersIds
+          )
         } else {
           // Only a few members are elegible for enrichment
           try {
@@ -166,14 +173,16 @@ export default {
                 'Member enrichment requires an associated GitHub profile or Email. If you proceed, only the members who fulfill this requirement will be enriched and counted towards your quota.',
               confirmButtonText: `Proceed with enrichment (${pluralize(
                 'member',
-                this.elegibleEnrichmentMembers.length,
+                this.elegibleEnrichmentMembersIds.length,
                 true
               )})`,
               cancelButtonText: 'Cancel',
               icon: 'ri-alert-line'
             })
 
-            await this.doBulkEnrich(this.selectedIds)
+            await this.doBulkEnrich(
+              this.elegibleEnrichmentMembersIds
+            )
           } catch (error) {
             // no
           }

frontend/src/modules/member/member-enrichment.js

@@ -4,6 +4,7 @@ import ConfirmDialog from '@/shared/dialog/confirm-dialog'
 import { formatNumber } from '@/utils/number'
 import { h } from 'vue'
 import Message from '@/shared/message/message'
+import pluralize from 'pluralize'
 
 const growthEnrichmentMax = 1000
 const essentialEnrichmentMax = 5
@@ -77,6 +78,7 @@ export const checkEnrichmentPlan = ({
 }
 
 export const showEnrichmentSuccessMessage = ({
+  enrichedMembers = 1,
   memberEnrichmentCount,
   planEnrichmentCountMax,
   plan,
@@ -112,9 +114,11 @@ export const showEnrichmentSuccessMessage = ({
 
   Message.closeAll()
   Message.success(message, {
-    title: `Successfully enriched ${
-      isBulk ? 'members' : 'member'
-    }`
+    title: `Successfully enriched ${pluralize(
+      'member',
+      enrichedMembers,
+      isBulk
+    )}`
   })
 }