Skip to content

fixed issue that didn't allow a user to update a document when deleting elements in an array attribute - #495

Merged
christyjacob4 merged 3 commits into
appwrite:mainfrom
safwanyp:fix-5476-user-unable-to-update-document-after-array-value-deletion
Aug 11, 2023
Merged

fixed issue that didn't allow a user to update a document when deleting elements in an array attribute#495
christyjacob4 merged 3 commits into
appwrite:mainfrom
safwanyp:fix-5476-user-unable-to-update-document-after-array-value-deletion

Conversation

@safwanyp

@safwanypsafwanyp commented Aug 8, 2023•
edited by stnguyen90
Loading

Copy link
Copy Markdown
Contributor

Use symmetricDifference instead of difference.

  • difference only returns values that are present in the edited attributes, but not in the originally fetched attribute vales. This always ends up returning an empty array.
  • I used symmetricDifference as it returns an intersection of difference from both sides and works perfectly for this use case, as the original attributes never change.

What does this PR do?

This PR closesappwrite/appwrite#5476

Test Plan

  • In addition to the existing tests, I performed manual testing by adding and deleting elements in an array attribute.
  • I was going to change the way the difference function worked, but realized it was being used in other places, which broke things. I used the symmetricDifference function as it fits in perfectly for this use case.

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

Yes ✅

@safwanyp
fixed incorrect array being used in comparison
da00454
Use `symmetricDifference` instead of `difference`.
- `difference` only returns values that are present in the edited attributes, but not in the originally fetched attribute vales. This always ends up returning an empty array.
- I used `symmetricDifference` as it returns an intersection of `difference` from both sides and works perfectly for this use case, as the original attributes never change.
@vercel

vercelBot commented Aug 8, 2023

Copy link
Copy Markdown

@safwanyp is attempting to deploy a commit to the appwrite Team on Vercel.

A member of the Team first needs to authorize it.

@safwanyp

safwanyp commented Aug 8, 2023

Copy link
Copy Markdown
ContributorAuthor

Okay I just realized there's another bug.
Although elements can be deleted, existing items cannot be edited. The Update button stays disabled even after changing values. Should I create a new issue for that, or push a commit to fix it in this PR?

@safwanypsafwanyp changed the title fixed incorrect array being used in comparisonfixed issue that didn't allow a user to update a document when deleting elements in an array attributeAug 8, 2023
@safwanyp

safwanyp commented Aug 9, 2023

Copy link
Copy Markdown
ContributorAuthor

Okay so I figured out the issue that prevents updating of a document when editing the elements of an array attribute.

In the code it seems like $work stores the value of edited values. $work is populated by iterating over $doc, but they are referencing the same underlying value, no? Due to this, when $work is populated, $doc is updated as well, which results in both the arrays having no difference.

I can think of 2 solutions to this:

  1. Use JSON.parse(JSON.stringify($doc)) to clone the $doc, and not reference copy.
  2. Use a locally decalred variable instead of formValues[attribute.key][index] in <AttributeItem />, which can be passed into the <Attribute /> component. Obviously, the local variable will be updated when there's a change.

I have only tested with the first approach as it doesn't mess with the functionality outside of the required component.

@TGlide
TGlide requested review from ArmanNik and TGlideAugust 9, 2023 11:51
@TGlide

TGlide commented Aug 9, 2023

Copy link
Copy Markdown
Contributor

Okay so I figured out the issue that prevents updating of a document when editing the elements of an array attribute.

In the code it seems like $work stores the value of edited values. $work is populated by iterating over $doc, but they are referencing the same underlying value, no? Due to this, when $work is populated, $doc is updated as well, which results in both the arrays having no difference.

I can think of 2 solutions to this:

1. Use `JSON.parse(JSON.stringify($doc))` to clone the $doc, and not reference copy.
2. Use a locally decalred variable instead of `formValues[attribute.key][index]` in `<AttributeItem />`, which can be passed into the `<Attribute />` component. Obviously, the local variable will be updated when there's a change.

I have only tested with the first approach as it doesn't mess with the functionality outside of the required component.

Hi @safwanyp! Thank you for the PR 😄

I'd say doing a deepClone with JSON.parse should be enough. I'd recommend creating an utility for it in helpers/object.ts

@safwanyp
use deep clone instead of reference copy
399ec90
- Original code creates a reference copy of `$doc` into `$work` which means that editing values of `$work` changes the values in `$doc`.
- Fix this behaviour by creating a deep clone of `$doc` into `$work`, so underlying values aren't cross-referenced.
@safwanyp

safwanyp commented Aug 10, 2023

Copy link
Copy Markdown
ContributorAuthor

Hey @TGlide, thanks for the feedback and pointers!

I've just pushed a commit that creates a deepClone utility function, and uses it to create a copy of $doc into $work. Tests were successful on local copy. Appreciate any feedback!

TGlide
TGlide reviewed Aug 10, 2023
View reviewed changes
Comment thread.../databases/database-[database]/collection-[collection]/document-[document]/data/+page.svelte Outdated
Comment on lines +26 to +42
deepClone(
Object.keys($doc)
.filter((key) => {
return ![
'$id',
'$collection',
'$collectionId',
'$databaseId',
'$createdAt',
'$updatedAt'
].includes(key);
})
.reduce((obj, key) => {
obj[key] = $doc[key];
return obj;
}, {}) as Models.Document
)

@TGlideTGlideAug 10, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think this function has become quite verbose.

As an alternative, we can create an initWork function, where we have better control flow.

e.g.

functioninitWork(){letprohibitedKeys=['$id', ...];constfilteredKeys=Object.keys($doc)// So on and so forth..}constwork=initWork()

@safwanypsafwanypAug 10, 2023

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

that's fair. I'll work on this 👍🏻

@safwanyp
Simplify initialization of editable attributes for clarity
5ad0349
Instead of cramming all the steps for correct deep cloning, I split the implementation into 4 distinct steps:
- define they keys to exclude
- filtering the keys
- reduce filtered keys into an object
- returning a writable deep clone
@safwanyp
safwanyp requested a review from TGlideAugust 10, 2023 11:53
@vercel

vercelBot commented Aug 11, 2023•
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
console✅ Ready (Inspect)Visit Preview💬 Add feedbackAug 11, 2023 1:04pm
console-cloud✅ Ready (Inspect)Visit Preview💬 Add feedbackAug 11, 2023 1:04pm
console-next✅ Ready (Inspect)Visit Preview💬 Add feedbackAug 11, 2023 1:04pm

@christyjacob4
christyjacob4 merged commit 2a0628a into appwrite:mainAug 11, 2023
@safwanypsafwanyp mentioned this pull request Aug 13, 2023
Closed
2 tasks
This was referenced Sep 1, 2023
Closed
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@christyjacob4christyjacob4christyjacob4 approved these changes
@ArmanNikArmanNikAwaiting requested review from ArmanNik
+1 more reviewer
@TGlideTGlideTGlide approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

🐛 Bug Report: Can't update document after deleting array element

3 participants

@safwanyp@TGlide@christyjacob4