[refactor] add newtype Limit, newtype Query

This is safer than type Limit = Int

bin/gargantext-import/Main.hs

@@ -30,6 +30,7 @@ import Gargantext.API.Node () -- instances
 import Gargantext.API.Prelude (GargError)
 import Gargantext.Core (Lang(..))
 import Gargantext.Core.Types.Individu (User(..))
+import Gargantext.Core.Types.Query (Limit)
 import Gargantext.Database.Action.Flow (flowCorpusFile, flowAnnuaire, TermType(..))
 import Gargantext.Database.Action.Flow.Types (FlowCmdM)
 import Gargantext.Database.Admin.Types.Hyperdata (toHyperdataDocument)
@@ -49,7 +50,7 @@ main = do
     --tt = (Unsupervised EN 6 0 Nothing)
     tt = (Multi EN)
     format = CsvGargV3 -- CsvHal --WOS
-    limit' = case (readMaybe limit :: Maybe Int) of
+    limit' = case (readMaybe limit :: Maybe Limit) of
       Nothing -> panic $ "Cannot read limit: " <> (Text.pack limit)
       Just l  -> l
     corpus :: forall m. (FlowCmdM DevEnv GargError m, MonadJobStatus m, JobHandle m ~ DevJobHandle) => m CorpusId

gargantext.cabal

@@ -72,6 +72,7 @@ library
       Gargantext.Core.Types
       Gargantext.Core.Types.Individu
       Gargantext.Core.Types.Main
+      Gargantext.Core.Types.Query
       Gargantext.Core.Utils
       Gargantext.Core.Utils.Prefix
       Gargantext.Core.Viz.Graph

package.yaml

@@ -98,6 +98,7 @@ library:
   - Gargantext.Core.Types
   - Gargantext.Core.Types.Individu
   - Gargantext.Core.Types.Main
+  - Gargantext.Core.Types.Query
   - Gargantext.Core.Utils
   - Gargantext.Core.Utils.Prefix
   - Gargantext.Core.Viz.Graph
@@ -557,4 +558,3 @@ tests:
 #    - OverloadedStrings
 #    - RankNTypes
 #
-

src/Gargantext/API/Admin/Auth.hs

