feat: delete unconfirmed users lua logic doc

Author: pajgo

doc/rfcs/inactive_users_cleanup.md

@@ -42,3 +42,54 @@ When script started:
 1. It extracts from `inactive-user` list of `userId` with score range '-inf' to 'currentimestamp - ttl'.
 2. Removes all user data including aliases, emails,  metadata, tokens, SSO accounts, throttles and cleans all bound indicies
 3. Removes processed records from `inactive-user`
+
+### Passed keys(next `KEY.$ind` used):
+ 1. Inactive users list key (USER_ACTIVATE constant) = `local outIndexKey`
+ 2. Template for user data key = `local dataKeyTemplate`
+ 3. Template for user meta data key = `local metaKeyTemplate`
+ 4. Template for user tokens key = `local userTokenTemplate`
+ 5. `user-audience` zset handling key name = `local kUserAudiences`
+ 6. Key for accessing `ALIAS_TO_ID` hash = `local kAliasToId`
+ 7. Key for accessing `USERNAME_TO_ID` hash = `local kUsernameToId`
+ 8. Key for accessing `SSO_TO_ID` hash = `local kSSOToId`
+ 9. Key for accessing general users index `USERS_INDEX` = `local kIndUsers`
+ 10. Key for accessing pulic users index `USERS_PUBLIC_INDEX` = `local kIndUsersPublic`
+ 11. Key prefix from `THROTTLE_PREFIX` constant = `local kThrottlePrefix`
+ 
+### Passed arguments(next `ARG.$ind` used):
+ 1. UserAlias field name from user data `USERs_ALIAS_FIELD`
+ 2. UserName field name from data `USERS_USERNAME_FIELD` 
+ 3. JSON string based on `SSO_PROVIDERS`
+ 4. JSON string based on `THROTTLE_ACTIONS`
+ 5. Timestamp, all users created below this value will be deleted
+ 
+ ### How it works:
+ #### Main
+ 1. Decodes from JSON passed SSO_PROVIDERS, THROTTLE_ACTIONS 
+ 2. Gets UserId's from ZSET `KEY.1` where score < `ARG.6`
+ 3. Iterates over list:
+    1. Forms user data key from `KEY.2` template + userId, and gets values
+    2. Calls `deleteUser(userid, userdata)`
+ 4. Deletes processed userId's from ZSET `KEY.1`
+ 
+ 
+ #### deleteUser(id, userdata)
+ Logic was adopted from `actions/removeUser.js`. Maybe I'm wrong, but all data deleted here, could be created even for inactive user.
+ **Except TOKENS?????**
+ 
+ 1. Gets `username` and `alias` values from `userData` using provided `ARG.2, ARG.3`
+ 2. If alias not empty, deletes field from `ALIAS_TO_ID`(`KEY.6`) hash
+ 3. If username not empty(sometimes this could happen(((( ), deletes from `USERNAME_TO_ID`(`KEY.7`) hash
+ 4. Iterates over decoded `SSO_PROVIDERS` list, and uses each value for access userData[key],
+ this field contains json_encoded string with provider options
+    1. if userData[ssoprovidername] exists, decoding it's value and checking for `uid` value. 
+    2. If `uid` set, deletes this it's value from `SSO_TO_ID`(`KEY.8`)) hash.
+ 5. Deletes userId from `USERS_INDEX`(`KEY.9`), `USERS_PUBLIC_INDEX`(`KEY.10`) sets.
+ 6. Gets Audience list from `USER_AUDIENCE`(`KEY.5`), decodes it from JSON, and iterates over it's values
+    * forms user meta `key` name from provided template `KEY.3`, userId and `audience`
+    * deletes meta `key`.
+ 7. Forms user tokens key name from `KEY.4` and deletes it
+ 8. **THROTTLE_PREFIX constant not exists in constants.js, so assuming this left for backward compat with previous version** Iterates over decoded `THROTTLE_ACTIONS` array
+    * forms Throttle `key` names from userId, `THROTTLE_PREFIX`(`KEY.11`)
+    * deletes throttle `key`
+ 

scripts/deleteInactivated.lua

@@ -1,9 +1,7 @@
-local outIndexKey = KEYS[1];
+local inactiveUsersList = KEYS[1];
 local dataKeyTemplate = KEYS[2];
 local metaKeyTemplate = KEYS[3];
-local kIndUserTokenTemplate = KEYS[4];
-
-local exTime = ARGV[6];
+local userTokenTemplate = KEYS[4];
 
 -- hashes
 local kUserAudiences = KEYS[5];
@@ -19,15 +17,13 @@ local kIndUsersPublic = KEYS[10];
 local kThrottlePrefix = KEYS[11];
 
 -- constant fields names
-local fUserId = ARGV[1]
-local fUserAlias = ARGV[2];
-local fUserName = ARGV[3];
+local fUserAlias = ARGV[1];
+local fUserName = ARGV[2];
 
-local _rawSSOProviders = ARGV[4];
-local _rawThrottleActions = ARGV[5];
+local _rawSSOProviders = ARGV[3];
+local _rawThrottleActions = ARGV[4];
 
-local throttleActions = cjson.decode(_rawThrottleActions);
-local ssoProviders = cjson.decode(_rawSSOProviders);
+local exTime = ARGV[5];
 
 local delimiter = "!";
 
@@ -43,11 +39,6 @@ local function toTable(data)
   return result;
 end
 
--- key generators
-local function key(...)
-  return table.concat(arg, delimiter);
-end
-
 local function decode(strval)
   if type(strval) == "string" then
     return cjson.decode(strval);
@@ -56,6 +47,15 @@ local function decode(strval)
   end
 end
 
+--Let this be here
+local throttleActions = decode(_rawThrottleActions);
+local ssoProviders = decode(_rawSSOProviders);
+
+-- key generators
+local function key(...)
+  return table.concat(arg, delimiter);
+end
+
 local function makeKey (userId, template)
   local str = template:gsub('{userid}', userId, 1);
   return str
@@ -123,7 +123,7 @@ local function deleteUser(userId, userData)
   end
 
   -- delete USERS_TOKENS
-  local userTokensKey = makeKey(userId, kIndUserTokenTemplate);
+  local userTokensKey = makeKey(userId, userTokenTemplate);
   redis.call("DEL", userTokensKey);
 
   -- remove audience list
@@ -138,7 +138,7 @@ local function deleteUser(userId, userData)
 end
 
 local function getInactiveUsers()
-  return redis.call("ZRANGEBYSCORE", outIndexKey, '-inf', exTime);
+  return redis.call("ZRANGEBYSCORE", inactiveUsersList, '-inf', exTime);
 end
 
 local function cleanInactiveUsers(idList)