feat: Add `saveEventually` and `deleteEventually` in `ParseObject` #911

mbfakourii · 2023-05-19T15:28:12Z

Pull Request

Report security issues confidentially.
Any contribution is under this license.
Link this pull request to an issue.

Issue

Closes: #149 and #194

Approach

In this feature, Functions saveEventually and deleteEventually in ParseObject were added

---> in saveEventually
At first, normal save command is entered in parseObject, if a NetworkError is encountered, this object is saved in a list with a key with the help of ParseCoreData.
In our collection, we have a list of objects in ParseCoreData that are in NetworkError.

---> in deleteEventually
At first, normal delete command is entered in parseObject, if a NetworkError is encountered, this object is saved in a list with a key with the help of ParseCoreData.
In our collection, we have a list of objects in ParseCoreData that are in NetworkError.

---> in await ParseObject.submitEventually()
With the help of the function await ParseObject.submitEventually() (which is debatable how to use it) we checks the error objcets

In this function, we first get the error parseObjects from ParseCoreData, then we send this list to _saveChildren. In this function, these objects are sent to the server in the form of chunks, and finally, we empty the ParseCoreData list.

In the following, we also take the list of parseObjects that must be deleted from ParseCoreData and try to delete them, and then we delete the successfully deleted parseObjects from the ParseCoreData list.

@parse-community/flutter-sdk-review
Please check these two functions thoroughly and give suggestions, this PR needs discussion.
and please check the algorithm, is this method good?

Tasks

Add tests
Add changes to documentation (guides, repository pages, code comments)

parse-github-assistant · 2023-05-19T15:28:14Z

I will reformat the title to use the proper commit message syntax.

parse-github-assistant · 2023-05-19T15:28:17Z

Thanks for opening this pull request!

codecov · 2023-05-19T15:32:11Z

Codecov Report

Attention: 9 lines in your changes are missing coverage. Please review.

Comparison is base (21ce56f) 39.61% compared to head (638440b) 40.60%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #911      +/-   ##
==========================================
+ Coverage   39.61%   40.60%   +0.98%     
==========================================
  Files          60       60              
  Lines        3337     3401      +64     
==========================================
+ Hits         1322     1381      +59     
- Misses       2015     2020       +5

Files	Coverage Δ
packages/dart/lib/parse_server_sdk.dart	`31.25% <50.00%> (+2.67%)`	⬆️
...ackages/dart/lib/src/network/parse_dio_client.dart	`0.00% <0.00%> (ø)`
...ckages/dart/lib/src/network/parse_http_client.dart	`5.06% <0.00%> (-0.07%)`	⬇️
packages/dart/lib/src/utils/parse_utils.dart	`76.27% <75.00%> (-0.20%)`	⬇️
packages/dart/lib/src/objects/parse_object.dart	`94.49% <92.85%> (-0.42%)`	⬇️

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mtrezza · 2023-05-20T16:13:23Z

Please check these two functions thoroughly and give suggestions, this PR needs discussion.

Changed to draft

mbfakourii · 2023-05-21T15:52:17Z

@mtrezza @Nidal-Bakir
Do you think the implemented method is appropriate?

Nidal-Bakir · 2023-05-21T23:13:45Z

I suggest looking at what other SDKs do and doing the same. There is the concept of a Queue so the objects get saved in order.

Do other SDKs save the unsaved Objects even when the app is closed(destroyed) using native services (android and iOS) when the connection is restored for example?

mbfakourii · 2023-05-22T05:26:37Z

I suggest looking at what other SDKs do and doing the same. There is the concept of a Queue so the objects get saved in order.

Do other SDKs save the unsaved Objects even when the app is closed(destroyed) using native services (android and iOS) when the connection is restored for example?

I think the queue issue happens in dio or Http and we don't need to create this queue.

According to the ios documentation

saveEventually

Saves this object to the server at some unspecified time in the future, even if Parse is currently inaccessible.

