Safe Haskell	None
Language	GHC2024

Napkin.Run.Effects.Types

Synopsis

type SpecProgram' b a = Sem (SpecProgramEffects b) a
type HookProgram' b a = Sem (TableHookProgramEffects b) a
type HookProgram b = HookProgram' b ()
data HookSyncOrAsync
- = HookSync
- | HookAsync
data Hook b = Hook {
- async :: HookSyncOrAsync
- hookProgram :: HookProgram b
}
pattern AsyncHook :: HookProgram b -> Hook b
pattern SyncHook :: HookProgram b -> Hook b
type IOGlobalHookProgram' b a = Sem (IOGlobalHookProgramEffects b) a
type IOGlobalHookProgram b = IOGlobalHookProgram' b ()
type PureGlobalHookProgram' b a = Sem (PureGlobalHookProgramEffects b) a
type PureGlobalHookProgram b = PureGlobalHookProgram' b ()
type SpecProgram b = SpecProgram' b ()
newtype HookProgramWithArgParser b = HookProgramWithArgParser (Object -> Parser (SpecProgramArguments, HookProgram b))
parserlessHook :: HookProgram b -> HookProgramWithArgParser b
newtype SpecProgramWithArgParser b = SpecProgramWithArgParser (Object -> Parser (SpecProgramArguments, SpecProgram b))
parserlessSpec :: SpecProgram b -> SpecProgramWithArgParser b
type SpecProgramEffects b = (AssertionEffects b :: [(Type -> Type) -> Type -> Type]) ++ TableEffects b
type TableHookProgramEffects b = (AssertionEffects b :: [(Type -> Type) -> Type -> Type]) ++ TableEffects b
type PureGlobalHookProgramEffects b = '[External :: (Type -> Type) -> Type -> Type, Reader TableMemos, Output TableMemo :: (Type -> Type) -> Type -> Type] ++ ((AssertionEffects b :: [(Type -> Type) -> Type -> Type]) ++ Core b)
type IOGlobalHookProgramEffects b = '[Embed IO] ++ PureGlobalHookProgramEffects b
type AssertionEffects (b :: k1) = '[Assertion :: k -> Type -> Type]
type TableEffects b = '[Reader TargetName, RecreateTable b :: (Type -> Type) -> Type -> Type, External :: (Type -> Type) -> Type -> Type, Output TableMemo :: (Type -> Type) -> Type -> Type] ++ Core b
type Core b = '[FatalError :: (Type -> Type) -> Type -> Type, Input RandomToken :: (Type -> Type) -> Type -> Type, Time :: (Type -> Type) -> Type -> Type, Output LogLine :: (Type -> Type) -> Type -> Type, SqlRender :: (Type -> Type) -> Type -> Type, SqlParse :: (Type -> Type) -> Type -> Type, SqlRead b :: (Type -> Type) -> Type -> Type, SqlWrite b :: (Type -> Type) -> Type -> Type, Input TemporaryTableName :: (Type -> Type) -> Type -> Type, BackendSpecificEffect b, AnnotateRead b :: (Type -> Type) -> Type -> Type, AnnotateWrite b :: (Type -> Type) -> Type -> Type, LocalFile :: (Type -> Type) -> Type -> Type, Template :: (Type -> Type) -> Type -> Type, LoadQuery :: (Type -> Type) -> Type -> Type, Reader QueryTransformer, Output ExtraDependencies :: (Type -> Type) -> Type -> Type, Reader HiddenDependencies, Reader HiddenArtifacts, Input MetaArguments :: (Type -> Type) -> Type -> Type, Reader SQLDialect, Reader ConnectionString, Fail :: (Type -> Type) -> Type -> Type]
class RunBackendEffect b where
- runBackendEffectReal :: forall (m :: Type -> Type) (r :: EffectRow) a. (Members '[FatalError :: (Type -> Type) -> Type -> Type, Embed m] r, MonadNapkin b m, SqlIO m, LocalQueryStats b m) => BackendConn b -> Sem (BackendSpecificEffect b ': r) a -> Sem r a
- runBackendEffectFake :: forall (r :: EffectRow) a. Members '[Reader HiddenDependencies, State IState :: (Type -> Type) -> Type -> Type, FatalError :: (Type -> Type) -> Type -> Type] r => Sem (BackendSpecificEffect b ': r) a -> Sem r a
- interceptBackendEffectDiscoverDependencies :: forall (r :: EffectRow) a. Members '[Input (Transformed HiddenDependencies) :: (Type -> Type) -> Type -> Type, Output Dependencies :: (Type -> Type) -> Type -> Type, BackendSpecificEffect b] r => Sem r a -> Sem r a
- interceptBackendEffectApplyQueryTransformer :: forall (r :: EffectRow) a. Members '[Output ExtraDependencies :: (Type -> Type) -> Type -> Type, Reader QueryTransformer, BackendSpecificEffect b] r => Sem r a -> Sem r a
- backendDependencyValidator :: Proxy b -> [(SpecDependency -> Ref Table) -> SpecsDepsTables -> [WithSpecTable Text]]
askRefRenamer :: forall (r :: EffectRow). Member (Reader QueryTransformer) r => Sem r (Ref Table -> Ref Table)
askQueryRewriter :: forall (r :: EffectRow). Member (Reader QueryTransformer) r => Sem r (Query -> Query)
askQueryRewriterData :: forall a (r :: EffectRow). (Data a, Member (Reader QueryTransformer) r) => Sem r (a -> a)
data ProgramDependenciesAndQueries (b :: k)
- = SinglePath (DryRunResult b)
- | MultiplePaths {
  - createPath :: DryRunResult b
  - updatePath :: DryRunResult b
  }
