feat: inactive users index

* index cleanup

Author: pajgo

rfcs/inactive_users/user_index.md

@@ -10,13 +10,19 @@ 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`.
+
+## Index cleanup
+Temporarily add `inactive-users` index cleanup. The functionality will move into one LUA script
+with `delete inactive users` logic. This will save us from `dlock` based implementations and all operations will execute in `one-shot` avoiding race conditions.
+On `registration` cleanup method executes before user creation.
+
+On `activation` cleanup method executes before any checks performed by `activation` action.
+
+

src/actions/activate.js

@@ -5,10 +5,11 @@ 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 { cleanInactiveUsersIndex } = require('../utils/inactiveUsers');
 
 const {
   USERS_INDEX,
+  USERS_INACTIVATED,
   USERS_DATA,
   USERS_REFERRAL_INDEX,
   USERS_PUBLIC_INDEX,
@@ -129,7 +130,7 @@ function activateAccount(data, metadata) {
     .sadd(USERS_INDEX, userId);
 
   /* delete user id from the inactive users index */
-  removeFromInactiveUsers(pipeline, userId);
+  pipeline.zrem(USERS_INACTIVATED, userId);
 
   if (alias) {
     pipeline.sadd(USERS_PUBLIC_INDEX, userId);
@@ -178,7 +179,7 @@ function hook(userId) {
  * @apiParam (Payload) {String} [audience] - additional metadata will be pushed there from custom hooks
  *
  */
-function activateAction({ params }) {
+async function activateAction({ params }) {
   // TODO: add security logs
   // var remoteip = request.params.remoteip;
   const { token, username } = params;
@@ -196,6 +197,9 @@ function activateAction({ params }) {
     erase: config.token.erase,
   };
 
+  // TODO: REMOVEME: Execute `DeleteInactiveUsers` LUA script
+  await cleanInactiveUsersIndex.call(this);
+
   return Promise
     .bind(context)
     .then(verifyRequest)

src/actions/register.js

@@ -22,12 +22,13 @@ 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 { cleanInactiveUsersIndex } = require('../utils/inactiveUsers');
 
 const {
   USERS_REF,
   USERS_INDEX,
   USERS_SSO_TO_ID,
+  USERS_INACTIVATED,
   USERS_DATA,
   USERS_USERNAME_TO_ID,
   USERS_ACTIVE_FLAG,
@@ -174,6 +175,9 @@ async function performRegistration({ service, params }) {
     await verifySSO(service, params);
   }
 
+  // TODO: REMOVEME: Execute `DeleteInactiveUsers` LUA script
+  await cleanInactiveUsersIndex.call(service);
+
   const [creatorAudience] = audience;
   const defaultAudience = last(audience);
   const userId = service.flake.next();
@@ -214,7 +218,7 @@ async function performRegistration({ service, params }) {
     pipeline.expire(userDataKey, config.deleteInactiveAccounts);
 
     /* Add user id to the inactive users index */
-    addToInactiveUsers(pipeline, userId, audience);
+    redis.zadd(USERS_INACTIVATED, created, userId);
   }
 
   await pipeline.exec().then(handlePipeline);

src/utils/inactiveUsers/index.js

@@ -3,25 +3,21 @@ const {
 } = require('../../constants');
 
 /**
- * Add user id to inacive users list
- * @param {ioredis} redis
- * @param {userId} userId
+ * NOTE: Contents of this file will be removed when `DeleteInactiveUsers` feature merged.
+ * To avoid `dlock` based locks, index cleanup and inactive user remove process will be merged into one LUA script.
  */
-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
+ * Cleans Inactive user index from User IDs that not activated in some period
+ * @returns {Promise<void>}
  */
-function removeFromInactiveUsers(redis, userId) {
-  redis.zrem(USERS_INACTIVATED, userId);
+async function cleanInactiveUsersIndex() {
+  const { redis } = this;
+  const { deleteInactiveAccounts } = this.config;
+  const expire = Date.now() - (deleteInactiveAccounts * 1000);
+  await redis.zremrangebyscore(USERS_INACTIVATED, '-inf', expire);
 }
 
 module.exports = {
-  addToInactiveUsers,
-  removeFromInactiveUsers,
+  cleanInactiveUsersIndex,
 };