graphql.schema.diff.DiffSet Maven / Gradle / Ivy
package graphql.schema.diff;
import graphql.Assert;
import graphql.DeprecatedAt;
import graphql.ExecutionResult;
import graphql.GraphQL;
import graphql.PublicApi;
import graphql.introspection.IntrospectionQuery;
import graphql.schema.GraphQLSchema;
import java.util.Map;
/**
* Represents 2 schemas that can be diffed. The {@link SchemaDiff} code
* assumes that that schemas to be diffed are the result of a
* {@link graphql.introspection.IntrospectionQuery}.
*/
@PublicApi
@Deprecated
@DeprecatedAt("2023-10-04")
public class DiffSet {
private final Map introspectionOld;
private final Map introspectionNew;
public DiffSet(Map introspectionOld, Map introspectionNew) {
this.introspectionOld = introspectionOld;
this.introspectionNew = introspectionNew;
}
/**
* @return the old API as an introspection result
*/
public Map getOld() {
return introspectionOld;
}
/**
* @return the new API as an introspection result
*/
public Map getNew() {
return introspectionNew;
}
/**
* Creates a diff set out of the result of 2 introspection queries.
*
* @param introspectionOld the older introspection query
* @param introspectionNew the newer introspection query
*
* @return a diff set representing them
*/
public static DiffSet diffSet(Map introspectionOld, Map introspectionNew) {
return new DiffSet(introspectionOld, introspectionNew);
}
/**
* Creates a diff set out of the result of 2 schemas.
*
* @param schemaOld the older schema
* @param schemaNew the newer schema
*
* @return a diff set representing them
*/
public static DiffSet diffSet(GraphQLSchema schemaOld, GraphQLSchema schemaNew) {
Map introspectionOld = introspect(schemaOld);
Map introspectionNew = introspect(schemaNew);
return diffSet(introspectionOld, introspectionNew);
}
private static Map introspect(GraphQLSchema schema) {
GraphQL gql = GraphQL.newGraphQL(schema).build();
ExecutionResult result = gql.execute(IntrospectionQuery.INTROSPECTION_QUERY);
Assert.assertTrue(result.getErrors().size() == 0, () -> "The schema has errors during Introspection");
return result.getData();
}
}