@@ -40,11 +40,8 @@ module Gargantext.API.Admin.Auth
 import Control.Lens (view, (#))
 import Data.Aeson
 import Data.Swagger (ToSchema(..))
-import Data.Text (Text)
-import Data.Text.Lazy (toStrict)
 import Data.UUID (UUID, fromText, toText)
 import Data.UUID.V4 (nextRandom)
-import GHC.Generics (Generic)
 import Gargantext.API.Admin.Auth.Types
 import Gargantext.API.Admin.EnvTypes (GargJob(..), Env)
 import Gargantext.API.Admin.Orchestrator.Types (JobLog(..), AsyncJobs)
@@ -64,6 +61,7 @@ import Gargantext.Database.Schema.Node (NodePoly(_node_id))
 import Gargantext.Prelude hiding (reverse)
 import Gargantext.Prelude.Crypto.Pass.User (gargPass)
 import Gargantext.Utils.Jobs (serveJobsAPI, MonadJobStatus(..))
+import Protolude hiding (to)
 import Servant
 import Servant.Auth.Server
 import qualified Data.Text as Text

src/Gargantext/API/Metrics.hs

@@ -27,7 +27,8 @@ import Gargantext.API.Ngrams.NgramsTree
 import Gargantext.API.Ngrams.Types
 import Gargantext.API.Prelude (GargServer)
 import Gargantext.Core.Text.Metrics (Scored(..), {-normalizeGlobal,-} normalizeLocal)
-import Gargantext.Core.Types (CorpusId, Limit, ListId, ListType(..))
+import Gargantext.Core.Types (CorpusId, ListId, ListType(..))
+import Gargantext.Core.Types.Query (Limit)
 import Gargantext.Core.Viz.Chart
 import Gargantext.Core.Viz.Types
 import Gargantext.Database.Admin.Types.Hyperdata (HyperdataList(..), hl_chart, hl_pie, hl_scatter, hl_tree)
@@ -49,12 +50,12 @@ import qualified Gargantext.Database.Action.Metrics as Metrics
 type ScatterAPI = Summary "SepGen IncExc metrics"
                   :> QueryParam  "list"       ListId
                   :> QueryParamR "ngramsType" TabType
-                  :> QueryParam  "limit"      Int
+                  :> QueryParam  "limit"      Limit
                   :> Get '[JSON] (HashedResponse Metrics)
               :<|> Summary "Scatter update"
                   :> QueryParam  "list"       ListId
                   :> QueryParamR "ngramsType" TabType
-                  :> QueryParam  "limit"      Int
+                  :> QueryParam  "limit"      Limit
                   :> Post '[JSON] ()
               :<|> "hash" :> Summary "Scatter Hash"
                           :> QueryParam  "list"       ListId
@@ -149,7 +150,7 @@ type ChartApi = Summary " Chart API"
             :<|> Summary "Chart update"
                :> QueryParam  "list"       ListId
                :> QueryParamR "ngramsType" TabType
-               :> QueryParam  "limit"      Int
+               :> QueryParam  "limit"      Limit
                :> Post '[JSON] ()
             :<|> "hash" :> Summary "Chart Hash"
                :> QueryParam  "list"       ListId
@@ -236,7 +237,7 @@ type PieApi = Summary "Pie Chart"
          :<|> Summary "Pie Chart update"
              :> QueryParam  "list"       ListId
              :> QueryParamR "ngramsType" TabType
-             :> QueryParam  "limit"      Int
+             :> QueryParam  "limit"      Limit
              :> Post '[JSON] ()
          :<|> "hash" :> Summary "Pie Hash"
                      :> QueryParam  "list"       ListId

src/Gargantext/API/Ngrams.hs

@@ -104,7 +104,8 @@ import Gargantext.API.Admin.Types (HasSettings)
 import Gargantext.API.Ngrams.Types
 import Gargantext.API.Prelude
 import Gargantext.Core.NodeStory
-import Gargantext.Core.Types (ListType(..), NodeId, ListId, DocId, Limit, Offset, TODO, assertValid, HasInvalidError)
+import Gargantext.Core.Types (ListType(..), NodeId, ListId, DocId, TODO, assertValid, HasInvalidError)
+import Gargantext.Core.Types.Query (Limit(..), Offset(..))
 import Gargantext.API.Ngrams.Tools
 import Gargantext.Database.Action.Flow.Types
 import Gargantext.Database.Action.Metrics.NgramsByContext (getOccByNgramsOnlyFast)
@@ -545,7 +546,7 @@ getTableNgrams _nType nId tabType listId limit_ offset
   -- lIds <- selectNodesWithUsername NodeList userMaster
   let
     ngramsType = ngramsTypeFromTabType tabType
-    offset'  = maybe 0 identity offset
+    offset'  = getOffset $ maybe 0 identity offset
     listType' = maybe (const True) (==) listType
     minSize'  = maybe (const True) (<=) minSize
     maxSize'  = maybe (const True) (>=) maxSize
@@ -590,7 +591,7 @@ getTableNgrams _nType nId tabType listId limit_ offset
 
     -- | Paginate the results
     sortAndPaginate :: [NgramsElement] -> [NgramsElement]
-    sortAndPaginate = take limit_
+    sortAndPaginate = take (getLimit limit_)
                       . drop offset'
                       . sortOnOrder orderBy
 

src/Gargantext/API/Node.hs

@@ -47,6 +47,7 @@ import Gargantext.API.Table
 import Gargantext.Core.Types (NodeTableResult)
 import Gargantext.Core.Types.Individu (User(..))
 import Gargantext.Core.Types.Main (Tree, NodeTree)
+import Gargantext.Core.Types.Query (Limit, Offset)
 import Gargantext.Core.Utils.Prefix (unPrefix)
 import Gargantext.Core.Viz.Phylo.API (PhyloAPI, phyloAPI)
 import Gargantext.Database.Action.Flow.Pairing (pairing)
@@ -169,8 +170,8 @@ type PostNodeApi = Summary " PostNode Node with ParentId as {id}"
 
 type ChildrenApi a = Summary " Summary children"
                  :> QueryParam "type"   NodeType
-                 :> QueryParam "offset" Int
-                 :> QueryParam "limit"  Int
+                 :> QueryParam "offset" Offset
+                 :> QueryParam "limit"  Limit
                  -- :> Get '[JSON] [Node a]
                  :> Get '[JSON] (NodeTableResult a)
 
@@ -296,8 +297,8 @@ scoreApi = putScore
 type PairingApi = Summary " Pairing API"
                 :> QueryParam "view"   TabType
                 -- TODO change TabType -> DocType (CorpusId for pairing)
-                :> QueryParam "offset" Int
-                :> QueryParam "limit"  Int
+                :> QueryParam "offset" Offset
+                :> QueryParam "limit"  Limit
                 :> QueryParam "order"  OrderBy
                 :> Get '[JSON] [FacetDoc]
 

src/Gargantext/API/Search.hs

@@ -23,6 +23,7 @@ import Data.Swagger hiding (fieldLabelModifier, Contact)
 import Data.Text (Text)
 import GHC.Generics (Generic)
 import Gargantext.API.Prelude (GargServer)
+import Gargantext.Core.Types.Query (Limit, Offset)
 import Gargantext.Core.Types.Search
 import Gargantext.Core.Utils.Prefix (unPrefixSwagger)
 import Gargantext.Database.Action.Flow.Pairing (isPairedWith)
@@ -40,8 +41,8 @@ import Test.QuickCheck.Arbitrary
 -- TODO-EVENTS: No event, this is a read-only query.
 type API results = Summary "Search endpoint"
                  :> ReqBody '[JSON] SearchQuery
-                 :> QueryParam "offset" Int
-                 :> QueryParam "limit"  Int
+                 :> QueryParam "offset" Offset
+                 :> QueryParam "limit"  Limit
                  :> QueryParam "order"  OrderBy
                  :> Post '[JSON] results
 -----------------------------------------------------------------------

src/Gargantext/API/Table.hs

@@ -43,7 +43,8 @@ import Test.QuickCheck.Arbitrary (Arbitrary, arbitrary)
 import Gargantext.API.HashedResponse
 import Gargantext.API.Ngrams.Types (TabType(..))
 import Gargantext.API.Prelude (GargServer)
-import Gargantext.Core.Types (Offset, Limit, TableResult(..))
+import Gargantext.Core.Types (TableResult(..))
+import Gargantext.Core.Types.Query (Offset, Limit)
 import Gargantext.Core.Utils.Prefix (unPrefix, unPrefixSwagger)
 import Gargantext.Database.Action.Learn (FavOrTrash(..), moreLike)
 import Gargantext.Database.Action.Search
@@ -58,8 +59,8 @@ import Gargantext.Prelude
 type TableApi = Summary "Table API"
               :> QueryParam "tabType" TabType
               :> QueryParam "list" ListId
-              :> QueryParam "limit" Int
-              :> QueryParam "offset" Int
+              :> QueryParam "limit" Limit
+              :> QueryParam "offset" Offset
               :> QueryParam "orderBy" OrderBy
               :> QueryParam "query" Text
               :> QueryParam "year" Text
@@ -73,8 +74,8 @@ type TableApi = Summary "Table API"
                 :> Get '[JSON] Text
 
 data TableQuery = TableQuery
-  { tq_offset  :: Int
-  , tq_limit   :: Int
+  { tq_offset  :: Offset
+  , tq_limit   :: Limit
   , tq_orderBy :: OrderBy
   , tq_view    :: TabType
   , tq_query   :: Text
@@ -105,8 +106,8 @@ getTableApi :: HasNodeError err
             => NodeId
             -> Maybe TabType
             -> Maybe ListId
-            -> Maybe Int
-            -> Maybe Int
+            -> Maybe Limit
+            -> Maybe Offset
             -> Maybe OrderBy
             -> Maybe Text
             -> Maybe Text

src/Gargantext/Core/Types/Main.hs

@@ -111,11 +111,6 @@ fromListTypeId i = lookup i
 
 -- | Then a Node can be a Score which has some synonyms
 
--- Queries
-type Limit    = Int
-type Offset   = Int
-type IsTrash  = Bool
-
 ------------------------------------------------------------------------
 -- All the Database is structured as a hierarchical Tree
 data Tree a = TreeN { _tn_node :: a, _tn_children :: [Tree a] }

src/Gargantext/Core/Types/Query.hs

+{-# LANGUAGE DerivingStrategies  #-}
+
+module Gargantext.Core.Types.Query where
+
+import qualified Data.Aeson as Aeson
+import qualified Database.PostgreSQL.Simple.FromField as PSQL
+import qualified Database.PostgreSQL.Simple.ToField as PSQL
+import qualified Data.Swagger as Swagger
+import Protolude
+import qualified Servant.API as Servant
+
+
+-- newtype wrappers based on
+-- https://www.haskellforall.com/2023/04/ergonomic-newtypes-for-haskell-strings.html
+-- These give stronger type guarantees than `type Offset = Int`.
+
+-- Queries
+newtype Limit = Limit { getLimit :: Int }
+  deriving newtype ( Aeson.FromJSON, Aeson.ToJSON
+                   , Eq, Num, Read, Show
+                   , PSQL.FromField, PSQL.ToField
+                   , Servant.FromHttpApiData, Servant.ToHttpApiData
+                   , Swagger.ToParamSchema, Swagger.ToSchema)
+newtype Offset = Offset { getOffset :: Int }
+  deriving newtype ( Aeson.FromJSON, Aeson.ToJSON
+                   , Eq, Num, Read, Show
+                   , PSQL.FromField, PSQL.ToField
+                   , Servant.FromHttpApiData, Servant.ToHttpApiData
+                   , Swagger.ToParamSchema, Swagger.ToSchema)
+type IsTrash  = Bool

src/Gargantext/Database/Action/Flow.hs

@@ -88,6 +88,7 @@ import Gargantext.Core.Text.Terms.Mono.Stem.En (stemIt)
 import Gargantext.Core.Types (POS(NP), TermsCount)
 import Gargantext.Core.Types.Individu (User(..))
 import Gargantext.Core.Types.Main
+import Gargantext.Core.Types.Query (Limit)
 import Gargantext.Core.Utils (addTuples)
 import Gargantext.Core.Utils.Prefix (unPrefix, unPrefixSwagger)
 import Gargantext.Database.Action.Flow.List
@@ -303,10 +304,10 @@ flow c u cn la mfslw (mLength, docsC) jobHandle = do
       let maxIdx = maximum (fst <$> docs)
       case mLength of
         Nothing -> pure ()
-        Just len -> do
+        Just _len -> do
 
           let succeeded = fromIntegral (1 + maxIdx)
-          let remaining = fromIntegral (len - maxIdx)
+          -- let remaining = fromIntegral (len - maxIdx)
           -- Reconstruct the correct update state by using 'markStarted' and the other primitives.
           -- We do this slightly awkward arithmetic such that when we call 'markProgress' we reduce
           -- the number of 'remaining' of exactly '1 + maxIdx', and we will end up with a 'JobLog'
@@ -317,7 +318,7 @@ flow c u cn la mfslw (mLength, docsC) jobHandle = do
           -- , _scst_remaining = Just $ fromIntegral $ len - maxIdx
           -- , _scst_events    = Just []
           -- }
-          markStarted (remaining + succeeded) jobHandle
+          -- markStarted (remaining + succeeded) jobHandle
           markProgress succeeded jobHandle
 
       pure ids

src/Gargantext/Database/Action/Learn.hs

@@ -18,7 +18,7 @@ module Gargantext.Database.Action.Learn
 import Data.Maybe
 import Data.Text (Text)
 import Gargantext.Core
-import Gargantext.Core.Types (Offset, Limit)
+import Gargantext.Core.Types.Query (Offset, Limit(..))
 import Gargantext.Database.Admin.Types.Hyperdata
 import Gargantext.Database.Admin.Types.Node
 import Gargantext.Database.Query.Facet
@@ -70,7 +70,7 @@ moreLikeWith cId o l order ft priors = do
        $ filter ((==) (Just $ not $ fav2bool ft) . snd)
        $ map (\f -> (f, detectDefaultWithPriors text priors f)) docs_test
 
-  pure $ List.take (maybe 10 identity l) results
+  pure $ List.take (getLimit $ maybe 10 identity l) results
 
 ---------------------------------------------------------------------------
 fav2bool :: FavOrTrash -> Bool

src/Gargantext/Database/Action/Metrics.hs

@@ -30,7 +30,8 @@ import Gargantext.Core.Mail.Types (HasMail)
 import Gargantext.Core.NodeStory hiding (runPGSQuery)
 import Gargantext.Core.Text.Metrics (scored, Scored(..), {-localMetrics, toScored-})
 import Database.PostgreSQL.Simple.ToField (toField, Action{-, ToField-})
-import Gargantext.Core.Types (ListType(..), Limit, NodeType(..), ContextId)
+import Gargantext.Core.Types (ListType(..), NodeType(..), ContextId)
+import Gargantext.Core.Types.Query (Limit(..))
 import Gargantext.Database.Action.Flow.Types (FlowCmdM)
 import Gargantext.Database.Action.Metrics.NgramsByContext (getContextsByNgramsOnlyUser{-, getTficfWith-})
 import Gargantext.Database.Admin.Config (userMaster)
@@ -240,6 +241,6 @@ getNgrams lId tabType = do
   pure (lists, maybeSyn)
 
 -- Some useful Tools
-take' :: Maybe Int -> [a] -> [a]
+take' :: Maybe Limit -> [a] -> [a]
 take' Nothing  xs = xs
-take' (Just n) xs = take n xs
+take' (Just n) xs = take (getLimit n) xs

src/Gargantext/Database/Action/Metrics/Lists.hs

@@ -22,6 +22,7 @@ module Gargantext.Database.Action.Metrics.Lists
 import Gargantext.API.Ngrams.Types (TabType(..))
 import Gargantext.Core.Text.Metrics (Scored(..))
 import Gargantext.Core.Types -- (NodePoly(..), NodeCorpus, ListId)
+import Gargantext.Core.Types.Query (Limit)
 import Gargantext.Database.Action.Flow.Types (FlowCmdM)
 import Gargantext.Prelude hiding (sum, head)
 import Prelude hiding (null, id, map, sum)
@@ -42,7 +43,7 @@ trainModel u = do
 
 
 getMetrics' :: FlowCmdM env err m
-             => CorpusId -> Maybe ListId -> TabType -> Maybe Int
+             => CorpusId -> Maybe ListId -> TabType -> Maybe Limit
              -> m (Map.Map ListType [Vec.Vector Double])
 getMetrics' cId maybeListId tabType maybeLimit = do
   (ngs', scores) <- Metrics.getMetrics cId maybeListId tabType maybeLimit

src/Gargantext/Database/Action/Search.hs

@@ -23,6 +23,7 @@ import Data.Text (Text, unpack, intercalate)
 import Data.Time (UTCTime)
 import Gargantext.Core
 import Gargantext.Core.Types
+import Gargantext.Core.Types.Query (IsTrash, Limit, Offset)
 import Gargantext.Database.Admin.Types.Hyperdata (HyperdataDocument(..), HyperdataContact(..))
 import Gargantext.Database.Prelude (Cmd, runOpaQuery, runCountOpaQuery)
 import Gargantext.Database.Query.Facet

src/Gargantext/Database/Action/TSQuery.hs

@@ -9,6 +9,7 @@ import Database.PostgreSQL.Simple (Query)
 import Database.PostgreSQL.Simple.ToField
 import Gargantext.Core
 import Gargantext.Core.Types
+import Gargantext.Core.Types.Query (Limit, Offset)
 import Gargantext.Database.Prelude (Cmd, runPGSQuery)
 import Gargantext.Prelude
 import Gargantext.Core.Text.Terms.Mono.Stem.En (stemIt)
@@ -74,5 +75,3 @@ textSearch :: HasDBid NodeType
 textSearch q p l o ord = runPGSQuery textSearchQuery (q,p,p,typeId,ord,o,l)
   where
     typeId = toDBid NodeDocument
-
-

src/Gargantext/Database/Query/Facet.hs

@@ -47,6 +47,7 @@ import qualified Opaleye.Internal.Unpackspec()
 
 import Gargantext.Core
 import Gargantext.Core.Types
+import Gargantext.Core.Types.Query (Limit, Offset, IsTrash)
 import Gargantext.Database.Query.Filter
 import Gargantext.Database.Query.Table.Context
 import Gargantext.Database.Query.Table.ContextNodeNgrams
@@ -230,8 +231,8 @@ viewDocumentsQuery cId t ntId mQuery mYear = proc () -> do
 
 ------------------------------------------------------------------------
 filterWith :: (SqlOrd date, SqlOrd title, SqlOrd category, SqlOrd score, hyperdata ~ SqlJsonb) =>
-        Maybe Gargantext.Core.Types.Offset
-     -> Maybe Gargantext.Core.Types.Limit
+        Maybe Offset
+     -> Maybe Limit
      -> Maybe OrderBy
      -> Select (Facet id (Field date) (Field title) (Field hyperdata) (FieldNullable category) ngramCount (FieldNullable score))
      -> Select (Facet id (Field date) (Field title) (Field hyperdata)(FieldNullable category) ngramCount (FieldNullable score))
@@ -261,8 +262,8 @@ orderWith _                = asc facetDoc_created
 
 
 filterWith' :: (SqlOrd date, SqlOrd title, SqlOrd category, SqlOrd score, hyperdata ~ SqlJsonb, SqlOrd ngramCount) =>
-        Maybe Gargantext.Core.Types.Offset
-     -> Maybe Gargantext.Core.Types.Limit
+        Maybe Offset
+     -> Maybe Limit
      -> Maybe OrderBy
      -> Select (Facet id (Field date) (Field title) (Field hyperdata) (Field category) (Field ngramCount) (Field score))
      -> Select (Facet id (Field date) (Field title) (Field hyperdata) (Field category) (Field ngramCount) (Field score))

src/Gargantext/Database/Query/Filter.hs

@@ -18,12 +18,12 @@ Portability : POSIX
 module Gargantext.Database.Query.Filter
   where
 
-import Gargantext.Core.Types (Limit, Offset)
+import Gargantext.Core.Types.Query (Limit(..), Offset(..))
 import Data.Maybe (Maybe, maybe)
 import Opaleye (Select, limit, offset)
 
 limit' ::  Maybe Limit -> Select a -> Select a
-limit' maybeLimit query = maybe query (\l -> limit l query) maybeLimit
+limit' maybeLimit query = maybe query (\l -> limit (getLimit l) query) maybeLimit
 
 offset' :: Maybe Offset -> Select a  -> Select a
-offset' maybeOffset query = maybe query (\o -> offset o query) maybeOffset
+offset' maybeOffset query = maybe query (\o -> offset (getOffset o) query) maybeOffset

src/Gargantext/Database/Query/Table/Context.hs

@@ -23,6 +23,7 @@ module Gargantext.Database.Query.Table.Context
 import Control.Arrow (returnA)
 import Gargantext.Core
 import Gargantext.Core.Types
+import Gargantext.Core.Types.Query (Limit, Offset)
 import Gargantext.Database.Admin.Types.Hyperdata
 import Gargantext.Database.Prelude
 import Gargantext.Database.Query.Filter (limit', offset')

src/Gargantext/Database/Query/Table/Node.hs

@@ -32,6 +32,7 @@ import Prelude hiding (null, id, map, sum)
 
 import Gargantext.Core
 import Gargantext.Core.Types
+import Gargantext.Core.Types.Query (Limit, Offset)
 import Gargantext.Database.Admin.Types.Hyperdata
 import Gargantext.Database.Admin.Types.Hyperdata.Default
 import Gargantext.Database.Prelude

src/Gargantext/Database/Query/Table/Node/Children.hs

@@ -20,6 +20,7 @@ import Control.Arrow (returnA)
 import Data.Proxy
 import Gargantext.Core
 import Gargantext.Core.Types
+import Gargantext.Core.Types.Query (Limit, Offset)
 import Gargantext.Database.Admin.Types.Hyperdata (HyperdataDocument, HyperdataContact)
 import Gargantext.Database.Prelude
 import Gargantext.Database.Query.Filter