Use this when you may not have a solid network connection, and don’t need to know when the save completes. If there is some problem with the object such that it can’t be saved, it will be silently discarded.

Objects saved with this method will be stored locally in an on-disk cache until they can be delivered to Parse. They will be sent immediately if possible. Otherwise, they will be sent the next time a network connection is available. Objects saved this way will persist even after the app is closed, in which case they will be sent the next time the app is opened. If more than 10MB of data is waiting to be sent, subsequent calls to -saveEventually will cause old saves to be silently discarded until the connection can be re-established, and the queued objects can be saved.

Based on what I understand, the internal structure of Android is implemented with this concept. If possible, take a look at the Android structure.

The concept that I didn't understand was where to double check and send the saved it objects?

I wrote the codes of this section in the await ParseObject.submitEventually() function! And I allow the user to use it wherever they need. But not sure about that !

refactor: Add `CONTRIBUTING.md`

Nidal-Bakir

Overall everything is good.

I have some thoughts:

What will happen if the current user logs out?
- should we clear the cache? or could you give the end user the option to decide what should happen?
should we give the end user control over the cached objects that need to be saved/deleted?

packages/dart/lib/src/objects/parse_object.dart

Nidal-Bakir · 2023-05-26T12:19:51Z

packages/dart/lib/src/objects/parse_object.dart

@@ -677,4 +722,89 @@ class ParseObject extends ParseBase implements ParseCloneable {
      return this;
    }
  }
