server: apply naming convention to prefixing/suffixing for graphql-default

PR-URL: hasura/graphql-engine-mono#5020
GitOrigin-RevId: 145ed4d5dcc352308486fefe9bb7f75f8ed1a84a

Author: paritosh-08

CHANGELOG.md

@@ -58,6 +58,7 @@
 
 ### Bug fixes and improvements
 
+- server: fix prefix/suffix behaviour for `graphql-default` naming convention (fixes #8544)
 - server: fix namespace visibility during introspection (fix #8434)
 - server: Create missing SQL triggers, if any, while reloading metadata and startup.
 - server: fix name transformation bug in `graphql-default` naming convention (fixes #8640 partially)

server/src-lib/Data/Text/Casing.hs

@@ -31,13 +31,18 @@ module Data.Text.Casing
     transformGQLSuffixWith,
 
     -- * Helpers
-    identifierToList,
     fromTuple,
     fromName,
+    fromNonEmptyList,
+    identifierToList,
+    lowerFirstChar,
+    transformPrefixAndSuffixAndConcat,
+    upperFirstChar,
   )
 where
 
 import Data.List (intersperse)
+import Data.List.NonEmpty qualified as NE
 import Data.Text qualified as T
 import Hasura.Prelude
 import Language.GraphQL.Draft.Syntax qualified as G
@@ -59,6 +64,9 @@ fromTuple (pref, suffs) = Identifier pref suffs
 fromName :: G.Name -> GQLNameIdentifier
 fromName n = Identifier n []
 
+fromNonEmptyList :: NonEmpty G.Name -> GQLNameIdentifier
+fromNonEmptyList neList = Identifier (NE.head neList) (map G.convertNameToSuffix (NE.tail neList))
+
 -- | transforms a graphql name with a transforming function
 --
 -- Note: This will return the graphql name without transformation if the
@@ -104,12 +112,16 @@ toSnakeG (Identifier pref suff) = G.addSuffixes pref (map (transformGQLSuffixWit
 
 -- | To @PascalCase@ for @GQLNameIdentifier@
 toPascalG :: GQLNameIdentifier -> G.Name
-toPascalG (Identifier pref suff) = G.addSuffixes pref (map (transformGQLSuffixWith upperFirstChar) suff)
+toPascalG gqlIdentifier = transformPrefixAndSuffixAndConcat gqlIdentifier upperFirstChar upperFirstChar
 
 -- | To @camelCase@ for @GQLNameIdentifier@
 toCamelG :: GQLNameIdentifier -> G.Name
-toCamelG (Identifier pref []) = pref
-toCamelG (Identifier x xs) = G.addSuffixes (transformNameWith lowerFirstChar x) (map (transformGQLSuffixWith upperFirstChar) xs)
+toCamelG gqlIdentifier = transformPrefixAndSuffixAndConcat gqlIdentifier lowerFirstChar upperFirstChar
+
+-- | Transforms @GQLNameIdentifier@ and returns a @G.Name@
+transformPrefixAndSuffixAndConcat :: GQLNameIdentifier -> (T.Text -> T.Text) -> (T.Text -> T.Text) -> G.Name
+transformPrefixAndSuffixAndConcat (Identifier pref suff) prefixTransformer suffixTransformer =
+  G.addSuffixes (transformNameWith prefixTransformer pref) (map (transformGQLSuffixWith suffixTransformer) suff)
 
 -- @fromSnake@ is used in splitting the schema/table names separated by @_@
 -- For global naming conventions:

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

@@ -47,6 +47,7 @@ import Control.Lens
 import Data.Aeson qualified as J
 import Data.Aeson.Extended
 import Data.Has
+import Data.List.NonEmpty qualified as NE
 import Data.Monoid
 import Data.Text qualified as T
 import Data.Text.Casing (GQLNameIdentifier (..))
@@ -121,20 +122,20 @@ parseNamingConventionFromText "graphql-default" = Right GraphqlCase
 parseNamingConventionFromText _ = Left "naming_convention can either be \"hasura-default\" or \"graphql-default\""
 
 mkCustomizedTypename :: Maybe SourceTypeCustomization -> NamingCase -> MkTypename
-mkCustomizedTypename stc tCase = MkTypename ((applyTypeNameCaseCust tCase) . (applyTypeCust stc))
+mkCustomizedTypename stc tCase = MkTypename ((applyTypeNameCaseCust tCase) . (applyTypeCust stc tCase))
 
-mkCustomizedFieldName :: Maybe RootFieldsCustomization -> MkRootFieldName
-mkCustomizedFieldName rtc = MkRootFieldName (applyFieldCust rtc)
+mkCustomizedFieldName :: Maybe RootFieldsCustomization -> NamingCase -> MkRootFieldName
+mkCustomizedFieldName rtc tCase = MkRootFieldName (applyFieldCust rtc tCase)
 
 -- | apply prefix and suffix to type name according to the source customization
-applyTypeCust :: Maybe SourceTypeCustomization -> (G.Name -> G.Name)
-applyTypeCust Nothing = id
-applyTypeCust (Just SourceTypeCustomization {..}) = applyPrefixSuffix _stcPrefix _stcSuffix
+applyTypeCust :: Maybe SourceTypeCustomization -> NamingCase -> (G.Name -> G.Name)
+applyTypeCust Nothing _ = id
+applyTypeCust (Just SourceTypeCustomization {..}) tCase = applyPrefixSuffix _stcPrefix _stcSuffix tCase True
 
 -- | apply prefix and suffix to field name according to the source customization
-applyFieldCust :: Maybe RootFieldsCustomization -> (G.Name -> G.Name)
-applyFieldCust Nothing = id
-applyFieldCust (Just RootFieldsCustomization {..}) = applyPrefixSuffix _rootfcPrefix _rootfcSuffix
+applyFieldCust :: Maybe RootFieldsCustomization -> NamingCase -> (G.Name -> G.Name)
+applyFieldCust Nothing _ = id
+applyFieldCust (Just RootFieldsCustomization {..}) tCase = applyPrefixSuffix _rootfcPrefix _rootfcSuffix tCase False
 
 -- | apply naming convention to type name
 applyTypeNameCaseCust :: NamingCase -> G.Name -> G.Name
@@ -188,11 +189,20 @@ applyEnumValueCase tCase v = case tCase of
   GraphqlCase -> C.transformNameWith (T.toUpper) v
 
 -- | append/prepend the suffix/prefix in the graphql name
-applyPrefixSuffix :: Maybe G.Name -> Maybe G.Name -> G.Name -> G.Name
-applyPrefixSuffix Nothing Nothing name = name
-applyPrefixSuffix (Just prefix) Nothing name = prefix <> name
-applyPrefixSuffix Nothing (Just suffix) name = name <> suffix
-applyPrefixSuffix (Just prefix) (Just suffix) name = prefix <> name <> suffix
+applyPrefixSuffix :: Maybe G.Name -> Maybe G.Name -> NamingCase -> Bool -> G.Name -> G.Name
+applyPrefixSuffix Nothing Nothing tCase isTypeName name = concatPrefixSuffix tCase isTypeName $ NE.fromList [name]
+applyPrefixSuffix (Just prefix) Nothing tCase isTypeName name = concatPrefixSuffix tCase isTypeName $ NE.fromList [prefix, name]
+applyPrefixSuffix Nothing (Just suffix) tCase isTypeName name = concatPrefixSuffix tCase isTypeName $ NE.fromList [name, suffix]
+applyPrefixSuffix (Just prefix) (Just suffix) tCase isTypeName name = concatPrefixSuffix tCase isTypeName $ NE.fromList [prefix, name, suffix]
+
+concatPrefixSuffix :: NamingCase -> Bool -> NonEmpty G.Name -> G.Name
+concatPrefixSuffix (HasuraCase) _ neList = sconcat neList
+concatPrefixSuffix (GraphqlCase) isTypeName neList =
+  if isTypeName
+    then C.toPascalG prefixSuffixGQLIdent
+    else C.transformPrefixAndSuffixAndConcat prefixSuffixGQLIdent id C.upperFirstChar
+  where
+    prefixSuffixGQLIdent = C.fromNonEmptyList neList
 
 data SourceCustomization = SourceCustomization
   { _scRootFields :: !(Maybe RootFieldsCustomization),
@@ -262,7 +272,7 @@ withSourceCustomization sc@SourceCustomization {..} namingConventionSupport defa
         HasuraCase -> pure HasuraCase
 
   withTypenameCustomization (mkCustomizedTypename _scTypeNames tCase)
-    . withRootFieldNameCustomization (mkCustomizedFieldName _scRootFields)
+    . withRootFieldNameCustomization (mkCustomizedFieldName _scRootFields tCase)
     . withNamingCaseCustomization tCase
     $ m
 

server/tests-py/queries/naming_conventions/type_and_field_names_with_prefix_and_suffix.yaml

@@ -20,7 +20,7 @@
       customization:
         root_fields:
           prefix: test
-          suffix: Query
+          suffix: query
         naming_convention: graphql-default
 
 - description: create table 1
@@ -57,7 +57,7 @@
   status: 200
   response:
     data:
-      testauthorLocalQuery:
+      testAuthorLocalQuery:
       - id: 1
         name: 'Author 1'
         __typename: AuthorLocal
@@ -67,7 +67,7 @@
   query:
     query: |
       query {
-        testauthorLocalQuery {
+        testAuthorLocalQuery {
           id
           name
           __typename
@@ -89,7 +89,7 @@
   query:
     query: |
       query {
-        a: testauthorLocalQuery {
+        a: testAuthorLocalQuery {
           b: id
           c: name
           d: __typename
@@ -101,14 +101,14 @@
   status: 200
   response:
     data:
-      testauthorLocalByPkQuery:
+      testAuthorLocalByPkQuery:
         id: 1
         name: 'Author 1'
         __typename: AuthorLocal
   query:
     query: |
       query {
-        testauthorLocalByPkQuery(id: 1) {
+        testAuthorLocalByPkQuery(id: 1) {
           id
           name
           __typename
@@ -120,15 +120,15 @@
   status: 200
   response:
     data:
-      testauthorLocalAggregateQuery:
+      testAuthorLocalAggregateQuery:
         __typename: AuthorLocalAggregate
         aggregate:
           __typename: AuthorLocalAggregateFields
           count: 1
   query:
     query: |
       query MyQuery {
-        testauthorLocalAggregateQuery(where: {name: {_eq: "Author 2"}}) {
+        testAuthorLocalAggregateQuery(where: {name: {_eq: "Author 2"}}) {
           __typename
           aggregate {
             __typename
@@ -142,7 +142,7 @@
   status: 200
   response:
     data:
-      testinsertAuthorLocalQuery:
+      testInsertAuthorLocalQuery:
         __typename: AuthorLocalMutationResponse
         returning:
         - __typename: AuthorLocal
@@ -151,7 +151,7 @@
   query:
     query: |
       mutation MyMutation {
-        testinsertAuthorLocalQuery(objects: {name: "Author 3", id: 3}) {
+        testInsertAuthorLocalQuery(objects: {name: "Author 3", id: 3}) {
           __typename
           returning {
             __typename
@@ -166,20 +166,54 @@
   status: 200
   response:
     data:
-      testdeleteAuthorLocalByPkQuery:
+      testDeleteAuthorLocalByPkQuery:
         __typename: AuthorLocal
         id: 3
         name: Author 3
   query:
     query: |
       mutation MyMutation {
-        testdeleteAuthorLocalByPkQuery(id: 3) {
+        testDeleteAuthorLocalByPkQuery(id: 3) {
           __typename
           id
           name
         }
       }
 
+- description: PG update source
+  url: /v1/metadata
+  status: 200
+  response:
+    message: success
+  query:
+    type: pg_update_source
+    args:
+      name: pg1
+      customization:
+        root_fields:
+          prefix: Test
+          suffix: query
+        naming_convention: graphql-default
+
+- description: Lookup by pk
+  url: /v1/graphql
+  status: 200
+  response:
+    data:
+      TestAuthorLocalByPkQuery:
+        id: 1
+        name: 'Author 1'
+        __typename: AuthorLocal
+  query:
+    query: |
+      query {
+        TestAuthorLocalByPkQuery(id: 1) {
+          id
+          name
+          __typename
+        }
+      }
+
 - description: untrack table
   url: /v1/metadata
   status: 200