| name | perplexity-known-pitfalls |
| description | Identify and avoid Perplexity anti-patterns and common integration mistakes.
Use when reviewing Perplexity code for issues, onboarding new developers,
or auditing existing Perplexity integrations for best practices violations.
Trigger with phrases like "perplexity mistakes", "perplexity anti-patterns",
"perplexity pitfalls", "perplexity what not to do", "perplexity code review".
|
| allowed-tools | Read, Grep |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
Perplexity Known Pitfalls
Overview
Common mistakes and anti-patterns when integrating with Perplexity.
Prerequisites
- Access to Perplexity codebase for review
- Understanding of async/await patterns
- Knowledge of security best practices
- Familiarity with rate limiting concepts
Pitfall #1: Synchronous API Calls in Request Path
❌ Anti-Pattern
app.post('/checkout', async (req, res) => {
const payment = await perplexityClient.processPayment(req.body);
const notification = await perplexityClient.sendEmail(payment);
res.json({ success: true });
});
✅ Better Approach
app.post('/checkout', async (req, res) => {
const jobId = await queue.enqueue('process-checkout', req.body);
res.json({ jobId, status: 'processing' });
});
async function processCheckout(data) {
const payment = await perplexityClient.processPayment(data);
await perplexityClient.sendEmail(payment);
}
Pitfall #2: Not Handling Rate Limits
❌ Anti-Pattern
for (const item of items) {
await perplexityClient.process(item);
}
✅ Better Approach
import pLimit from 'p-limit';
const limit = pLimit(5);
const rateLimiter = new RateLimiter({ tokensPerSecond: 10 });
for (const item of items) {
await rateLimiter.acquire();
await limit(() => perplexityClient.process(item));
}
Pitfall #3: Leaking API Keys
❌ Anti-Pattern
const client = new PerplexityClient({
apiKey: 'sk_live_ACTUAL_KEY_HERE',
});
git commit -m "add API key"
✅ Better Approach
const client = new PerplexityClient({
apiKey: process.env.PERPLEXITY_API_KEY,
});
.env
.env.local
.env.*.local
Pitfall #4: Ignoring Idempotency
❌ Anti-Pattern
try {
await perplexityClient.charge(order);
} catch (error) {
if (error.code === 'NETWORK_ERROR') {
await perplexityClient.charge(order);
}
}
✅ Better Approach
const idempotencyKey = `order-${order.id}-${Date.now()}`;
await perplexityClient.charge(order, {
idempotencyKey,
});
Pitfall #5: Not Validating Webhooks
❌ Anti-Pattern
app.post('/webhook', (req, res) => {
processWebhook(req.body);
res.sendStatus(200);
});
✅ Better Approach
app.post('/webhook',
express.raw({ type: 'application/json' }),
(req, res) => {
const signature = req.headers['x-perplexity-signature'];
if (!verifyPerplexitySignature(req.body, signature)) {
return res.sendStatus(401);
}
processWebhook(JSON.parse(req.body));
res.sendStatus(200);
}
);
Pitfall #6: Missing Error Handling
❌ Anti-Pattern
const result = await perplexityClient.get(id);
console.log(result.data.nested.value);
✅ Better Approach
try {
const result = await perplexityClient.get(id);
console.log(result?.data?.nested?.value ?? 'default');
} catch (error) {
if (error instanceof PerplexityNotFoundError) {
return null;
}
if (error instanceof PerplexityRateLimitError) {
await sleep(error.retryAfter);
return this.get(id);
}
throw error;
}
Pitfall #7: Hardcoding Configuration
❌ Anti-Pattern
const client = new PerplexityClient({
timeout: 5000,
baseUrl: 'https://api.perplexity.com',
});
✅ Better Approach
const client = new PerplexityClient({
timeout: parseInt(process.env.PERPLEXITY_TIMEOUT || '30000'),
baseUrl: process.env.PERPLEXITY_BASE_URL || 'https://api.perplexity.com',
});
Pitfall #8: Not Implementing Circuit Breaker
❌ Anti-Pattern
for (const user of users) {
await perplexityClient.sync(user);
}
✅ Better Approach
import CircuitBreaker from 'opossum';
const breaker = new CircuitBreaker(perplexityClient.sync, {
timeout: 10000,
errorThresholdPercentage: 50,
resetTimeout: 30000,
});
for (const user of users) {
await breaker.fire(user).catch(handleFailure);
}
Pitfall #9: Logging Sensitive Data
❌ Anti-Pattern
console.log('Request:', JSON.stringify(request));
console.log('User:', user);
✅ Better Approach
const redacted = {
...request,
apiKey: '[REDACTED]',
user: { id: user.id },
};
console.log('Request:', JSON.stringify(redacted));
Pitfall #10: No Graceful Degradation
❌ Anti-Pattern
const recommendations = await perplexityClient.getRecommendations(userId);
return renderPage({ recommendations });
✅ Better Approach
let recommendations;
try {
recommendations = await perplexityClient.getRecommendations(userId);
} catch (error) {
recommendations = await getFallbackRecommendations(userId);
reportDegradedService('perplexity', error);
}
return renderPage({ recommendations, degraded: !recommendations });
Instructions
Step 1: Review for Anti-Patterns
Scan codebase for each pitfall pattern.
Step 2: Prioritize Fixes
Address security issues first, then performance.
Step 3: Implement Better Approach
Replace anti-patterns with recommended patterns.
Step 4: Add Prevention
Set up linting and CI checks to prevent recurrence.
Output
- Anti-patterns identified
- Fixes prioritized and implemented
- Prevention measures in place
- Code quality improved
Error Handling
| Issue | Cause | Solution |
|---|
| Too many findings | Legacy codebase | Prioritize security first |
| Pattern not detected | Complex code | Manual review |
| False positive | Similar code | Whitelist exceptions |
| Fix breaks tests | Behavior change | Update tests |
Examples
Quick Pitfall Scan
grep -r "sk_live_" --include="*.ts" src/
grep -r "console.log" --include="*.ts" src/
Resources
Quick Reference Card
| Pitfall | Detection | Prevention |
|---|
| Sync in request | High latency | Use queues |
| Rate limit ignore | 429 errors | Implement backoff |
| Key leakage | Git history scan | Env vars, .gitignore |
| No idempotency | Duplicate records | Idempotency keys |
| Unverified webhooks | Security audit | Signature verification |
| Missing error handling | Crashes | Try-catch, types |
| Hardcoded config | Code review | Environment variables |
| No circuit breaker | Cascading failures | opossum, resilience4j |
| Logging PII | Log audit | Redaction middleware |
| No degradation | Total outages | Fallback systems |