[#22] Revise messages editing (#54)

Problem: Currently message_changed event is handled by translating new
time references and sending ephemeral with them, which can be
inconvenient sometimes.

Solution: On message_changed event send an ephemeral containing message
permalink and all message time references translated.

Author: YuriRomanowski

package.yaml

@@ -72,6 +72,7 @@ library:
   - utf8-string
   - validation
   - yaml
+  - utf8-string
 
 executables:
   tzbot-exe:

src/TzBot/BotMain.hs

@@ -8,7 +8,6 @@ import Universum
 
 import Control.Monad.Managed (managed, runManaged)
 import Data.ByteString qualified as BS
-import Data.Map qualified as M
 import Network.HTTP.Client (newManager)
 import Network.HTTP.Client.TLS (tlsManagerSettings)
 import Options.Applicative (execParser)
@@ -17,6 +16,7 @@ import Slacker
   setGracefulShutdownHandler, setOnException)
 import System.Directory (doesFileExist)
 import Text.Interpolation.Nyan (int, rmode')
+import Time (hour)
 
 import TzBot.Cache
   (TzCacheSettings(tcsExpiryRandomAmplitudeFraction), defaultTzCacheSettings, withTzCache,
@@ -78,13 +78,17 @@ run opts = do
               & setGracefulShutdownHandler extractShutdownFunction
 
     bsManager <- liftIO $ newManager tlsManagerSettings
-    bsMessagesReferences <- newIORef M.empty
     bsFeedbackConfig <-
       managed $ withFeedbackConfig bsConfig
     bsUserInfoCache <-
       managed $ withTzCache fifteenPercentAmplitudeSettings cCacheUsersInfo
     bsConversationMembersCache <-
       managed $ withTzCache fifteenPercentAmplitudeSettings cCacheConversationMembers
+    let defaultMessageInfoCachingTime = hour 1
+    bsMessageCache <-
+      managed $ withTzCacheDefault defaultMessageInfoCachingTime
+    bsMessageLinkCache <-
+      managed $ withTzCacheDefault defaultMessageInfoCachingTime
     bsReportEntries <-
       managed $ withTzCacheDefault cCacheReportDialog
     -- auto-acknowledge received messages

src/TzBot/Cache.hs

@@ -16,8 +16,8 @@ module TzBot.Cache
   , lookup
 
     -- * Altering cache
-  , insertRandomized
-  , fetchWithCacheRandomized
+  , insert
+  , fetchWithCache
   , update
   ) where
 
@@ -106,13 +106,13 @@ cleaningThread cleaningPeriod cache = forever $ do
 
 -- | Generate a random expiry time and insert a key/value pair into
 -- the cache with that expiry time.
-insertRandomized
+insert
   :: (Eq k, Hashable k, MonadIO m)
   => k
   -> v
   -> TzCache k v
   -> m ()
-insertRandomized key val TzCache {..} = do
+insert key val TzCache {..} = do
   expiry <- case rcExpiryRandomAmplitude of
     Nothing -> pure rcExpiry
     Just randAmp -> do
@@ -124,13 +124,13 @@ insertRandomized key val TzCache {..} = do
 -- If the value is either absent or expired, perform given fetch action
 -- and insert the obtained value with configured expiration parameters
 -- into the cache.
-fetchWithCacheRandomized
+fetchWithCache
   :: (Eq k, Hashable k, MonadIO m, KatipContext m, Buildable k)
   => k
   -> (k -> m v)
   -> TzCache k v
   -> m v
-fetchWithCacheRandomized key fetchAction cache =
+fetchWithCache key fetchAction cache =
   katipAddNamespace "cache" $ do
   logDebug [int||Fetching key=#{key}|]
   mv <- liftIO $ Cache.lookup (rcCache cache) key
@@ -142,7 +142,7 @@ fetchWithCacheRandomized key fetchAction cache =
         using provided fetching action
         |]
       v <- fetchAction key
-      insertRandomized key v cache
+      insert key v cache
       pure v
 
 lookup

src/TzBot/Feedback/Dialog.hs

@@ -20,7 +20,7 @@ import TzBot.RunMonad (BotM, BotState(bsReportEntries))
 insertDialogEntry :: ReportDialogId -> ReportDialogEntry -> BotM ()
 insertDialogEntry id_ entry = do
   dialogEntriesCache <- asks bsReportEntries
-  Cache.insertRandomized id_ entry dialogEntriesCache
+  Cache.insert id_ entry dialogEntriesCache
 
 lookupDialogEntry :: ReportDialogId -> BotM (Maybe ReportDialogEntry)
 lookupDialogEntry id_ = do

src/TzBot/Logger.hs

@@ -14,6 +14,7 @@ import Universum
 
 import Data.Aeson (KeyValue((.=)), ToJSON(..), object)
 import Katip
+import Text.Interpolation.Nyan (int, rmode's)
 
 import TzBot.Slack.API (MessageId(..))
 
@@ -26,6 +27,9 @@ logWarn t = withFrozenCallStack $ logSugar_ WarningS t
 logDebug t = withFrozenCallStack $ logSugar_ DebugS t
 logError t = withFrozenCallStack $ logSugar_ ErrorS t
 
+logException :: (Exception e, KatipContext m) => e -> m ()
+logException err = logError [int||Error occured: #s{err}|]
+
 withLogger
   :: Severity
   -> ((Namespace, LogContexts, LogEnv) -> IO a)

src/TzBot/ProcessEvents.hs

@@ -87,8 +87,6 @@ handler shutdownRef bState _cfg e = run $ do
     run action = void $ runBotM bState $ do
       eithRes <- catchAllErrors action
       whenLeft eithRes $ \eithErr -> do
-        let logException :: (Exception e) => e -> BotM ()
-            logException err = logError [int||Error occured: #s{err}|]
         case eithErr of
           Left someExc
             | Just UserInterrupt <- fromException someExc ->