Add API Gateway #1572

yoomlam · 2023-05-17T14:56:29Z

What was the problem?

VRO currently serves up its API using Spring MVC. This constrains implementations of new APIs to be written using Spring MVC and Java.

Implement VRO API Gateway to serve multiple APIs #1512

How does this fix it?

To support serving up APIs implemented in other languages (i.e., Python used by the CC Team), implement a VRO Gateway that acts as a proxy to forward requests to the specified tenant API, as determined by the URI prefix.

Referring to https://piotrminkowski.com/2020/02/20/microservices-api-documentation-with-springdoc-openapi/, implement using Spring Boot 3 and Spring Cloud Gateway.

Creating a docker image and enabling Helm deployment will be done in a separate PR

How to test this PR

Run the API Gateway: ./gradlew :api-gateway:bootRun
Run the domain APIs:

# Start VRO's App API
./gradlew :app:dockerComposeUp
# This API's Swagger UI is available at http://localhost:8080/swagger

# Start Team CC's API -- see domain-cc/README.md
cd domain-cc/svc-cc-app/src
uvicorn api:app --port 18000 --reload
# This API's Swagger UI is available at http://localhost:18000/docs

Browse to http://localhost:8060/, read instructions, and click Swagger UI
- Select the definition "App API" -- note that it is the same as App API. To use it, select the "/app" server on the left dropdown
- Select the definition "Contention Classification API" -- note that it is the same as Team CC's API. This API needs to be updated to allow the "/contention-classification" to be selected as the server.

github-actions · 2023-05-17T15:01:51Z

Test Results

91 tests ±0 91 ✔️ ±0 49s ⏱️ +5s
34 suites ±0   0 💤 ±0
34 files ±0   0 ❌ ±0

Results for commit 3b7e08e. ± Comparison against base commit 6ddd1d5.

♻️ This comment has been updated with latest results.

github-actions · 2023-05-17T15:02:36Z

JaCoCo Test Coverage

File	Coverage [44.25%]	❌
OpenApiProperties.java	100%	🍏
OpenApiConfiguration.java	97.79%	🍏
OpenApiProperties.java	0%	❌
License.java	0%	❌
Server.java	0%	❌
Contact.java	0%	❌
Info.java	0%	❌
OpenApiConfiguration.java	0%	❌
GatewayApplication.java	0%	❌
GatewayConfiguration.java	0%	❌
HomePageController.java	0%	❌

Total Project Coverage	74.67%	❌

yoomlam · 2023-05-17T15:26:24Z

buildSrc/src/main/groovy/starter.java.deps-build-conventions.gradle

