Skip to content

docs: update google repair/import websocket documentation#1581

Merged
tyler-dane merged 2 commits intomainfrom
cursor/documentation-automation-system-ed70
Mar 28, 2026
Merged

docs: update google repair/import websocket documentation#1581
tyler-dane merged 2 commits intomainfrom
cursor/documentation-automation-system-ed70

Conversation

@cursor
Copy link
Copy Markdown
Contributor

@cursor cursor Bot commented Mar 28, 2026

Summary

  • Updated docs/features/google-sync-and-websocket-flow.md with the latest repair UX behavior and websocket payload contract.
  • Updated docs/development/troubleshoot.md with a focused runbook for Google repair failures.

What changed

  • Documented IMPORT_GCAL_END payload shape with explicit operation: "REPAIR" | "INCREMENTAL" and status-specific fields.
  • Added operation-aware handling semantics for the web client (useGcalSync, sync slice, useConnectGoogle) including repair-specific spinner state and toast de-dup behavior.
  • Added verified repair failure message semantics for quota/rate-limit vs generic repair errors.
  • Clarified revoked-token behavior during repair (invalid_grant => prune + GOOGLE_REVOKED), including the absence of an IMPORT_GCAL_END errored payload in that path.
  • Added troubleshooting steps for quota-limited repairs and revoked-token repairs.

Codepaths covered

  • packages/core/src/types/websocket.types.ts
  • packages/backend/src/user/services/user.service.ts
  • packages/backend/src/sync/services/sync.service.ts
  • packages/backend/src/common/services/gcal/gcal.utils.ts
  • packages/backend/src/common/errors/integration/gcal/gcal.errors.ts
  • packages/web/src/socket/hooks/useGcalSync.ts
  • packages/web/src/auth/hooks/oauth/useConnectGoogle.ts
  • packages/web/src/ducks/events/slices/sync.slice.ts

Why

PR #1580 changed repair UX and the sync completion contract; existing docs did not clearly explain operation-specific websocket payloads, repair error semantics, or expected operator troubleshooting paths.

Open in Web View Automation 

Note

Low Risk
Documentation-only changes that clarify websocket payloads and operational repair failure modes; no production code behavior is modified.

Overview
Updates Google sync documentation to define the new IMPORT_GCAL_END payload contract (adds operation: "REPAIR" | "INCREMENTAL" and status-specific fields) and to spell out operation-aware client handling semantics for completion, refetching, and repair-specific toasts/spinner state.

Adds a troubleshooting runbook for Google Calendar repair failures, including guidance for quota/rate-limit errors vs revoked-token (invalid_grant) behavior, and notes that revoked-token repair exits via GOOGLE_REVOKED without an IMPORT_GCAL_END errored payload.

Written by Cursor Bugbot for commit 078d6ed. This will update automatically on new commits. Configure here.

cursoragent and others added 2 commits March 28, 2026 12:55
Co-authored-by: Tyler Dane <tyler-dane@users.noreply.github.com>
Co-authored-by: Tyler Dane <tyler-dane@users.noreply.github.com>
@tyler-dane tyler-dane marked this pull request as ready for review March 28, 2026 13:03
@tyler-dane tyler-dane merged commit 7250799 into main Mar 28, 2026
8 checks passed
@tyler-dane tyler-dane deleted the cursor/documentation-automation-system-ed70 branch March 28, 2026 13:03
tyler-dane added a commit to Muhammad-Nur-Alamsyah-Anwar/compass that referenced this pull request Mar 30, 2026
…Tech#1581)

* docs(sync): update repair and import websocket semantics

Co-authored-by: Tyler Dane <tyler-dane@users.noreply.github.com>

* docs(dev): add google repair troubleshooting guidance

Co-authored-by: Tyler Dane <tyler-dane@users.noreply.github.com>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Tyler Dane <tyler-dane@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants