Fix the handleSignIn() error object

In order to know if we should show the error description when sign in
errors occur, we were counting on the updateReason property being set on
the returning object. This was true until my last change, where we always
return a valid UserInfo (except in this one case). After my change, the
updateReason property was getting blown away and because of that, the
logic around when to show the error message could never be true.

Author: leakymemory

src/scripts/clipperUI/clipper.tsx

@@ -576,7 +576,7 @@ class ClipperClass extends ComponentBase<ClipperState, {}> {
 		let handleSignInEvent = new Log.Event.PromiseEvent(Log.Event.Label.HandleSignInEvent);
 
 		this.setState({ userResult: { status: Status.InProgress } });
-		type ErrorObject = { correlationId?: string, error: string, errorDescription: string };
+		type ErrorObject = { updateReason: UpdateReason, correlationId?: string, error: string, errorDescription: string };
 		Clipper.getExtensionCommunicator().callRemoteFunction(Constants.FunctionKeys.signInUser, { param: authType, callback: (data: UserInfo | ErrorObject) => {
 			// For cleaner referencing
 			let updatedUser = data as UserInfo;
@@ -598,7 +598,7 @@ class ClipperClass extends ComponentBase<ClipperState, {}> {
 				handleSignInEvent.setFailureInfo({ error: error });
 
 				errorObject.errorDescription = error;
-				this.state.setState({ userResult: { status: Status.Failed, data: updatedUser } });
+				this.state.setState({ userResult: { status: Status.Failed, data: errorObject } });
 
 				Clipper.logger.logUserFunnel(Log.Funnel.Label.AuthSignInFailed);
 			}

src/scripts/extensions/extensionWorkerBase.ts

@@ -511,6 +511,11 @@ export abstract class ExtensionWorkerBase<TTab, TTabIdentifier> {
 			}).catch((errorObject) => {
 				// Set the user info object to undefined as a result of an attempted sign in
 				this.auth.user.set({ updateReason: UpdateReason.SignInAttempt });
+
+				// Right now we're adding the update reason to the errorObject as well so that it is preserved in the callback.
+				// The right thing to do is revise the way we use callbacks in the communicator and instead use Promises so that
+				// we are able to return distinct objects.
+				errorObject.updateReason = UpdateReason.SignInAttempt;
 				return Promise.reject(errorObject);
 			});
 		});