Salesforce Performance Tuning

Overview

Optimize Salesforce API performance with caching, batching, and connection pooling.

Prerequisites

• Salesforce SDK installed
• Understanding of async patterns
• Redis or in-memory cache available (optional)
• Performance monitoring in place

Latency Benchmarks

Caching Strategy

Response Caching

import { LRUCache } from 'lru-cache';

const cache = new LRUCache<string, any>({
  max: 1000,
  ttl: 60000, // 1 minute
  updateAgeOnGet: true,
});

async function cachedSalesforceRequest<T>(
  key: string,
  fetcher: () => Promise<T>,
  ttl?: number
): Promise<T> {
  const cached = cache.get(key);
  if (cached) return cached as T;

  const result = await fetcher();
  cache.set(key, result, { ttl });
  return result;
}

Redis Caching (Distributed)

import Redis from 'ioredis';

const redis = new Redis(process.env.REDIS_URL);

async function cachedWithRedis<T>(
  key: string,
  fetcher: () => Promise<T>,
  ttlSeconds = 60
): Promise<T> {
  const cached = await redis.get(key);
  if (cached) return JSON.parse(cached);

  const result = await fetcher();
  await redis.setex(key, ttlSeconds, JSON.stringify(result));
  return result;
}

Request Batching

import DataLoader from 'dataloader';

const salesforceLoader = new DataLoader<string, any>(
  async (ids) => {
    // Batch fetch from Salesforce
    const results = await salesforceClient.batchGet(ids);
    return ids.map(id => results.find(r => r.id === id) || null);
  },
  {
    maxBatchSize: 100,
    batchScheduleFn: callback => setTimeout(callback, 10),
  }
);

// Usage - automatically batched
const [item1, item2, item3] = await Promise.all([
  salesforceLoader.load('id-1'),
  salesforceLoader.load('id-2'),
  salesforceLoader.load('id-3'),
]);

Connection Optimization

import { Agent } from 'https';

// Keep-alive connection pooling
const agent = new Agent({
  keepAlive: true,
  maxSockets: 10,
  maxFreeSockets: 5,
  timeout: 30000,
});

const client = new SalesforceClient({
  apiKey: process.env.SALESFORCE_API_KEY!,
  httpAgent: agent,
});

Pagination Optimization

