feat: inactive users index

Author: pajgo

rfcs/inactive_users/user_index.md

@@ -0,0 +1,22 @@
+# Inactive users index
+
+## Overview and motivation
+As other task dependency and to provide additional internal statistics the Service needs additional index
+to track users that didn't pass the activation.
+
+## `inactive-users` index
+It's an Additional Redis Sorted Set which contains the list of IDs of the `inactive` users.
+Each item score is equal to the `timestamp` set on user creation.
+
+To avoid hardcoded SET name new `USERS_INACTIVATED` constant introduced.
+
+## Inactive user tracking utils
+New `deleteFromInactiveUsers(userID)` and `addToInactiveUsers(userID)` methods used to control data stored inside `inactive-users` set.
+
+## Registration process
+When the user succeeds registration but activation not requested, the new entry added to `inactive-users`.
+
+**NOTE:** Old Redis `expire` setting methods left in their place, to save old service behavior.
+
+## Activation process
+When the user succeeds activation the entry deleted from `inactive-users`.

src/actions/activate.js

@@ -5,6 +5,8 @@ const jwt = require('../utils/jwt.js');
 const { getInternalData } = require('../utils/userData');
 const getMetadata = require('../utils/getMetadata');
 const handlePipeline = require('../utils/pipelineError.js');
+const { removeFromInactiveUsers } = require('../utils/inactiveUsers');
+
 const {
   USERS_INDEX,
   USERS_DATA,
@@ -126,6 +128,9 @@ function activateAccount(data, metadata) {
     .persist(userKey)
     .sadd(USERS_INDEX, userId);
 
+  /* delete user id from the inactive users index */
+  removeFromInactiveUsers(pipeline, userId);
+
   if (alias) {
     pipeline.sadd(USERS_PUBLIC_INDEX, userId);
   }

src/actions/register.js

@@ -22,6 +22,8 @@ const checkLimits = require('../utils/checkIpLimits');
 const challenge = require('../utils/challenges/challenge');
 const handlePipeline = require('../utils/pipelineError');
 const hashPassword = require('../utils/register/password/hash');
+const { addToInactiveUsers } = require('../utils/inactiveUsers');
+
 const {
   USERS_REF,
   USERS_INDEX,
@@ -208,7 +210,11 @@ async function performRegistration({ service, params }) {
   pipeline.hset(USERS_USERNAME_TO_ID, username, userId);
 
   if (activate === false && config.deleteInactiveAccounts >= 0) {
+    /* TODO Remove this line when last task in group merged */
     pipeline.expire(userDataKey, config.deleteInactiveAccounts);
+
+    /* Add user id to the inactive users index */
+    addToInactiveUsers(pipeline, userId, audience);
   }
 
   await pipeline.exec().then(handlePipeline);

src/actions/remove.js

@@ -9,6 +9,7 @@ const getMetadata = require('../utils/getMetadata');
 const handlePipeline = require('../utils/pipelineError');
 const {
   USERS_INDEX,
+  USERS_INACTIVATED,
   USERS_PUBLIC_INDEX,
   USERS_ALIAS_TO_ID,
   USERS_SSO_TO_ID,
@@ -92,6 +93,9 @@ async function removeUser({ params }) {
   transaction.srem(USERS_PUBLIC_INDEX, userId);
   transaction.srem(USERS_INDEX, userId);
 
+  /* Delete user from the inactive users index, if user not activated */
+  transaction.zrem(USERS_INACTIVATED, userId);
+
   // remove metadata & internal data
   transaction.del(key(userId, USERS_DATA));
   transaction.del(key(userId, USERS_METADATA, audience));

src/constants.js

@@ -6,6 +6,10 @@ module.exports = exports = {
   USERS_PUBLIC_INDEX: 'users-public',
   USERS_REFERRAL_INDEX: 'users-referral',
   ORGANIZATIONS_INDEX: 'organization-iterator-set',
+
+  /* inactive user ids set */
+  USERS_INACTIVATED: 'users-inactivated',
+
   // id mapping
   USERS_ALIAS_TO_ID: 'users-alias',
   USERS_SSO_TO_ID: 'users-sso-hash',

src/utils/inactiveUsers/index.js

@@ -0,0 +1,27 @@
+const {
+  USERS_INACTIVATED,
+} = require('../../constants');
+
+/**
+ * Add user id to inacive users list
+ * @param {ioredis} redis
+ * @param {userId} userId
+ */
+function addToInactiveUsers(redis, userId) {
+  const created = Date.now();
+  redis.zadd(USERS_INACTIVATED, created, userId);
+}
+
+/**
+ * Remove user id from inactive users list
+ * @param {ioredis} redis
+ * @param {userId} userId
+ */
+function removeFromInactiveUsers(redis, userId) {
+  redis.zrem(USERS_INACTIVATED, userId);
+}
+
+module.exports = {
+  addToInactiveUsers,
+  removeFromInactiveUsers,
+};