-{-# OPTIONS_GHC -fno-warn-unused-top-binds #-}
{-|
Module : Gargantext.API.Ngrams
Description : Server API
-}
+{-# OPTIONS_GHC -fno-warn-unused-top-binds #-}
+
{-# LANGUAGE ConstraintKinds #-}
{-# LANGUAGE ScopedTypeVariables #-}
-{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE TypeOperators #-}
{-# LANGUAGE TypeFamilies #-}
-{-# OPTIONS -fno-warn-orphans #-}
module Gargantext.API.Ngrams
( TableNgramsApi
, TableNgramsApiGet
, TableNgramsApiPut
- , TableNgramsApiPost
, getTableNgrams
, setListNgrams
- , rmListNgrams
- , putListNgrams
- , putListNgrams'
- , tableNgramsPost
+ --, rmListNgrams TODO fix before exporting
, apiNgramsTableCorpus
, apiNgramsTableDoc
, NgramsTablePatch
, NgramsTableMap
+ , NgramsTerm(..)
+
, NgramsElement(..)
, mkNgramsElement
- , mergeNgramsElement
, RootParent(..)
, renv_lock
, TabType(..)
- , ngramsTypeFromTabType
, HasRepoVar(..)
, HasRepoSaver(..)
-- Internals
, getNgramsTableMap
+ , dumpJsonTableMap
, tableNgramsPull
, tableNgramsPut
, Version
, Versioned(..)
+ , VersionedWithCount(..)
, currentVersion
, listNgramsChangedSince
)
where
-import Codec.Serialise (Serialise())
-import Control.Category ((>>>))
import Control.Concurrent
-import Control.Lens (makeLenses, makePrisms, Getter, Iso', iso, from, (.~), (?=), (#), to, folded, {-withIndex, ifolded,-} view, use, (^.), (^..), (^?), (+~), (%~), (.~), (%=), sumOf, at, _Just, Each(..), itraverse_, both, forOf_, (%%~), (?~), mapped)
-import Control.Monad.Base (MonadBase, liftBase)
-import Control.Monad.Error.Class (MonadError)
+import Control.Lens ((.~), view, (^.), (^..), (+~), (%~), (.~), sumOf, at, _Just, Each(..), (%%~), mapped, ifolded, withIndex)
import Control.Monad.Reader
-import Control.Monad.State
-import Control.Monad.Trans.Control (MonadBaseControl)
import Data.Aeson hiding ((.=))
-import Data.Aeson.TH (deriveJSON)
-import Data.Either(Either(Left))
-import Data.Either.Extra (maybeToEither)
+import qualified Data.Aeson.Text as DAT
+import Data.Either (Either(..))
import Data.Foldable
+import qualified Data.List as List
import Data.Map.Strict (Map)
+import qualified Data.Map.Strict as Map
+import qualified Data.Map.Strict.Patch as PM
import Data.Maybe (fromMaybe)
import Data.Monoid
import Data.Ord (Down(..))
-import Data.Patch.Class (Replace, replace, Action(act), Applicable(..), Composable(..), Transformable(..), PairPatch(..), Patched, ConflictResolution, ConflictResolutionReplace, ours)
-import Data.Set (Set)
+import Data.Patch.Class (Action(act), Transformable(..), ours)
+import qualified Data.Set as S
+import qualified Data.Set as Set
import Data.Swagger hiding (version, patch)
-import Data.Text (Text, isInfixOf, count)
-import Data.Validity
-import Database.PostgreSQL.Simple.FromField (FromField, fromField)
+import Data.Text (Text, isInfixOf, unpack)
+import Data.Text.Lazy.IO as DTL
import Formatting (hprint, int, (%))
import Formatting.Clock (timeSpecs)
import GHC.Generics (Generic)
-import Gargantext.Core.Types (ListType(..), NodeId, ListId, DocId, Limit, Offset, HasInvalidError, assertValid)
-import Gargantext.Core.Types (TODO)
-import Gargantext.Core.Utils.Prefix (unPrefix, unPrefixSwagger, wellNamedSchema)
-import Gargantext.Database.Action.Metrics.NgramsByNode (getOccByNgramsOnlyFast')
-import Gargantext.Database.Query.Table.Node.Select
-import Gargantext.Database.Query.Table.Ngrams hiding (NgramsType(..), ngrams, ngramsType, ngrams_terms)
-import Gargantext.Database.Admin.Config (userMaster)
-import Gargantext.Database.Query.Table.Node.Error (HasNodeError)
-import Gargantext.Database.Admin.Types.Node (NodeType(..))
-import Gargantext.Database.Prelude (fromField', HasConnectionPool, HasConfig)
-import Gargantext.Prelude
-import Prelude (Enum, Bounded, Semigroup(..), minBound, maxBound {-, round-}, error)
import Servant hiding (Patch)
import System.Clock (getTime, TimeSpec, Clock(..))
-import System.FileLock (FileLock)
+import Servant.Job.Async (JobFunction(..), serveJobsAPI)
import System.IO (stderr)
import Test.QuickCheck (elements)
import Test.QuickCheck.Arbitrary (Arbitrary, arbitrary)
-import qualified Data.HashMap.Strict.InsOrd as InsOrdHashMap
-import qualified Data.List as List
-import qualified Data.Map.Strict as Map
-import qualified Data.Map.Strict.Patch as PM
-import qualified Data.Set as S
-import qualified Data.Set as Set
-import qualified Gargantext.Database.Query.Table.Ngrams as TableNgrams
-
-------------------------------------------------------------------------
---data FacetFormat = Table | Chart
-data TabType = Docs | Trash | MoreFav | MoreTrash
- | Terms | Sources | Authors | Institutes
- | Contacts
- deriving (Generic, Enum, Bounded, Show)
-
-instance FromHttpApiData TabType
- where
- parseUrlPiece "Docs" = pure Docs
- parseUrlPiece "Trash" = pure Trash
- parseUrlPiece "MoreFav" = pure MoreFav
- parseUrlPiece "MoreTrash" = pure MoreTrash
-
- parseUrlPiece "Terms" = pure Terms
- parseUrlPiece "Sources" = pure Sources
- parseUrlPiece "Institutes" = pure Institutes
- parseUrlPiece "Authors" = pure Authors
-
- parseUrlPiece "Contacts" = pure Contacts
-
- parseUrlPiece _ = Left "Unexpected value of TabType"
-
-instance ToParamSchema TabType
-instance ToJSON TabType
-instance FromJSON TabType
-instance ToSchema TabType
-instance Arbitrary TabType
- where
- arbitrary = elements [minBound .. maxBound]
-
-newtype MSet a = MSet (Map a ())
- deriving (Eq, Ord, Show, Generic, Arbitrary, Semigroup, Monoid)
-
-instance ToJSON a => ToJSON (MSet a) where
- toJSON (MSet m) = toJSON (Map.keys m)
- toEncoding (MSet m) = toEncoding (Map.keys m)
-
-mSetFromSet :: Set a -> MSet a
-mSetFromSet = MSet . Map.fromSet (const ())
-
-mSetFromList :: Ord a => [a] -> MSet a
-mSetFromList = MSet . Map.fromList . map (\x -> (x, ()))
-
--- mSetToSet :: Ord a => MSet a -> Set a
--- mSetToSet (MSet a) = Set.fromList ( Map.keys a)
-mSetToSet :: Ord a => MSet a -> Set a
-mSetToSet = Set.fromList . mSetToList
-
-mSetToList :: MSet a -> [a]
-mSetToList (MSet a) = Map.keys a
-
-instance Foldable MSet where
- foldMap f (MSet m) = Map.foldMapWithKey (\k _ -> f k) m
-
-instance (Ord a, FromJSON a) => FromJSON (MSet a) where
- parseJSON = fmap mSetFromList . parseJSON
-
-instance (ToJSONKey a, ToSchema a) => ToSchema (MSet a) where
- -- TODO
- declareNamedSchema _ = wellNamedSchema "" (Proxy :: Proxy TODO)
-
-------------------------------------------------------------------------
-type NgramsTerm = Text
-
-data RootParent = RootParent
- { _rp_root :: NgramsTerm
- , _rp_parent :: NgramsTerm
- }
- deriving (Ord, Eq, Show, Generic)
-
-deriveJSON (unPrefix "_rp_") ''RootParent
-makeLenses ''RootParent
-
-data NgramsRepoElement = NgramsRepoElement
- { _nre_size :: Int
- , _nre_list :: ListType
---, _nre_root_parent :: Maybe RootParent
- , _nre_root :: Maybe NgramsTerm
- , _nre_parent :: Maybe NgramsTerm
- , _nre_children :: MSet NgramsTerm
- }
- deriving (Ord, Eq, Show, Generic)
-
-deriveJSON (unPrefix "_nre_") ''NgramsRepoElement
-makeLenses ''NgramsRepoElement
-
-instance ToSchema NgramsRepoElement where
- declareNamedSchema = genericDeclareNamedSchema (unPrefixSwagger "_nre_")
-
-instance Serialise (MSet NgramsTerm)
-instance Serialise NgramsRepoElement
-
-data NgramsElement =
- NgramsElement { _ne_ngrams :: NgramsTerm
- , _ne_size :: Int
- , _ne_list :: ListType
- , _ne_occurrences :: Int
- , _ne_root :: Maybe NgramsTerm
- , _ne_parent :: Maybe NgramsTerm
- , _ne_children :: MSet NgramsTerm
- }
- deriving (Ord, Eq, Show, Generic)
-
-deriveJSON (unPrefix "_ne_") ''NgramsElement
-makeLenses ''NgramsElement
-
-mkNgramsElement :: NgramsTerm
- -> ListType
- -> Maybe RootParent
- -> MSet NgramsTerm
- -> NgramsElement
-mkNgramsElement ngrams list rp children =
- NgramsElement ngrams size list 1 (_rp_root <$> rp) (_rp_parent <$> rp) children
- where
- -- TODO review
- size = 1 + count " " ngrams
-
-newNgramsElement :: Maybe ListType -> NgramsTerm -> NgramsElement
-newNgramsElement mayList ngrams =
- mkNgramsElement ngrams (fromMaybe MapTerm mayList) Nothing mempty
-
-instance ToSchema NgramsElement where
- declareNamedSchema = genericDeclareNamedSchema (unPrefixSwagger "_ne_")
-instance Arbitrary NgramsElement where
- arbitrary = elements [newNgramsElement Nothing "sport"]
-
-ngramsElementToRepo :: NgramsElement -> NgramsRepoElement
-ngramsElementToRepo
- (NgramsElement { _ne_size = s
- , _ne_list = l
- , _ne_root = r
- , _ne_parent = p
- , _ne_children = c
- }) =
- NgramsRepoElement
- { _nre_size = s
- , _nre_list = l
- , _nre_parent = p
- , _nre_root = r
- , _nre_children = c
- }
-
-ngramsElementFromRepo :: NgramsTerm -> NgramsRepoElement -> NgramsElement
-ngramsElementFromRepo
- ngrams
- (NgramsRepoElement
- { _nre_size = s
- , _nre_list = l
- , _nre_parent = p
- , _nre_root = r
- , _nre_children = c
- }) =
- NgramsElement { _ne_size = s
- , _ne_list = l
- , _ne_root = r
- , _ne_parent = p
- , _ne_children = c
- , _ne_ngrams = ngrams
- , _ne_occurrences = panic $ "API.Ngrams._ne_occurrences"
- {-
- -- Here we could use 0 if we want to avoid any `panic`.
- -- It will not happen using getTableNgrams if
- -- getOccByNgramsOnly provides a count of occurrences for
- -- all the ngrams given.
- -}
- }
-
-------------------------------------------------------------------------
-newtype NgramsTable = NgramsTable [NgramsElement]
- deriving (Ord, Eq, Generic, ToJSON, FromJSON, Show)
-
-type NgramsList = NgramsTable
-
-makePrisms ''NgramsTable
-
--- | Question: why these repetition of Type in this instance
--- may you document it please ?
-instance Each NgramsTable NgramsTable NgramsElement NgramsElement where
- each = _NgramsTable . each
-
--- TODO discuss
--- | TODO Check N and Weight
-{-
-toNgramsElement :: [NgramsTableData] -> [NgramsElement]
-toNgramsElement ns = map toNgramsElement' ns
- where
- toNgramsElement' (NgramsTableData _ p t _ lt w) = NgramsElement t lt' (round w) p' c'
- where
- p' = case p of
- Nothing -> Nothing
- Just x -> lookup x mapParent
- c' = maybe mempty identity $ lookup t mapChildren
- lt' = maybe (panic "API.Ngrams: listypeId") identity lt
-
- mapParent :: Map Int Text
- mapParent = Map.fromListWith (<>) $ map (\(NgramsTableData i _ t _ _ _) -> (i,t)) ns
-
- mapChildren :: Map Text (Set Text)
- mapChildren = Map.mapKeys (\i -> (maybe (panic "API.Ngrams.mapChildren: ParentId with no Terms: Impossible") identity $ lookup i mapParent))
- $ Map.fromListWith (<>)
- $ map (first fromJust)
- $ filter (isJust . fst)
- $ map (\(NgramsTableData _ p t _ _ _) -> (p, Set.singleton t)) ns
--}
-
-mockTable :: NgramsTable
-mockTable = NgramsTable
- [ mkNgramsElement "animal" MapTerm Nothing (mSetFromList ["dog", "cat"])
- , mkNgramsElement "cat" MapTerm (rp "animal") mempty
- , mkNgramsElement "cats" StopTerm Nothing mempty
- , mkNgramsElement "dog" MapTerm (rp "animal") (mSetFromList ["dogs"])
- , mkNgramsElement "dogs" StopTerm (rp "dog") mempty
- , mkNgramsElement "fox" MapTerm Nothing mempty
- , mkNgramsElement "object" CandidateTerm Nothing mempty
- , mkNgramsElement "nothing" StopTerm Nothing mempty
- , mkNgramsElement "organic" MapTerm Nothing (mSetFromList ["flower"])
- , mkNgramsElement "flower" MapTerm (rp "organic") mempty
- , mkNgramsElement "moon" CandidateTerm Nothing mempty
- , mkNgramsElement "sky" StopTerm Nothing mempty
- ]
- where
- rp n = Just $ RootParent n n
-
-instance Arbitrary NgramsTable where
- arbitrary = pure mockTable
-
-instance ToSchema NgramsTable
-
-------------------------------------------------------------------------
-type NgramsTableMap = Map NgramsTerm NgramsRepoElement
-------------------------------------------------------------------------
--- On the Client side:
---data Action = InGroup NgramsId NgramsId
--- | OutGroup NgramsId NgramsId
--- | SetListType NgramsId ListType
-
-data PatchSet a = PatchSet
- { _rem :: Set a
- , _add :: Set a
- }
- deriving (Eq, Ord, Show, Generic)
-
-makeLenses ''PatchSet
-makePrisms ''PatchSet
-
-instance ToJSON a => ToJSON (PatchSet a) where
- toJSON = genericToJSON $ unPrefix "_"
- toEncoding = genericToEncoding $ unPrefix "_"
-
-instance (Ord a, FromJSON a) => FromJSON (PatchSet a) where
- parseJSON = genericParseJSON $ unPrefix "_"
-
-{-
-instance (Ord a, Arbitrary a) => Arbitrary (PatchSet a) where
- arbitrary = PatchSet <$> arbitrary <*> arbitrary
-
-type instance Patched (PatchSet a) = Set a
-
-type ConflictResolutionPatchSet a = SimpleConflictResolution' (Set a)
-type instance ConflictResolution (PatchSet a) = ConflictResolutionPatchSet a
-
-instance Ord a => Semigroup (PatchSet a) where
- p <> q = PatchSet { _rem = (q ^. rem) `Set.difference` (p ^. add) <> p ^. rem
- , _add = (q ^. add) `Set.difference` (p ^. rem) <> p ^. add
- } -- TODO Review
-
-instance Ord a => Monoid (PatchSet a) where
- mempty = PatchSet mempty mempty
-
-instance Ord a => Group (PatchSet a) where
- invert (PatchSet r a) = PatchSet a r
-
-instance Ord a => Composable (PatchSet a) where
- composable _ _ = undefined
-
-instance Ord a => Action (PatchSet a) (Set a) where
- act p source = (source `Set.difference` (p ^. rem)) <> p ^. add
-
-instance Applicable (PatchSet a) (Set a) where
- applicable _ _ = mempty
-
-instance Ord a => Validity (PatchSet a) where
- validate p = check (Set.disjoint (p ^. rem) (p ^. add)) "_rem and _add should be dijoint"
-
-instance Ord a => Transformable (PatchSet a) where
- transformable = undefined
-
- conflicts _p _q = undefined
-
- transformWith conflict p q = undefined conflict p q
-
-instance ToSchema a => ToSchema (PatchSet a)
--}
-
-type AddRem = Replace (Maybe ())
-
-instance Serialise AddRem
-
-remPatch, addPatch :: AddRem
-remPatch = replace (Just ()) Nothing
-addPatch = replace Nothing (Just ())
-
-isRem :: Replace (Maybe ()) -> Bool
-isRem = (== remPatch)
-
-type PatchMap = PM.PatchMap
-
-
-newtype PatchMSet a = PatchMSet (PatchMap a AddRem)
- deriving (Eq, Show, Generic, Validity, Semigroup, Monoid,
- Transformable, Composable)
-
-type ConflictResolutionPatchMSet a = a -> ConflictResolutionReplace (Maybe ())
-type instance ConflictResolution (PatchMSet a) = ConflictResolutionPatchMSet a
-
-instance (Serialise a, Ord a) => Serialise (PatchMap a AddRem)
-instance (Serialise a, Ord a) => Serialise (PatchMSet a)
-
--- TODO this breaks module abstraction
-makePrisms ''PM.PatchMap
-
-makePrisms ''PatchMSet
-
-_PatchMSetIso :: Ord a => Iso' (PatchMSet a) (PatchSet a)
-_PatchMSetIso = _PatchMSet . _PatchMap . iso f g . from _PatchSet
- where
- f :: Ord a => Map a (Replace (Maybe ())) -> (Set a, Set a)
- f = Map.partition isRem >>> both %~ Map.keysSet
-
- g :: Ord a => (Set a, Set a) -> Map a (Replace (Maybe ()))
- g (rems, adds) = Map.fromSet (const remPatch) rems
- <> Map.fromSet (const addPatch) adds
-
-instance Ord a => Action (PatchMSet a) (MSet a) where
- act (PatchMSet p) (MSet m) = MSet $ act p m
-
-instance Ord a => Applicable (PatchMSet a) (MSet a) where
- applicable (PatchMSet p) (MSet m) = applicable p m
-
-instance (Ord a, ToJSON a) => ToJSON (PatchMSet a) where
- toJSON = toJSON . view _PatchMSetIso
- toEncoding = toEncoding . view _PatchMSetIso
-
-instance (Ord a, FromJSON a) => FromJSON (PatchMSet a) where
- parseJSON = fmap (_PatchMSetIso #) . parseJSON
-
-instance (Ord a, Arbitrary a) => Arbitrary (PatchMSet a) where
- arbitrary = (PatchMSet . PM.fromMap) <$> arbitrary
-
-instance ToSchema a => ToSchema (PatchMSet a) where
- -- TODO
- declareNamedSchema _ = wellNamedSchema "" (Proxy :: Proxy TODO)
-
-type instance Patched (PatchMSet a) = MSet a
-
-instance (Eq a, Arbitrary a) => Arbitrary (Replace a) where
- arbitrary = uncurry replace <$> arbitrary
- -- If they happen to be equal then the patch is Keep.
-
-instance ToSchema a => ToSchema (Replace a) where
- declareNamedSchema (_ :: Proxy (Replace a)) = do
- -- TODO Keep constructor is not supported here.
- aSchema <- declareSchemaRef (Proxy :: Proxy a)
- return $ NamedSchema (Just "Replace") $ mempty
- & type_ ?~ SwaggerObject
- & properties .~
- InsOrdHashMap.fromList
- [ ("old", aSchema)
- , ("new", aSchema)
- ]
- & required .~ [ "old", "new" ]
-
-data NgramsPatch =
- NgramsPatch { _patch_children :: PatchMSet NgramsTerm
- , _patch_list :: Replace ListType -- TODO Map UserId ListType
- }
- deriving (Eq, Show, Generic)
-
-deriveJSON (unPrefix "_") ''NgramsPatch
-makeLenses ''NgramsPatch
-
-instance ToSchema NgramsPatch where
- declareNamedSchema = genericDeclareNamedSchema (unPrefixSwagger "_")
-
-instance Arbitrary NgramsPatch where
- arbitrary = NgramsPatch <$> arbitrary <*> (replace <$> arbitrary <*> arbitrary)
-
-instance Serialise NgramsPatch
-instance Serialise (Replace ListType)
-instance Serialise ListType
-
-type NgramsPatchIso = PairPatch (PatchMSet NgramsTerm) (Replace ListType)
-
-_NgramsPatch :: Iso' NgramsPatch NgramsPatchIso
-_NgramsPatch = iso (\(NgramsPatch c l) -> c :*: l) (\(c :*: l) -> NgramsPatch c l)
-
-instance Semigroup NgramsPatch where
- p <> q = _NgramsPatch # (p ^. _NgramsPatch <> q ^. _NgramsPatch)
-
-instance Monoid NgramsPatch where
- mempty = _NgramsPatch # mempty
-
-instance Validity NgramsPatch where
- validate p = p ^. _NgramsPatch . to validate
-
-instance Transformable NgramsPatch where
- transformable p q = transformable (p ^. _NgramsPatch) (q ^. _NgramsPatch)
-
- conflicts p q = conflicts (p ^. _NgramsPatch) (q ^. _NgramsPatch)
-
- transformWith conflict p q = (_NgramsPatch # p', _NgramsPatch # q')
- where
- (p', q') = transformWith conflict (p ^. _NgramsPatch) (q ^. _NgramsPatch)
-
-type ConflictResolutionNgramsPatch =
- ( ConflictResolutionPatchMSet NgramsTerm
- , ConflictResolutionReplace ListType
- )
-type instance ConflictResolution NgramsPatch =
- ConflictResolutionNgramsPatch
-
-type PatchedNgramsPatch = (Set NgramsTerm, ListType)
- -- ~ Patched NgramsPatchIso
-type instance Patched NgramsPatch = PatchedNgramsPatch
-
-instance Applicable NgramsPatch (Maybe NgramsRepoElement) where
- applicable p Nothing = check (p == mempty) "NgramsPatch should be empty here"
- applicable p (Just nre) =
- applicable (p ^. patch_children) (nre ^. nre_children) <>
- applicable (p ^. patch_list) (nre ^. nre_list)
-
-instance Action NgramsPatch NgramsRepoElement where
- act p = (nre_children %~ act (p ^. patch_children))
- . (nre_list %~ act (p ^. patch_list))
-
-instance Action NgramsPatch (Maybe NgramsRepoElement) where
- act = fmap . act
-
-newtype NgramsTablePatch = NgramsTablePatch (PatchMap NgramsTerm NgramsPatch)
- deriving (Eq, Show, Generic, ToJSON, FromJSON, Semigroup, Monoid, Validity, Transformable)
-
-instance Serialise NgramsTablePatch
-instance Serialise (PatchMap NgramsTerm NgramsPatch)
-
-instance FromField NgramsTablePatch
- where
- fromField = fromField'
-
-instance FromField (PatchMap TableNgrams.NgramsType (PatchMap NodeId NgramsTablePatch))
- where
- fromField = fromField'
-
---instance (Ord k, Action pv (Maybe v)) => Action (PatchMap k pv) (Map k v) where
---
-type instance ConflictResolution NgramsTablePatch =
- NgramsTerm -> ConflictResolutionNgramsPatch
-
-type PatchedNgramsTablePatch = Map NgramsTerm PatchedNgramsPatch
- -- ~ Patched (PatchMap NgramsTerm NgramsPatch)
-type instance Patched NgramsTablePatch = PatchedNgramsTablePatch
-
-makePrisms ''NgramsTablePatch
-instance ToSchema (PatchMap NgramsTerm NgramsPatch)
-instance ToSchema NgramsTablePatch
-
-instance Applicable NgramsTablePatch (Maybe NgramsTableMap) where
- applicable p = applicable (p ^. _NgramsTablePatch)
-
-instance Action NgramsTablePatch (Maybe NgramsTableMap) where
- act p =
- fmap (execState (reParentNgramsTablePatch p)) .
- act (p ^. _NgramsTablePatch)
-
-instance Arbitrary NgramsTablePatch where
- arbitrary = NgramsTablePatch <$> PM.fromMap <$> arbitrary
-
--- Should it be less than an Lens' to preserve PatchMap's abstraction.
--- ntp_ngrams_patches :: Lens' NgramsTablePatch (Map NgramsTerm NgramsPatch)
--- ntp_ngrams_patches = _NgramsTablePatch . undefined
-
-type ReParent a = forall m. MonadState NgramsTableMap m => a -> m ()
-
-reRootChildren :: NgramsTerm -> ReParent NgramsTerm
-reRootChildren root ngram = do
- nre <- use $ at ngram
- forOf_ (_Just . nre_children . folded) nre $ \child -> do
- at child . _Just . nre_root ?= root
- reRootChildren root child
-
-reParent :: Maybe RootParent -> ReParent NgramsTerm
-reParent rp child = do
- at child . _Just %= ( (nre_parent .~ (_rp_parent <$> rp))
- . (nre_root .~ (_rp_root <$> rp))
- )
- reRootChildren (fromMaybe child (rp ^? _Just . rp_root)) child
-
-reParentAddRem :: RootParent -> NgramsTerm -> ReParent AddRem
-reParentAddRem rp child p =
- reParent (if isRem p then Nothing else Just rp) child
-
-reParentNgramsPatch :: NgramsTerm -> ReParent NgramsPatch
-reParentNgramsPatch parent ngramsPatch = do
- root_of_parent <- use (at parent . _Just . nre_root)
- let
- root = fromMaybe parent root_of_parent
- rp = RootParent { _rp_root = root, _rp_parent = parent }
- itraverse_ (reParentAddRem rp) (ngramsPatch ^. patch_children . _PatchMSet . _PatchMap)
- -- TODO FoldableWithIndex/TraversableWithIndex for PatchMap
-
-reParentNgramsTablePatch :: ReParent NgramsTablePatch
-reParentNgramsTablePatch p = itraverse_ reParentNgramsPatch (p ^. _NgramsTablePatch. _PatchMap)
- -- TODO FoldableWithIndex/TraversableWithIndex for PatchMap
-
-------------------------------------------------------------------------
-------------------------------------------------------------------------
-type Version = Int
-
-data Versioned a = Versioned
- { _v_version :: Version
- , _v_data :: a
- }
- deriving (Generic, Show, Eq)
-deriveJSON (unPrefix "_v_") ''Versioned
-makeLenses ''Versioned
-instance (Typeable a, ToSchema a) => ToSchema (Versioned a) where
- declareNamedSchema = wellNamedSchema "_v_"
-instance Arbitrary a => Arbitrary (Versioned a) where
- arbitrary = Versioned 1 <$> arbitrary -- TODO 1 is constant so far
+import Prelude (error)
+import Gargantext.Prelude hiding (log)
+
+import Gargantext.API.Admin.Orchestrator.Types (JobLog(..), AsyncJobs)
+import Gargantext.API.Admin.Types (HasSettings)
+import qualified Gargantext.API.Metrics as Metrics
+import Gargantext.API.Ngrams.Types
+import Gargantext.API.Prelude
+import Gargantext.Core.Types (ListType(..), NodeId, ListId, DocId, Limit, Offset, TODO, assertValid)
+import Gargantext.Core.Utils (something)
+-- import Gargantext.Core.Viz.Graph.API (recomputeGraph)
+-- import Gargantext.Core.Viz.Graph.Distances (Distance(Conditional))
+import Gargantext.Database.Action.Flow.Types
+import Gargantext.Database.Action.Metrics.NgramsByNode (getOccByNgramsOnlyFast')
+import Gargantext.Database.Admin.Config (userMaster)
+import Gargantext.Database.Admin.Types.Node (NodeType(..))
+import Gargantext.Database.Prelude (HasConnectionPool, HasConfig)
+import Gargantext.Database.Query.Table.Node.Error (HasNodeError)
+import Gargantext.Database.Query.Table.Node.Select
+import Gargantext.Database.Query.Table.Ngrams hiding (NgramsType(..), ngramsType, ngrams_terms)
+import qualified Gargantext.Database.Query.Table.Ngrams as TableNgrams
+import Gargantext.Database.Query.Table.Node (getNode)
+import Gargantext.Database.Schema.Node (node_id, node_parentId, node_userId)
+import Gargantext.Prelude.Job
{-
-- TODO sequences of modifications (Patchs)
]
-}
-ngramsTypeFromTabType :: TabType -> TableNgrams.NgramsType
-ngramsTypeFromTabType tabType =
- let lieu = "Garg.API.Ngrams: " :: Text in
- case tabType of
- Sources -> TableNgrams.Sources
- Authors -> TableNgrams.Authors
- Institutes -> TableNgrams.Institutes
- Terms -> TableNgrams.NgramsTerms
- _ -> panic $ lieu <> "No Ngrams for this tab"
- -- TODO: This `panic` would disapear with custom NgramsType.
-
-------------------------------------------------------------------------
-data Repo s p = Repo
- { _r_version :: Version
- , _r_state :: s
- , _r_history :: [p]
- -- first patch in the list is the most recent
- }
- deriving (Generic)
-
-instance (FromJSON s, FromJSON p) => FromJSON (Repo s p) where
- parseJSON = genericParseJSON $ unPrefix "_r_"
-
-instance (ToJSON s, ToJSON p) => ToJSON (Repo s p) where
- toJSON = genericToJSON $ unPrefix "_r_"
- toEncoding = genericToEncoding $ unPrefix "_r_"
-
-instance (Serialise s, Serialise p) => Serialise (Repo s p)
-
-makeLenses ''Repo
-
-initRepo :: Monoid s => Repo s p
-initRepo = Repo 1 mempty []
-
-type NgramsRepo = Repo NgramsState NgramsStatePatch
-type NgramsState = Map TableNgrams.NgramsType (Map NodeId NgramsTableMap)
-type NgramsStatePatch = PatchMap TableNgrams.NgramsType (PatchMap NodeId NgramsTablePatch)
-
-instance Serialise (PM.PatchMap NodeId NgramsTablePatch)
-instance Serialise NgramsStatePatch
-
-initMockRepo :: NgramsRepo
-initMockRepo = Repo 1 s []
- where
- s = Map.singleton TableNgrams.NgramsTerms
- $ Map.singleton 47254
- $ Map.fromList
- [ (n ^. ne_ngrams, ngramsElementToRepo n) | n <- mockTable ^. _NgramsTable ]
-
-data RepoEnv = RepoEnv
- { _renv_var :: !(MVar NgramsRepo)
- , _renv_saver :: !(IO ())
- , _renv_lock :: !FileLock
- }
- deriving (Generic)
-
-makeLenses ''RepoEnv
-
-class HasRepoVar env where
- repoVar :: Getter env (MVar NgramsRepo)
-
-instance HasRepoVar (MVar NgramsRepo) where
- repoVar = identity
-
-class HasRepoSaver env where
- repoSaver :: Getter env (IO ())
-
-class (HasRepoVar env, HasRepoSaver env) => HasRepo env where
- repoEnv :: Getter env RepoEnv
-
-instance HasRepo RepoEnv where
- repoEnv = identity
-
-instance HasRepoVar RepoEnv where
- repoVar = renv_var
-
-instance HasRepoSaver RepoEnv where
- repoSaver = renv_saver
-
-type RepoCmdM env err m =
- ( MonadReader env m
- , MonadError err m
- , MonadBaseControl IO m
- , HasRepo env
- )
------------------------------------------------------------------------
saveRepo :: ( MonadReader env m, MonadBase IO m, HasRepoSaver env )
-> NgramsTerm
-> ConflictResolutionNgramsPatch
ngramsStatePatchConflictResolution _ngramsType _nodeId _ngramsTerm
- = (const ours, ours)
+ = (ours, (const ours, ours), (False, False))
+ -- (False, False) mean here that Mod has always priority.
+ -- (True, False) <- would mean priority to the left (same as ours).
+
-- undefined {- TODO think this through -}, listTypeConflictResolution)
-- Current state:
insertNewOnly m = maybe m (const $ error "insertNewOnly: impossible")
-- TODO error handling
-something :: Monoid a => Maybe a -> a
-something Nothing = mempty
-something (Just a) = a
-
{- unused
-- TODO refactor with putListNgrams
copyListNgrams :: RepoCmdM env err m
m = Map.fromList $ (\n -> (n ^. ne_ngrams, n)) <$> nes
-}
+-- UNSAFE
rmListNgrams :: RepoCmdM env err m
=> ListId
-> TableNgrams.NgramsType
-- | TODO: incr the Version number
-- && should use patch
+-- UNSAFE
setListNgrams :: RepoCmdM env err m
=> NodeId
-> TableNgrams.NgramsType
saveRepo
--- If the given list of ngrams elements contains ngrams already in
--- the repo, they will be ignored.
-putListNgrams :: RepoCmdM env err m
- => NodeId
- -> TableNgrams.NgramsType
- -> [NgramsElement] -> m ()
-putListNgrams _ _ [] = pure ()
-putListNgrams listId ngramsType nes = putListNgrams' listId ngramsType m
- where
- m = Map.fromList $ map (\n -> (n ^. ne_ngrams, ngramsElementToRepo n)) nes
-
-putListNgrams' :: RepoCmdM env err m
- => ListId
- -> TableNgrams.NgramsType
- -> Map NgramsTerm NgramsRepoElement
- -> m ()
-putListNgrams' listId ngramsType ns = do
- -- printDebug "putListNgrams" (length nes)
- var <- view repoVar
- liftBase $ modifyMVar_ var $
- pure . ( r_state
- . at ngramsType %~
- (Just .
- (at listId %~
- ( Just
- . (<> ns)
- . something
- )
- )
- . something
- )
- )
- saveRepo
-
-
--- TODO-ACCESS check
-tableNgramsPost :: RepoCmdM env err m
- => TabType
- -> NodeId
- -> Maybe ListType
- -> [NgramsTerm] -> m ()
-tableNgramsPost tabType listId mayList =
- putListNgrams listId (ngramsTypeFromTabType tabType) . fmap (newNgramsElement mayList)
-
currentVersion :: RepoCmdM env err m
=> m Version
currentVersion = do
r <- liftBase $ readMVar var
pure $ r ^. r_version
+newNgramsFromNgramsStatePatch :: NgramsStatePatch -> [Ngrams]
+newNgramsFromNgramsStatePatch p =
+ [ text2ngrams (unNgramsTerm n)
+ | (n,np) <- p ^.. _PatchMap . each . _PatchMap . each . _NgramsTablePatch . _PatchMap . ifolded . withIndex
+ , _ <- np ^.. patch_new . _Just
+ ]
+
+-- tableNgramsPut :: (HasInvalidError err, RepoCmdM env err m)
+commitStatePatch :: RepoCmdM env err m => Versioned NgramsStatePatch -> m (Versioned NgramsStatePatch)
+commitStatePatch (Versioned p_version p) = do
+ var <- view repoVar
+ vq' <- liftBase $ modifyMVar var $ \r -> do
+ let
+ q = mconcat $ take (r ^. r_version - p_version) (r ^. r_history)
+ (p', q') = transformWith ngramsStatePatchConflictResolution p q
+ r' = r & r_version +~ 1
+ & r_state %~ act p'
+ & r_history %~ (p' :)
+ {-
+ -- Ideally we would like to check these properties. However:
+ -- * They should be checked only to debug the code. The client data
+ -- should be able to trigger these.
+ -- * What kind of error should they throw (we are in IO here)?
+ -- * Should we keep modifyMVar?
+ -- * Should we throw the validation in an Exception, catch it around
+ -- modifyMVar and throw it back as an Error?
+ assertValid $ transformable p q
+ assertValid $ applicable p' (r ^. r_state)
+ -}
+ pure (r', Versioned (r' ^. r_version) q')
+
+ saveRepo
+
+ -- Save new ngrams
+ _ <- insertNgrams (newNgramsFromNgramsStatePatch p)
+
+ pure vq'
+
+-- This is a special case of tableNgramsPut where the input patch is empty.
tableNgramsPull :: RepoCmdM env err m
=> ListId
-> TableNgrams.NgramsType
-- Apply the given patch to the DB and returns the patch to be applied on the
-- client.
-- TODO-ACCESS check
-tableNgramsPut :: (HasInvalidError err, RepoCmdM env err m)
- => TabType -> ListId
+tableNgramsPut :: ( FlowCmdM env err m
+ , HasSettings env
+ )
+ => TabType
+ -> ListId
-> Versioned NgramsTablePatch
-> m (Versioned NgramsTablePatch)
tableNgramsPut tabType listId (Versioned p_version p_table)
assertValid p0_validity
assertValid p_validity
- var <- view repoVar
- vq' <- liftBase $ modifyMVar var $ \r -> do
- let
- q = mconcat $ take (r ^. r_version - p_version) (r ^. r_history)
- (p', q') = transformWith ngramsStatePatchConflictResolution p q
- r' = r & r_version +~ 1
- & r_state %~ act p'
- & r_history %~ (p' :)
- q'_table = q' ^. _PatchMap . at ngramsType . _Just . _PatchMap . at listId . _Just
- {-
- -- Ideally we would like to check these properties. However:
- -- * They should be checked only to debug the code. The client data
- -- should be able to trigger these.
- -- * What kind of error should they throw (we are in IO here)?
- -- * Should we keep modifyMVar?
- -- * Should we throw the validation in an Exception, catch it around
- -- modifyMVar and throw it back as an Error?
- assertValid $ transformable p q
- assertValid $ applicable p' (r ^. r_state)
- -}
- pure (r', Versioned (r' ^. r_version) q'_table)
-
- saveRepo
- pure vq'
-
-mergeNgramsElement :: NgramsRepoElement -> NgramsRepoElement -> NgramsRepoElement
-mergeNgramsElement _neOld neNew = neNew
+ ret <- commitStatePatch (Versioned p_version p)
+ <&> v_data %~ (view (_PatchMap . at ngramsType . _Just . _PatchMap . at listId . _Just))
+
+ pure ret
+
+
+tableNgramsPostChartsAsync :: ( FlowCmdM env err m
+ , HasNodeError err
+ , HasSettings env
+ )
+ => UpdateTableNgramsCharts
+ -> (JobLog -> m ())
+ -> m JobLog
+tableNgramsPostChartsAsync utn logStatus = do
+ let tabType = utn ^. utn_tab_type
+ let listId = utn ^. utn_list_id
+
+ node <- getNode listId
+ let nId = node ^. node_id
+ _uId = node ^. node_userId
+ mCId = node ^. node_parentId
+
+ printDebug "[tableNgramsPut] tabType" tabType
+ printDebug "[tableNgramsPut] listId" listId
+
+ case mCId of
+ Nothing -> do
+ printDebug "[tableNgramsPut] can't update charts, no parent, nId" nId
+ pure $ jobLogFail $ jobLogInit 1
+ Just cId -> do
+ case tabType of
+ Authors -> do
+ -- printDebug "[tableNgramsPut] Authors, updating Pie, cId" cId
+ (logRef, logRefSuccess, getRef) <- runJobLog 1 logStatus
+ logRef
+ _ <- Metrics.updatePie cId (Just listId) tabType Nothing
+ logRefSuccess
+
+ getRef
+ Institutes -> do
+ -- printDebug "[tableNgramsPut] Institutes, updating Tree, cId" cId
+ -- printDebug "[tableNgramsPut] updating tree StopTerm, cId" cId
+ (logRef, logRefSuccess, getRef) <- runJobLog 3 logStatus
+ logRef
+ _ <- Metrics.updateTree cId (Just listId) tabType StopTerm
+ -- printDebug "[tableNgramsPut] updating tree CandidateTerm, cId" cId
+ logRefSuccess
+ _ <- Metrics.updateTree cId (Just listId) tabType CandidateTerm
+ -- printDebug "[tableNgramsPut] updating tree MapTerm, cId" cId
+ logRefSuccess
+ _ <- Metrics.updateTree cId (Just listId) tabType MapTerm
+ logRefSuccess
+
+ getRef
+ Sources -> do
+ -- printDebug "[tableNgramsPut] Sources, updating chart, cId" cId
+ (logRef, logRefSuccess, getRef) <- runJobLog 1 logStatus
+ logRef
+ _ <- Metrics.updatePie cId (Just listId) tabType Nothing
+ logRefSuccess
+
+ getRef
+ Terms -> do
+ -- printDebug "[tableNgramsPut] Terms, updating Metrics (Histo), cId" cId
+ (logRef, logRefSuccess, getRef) <- runJobLog 6 logStatus
+ logRef
+{-
+ _ <- Metrics.updateChart cId (Just listId) tabType Nothing
+ logRefSuccess
+ _ <- Metrics.updatePie cId (Just listId) tabType Nothing
+ logRefSuccess
+ _ <- Metrics.updateScatter cId (Just listId) tabType Nothing
+ logRefSuccess
+ _ <- Metrics.updateTree cId (Just listId) tabType StopTerm
+ logRefSuccess
+ _ <- Metrics.updateTree cId (Just listId) tabType CandidateTerm
+ logRefSuccess
+ _ <- Metrics.updateTree cId (Just listId) tabType MapTerm
+-}
+ logRefSuccess
+
+ getRef
+ _ -> do
+ printDebug "[tableNgramsPut] no update for tabType = " tabType
+ pure $ jobLogFail $ jobLogInit 1
+
{-
{ _ne_list :: ListType
If we merge the parents/children we can potentially create cycles!
-}
getNgramsTableMap :: RepoCmdM env err m
- => ListId
+ => NodeId
-> TableNgrams.NgramsType
-> m (Versioned NgramsTableMap)
getNgramsTableMap nodeId ngramsType = do
pure $ Versioned (repo ^. r_version)
(repo ^. r_state . at ngramsType . _Just . at nodeId . _Just)
+dumpJsonTableMap :: RepoCmdM env err m
+ => Text
+ -> NodeId
+ -> TableNgrams.NgramsType
+ -> m ()
+dumpJsonTableMap fpath nodeId ngramsType = do
+ m <- getNgramsTableMap nodeId ngramsType
+ liftBase $ DTL.writeFile (unpack fpath) (DAT.encodeToLazyText m)
+ pure ()
+
type MinSize = Int
type MaxSize = Int
-> Maybe MinSize -> Maybe MaxSize
-> Maybe OrderBy
-> (NgramsTerm -> Bool)
- -> m (Versioned NgramsTable)
+ -> m (VersionedWithCount NgramsTable)
getTableNgrams _nType nId tabType listId limit_ offset
listType minSize maxSize orderBy searchQuery = do
sortOnOrder (Just ScoreAsc) = List.sortOn $ view ne_occurrences
sortOnOrder (Just ScoreDesc) = List.sortOn $ Down . view ne_occurrences
+ ---------------------------------------
+
+ filteredNodes :: Map NgramsTerm NgramsElement -> [NgramsElement]
+ filteredNodes tableMap = rootOf <$> list & filter selected_node
+ where
+ rootOf ne = maybe ne (\r -> fromMaybe (panic "getTableNgrams: invalid root") (tableMap ^. at r))
+ (ne ^. ne_root)
+ list = tableMap ^.. each
+
---------------------------------------
selectAndPaginate :: Map NgramsTerm NgramsElement -> [NgramsElement]
selectAndPaginate tableMap = roots <> inners
setScores :: forall t. Each t t NgramsElement NgramsElement => Bool -> t -> m t
setScores False table = pure table
setScores True table = do
- let ngrams_terms = (table ^.. each . ne_ngrams)
+ let ngrams_terms = table ^.. each . ne_ngrams
t1 <- getTime'
occurrences <- getOccByNgramsOnlyFast' nId
listId
-- trace (show lists) $
-- getNgramsTableMap ({-lists <>-} listIds) ngramsType
+
let scoresNeeded = needsScores orderBy
tableMap1 <- getNgramsTableMap listId ngramsType
t1 <- getTime'
tableMap2 <- tableMap1 & v_data %%~ setScores scoresNeeded
. Map.mapWithKey ngramsElementFromRepo
+
+ fltr <- tableMap2 & v_data %%~ fmap NgramsTable . setScores (not scoresNeeded)
+ . filteredNodes
+ let fltrCount = length $ fltr ^. v_data . _NgramsTable
+
t2 <- getTime'
tableMap3 <- tableMap2 & v_data %%~ fmap NgramsTable
. setScores (not scoresNeeded)
% " sql=" % (if scoresNeeded then "map2" else "map3")
% "\n"
) t0 t3 t0 t1 t1 t2 t2 t3
- pure tableMap3
+ pure $ toVersionedWithCount fltrCount tableMap3
scoresRecomputeTableNgrams :: forall env err m. (RepoCmdM env err m, HasNodeError err, HasConnectionPool env, HasConfig env) => NodeId -> TabType -> ListId -> m Int
setScores :: forall t. Each t t NgramsElement NgramsElement => t -> m t
setScores table = do
- let ngrams_terms = (table ^.. each . ne_ngrams)
+ let ngrams_terms = table ^.. each . ne_ngrams
occurrences <- getOccByNgramsOnlyFast' nId
listId
ngramsType
-- APIs
-- TODO: find a better place for the code above, All APIs stay here
-type QueryParamR = QueryParam' '[Required, Strict]
data OrderBy = TermAsc | TermDesc | ScoreAsc | ScoreDesc
deriving (Generic, Enum, Bounded, Read, Show)
:> QueryParam "maxTermSize" MaxSize
:> QueryParam "orderBy" OrderBy
:> QueryParam "search" Text
- :> Get '[JSON] (Versioned NgramsTable)
+ :> Get '[JSON] (VersionedWithCount NgramsTable)
type TableNgramsApiPut = Summary " Table Ngrams API Change"
:> QueryParamR "ngramsType" TabType
:> ReqBody '[JSON] (Versioned NgramsTablePatch)
:> Put '[JSON] (Versioned NgramsTablePatch)
-type TableNgramsApiPost = Summary " Table Ngrams API Adds new ngrams"
- :> QueryParamR "ngramsType" TabType
- :> QueryParamR "list" ListId
- :> QueryParam "listType" ListType
- :> ReqBody '[JSON] [NgramsTerm]
- :> Post '[JSON] ()
-
type RecomputeScoresNgramsApiGet = Summary " Recompute scores for ngrams table"
:> QueryParamR "ngramsType" TabType
:> QueryParamR "list" ListId
type TableNgramsApi = TableNgramsApiGet
:<|> TableNgramsApiPut
- :<|> TableNgramsApiPost
:<|> RecomputeScoresNgramsApiGet
:<|> "version" :> TableNgramsApiGetVersion
+ :<|> TableNgramsAsyncApi
+
+type TableNgramsAsyncApi = Summary "Table Ngrams Async API"
+ :> "async"
+ :> "charts"
+ :> "update"
+ :> AsyncJobs JobLog '[JSON] UpdateTableNgramsCharts JobLog
getTableNgramsCorpus :: (RepoCmdM env err m, HasNodeError err, HasConnectionPool env, HasConfig env)
=> NodeId
-> Maybe MinSize -> Maybe MaxSize
-> Maybe OrderBy
-> Maybe Text -- full text search
- -> m (Versioned NgramsTable)
+ -> m (VersionedWithCount NgramsTable)
getTableNgramsCorpus nId tabType listId limit_ offset listType minSize maxSize orderBy mt =
getTableNgrams NodeCorpus nId tabType listId limit_ offset listType minSize maxSize orderBy searchQuery
where
- searchQuery = maybe (const True) isInfixOf mt
+ searchQuery (NgramsTerm nt) = maybe (const True) isInfixOf mt nt
getTableNgramsVersion :: (RepoCmdM env err m, HasNodeError err, HasConnectionPool env, HasConfig env)
=> NodeId
-> TabType
-> ListId
-> m Version
-getTableNgramsVersion nId tabType listId = do
+getTableNgramsVersion _nId _tabType _listId = currentVersion
-- TODO: limit?
- Versioned { _v_version = v } <- getTableNgramsCorpus nId tabType listId 100000 Nothing Nothing Nothing Nothing Nothing Nothing
- pure v
+ -- Versioned { _v_version = v } <- getTableNgramsCorpus nId tabType listId 100000 Nothing Nothing Nothing Nothing Nothing Nothing
+ -- This line above looks like a waste of computation to finally get only the version.
+ -- See the comment about listNgramsChangedSince.
+
-- | Text search is deactivated for now for ngrams by doc only
getTableNgramsDoc :: (RepoCmdM env err m, HasNodeError err, HasConnectionPool env, HasConfig env)
-> Maybe MinSize -> Maybe MaxSize
-> Maybe OrderBy
-> Maybe Text -- full text search
- -> m (Versioned NgramsTable)
+ -> m (VersionedWithCount NgramsTable)
getTableNgramsDoc dId tabType listId limit_ offset listType minSize maxSize orderBy _mt = do
ns <- selectNodesWithUsername NodeList userMaster
let ngramsType = ngramsTypeFromTabType tabType
ngs <- selectNgramsByDoc (ns <> [listId]) dId ngramsType
- let searchQuery = flip S.member (S.fromList ngs)
+ let searchQuery (NgramsTerm nt) = flip S.member (S.fromList ngs) nt
getTableNgrams NodeDocument dId tabType listId limit_ offset listType minSize maxSize orderBy searchQuery
-apiNgramsTableCorpus :: ( RepoCmdM env err m
- , HasNodeError err
- , HasInvalidError err
- , HasConnectionPool env
- , HasConfig env
+apiNgramsTableCorpus :: ( GargServerC env err m
)
=> NodeId -> ServerT TableNgramsApi m
apiNgramsTableCorpus cId = getTableNgramsCorpus cId
:<|> tableNgramsPut
- :<|> tableNgramsPost
:<|> scoresRecomputeTableNgrams cId
:<|> getTableNgramsVersion cId
+ :<|> apiNgramsAsync cId
-apiNgramsTableDoc :: ( RepoCmdM env err m
- , HasNodeError err
- , HasInvalidError err
- , HasConnectionPool env
- , HasConfig env
+apiNgramsTableDoc :: ( GargServerC env err m
)
=> DocId -> ServerT TableNgramsApi m
apiNgramsTableDoc dId = getTableNgramsDoc dId
:<|> tableNgramsPut
- :<|> tableNgramsPost
:<|> scoresRecomputeTableNgrams dId
:<|> getTableNgramsVersion dId
- -- > add new ngrams in database (TODO AD)
+ :<|> apiNgramsAsync dId
-- > index all the corpus accordingly (TODO AD)
+apiNgramsAsync :: NodeId -> GargServer TableNgramsAsyncApi
+apiNgramsAsync _dId =
+ serveJobsAPI $
+ JobFunction $ \i log ->
+ let
+ log' x = do
+ printDebug "tableNgramsPostChartsAsync" x
+ liftBase $ log x
+ in tableNgramsPostChartsAsync i log'
+
+-- Did the given list of ngrams changed since the given version?
+-- The returned value is versioned boolean value, meaning that one always retrieve the
+-- latest version.
+-- If the given version is negative then one simply receive the latest version and True.
+-- Using this function is more precise than simply comparing the latest version number
+-- with the local version number. Indeed there might be no change to this particular list
+-- and still the version number has changed because of other lists.
+--
+-- Here the added value is to make a compromise between precision, computation, and bandwidth:
+-- * currentVersion: good computation, good bandwidth, bad precision.
+-- * listNgramsChangedSince: good precision, good bandwidth, bad computation.
+-- * tableNgramsPull: good precision, good bandwidth (if you use the received data!), bad computation.
listNgramsChangedSince :: RepoCmdM env err m
=> ListId -> TableNgrams.NgramsType -> Version -> m (Versioned Bool)
listNgramsChangedSince listId ngramsType version
Versioned <$> currentVersion <*> pure True
| otherwise =
tableNgramsPull listId ngramsType version & mapped . v_data %~ (== mempty)
-
--- Instances
-instance Arbitrary NgramsRepoElement where
- arbitrary = elements $ map ngramsElementToRepo ns
- where
- NgramsTable ns = mockTable
-
---{-
-instance FromHttpApiData (Map TableNgrams.NgramsType (Versioned NgramsTableMap))
- where
- parseUrlPiece x = maybeToEither x (decode $ cs x)