async function* paginatedSalesforceList<T>(
  fetcher: (cursor?: string) => Promise<{ data: T[]; nextCurso

Salesforce Policy & Guardrails

Overview

Automated policy enforcement and guardrails for Salesforce integrations.

Prerequisites

• ESLint configured in project
• Pre-commit hooks infrastructure
• CI/CD pipeline with policy checks
• TypeScript for type enforcement

ESLint Rules

Custom Salesforce Plugin

// eslint-plugin-salesforce/rules/no-hardcoded-keys.js
module.exports = {
  meta: {
    type: 'problem',
    docs: {
      description: 'Disallow hardcoded Salesforce API keys',
    },
    fixable: 'code',
  },
  create(context) {
    return {
      Literal(node) {
        if (typeof node.value === 'string') {
          if (node.value.match(/^sk_(live|test)_[a-zA-Z0-9]{24,}/)) {
            context.report({
              node,
              message: 'Hardcoded Salesforce API key detected',
            });
          }
        }
      },
    };
  },
};

ESLint Configuration

// .eslintrc.js
module.exports = {
  plugins: ['salesforce'],
  rules: {
    'salesforce/no-hardcoded-keys': 'error',
    'salesforce/require-error-handling': 'warn',
    'salesforce/use-typed-client': 'warn',
  },
};

Pre-Commit Hooks

# .pre-commit-config.yaml
repos:
  - repo: local
    hooks:
      - id: salesforce-secrets-check
        name: Check for Salesforce secrets
        entry: bash -c 'git diff --cached --name-only | xargs grep -l "sk_live_" && exit 1 || exit 0'
        language: system
        pass_filenames: false

      - id: salesforce-config-validate
        name: Validate Salesforce configuration
        entry: node scripts/validate-salesforce-config.js
        language: node
        files: '\.salesforce\.json$'

TypeScript Strict Patterns

// Enforce typed configuration
interface SalesforceStrictConfig {
  apiKey: string;  // Required
  environment: 'development' | 'staging' | 'production';  // Enum
  timeout: number;  // Required number, not optional
  retries: number;
}

// Disallow any in Salesforce code
// @ts-expect-error - Using any is forbidden
const client = new Client({ apiKey: any });

// Prefer this
const client = new SalesforceClient(config satisfies SalesforceStrictConfig);

Architecture Decision Records

ADR Template

# ADR-001: Salesforce Client Initialization

## Status
Accepted

## Context
We need to decide how to initialize the Salesforce client across our application.

## Decision
We will use the singleton pattern with lazy initialization.

## Consequences
- Pro: Single client instance, connection reuse
- Pro: Easy to mock in tests
- Con: Global state 

Salesforce Production Checklist

Overview

Complete checklist for deploying Salesforce integrations to production.

Prerequisites

• Staging environment tested and verified
• Production API keys available
• Deployment pipeline configured
• Monitoring and alerting ready

Instructions

Step 1: Pre-Deployment Configuration

• [ ] Production API keys in secure vault
• [ ] Environment variables set in deployment platform
• [ ] API key scopes are minimal (least privilege)
• [ ] Webhook endpoints configured with HTTPS
• [ ] Webhook secrets stored securely

Step 2: Code Quality Verification

• [ ] All tests passing (npm test)
• [ ] No hardcoded credentials
• [ ] Error handling covers all Salesforce error types
• [ ] Rate limiting/backoff implemented
• [ ] Logging is production-appropriate

Step 3: Infrastructure Setup

• [ ] Health check endpoint includes Salesforce connectivity
• [ ] Monitoring/alerting configured
• [ ] Circuit breaker pattern implemented
• [ ] Graceful degradation configured

Step 4: Documentation Requirements

• [ ] Incident runbook created
• [ ] Key rotation procedure documented
• [ ] Rollback procedure documented
• [ ] On-call escalation path defined

Step 5: Deploy with Gradual Rollout

# Pre-flight checks
curl -f https://staging.example.com/health
curl -s https://status.salesforce.com

# Gradual rollout - start with canary (10%)
kubectl apply -f k8s/production.yaml
kubectl set image deployment/salesforce-integration app=image:new --record
kubectl rollout pause deployment/salesforce-integration

# Monitor canary traffic for 10 minutes
sleep 600
# Check error rates and latency before continuing

# If healthy, continue rollout to 50%
kubectl rollout resume deployment/salesforce-integration
kubectl rollout pause deployment/salesforce-integration
sleep 300

# Complete rollout to 100%
kubectl rollout resume deployment/salesforce-integration
kubectl rollout status deployment/salesforce-integration

Output

• Deployed Salesforce integration
• Health checks passing
• Monitoring active
• Rollback procedure documented

Error Handling

Examples

Health Check Implementation

async function healthCheck(): Promise<{ status:

Salesforce Rate Limits

Overview

Handle Salesforce rate limits gracefully with exponential backoff and idempotency.

Prerequisites

• Salesforce SDK installed
• Understanding of async/await patterns
• Access to rate limit headers

Instructions

Step 1: Understand Rate Limit Tiers

Step 2: Implement Exponential Backoff with Jitter

async function withExponentialBackoff<T>(
  operation: () => Promise<T>,
  config = { maxRetries: 5, baseDelayMs: 1000, maxDelayMs: 32000, jitterMs: 500 }
): Promise<T> {
  for (let attempt = 0; attempt <= config.maxRetries; attempt++) {
    try {
      return await operation();
    } catch (error: any) {
      if (attempt === config.maxRetries) throw error;
      const status = error.status || error.response?.status;
      if (status !== 429 && (status < 500 || status >= 600)) throw error;

      // Exponential delay with jitter to prevent thundering herd
      const exponentialDelay = config.baseDelayMs * Math.pow(2, attempt);
      const jitter = Math.random() * config.jitterMs;
      const delay = Math.min(exponentialDelay + jitter, config.maxDelayMs);

      console.log(`Rate limited. Retrying in ${delay.toFixed(0)}ms...`);
      await new Promise(r => setTimeout(r, delay));
    }
  }
  throw new Error('Unreachable');
}

Step 3: Add Idempotency Keys

import { v4 as uuidv4 } from 'uuid';
import crypto from 'crypto';

// Generate deterministic key from operation params (for safe retries)
function generateIdempotencyKey(operation: string, params: Record<string, any>): string {
  const data = JSON.stringify({ operation, params });
  return crypto.createHash('sha256').update(data).digest('hex');
}

async function idempotentRequest<T>(
  client: SalesforceClient,
  params: Record<string, any>,
  idempotencyKey?: string  // Pass existing key for retries
): Promise<T> {
  // Use provided key (for retries) or generate deterministic key from params
  const key = idempotencyKey || generateIdempotencyKey(params.method || 'POST', params);
  return client.request({
    ...params,
    headers: { 'Idempotency-Key': key, ...params.headers },
  });
}

Output

• Reliable API calls with automatic retry
• Idempotent requests preventing duplicates
• Rate limit headers properly handled

Error Handling

my-salesforce-project/
├── src/
│   ├── salesforce/
│   │   ├── client.ts           # Singleton client wrapper
│   │   ├── config.ts           # Environment configuration
│   │   ├── types.ts            # TypeScript types
│   │   ├── errors.ts           # Custom error classes
│   │   └── handlers/
│   │       ├── webhooks.ts     # Webhook handlers
│   │       └── events.ts       # Event processing
│   ├── services/
│   │   └── salesforce/
│   │       ├── index.ts        # Service facade
│   │       ├── sync.ts         # Data synchronization
│   │       └── cache.ts        # Caching layer
│   ├── api/
│   │   └── salesforce/
│   │       └── webhook.ts      # Webhook endpoint
│   └── jobs/
│       └── salesforce/
│           └── sync.ts         # Background sync job
├── tests/
│   ├── unit/
│   │   └── salesforce/
│   └── integration/
│       └── salesforce/
├── config/
│   ├── salesforce.development.json
│   ├── salesforce.staging.json
│   └── salesforce.production.json
└── docs/
    └── salesforce/
        ├── SETUP.md
        └── RUNBOOK.md

┌─────────────────────────────────────────┐
│             API Layer                    │
│   (Controllers, Routes, Webhooks)        │
├─────────────────────────────────────────┤
│           Service Layer                  │
│  (Business Logic, Orchestration)         │
├─────────────────────────────────────────┤
│          Salesforce Layer        │
│   (Client, Types, Error Handling)        │
├─────────────────────────────────────────┤
│         Infrastructure Layer             │
│    (Cache, Queue, Monitoring)            │
└─────────────────────────────────────────┘

// src/salesforce/client.ts
export class SalesforceService {
  private client: SalesforceClient;
  private cache: Cache;
  private monitor: Monitor;

  constructor(config: SalesforceConfig) {
    this.client = new SalesforceClient(config);
    this.cache = new Cache(config.cacheOptions);
    this.monitor = new Monitor('salesforce');
  }

  async get(id: string): Promise<Resource> {
    return this.cache.getOrFetch(id, () =>
      this.monitor.track('get', () => this.client.get(id))
    );
  }
}

// src/salesforce/errors.ts
export class SalesforceServiceError extends Error {
  constructor(
    message: string,
    public readonly code: string,
    public readonly retryable: boolean,
    public readonly originalError?: Error
  ) {
  

import CircuitBreaker from 'opossum';

const salesforceBreaker = new CircuitBreaker(
  async (operation: () => Promise<any>) => operation(),
  {
    timeout: 30000,
    errorThresholdPercentage: 50,
    resetTimeout: 30000,
    volumeThreshold: 10,
  }
);

// Events
salesforceBreaker.on('open', () => {
  console.warn('Salesforce circuit OPEN - requests failing fast');
  alertOps('Salesforce circuit breaker opened');
});

salesforceBreaker.on('halfOpen', () => {
  console.info('Salesforce circuit HALF-OPEN - testing recovery');
});

salesforceBreaker.on('close', () => {
  console.info('Salesforce circuit CLOSED - normal operation');
});

// Usage
async function safeSalesforceCall<T>(fn: () => Promise<T>): Promise<T> {
  return salesforceBreaker.fire(fn);
}

import { v4 as uuidv4 } from 'uuid';
import crypto from 'crypto';

// Generate deterministic idempotency key from input
function generateIdempotencyKey(
  operation: string,
  params: Record<string, any>
): string {
  const data = JSON.stringify({ operation, params });
  return crypto.createHash('sha256').update(data).digest('hex');
}

// Or use random key with storage
class IdempotencyManager {
  private store: Map<string, { key: string; expiresAt: Date }> = new Map();

  getOrCreate(operationId: string): string {
    const existing = this.store.get(operationId);
    if (existing && existing.expiresAt > new Date()) {
      return existing.key;
    }

    const key = uuidv4();
    this.store.set(operationId, {
      key,
      expiresAt: new Date(Date.now() + 24 * 60 * 60 * 1000),
    });
    return key;
  }
}

import PQueue from 'p-queue';

// Separate queues for different operations
const salesforceQueues = {
  critical: new PQueue({ concurrency: 10 }),
  normal: new PQueue({ concurrency: 5 }),
  bulk: new PQueue({ concurrency: 2 }),
};

async function prioritizedSalesforceCall<T>(
  priority: 'critical' | 'normal' | 'bulk',
  fn: () => Promise<T>
): Promise<T> {
  return salesforceQueues[priority].add(fn);
}

// Usage
await prioritizedSalesforceCall('critical', () =>
  salesforceClient.processPayment(order)
);

await prioritizedSalesforceCall('bulk', () =>
  salesforceClient.syncCatalog(products)
);

// src/salesforce/client.ts
import { SalesforceClient } from '@salesforce/sdk';

let instance: SalesforceClient | null = null;

export function getSalesforceClient(): SalesforceClient {
  if (!instance) {
    instance = new SalesforceClient({
      apiKey: process.env.SALESFORCE_API_KEY!,
      // Additional options
    });
  }
  return instance;
}

import { SalesforceError } from '@salesforce/sdk';

async function safeSalesforceCall<T>(
  operation: () => Promise<T>
): Promise<{ data: T | null; error: Error | null }> {
  try {
    const data = await operation();
    return { data, error: null };
  } catch (err) {
    if (err instanceof SalesforceError) {
      console.error({
        code: err.code,
        message: err.message,
      });
    }
    return { data: null, error: err as Error };
  }
}

async function withRetry<T>(
  operation: () => Promise<T>,
  maxRetries = 3,
  backoffMs = 1000
): Promise<T> {
  for (let attempt = 1; attempt <= maxRetries; attempt++) {
    try {
      return await operation();
    } catch (err) {
      if (attempt === maxRetries) throw err;
      const delay = backoffMs * Math.pow(2, attempt - 1);
      await new Promise(r => setTimeout(r, delay));
    }
  }
  throw new Error('Unreachable');
}

const clients = new Map<string, SalesforceClient>();

export function getClientForTenant(tenantId: string): SalesforceClient {
  if (!clients.has(tenantId)) {
    const apiKey = getTenantApiKey(tenantId);
    clients.set(tenantId, n

Salesforce Security Basics

Overview

Security best practices for Salesforce API keys, tokens, and access control.

Prerequisites

• Salesforce SDK installed
• Understanding of environment variables
• Access to Salesforce dashboard

Instructions

Step 1: Configure Environment Variables

# .env (NEVER commit to git)
SALESFORCE_API_KEY=sk_live_***
SALESFORCE_SECRET=***

# .gitignore
.env
.env.local
.env.*.local

Step 2: Implement Secret Rotation

# 1. Generate new key in Salesforce dashboard
# 2. Update environment variable
export SALESFORCE_API_KEY="new_key_here"

# 3. Verify new key works
curl -H "Authorization: Bearer ${SALESFORCE_API_KEY}" \
  https://api.salesforce.com/health

# 4. Revoke old key in dashboard

Step 3: Apply Least Privilege

Output

• Secure API key storage
• Environment-specific access controls
• Audit logging enabled

Error Handling

Examples

Service Account Pattern

const clients = {
  reader: new SalesforceClient({
    apiKey: process.env.SALESFORCE_READ_KEY,
  }),
  writer: new SalesforceClient({
    apiKey: process.env.SALESFORCE_WRITE_KEY,
  }),
};

Webhook Signature Verification

import crypto from 'crypto';

function verifyWebhookSignature(
  payload: string, signature: string, secret: string
): boolean {
  const expected = crypto.createHmac('sha256', secret).update(payload).digest('hex');
  return crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(expected));
}

Security Checklist

• [ ] API keys in environment variables
• [ ] .env files in .gitignore
• [ ] Different keys for dev/staging/prod
• [ ] Minimal scopes per environment
• [ ] Webhook signatures validated
• [ ] Audit logging enabled

Audit Logging

interface AuditEntry {
  timestamp: Date;
  action: string;
  userId: string;
  resource: string;
  result: 'success

Salesforce Upgrade & Migration

Overview

Guide for upgrading Salesforce SDK versions and handling breaking changes.

Prerequisites

• Current Salesforce SDK installed
• Git for version control
• Test suite available
• Staging environment

Instructions

Step 1: Check Current Version

npm list @salesforce/sdk
npm view @salesforce/sdk version

Step 2: Review Changelog

open https://github.com/salesforce/sdk/releases

Step 3: Create Upgrade Branch

git checkout -b upgrade/salesforce-sdk-vX.Y.Z
npm install @salesforce/sdk@latest
npm test

Step 4: Handle Breaking Changes

Update import statements, configuration, and method signatures as needed.

Output

• Updated SDK version
• Fixed breaking changes
• Passing test suite
• Documented rollback procedure

Error Handling

Examples

Import Changes

// Before (v1.x)
import { Client } from '@salesforce/sdk';

// After (v2.x)
import { SalesforceClient } from '@salesforce/sdk';

Configuration Changes

// Before (v1.x)
const client = new Client({ key: 'xxx' });

// After (v2.x)
const client = new SalesforceClient({
  apiKey: 'xxx',
});

Rollback Procedure

npm install @salesforce/sdk@1.x.x --save-exact

Deprecation Handling

// Monitor for deprecation warnings in development
if (process.env.NODE_ENV === 'development') {
  process.on('warning', (warning) => {
    if (warning.name === 'DeprecationWarning') {
      console.warn('[Salesforce]', warning.message);
      // Log to tracking system for proactive updates
    }
  });
}

// Common deprecation patterns to watch for:
// - Renamed methods: client.oldMethod() -> client.newMethod()
// - Changed parameters: { key: 'x' } -> { apiKey: 'x' }
// - Removed features: Check release notes before upgrading

Resources

• Salesforce Changelog
• Salesforce Migration Guide

Next Steps

For CI integration during upgrades, see salesforce-ci-integration