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

feat: handle connection reject event #1020

Merged
merged 1 commit into from
Sep 18, 2024
Merged

feat: handle connection reject event #1020

merged 1 commit into from
Sep 18, 2024

Conversation

abretonc7s
Copy link
Collaborator

@abretonc7s abretonc7s commented Sep 11, 2024

Explanation

There is an issue with async key exchange when the connection is rejected on the wallet.

One of the improvement with aysnc key exchange is that nothing goes through the socket until the connection is accepted.

If the UI provies a diconnect or terminate button to re-initialize the connection there are no issues as the user can manually terminate and reconnect.

The solution is to add a rejected event to the protocol that will be emitted by the wallet and is only processed when the connection hasn’t completed.

References

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate

@abretonc7s abretonc7s self-assigned this Sep 11, 2024
@abretonc7s abretonc7s marked this pull request as ready for review September 11, 2024 04:24
@abretonc7s abretonc7s requested a review from a team as a code owner September 11, 2024 04:24
Copy link

codecov bot commented Sep 11, 2024

Codecov Report

Attention: Patch coverage is 38.75000% with 49 lines in your changes missing coverage. Please review.

Project coverage is 79.18%. Comparing base (91f61ba) to head (81f1cf4).
Report is 8 commits behind head on main.

Files with missing lines Patch % Lines
...teCommunication/ConnectionManager/rejectChannel.ts 14.81% 23 Missing ⚠️
...kages/sdk/src/provider/initializeMobileProvider.ts 0.00% 6 Missing ⚠️
...rvice/ConnectionManager/handleJoinChannelResult.ts 28.57% 5 Missing ⚠️
...ketService/EventListeners/handleChannelRejected.ts 69.23% 4 Missing ⚠️
.../src/services/RemoteConnection/RemoteConnection.ts 0.00% 3 Missing ⚠️
...sdk-communication-layer/src/RemoteCommunication.ts 50.00% 2 Missing ⚠️
packages/sdk-react/src/MetaMaskProvider.tsx 50.00% 2 Missing ⚠️
...oteConnection/ConnectionManager/startConnection.ts 33.33% 2 Missing ⚠️
...services/SocketService/ConnectionManager/resume.ts 50.00% 1 Missing ⚠️
...ion/ConnectionManager/connectWithModalInstaller.ts 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1020      +/-   ##
==========================================
- Coverage   80.00%   79.18%   -0.82%     
==========================================
  Files         177      179       +2     
  Lines        4025     4083      +58     
  Branches      997     1013      +16     
==========================================
+ Hits         3220     3233      +13     
- Misses        805      850      +45     

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

Copy link

@abretonc7s abretonc7s merged commit 0869b22 into main Sep 18, 2024
35 of 37 checks passed
@abretonc7s abretonc7s deleted the rejectconn branch September 18, 2024 22:00
github-merge-queue bot pushed a commit to MetaMask/metamask-mobile that referenced this pull request Sep 19, 2024
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

This PR is an update to the SDK communication protocol that allows the
following:
- prevent deleting connection until server confirmation
- emit rejection event 

## **Related issues**

- MetaMask/metamask-sdk#1020
- MetaMask/metamask-sdk#1022

## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [x] I’ve followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [x] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [x] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
abretonc7s added a commit to MetaMask/metamask-mobile that referenced this pull request Sep 19, 2024
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

This PR is an update to the SDK communication protocol that allows the
following:
- prevent deleting connection until server confirmation
- emit rejection event 

## **Related issues**

- MetaMask/metamask-sdk#1020
- MetaMask/metamask-sdk#1022

## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [x] I’ve followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [x] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [x] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
Daniel-Cross pushed a commit to MetaMask/metamask-mobile that referenced this pull request Sep 20, 2024
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

This PR is an update to the SDK communication protocol that allows the
following:
- prevent deleting connection until server confirmation
- emit rejection event 

## **Related issues**

- MetaMask/metamask-sdk#1020
- MetaMask/metamask-sdk#1022

## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [x] I’ve followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [x] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [x] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
@abretonc7s abretonc7s mentioned this pull request Oct 3, 2024
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