com.github.aoudiamoncef.apollo.plugin.GraphQLClientMojo.kt Maven / Gradle / Ivy
package com.github.aoudiamoncef.apollo.plugin
import com.apollographql.apollo.compiler.GraphQLCompiler
import com.apollographql.apollo.compiler.OperationIdGenerator
import com.apollographql.apollo.compiler.OperationOutputGenerator
import com.github.aoudiamoncef.apollo.plugin.config.CompilationUnit
import com.github.aoudiamoncef.apollo.plugin.config.Introspection
import com.github.aoudiamoncef.apollo.plugin.config.Service
import com.github.aoudiamoncef.apollo.plugin.util.ConfigUtils
import com.github.aoudiamoncef.apollo.plugin.util.SchemaDownloader
import org.apache.maven.plugin.AbstractMojo
import org.apache.maven.plugin.MojoExecutionException
import org.apache.maven.plugins.annotations.LifecyclePhase
import org.apache.maven.plugins.annotations.Mojo
import org.apache.maven.plugins.annotations.Parameter
import org.apache.maven.plugins.annotations.ResolutionScope
import org.apache.maven.project.MavenProject
import java.io.File
import java.nio.file.FileSystems
import java.nio.file.PathMatcher
/**
* Generate queries classes for a GraphQl API
*/
@Mojo(
name = "generate",
requiresDependencyCollection = ResolutionScope.COMPILE,
requiresDependencyResolution = ResolutionScope.COMPILE,
defaultPhase = LifecyclePhase.GENERATE_SOURCES,
threadSafe = true
)
class GraphQLClientMojo : AbstractMojo() {
/**
* Maven project instance
*/
@Parameter(defaultValue = "\${project}", readonly = true, required = true)
private lateinit var project: MavenProject
/**
* Whether to skip plugin execution
*/
@Parameter
private val skip: Boolean = false
/**
* registers services
*
* name: the name of the [Service], must be unique
*/
@Parameter
private lateinit var services: Map
@Throws(MojoExecutionException::class)
override fun execute() {
val start = System.nanoTime()
if (skip) {
log.info("Apollo GraphQL Client code generation skipping execution because skip option is true")
return
}
log.info("Apollo GraphQL Client code generation task started")
services.entries.forEach service@{
if (!it.value.enabled) {
log.info("Skipping generation of service: ${it.key} because enabled option is false")
return@service
}
val service: Service = ConfigUtils.checkService(project, it.key, it.value)
val compilationUnit: CompilationUnit =
ConfigUtils.checkCompilationUnit(project, it.key, service.compilationUnit)
val compilerParams = ConfigUtils.checkCompilerParams(project, service, compilationUnit.compilerParams)
val introspection: Introspection = ConfigUtils.checkIntrospection(project, service)
log.info("Generating service: ${it.key}")
if (introspection.enabled) {
log.info("Automatically generating introspection file from: ${introspection.endpointUrl}")
introspection.schemaFile.let { schema ->
val okHttpClient = SchemaDownloader.newOkHttpClient(
connectTimeoutSeconds = introspection.connectTimeoutSeconds,
readTimeoutSeconds = introspection.readTimeoutSeconds,
writeTimeoutSeconds = introspection.writeTimeoutSeconds,
useSelfSignedCertificat = introspection.useSelfSignedCertificat,
useGzip = introspection.useGzip
)
if (introspection.endpointUrl.isNotEmpty()) {
SchemaDownloader.downloadIntrospection(
schema = schema as File,
endpoint = introspection.endpointUrl,
headers = introspection.headers,
prettyPrint = introspection.prettyPrint,
okHttpClient = okHttpClient
)
} else if (introspection.graph.isNotEmpty()) {
SchemaDownloader.downloadRegistry(
schema = schema as File,
graph = introspection.graph,
key = introspection.key,
variant = introspection.graphVariant,
prettyPrint = introspection.prettyPrint,
okHttpClient = okHttpClient
)
}
}
}
log.info("Read schema file")
val sourceSetFiles = ConfigUtils.getSourceSetFiles(
sourceFolder = service.sourceFolder as File,
includes = service.includes,
excludes = service.excludes
)
val schemaMatcher: PathMatcher = FileSystems.getDefault().getPathMatcher("glob:**.{json,sdl,graphqls}")
val directories = ConfigUtils.findFilesByMatcher(sourceSetFiles, schemaMatcher)
val schema = ConfigUtils.resolveSchema(
project = project,
schemaPath = service.schemaPath,
directories = directories,
sourceSetFiles = sourceSetFiles
)
log.info("Read querie(s)/fragment(s) files")
val graphqlMatcher: PathMatcher = FileSystems.getDefault().getPathMatcher("glob:**.{graphql,gql,graphqls}")
val graphqlFiles =
ConfigUtils.findFilesByMatcher(sourceSetFiles, graphqlMatcher)
.takeIf { set -> set.isNotEmpty() }
?: throw MojoExecutionException("No querie(s)/fragment(s) found")
val operationOutputGenerator = if (compilerParams.operationIdGeneratorClass.isEmpty()) {
OperationOutputGenerator.DefaultOperationOuputGenerator(OperationIdGenerator.Sha256())
} else {
val operationIdGenerator =
Class.forName(compilerParams.operationIdGeneratorClass).newInstance() as OperationIdGenerator
OperationOutputGenerator.DefaultOperationOuputGenerator(operationIdGenerator)
}
val compiler = GraphQLCompiler()
compiler.write(
GraphQLCompiler.Arguments(
rootFolders = compilerParams.rootFolders,
graphqlFiles = graphqlFiles,
schemaFile = schema,
outputDir = compilationUnit.outputDirectory as File,
metadata = compilerParams.metadata,
moduleName = compilerParams.moduleName,
rootProjectDir = compilerParams.rootProjectDir,
metadataOutputFile = compilerParams.metadataOutputFile as File,
generateMetadata = compilerParams.generateApolloMetadata,
alwaysGenerateTypesMatching = compilerParams.alwaysGenerateTypesMatching,
operationOutputFile = compilationUnit.operationOutputFile,
operationOutputGenerator = operationOutputGenerator,
rootPackageName = compilerParams.rootPackageName,
packageName = compilerParams.packageName,
generateKotlinModels = compilerParams.generateKotlinModels,
customTypeMap = compilerParams.customTypeMapping,
useSemanticNaming = compilerParams.useSemanticNaming,
generateAsInternal = compilerParams.generateAsInternal,
warnOnDeprecatedUsages = compilerParams.warnOnDeprecatedUsages,
failOnWarnings = compilerParams.failOnWarnings,
kotlinMultiPlatformProject = compilerParams.kotlinMultiPlatformProject,
enumAsSealedClassPatternFilters = compilerParams.sealedClassesForEnumsMatching,
nullableValueType = compilerParams.nullableValueType,
generateModelBuilder = compilerParams.generateModelBuilder,
useJavaBeansSemanticNaming = compilerParams.useJavaBeansSemanticNaming,
suppressRawTypesWarning = compilerParams.suppressRawTypesWarning,
generateVisitorForPolymorphicDatatypes = compilerParams.generateVisitorForPolymorphicDatatypes
)
)
if (service.addSourceRoot) {
val generatedSourcePath = compilationUnit.outputDirectory?.canonicalPath
log.info("Add the compiled sources from $generatedSourcePath to project root")
project.addCompileSourceRoot(generatedSourcePath)
}
}
log.info("Apollo GraphQL Client code generation task finished")
val finish = System.nanoTime()
val timeElapsed = (finish - start).toDouble() / 1000000000
log.info("Total time: ${String.format("%.3f", timeElapsed)} s")
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy