Add ApolloCompilerPlugin.schemaDocumentListener()

[martinbonnin]

class TestPlugin: ApolloCompilerPlugin {
  override fun foreignSchemas(): List<ForeignSchema> {
    return listOf(
        ForeignSchema("cache", "v0.1", definitions)
    )
  }

  override fun schemaDocumentListener(): SchemaDocumentListener {
    return object : SchemaDocumentListener {
      override fun onSchemaDocument(schema: GQLDocument, outputDirectory: File) {
        // Do some codegen here
      }
    }
  }
}

See here for an example

[netlify]

✅ Deploy Preview for apollo-android-docs canceled.

Name	Link
🔨 Latest commit	eec3e57
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-android-docs/deploys/66faa33fed06f40008cd9792

[BoD]

Looks very good! I'll try it on the cache repo.

[BoD]

Sorry I didn't catch it before, but would it make sense to also pass the packageName configured in the service here?

[martinbonnin]

I left it out on purpose. The package name can be turing complete (because of packageNameFromFilePath, etc...). How big of an issue is it to not have it? If really needed, one can always pass it as a ACP (Apollo Compiler Plugin) argument.

[BoD]

Ah I see. Not a big issue, but I think this means the package name will have to be repeated in most cases.

[BoD]

Another question - why not passing the Schema rather than the GQLDocument? To correctly look at directives I should use Schema.originalDirectiveName() right?

[martinbonnin]

this means the package name will have to be repeated in most cases.

What about:

apollo {
  service("service") {
    packageName.set("com.example")
    plugin(project(":cache-plugin")) {
      argument("packageName", packageName.get())
    }
  }
}

And if evolution is a concern, hide it behind a java function:

apollo {
  service("service") {
    packageName.set("com.example")
    configureCachePlugin(this, project(":cache-plugin"))
  }
}

[martinbonnin]

why not passing the Schema rather than the GQLDocument?

Not sure. GQLDocument is overall more stable than Schema but yea in your case, looks like you need schema. I'll amend.

[martinbonnin]

#6166 for passing a Schema instead of a GQLDocument

[BoD]

packageName.get() is totally acceptable, a dedicated fun as well 👍.