+
+  static Future<ParseResponse?> submitEventually(


who should call this faction the end-user or the SDK itself when initialized?

Exactly my problem is here, I don't know where this function should be used, whether the user should call or the SDK and where in the SDK

mbfakourii · 2023-05-26T12:37:06Z

Overall everything is good.

I have some thoughts:

What will happen if the current user logs out?

should we clear the cache? or could you give the end user the option to decide what should happen?

should we give the end user control over the cached objects that need to be saved/deleted?

At the moment, the caches are not deleted, but I think a function should be written to delete the cache

Regarding the second question, I did not see anything in other SDKs. Do you have any suggestions for this? What control do you mean?

Nidal-Bakir · 2023-05-26T12:43:15Z

At the moment, the caches are not deleted, but I think a function should be written to delete the cache

Got it.

Regarding the second question, I did not see anything in other SDKs. Do you have any suggestions for this? What control do you mean?

I mean what if the user wants to clear the currently cached objects for saving/deleting and start over?
Should we expose such a feature?

Or in general, should we expose the current cache state so the end user can alter it?

If yes we should consider a saving mechanism like functions to be invoked. for example:

onBeforStartSaving()
shouldSave()
shouldDelete()
onBeforSave()
onBeforDelete()
onAfterSave()
onAfterDelete()
onAllSaved()
onAllDeleted()

something like that

mbfakourii · 2023-05-26T14:17:02Z

I mean what if the user wants to clear the currently cached objects for saving/deleting and start over? Should we expose such a feature?

Or in general, should we expose the current cache state so the end user can alter it?

If yes we should consider a saving mechanism like functions to be invoked. for example:

onBeforStartSaving()

shouldSave()

shouldDelete()

onBeforSave()

onBeforDelete()

onAfterSave()

onAfterDelete()

onAllSaved()

onAllDeleted()

something like that

I don't think this is necessary. I haven't seen anything about this in other SDKs. Do you have a reason why it needs to be added?

Nidal-Bakir · 2023-05-26T18:15:00Z

Do you have a reason why it needs to be added?

No, I'm just wounding if we need to give the end user finer control over the eventual save in general. If the other SDKs do not do that we are good.

So currently, we need to discuss how the submitEventually function should be called and what will happen when the user logs out when there are some unsaved objects.

mtrezza · 2023-08-09T23:02:47Z

What's missing in this PR to get it merged?

mbfakourii · 2023-08-10T03:20:54Z

What's missing in this PR to get it merged?

The code is finished, the tests must be written

mbfakourii · 2023-10-03T19:21:55Z

The error related to Test Flutter beta has been resolved in this PR

packages/dart/lib/src/objects/parse_object.dart

mbfakourii · 2023-10-09T05:55:12Z

@mtrezza

Done 😃

packages/dart/lib/src/objects/parse_object.dart

packages/dart/lib/parse_server_sdk.dart

mtrezza · 2023-10-09T11:20:45Z

Note for review: The Flutter test is failing, hence we need to merge #969 first before merging this PR.

mtrezza

Could you check whether I've resolved the conflicts correctly? Then I believe this can be merged.

mbfakourii · 2023-10-17T15:17:47Z

Could you check whether I've resolved the conflicts correctly? Then I believe this can be merged.

I checked, and there was no problem.

packages/dart/CHANGELOG.md

add saveEventually and deleteEventually

6fbd06c

parse-github-assistant bot changed the title ~~feat: add saveEventually and deleteEventually in ParseObject~~ feat: Add saveEventually and deleteEventually in ParseObject May 19, 2023

mbfakourii and others added 3 commits May 19, 2023 23:15

Merge branch 'master' into add_eventually

6ea7fc3

Merge branch 'master' into add_eventually

c9b68a9

Merge branch 'master' into add_eventually

46a9a9e

mtrezza marked this pull request as draft May 20, 2023 16:13

Merge branch 'master' into add_eventually

354054b

mbfakourii changed the title ~~feat: Add saveEventually and deleteEventually in ParseObject~~ feat: Added saveEventually and deleteEventually in ParseObject May 21, 2023

mtrezza requested a review from a team May 21, 2023 15:54

mbfakourii and others added 7 commits May 23, 2023 15:13

Merge branch 'master' into add_eventually

e1a5948

Create CONTRIBUTING.md

cde971b

Merge pull request #1 from mbfakourii/mbfakourii-patch-1

4e7ba14

refactor: Add `CONTRIBUTING.md`

just some styling

835a1db

Merge branch 'parse-community:master' into master

2b6997f

Merge branch 'parse-community:master' into master

45928d4

Merge branch 'master' into add_eventually

39168d3

Nidal-Bakir reviewed May 26, 2023

View reviewed changes

mbfakourii added 2 commits May 29, 2023 00:21

Merge branch 'parse-community:master' into master

f86d134

Merge branch 'parse-community:master' into master

79f9d4b

mbfakourii added 3 commits July 19, 2023 21:06

Merge branch 'master' into add_eventually

99c081b

Putting submitEventually in places to submit

01cd124

Merge branch 'parse-community:master' into master

69bffd2

mbfakourii mentioned this pull request Aug 9, 2023

Support Local Storage #963

Closed

Merge branch 'master' into add_eventually

22971e5

mbfakourii added 2 commits September 25, 2023 22:56

Merge branch 'parse-community:master' into master

f9c00d9

feat: add test

b46a1b9

mbfakourii marked this pull request as ready for review October 3, 2023 19:16

mbfakourii requested a review from a team October 3, 2023 19:16

mtrezza reviewed Oct 3, 2023

View reviewed changes

packages/dart/lib/src/objects/parse_object.dart Outdated Show resolved Hide resolved

mbfakourii added 2 commits October 4, 2023 11:45

fix: remove string and user response.

1ca99d5

fix: remove string and user consts.

d98dc40

mbfakourii requested a review from a team October 7, 2023 18:43

refactor: bump version and add entries in CHANGELOG.md.

287845c

mtrezza reviewed Oct 9, 2023

View reviewed changes

packages/dart/lib/src/objects/parse_object.dart Show resolved Hide resolved

packages/dart/lib/parse_server_sdk.dart Show resolved Hide resolved

mbfakourii changed the title ~~feat: Added saveEventually and deleteEventually in ParseObject~~ feat: Add saveEventually and deleteEventually in ParseObject Oct 13, 2023

Merge branch 'master' into add_eventually

9a6c089

mtrezza reviewed Oct 16, 2023

View reviewed changes

mbfakourii added 2 commits October 17, 2023 16:01

Merge branch 'parse-community:master' into master

10ae85e

Merge branch 'master' into add_eventually

638440b

mtrezza reviewed Oct 18, 2023

View reviewed changes

packages/dart/CHANGELOG.md Outdated Show resolved Hide resolved

Update packages/dart/CHANGELOG.md

36e8d56

mtrezza approved these changes Oct 18, 2023

View reviewed changes

mtrezza merged commit 9431086 into parse-community:master Oct 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add `saveEventually` and `deleteEventually` in `ParseObject` #911

feat: Add `saveEventually` and `deleteEventually` in `ParseObject` #911

mbfakourii commented May 19, 2023 •

edited

Loading

parse-github-assistant bot commented May 19, 2023

parse-github-assistant bot commented May 19, 2023

codecov bot commented May 19, 2023 •

edited

Loading

mtrezza commented May 20, 2023

mbfakourii commented May 21, 2023

Nidal-Bakir commented May 21, 2023

mbfakourii commented May 22, 2023 •

edited

Loading

Nidal-Bakir left a comment

Nidal-Bakir May 26, 2023

mbfakourii May 26, 2023

mbfakourii commented May 26, 2023 •

edited

Loading

Nidal-Bakir commented May 26, 2023 •

edited

Loading

mbfakourii commented May 26, 2023

Nidal-Bakir commented May 26, 2023 •

edited

Loading

mtrezza commented Aug 9, 2023

mbfakourii commented Aug 10, 2023 •

edited

Loading

mbfakourii commented Oct 3, 2023

mbfakourii commented Oct 9, 2023

mtrezza commented Oct 9, 2023

mtrezza left a comment

mbfakourii commented Oct 17, 2023 •

edited

Loading

feat: Add saveEventually and deleteEventually in ParseObject #911

feat: Add saveEventually and deleteEventually in ParseObject #911

Conversation

mbfakourii commented May 19, 2023 • edited Loading

Pull Request

Issue

Approach

Tasks

parse-github-assistant bot commented May 19, 2023

parse-github-assistant bot commented May 19, 2023

Thanks for opening this pull request!

codecov bot commented May 19, 2023 • edited Loading

Codecov Report

mtrezza commented May 20, 2023

mbfakourii commented May 21, 2023

Nidal-Bakir commented May 21, 2023

mbfakourii commented May 22, 2023 • edited Loading

Nidal-Bakir left a comment

Choose a reason for hiding this comment

Nidal-Bakir May 26, 2023

Choose a reason for hiding this comment

mbfakourii May 26, 2023

Choose a reason for hiding this comment

mbfakourii commented May 26, 2023 • edited Loading

Nidal-Bakir commented May 26, 2023 • edited Loading

mbfakourii commented May 26, 2023

Nidal-Bakir commented May 26, 2023 • edited Loading

mtrezza commented Aug 9, 2023

mbfakourii commented Aug 10, 2023 • edited Loading

mbfakourii commented Oct 3, 2023

mbfakourii commented Oct 9, 2023

mtrezza commented Oct 9, 2023

mtrezza left a comment

Choose a reason for hiding this comment

mbfakourii commented Oct 17, 2023 • edited Loading

feat: Add `saveEventually` and `deleteEventually` in `ParseObject` #911

feat: Add `saveEventually` and `deleteEventually` in `ParseObject` #911

mbfakourii commented May 19, 2023 •

edited

Loading

codecov bot commented May 19, 2023 •

edited

Loading

mbfakourii commented May 22, 2023 •

edited

Loading

mbfakourii commented May 26, 2023 •

edited

Loading

Nidal-Bakir commented May 26, 2023 •

edited

Loading

Nidal-Bakir commented May 26, 2023 •

edited

Loading

mbfakourii commented Aug 10, 2023 •

edited

Loading

mbfakourii commented Oct 17, 2023 •

edited

Loading