@getjones/test-infra 5.2.10 → 5.2.12

package/src/saas/internal-api/auth/api/auth.api.js

@@ -1,78 +1,78 @@
-const requests = require('../../../../common/requests/cookieAuth/requests');
-const { backendUrl } = require('../../../../env').getEnv();
-
-const Endpoints = {
-	login: `${backendUrl}/logincontroller`,
-	verifyEmail: `${backendUrl}/verify/email`,
-	createOneTimeSession: `${backendUrl}/vendor-app/one-time-session/create`,
-	verifyUser: `${backendUrl}/vendor-app/one-time-session/verify-user`,
-	twoFAResendCode: `${backendUrl}/_saas/2fa/resend-code`,
-	twoFAVerify: `${backendUrl}/_saas/2fa/verify`,
-	getAuthenticatedUser: `${backendUrl}/authenticate/user`,
-	isHubUser: email => `${backendUrl}/vendor-app/is-hub-user?email=${encodeURIComponent(email)}`,
-	resetPassword: `${backendUrl}/reset-password`,
-	loginAttempt: `${backendUrl}/saas/integration-tests/user-login-attempt`
-};
-
-const login = (email, password) => {
-	return requests.postRequestHandler(Endpoints.login, { email, password });
-};
-
-const verifyEmail = email => {
-	return requests.postRequestHandler(Endpoints.verifyEmail, { email });
-};
-
-const createOneTimeSession = email => {
-	return requests.postRequestHandler(Endpoints.createOneTimeSession, { email });
-};
-
-const verifyUser = (email, oneTimeCode) => {
-	return requests.postRequestHandler(Endpoints.verifyUser, { email, oneTimeCode });
-};
-
-const twoFAResendCode = (email, pendingSessionToken) => {
-	return requests.postRequestHandler(Endpoints.twoFAResendCode, { email, pendingSessionToken });
-};
-
-const twoFAVerify = (email, code, pendingSessionToken) => {
-	return requests.postRequestHandler(Endpoints.twoFAVerify, { email, code, pendingSessionToken });
-};
-
-const getAuthenticatedUser = context => {
-	return requests.getRequestHandler(Endpoints.getAuthenticatedUser, {}, context);
-};
-
-const isHubUser = email => {
-	return requests.postRequestHandler(Endpoints.isHubUser(email), null);
-};
-
-const resetPassword = (password, linkData) => {
-	return requests.postRequestHandler(Endpoints.resetPassword, { password, linkData });
-};
-
-const getLoginAttempts = (email, context) => {
-	return requests.getRequestHandler(Endpoints.loginAttempt, { email }, context);
-};
-
-const backdateLoginAttempt = (body, context) => {
-	return requests.postRequestHandler(Endpoints.loginAttempt, body, context);
-};
-
-const deleteLoginAttempt = (email, context) => {
-	return requests.deleteRequestHandler(Endpoints.loginAttempt, context, {}, { email });
-};
-
-module.exports = {
-	login,
-	verifyEmail,
-	createOneTimeSession,
-	verifyUser,
-	twoFAResendCode,
-	twoFAVerify,
-	getAuthenticatedUser,
-	isHubUser,
-	resetPassword,
-	getLoginAttempts,
-	backdateLoginAttempt,
-	deleteLoginAttempt
-};
+const requests = require('../../../../common/requests/cookieAuth/requests');
+const { backendUrl } = require('../../../../env').getEnv();
+
+const Endpoints = {
+	login: `${backendUrl}/logincontroller`,
+	verifyEmail: `${backendUrl}/verify/email`,
+	createOneTimeSession: `${backendUrl}/vendor-app/one-time-session/create`,
+	verifyUser: `${backendUrl}/vendor-app/one-time-session/verify-user`,
+	twoFAResendCode: `${backendUrl}/_saas/2fa/resend-code`,
+	twoFAVerify: `${backendUrl}/_saas/2fa/verify`,
+	getAuthenticatedUser: `${backendUrl}/authenticate/user`,
+	isHubUser: email => `${backendUrl}/vendor-app/is-hub-user?email=${encodeURIComponent(email)}`,
+	resetPassword: `${backendUrl}/reset-password`,
+	loginAttempt: `${backendUrl}/saas/integration-tests/user-login-attempt`
+};
+
+const login = (email, password) => {
+	return requests.postRequestHandler(Endpoints.login, { email, password });
+};
+
+const verifyEmail = email => {
+	return requests.postRequestHandler(Endpoints.verifyEmail, { email });
+};
+
+const createOneTimeSession = email => {
+	return requests.postRequestHandler(Endpoints.createOneTimeSession, { email });
+};
+
+const verifyUser = (email, oneTimeCode) => {
+	return requests.postRequestHandler(Endpoints.verifyUser, { email, oneTimeCode });
+};
+
+const twoFAResendCode = (email, pendingSessionToken) => {
+	return requests.postRequestHandler(Endpoints.twoFAResendCode, { email, pendingSessionToken });
+};
+
+const twoFAVerify = (email, code, pendingSessionToken) => {
+	return requests.postRequestHandler(Endpoints.twoFAVerify, { email, code, pendingSessionToken });
+};
+
+const getAuthenticatedUser = context => {
+	return requests.getRequestHandler(Endpoints.getAuthenticatedUser, {}, context);
+};
+
+const isHubUser = email => {
+	return requests.postRequestHandler(Endpoints.isHubUser(email), null);
+};
+
+const resetPassword = (password, linkData) => {
+	return requests.postRequestHandler(Endpoints.resetPassword, { password, linkData });
+};
+
+const getLoginAttempts = (email, context) => {
+	return requests.getRequestHandler(Endpoints.loginAttempt, { email }, context);
+};
+
+const backdateLoginAttempt = (body, context) => {
+	return requests.postRequestHandler(Endpoints.loginAttempt, body, context);
+};
+
+const deleteLoginAttempt = (email, context) => {
+	return requests.deleteRequestHandler(Endpoints.loginAttempt, context, {}, { email });
+};
+
+module.exports = {
+	login,
+	verifyEmail,
+	createOneTimeSession,
+	verifyUser,
+	twoFAResendCode,
+	twoFAVerify,
+	getAuthenticatedUser,
+	isHubUser,
+	resetPassword,
+	getLoginAttempts,
+	backdateLoginAttempt,
+	deleteLoginAttempt
+};

