How can I implement GraphQL types by ignoring interfaces out of my hands?

[wickedev]

Below is the class I want to create.

@GraphQLIgnore
interface SimpleUserDetails : org.springframework.security.core.userdetails.UserDetails {
    @GraphQLIgnore
    override fun isAccountNonExpired(): Boolean = true

    @GraphQLIgnore
    override fun isAccountNonLocked(): Boolean = true

    @GraphQLIgnore
    override fun isCredentialsNonExpired(): Boolean = true

    @GraphQLIgnore
    override fun isEnabled(): Boolean = true
}

@Table("users")
data class User(
    @Id override val id: ID = ID.Empty,

    val email: String,
    val name: String?,
    val hashSalt: String,
    val roles: List<String>,
) : Node, SimpleUserDetails {

    fun posts(
        @GraphQLIgnore @Autowired postRepository: PostRepository,
        env: DataFetchingEnvironment
    ): CompletableFuture<List<Post>> {
        return postRepository.findAllByAuthorId(id, env)
    }

    @GraphQLIgnore
    override fun getUsername(): String = email

    @GraphQLIgnore
    override fun getPassword(): String = hashSalt

    @GraphQLIgnore
    override fun getAuthorities(): Collection<GrantedAuthority> = roles.map { SimpleGrantedAuthority(it) }
}

Caused by: graphql.schema.validation.InvalidSchemaException: invalid schema:
object type 'User' does not implement interface 'UserDetails' because field 'isEnabled' is missing
object type 'User' does not implement interface 'UserDetails' because field 'getAuthorities' is missing
object type 'User' does not implement interface 'UserDetails' because field 'getPassword' is missing
object type 'User' does not implement interface 'UserDetails' because field 'getUsername' is missing
object type 'User' does not implement interface 'UserDetails' because field 'isAccountNonExpired' is missing
object type 'User' does not implement interface 'UserDetails' because field 'isAccountNonLocked' is missing
object type 'User' does not implement interface 'UserDetails' because field 'isCredentialsNonExpired' is missing

[dariuszkuc]

Hello 👋
As per the error - your class User implements SimpleUserDetails ignored interface which in turn extends the UserDetails interface which is not ignored. You would need to also add GraphQLIgnore annotations to UserDetails interface (or use custom schema generator hook to customize the schema generation behavior).

[wickedev]

I tried as you suggested and it works perfectly. thank you. 😀

code:

graphql:
  packages:
    - your.package
    - org.springframework.security.core.userdetails.UserDetails

class CustomSchemaGeneratorHooks(
    resolvers: List<FederatedTypeResolver<*>>
) : FederatedSchemaGeneratorHooks(resolvers) {

    override fun willGenerateGraphQLType(type: KType): GraphQLType? {
        return when (type.classifier) {
            UserDetails::class -> SkipScalar
            else -> super.willGenerateGraphQLType(type)
        }
    }
}

val SkipScalar: GraphQLScalarType = GraphQLScalarType.newScalar()
    .name("__Skip__")
    .coercing(object : Coercing<Nothing, Nothing> {
        override fun serialize(dataFetcherResult: Any): Nothing {
            throw CoercingSerializeException("Skip types should never be used.")
        }

        override fun parseValue(input: Any): Nothing {
            throw CoercingSerializeException("Skip types should never be used.")
        }

        override fun parseLiteral(input: Any): Nothing {
            throw CoercingSerializeException("Skip types should never be used.")
        }
    })
    .build()

output:

type User implements Node {
  email: String!
  id: ID!
  name: String
  posts: [Post!]!
  roles: [String!]!
}