graphql-engine/server/src-lib/Hasura/StoredProcedure/Cache.hs

{-# LANGUAGE UndecidableInstances #-}

-- | The representation of stored procedures as derived from the schema cache.
module Hasura.StoredProcedure.Cache
  ( StoredProcedureInfo (..),
    StoredProcedureCache,
  )
where

import Data.Aeson (ToJSON (toJSON), genericToJSON)
import Hasura.LogicalModel.Cache (LogicalModelInfo)
import Hasura.Prelude
import Hasura.RQL.Types.Backend (Backend, FunctionName)
import Hasura.RQL.Types.BackendType (BackendType)
import Hasura.StoredProcedure.Metadata (ArgumentName)
import Hasura.StoredProcedure.Types (NullableScalarType, StoredProcedureConfig)
import Hasura.Table.Cache (RolePermInfoMap)
import Language.GraphQL.Draft.Syntax qualified as G

type StoredProcedureCache b = HashMap (FunctionName b) (StoredProcedureInfo b)

-- | The type into which 'StoredProcedureMetadata' is resolved in
-- 'Hasura/RQL/DDL/Schema/Cache.buildSchemaCacheRule'.
data StoredProcedureInfo (b :: BackendType) = StoredProcedureInfo
  { _spiStoredProcedure :: FunctionName b,
    -- | The GraphQL name of the stored procedure.
    _spiGraphqlName :: G.Name,
    _spiConfig :: StoredProcedureConfig,
    _spiReturns :: LogicalModelInfo b,
    _spiArguments :: HashMap ArgumentName (NullableScalarType b),
    _spiDescription :: Maybe Text
  }
  deriving stock (Generic)

instance
  (Backend b, ToJSON (RolePermInfoMap b)) =>
  ToJSON (StoredProcedureInfo b)
  where
  toJSON = genericToJSON hasuraJSON