mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-15 17:31:56 +03:00
584aa666bd
Earlier, if the `select` root field had a custom root field set, the same custom root field was then used for the streaming subscription root field as well. This leads to duplicate root fields being generated in the `subscription_root`. This PR fixes that. It provides a way to customize the streaming subscription root field and not use the `select` root field's custom root field name for the streaming subscription root field. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4967 Co-authored-by: Anon Ray <616387+ecthiender@users.noreply.github.com> GitOrigin-RevId: 54e74ce97561b0e5cfdfc60d1ca340aaebecf7d4
127 lines
3.5 KiB
Haskell
127 lines
3.5 KiB
Haskell
{-# LANGUAGE QuasiQuotes #-}
|
|
|
|
-- | Testing custom root fields.
|
|
-- See the main hasura documentation for more information.
|
|
--
|
|
-- - Postgres: https://hasura.io/docs/latest/graphql/core/databases/postgres/schema/custom-field-names/#expose-table-root-fields-with-a-different-name-in-the-graphql-api
|
|
module Test.CustomRootFieldsSpec (spec) where
|
|
|
|
import Harness.Backend.Postgres qualified as Postgres
|
|
import Harness.GraphqlEngine qualified as GraphqlEngine
|
|
import Harness.Quoter.Graphql (graphql)
|
|
import Harness.Quoter.Yaml (shouldReturnYaml, yaml)
|
|
import Harness.Test.Context qualified as Context
|
|
import Harness.Test.Schema (Table (..), table)
|
|
import Harness.Test.Schema qualified as Schema
|
|
import Harness.TestEnvironment (TestEnvironment)
|
|
import Test.Hspec (SpecWith, it)
|
|
import Prelude
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
-- * Preamble
|
|
|
|
spec :: SpecWith TestEnvironment
|
|
spec =
|
|
Context.run
|
|
[ Context.Context
|
|
{ name = Context.Backend Context.Postgres,
|
|
mkLocalTestEnvironment = Context.noLocalTestEnvironment,
|
|
setup = postgresSetup,
|
|
teardown = Postgres.teardown schema,
|
|
customOptions = Nothing
|
|
}
|
|
]
|
|
streamingSubscriptionCustomRootFieldTests
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
-- * Tests
|
|
|
|
streamingSubscriptionCustomRootFieldTests :: Context.Options -> SpecWith TestEnvironment
|
|
streamingSubscriptionCustomRootFieldTests opts = do
|
|
-- TODO: At the time of writing this, there's no easy way to make a subscription
|
|
-- request in the tests-hspec. When we do support that, we can add a new test that tests
|
|
-- the streaming subscription with the customized root field name.
|
|
it "The introspection includes the customized streaming subscription root fields" $ \testEnvironment ->
|
|
shouldReturnYaml
|
|
opts
|
|
( GraphqlEngine.postGraphqlWithHeaders
|
|
testEnvironment
|
|
[("X-Hasura-Role", "user")]
|
|
[graphql|
|
|
query {
|
|
__type(name: "subscription_root") {
|
|
fields {
|
|
name
|
|
}
|
|
|
|
}
|
|
}
|
|
|]
|
|
)
|
|
[yaml|
|
|
data:
|
|
__type:
|
|
fields:
|
|
- name: LogsStream
|
|
|]
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
-- * Backend
|
|
|
|
-- ** Schema
|
|
|
|
schema :: [Schema.Table]
|
|
schema =
|
|
[ (table "logs")
|
|
{ tableColumns =
|
|
[ Schema.column "Id" Schema.TInt,
|
|
Schema.column "Log" Schema.TStr,
|
|
Schema.column "Level" Schema.TStr
|
|
],
|
|
tablePrimaryKey = ["Id"],
|
|
tableData = []
|
|
}
|
|
]
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
-- ** Postgres backend
|
|
|
|
postgresSetup :: (TestEnvironment, ()) -> IO ()
|
|
postgresSetup (testEnvironment, localTestEnvironment) = do
|
|
Postgres.setup schema (testEnvironment, localTestEnvironment)
|
|
postgresCreateCustomNames testEnvironment
|
|
|
|
postgresCreateCustomNames :: TestEnvironment -> IO ()
|
|
postgresCreateCustomNames testEnvironment = do
|
|
let source = Context.defaultBackendTypeString Context.Postgres
|
|
in GraphqlEngine.postMetadata_
|
|
testEnvironment
|
|
[yaml|
|
|
type: bulk
|
|
args:
|
|
- type: pg_set_table_customization
|
|
args:
|
|
source: *source
|
|
table:
|
|
schema: hasura
|
|
name: logs
|
|
configuration:
|
|
custom_root_fields:
|
|
"select_stream": "LogsStream"
|
|
- type: pg_create_select_permission
|
|
args:
|
|
source: *source
|
|
table:
|
|
schema: hasura
|
|
name: logs
|
|
role: user
|
|
permission:
|
|
columns: "*"
|
|
filter: {}
|
|
subscription_root_fields: ["select_stream"]
|
|
|]
|