Sync Gateway Code Review

This skill performs thorough code reviews for Couchbase Sync Gateway, which manages access and synchronization between Couchbase Lite and Couchbase Server.

What This Skill Does

Provides comprehensive code review guidance specific to Sync Gateway development, focusing on:

Instructions

When performing a code review for Sync Gateway, follow these steps:

1. REST API Documentation Check

If there are **any changes to REST APIs**, verify:

**Action Required:** Ensure the OpenAPI specifications are updated accordingly in the `docs/api` directory.

2. Development Logging Review

Check for **inappropriate dev-time logging**:

**Action Required:** Ensure all dev-time logging is either:

- `base.Infof` for informational messages

- `base.Warnf` for warnings

- `base.Debugf` for debug-level logging

3. User Data Redaction Verification

Identify log messages containing **User Data**, including:

**Action Required:** Ensure all User Data values are wrapped with the `base.UD()` helper function to enable proper redaction.

**Example:**

```go

// Bad

base.Infof("Processing document: %s", docID)

// Good

base.Infof("Processing document: %s", base.UD(docID))

```

4. Performance and Concurrency Analysis

Review code for **performance implications**:

**Action Required:** Flag any potential performance or concurrency issues with clear explanation of the risk.

5. Code Comment Quality

Evaluate comment quality to ensure they:

**Bad Example:**

```go

// Increment counter by 1

counter++

```

**Good Example:**

```go

// Track failed sync attempts to trigger backoff after 3 consecutive failures

failedSyncCount++

```

6. Loop Exit Condition Safety

Examine all `for` loops to ensure:

**Preferred Pattern:**

```go

// Good - exit condition in declaration

for i := 0; i < maxRetries && !succeeded; i++ {

// loop body

}

// Avoid - relying on break statements

for {

if condition {

break

}

}

```

Review Checklist

For each code review, verify:

Constraints