PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Minor refactoring; remove debug logging; add comments

Browse source
This commit is contained in:
Kegan Dougal 2015-11-19 16:07:58 +00:00
parent cc74676718
commit b12f0f1df7
2 changed files with 48 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
src/Signup.js
View file

@ -6,6 +6,10 @@ var q = require("q");
const EMAIL_STAGE_TYPE = "m.login.email.identity";
/**
* A base class for common functionality between Registration and Login e.g.
* storage of HS/IS URLs.
*/
class Signup {
constructor(hsUrl, isUrl) {
this._hsUrl = hsUrl;
@ -29,13 +33,16 @@ class Signup {
}
}
/**
* Registration logic class
*/
class Register extends Signup {
constructor(hsUrl, isUrl) {
super(hsUrl, isUrl);
this.setStep("START");
this.data = null; // from the server
this.params = {}; // random other stuff (e.g. query params, NOT params from the server)
// random other stuff (e.g. query params, NOT params from the server)
this.params = {};
this.credentials = null;
this.activeStage = null;
this.registrationPromise = null;
@ -104,12 +111,12 @@ class Register extends Signup {
this._hsUrl,
this._isUrl
);
console.log("register(formVals)");
console.log("Starting registration process (form submission)");
return this._tryRegister();
}
_tryRegister(authDict) {
console.log("_tryRegister %s", JSON.stringify(authDict));
console.log("Trying to register with auth dict: %s", JSON.stringify(authDict));
var self = this;
return MatrixClientPeg.get().register(
this.username, this.password, this.params.sessionId, authDict
@ -163,6 +170,11 @@ class Register extends Signup {
}
}
hasCompletedStage(stageType) {
var completed = (this.data || {}).completed || [];
return completed.indexOf(stageType) !== -1;
}
startStage(stageName) {
var self = this;
this.setStep(`STEP_${stageName}`);
@ -175,8 +187,8 @@ class Register extends Signup {
var stage = new StageClass(MatrixClientPeg.get(), this);
this.activeStage = stage;
return stage.complete().then(function(request) {
console.log("Stage %s completed with %s", stageName, JSON.stringify(request));
if (request.auth) {
console.log("Stage %s is returning an auth dict", stageName);
return self._tryRegister(request.auth);
}
else {
@ -189,11 +201,6 @@ class Register extends Signup {
});
}
hasCompletedStage(stageType) {
var completed = (this.data || {}).completed || [];
return completed.indexOf(stageType) !== -1;
}
chooseFlow(flows) {
// If the user gave us an email then we want to pick an email
// flow we can do, else any other flow.
@ -248,7 +255,6 @@ class Register extends Signup {
);
if (this.params.hasEmailInfo) {
console.log("recheckState has email info.. starting email info..");
this.registrationPromise = this.startStage(EMAIL_STAGE_TYPE);
}
return this.registrationPromise;

47
src/SignupStages.js
View file

@ -1,6 +1,9 @@
"use strict";
var q = require("q");
/**
* An interface class which login types should abide by.
*/
class Stage {
constructor(type, matrixClient, signupInstance) {
this.type = type;
@ -24,6 +27,9 @@ class Stage {
Stage.TYPE = "NOT IMPLEMENTED";
/**
* This stage requires no auth.
*/
class DummyStage extends Stage {
constructor(matrixClient, signupInstance) {
super(DummyStage.TYPE, matrixClient, signupInstance);
@ -40,17 +46,24 @@ class DummyStage extends Stage {
DummyStage.TYPE = "m.login.dummy";
/**
* This stage uses Google's Recaptcha to do auth.
*/
class RecaptchaStage extends Stage {
constructor(matrixClient, signupInstance) {
super(RecaptchaStage.TYPE, matrixClient, signupInstance);
this.defer = q.defer();
this.publicKey = null;
this.defer = q.defer(); // resolved with the captcha response
this.publicKey = null; // from the HS
this.divId = null; // from the UI component
}
// called when the UI component has loaded the recaptcha <div> so we can
// render to it.
onReceiveData(data) {
if (data !== "loaded") {
if (!data || !data.divId) {
return;
}
this.divId = data.divId;
this._attemptRender();
}
@ -81,9 +94,13 @@ class RecaptchaStage extends Stage {
console.error("No public key for recaptcha!");
return;
}
if (!this.divId) {
console.error("No div ID specified!");
return;
}
console.log("Rendering to %s", this.divId);
var self = this;
// FIXME: Tight coupling here and in CaptchaForm.js
global.grecaptcha.render('mx_recaptcha', {
global.grecaptcha.render(this.divId, {
sitekey: this.publicKey,
callback: function(response) {
console.log("Received captcha response");
@ -100,13 +117,16 @@ class RecaptchaStage extends Stage {
RecaptchaStage.TYPE = "m.login.recaptcha";
/**
* This state uses the IS to verify email addresses.
*/
class EmailIdentityStage extends Stage {
constructor(matrixClient, signupInstance) {
super(EmailIdentityStage.TYPE, matrixClient, signupInstance);
}
_completeVerify() {
console.log("_completeVerify");
// pull out the host of the IS URL by creating an anchor element
var isLocation = document.createElement('a');
isLocation.href = this.signupInstance.getIdentityServerUrl();
@ -130,20 +150,15 @@ class EmailIdentityStage extends Stage {
* 2) When validating query parameters received from the link in the email
*/
complete() {
console.log("Email complete()");
// TODO: The Registration class shouldn't really know this info.
if (this.signupInstance.params.hasEmailInfo) {
return this._completeVerify();
}
var config = {
clientSecret: this.client.generateClientSecret(),
sendAttempt: 1
};
this.signupInstance.params[EmailIdentityStage.TYPE] = config;
var clientSecret = this.client.generateClientSecret();
var nextLink = this.signupInstance.params.registrationUrl +
'?client_secret=' +
encodeURIComponent(config.clientSecret) +
encodeURIComponent(clientSecret) +
"&hs_url=" +
encodeURIComponent(this.signupInstance.getHomeserverUrl()) +
"&is_url=" +
@ -153,8 +168,8 @@ class EmailIdentityStage extends Stage {
return this.client.requestEmailToken(
this.signupInstance.email,
config.clientSecret,
config.sendAttempt,
clientSecret,
1, // TODO: Multiple send attempts?
nextLink
).then(function(response) {
return {}; // don't want to make a request