package/src/saas/internal-api/auth/api/auth.service.js

@@ -1,172 +1,206 @@
-const { getEnv, requiredValidation, getSystemUserIdentity, addUserIdentity } = require('../../../../env');
-const { credentials } = getEnv();
-
-const httpResponseStatusCodes = require('../../../../common/httpResponseStatusCodes.json');
-
-const authApi = require('./auth.api');
-
-const getAuthCookie = async (email, password) => {
-	const systemUser = getSystemUserIdentity(email);
-
-	if (systemUser) {
-		return systemUser.cookie;
-	}
-
-	try {
-		const response = await authApi.login(email, password);
-
-		if (response.status !== httpResponseStatusCodes.OK) {
-			throw Error(`Error: ${JSON.stringify(response.data)}`);
-		}
-
-		const authCookie = response.headers['set-cookie'].find(item => item.startsWith('JonesToken='));
-
-		addUserIdentity(email, authCookie, response.data.user.id);
-
-		return authCookie;
-	} catch (error) {
-		throw new Error(`Failed to login with email: ${email}\nError: ${error}`);
-	}
-};
-
-const verifyEmail = email => {
-	return authApi.verifyEmail(email);
-};
-
-const createOneTimeSession = email => {
-	return authApi.createOneTimeSession(email);
-};
-
-const getHubUserCookie = async (email, oneTimeCode) => {
-	try {
-		const response = await authApi.verifyUser(email, oneTimeCode);
-
-		if (response.status !== httpResponseStatusCodes.OK && response.status !== httpResponseStatusCodes.NO_CONTENT) {
-			throw Error(`Error: ${JSON.stringify(response.data)}`);
-		}
-
-		const authCookie = response.headers['set-cookie'].find(item => item.startsWith('JonesToken='));
-
-		return authCookie;
-	} catch (error) {
-		throw new Error(`Failed to login to vendor hub by email:${email}`, error);
-	}
-};
-
-const getIcsCookie = () => {
-	const { superUser, superUserPassword } = credentials;
-
-	requiredValidation({
-		'credentials.superUser': superUser,
-		'credentials.superUserPassword': superUserPassword
-	});
-	return getAuthCookie(superUser, superUserPassword);
-};
-
-const getAuditorCookie = () => {
-	const { auditorUser, auditorPassword } = credentials;
-	requiredValidation({
-		'credentials.auditorUser': auditorUser,
-		'credentials.auditorPassword': auditorPassword
-	});
-	return getAuthCookie(auditorUser, auditorPassword);
-};
-
-const getOperatorCookie = () => {
-	const { operatorUser, operatorPassword } = credentials;
-	requiredValidation({
-		'credentials.operatorUser': operatorUser,
-		'credentials.operatorPassword': operatorPassword
-	});
-	return getAuthCookie(operatorUser, operatorPassword);
-};
-
-const login = (email, password) => {
-	return authApi.login(email, password);
-};
-
-const twoFAResendCode = (email, pendingSessionToken) => {
-	return authApi.twoFAResendCode(email, pendingSessionToken);
-};
-
-const twoFAVerify = (email, code, pendingSessionToken) => {
-	return authApi.twoFAVerify(email, code, pendingSessionToken);
-};
-
-const getAuthenticatedUser = context => {
-	return authApi.getAuthenticatedUser(context);
-};
-
-const isHubUser = async (email, { expectError } = {}) => {
-	const response = await authApi.isHubUser(email);
-
-	if (!expectError && response.status !== httpResponseStatusCodes.OK) {
-		throw new Error(`is-hub-user failed for ${email}: ${JSON.stringify(response.data)}`);
-	}
-
-	return response.data;
-};
-
-const resetPassword = async (password, linkData, { expectError = false } = {}) => {
-	const response = await authApi.resetPassword(password, linkData);
-
-	if (!expectError && response.status !== httpResponseStatusCodes.OK) {
-		throw Error(`Failed to reset password. Status code: ${response.status}`);
-	}
-
-	return response;
-};
-
-// Reads the user_login_attempt row via the ICS-secured test-only endpoint.
-// A 404 (no row ever created) is a distinct state from a cleared row (200, counter 0, null dates);
-// pass { expectError: true } to receive the raw response and tell them apart, otherwise the
-// wrapper throws on any non-200 rather than flattening a 404 into a zeroed row.
-const getLoginAttempts = async (email, { expectError } = {}) => {
-	const response = await authApi.getLoginAttempts(email, await getIcsCookie());
-
-	if (!expectError && response.status !== httpResponseStatusCodes.OK) {
-		throw new Error(`getLoginAttempts failed for ${email}: ${JSON.stringify(response.data)}`);
-	}
-
-	return expectError ? response : response.data;
-};
-
-// Backdates the failed-login timestamps for an existing row. The endpoint returns 204 No Content.
-const backdateLoginAttempt = async (email, { dateLastFailedLogin, dateFirstFailedLogin } = {}) => {
-	const response = await authApi.backdateLoginAttempt(
-		{ email, dateLastFailedLogin, dateFirstFailedLogin }, await getIcsCookie());
-
-	if (response.status !== httpResponseStatusCodes.NO_CONTENT && response.status !== httpResponseStatusCodes.OK) {
-		throw new Error(`backdateLoginAttempt failed for ${email}: ${JSON.stringify(response.data)}`);
-	}
-};
-
-// Clears the user_login_attempt row for an email via the ICS-secured test-only endpoint.
-// Idempotent: the endpoint returns 204 whether or not a row existed, so this is safe to call
-// on non-existent-email subjects when resetting lockout state between runs.
-const deleteLoginAttempt = async email => {
-	const response = await authApi.deleteLoginAttempt(email, await getIcsCookie());
-
-	if (response.status !== httpResponseStatusCodes.NO_CONTENT && response.status !== httpResponseStatusCodes.OK) {
-		throw new Error(`deleteLoginAttempt failed for ${email}: ${JSON.stringify(response.data)}`);
-	}
-};
-
-module.exports = {
-	getAuthCookie,
-	verifyEmail,
-	createOneTimeSession,
-	getHubUserCookie,
-	getIcsCookie,
-	getAuditorCookie,
-	getOperatorCookie,
-	login,
-	twoFAResendCode,
-	twoFAVerify,
-	getAuthenticatedUser,
-	isHubUser,
-	resetPassword,
-	getLoginAttempts,
-	backdateLoginAttempt,
-	deleteLoginAttempt
-};
+const { getEnv, requiredValidation, getSystemUserIdentity, addUserIdentity } = require('../../../../env');
+const { credentials } = getEnv();
+
+const httpResponseStatusCodes = require('../../../../common/httpResponseStatusCodes.json');
+
+const authApi = require('./auth.api');
+const timeUtils = require('../../../../common/utils/timeUtils');
+
+const RETRYABLE_LOGIN_STATUSES = [
+	httpResponseStatusCodes.BAD_GATEWAY,
+	httpResponseStatusCodes.SERVICE_UNAVAILABLE,
+	httpResponseStatusCodes.GATEWAY_TIMEOUT
+];
+const MAX_LOGIN_ATTEMPTS = 3;
+const LOGIN_RETRY_DELAY_SECONDS = 1;
+
+// Parallel callers for the same user share one login request
+const pendingLogins = new Map();
+
+const getAuthCookie = async (email, password) => {
+	const systemUser = getSystemUserIdentity(email);
+
+	if (systemUser) {
+		return systemUser.cookie;
+	}
+
+	if (!pendingLogins.has(email)) {
+		const login = loginAndCacheCookie(email, password).finally(() => pendingLogins.delete(email));
+		pendingLogins.set(email, login);
+	}
+
+	return pendingLogins.get(email);
+};
+
+const loginWithRetry = async (email, password) => {
+	for (let attempt = 1; ; attempt++) {
+		const response = await authApi.login(email, password);
+
+		if (!RETRYABLE_LOGIN_STATUSES.includes(response.status) || attempt === MAX_LOGIN_ATTEMPTS) {
+			return response;
+		}
+
+		console.warn(`Login for ${email} failed with status ${response.status}, retrying`);
+		await timeUtils.waitFor(LOGIN_RETRY_DELAY_SECONDS).seconds;
+	}
+};
+
+const loginAndCacheCookie = async (email, password) => {
+	try {
+		const response = await loginWithRetry(email, password);
+
+		if (response.status !== httpResponseStatusCodes.OK) {
+			throw Error(`Error: ${JSON.stringify(response.data)}`);
+		}
+
+		const authCookie = response.headers['set-cookie'].find(item => item.startsWith('JonesToken='));
+
+		addUserIdentity(email, authCookie, response.data.user.id);
+
+		return authCookie;
+	} catch (error) {
+		throw new Error(`Failed to login with email: ${email}\nError: ${error}`);
+	}
+};
+
+const verifyEmail = email => {
+	return authApi.verifyEmail(email);
+};
+
+const createOneTimeSession = email => {
+	return authApi.createOneTimeSession(email);
+};
+
+const getHubUserCookie = async (email, oneTimeCode) => {
+	try {
+		const response = await authApi.verifyUser(email, oneTimeCode);
+
+		if (response.status !== httpResponseStatusCodes.OK && response.status !== httpResponseStatusCodes.NO_CONTENT) {
+			throw Error(`Error: ${JSON.stringify(response.data)}`);
+		}
+
+		const authCookie = response.headers['set-cookie'].find(item => item.startsWith('JonesToken='));
+
+		return authCookie;
+	} catch (error) {
+		throw new Error(`Failed to login to vendor hub by email:${email}`, error);
+	}
+};
+
+const getIcsCookie = () => {
+	const { superUser, superUserPassword } = credentials;
+
+	requiredValidation({
+		'credentials.superUser': superUser,
+		'credentials.superUserPassword': superUserPassword
+	});
+	return getAuthCookie(superUser, superUserPassword);
+};
+
+const getAuditorCookie = () => {
+	const { auditorUser, auditorPassword } = credentials;
+	requiredValidation({
+		'credentials.auditorUser': auditorUser,
+		'credentials.auditorPassword': auditorPassword
+	});
+	return getAuthCookie(auditorUser, auditorPassword);
+};
+
+const getOperatorCookie = () => {
+	const { operatorUser, operatorPassword } = credentials;
+	requiredValidation({
+		'credentials.operatorUser': operatorUser,
+		'credentials.operatorPassword': operatorPassword
+	});
+	return getAuthCookie(operatorUser, operatorPassword);
+};
+
+const login = (email, password) => {
+	return authApi.login(email, password);
+};
+
+const twoFAResendCode = (email, pendingSessionToken) => {
+	return authApi.twoFAResendCode(email, pendingSessionToken);
+};
+
+const twoFAVerify = (email, code, pendingSessionToken) => {
+	return authApi.twoFAVerify(email, code, pendingSessionToken);
+};
+
+const getAuthenticatedUser = context => {
+	return authApi.getAuthenticatedUser(context);
+};
+
+const isHubUser = async (email, { expectError } = {}) => {
+	const response = await authApi.isHubUser(email);
+
+	if (!expectError && response.status !== httpResponseStatusCodes.OK) {
+		throw new Error(`is-hub-user failed for ${email}: ${JSON.stringify(response.data)}`);
+	}
+
+	return response.data;
+};
+
+const resetPassword = async (password, linkData, { expectError = false } = {}) => {
+	const response = await authApi.resetPassword(password, linkData);
+
+	if (!expectError && response.status !== httpResponseStatusCodes.OK) {
+		throw Error(`Failed to reset password. Status code: ${response.status}`);
+	}
+
+	return response;
+};
+
+// Reads the user_login_attempt row via the ICS-secured test-only endpoint.
+// A 404 (no row ever created) is a distinct state from a cleared row (200, counter 0, null dates);
+// pass { expectError: true } to receive the raw response and tell them apart, otherwise the
+// wrapper throws on any non-200 rather than flattening a 404 into a zeroed row.
+const getLoginAttempts = async (email, { expectError } = {}) => {
+	const response = await authApi.getLoginAttempts(email, await getIcsCookie());
+
+	if (!expectError && response.status !== httpResponseStatusCodes.OK) {
+		throw new Error(`getLoginAttempts failed for ${email}: ${JSON.stringify(response.data)}`);
+	}
+
+	return expectError ? response : response.data;
+};
+
+// Backdates the failed-login timestamps for an existing row. The endpoint returns 204 No Content.
+const backdateLoginAttempt = async (email, { dateLastFailedLogin, dateFirstFailedLogin } = {}) => {
+	const response = await authApi.backdateLoginAttempt(
+		{ email, dateLastFailedLogin, dateFirstFailedLogin }, await getIcsCookie());
+
+	if (response.status !== httpResponseStatusCodes.NO_CONTENT && response.status !== httpResponseStatusCodes.OK) {
+		throw new Error(`backdateLoginAttempt failed for ${email}: ${JSON.stringify(response.data)}`);
+	}
+};
+
+// Clears the user_login_attempt row for an email via the ICS-secured test-only endpoint.
+// Idempotent: the endpoint returns 204 whether or not a row existed, so this is safe to call
+// on non-existent-email subjects when resetting lockout state between runs.
+const deleteLoginAttempt = async email => {
+	const response = await authApi.deleteLoginAttempt(email, await getIcsCookie());
+
+	if (response.status !== httpResponseStatusCodes.NO_CONTENT && response.status !== httpResponseStatusCodes.OK) {
+		throw new Error(`deleteLoginAttempt failed for ${email}: ${JSON.stringify(response.data)}`);
+	}
+};
+
+module.exports = {
+	getAuthCookie,
+	verifyEmail,
+	createOneTimeSession,
+	getHubUserCookie,
+	getIcsCookie,
+	getAuditorCookie,
+	getOperatorCookie,
+	login,
+	twoFAResendCode,
+	twoFAVerify,
+	getAuthenticatedUser,
+	isHubUser,
+	resetPassword,
+	getLoginAttempts,
+	backdateLoginAttempt,
+	deleteLoginAttempt
+};

package/src/saas/internal-api/auth/index.js

@@ -1,3 +1,3 @@
-const services = require('./api/auth.service');
-
-module.exports = { services };
+const services = require('./api/auth.service');
+
+module.exports = { services };