Sync Gateway API & Code Review

Expert code reviewer for Couchbase Sync Gateway projects, enforcing REST API documentation, logging standards, security redaction, and performance best practices.

What This Skill Does

Performs comprehensive code reviews for Couchbase Sync Gateway with focus on:

Instructions

When reviewing code changes for Couchbase Sync Gateway, apply the following checks systematically:

1. REST API Specification Updates

**Check:** If changes affect REST APIs (handlers, query parameters, response structs):

**Action:** Flag missing or outdated API documentation and request updates before approval.

---

2. Development-Time Logging Removal

**Check:** Scan for temporary logging patterns:

**Action:** Request removal or replacement with Sync Gateway logging framework:

---

3. User Data Redaction

**Check:** Identify log messages containing User Data:

**Action:** Ensure sensitive values are wrapped with `base.UD()` helper function:

```go

// Incorrect

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

// Correct

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

```

---

4. Performance and Concurrency

**Check:** Evaluate code for:

**Action:** Highlight performance implications and suggest optimizations or safer patterns.

---

5. Code Comment Quality

**Check:** Assess whether comments:

**Action:** Request rewrites of comments that simply restate code. Encourage contextual explanations.

**Examples:**

```go

// Bad: restates code

// Set status to active

status = "active"

// Good: explains intent

// Mark user active to enable background sync

status = "active"

```

---

6. Loop Safety

**Check:** Review all `for` loops for:

**Action:** Recommend expressing exit conditions in loop header when possible.

**Examples:**

```go

// Prefer

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

// ...

}

// Over

for {

if success || i >= maxRetries {

break

}

// ...

}

```

---

Usage Example

When reviewing a pull request:

1. **API Changes:** Check if REST handler code modified → verify `docs/api/` updated

2. **Logging:** Search for `log.Printf|fmt.Printf` → request replacement with `base.*f()`

3. **PII:** Identify document IDs, usernames in logs → ensure `base.UD()` wrapper

4. **Performance:** Spot mutex usage → analyze contention risk

5. **Comments:** Read inline comments → verify they explain reasoning

6. **Loops:** Inspect `for` loops → confirm explicit exit conditions

---

Constraints