sfdx-hardis 6.4.4 → 6.5.0

package/lib/common/utils/limitUtils.js

@@ -0,0 +1,163 @@
+// External Libraries and Node.js Modules
+import c from 'chalk';
+// Salesforce Specific Libraries
+import { SfError } from '@salesforce/core';
+// Project Specific Utilities
+import { uxLog } from './index.js';
+// Optimized API Limits Management System
+export class ApiLimitsManager {
+    conn;
+    commandThis;
+    // Caching system
+    cachedLimits = null;
+    lastRefreshTime = 0;
+    cacheDuration = 5 * 60 * 1000; // 5 minutes
+    // Local tracking counters
+    localRestApiCalls = 0;
+    localBulkApiCalls = 0;
+    // Base limits from Salesforce
+    baseRestApiUsed = 0;
+    baseRestApiLimit = 0;
+    baseBulkApiUsed = 0;
+    baseBulkApiLimit = 0;
+    // Thresholds for API management
+    WARNING_THRESHOLD = 70; // Force refresh at 70%
+    DANGER_THRESHOLD = 80; // Stop operations at 80%
+    constructor(conn, commandThis) {
+        this.conn = conn;
+        this.commandThis = commandThis;
+    }
+    // Initialize the limits manager with initial API limits data
+    async initialize() {
+        await this.refreshLimits(); // Initial refresh
+    }
+    // Refresh limits from Salesforce
+    async refreshLimits() {
+        const now = Date.now();
+        try {
+            uxLog("log", this.commandThis, c.grey(`Refreshing API limits from Salesforce...`));
+            // Fetch fresh limits from Salesforce
+            this.cachedLimits = await this.conn.limits();
+            if (!this.cachedLimits) {
+                throw new SfError("Unable to retrieve API limit information from Salesforce org.");
+            }
+            // Extract REST API limits
+            if (!this.cachedLimits.DailyApiRequests) {
+                throw new SfError("DailyApiRequests limit not available from Salesforce org.");
+            }
+            this.baseRestApiUsed = this.cachedLimits.DailyApiRequests.Max - this.cachedLimits.DailyApiRequests.Remaining;
+            this.baseRestApiLimit = this.cachedLimits.DailyApiRequests.Max;
+            // Extract Bulk API v2 limits
+            if (!this.cachedLimits.DailyBulkV2QueryJobs) {
+                throw new SfError("DailyBulkV2QueryJobs limit not available from Salesforce org.");
+            }
+            this.baseBulkApiUsed = this.cachedLimits.DailyBulkV2QueryJobs.Max - this.cachedLimits.DailyBulkV2QueryJobs.Remaining;
+            this.baseBulkApiLimit = this.cachedLimits.DailyBulkV2QueryJobs.Max;
+            // Reset local counters on fresh data
+            this.localRestApiCalls = 0;
+            this.localBulkApiCalls = 0;
+            this.lastRefreshTime = now;
+            uxLog("success", this.commandThis, `API Limits refreshed - REST: ${this.baseRestApiUsed}/${this.baseRestApiLimit}, Bulk: ${this.baseBulkApiUsed}/${this.baseBulkApiLimit}`);
+        }
+        catch (error) {
+            if (error instanceof SfError)
+                throw error;
+            throw new SfError(`Failed to refresh API limits: ${error?.message || 'Unknown error'}`);
+        }
+    }
+    // Track API call and check if we need to wait or refresh
+    async trackApiCall(apiType) {
+        // Increment local counter
+        if (apiType === 'REST') {
+            this.localRestApiCalls++;
+        }
+        else {
+            this.localBulkApiCalls++;
+        }
+        // Check if cache has expired (5 minutes)
+        const now = Date.now();
+        const cacheAge = now - this.lastRefreshTime;
+        const cacheExpired = cacheAge >= this.cacheDuration;
+        if (cacheExpired) {
+            await this.refreshLimits(); // Use smart caching (no force)
+        }
+        // Calculate current usage after potential refresh
+        const currentRestUsage = this.baseRestApiUsed + this.localRestApiCalls;
+        const currentBulkUsage = this.baseBulkApiUsed + this.localBulkApiCalls;
+        const restPercent = (currentRestUsage / this.baseRestApiLimit) * 100;
+        const bulkPercent = (currentBulkUsage / this.baseBulkApiLimit) * 100;
+        // Check if we need to wait due to danger threshold
+        if (apiType === 'REST' && restPercent >= this.DANGER_THRESHOLD) {
+            await this.waitForLimitReset('REST', restPercent);
+        }
+        if (apiType === 'BULK' && bulkPercent >= this.DANGER_THRESHOLD) {
+            await this.waitForLimitReset('BULK', bulkPercent);
+        }
+    } // Wait for API limits to reset
+    async waitForLimitReset(apiType, currentPercent) {
+        const WAIT_INTERVAL = 300; // 5 minutes
+        const MAX_CYCLES = 12; // 1 hour max
+        uxLog("warning", this.commandThis, c.yellow(`${apiType} API at ${currentPercent.toFixed(1)}%. Waiting for limits to reset...`));
+        for (let cycle = 0; cycle < MAX_CYCLES; cycle++) {
+            uxLog("action", this.commandThis, c.cyan(`Waiting ${WAIT_INTERVAL}s for ${apiType} API reset (${cycle + 1}/${MAX_CYCLES})...`));
+            // Wait in 1-second intervals
+            for (let i = 0; i < WAIT_INTERVAL; i++) {
+                await new Promise(resolve => setTimeout(resolve, 1000));
+            }
+            // Check if limits have reset
+            await this.refreshLimits();
+            const currentUsage = apiType === 'REST'
+                ? this.baseRestApiUsed + this.localRestApiCalls
+                : this.baseBulkApiUsed + this.localBulkApiCalls;
+            const limit = apiType === 'REST' ? this.baseRestApiLimit : this.baseBulkApiLimit;
+            const percent = (currentUsage / limit) * 100;
+            if (percent < this.WARNING_THRESHOLD) {
+                uxLog("success", this.commandThis, c.green(`${apiType} API usage dropped to ${percent.toFixed(1)}%. Resuming operations.`));
+                return;
+            }
+        }
+        throw new SfError(`${apiType} API limits did not reset after ${MAX_CYCLES * WAIT_INTERVAL / 60} minutes.`);
+    }
+    // Get current API usage status for display
+    getUsageStatus() {
+        const currentRestUsage = this.baseRestApiUsed + this.localRestApiCalls;
+        const currentBulkUsage = this.baseBulkApiUsed + this.localBulkApiCalls;
+        const restPercent = (currentRestUsage / this.baseRestApiLimit) * 100;
+        const bulkPercent = (currentBulkUsage / this.baseBulkApiLimit) * 100;
+        return {
+            rest: restPercent,
+            bulk: bulkPercent,
+            message: `[REST: ${restPercent.toFixed(1)}% | Bulk: ${bulkPercent.toFixed(1)}%]`
+        };
+    }
+    // Get current usage for API consumption estimation
+    getCurrentUsage() {
+        const currentRestUsage = this.baseRestApiUsed + this.localRestApiCalls;
+        const currentBulkUsage = this.baseBulkApiUsed + this.localBulkApiCalls;
+        return {
+            restUsed: currentRestUsage,
+            restLimit: this.baseRestApiLimit,
+            bulkUsed: currentBulkUsage,
+            bulkLimit: this.baseBulkApiLimit,
+            restRemaining: this.baseRestApiLimit - currentRestUsage,
+            bulkRemaining: this.baseBulkApiLimit - currentBulkUsage
+        };
+    }
+    // Get final usage for reporting (forces a fresh refresh)
+    async getFinalUsage() {
+        await this.refreshLimits(); // Get fresh data
+        // Try to get fresh limits from Salesforce
+        const currentLimits = this.cachedLimits;
+        const restUsed = currentLimits.DailyApiRequests.Max - currentLimits.DailyApiRequests.Remaining;
+        const bulkUsed = currentLimits.DailyBulkV2QueryJobs.Max - currentLimits.DailyBulkV2QueryJobs.Remaining;
+        return {
+            restUsed: restUsed,
+            restLimit: currentLimits.DailyApiRequests.Max,
+            restRemaining: currentLimits.DailyApiRequests.Remaining,
+            bulkUsed: bulkUsed,
+            bulkLimit: currentLimits.DailyBulkV2QueryJobs.Max,
+            bulkRemaining: currentLimits.DailyBulkV2QueryJobs.Remaining
+        };
+    }
+}
+//# sourceMappingURL=limitUtils.js.map

