Skip to content

drive-backup.md

Latest commit

 

History

History
54 lines (39 loc) · 1.88 KB

drive-backup.md

File metadata and controls

54 lines (39 loc) · 1.88 KB
Raw

Google Drive backup

Optional, manual sync. Nothing uploads until the user uses the backup control in History.

Folder created in My Drive: Bihar Police Notebook Backup — do not delete.

Scope: https://www.googleapis.com/auth/drive.file (files/folders this app creates).

Modules

File Role
drive-config.js Client ID, scope, folder name, API bases
drive-auth.js Google Identity Services token; short-lived token cache in IndexedDB bp-writing-tool-auth
drive-sync.js Ensure folder, push/pull/merge JSON per document UUID

Menu actions

Action Behavior
Sync all Pull from Drive into local, then push dirty/new local docs to Drive
Sync new Push only dirty/new local docs to Drive (no pull)
Disconnect Revokes access in this browser; does not delete the Drive folder

If the backup folder was deleted, the next sync recreates it and re-uploads local docs (stale Drive file ids are cleared).

Sync sequence (happy path)

sequenceDiagram
  participant User
  participant UI as History_backup_button
  participant Auth as drive-auth
  participant Sync as drive-sync
  participant Drive as Google_Drive_API

  User->>UI: Connect_or_Sync
  UI->>Auth: ensureAccessToken
  Auth->>Drive: OAuth_token
  UI->>Sync: syncAll_or_pushPending
  Sync->>Drive: ensureFolder
  Sync->>Drive: Pull_and_or_push_JSON_files
  Sync->>UI: Update_badges_status
Loading

File layout on Drive

  • One folder (name above).
  • One JSON file per document: {uuid}.json, matched with appProperties.uuid.
  • Disconnect revokes access in this browser; it does not delete the Drive folder.

Maintainer note: OAuth Web client ID is in drive-config.js. Add authorized JavaScript origins for production and local preview; do not commit a client secret.

See: Storage, Architecture.