@@ -11,9 +11,6 @@ plugins {
 dependencies {
    implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310'

-    // Added
-    implementation 'javax.validation:validation-api'


We don't need to import this for all java projects, plus Spring Boot 3 uses jakarta instead.

yoomlam · 2023-05-17T15:26:34Z

buildSrc/src/main/groovy/local.std.java.application-conventions.gradle

@@ -17,7 +17,6 @@ plugins {
    id 'starter.java.deps-springdoc-conventions'

    // Use our `local` container variants
-    id 'local.java.container-conventions'


local.java.container-spring-conventions already includes local.java.container-conventions

yoomlam · 2023-05-17T15:45:39Z

api-gateway/src/main/resources/application.yml

+        url: /app/v3/api-docs
+      - name: Contention Classification API
+        # Use the route defined under spring.cloud.gateway below
+        url: /contention-classification/openapi.json


@lukey-luke If you the location of the openapi.json changes, please update this line.

yoomlam · 2023-05-17T15:48:30Z

api-gateway/src/main/resources/application.yml

+    filters:
+    - RewritePath=/app/(?<path>.*), /$\{path}
+  - id: contention-classification-tenant
+    # TODO: add Swagger servers such that /contention-classification is used as the prefix for requests


@lukey-luke Requested this TODO in Slack

yoomlam · 2023-05-17T17:39:15Z

api-gateway/gradle.properties

@@ -0,0 +1 @@
+spring_boot_version=3.0.6


Use Spring Boot 3. The rest of VRO is using Spring Boot 2.

engineer-plus-plus

I would love to see included a README file and automated tests. In a README, it would be useful to be able to find out what exactly this api gateway does. Is it just url-mapping? Authentication? Throttling? I'm pretty sure api gateways have been known to do a variety of things like this.

engineer-plus-plus · 2023-05-17T21:36:50Z

api-gateway/src/main/java/gov/va/vro/OpenApiConfiguration.java

+@Configuration
+public class OpenApiConfiguration {
+  @Autowired
+  private final OpenApiProperties openApiProperties = new OpenApiProperties();


Isn't it a little unusual to initialize @autowired member of a class? Seems to mildly defeat the purpose of dependency injection.

This was copied from

abd-vro/app/src/main/java/gov/va/vro/config/OpenApiConfiguration.java

Line 27 in a6e0c86

@Autowired private final OpenApiProperties openApiProperties = new OpenApiProperties();

I removed @Autowired and added @RequiredArgsConstructor.

engineer-plus-plus · 2023-05-17T21:40:29Z

api-gateway/src/main/java/gov/va/vro/OpenApiConfiguration.java

+                    .title(info.getTitle())
+                    .description(info.getDescription())
+                    .version(info.getVersion())
+                    .license(new License().name(license.getName()).url(license.getUrl()))


Is there a reason to not just pass existing contact and license objects? It would make the code simpler.

They're different object types:

io.swagger.v3.oas.models.info.Contact - what is expected

gov.va.vro.propmodel.Contact - what we create as a result of parsing the application.yaml file

msnwatson

since this ain't being used right now, i'm good with testing being included in another PR once it is potentially better exposed through docker containers and helm charts like mentioned in the PR description

yoomlam · 2023-05-18T14:51:38Z

since this ain't being used right now, i'm good with testing being included in another PR once it is potentially better exposed through docker containers and helm charts like mentioned in the PR description

Yeah, there's barely any code for unit testing. The API Gateway can be tested in an integration or end-to-end test.

add api-gateway

d805e1b

clean up

a9157fa

yoomlam marked this pull request as ready for review May 17, 2023 15:25

more clean up

028210d

yoomlam commented May 17, 2023

View reviewed changes

yoomlam requested review from engineer-plus-plus, greene858, tcraghu and msnwatson May 17, 2023 15:37

yoomlam commented May 17, 2023

View reviewed changes

move API contact and license to gateway

4daba4d

yoomlam mentioned this pull request May 17, 2023

Implement VRO API Gateway to serve multiple APIs #1512

Closed

cleanup

a6e0c86

yoomlam force-pushed the yoom/api-gateway branch from 5a10910 to a6e0c86 Compare May 17, 2023 17:36

yoomlam commented May 17, 2023

View reviewed changes

yoomlam force-pushed the yoom/api-gateway branch 2 times, most recently from c8afd39 to 5feb2d9 Compare May 17, 2023 18:26

remove unnecessary dependencies

7858c88

yoomlam force-pushed the yoom/api-gateway branch from 5feb2d9 to 7858c88 Compare May 17, 2023 18:57

engineer-plus-plus reviewed May 17, 2023

View reviewed changes

msnwatson approved these changes May 18, 2023

View reviewed changes

yoomlam added 2 commits May 18, 2023 09:34

removed @Autowired` and added @requiredargsconstructor

a7e5073

add README.md

3b7e08e

yoomlam requested a review from engineer-plus-plus May 18, 2023 14:49

yoomlam mentioned this pull request May 18, 2023

Add deploy configurations for API Gateway #1578

Merged

yoomlam merged commit 23d9857 into develop May 22, 2023

yoomlam deleted the yoom/api-gateway branch May 22, 2023 15:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add API Gateway #1572

Add API Gateway #1572

yoomlam commented May 17, 2023 •

edited

Loading

github-actions bot commented May 17, 2023 •

edited

Loading

github-actions bot commented May 17, 2023 •

edited

Loading

yoomlam May 17, 2023

yoomlam May 17, 2023

yoomlam May 17, 2023

yoomlam May 17, 2023

yoomlam May 17, 2023

engineer-plus-plus left a comment

engineer-plus-plus May 17, 2023

yoomlam May 18, 2023

engineer-plus-plus May 17, 2023

yoomlam May 18, 2023 •

edited

Loading

msnwatson left a comment

yoomlam commented May 18, 2023

		@@ -0,0 +1 @@
		spring_boot_version=3.0.6

Add API Gateway #1572

Add API Gateway #1572

Conversation

yoomlam commented May 17, 2023 • edited Loading

What was the problem?

How does this fix it?

How to test this PR

github-actions bot commented May 17, 2023 • edited Loading

Test Results

github-actions bot commented May 17, 2023 • edited Loading

JaCoCo Test Coverage

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

engineer-plus-plus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yoomlam May 18, 2023 • edited Loading

Choose a reason for hiding this comment

msnwatson left a comment

Choose a reason for hiding this comment

yoomlam commented May 18, 2023

yoomlam commented May 17, 2023 •

edited

Loading

github-actions bot commented May 17, 2023 •

edited

Loading

github-actions bot commented May 17, 2023 •

edited

Loading

yoomlam May 18, 2023 •

edited

Loading