knotx / knotx-example-project Goto Github PK

Version used

• knot.x: 1.3.0

Context of the issue/feature

The mvn clean package command builds the example project distribution but it does not contain all dependencies defined in the knotx-stack.json file (like the knotx-mocks module). So the first command to execute is bin/knotx resolve.

The example project should provide both sample temapltes and mocked data sources. It should not be a part of the https://github.com/Cognifide/knotx repository any more.

Appendix

• Knot.x Stack
• Knot.x Mocks

The integration tests should check that all modules like Knot.x Core, Knot.x Data Bridge etc work together. The example project contains sample data which can be easlily used.

Proposed technologies: rest-assured, docker

Is your feature request related to a problem? Please describe.
Upgrade the GraphQL example (/api-gateway/graphql-api) to the Knot.x 2.2.1.

Describe the solution you'd like
The GraphQL example the following changes:

• upgrade Gradle to 6.X
• configure the new Knot.x Gradle Plugins
• reimplement Actions & Fetchers
• implement unit tests

Additional context
Please upgrade also the tutorial.

Is your feature request related to a problem? Please describe.
Example projects should include some samples of implementing authentication.

Describe the solution you'd like
A sample project showing how to handle Basic Auth, JWT Auth and OAuth2 with OpenID

Additional context
After release actions.

First tutorials concentrate on first steps in Knot.x 2.0. Now we want to categorize those tutorials with typical use cases:

• API Gateway (getting started, securing existing API, Beautifying existing API etc.)
• Templating (getting started)
• Distribution (stack, docker)
• Configurable Integrations (getting started (simple timeout), circuit breaker)

Describe the solution you'd like
We should restructure examples, the proposal catalogues:

/api-gateway/composing-many-apis (current getting started)
/api-gateway/securing-existing-apis
/template-processing/getting-started
/distribution/getting-started
/distribution/getting-started-with-docker

Additional context
We need to update tutorials.

The current simple page (http://localhost:8092/content/simple.html) shows the final HTML markup (after Knots evaluation) - this means that it displays dynamic content inside Handlebars placeholders.

We need to add tips that can provide:

• content of fragment coming from the repository (which is not processed through Knots)
• list of Knots that process the fragment
• fragment context (which contains dynamic data from data sources).

Version used

• knot.x: 1.3.0

Context of the issue/feature

The example project uses Maven, We should also add the Gradle support.

Is your feature request related to a problem? Please describe.
There is no example of GraphQL usage with !x.

Describe the solution you'd like
Possible implementation revolves around using !x tasks in GraphQL data fetchers.
Requires:

• java graphql implementation (repo)
• vertx wrapper of the java graphql (doc)

Java GraphQL provides needed implementation itself while Vert.x wrapper provides HTTP handler for GraphQL.

We can implement graphql handler factory (implementing RoutingHandlerFactory) that would configure GraphQL object and return GraphQLHandler from Vertx. GraphQL schema could be provided via configuration in operations.conf (either as a string or as a path to a file with the schema).

GraphQL uses data fetchers as an integration layer. Each type defined in schema needs to have a data fetcher assigned. In the java implementation it needs to be assigned to the GraphQL object before passing it to the http handler (so fetchers need to be assigned in graphql handler factory). Data fetcher is just an object implementing DataFetcher. The idea is to have it run !x tasks. This way !x is still responsible for providing data from integrations.

FragmentsEngine (directly or indirectly via FragmentsHandler) could be used to process tasks defined in configuration. DataFetcher logic would probably be universal or almost universal. It would be better to have it universal if possible. This way there would be no need for hardcoding any connections between schema types and data fetchers.

Describe alternatives you've considered
If some genericity can be extracted then GraphQL support could be implemented in !x.

Additional context
No context, but here's a cat emoji: 🐱

Is your feature request related to a problem? Please describe.

We need to check the tutorials from sections (we plan to release Knot.x 2.2 soon):

Distribution

API Gateway & Web API

Template Processing

Additional context
Please add comments with required configuration changes - this should help us with upgrade notes.

Create tutorial describing how to setup in-memory cache in Knot.x project

acme-cluster configuration is not up-to date with master branch changes after merging #8
Update the configuration.

Version used

• knot.x: 1.3.0

Context of the issue/feature

Use Knot.x Data Bridge in the example project. It should be delivered in the Knot.x Stack. Update the sample content (templates).

Appendix

• Knotx/knotx-stack#5

After build project with Maven or Gradle bash execution script (bin/knotx) in acme-stack has CRLF end line instead of LF on Linux environment

Is your feature request related to a problem? Please describe.
The current templating example use Handlebars. We should update the tutorial to use Handlebars and Pebble.

Describe the solution you'd like
Process the page containing two snippets:

• with Handlebars syntax
• with Pebble syntax

Please note that we can simply replace TE syntax without data changes.

Additional context

• move the example assets from https://github.com/Knotx/knotx-fragments#supply-fragments