Google contacts batch sync (#2567)

* add quota limiter with conf set from  env vars

* add: respect quota limits and use batch sync

* update, refactor unit tests

* remove non-null assertions

Author: malek10xdev

.env.docker

@@ -122,3 +122,20 @@ AZURE_CLIENT_ID = your_azure_client_id # ( REQUIRED ) Azure client ID
 AZURE_SECRET = your_azure_client_secret # ( REQUIRED ) Azure secret
 
 
+# ==============| GOOGLE CONTACTS Sync |============= #
+
+# Critical Read Operations (API Limit: 90/min)
+GOOGLE_CONTACTS_CRITICAL_READ_REQUESTS = 80   # ( OPTIONAL ) Number of requests allowed per interval
+GOOGLE_CONTACTS_CRITICAL_READ_INTERVAL = 60   # ( OPTIONAL ) Rate limit interval in seconds
+
+# Critical Write Operations (API Limit: 90/min)
+GOOGLE_CONTACTS_CRITICAL_WRITE_REQUESTS = 80  # ( OPTIONAL ) Number of requests allowed per interval
+GOOGLE_CONTACTS_CRITICAL_WRITE_INTERVAL = 60  # ( OPTIONAL ) Rate limit interval in seconds
+
+# Read Operations - Groups (API Limit: 120/min)
+GOOGLE_CONTACTS_READ_REQUESTS = 110           # ( OPTIONAL ) Number of requests allowed per interval
+GOOGLE_CONTACTS_READ_INTERVAL = 60            # ( OPTIONAL ) Rate limit interval in seconds
+
+# Write Operations - Groups/Delete (API Limit: 90/min)
+GOOGLE_CONTACTS_WRITE_REQUESTS = 80           # ( OPTIONAL ) Number of requests allowed per interval
+GOOGLE_CONTACTS_WRITE_INTERVAL = 60           # ( OPTIONAL ) Rate limit interval in seconds

backend/.env.dev

@@ -124,3 +124,21 @@ ENRICH_LAYER_API_KEY = test-api-key
 # ==============| THIRD-PARTY - IMAP EMAIL FETCHING SERVICE |============= #
 EMAIL_FETCHING_SERVICE_URL = http://localhost:8084
 EMAIL_FETCHING_SERVICE_API_TOKEN = "test-key"
+
+# ==============| GOOGLE CONTACTS Sync |============= #
+
+# Critical Read Operations (API Limit: 90/min)
+GOOGLE_CONTACTS_CRITICAL_READ_REQUESTS = 80   # ( OPTIONAL ) Number of requests allowed per interval
+GOOGLE_CONTACTS_CRITICAL_READ_INTERVAL = 60   # ( OPTIONAL ) Rate limit interval in seconds
+
+# Critical Write Operations (API Limit: 90/min)
+GOOGLE_CONTACTS_CRITICAL_WRITE_REQUESTS = 80  # ( OPTIONAL ) Number of requests allowed per interval
+GOOGLE_CONTACTS_CRITICAL_WRITE_INTERVAL = 60  # ( OPTIONAL ) Rate limit interval in seconds
+
+# Read Operations - Groups (API Limit: 120/min)
+GOOGLE_CONTACTS_READ_REQUESTS = 110           # ( OPTIONAL ) Number of requests allowed per interval
+GOOGLE_CONTACTS_READ_INTERVAL = 60            # ( OPTIONAL ) Rate limit interval in seconds
+
+# Write Operations - Groups/Delete (API Limit: 90/min)
+GOOGLE_CONTACTS_WRITE_REQUESTS = 80           # ( OPTIONAL ) Number of requests allowed per interval
+GOOGLE_CONTACTS_WRITE_INTERVAL = 60           # ( OPTIONAL ) Rate limit interval in seconds

backend/src/config/schema.ts

@@ -117,6 +117,31 @@ const schema = z.object({
   ENRICH_LAYER_URL: z.string().min(1).optional(),
   ENRICH_LAYER_API_KEY: z.string().min(1).optional(),
 
+  /** GOOGLE CONTACTS SYNC */
+  GOOGLE_CONTACTS_CRITICAL_READ_REQUESTS: z.coerce
+    .number()
+    .positive()
+    .default(80),
+  GOOGLE_CONTACTS_CRITICAL_READ_INTERVAL: z.coerce
+    .number()
+    .positive()
+    .default(60),
+
+  GOOGLE_CONTACTS_CRITICAL_WRITE_REQUESTS: z.coerce
+    .number()
+    .positive()
+    .default(80),
+  GOOGLE_CONTACTS_CRITICAL_WRITE_INTERVAL: z.coerce
+    .number()
+    .positive()
+    .default(60),
+
+  GOOGLE_CONTACTS_READ_REQUESTS: z.coerce.number().positive().default(110),
+  GOOGLE_CONTACTS_READ_INTERVAL: z.coerce.number().positive().default(60),
+
+  GOOGLE_CONTACTS_WRITE_REQUESTS: z.coerce.number().positive().default(80),
+  GOOGLE_CONTACTS_WRITE_INTERVAL: z.coerce.number().positive().default(60),
+
   NODE_ENV: z.enum(['development', 'production', 'test']).default('production')
 });
 

backend/src/controllers/contacts.controller.ts

@@ -32,6 +32,7 @@ async function validateRequest(
   }
 
   let googleContactsOptions: ExportOptions['googleContactsOptions'] = {
+    userId: user.id,
     accessToken: undefined,
     refreshToken: undefined,
     updateEmptyFieldsOnly
@@ -44,9 +45,9 @@ async function validateRequest(
     )) as OAuthMiningSourceCredentials;
 
     googleContactsOptions = {
+      ...googleContactsOptions,
       accessToken: oauthCredentials?.accessToken,
-      refreshToken: oauthCredentials?.refreshToken,
-      updateEmptyFieldsOnly
+      refreshToken: oauthCredentials?.refreshToken
     };
   }