Scheduled triggers (close hasura#1914) (hasura#3553)

server: add scheduled triggers

Co-authored-by: Alexis King <[email protected]>
Co-authored-by: Marion Schleifer <[email protected]>
Co-authored-by: Karthikeyan Chinnakonda <[email protected]>
Co-authored-by: Aleksandra Sikora <[email protected]>

Author: 5 people

CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## Next release
 
+### Scheduled Triggers
+
+A scheduled trigger can be used to execute custom business logic based on time. There are two types of timing events: cron based or timestamp based.
+
+A cron trigger will be useful when something needs to be done periodically. For example, you can create a cron trigger to  generate an end-of-day sales report every weekday at 9pm.
+
+You can also schedule one-off events based on a timestamp. For example, a new scheduled event can be created for 2 weeks from when a user signs up to send them an email about their experience. 
+
+<Add docs links>
+
+(close #1914)
+
+
 ### Allow access to session variables by computed fields (fix #3846)
 
 Sometimes it is useful for computed fields to have access to the Hasura session variables directly. For example, suppose you want to fetch some articles but also get related user info, say `likedByMe`. Now, you can define a function like:

scripts/dev.sh

@@ -215,7 +215,7 @@ if [ "$MODE" = "graphql-engine" ]; then
   echo_pretty "    $ $0 postgres"
   echo_pretty ""
 
-  RUN_INVOCATION=(cabal new-run --project-file=cabal.project.dev-sh --RTS -- 
+  RUN_INVOCATION=(cabal new-run --project-file=cabal.project.dev-sh --RTS --
     exe:graphql-engine +RTS -N -T -s -RTS serve
     --enable-console --console-assets-dir "$PROJECT_ROOT/console/static/dist"
     )

server/cabal.project.freeze

@@ -137,8 +137,11 @@ constraints: any.Cabal ==3.2.0.0,
              any.ghc-heap-view ==0.6.2,
              ghc-heap-view -prim-supports-any,
              any.ghc-prim ==0.6.1,
+             any.happy ==1.19.12,
+             happy +small_base,
              any.hashable ==1.3.0.0,
              hashable -examples +integer-gmp +sse2 -sse41,
+             hashable -examples +integer-gmp +sse2 -sse41,
              any.hashtables ==1.2.3.4,
              hashtables -bounds-checking -debug -detailed-profiling -portable -sse42 +unsafe-tricks,
              any.hasql ==1.4.2,

server/commit_diff.txt

@@ -333,16 +333,3 @@ Author: Brandon Simmons <[email protected]>
 Date:   Wed May 13 17:38:16 2020 -0400
 
     dev.sh: bump version due to addition of croniter python dependency
-
-commit cc8e2ccc78bf154c5da90fea0967bd5ac2ca8b4b
-Author: Tirumarai Selvan <[email protected]>
-Date:   Wed May 13 18:03:16 2020 +0530
-
-    Scheduled triggers (close #1914) (#3553)
-
-    server: add scheduled triggers
-
-    Co-authored-by: Alexis King <[email protected]>
-    Co-authored-by: Marion Schleifer <[email protected]>
-    Co-authored-by: Karthikeyan Chinnakonda <[email protected]>
-    Co-authored-by: Aleksandra Sikora <[email protected]>

server/graphql-engine.cabal

@@ -71,6 +71,12 @@ common common-all
     TypeFamilyDependencies
     TypeOperators
 
+    -- ApplicativeDo BangPatterns BlockArguments ConstraintKinds DataKinds DefaultSignatures DeriveDataTypeable
+    -- DeriveFoldable DeriveFunctor DeriveGeneric DeriveLift DeriveTraversable DerivingVia EmptyCase
+    -- FlexibleContexts FlexibleInstances FunctionalDependencies GeneralizedNewtypeDeriving
+    -- InstanceSigs LambdaCase MultiParamTypeClasses MultiWayIf NamedFieldPuns NoImplicitPrelude
+    -- OverloadedStrings QuantifiedConstraints QuasiQuotes RankNTypes RecordWildCards ScopedTypeVariables
+    -- StandaloneDeriving TemplateHaskell TupleSections TypeApplications TypeFamilies TypeOperators
 
 common common-exe
   ghc-options:
@@ -115,7 +121,7 @@ library
                      , http-types
                      , attoparsec
                      , attoparsec-iso8601 >= 1.0
-                     , time
+                     , time >= 1.9
                      , scientific
                      , Spock-core
                      , split
@@ -246,6 +252,9 @@ library
                      -- scheduled triggers
                      , cron >= 0.6.2
 
+                     -- scheduled triggers
+                     , cron >= 0.6.2
+
   exposed-modules:     Control.Arrow.Extended
                      , Control.Arrow.Trans
                      , Control.Monad.Stateless

server/src-lib/Hasura/Eventing/EventTrigger.hs

@@ -56,6 +56,7 @@ import           Data.Time.Clock
 import           Data.Word
 import           Hasura.Eventing.HTTP
 import           Hasura.Eventing.Common
+
 import           Hasura.HTTP
 import           Hasura.Prelude
 import           Hasura.RQL.DDL.Headers
@@ -72,6 +73,7 @@ import qualified Hasura.Logging                as L
 import qualified Network.HTTP.Client           as HTTP
 import qualified Database.PG.Query.PTI         as PTI
 import qualified PostgreSQL.Binary.Encoding    as PE
+import qualified Data.Set                      as Set
 
 data TriggerMetadata
   = TriggerMetadata { tmName :: TriggerName }

server/src-lib/Hasura/Eventing/HTTP.hs

@@ -46,11 +46,15 @@ import qualified Data.TByteString              as TBS
 import qualified Data.Text                     as T
 import qualified Data.Text.Encoding            as TE
 import qualified Data.Text.Encoding.Error      as TE
+
 import qualified Network.HTTP.Client           as HTTP
 import qualified Network.HTTP.Types            as HTTP
 import qualified Data.Time.Clock               as Time
 
 import           Control.Exception             (try)
+-- import           Control.Monad.IO.Class        (MonadIO, liftIO)
+-- import           Control.Monad.Reader          (MonadReader)
+
 import           Data.Aeson
 import           Data.Aeson.Casing
 import           Data.Aeson.TH

server/src-lib/Hasura/Eventing/ScheduledTrigger.hs

@@ -90,6 +90,7 @@ import           Hasura.RQL.DDL.EventTrigger       (getHeaderInfosFromConf)
 import           Hasura.SQL.DML
 import           Hasura.SQL.Types
 import           Hasura.Eventing.Common
+
 import           System.Cron
 
 import qualified Data.Aeson                        as J

server/src-lib/Hasura/Incremental/Internal/Dependency.hs

@@ -18,6 +18,7 @@ import           Data.GADT.Compare
 import           Data.Int
 import           Data.Scientific               (Scientific)
 import           Data.Set                      (Set)
+
 import           Data.Time.Clock
 import           Data.Vector                   (Vector)
 import           GHC.Generics                  ((:*:) (..), (:+:) (..), Generic (..), K1 (..),

server/src-lib/Hasura/RQL/DDL/Action.hs

@@ -27,6 +27,7 @@ import           Hasura.EncJSON
 import           Hasura.GraphQL.Utils
 import           Hasura.Prelude
 import           Hasura.RQL.Types
+import           Data.URL.Template
 import           Hasura.Session
 import           Hasura.SQL.Types
 
@@ -35,10 +36,10 @@ import qualified Data.Aeson.Casing             as J
 import qualified Data.Aeson.TH                 as J
 import qualified Data.HashMap.Strict           as Map
 import qualified Data.Text                     as T
+
 import qualified Database.PG.Query             as Q
 import qualified Language.GraphQL.Draft.Syntax as G
 
-import           Data.URL.Template             (renderURLTemplate)
 import           Language.Haskell.TH.Syntax    (Lift)
 
 getActionInfo

server/src-lib/Hasura/RQL/DDL/Metadata.hs

@@ -206,6 +206,11 @@ saveMetadata (ReplaceMetadata _ tables functionsMeta
   withPathK "custom_types" $
     CustomTypes.persistCustomTypes customTypes
 
+  -- cron triggers
+  withPathK "cron_triggers" $
+    indexedForM_ cronTriggers $ \ct -> liftTx $ do
+    addCronTriggerToCatalog ct
+
   -- actions
   withPathK "actions" $
     indexedForM_ actions $ \action -> do
@@ -217,6 +222,7 @@ saveMetadata (ReplaceMetadata _ tables functionsMeta
           let createActionPermission = CreateActionPermission (_amName action)
                                        (_apmRole permission) Nothing (_apmComment permission)
           Action.persistCreateActionPermission createActionPermission
+
   where
     processPerms tableName perms = indexedForM_ perms $ Permission.addPermP2 tableName
 

server/src-lib/Hasura/RQL/DDL/Metadata/Generator.hs

@@ -35,7 +35,6 @@ import           Hasura.RQL.DDL.Metadata.Types
 import           Hasura.RQL.Types
 import           Hasura.SQL.Types
 
-
 genReplaceMetadata :: Gen ReplaceMetadata
 genReplaceMetadata = do
   version <- arbitrary

server/src-lib/Hasura/RQL/DDL/Schema/Cache.hs

@@ -32,7 +32,6 @@ import           Data.Aeson
 import           Data.List                                (nub)
 
 import qualified Hasura.Incremental                       as Inc
-import qualified Language.GraphQL.Draft.Syntax            as G
 
 import           Hasura.Db
 import           Hasura.GraphQL.Execute.Types
@@ -263,8 +262,6 @@ buildSchemaCacheRule = proc (catalogMetadata, invalidationKeys) -> do
                                    , "custom types are inconsistent" )
           returnA -< (M.empty, emptyAnnotatedCustomTypes)
 
-      -- remote schemas
-
       cronTriggersMap <- buildCronTriggers -< ((),cronTriggers)
 
       returnA -< BuildOutputs

server/src-lib/Hasura/RQL/DDL/Schema/Cache/Common.hs

@@ -52,10 +52,10 @@ data BuildInputs
 -- 'MonadWriter' side channel.
 data BuildOutputs
   = BuildOutputs
-  { _boTables        :: !TableCache
-  , _boActions       :: !ActionCache
-  , _boFunctions     :: !FunctionCache
-  , _boRemoteSchemas :: !(HashMap RemoteSchemaName (RemoteSchemaCtx, MetadataObject))
+  { _boTables            :: !TableCache
+  , _boActions           :: !ActionCache
+  , _boFunctions         :: !FunctionCache
+  , _boRemoteSchemas     :: !(HashMap RemoteSchemaName (RemoteSchemaCtx, MetadataObject))
   -- ^ We preserve the 'MetadataObject' from the original catalog metadata in the output so we can
   -- reuse it later if we need to mark the remote schema inconsistent during GraphQL schema
   -- generation (because of field conflicts).

server/src-lib/Hasura/RQL/Types/Common.hs

@@ -49,6 +49,8 @@ import           Hasura.Prelude
 import           Hasura.RQL.DDL.Headers        ()
 import           Hasura.RQL.Types.Error
 import           Hasura.SQL.Types
+import           Hasura.RQL.DDL.Headers        ()
+
 
 
 import           Control.Lens                  (makeLenses)

server/src-lib/Hasura/RQL/Types/SchemaCache.hs

@@ -131,12 +131,15 @@ import           Hasura.RQL.Types.Metadata
 --import           Hasura.RQL.Types.Permission
 import           Hasura.RQL.Types.QueryCollection
 import           Hasura.RQL.Types.RemoteSchema
+--import           Hasura.RQL.Types.EventTrigger
+
 import           Hasura.RQL.Types.ScheduledTrigger
 import           Hasura.RQL.Types.SchemaCacheTypes
 import           Hasura.RQL.Types.Table
 import           Hasura.Session
 import           Hasura.SQL.Types
 
+
 import           Data.Aeson
 import           Data.Aeson.Casing
 import           Data.Aeson.TH

server/src-lib/Hasura/Server/API/Query.hs

@@ -283,7 +283,7 @@ queryModifiesSchemaCache (RQV1 qi) = case qi of
   RQAddCollectionToAllowlist _        -> True
   RQDropCollectionFromAllowlist _     -> True
 
-  RQRunSql q                      -> isSchemaCacheBuildRequiredRunSQL q
+  RQRunSql q                          -> isSchemaCacheBuildRequiredRunSQL q
 
   RQReplaceMetadata _                 -> True
   RQExportMetadata _                  -> False

server/src-lib/Hasura/Server/Auth/JWT.hs

@@ -47,7 +47,6 @@ import qualified Data.Aeson                      as J
 import qualified Data.Aeson.Casing               as J
 import qualified Data.Aeson.Internal             as J
 import qualified Data.Aeson.TH                   as J
-import qualified Data.Aeson.Internal             as J
 import qualified Data.ByteString.Lazy            as BL
 import qualified Data.ByteString.Lazy.Char8      as BLC
 import qualified Data.CaseInsensitive            as CI

server/tests-py/conftest.py

@@ -292,6 +292,7 @@ def gql_server(request, hge_ctx):
     yield server
     server.teardown()
 
+
 @pytest.fixture(scope='class')
 def ws_client(request, hge_ctx):
     """