summarizeWithHooks :: forall {k} (b :: k). ProgramAndHooksDependenciesAndQueries b -> DryRunResult b
summarize :: forall {k} (b :: k). ProgramDependenciesAndQueries b -> DryRunResult b
data DryRunResult (b :: k) = DryRunResult {
- dependencies :: Dependencies
- artifacts :: Artifacts
- queries :: [DumpItem b]
- loadedSqlQueries :: [(FilePath, Query)]
- assertions :: AssertionLog
}
type ProgramAndHooksDependenciesAndQueries (bk :: k) = (ProgramDependenciesAndQueries bk, [DryRunResult bk], [DryRunResult bk])
data SpecDepsAndQueries (bk :: k) = SpecDepsAndQueries {
- tablesDepsAndQueries :: [(SpecTableName, ProgramAndHooksDependenciesAndQueries bk)]
- hooksDepsAndQueries :: [(Text, DryRunResult bk)]
}

Documentation

type SpecProgram' b a = Sem (SpecProgramEffects b) a #

type HookProgram' b a = Sem (TableHookProgramEffects b) a #

Programs packaged up for use in Specs. Intended for use in providing introspectable CustomCreate actions in specs.

type HookProgram b = HookProgram' b () #

Hooks have different capabilities than specs

data HookSyncOrAsync #

Constructors

HookSync
HookAsync

Instances

Instances details

Generic HookSyncOrAsync #

Instance details

Defined in Napkin.Run.Effects.Types

Associated Types

