This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
Properly translate errors in AddThreepid.ts so they show up translated to the user but not in our logs
#10432
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,20 +17,21 @@ limitations under the License. | |
| */ | ||
|
|
||
| import { IAuthData, IRequestMsisdnTokenResponse, IRequestTokenResponse } from "matrix-js-sdk/src/matrix"; | ||
| import { MatrixError, HTTPError } from "matrix-js-sdk/src/matrix"; | ||
|
|
||
| import { MatrixClientPeg } from "./MatrixClientPeg"; | ||
| import Modal from "./Modal"; | ||
| import { _t, UserFriendlyError } from "./languageHandler"; | ||
| import IdentityAuthClient from "./IdentityAuthClient"; | ||
| import { SSOAuthEntry } from "./components/views/auth/InteractiveAuthEntryComponents"; | ||
| import InteractiveAuthDialog from "./components/views/dialogs/InteractiveAuthDialog"; | ||
|
|
||
| function getIdServerDomain(): string { | ||
| const idBaseUrl = MatrixClientPeg.get().getIdentityServerUrl(true); | ||
| if (!idBaseUrl) { | ||
| throw new UserFriendlyError("Identity server not set"); | ||
| } | ||
| return idBaseUrl; | ||
| } | ||
|
|
||
| export type Binding = { | ||
|
|
@@ -67,23 +68,18 @@ export default class AddThreepid { | |
| * @param {string} emailAddress The email address to add | ||
| * @return {Promise} Resolves when the email has been sent. Then call checkEmailLinkClicked(). | ||
| */ | ||
|
There was a problem hiding this comment. This bit of logging seems to get lost, is that intended? There was a problem hiding this comment. Yes, see #10432 (comment)
|
||
| public async addEmailAddress(emailAddress: string): Promise<IRequestTokenResponse> { | ||
|
There was a problem hiding this comment. These are just getting some |
||
| try { | ||
| const res = await MatrixClientPeg.get().requestAdd3pidEmailToken(emailAddress, this.clientSecret, 1); | ||
| this.sessionId = res.sid; | ||
| return res; | ||
| } catch (err) { | ||
| if (err instanceof MatrixError && err.errcode === "M_THREEPID_IN_USE") { | ||
|
There was a problem hiding this comment. By the nature of unifying our error handling, we're going to have "duplicate lines" that SonarCloud is calling out. Need an exception here. I've already de-duplicated some logic with |
||
| throw new UserFriendlyError("This email address is already in use", { cause: err }); | ||
| } | ||
| // Otherwise, just blurt out the same error | ||
| throw err; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -98,22 +94,23 @@ export default class AddThreepid { | |
| // For separate bind, request a token directly from the IS. | ||
| const authClient = new IdentityAuthClient(); | ||
| const identityAccessToken = (await authClient.getAccessToken()) ?? undefined; | ||
| try { | ||
| const res = await MatrixClientPeg.get().requestEmailToken( | ||
| emailAddress, | ||
| this.clientSecret, | ||
| 1, | ||
| undefined, | ||
| identityAccessToken, | ||
| ); | ||
| this.sessionId = res.sid; | ||
| return res; | ||
| } catch (err) { | ||
| if (err instanceof MatrixError && err.errcode === "M_THREEPID_IN_USE") { | ||
| throw new UserFriendlyError("This email address is already in use", { cause: err }); | ||
| } | ||
| // Otherwise, just blurt out the same error | ||
| throw err; | ||
| } | ||
| } else { | ||
| // For tangled bind, request a token via the HS. | ||
| return this.addEmailAddress(emailAddress); | ||
|
|
@@ -127,24 +124,24 @@ export default class AddThreepid { | |
| * @param {string} phoneNumber The national or international formatted phone number to add | ||
| * @return {Promise} Resolves when the text message has been sent. Then call haveMsisdnToken(). | ||
| */ | ||
| public async addMsisdn(phoneCountry: string, phoneNumber: string): Promise<IRequestMsisdnTokenResponse> { | ||
| try { | ||
| const res = await MatrixClientPeg.get().requestAdd3pidMsisdnToken( | ||
| phoneCountry, | ||
| phoneNumber, | ||
| this.clientSecret, | ||
| 1, | ||
| ); | ||
| this.sessionId = res.sid; | ||
| this.submitUrl = res.submit_url; | ||
| return res; | ||
| } catch (err) { | ||
| if (err instanceof MatrixError && err.errcode === "M_THREEPID_IN_USE") { | ||
| throw new UserFriendlyError("This phone number is already in use", { cause: err }); | ||
| } | ||
| // Otherwise, just blurt out the same error | ||
| throw err; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -160,22 +157,24 @@ export default class AddThreepid { | |
| // For separate bind, request a token directly from the IS. | ||
| const authClient = new IdentityAuthClient(); | ||
| const identityAccessToken = (await authClient.getAccessToken()) ?? undefined; | ||
| try { | ||
| const res = await MatrixClientPeg.get().requestMsisdnToken( | ||
| phoneCountry, | ||
| phoneNumber, | ||
| this.clientSecret, | ||
| 1, | ||
| undefined, | ||
| identityAccessToken, | ||
| ); | ||
| this.sessionId = res.sid; | ||
| return res; | ||
| } catch (err) { | ||
| if (err instanceof MatrixError && err.errcode === "M_THREEPID_IN_USE") { | ||
| throw new UserFriendlyError("This phone number is already in use", { cause: err }); | ||
| } | ||
| // Otherwise, just blurt out the same error | ||
| throw err; | ||
| } | ||
| } else { | ||
| // For tangled bind, request a token via the HS. | ||
| return this.addMsisdn(phoneCountry, phoneNumber); | ||
|
|
@@ -195,7 +194,7 @@ export default class AddThreepid { | |
| const authClient = new IdentityAuthClient(); | ||
| const identityAccessToken = await authClient.getAccessToken(); | ||
| if (!identityAccessToken) { | ||
| throw new UserFriendlyError("No identity access token found"); | ||
| } | ||
| await MatrixClientPeg.get().bindThreePid({ | ||
| sid: this.sessionId, | ||
|
|
@@ -210,10 +209,10 @@ export default class AddThreepid { | |
| // The spec has always required this to use UI auth but synapse briefly | ||
| // implemented it without, so this may just succeed and that's OK. | ||
| return [true]; | ||
| } catch (err) { | ||
| if (!(err instanceof MatrixError) || err.httpStatus !== 401 || !err.data || !err.data.flows) { | ||
| // doesn't look like an interactive-auth failure | ||
| throw err; | ||
| } | ||
|
|
||
| const dialogAesthetics = { | ||
|
|
@@ -235,7 +234,7 @@ export default class AddThreepid { | |
| const { finished } = Modal.createDialog(InteractiveAuthDialog, { | ||
| title: _t("Add Email Address"), | ||
| matrixClient: MatrixClientPeg.get(), | ||
| authData: err.data, | ||
| makeRequest: this.makeAddThreepidOnlyRequest, | ||
| aestheticsForStagePhases: { | ||
| [SSOAuthEntry.LOGIN_TYPE]: dialogAesthetics, | ||
|
|
@@ -256,11 +255,13 @@ export default class AddThreepid { | |
| ); | ||
| } | ||
| } catch (err) { | ||
| if (err instanceof HTTPError && err.httpStatus === 401) { | ||
| throw new UserFriendlyError( | ||
| "Failed to verify email address: make sure you clicked the link in the email", | ||
| { cause: err }, | ||
| ); | ||
| } | ||
| // Otherwise, just blurt out the same error | ||
| throw err; | ||
| } | ||
| return []; | ||
|
|
@@ -308,7 +309,7 @@ export default class AddThreepid { | |
| await authClient.getAccessToken(), | ||
| ); | ||
| } else { | ||
| throw new UserFriendlyError("The add / bind with MSISDN flow is misconfigured"); | ||
| } | ||
| if (result.errcode) { | ||
| throw result; | ||
|
|
@@ -329,10 +330,10 @@ export default class AddThreepid { | |
| // The spec has always required this to use UI auth but synapse briefly | ||
| // implemented it without, so this may just succeed and that's OK. | ||
| return; | ||
| } catch (err) { | ||
| if (!(err instanceof MatrixError) || err.httpStatus !== 401 || !err.data || !err.data.flows) { | ||
| // doesn't look like an interactive-auth failure | ||
| throw err; | ||
| } | ||
|
|
||
| const dialogAesthetics = { | ||
|
|
@@ -354,7 +355,7 @@ export default class AddThreepid { | |
| const { finished } = Modal.createDialog(InteractiveAuthDialog, { | ||
| title: _t("Add Phone Number"), | ||
| matrixClient: MatrixClientPeg.get(), | ||
| authData: err.data, | ||
| makeRequest: this.makeAddThreepidOnlyRequest, | ||
| aestheticsForStagePhases: { | ||
| [SSOAuthEntry.LOGIN_TYPE]: dialogAesthetics, | ||
|
|
||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The remaining strict TypeScript lints are tracked by element-hq/element-web#24899