Skip to content

docs(ensemble): CDN provider, file upload, and ViewGroup clamping#2267

Draft
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/engineering-documentation-updates-662a
Draft

docs(ensemble): CDN provider, file upload, and ViewGroup clamping#2267
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/engineering-documentation-updates-662a

Conversation

@cursor

@cursor cursor Bot commented Jun 8, 2026

Copy link
Copy Markdown

Summary

Documentation-only update for recently changed Ensemble runtime subsystems that lacked technical write-ups.

Docs added/updated

Document Change
modules/ensemble/docs/cdn-definition-provider.md New — CDN manifest fetch, caching, encryption, ENABLE_ARTIFACT_REFRESH, and pending-update ordering
modules/ensemble/docs/file-upload.md NewuploadFiles action, batching, background Workmanager tasks, UploadFilesResponse API
modules/ensemble/docs/layout-widgets.md Updated — ViewGroup tab index clamping, ListView controller swap note
modules/ensemble/README.md Updated — links to new docs
starter/README.md Updated — brief CDN production note with link

Codepaths covered

  • lib/framework/definition_providers/cdn_provider.dart — CDN lifecycle and artifact refresh
  • lib/action/upload_files_action.dart, lib/util/upload_utils.dart, lib/framework/data_context.dart — upload batches and cancellation
  • lib/framework/view/page_group.dart, lib/framework/action.dartsafeViewGroupPayloadIndex and navigateViewGroup
  • lib/layout/helpers/list_view_core.dart — scroll controller re-attachment

Key knowledge gaps addressed

  • How CDN differs from Firestore (ensemble) hosting and when to use from: cdn
  • Why UI may not update after CDN publish without ENABLE_ARTIFACT_REFRESH
  • Background upload batching, per-batch Workmanager tags, and why cancelAll does not call Workmanager.cancelAll
  • ViewGroup index clamping when menu definitions shrink or storage restores stale indices

All behavior verified against source and existing tests (cdn_provider_test.dart, upload_batch_split_test.dart, upload_cancel_all_test.dart, safe_view_group_payload_index_test.dart).

Open in Web View Automation 

…mping

Add technical docs for recently changed subsystems:
- CDN definition provider lifecycle, caching, and artifact refresh
- uploadFiles foreground/background batches and cancelAll scoping
- ViewGroup tab index safety via safeViewGroupPayloadIndex

Update ensemble and starter READMEs with links and CDN production note.

Co-authored-by: Sharjeel Yunus <sharjeelyunus@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.

1 participant