Skip to content
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.

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

Add RFC for offline support #54

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

stnguyen90
Copy link

What does this PR do?

To see rendered document, see https://github.com/appwrite/rfc/tree/feat-offline-support/021-offline-support.

Test Plan

  1. Alpha release
  2. Beta release

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

Yes

### API Changes
<!-- Do we need new API endpoints? List and describe them and their API signatures -->

The Appwrite API will acceprt the new `X-Appwrite-Timestamp` header. The header will be used to initalize the relevant database instance. We need to figure whether a similar approach should also be taken for the different workers.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo acceprt

### Tests (UI, Unit, E2E)
<!-- How will we test this feature? -->

We need to add a test for offline support as part of the SDK generator. We can achieve offline simulation using built in platofrm features or if not possible to create a method in the SDK to mock the network conectivty and overwrite the device/browser original status.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo conectivty


### Data

Data is cached locally into into local collections. Each Appwrite Model is stored in it's own local collection. For example, the List Contintents API returns a list of `Continent` objects so there is a local `/locale/continents` collection.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: into into

@stnguyen90 stnguyen90 marked this pull request as draft October 5, 2023 18:56
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