Collection of 1.0 items to consider

[vladsud]

Background

The goal of this issue / epic is to track and organize all the potential issues we would want to review, prioritize, and possibly implement for 1.0 release.
Note that 1.0 release is not necessarily tied to particular goal or date (this should be defined outside of this issue). In context of this issue, 1.0 really means long-term support and graduation of "beta". Today, while we do our best to maintain APIs and behaviors (including back compatibility in document file format), the processes are tight to internal requirements (for example, we assume that new releases are consumed by all customers quickly and get to 99.99% saturation within ~month timeframe in production). We also keep changing and deprecated APIs with assumption that few consumers are using (i.e. we bake into calculus certain collective cost of changing APIs that is based on few internal users of framework). These assumptions needs to change and "1.0" badge needs to reflect that. There are certain areas where we are not happy with APIs and want to change them before that happens, and thus this issue.

This item is not about tracking any other areas, like reliability or perf, i.e. it's focused on API shape, and promises (including backward compatibility) for the long run.

Issue list

New issues to be triages and put under appropriate buckets

• "clear" events on directory & map have ISequencedDocumentMessage payload #8481
• Deprecate IDirectory.absolutePath #8482

Correctness

• DDS to use deep-cloning / immutable objects when raising events, returning current state #5738 - triage: cut - consider adding documentation
• Capability to create safely root data stores in attached container mode #6465 - triage: in (October)
• Potential eventual consistency issues with SharedDirectory subdirectory deletion/creation #6069 - triage: cut - pending investigation into nature of fix

Correctness / op batching - new epic created
(moved to it's own epic:

• Batch processing in ContainerRuntime may not process batch in one JS turn #5761 - triage: in process
• Correctness: 'FlushMode.Manual' should be the default #4048
• BatchManager should be removed, all the bugs in Runtime related to not using batches in right places fixed #3788 - triage: in process
• 1 MB op causes infinite reconnect loop: chunking / op packing is very inefficient, violating 16K op size requirements #7545 - triage: in

Channel unification

• Unify Channel interfaces #3469 - triage: cut - wait for 2.0
• DDS summarization and asynchrony / unifications of summarization flows across layers #6571 - triage: in process

Quorum - new epic created

• Quorum cleanup: hide abilities to make/access arbitrary proposal values #6274 - triage: in
• Proposal: Quorum: reliable workflow #1539 (Important if 1.0 scenarios include direct Quorum manipulation (not through UpgradeManager)). - triage: cut
• There is a lot of confusion around Quorum vs. Audience usage, when they get updated, when clientId changes, etc. I believe we need to revisit this area and come up with either plan to make it better, or clear documentation / samples that clearly articulate usage / expectations. Inquiry to couple users (Teams, Bohemia) would be warranted here to solicit feedback. Related issues Try to assert that audience is superset of quorum #5251, view-only mode should issue "connected" event on current clientID being in audience #1733 - triage: in - needs more analysis

Waits should be deleted - new epic created

• Remove wait<> on directory and map, since they are hard to debug if they cause deadlock due to runtime being disposed #6188 (consider removing or taking into account disposed states) triage: in
• Infinite waits while resolving data stores / requests #4508 - triage: cut

Cleanup

• IFluidLoadable or IProvideFluidHandle ? #4165 - triage: in - deprecate one by 1.0
• Remove ComponentContext.documentId, Container.id #2903 - triage: in process
• Deprecation of existing flag (storage) #6033
• Epic: Remove _existing state from Fluid Framework (container, data store, DDS) #3429 - triage: in process
• Separating protocol from service packages #6073 - triage: cut
• (Re)Remove _createDataStoreWithProps from dataStoreContext.ts #3631 - triage: cut
• Replace Container Resume with Reconnect #1038
• As part of async summarization work, rename snapshotCore() and make it work with summaries #8013 - triage: in process

Composability

• Support building reusable components / eco-systems #4265 (Need to break it into more (actionable) items.) - triage: cut
• Consider removing access to global scope object on container runtime #3484 - triage: cut

IFluidObject: - new epic created

• Almost any interface change in the Fluid repo results in IFluidObject typing incompatibility #2566 - triage: in process
• Refactor IFluidObject into a few different types for different parts of the feature detection scenario #3275
• Remove certain "internal" interfaces from IFluidObject #3264 - triage: in

Versioning

• Ability to reject old loader / container runtime (compatibility) #1698 - triage: cut
• Any work around versioning and back compatibility

Lower priority issues / potential cut line

Signals

• Mechanism to choose leader that does not involve ops / modifying file #6544 - triage: cut
• Signal are lost on load path #5762 (We need to make a call on direction here. Likely documenting properly current expectations and future next steps is sufficient for 1.0. Having conformance testing to be included into FRS/ODSP stress test would be great.) - triage: cut
• Signal can be lost on data store creation path #682 - triage: cut

Handles & Requests

• Add Support Weak Handles for Components and DDS #1247
• Provide APIs to construct handles that contain 2 parts - base that points to GC node, and tail that participates only on object resolution #6001 - triage: cut
• Request resolution at data store level is ambiguous, may result in wrong route taken #3062 - triage: cut
• Deprecate IResponse #2781 - triage: cut
• Remove status codes and possibly mime type form request routing #4194 - triage: cut
• Make Runtime Request Handler API Reusable and Injectable #455

Loader

• Bring IContainer interfaces to maturity #2465 - triage: in - made this into an epic
• Loader Event on new Container resolve/request #5114 (This is more about policies, caching, and consistency than just event.) triage: cut
• Design/change how container is returned during loader.resolve() #4519 - triage: cut

Cleanup

• PureDataObject should ideally not expose (even as protected) context #8167
• Snapshot, summary, Tree entries: Need standardization and reduction of concepts. #4683 - triage: keep - made this into an epic
• Remove Git Concepts from Client Packages #4540
• remove snapshot() path from Container #3929 - triage: keep
• Cleanup ISnapshotTree  #4475 - triage: cut
• DataObject: Deprecate Container Services #3799 - triage: cut
• Go through all deprecated APIs and figure a plan to actually remove them. - triage: in

Other

• IFluidConfiguration should be removed #3854 - triage: cut
• Abstract away ContainerRuntime and revisit IContainerRuntime  #3677 - triage: cut
• Clearly Defining DataStoreContext #1357 - triage: cut
• Add cancelation tokens to read/write blob APIs #5192 (There are references to other items (request, loading data store, etc.)) - triage: cut
• Move Summarization to background #4912 (It will be much harder to implement it post 1.0. I.e. can we effort not to fix it now? Ever?) triage: cut
• API is inconsistent about use of property getter/setters #2561 - triage: cut
• Promises in DDS's that resolve when an op is ack'd should reject if ack can't be received #2088
• Handle support in SummarizableObject? #1683
• Stumbling blocks for Aqueduct data object authors #193 - triage: cut
• Decouple Merge Tree From Segment Implemenations  #77
• Lock down ways to instantiate a DDS #1845 - triage: cut

[ghost]

This issue has been automatically marked as stale because it has had no activity for 180 days. It will be closed if no further activity occurs within 8 days of this comment. Thank you for your contributions to Fluid Framework!