CodeReviewPatterns

Code Review Patterns

Cross-cutting patterns that recur in PR review feedback for the Copilot Studio VS Code Extension. These are not auto-detected by ESLint or Roslyn analyzers — check them manually before pushing.

High-frequency review flags:

• Missing await on async LSP requests (silent failures)
• PII leaked in telemetry without <pii> tag wrapping
• Concurrent sync operations not guarded by state machine
• Command handlers not pushed to context.subscriptions
• Disposable resources not cleaned up on deactivation
• Hardcoded environment URLs instead of cluster lookup
• Missing error handling on Dataverse/BAP API calls
• any type usage bypassing TypeScript strict mode
• C# handlers missing null checks on nullable-enabled types

TypeScript Extension Patterns

Command Registration Must Use Subscriptions

Every commands.registerCommand call must push the disposable to context.subscriptions. Leaked commands survive extension deactivation and cause ghost behavior on reload.

// BAD - disposable leaked
commands.registerCommand('microsoft-copilot-studio.x', handler);

// GOOD - tracked for cleanup
const command = commands.registerCommand('microsoft-copilot-studio.x', handler);
context.subscriptions.push(command);

Async LSP Requests Must Be Awaited

The LSP client proxy wraps all requests with telemetry. Forgetting await silently drops errors and makes the telemetry log "success" for failed operations.

// BAD - fire-and-forget on LSP request
lspClient.sendRequest('powerplatformls/syncPush', params);

// GOOD - await and handle errors
const result = await lspClient.sendRequest('powerplatformls/syncPush', params);

PII Must Use Redaction Tags

The logger redacts <pii>text</pii> in telemetry output. Any user-identifiable data (environment IDs, agent names, email addresses, URLs with tenant info) must be wrapped.

// BAD - environment URL exposed in telemetry
logger.info(`Connecting to ${environmentUrl}`);

// GOOD - PII redacted in telemetry stream
logger.info(`Connecting to <pii>${environmentUrl}</pii>`);