type Rep HookSyncOrAsync
Instance details Defined in Napkin.Run.Effects.Types type Rep HookSyncOrAsync = D1 ('MetaData "HookSyncOrAsync" "Napkin.Run.Effects.Types" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'False) (C1 ('MetaCons "HookSync" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HookAsync" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: HookSyncOrAsync -> Rep HookSyncOrAsync x #

to :: Rep HookSyncOrAsync x -> HookSyncOrAsync #

Show HookSyncOrAsync #

Instance details

Defined in Napkin.Run.Effects.Types

Methods

showsPrec :: Int -> HookSyncOrAsync -> ShowS #

show :: HookSyncOrAsync -> String #

showList :: [HookSyncOrAsync] -> ShowS #

type Rep HookSyncOrAsync #

Instance details

Defined in Napkin.Run.Effects.Types

type Rep HookSyncOrAsync = D1 ('MetaData "HookSyncOrAsync" "Napkin.Run.Effects.Types" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'False) (C1 ('MetaCons "HookSync" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HookAsync" 'PrefixI 'False) (U1 :: Type -> Type))

data Hook b #

Constructors

Hook
Fields async :: HookSyncOrAsync hookProgram :: HookProgram b

Instances

Instances details

Generic (Hook b) #

Instance details

Defined in Napkin.Run.Effects.Types

Associated Types

type Rep (Hook b)

Instance details

Defined in Napkin.Run.Effects.Types

type Rep (Hook b) = D1 ('MetaData "Hook" "Napkin.Run.Effects.Types" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'False) (C1 ('MetaCons "Hook" 'PrefixI 'True) (S1 ('MetaSel ('Just "async") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HookSyncOrAsync) :*: S1 ('MetaSel ('Just "hookProgram") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HookProgram b))))

Methods

from :: Hook b -> Rep (Hook b) x #

to :: Rep (Hook b) x -> Hook b #

type Rep (Hook b) #

Instance details

Defined in Napkin.Run.Effects.Types

type Rep (Hook b) = D1 ('MetaData "Hook" "Napkin.Run.Effects.Types" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'False) (C1 ('MetaCons "Hook" 'PrefixI 'True) (S1 ('MetaSel ('Just "async") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HookSyncOrAsync) :*: S1 ('MetaSel ('Just "hookProgram") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HookProgram b))))

pattern AsyncHook :: HookProgram b -> Hook b #

pattern SyncHook :: HookProgram b -> Hook b #

type IOGlobalHookProgram' b a = Sem (IOGlobalHookProgramEffects b) a #

type IOGlobalHookProgram b = IOGlobalHookProgram' b () #

type PureGlobalHookProgram' b a = Sem (PureGlobalHookProgramEffects b) a #

type PureGlobalHookProgram b = PureGlobalHookProgram' b () #

type SpecProgram b = SpecProgram' b () #

newtype HookProgramWithArgParser b #

Constructors

HookProgramWithArgParser (Object -> Parser (SpecProgramArguments, HookProgram b))

parserlessHook :: HookProgram b -> HookProgramWithArgParser b #

newtype SpecProgramWithArgParser b #

Constructors

SpecProgramWithArgParser (Object -> Parser (SpecProgramArguments, SpecProgram b))

parserlessSpec :: SpecProgram b -> SpecProgramWithArgParser b #

type SpecProgramEffects b = (AssertionEffects b :: [(Type -> Type) -> Type -> Type]) ++ TableEffects b #

type TableHookProgramEffects b = (AssertionEffects b :: [(Type -> Type) -> Type -> Type]) ++ TableEffects b #

type PureGlobalHookProgramEffects b = '[External :: (Type -> Type) -> Type -> Type, Reader TableMemos, Output TableMemo :: (Type -> Type) -> Type -> Type] ++ ((AssertionEffects b :: [(Type -> Type) -> Type -> Type]) ++ Core b) #

type IOGlobalHookProgramEffects b = '[Embed IO] ++ PureGlobalHookProgramEffects b #

type AssertionEffects (b :: k1) = '[Assertion :: k -> Type -> Type] #

type TableEffects b = '[Reader TargetName, RecreateTable b :: (Type -> Type) -> Type -> Type, External :: (Type -> Type) -> Type -> Type, Output TableMemo :: (Type -> Type) -> Type -> Type] ++ Core b #

class RunBackendEffect b where #

Minimal complete definition

runBackendEffectReal, runBackendEffectFake, interceptBackendEffectDiscoverDependencies, interceptBackendEffectApplyQueryTransformer

Methods

runBackendEffectReal :: forall (m :: Type -> Type) (r :: EffectRow) a. (Members '[FatalError :: (Type -> Type) -> Type -> Type, Embed m] r, MonadNapkin b m, SqlIO m, LocalQueryStats b m) => BackendConn b -> Sem (BackendSpecificEffect b ': r) a -> Sem r a #

runBackendEffectFake :: forall (r :: EffectRow) a. Members '[Reader HiddenDependencies, State IState :: (Type -> Type) -> Type -> Type, FatalError :: (Type -> Type) -> Type -> Type] r => Sem (BackendSpecificEffect b ': r) a -> Sem r a #

interceptBackendEffectDiscoverDependencies :: forall (r :: EffectRow) a. Members '[Input (Transformed HiddenDependencies) :: (Type -> Type) -> Type -> Type, Output Dependencies :: (Type -> Type) -> Type -> Type, BackendSpecificEffect b] r => Sem r a -> Sem r a #

interceptBackendEffectApplyQueryTransformer :: forall (r :: EffectRow) a. Members '[Output ExtraDependencies :: (Type -> Type) -> Type -> Type, Reader QueryTransformer, BackendSpecificEffect b] r => Sem r a -> Sem r a #

backendDependencyValidator :: Proxy b -> [(SpecDependency -> Ref Table) -> SpecsDepsTables -> [WithSpecTable Text]] #

default backendDependencyValidator :: Proxy b -> [(SpecDependency -> Ref Table) -> SpecsDepsTables -> [WithSpecTable Text]] #

askRefRenamer :: forall (r :: EffectRow). Member (Reader QueryTransformer) r => Sem r (Ref Table -> Ref Table) #

askQueryRewriter :: forall (r :: EffectRow). Member (Reader QueryTransformer) r => Sem r (Query -> Query) #

askQueryRewriterData :: forall a (r :: EffectRow). (Data a, Member (Reader QueryTransformer) r) => Sem r (a -> a) #

data ProgramDependenciesAndQueries (b :: k) #

Constructors

SinglePath (DryRunResult b)
MultiplePaths
Fields createPath :: DryRunResult b updatePath :: DryRunResult b

summarizeWithHooks :: forall {k} (b :: k). ProgramAndHooksDependenciesAndQueries b -> DryRunResult b #

summarize :: forall {k} (b :: k). ProgramDependenciesAndQueries b -> DryRunResult b #

data DryRunResult (b :: k) #

Constructors

DryRunResult
Fields dependencies :: Dependencies artifacts :: Artifacts queries :: [DumpItem b] loadedSqlQueries :: [(FilePath, Query)] assertions :: AssertionLog

Instances

Instances details

Monoid (DryRunResult b) #

Instance details

Defined in Napkin.Run.Effects.Types

Methods

mempty :: DryRunResult b #

mappend :: DryRunResult b -> DryRunResult b -> DryRunResult b #

mconcat :: [DryRunResult b] -> DryRunResult b #

Semigroup (DryRunResult b) #

Instance details

Defined in Napkin.Run.Effects.Types

Methods

(<>) :: DryRunResult b -> DryRunResult b -> DryRunResult b #

sconcat :: NonEmpty (DryRunResult b) -> DryRunResult b #

stimes :: Integral b0 => b0 -> DryRunResult b -> DryRunResult b #

Generic (DryRunResult b) #

Instance details

Defined in Napkin.Run.Effects.Types

Associated Types

type Rep (DryRunResult b)

Instance details

Defined in Napkin.Run.Effects.Types

type Rep (DryRunResult b) = D1 ('MetaData "DryRunResult" "Napkin.Run.Effects.Types" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'False) (C1 ('MetaCons "DryRunResult" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dependencies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Dependencies) :*: S1 ('MetaSel ('Just "artifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Artifacts)) :*: (S1 ('MetaSel ('Just "queries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [DumpItem b]) :*: (S1 ('MetaSel ('Just "loadedSqlQueries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(FilePath, Query)]) :*: S1 ('MetaSel ('Just "assertions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AssertionLog)))))

Methods

from :: DryRunResult b -> Rep (DryRunResult b) x #

to :: Rep (DryRunResult b) x -> DryRunResult b #

Show (DryRunResult b) #

Instance details

Defined in Napkin.Run.Effects.Types

Methods

showsPrec :: Int -> DryRunResult b -> ShowS #

show :: DryRunResult b -> String #

showList :: [DryRunResult b] -> ShowS #

Eq (DryRunResult b) #

Instance details

Defined in Napkin.Run.Effects.Types

Methods

(==) :: DryRunResult b -> DryRunResult b -> Bool #

(/=) :: DryRunResult b -> DryRunResult b -> Bool #

type Rep (DryRunResult b) #

Instance details

Defined in Napkin.Run.Effects.Types

type Rep (DryRunResult b) = D1 ('MetaData "DryRunResult" "Napkin.Run.Effects.Types" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'False) (C1 ('MetaCons "DryRunResult" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dependencies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Dependencies) :*: S1 ('MetaSel ('Just "artifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Artifacts)) :*: (S1 ('MetaSel ('Just "queries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [DumpItem b]) :*: (S1 ('MetaSel ('Just "loadedSqlQueries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(FilePath, Query)]) :*: S1 ('MetaSel ('Just "assertions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AssertionLog)))))

type ProgramAndHooksDependenciesAndQueries (bk :: k) = (ProgramDependenciesAndQueries bk, [DryRunResult bk], [DryRunResult bk]) #

data SpecDepsAndQueries (bk :: k) #

Constructors

SpecDepsAndQueries
Fields tablesDepsAndQueries :: [(SpecTableName, ProgramAndHooksDependenciesAndQueries bk)] hooksDepsAndQueries :: [(Text, DryRunResult bk)]

Instances

Instances details

Generic (SpecDepsAndQueries bk) #

Instance details

Defined in Napkin.Run.Effects.Types

Associated Types

type Rep (SpecDepsAndQueries bk)

Instance details

Defined in Napkin.Run.Effects.Types

type Rep (SpecDepsAndQueries bk) = D1 ('MetaData "SpecDepsAndQueries" "Napkin.Run.Effects.Types" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'False) (C1 ('MetaCons "SpecDepsAndQueries" 'PrefixI 'True) (S1 ('MetaSel ('Just "tablesDepsAndQueries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(SpecTableName, ProgramAndHooksDependenciesAndQueries bk)]) :*: S1 ('MetaSel ('Just "hooksDepsAndQueries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, DryRunResult bk)])))

Methods

from :: SpecDepsAndQueries bk -> Rep (SpecDepsAndQueries bk) x #

to :: Rep (SpecDepsAndQueries bk) x -> SpecDepsAndQueries bk #

type Rep (SpecDepsAndQueries bk) #

Instance details

Defined in Napkin.Run.Effects.Types

type Rep (SpecDepsAndQueries bk) = D1 ('MetaData "SpecDepsAndQueries" "Napkin.Run.Effects.Types" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'False) (C1 ('MetaCons "SpecDepsAndQueries" 'PrefixI 'True) (S1 ('MetaSel ('Just "tablesDepsAndQueries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(SpecTableName, ProgramAndHooksDependenciesAndQueries bk)]) :*: S1 ('MetaSel ('Just "hooksDepsAndQueries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, DryRunResult bk)])))