Skip to content

feat: sync connection settings across browsers via chrome.storage.sync #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mkobayashime merged 5 commits into from
Feb 5, 2026
Merged

feat: sync connection settings across browsers via chrome.storage.sync #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2755fd8
docs: add cross-browser sync design spec and original requirement
mkobayashime Feb 5, 2026
4dec644
feat: split Connection into ConnectionConfig and ConnectionState
mkobayashime Feb 5, 2026
0506063
feat: rewrite connection storage for cross-browser sync
mkobayashime Feb 5, 2026
5e6a9d0
feat: wire orphan resolution and cleanup into the options page
mkobayashime Feb 5, 2026
0584024
docs: update AGENTS.md with split-storage architecture
mkobayashime Feb 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 27 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Chrome Extension that syncs GitHub repository manifest files to Chrome bookmarks
### Key Features
- GitHub OAuth Device Flow authentication
- Repository connection management
- Cross-browser connection settings sync (via chrome.storage.sync)
- Manifest file parsing from GitHub repos
- Automatic periodic sync (hourly) + manual sync
- Skip-if-unchanged optimization using commit SHA
Expand Down Expand Up @@ -79,9 +80,16 @@ Chrome Extension that syncs GitHub repository manifest files to Chrome bookmarks

### Data Flow

1. **Auth**: GitHub OAuth Device Flow → token stored in chrome.storage
1. **Auth**: GitHub OAuth Device Flow → token stored in chrome.storage.local
2. **Add Connection**: User selects repo → target folder → connection saved
3. **Sync**:
- Configuration (repo settings, enabled status) → chrome.storage.sync
- State (folder IDs, sync timestamps) → chrome.storage.local
3. **Cross-Browser Sync**:
- Connection settings sync across browsers via chrome.storage.sync
- Browser-specific state (folder IDs) remains local
- Orphan configs (synced without local state) auto-resolve on mount
- Deleted connections cleanup orphaned local state
4. **Sync**:
- Fetch latest commit SHA for `srcDir`
- Skip if unchanged (unless forced)
- Fetch `manifest.json` from repo
Expand All @@ -92,11 +100,26 @@ Chrome Extension that syncs GitHub repository manifest files to Chrome bookmarks

### Key Types

- `Connection`: Repo config + sync state
- `ConnectionConfig`: Synced across browsers (repo settings, enabled status)
- `ConnectionState`: Browser-specific (folder IDs, sync timestamps)
- `Connection`: Merged type (ConnectionConfig & ConnectionState) for backward compatibility
- `ManifestBookmark`: `{ name, location }` from manifest.json
- `ResolvedBookmark`: `{ name, url }` after processing

### External APIs

- GitHub REST API: Repos, contents, commits, user
- Chrome Extension API: Storage, Bookmarks, Alarms
- Chrome Extension API: Storage (sync + local), Bookmarks, Alarms

### Storage Architecture

**Split Storage for Cross-Browser Sync:**
- `chrome.storage.sync` - Connection configurations (synced across browsers)
- Key: `sync:gitmarks_connections`
- Includes: repo settings, target folder path, enabled status
- `chrome.storage.local` - Browser-specific state (local only)
- Key: `local:gitmarks_connection_state`
- Includes: folder IDs, sync timestamps, errors
- `chrome.storage.local` - User data (local only)
- Keys: `local:gitmarks_user`, `local:github_access_token`
- Each browser requires separate authentication
Loading