Fix record author bug #345
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…scovered bug Signed-off-by: Frank Hinek <[email protected]>
Signed-off-by: Frank Hinek <[email protected]>
Signed-off-by: Frank Hinek <[email protected]>
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
|
TBDocs Report ✅ No errors or warnings @web5/api
TBDocs Report Updated at 2023-12-09T21:16:42Z |
Signed-off-by: Frank Hinek <[email protected]>
frankhinek
force-pushed
the
fix-record-author-bug
branch
from
abc8e20 to
33f666a
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #345 +/- ##
==========================================
+ Coverage 92.69% 92.71% +0.01%
==========================================
Files 75 75
Lines 16838 16835 -3
Branches 1577 1578 +1
==========================================
Hits 15608 15608
+ Misses 1204 1201 -3
Partials 26 26
|
csuwildcat
approved these changes
Dec 9, 2023
LiranCohen
reviewed
Dec 11, 2023
| /** | ||
| * 4. Validate that Bob is able to write the record to Alice's remote DWN. | ||
| */ | ||
| const { status: sendStatusToAlice } = await queryRecordsFrom[0]!.send(aliceDid.did); |
There was a problem hiding this comment.
This last part of the test is confusing. It says bob is supposed to be able to write, however expects a 401.
LiranCohen
approved these changes
Dec 12, 2023
finn-block
pushed a commit
that referenced
this pull request
Mar 19, 2024
* Improve Record class test structure and add failing test for newly discovered bug * Rename remoteTarget to remoteOrigin * Correct typo in error message * Improve semantics of Record class --------- Signed-off-by: Frank Hinek <[email protected]>
finn-block
pushed a commit
that referenced
this pull request
Mar 19, 2024
* Improve Record class test structure and add failing test for newly discovered bug * Rename remoteTarget to remoteOrigin * Correct typo in error message * Improve semantics of Record class --------- Signed-off-by: Frank Hinek <[email protected]>
finn-block
pushed a commit
that referenced
this pull request
Mar 19, 2024
* Improve Record class test structure and add failing test for newly discovered bug * Rename remoteTarget to remoteOrigin * Correct typo in error message * Improve semantics of Record class --------- Signed-off-by: Frank Hinek <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR primarily focuses on fixing a bug reported by community members on Discord that occurred when interacting with records retrieved from remote DWNs and subsequent attempts to consume the data payload.
Context
A number of community members and TBD developers had reported that errors were returned when attempting to read data from
Recordinstances:Uncaught Error: DwnManager: Signing key not found for author: 'did:ion:...'Further troubleshooting revealed that when large (>
DwnConstant.maxDataSizeAllowedToBeEncoded) records authored/signed by one party (Alice) were written to another party's DWN (Bob), the recipient (Bob) was unable to access the data payload with the aforementioned error being thrown. This bug only surfaces when accessing the data (record.data.*) of a record signed by a different entity aRecordinstance's data, which requires fetching the data from a remote DWN. Since the large (>DwnConstant.maxDataSizeAllowedToBeEncoded) data was not returned with the query asencodedData, theRecordinstance's data is not available and must be fetched from the remote DWN using aRecordsReadmessage.What made this bug particularly difficult to track down is that the bug only surfaces when keys used to sign the record are different than the keys used to fetch the record AND both sets of keys are unavailable to the test Agent used by the entity that is attempting to fetch the record. In all of the other existing tests, the same test agent is used to store the keys for all entities (e.g., "Alice", "Bob", etc.) so the bug never surfaced.
Changes
@web5/apiauthorandtargetinRecordclass that had been acting as a stand in for theconnectedDid. This double-meaning has already introduced several bugs, so this PR removes the usage of the overloaded term and instead refers directly to theconnectedDid, where applicable.remoteTargettoremoteOriginto improve intuitiveness of semantic meaning.@web5/agent