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

Implement changes to MSC2285 (private read receipts) #2221

Merged

Conversation

SimonBrandner
Copy link
Contributor

@SimonBrandner SimonBrandner commented Mar 5, 2022

Type: enhancement
Implement changes to MSC2285 (hidden read receipts)
Requires matrix-org/matrix-react-sdk#7993
Requires matrix-org/synapse#12168


The changes in this PR shouldn't affect any clients which don't currently use the opts params.

sendReadReceipt(event: MatrixEvent, receiptType = ReceiptType.Read, callback?: Callback)

The opts param has been replaced with receiptType: ReceiptType. By default this is ReceiptType.Read and any other value is experimental.

setRoomReadMarkers(roomId: string, rmEventId: string, rrEvent?: MatrixEvent, rpEvent?: MatrixEvent)

The opts param has been replaced with rpEvent?: MatrixEvent. This param is optional and experimental. It allows you to specify a private read receipt not visible to other users

setRoomReadMarkersHttpRequest(roomId: string, rmEventId: string, rrEventId: string, rpEventId: string)

The opts param has been replaced with rpEventId: string. This param is optional and experimental. It allows you to specify a private read receipt not visible to other users


Here's what your changelog entry will look like:

🚨 BREAKING CHANGES

  • Implement changes to MSC2285 (private read receipts) (#2221).

Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
@codecov-commenter
Copy link

codecov-commenter commented Mar 5, 2022

Codecov Report

Merging #2221 (6b427ce) into develop (2ebf335) will increase coverage by 0.11%.
The diff coverage is 85.71%.

@@             Coverage Diff             @@
##           develop    #2221      +/-   ##
===========================================
+ Coverage    59.76%   59.88%   +0.11%     
===========================================
  Files           91       91              
  Lines        16456    16472      +16     
  Branches      3801     3807       +6     
===========================================
+ Hits          9835     9864      +29     
+ Misses        6621     6608      -13     
Impacted Files Coverage Δ
src/client.ts 38.77% <75.00%> (+0.65%) ⬆️
src/models/room.ts 57.23% <84.61%> (+0.14%) ⬆️
src/sync-accumulator.ts 75.54% <100.00%> (+1.11%) ⬆️

Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
@SimonBrandner SimonBrandner marked this pull request as ready for review March 6, 2022 07:22
@SimonBrandner SimonBrandner requested a review from a team as a code owner March 6, 2022 07:22
@SimonBrandner SimonBrandner changed the title Implement changes to MSC2285 Implement changes to MSC2285 (hidden read receipts) Mar 7, 2022
Copy link
Member

@t3chguy t3chguy left a comment

Choose a reason for hiding this comment

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

Looks sane otherwise

src/sync-accumulator.ts Outdated Show resolved Hide resolved
src/sync-accumulator.ts Outdated Show resolved Hide resolved
src/client.ts Outdated Show resolved Hide resolved
src/client.ts Outdated Show resolved Hide resolved
src/client.ts Outdated Show resolved Hide resolved
Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
…read-receipts

Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
…read-receipts

Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
…read-receipts

Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
…read-receipts

Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
@SimonBrandner SimonBrandner changed the title Implement changes to MSC2285 (hidden read receipts) Implement changes to MSC2285 (private read receipts) May 5, 2022
src/models/room.ts Show resolved Hide resolved
src/models/room.ts Outdated Show resolved Hide resolved
Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
@SimonBrandner SimonBrandner requested a review from t3chguy May 6, 2022 18:50
src/models/room.ts Outdated Show resolved Hide resolved
Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
@SimonBrandner SimonBrandner requested a review from t3chguy May 6, 2022 19:28
@SimonBrandner SimonBrandner merged commit da69ca2 into matrix-org:develop May 6, 2022
@SimonBrandner SimonBrandner deleted the feature/private-read-receipts branch May 6, 2022 19:32
su-ex added a commit to SchildiChat/matrix-js-sdk that referenced this pull request May 28, 2022
* Implement changes to MSC2285 (private read receipts) ([\matrix-org#2221](matrix-org#2221)).
* Add support for HTML renderings of room topics ([\matrix-org#2272](matrix-org#2272)).
* Add stopClient parameter to MatrixClient::logout ([\matrix-org#2367](matrix-org#2367)).
* registration: add function to re-request email token ([\matrix-org#2357](matrix-org#2357)).
* Remove hacky custom status feature ([\matrix-org#2350](matrix-org#2350)).
* Remove default push rule override for MSC1930 ([\matrix-org#2376](matrix-org#2376)). Fixes element-hq/element-web#15439.
* Tweak thread creation & event adding to fix bugs around relations ([\matrix-org#2369](matrix-org#2369)). Fixes element-hq/element-web#22162 and element-hq/element-web#22180.
* Prune both clear & wire content on redaction ([\matrix-org#2346](matrix-org#2346)). Fixes element-hq/element-web#21929.
* MSC3786: Add a default push rule to ignore `m.room.server_acl` events ([\matrix-org#2333](matrix-org#2333)). Fixes element-hq/element-web#20788.
gleachkr added a commit to opentower/populus-viewer that referenced this pull request Jul 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants