Add manual routes support to imperative gateway #25817

mshima · 2024-04-11T21:22:48Z

add support to quotedList to jdl
add types to jdl operations
rework jdl toString
add routes option for imperative gateway

Related to #25715

Please make sure the below checklist is followed for Pull Requests.

All continuous integration tests are green
Tests are added where necessary
The JDL part is updated if necessary
jhipster-online is updated if necessary
Documentation is added/updated where necessary
Coding Rules & Commit Guidelines as per our CONTRIBUTING.md document are followed

When you are still working on the PR, consider converting it to Draft (below reviewers) and adding skip-ci label, you can still see CI build result at your branch.

generators/server/jdl/application-definition.ts

mraible · 2024-04-25T19:00:36Z

I'm guessing there's no way to halt the generation of all apps when this error occurs:

ERROR! An error occured while running jhipster:spring-cloud:gateway#reactiveByDefault
ERROR! An error occured while running jhipster:workspaces#generateApplications
ERROR! ERROR! Spring Cloud Gateway MVC support is experimental and not officially supported. To use it, run the generator with the --experimental flag.
Error: Spring Cloud Gateway MVC support is experimental and not officially supported. To use it, run the generator with the --experimental flag.
    at GatewayGenerator.reactiveByDefault (file:///Users/mraible/dev/generator-jhipster/dist/generators/spring-cloud/generators/gateway/generator.js:61:31)
    at GatewayGenerator.executeTask (file:///Users/mraible/dev/generator-jhipster/node_modules/yeoman-generator/dist/actions/lifecycle.js:244:26)
    at env.queueTask.once (file:///Users/mraible/dev/generator-jhipster/node_modules/yeoman-generator/dist/actions/lifecycle.js:218:56)
    at runLoop.add.once (file:///Users/mraible/dev/generator-jhipster/node_modules/yeoman-environment/dist/environment-base.js:395:23)
    at Immediate.<anonymous> (/Users/mraible/dev/generator-jhipster/node_modules/grouped-queue/lib/subqueue.js:48:34)
    at process.processImmediate (node:internal/timers:478:21)

I ran the following command and got distracted:

jhipster jdl app.jdl --monorepository --workspaces

When I came back to my terminal, I was confused as to why the gateway directory was empty. Then I scrolled up and saw the error. It'd be a better developer experience if it stopped after this error.

mraible · 2024-04-25T19:13:14Z

I tried the JDL in #25715 (comment) and was confused at first that there was no Consul Docker image to start up. Then I realized there was no service discovery so it's not needed. Should we issue a warning when there's a serviceDiscoveryType line in the JDL and it's a non-reactive gateway?

 ✔ Container blog-consul-1                Healthy                                                                  0.0s
 ✔ Container blog-consul-config-loader-1  Healthy                                                                  0.0s
 ✔ Container blog-neo4j-1                 Created                                                                  0.0s
 ✔ Container blog-keycloak-1              Created

mraible · 2024-04-27T20:23:22Z

I tried this again today with the following JDL:

application {
  config {
    baseName gateway
    reactive false
    packageName org.jhipster.gateway
    applicationType gateway
    authenticationType oauth2
    buildTool gradle
    clientFramework react
    prodDatabaseType postgresql
    serviceDiscoveryType no
    testFrameworks [cypress]
    microfrontends [blog, store]
    routes ["blog:blog:8081", "store:store:8082"]
  }
}

application {
  config {
    baseName blog
    reactive false
    packageName org.jhipster.blog
    applicationType microservice
    authenticationType oauth2
    buildTool gradle
    clientFramework react
    databaseType neo4j
    enableHibernateCache false
    serverPort 8081
    serviceDiscoveryType no
    testFrameworks [cypress]
  }
  entities Blog, Post, Tag
}

application {
  config {
    baseName store
    reactive false
    packageName org.jhipster.store
    applicationType microservice
    authenticationType oauth2
    buildTool gradle
    clientFramework react
    databaseType mongodb
    enableHibernateCache false
    serverPort 8082
    serviceDiscoveryType no
    testFrameworks [cypress]
  }
  entities Product
}

entity Blog {
  name String required minlength(3)
  handle String required minlength(2)
}

entity Post {
  title String required
  content TextBlob required
  date Instant required
}

entity Tag {
  name String required minlength(2)
}

entity Product {
  title String required
  price BigDecimal required min(0)
  image ImageBlob
}

relationship ManyToOne {
  Blog{user(login)} to User with builtInEntity
  Post{blog(name)} to Blog
}

relationship ManyToMany {
  Post{tag(name)} to Tag{post}
}

paginate Post, Tag with infinite-scroll
paginate Product with pagination

deployment {
  deploymentType docker-compose
  serviceDiscoveryType consul
  appsFolders [gateway, blog, store]
  dockerRepositoryName "mraible"
}

deployment {
  deploymentType kubernetes
  appsFolders [gateway, blog, store]
  clusteredDbApps [store]
  kubernetesNamespace demo
  kubernetesUseDynamicStorage true
  kubernetesStorageClassName ""
  serviceDiscoveryType consul
  dockerRepositoryName "mraible"
}

And the following command:

jhipster jdl app.jdl --monorepository --workspaces --experimental

The gateway seems to work fine, but there is a stack trace in the logs:

Caused by: java.lang.NoClassDefFoundError: org/springframework/cloud/loadbalancer/support/LoadBalancerClientFactory
        at org.springframework.cloud.gateway.server.mvc.filter.LoadBalancerFilterFunctions.lambda$lb$5(LoadBalancerFilterFunctions.java:66)
        at org.springframework.web.servlet.function.HandlerFilterFunction.lambda$andThen$0(HandlerFilterFunction.java:58)
        at org.springframework.web.servlet.function.HandlerFilterFunction.lambda$ofRequestProcessor$3(HandlerFilterFunction.java:83)
        at org.springframework.web.servlet.function.HandlerFilterFunction.lambda$andThen$0(HandlerFilterFunction.java:58)
        at org.springframework.cloud.gateway.server.mvc.config.RouterFunctionHolderFactory.lambda$getRouterFunction$3(RouterFunctionHolderFactory.java:154)

And, after starting both the blog and store apps, the gateway can't connect to them because of a 403.

mshima · 2024-04-27T23:21:34Z

Indeed it works with serviceDiscovery enabled.

mraible · 2024-04-29T15:33:34Z

@mshima I tried changing the JDL from serviceDiscoveryType no to serviceDiscoveryType consul and regenerating everything. After starting the blog app, I can see the menu items in the gateway. However, when I click on them, there's an infinite redirect that happens.

25817.mp4

generators/server/templates/src/main/resources/config/application.yml.ejs

Tcharl · 2024-04-30T14:14:19Z

test-integration/jdl-samples/ms-ng-oauth2-mongodb-caffeine/blog-store.jdl

    clientFramework angular
    creationTimestamp 1617901618886
    databaseType mongodb
    jhiPrefix custom
    jwtSecretKey "ZjY4MTM4YjI5YzMwZjhjYjI2OTNkNTRjMWQ5Y2Q0Y2YwOWNmZTE2NzRmYzU3NTMwM2NjOTE3MTllOTM3MWRkMzcyYTljMjVmNmQ0Y2MxOTUzODc0MDhhMTlkMDIxMzI2YzQzZDM2ZDE3MmQ3NjVkODk3OTVmYzljYTQyZDNmMTQ="
    messageBroker kafka
    packageName com.okta.developer.gateway
-    serviceDiscoveryType consul
+    reactive false
+    serviceDiscoveryType no


Gateway shouldn't be an option for microservice architecture, there's no point specifically routing.

I'm strongly against adding an antipattern just to please users that aren't able to achieve reactive programming from api to ms webclient.

I agree that hard-coding routes in the gateway might not be a good idea. The reason we're considering it is that Spring Cloud Gateway MVC won't have support for service discovery until November 2024.

As far as reactive vs MVC, there does seem to be a demand for Spring Cloud Gateway MVC, that's why Spencer Gibb and the Spring Cloud team are working on it.

I don't agree.

it's not up to us to say you should use service discovery for every gateway/microservice use case

we do not forbid gateways and microservices without serviceDiscovery

Add manual option for service discovery #21012 is open for more than a year without any comment

IMO we have do choose one of:

accept manual routes PR

force the user to use --skip-checks for gateways and microservices without serviceDiscovery and close Add manual option for service discovery #21012

It's just IMHO:

Backend Gateways:

Act as a single point of entry of frontend request

Is in charge of managing permissions (users and authorities)

Route requests to the according microservice by querying the registry and translating exceptions and return codes

Retry, circuitbreaking policy, ...
And this is simple enough to be managed by reactive paradigm to anyone (imperative would also please me as I find reactive quite hard, but still)

Otherwise, we loose one of the 12 factors and microservice paradigm. Manual route is not hipsterish and definitely not something worth the maintenance, I would personally prefer to close the #21012 as antipattern

ideally BTW, this paradigm should also be applied for microfrontend too ;-)

To add to this discussion, here's a video from Josh Long about why Spring Cloud Gateway MVC. Summary: because Java 21 with virtual threads and it's easier to understand. https://youtu.be/1ouE2QAebuE?si=-603Akrcvgn0HiMN&t=244

github-actions bot added theme: jhipster-internals theme: java labels Apr 11, 2024

mshima mentioned this pull request Apr 11, 2024

Add support for Spring Cloud Gateway MVC #25715

Open

1 task

DanielFran requested a review from mraible April 12, 2024 13:12

mraible reviewed Apr 25, 2024

View reviewed changes

generators/server/jdl/application-definition.ts Outdated Show resolved Hide resolved

yhao3 reviewed Apr 30, 2024

View reviewed changes

generators/server/templates/src/main/resources/config/application.yml.ejs Outdated Show resolved Hide resolved

github-actions bot added the theme: maven label Apr 30, 2024

Tcharl reviewed Apr 30, 2024

View reviewed changes

mshima mentioned this pull request Apr 30, 2024

improve jdl serialization and types #26006

Merged

6 tasks

mshima added 5 commits April 30, 2024 16:44

add support to quotedList

069c633

add spring-cloud-starter-loadbalancer to imperative gateways

cce2a46

fix skip-*-tests matrix

1544729

add support to manually configured routes.

987a693

add imperative gateway oauth2 sample with manual route

cf9d21b

mshima force-pushed the gateway-imperative branch from f8cebf2 to cf9d21b Compare April 30, 2024 19:49

mshima requested a review from DanielFran May 6, 2024 15:05

DanielFran approved these changes May 6, 2024

View reviewed changes

DanielFran merged commit cc67bdc into jhipster:main May 6, 2024
52 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add manual routes support to imperative gateway #25817

Add manual routes support to imperative gateway #25817

mshima commented Apr 11, 2024

mraible commented Apr 25, 2024

mraible commented Apr 25, 2024

mraible commented Apr 27, 2024

mshima commented Apr 27, 2024

mraible commented Apr 29, 2024

Tcharl Apr 30, 2024

mraible Apr 30, 2024

mshima Apr 30, 2024

Tcharl Apr 30, 2024 •

edited

Tcharl Apr 30, 2024

mraible Apr 30, 2024

Add manual routes support to imperative gateway #25817

Add manual routes support to imperative gateway #25817

Conversation

mshima commented Apr 11, 2024

mraible commented Apr 25, 2024

mraible commented Apr 25, 2024

mraible commented Apr 27, 2024

mshima commented Apr 27, 2024

mraible commented Apr 29, 2024

Tcharl Apr 30, 2024

Choose a reason for hiding this comment

mraible Apr 30, 2024

Choose a reason for hiding this comment

mshima Apr 30, 2024

Choose a reason for hiding this comment

Tcharl Apr 30, 2024 • edited

Choose a reason for hiding this comment

Tcharl Apr 30, 2024

Choose a reason for hiding this comment

mraible Apr 30, 2024

Choose a reason for hiding this comment

Tcharl Apr 30, 2024 •

edited