server/lib/api-tests/src/Test/DataConnector/AggregateQuerySpec.hs - master - alt3rmann/graphql-engine

server/lib/api-tests/src/Test/DataConnector/AggregateQuerySpec.hs
457 строк13 KB
Gavin Ray
Update SuperConnector dependencies (#11363)
22 дек 2025, 17:47
22 дек 2025, 17:47fd31c70
{-# LANGUAGE QuasiQuotes #-}

module Test.DataConnector.AggregateQuerySpec
  ( spec,
    tests,
  )
where

--------------------------------------------------------------------------------

import Control.Lens qualified as Lens
import Data.Aeson qualified as J
import Data.Aeson.Lens (key, _Array)
import Data.List.NonEmpty qualified as NE
import Data.Vector qualified as Vector
import Harness.Backend.DataConnector.Chinook.Reference qualified as Reference
import Harness.Backend.DataConnector.Chinook.Sqlite qualified as Sqlite
import Harness.GraphqlEngine qualified as GraphqlEngine
import Harness.Quoter.Graphql (graphql)
import Harness.Quoter.Yaml (yaml)
import Harness.Test.Fixture qualified as Fixture
import Harness.TestEnvironment (GlobalTestEnvironment, TestEnvironment)
import Harness.TestEnvironment qualified as TE
import Harness.Yaml (shouldReturnYaml, shouldReturnYamlF)
import Hasura.Prelude
import Test.Hspec (SpecWith, describe, it, pendingWith)

--------------------------------------------------------------------------------

spec :: SpecWith GlobalTestEnvironment
spec =
  Fixture.runWithLocalTestEnvironment
    ( NE.fromList
        [ Reference.chinookFixture,
          Sqlite.chinookFixture
        ]
    )
    tests

--------------------------------------------------------------------------------

tests :: SpecWith (TestEnvironment, a)
tests = describe "Aggregate Query Tests" $ do
  nodeTests
  aggregateTests

nodeTests :: SpecWith (TestEnvironment, a)
nodeTests = describe "Nodes Tests" $ do
  it "works with simple query" $ \(testEnvironment, _) ->
    shouldReturnYaml
      testEnvironment
      ( GraphqlEngine.postGraphql
          testEnvironment
          [graphql|
              query getAlbum {
                Album_aggregate(limit: 2) {
                  nodes {
                    AlbumId
                    Title
                  }
                }
              }
            |]
      )
      [yaml|
          data:
            Album_aggregate:
              nodes:
                - AlbumId: 1
                  Title: For Those About To Rock We Salute You
                - AlbumId: 2
                  Title: Balls to the Wall
        |]

  it "works with multiple nodes fields" $ \(testEnvironment, _) ->
    shouldReturnYaml
      testEnvironment
      ( GraphqlEngine.postGraphql
          testEnvironment
          [graphql|
              query getAlbum {
                Album_aggregate(limit: 2) {
                  AlbumIds: nodes {
                    AlbumId
                  }
                  Titles: nodes {
                    Title
                  }
                }
              }
            |]
      )
      [yaml|
          data:
            Album_aggregate:
              AlbumIds:
                - AlbumId: 1
                - AlbumId: 2
              Titles:
                - Title: For Those About To Rock We Salute You
                - Title: Balls to the Wall
        |]

  it "works with object relations" $ \(testEnvironment, _) -> do
    -- NOTE: Ordering is required due to datasets non-matching orders
    shouldReturnYaml
      testEnvironment
      ( GraphqlEngine.postGraphql
          testEnvironment
          [graphql|
              query getAlbum {
                Album_aggregate(order_by: {AlbumId: asc}, limit: 2) {
                  nodes {
                    AlbumId
                    Artist {
                      Name
                    }
                  }
                }
              }
            |]
      )
      [yaml|
          data:
            Album_aggregate:
              nodes:
                - AlbumId: 1
                  Artist:
                    Name: AC/DC
                - AlbumId: 2
                  Artist:
                    Name: Accept
        |]

  -- NOTE: Ordering is required due to datasets non-matching orders
  it "works with array relations" $ \(testEnvironment, _) -> do
    let sortYamlArray :: J.Value -> IO J.Value
        sortYamlArray (J.Array a) = pure $ J.Array (Vector.fromList (sort (Vector.toList a)))
        sortYamlArray _ = fail "Should return Array"

    shouldReturnYamlF
      testEnvironment
      (Lens.traverseOf (key "data" . key "Artist_aggregate" . key "nodes" . _Array . traverse . key "Albums" . key "nodes") sortYamlArray)
      ( GraphqlEngine.postGraphql
          testEnvironment
          [graphql|
            query getArtist {
              Artist_aggregate(order_by: {ArtistId: asc}, limit: 2) {
                nodes {
                  ArtistId
                  Albums: Albums_aggregate {
                    nodes {
                      Title
                    }
                  }
                }
              }
            }
          |]
      )
      [yaml|
          data:
            Artist_aggregate:
              nodes:
                - ArtistId: 1
                  Albums:
                    nodes:
                      - Title: For Those About To Rock We Salute You
                      - Title: Let There Be Rock
                - ArtistId: 2
                  Albums:
                    nodes:
                      - Title: Balls to the Wall
                      - Title: Restless and Wild
        |]

aggregateTests :: SpecWith (TestEnvironment, a)
aggregateTests =
  describe "Aggregate Tests" $ do
    it "works with count queries" $ \(testEnvironment, _) ->
      shouldReturnYaml
        testEnvironment
        ( GraphqlEngine.postGraphql
            testEnvironment
            [graphql|
              query getInvoices {
                Invoice_aggregate {
                  aggregate {
                    count
                    countColumn: count(column: BillingState)
                    countColumnDistinct: count(column: BillingState, distinct: true)
                  }
                }
              }
            |]
        )
        [yaml|
          data:
            Invoice_aggregate:
              aggregate:
                count: 412
                countColumn: 210
                countColumnDistinct: 25
        |]

    it "works with single column queries" $ \(testEnvironment, _) -> do
      -- NOTE: This test is specialized for the reference agent to support more statistical functions.
      -- This should really be derived from the agent's capabilities.
      let referenceQuery =
            [graphql|
          query getInvoices {
            Invoice_aggregate {
              aggregate {
                max { Total }
                min { Total }
                stddev { Total }
                stddev_pop { Total }
                stddev_samp { Total }
                sum { Total }
                var_pop { Total }
                var_samp { Total }
                variance { Total }
              }
            }
          }
        |]

          generalQuery =
            [graphql|
          query getInvoices {
            Invoice_aggregate {
              aggregate {
                max { Total }
                min { Total }
                sum { Total }
              }
            }
          }
        |]

          referenceResults =
            [yaml|
          data:
            Invoice_aggregate:
              aggregate:
                max:
                  Total: 25.86
                min:
                  Total: 0.99
                stddev:
                  Total: 4.745319693568103
                stddev_pop:
                  Total: 4.739557311729622
                stddev_samp:
                  Total: 4.745319693568103
                sum:
                  Total: 2328.600000000004
                var_pop:
                  Total: 22.463403511169727
                var_samp:
                  Total: 22.518058994165273
                variance:
                  Total: 22.518058994165273
        |]

          generalResults =
            [yaml|
          data:
            Invoice_aggregate:
              aggregate:
                max:
                  Total: 25.86
                min:
                  Total: 0.99
                sum:
                  Total: 2328.6
        |]

      if (fmap Fixture.backendType (TE.getBackendTypeConfig testEnvironment) == Just Fixture.DataConnectorReference)
        then
          shouldReturnYaml
            testEnvironment
            ( GraphqlEngine.postGraphql
                testEnvironment
                referenceQuery
            )
            referenceResults
        else
          shouldReturnYaml
            testEnvironment
            ( GraphqlEngine.postGraphql
                testEnvironment
                generalQuery
            )
            generalResults

    it "min and max works on string fields" $ \(testEnvironment, _) ->
      shouldReturnYaml
        testEnvironment
        ( GraphqlEngine.postGraphql
            testEnvironment
            [graphql|
              query getArtists {
                Artist_aggregate {
                  aggregate {
                    max {
                      Name
                    }
                    min {
                      Name
                    }
                  }
                }
              }
            |]
        )
        [yaml|
          data:
            Artist_aggregate:
              aggregate:
                max:
                  Name: Zeca Pagodinho
                min:
                  Name: A Cor Do Som
        |]

    it "works across array relationships from regular queries" $ \(testEnvironment, _) -> do
      -- NOTE: Ordering is added to allow SQLite chinook dataset to return ordered results
      shouldReturnYaml
        testEnvironment
        ( GraphqlEngine.postGraphql
            testEnvironment
            [graphql|
              query getInvoices {
                Invoice(limit: 5, order_by: {InvoiceId: asc}) {
                  InvoiceId
                  InvoiceLines_aggregate {
                    aggregate {
                      count
                    }
                  }
                }
              }
            |]
        )
        [yaml|
          data:
            Invoice:
              - InvoiceId: 1
                InvoiceLines_aggregate:
                  aggregate:
                    count: 2
              - InvoiceId: 2
                InvoiceLines_aggregate:
                  aggregate:
                    count: 4
              - InvoiceId: 3
                InvoiceLines_aggregate:
                  aggregate:
                    count: 6
              - InvoiceId: 4
                InvoiceLines_aggregate:
                  aggregate:
                    count: 9
              - InvoiceId: 5
                InvoiceLines_aggregate:
                  aggregate:
                    count: 14
        |]

    it "works across array relationships from aggregate queries via nodes" $ \(testEnvironment, _) -> do
      -- NOTE: Ordering present so that out-of-order rows are sorted for SQLite
      shouldReturnYaml
        testEnvironment
        ( GraphqlEngine.postGraphql
            testEnvironment
            [graphql|
              query getInvoices {
                Invoice_aggregate(limit: 5, order_by: {InvoiceId: asc}) {
                  nodes {
                    InvoiceId
                    InvoiceLines_aggregate {
                      aggregate {
                        count
                      }
                    }
                  }
                }
              }
            |]
        )
        [yaml|
          data:
            Invoice_aggregate:
              nodes:
                - InvoiceId: 1
                  InvoiceLines_aggregate:
                    aggregate:
                      count: 2
                - InvoiceId: 2
                  InvoiceLines_aggregate:
                    aggregate:
                      count: 4
                - InvoiceId: 3
                  InvoiceLines_aggregate:
                    aggregate:
                      count: 6
                - InvoiceId: 4
                  InvoiceLines_aggregate:
                    aggregate:
                      count: 9
                - InvoiceId: 5
                  InvoiceLines_aggregate:
                    aggregate:
                      count: 14
        |]
    it "works for custom aggregate functions" $ \(testEnvironment, _) -> do
      when ((fmap Fixture.backendType (TE.getBackendTypeConfig testEnvironment)) /= Just Fixture.DataConnectorReference) do
        pendingWith "Agent does not support 'longest' and 'shortest' custom aggregate functions"
      shouldReturnYaml
        testEnvironment
        ( GraphqlEngine.postGraphql
            testEnvironment
            [graphql|
              query MyQuery {
                Album_aggregate {
                  aggregate {
                    longest {
                      Title
                    }
                    shortest {
                      Title
                    }
                    max {
                      Title
                    }
                    min {
                      Title
                    }
                  }
                }
              }
            |]
        )
        [yaml|
          "data":
            "Album_aggregate":
              "aggregate":
                "longest":
                  "Title": "Tchaikovsky: 1812 Festival Overture, Op.49, Capriccio Italien & Beethoven: Wellington's Victory"
                "shortest":
                  "Title": "IV"
                "max":
                  "Title": "[1997] Black Light Syndrome"
                "min":
                  "Title": "...And Justice For All"
        |]