GH-3501: Add GraphQL support
Fixes https://github.com/spring-projects/spring-integration/issues/3501 * make current with latest changes in 'spring-graphql' * fix checkstyle issues * implement reactive endpoint for GraphQL Query * refactor to handle GraphQL Query and Mutation requests * refactor to handle GraphQL Subscription requests * implement expressions to handle for various RequestInput parameters * convert classes to records in tests, remove unneeded datatype modifiers on channels * replace executionId with idExpression SpEL evaluator * adjust name and default expression for executionId * rename for consistency, remove unneeded null check * Clean up code style * Remove redundant variables * Add `What's New` entry * Add `package-info.java`
This commit is contained in:
Daniel Frey
@@ -0,0 +1,337 @@
|
||||
/*
|
||||
* Copyright 2022 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.integration.graphql.outbound;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
import java.time.Duration;
|
||||
import java.util.Locale;
|
||||
import java.util.Map;
|
||||
import java.util.UUID;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.core.io.ClassPathResource;
|
||||
import org.springframework.graphql.GraphQlService;
|
||||
import org.springframework.graphql.RequestInput;
|
||||
import org.springframework.graphql.RequestOutput;
|
||||
import org.springframework.graphql.data.method.annotation.Argument;
|
||||
import org.springframework.graphql.data.method.annotation.MutationMapping;
|
||||
import org.springframework.graphql.data.method.annotation.QueryMapping;
|
||||
import org.springframework.graphql.data.method.annotation.SubscriptionMapping;
|
||||
import org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer;
|
||||
import org.springframework.graphql.execution.ExecutionGraphQlService;
|
||||
import org.springframework.graphql.execution.GraphQlSource;
|
||||
import org.springframework.integration.channel.FluxMessageChannel;
|
||||
import org.springframework.integration.channel.QueueChannel;
|
||||
import org.springframework.integration.config.EnableIntegration;
|
||||
import org.springframework.integration.dsl.IntegrationFlow;
|
||||
import org.springframework.integration.dsl.IntegrationFlows;
|
||||
import org.springframework.integration.dsl.MessageChannels;
|
||||
import org.springframework.messaging.Message;
|
||||
import org.springframework.messaging.MessageHandlingException;
|
||||
import org.springframework.messaging.PollableChannel;
|
||||
import org.springframework.messaging.support.ErrorMessage;
|
||||
import org.springframework.messaging.support.GenericMessage;
|
||||
import org.springframework.messaging.support.MessageBuilder;
|
||||
import org.springframework.stereotype.Controller;
|
||||
import org.springframework.stereotype.Repository;
|
||||
import org.springframework.test.annotation.DirtiesContext;
|
||||
import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
|
||||
|
||||
import graphql.execution.reactive.SubscriptionPublisher;
|
||||
import reactor.core.publisher.Flux;
|
||||
import reactor.core.publisher.Mono;
|
||||
import reactor.test.StepVerifier;
|
||||
|
||||
/**
|
||||
*
|
||||
* @author Daniel Frey
|
||||
*
|
||||
* @since 6.0
|
||||
*/
|
||||
@SpringJUnitConfig
|
||||
@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_EACH_TEST_METHOD)
|
||||
public class GraphQlMessageHandlerTests {
|
||||
|
||||
@Autowired
|
||||
private FluxMessageChannel inputChannel;
|
||||
|
||||
@Autowired
|
||||
private FluxMessageChannel resultChannel;
|
||||
|
||||
@Autowired
|
||||
private PollableChannel errorChannel;
|
||||
|
||||
@Autowired
|
||||
private GraphQlMessageHandler graphQlMessageHandler;
|
||||
|
||||
@Autowired
|
||||
private UpdateRepository updateRepository;
|
||||
|
||||
@Test
|
||||
@SuppressWarnings("unchecked")
|
||||
void testHandleMessageForQueryWithRequestInputProvided() {
|
||||
StepVerifier verifier =
|
||||
StepVerifier.create(
|
||||
Flux.from(this.resultChannel)
|
||||
.map(Message::getPayload)
|
||||
.cast(RequestOutput.class)
|
||||
)
|
||||
.consumeNextWith(result -> {
|
||||
assertThat(result).isInstanceOf(RequestOutput.class);
|
||||
Map<String, Object> data = result.getData();
|
||||
Map<String, Object> testQuery = (Map<String, Object>) data.get("testQuery");
|
||||
assertThat(testQuery.get("id")).isEqualTo("test-data");
|
||||
})
|
||||
.thenCancel()
|
||||
.verifyLater();
|
||||
|
||||
RequestInput payload = new RequestInput("{ testQuery { id } }", null, null, null, UUID.randomUUID().toString());
|
||||
this.inputChannel.send(MessageBuilder.withPayload(payload).build());
|
||||
|
||||
verifier.verify(Duration.ofSeconds(10));
|
||||
}
|
||||
|
||||
@Test
|
||||
@SuppressWarnings("unchecked")
|
||||
void testHandleMessageForQueryWithQueryProvided() {
|
||||
String fakeQuery = "{ testQuery { id } }";
|
||||
this.graphQlMessageHandler.setOperation(fakeQuery);
|
||||
|
||||
Locale locale = Locale.getDefault();
|
||||
this.graphQlMessageHandler.setLocale(locale);
|
||||
|
||||
Mono<RequestOutput> resultMono =
|
||||
(Mono<RequestOutput>) this.graphQlMessageHandler.handleRequestMessage(new GenericMessage<>(fakeQuery));
|
||||
StepVerifier.create(resultMono)
|
||||
.consumeNextWith(result -> {
|
||||
assertThat(result).isInstanceOf(RequestOutput.class);
|
||||
Map<String, Object> data = result.getData();
|
||||
Map<String, Object> testQuery = (Map<String, Object>) data.get("testQuery");
|
||||
assertThat(testQuery.get("id")).isEqualTo("test-data");
|
||||
})
|
||||
.expectComplete()
|
||||
.verify();
|
||||
}
|
||||
|
||||
@Test
|
||||
@SuppressWarnings("unchecked")
|
||||
void testHandleMessageForMutationWithRequestInputProvided() {
|
||||
String fakeId = UUID.randomUUID().toString();
|
||||
Update expected = new Update(fakeId);
|
||||
|
||||
StepVerifier verifier = StepVerifier.create(
|
||||
Flux.from(this.resultChannel)
|
||||
.map(Message::getPayload)
|
||||
.cast(RequestOutput.class)
|
||||
)
|
||||
.consumeNextWith(result -> {
|
||||
assertThat(result).isInstanceOf(RequestOutput.class);
|
||||
Map<String, Object> data = result.getData();
|
||||
Map<String, Object> update = (Map<String, Object>) data.get("update");
|
||||
assertThat(update.get("id")).isEqualTo(fakeId);
|
||||
|
||||
assertThat(this.updateRepository.current().block()).isEqualTo(expected);
|
||||
}
|
||||
)
|
||||
.thenCancel()
|
||||
.verifyLater();
|
||||
|
||||
RequestInput payload =
|
||||
new RequestInput("mutation { update(id: \"" + fakeId + "\") { id } }", null, null, null,
|
||||
UUID.randomUUID().toString());
|
||||
this.inputChannel.send(MessageBuilder.withPayload(payload).build());
|
||||
|
||||
verifier.verify(Duration.ofSeconds(10));
|
||||
|
||||
StepVerifier.create(this.updateRepository.current())
|
||||
.expectNext(expected)
|
||||
.expectComplete()
|
||||
.verify();
|
||||
}
|
||||
|
||||
@Test
|
||||
@SuppressWarnings("unchecked")
|
||||
void testHandleMessageForSubscriptionWithRequestInputProvided() {
|
||||
StepVerifier verifier = StepVerifier.create(
|
||||
Flux.from(this.resultChannel)
|
||||
.map(Message::getPayload)
|
||||
.cast(RequestOutput.class)
|
||||
.mapNotNull(RequestOutput::getData)
|
||||
.cast(SubscriptionPublisher.class)
|
||||
.map(Flux::from)
|
||||
.flatMap(data -> data)
|
||||
)
|
||||
.consumeNextWith(requestOutput -> {
|
||||
Map<String, Object> results = requestOutput.getData();
|
||||
assertThat(results).containsKey("results");
|
||||
|
||||
Map<String, Object> operationResult = (Map<String, Object>) results.get("results");
|
||||
assertThat(operationResult)
|
||||
.containsKey("id")
|
||||
.containsValue("test-data-01");
|
||||
|
||||
})
|
||||
.expectNextCount(9)
|
||||
.thenCancel()
|
||||
.verifyLater();
|
||||
|
||||
RequestInput payload =
|
||||
new RequestInput("subscription { results { id } }", null, null, null, UUID.randomUUID().toString());
|
||||
this.inputChannel.send(MessageBuilder.withPayload(payload).build());
|
||||
|
||||
verifier.verify(Duration.ofSeconds(10));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testHandleMessageWithInvalidPayload() {
|
||||
this.inputChannel.send(MessageBuilder.withPayload(new Object()).build());
|
||||
|
||||
Message<?> errorMessage = errorChannel.receive(10_000);
|
||||
assertThat(errorMessage).isNotNull()
|
||||
.isInstanceOf(ErrorMessage.class)
|
||||
.extracting(Message::getPayload)
|
||||
.isInstanceOf(MessageHandlingException.class)
|
||||
.satisfies((ex) -> assertThat((Exception) ex)
|
||||
.hasMessageContaining(
|
||||
"'operationExpression' must not be null"));
|
||||
}
|
||||
|
||||
@Controller
|
||||
static class GraphQlController {
|
||||
|
||||
final UpdateRepository updateRepository;
|
||||
|
||||
GraphQlController(UpdateRepository updateRepository) {
|
||||
this.updateRepository = updateRepository;
|
||||
}
|
||||
|
||||
@QueryMapping
|
||||
public Mono<QueryResult> testQuery() {
|
||||
return Mono.just(new QueryResult("test-data"));
|
||||
}
|
||||
|
||||
@QueryMapping
|
||||
public Mono<QueryResult> testQueryById(@Argument String id) {
|
||||
return Mono.just(new QueryResult("test-data"));
|
||||
}
|
||||
|
||||
@MutationMapping
|
||||
public Mono<Update> update(@Argument String id) {
|
||||
return this.updateRepository.save(new Update(id));
|
||||
}
|
||||
|
||||
@SubscriptionMapping
|
||||
public Flux<QueryResult> results() {
|
||||
return Flux.just(
|
||||
new QueryResult("test-data-01"),
|
||||
new QueryResult("test-data-02"),
|
||||
new QueryResult("test-data-03"),
|
||||
new QueryResult("test-data-04"),
|
||||
new QueryResult("test-data-05"),
|
||||
new QueryResult("test-data-06"),
|
||||
new QueryResult("test-data-07"),
|
||||
new QueryResult("test-data-08"),
|
||||
new QueryResult("test-data-09"),
|
||||
new QueryResult("test-data-10")
|
||||
);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Repository
|
||||
static class UpdateRepository {
|
||||
|
||||
private Update current;
|
||||
|
||||
Mono<Update> save(Update update) {
|
||||
this.current = update;
|
||||
return Mono.justOrEmpty(this.current);
|
||||
}
|
||||
|
||||
Mono<Update> current() {
|
||||
return Mono.just(this.current);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@EnableIntegration
|
||||
static class TestConfig {
|
||||
|
||||
@Bean
|
||||
GraphQlMessageHandler handler(GraphQlService graphQlService) {
|
||||
|
||||
return new GraphQlMessageHandler(graphQlService);
|
||||
}
|
||||
|
||||
@Bean
|
||||
IntegrationFlow graphqlQueryMessageHandlerFlow(GraphQlMessageHandler handler) {
|
||||
return IntegrationFlows.from(MessageChannels.flux("inputChannel"))
|
||||
.handle(handler)
|
||||
.channel(c -> c.flux("resultChannel"))
|
||||
.get();
|
||||
}
|
||||
|
||||
@Bean
|
||||
PollableChannel errorChannel() {
|
||||
return new QueueChannel();
|
||||
}
|
||||
|
||||
@Bean
|
||||
UpdateRepository updateRepository() {
|
||||
return new UpdateRepository();
|
||||
}
|
||||
|
||||
@Bean
|
||||
GraphQlController graphqlQueryController(UpdateRepository updateRepository) {
|
||||
return new GraphQlController(updateRepository);
|
||||
}
|
||||
|
||||
@Bean
|
||||
GraphQlService graphQlService(GraphQlSource graphQlSource) {
|
||||
return new ExecutionGraphQlService(graphQlSource);
|
||||
}
|
||||
|
||||
@Bean
|
||||
GraphQlSource graphQlSource(AnnotatedControllerConfigurer annotatedDataFetcherConfigurer) {
|
||||
return GraphQlSource.builder()
|
||||
.schemaResources(new ClassPathResource("graphql/test-schema.graphqls"))
|
||||
.configureRuntimeWiring(annotatedDataFetcherConfigurer)
|
||||
.build();
|
||||
}
|
||||
|
||||
@Bean
|
||||
AnnotatedControllerConfigurer annotatedDataFetcherConfigurer() {
|
||||
return new AnnotatedControllerConfigurer();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
record QueryResult(String id) {
|
||||
|
||||
}
|
||||
|
||||
record Update(String id) {
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
type Query {
|
||||
testQuery: QueryResult
|
||||
testQueryById(id: String): QueryResult
|
||||
}
|
||||
|
||||
type Mutation {
|
||||
update(id: String!): Update!
|
||||
}
|
||||
|
||||
type Subscription {
|
||||
results: QueryResult
|
||||
}
|
||||
|
||||
type QueryResult {
|
||||
id: String
|
||||
}
|
||||
|
||||
type Update {
|
||||
id: String
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<Configuration status="WARN">
|
||||
<Appenders>
|
||||
<Console name="STDOUT" target="SYSTEM_OUT">
|
||||
<PatternLayout pattern="%d %p [%t] [%c] - %m%n" />
|
||||
</Console>
|
||||
</Appenders>
|
||||
<Loggers>
|
||||
<Logger name="org.springframework" level="warn"/>
|
||||
<Logger name="org.springframework.graphql" level="warn"/>
|
||||
<Logger name="org.springframework.integration.graphql" level="warn"/>
|
||||
<Root level="warn">
|
||||
<AppenderRef ref="STDOUT" />
|
||||
</Root>
|
||||
</Loggers>
|
||||
</Configuration>
|
||||
Reference in New Issue
Block a user