package/lib/common/utils/limitUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"limitUtils.js","sourceRoot":"","sources":["../../../src/common/utils/limitUtils.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC,OAAO,CAAC,MAAM,OAAO,CAAC;AAEtB,gCAAgC;AAChC,OAAO,EAAc,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEvD,6BAA6B;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC,yCAAyC;AACzC,MAAM,OAAO,gBAAgB;IACnB,IAAI,CAAa;IACjB,WAAW,CAAM;IAEzB,iBAAiB;IACT,YAAY,GAAQ,IAAI,CAAC;IACzB,eAAe,GAAW,CAAC,CAAC;IAC5B,aAAa,GAAW,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,YAAY;IAE3D,0BAA0B;IAClB,iBAAiB,GAAW,CAAC,CAAC;IAC9B,iBAAiB,GAAW,CAAC,CAAC;IAEtC,8BAA8B;IACtB,eAAe,GAAW,CAAC,CAAC;IAC5B,gBAAgB,GAAW,CAAC,CAAC;IAC7B,eAAe,GAAW,CAAC,CAAC;IAC5B,gBAAgB,GAAW,CAAC,CAAC;IAErC,gCAAgC;IACf,iBAAiB,GAAG,EAAE,CAAC,CAAC,uBAAuB;IAC/C,gBAAgB,GAAG,EAAE,CAAC,CAAE,yBAAyB;IAElE,YAAY,IAAgB,EAAE,WAAgB;QAC5C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,6DAA6D;IAC7D,KAAK,CAAC,UAAU;QACd,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,kBAAkB;IAChD,CAAC;IAED,iCAAiC;IACzB,KAAK,CAAC,aAAa;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,IAAI,CAAC;YACH,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC,CAAC;YAEnF,qCAAqC;YACrC,IAAI,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAE7C,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;gBACvB,MAAM,IAAI,OAAO,CAAC,+DAA+D,CAAC,CAAC;YACrF,CAAC;YAED,0BAA0B;YAC1B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,CAAC;gBACxC,MAAM,IAAI,OAAO,CAAC,2DAA2D,CAAC,CAAC;YACjF,CAAC;YAED,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAC7G,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,GAAG,CAAC;YAE/D,6BAA6B;YAC7B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,CAAC;gBAC5C,MAAM,IAAI,OAAO,CAAC,+DAA+D,CAAC,CAAC;YACrF,CAAC;YAED,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,SAAS,CAAC;YACrH,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,GAAG,CAAC;YAEnE,qCAAqC;YACrC,IAAI,CAAC,iBAAiB,GAAG,CAAC,CAAC;YAC3B,IAAI,CAAC,iBAAiB,GAAG,CAAC,CAAC;YAC3B,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC;YAE3B,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,EAC/B,gCAAgC,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,gBAAgB,WAAW,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,gBAAgB,EAAE,CACxI,CAAC;QAEJ,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,IAAI,KAAK,YAAY,OAAO;gBAAE,MAAM,KAAK,CAAC;YAC1C,MAAM,IAAI,OAAO,CAAC,iCAAiC,KAAK,EAAE,OAAO,IAAI,eAAe,EAAE,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IAED,yDAAyD;IACzD,KAAK,CAAC,YAAY,CAAC,OAAwB;QACzC,0BAA0B;QAC1B,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;YACvB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;QAED,yCAAyC;QACzC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,QAAQ,GAAG,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC;QAC5C,MAAM,YAAY,GAAG,QAAQ,IAAI,IAAI,CAAC,aAAa,CAAC;QAEpD,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,+BAA+B;QAC7D,CAAC;QAED,kDAAkD;QAClD,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACvE,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACvE,MAAM,WAAW,GAAG,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,GAAG,CAAC;QACrE,MAAM,WAAW,GAAG,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,GAAG,CAAC;QAErE,mDAAmD;QACnD,IAAI,OAAO,KAAK,MAAM,IAAI,WAAW,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC/D,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,OAAO,KAAK,MAAM,IAAI,WAAW,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC/D,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACpD,CAAC;IACH,CAAC,CAAE,+BAA+B;IAC1B,KAAK,CAAC,iBAAiB,CAAC,OAAwB,EAAE,cAAsB;QAC9E,MAAM,aAAa,GAAG,GAAG,CAAC,CAAC,YAAY;QACvC,MAAM,UAAU,GAAG,EAAE,CAAC,CAAC,aAAa;QAEpC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,EAC/B,CAAC,CAAC,MAAM,CAAC,GAAG,OAAO,WAAW,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,mCAAmC,CAAC,CAC5F,CAAC;QAEF,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,UAAU,EAAE,KAAK,EAAE,EAAE,CAAC;YAChD,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,EAC9B,CAAC,CAAC,IAAI,CAAC,WAAW,aAAa,SAAS,OAAO,eAAe,KAAK,GAAG,CAAC,IAAI,UAAU,MAAM,CAAC,CAC7F,CAAC;YAEF,6BAA6B;YAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;gBACvC,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;YAC1D,CAAC;YAED,6BAA6B;YAC7B,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAE3B,MAAM,YAAY,GAAG,OAAO,KAAK,MAAM;gBACrC,CAAC,CAAC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB;gBAC/C,CAAC,CAAC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC;YAClD,MAAM,KAAK,GAAG,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACjF,MAAM,OAAO,GAAG,CAAC,YAAY,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC;YAE7C,IAAI,OAAO,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACrC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,EAC/B,CAAC,CAAC,KAAK,CAAC,GAAG,OAAO,yBAAyB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,yBAAyB,CAAC,CACxF,CAAC;gBACF,OAAO;YACT,CAAC;QACH,CAAC;QAED,MAAM,IAAI,OAAO,CAAC,GAAG,OAAO,mCAAmC,UAAU,GAAG,aAAa,GAAG,EAAE,WAAW,CAAC,CAAC;IAC7G,CAAC;IAED,2CAA2C;IAC3C,cAAc;QACZ,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACvE,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEvE,MAAM,WAAW,GAAG,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,GAAG,CAAC;QACrE,MAAM,WAAW,GAAG,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,GAAG,CAAC;QAErE,OAAO;YACL,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE,UAAU,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;SACjF,CAAC;IACJ,CAAC;IAED,mDAAmD;IACnD,eAAe;QAQb,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACvE,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEvE,OAAO;YACL,QAAQ,EAAE,gBAAgB;YAC1B,SAAS,EAAE,IAAI,CAAC,gBAAgB;YAChC,QAAQ,EAAE,gBAAgB;YAC1B,SAAS,EAAE,IAAI,CAAC,gBAAgB;YAChC,aAAa,EAAE,IAAI,CAAC,gBAAgB,GAAG,gBAAgB;YACvD,aAAa,EAAE,IAAI,CAAC,gBAAgB,GAAG,gBAAgB;SACxD,CAAC;IACJ,CAAC;IAED,yDAAyD;IACzD,KAAK,CAAC,aAAa;QAQjB,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,iBAAiB;QAC7C,0CAA0C;QAC1C,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC;QACxC,MAAM,QAAQ,GAAG,aAAa,CAAC,gBAAgB,CAAC,GAAG,GAAG,aAAa,CAAC,gBAAgB,CAAC,SAAS,CAAC;QAC/F,MAAM,QAAQ,GAAG,aAAa,CAAC,oBAAoB,CAAC,GAAG,GAAG,aAAa,CAAC,oBAAoB,CAAC,SAAS,CAAC;QAEvG,OAAO;YACL,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,aAAa,CAAC,gBAAgB,CAAC,GAAG;YAC7C,aAAa,EAAE,aAAa,CAAC,gBAAgB,CAAC,SAAS;YACvD,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,aAAa,CAAC,oBAAoB,CAAC,GAAG;YACjD,aAAa,EAAE,aAAa,CAAC,oBAAoB,CAAC,SAAS;SAC5D,CAAC;IACJ,CAAC;CACF"}