Camel-freemarker component #835

carlosthe19916 · 2020-03-02T18:47:30Z

Issue: #223

Added camel-freemarker component.
Changes:

The same test used for apache-camel-freemarker
We can add the list of locations where the templates can be found in the classpath using: quarkus.camel.freemarker.locations=myFolder1,myFolder2

Looking forward to have some feedback.

# Conflicts: # docs/modules/ROOT/pages/_partials/component-extensions.adoc # extensions/pom.xml # integration-tests/pom.xml

# Conflicts: # extensions/pom.xml # integration-tests/pom.xml # poms/bom-deployment/pom.xml

# Conflicts: # extensions/pom.xml

# Conflicts: # docs/modules/ROOT/pages/list-of-camel-quarkus-extensions.adoc # extensions/pom.xml # extensions/readme.adoc # poms/bom-deployment/pom.xml

# Conflicts: # docs/modules/ROOT/pages/list-of-camel-quarkus-extensions.adoc # extensions/pom.xml # extensions/readme.adoc # integration-tests/pom.xml

# Conflicts: # docs/modules/ROOT/pages/list-of-camel-quarkus-extensions.adoc # extensions/readme.adoc # integration-tests/pom.xml

oscerd

Please fix the codestyle by running 'mvn process-resources -Pformat'

...org/apache/camel/quarkus/component/freemarker/deployment/FreemarkerNativeImageProcessor.java

ppalaga

Thanks, good work, I especially like the test coverage. A couple of questions and suggestions inline.

...org/apache/camel/quarkus/component/freemarker/deployment/FreemarkerNativeImageProcessor.java

ppalaga · 2020-03-03T15:47:03Z

...org/apache/camel/quarkus/component/freemarker/deployment/FreemarkerNativeImageProcessor.java

+        try {
+            List<String> locations = new ArrayList<>(camelFreemarkerConfig.locations);
+            if (locations.isEmpty()) {
+                locations.add("freemarker/templates");


Could you please declare freemarker/templates as a default directly on CamelFreemarkerConfig.locations using @ConfigItem(defaultValue = "freemarker/templates")?

Could you please document the config param and the default in docs/modules/ROOT/pages/extensions/freemarker.adoc?

I've added the default location freemarker/templates to CamelFreemarkerConfig and also added some docs in docs/modules/ROOT/pages/extensions/freemarker.adoc

...org/apache/camel/quarkus/component/freemarker/deployment/FreemarkerNativeImageProcessor.java

.../main/java/org/apache/camel/quarkus/component/freemarker/deployment/FreemarkerProcessor.java

extensions/freemarker/runtime/pom.xml

ppalaga · 2020-03-03T16:29:36Z

integration-tests/freemarker/src/main/resources/application.properties

+#
+# Quarkus
+#
+quarkus.camel.freemarker.locations = org/apache/camel/component/freemarker


Given that org/apache/camel/component/freemarker will be scanned recursivelly, I wonder whether all the class files are going to get included as native image resources? I would be interesting to compare the size of the native image using this locations value and using a new path that does not contain any class files.

Only files with the extension .ftl will be included. You can see there is a filter for that here... I've also created 2 native images, the first one using org/apache/camel/component/freemarker and the second one using myfreemarkerfolder and the sizes are exactly the same (45.8 MB)

Only files with the extension .ftl will be included.

Thanks for the info, I have not noticed that and I must say I do not think we should be selecting only *.ftl files. I commonly used other or no extensions for FreeMarker template files in the past. I think many people do that because because of syntax highlighting in editors. There is even a couple of examples in this repo: https://github.com/apache/camel-quarkus/tree/master/tooling/create-extension-templates

I think we should either include whole subtrees or we should have path includes and excludes like we have in https://github.com/apache/camel-quarkus/blob/master/extensions/core/runtime/src/main/java/org/apache/camel/quarkus/core/CamelConfig.java#L74-L100 WDYT?

Good point @ppalaga . Files with different extensions should still work. I agree and we should include the whole subtree but just to avoid adding files we don't want to add we can use includePatterns and excludePatterns as you suggested. Let me add it

@ppalaga sorry for being so slow in this. I've added includePatterns and excludePatterns

ppalaga · 2020-03-03T16:32:47Z

Could you please rebase and squash your commits? It would make it easier to review locally.

carlosthe19916 · 2020-03-11T16:33:44Z

@ppalaga I've also added a new Config property called classModels which should be used to pass all Java Classes that will be marked for reflection. Freemarker uses POJOs for processing the templates but if those POJOs were not marked for reflection using Quarkus, then an exception will happen... Because of this change, I've removed this line 0e2d854#diff-d5f7db497629630202e093f916c76b9eL65 WDYT?

ppalaga

Some comments inline.

ppalaga · 2020-03-12T09:37:42Z

docs/modules/ROOT/pages/extensions/freemarker.adoc

+|===
+|Configuration property |Type |Default
+
+|`quarkus.camel.freemarker.locations`


Could we perhaps remove the locations option now that we have includes and excludes? The includes option seems to offer a superset of locations functionality. The default can be changed to freemarker/templates/** and moved to the includes option too. WDYT?

ppalaga · 2020-03-12T09:44:08Z

docs/modules/ROOT/pages/extensions/freemarker.adoc

+
+|`quarkus.camel.freemarker.include-patterns`
+
+ Used for inclusive filtering scanning of Freemarker templates. By default all tree files inside 'locations' will be included.


Plase add:

Where we scan for the templates (classpath, filesystem)

Are classpath: and filesystem: prefixes supported? Which one is the default? (I do not insist on supporting filesystem:) We have other extensions documenting similar features properly, just grep for classpath: in the source tree.

ppalaga · 2020-03-12T10:04:41Z

It would be cool if the extension could do most/all of the following tasks at build time:

Create a freemarker.template.Configuration
Parse/warmup the templates.

That would make it truly quarkyfied!

@carlosthe19916

now The tests are adapted from apache#835 by @carlosthe19916

@carlosthe19916

now The tests are adapted from apache#835 by @carlosthe19916

ppalaga · 2020-11-26T20:57:02Z

The tests were adapted in #2028 and I'd like to implement the native support using the Quarkiverse Freemarker extension. Hence closing this one.

@carlosthe19916

now The tests are adapted from #835 by @carlosthe19916

carlosthe19916 and others added 22 commits October 3, 2019 20:33

added freemarker modules

3b5d4bf

added freemarker modules

1816c73

add basic structure

1c270eb

change tests

9d9d593

Merge branch 'master' into camel-freemarker

053af99

change tests

dd55cad

change tests

c65913b

change tests

8dd82dc

Merge branch 'master' into camel-freemarker

74568bc

# Conflicts: # docs/modules/ROOT/pages/_partials/component-extensions.adoc # extensions/pom.xml # integration-tests/pom.xml

Merge branch 'master' into camel-freemarker

7d74e47

# Conflicts: # extensions/pom.xml # integration-tests/pom.xml # poms/bom-deployment/pom.xml

Merge branch 'master' into camel-freemarker

3a58ad1

# Conflicts: # extensions/pom.xml

working

da1723e

add freemarker

0d8599f

add freemarker template resources

9391b97

Merge branch 'master' into camel-freemarker

a486227

# Conflicts: # docs/modules/ROOT/pages/list-of-camel-quarkus-extensions.adoc # extensions/pom.xml # extensions/readme.adoc # poms/bom-deployment/pom.xml

add freemarker template resources

6a383de

add freemarker template resources

98ba3fc

Merge branch 'master' into camel-freemarker

46e3804

# Conflicts: # docs/modules/ROOT/pages/list-of-camel-quarkus-extensions.adoc # extensions/pom.xml # extensions/readme.adoc # integration-tests/pom.xml

create first draft for camel-freemarker

56da67f

add tests based on apache-camel-freemarker

2da1c69

Merge branch 'master' into camel-freemarker

53c505a

# Conflicts: # docs/modules/ROOT/pages/list-of-camel-quarkus-extensions.adoc # extensions/readme.adoc # integration-tests/pom.xml

remove useless files and add license to application.properties

c4859fe

oscerd requested changes Mar 3, 2020

View reviewed changes

...org/apache/camel/quarkus/component/freemarker/deployment/FreemarkerNativeImageProcessor.java Show resolved Hide resolved

carlosthe19916 added 2 commits March 3, 2020 09:42

add ASF license

e0b4e34

mvn process-resources -Pformat

7d45a78

ppalaga mentioned this pull request Mar 3, 2020

Velocity Support #837

Closed

ppalaga reviewed Mar 3, 2020

View reviewed changes

carlosthe19916 added 2 commits March 4, 2020 15:21

fix and enhance problems found during fast review

4f195dc

add freemarker.adoc

685dbaa

carlosthe19916 added 4 commits March 9, 2020 09:08

add multiple locations of templates

66560f7

remove new line

7c02725

add include and exclude patterns

1b46f16

add 'class-models' property

0e2d854

ppalaga requested changes Mar 12, 2020

View reviewed changes

ppalaga added a commit to ppalaga/camel-quarkus that referenced this pull request Nov 25, 2020

Test the Freemarker extension properly, although only in JVM mode for

9766014

now The tests are adapted from apache#835 by @carlosthe19916

ppalaga mentioned this pull request Nov 25, 2020

Test the Freemarker extension properly, although only in JVM mode for #2028

Merged

ppalaga added a commit to ppalaga/camel-quarkus that referenced this pull request Nov 26, 2020

Test the Freemarker extension properly, although only in JVM mode for

720bb66

now The tests are adapted from apache#835 by @carlosthe19916

ppalaga closed this Nov 26, 2020

ppalaga added a commit that referenced this pull request Nov 27, 2020

Test the Freemarker extension properly, although only in JVM mode for

c48e2ba

now The tests are adapted from #835 by @carlosthe19916

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Camel-freemarker component #835

Camel-freemarker component #835

carlosthe19916 commented Mar 2, 2020 •

edited

oscerd left a comment

ppalaga left a comment

ppalaga Mar 3, 2020

carlosthe19916 Mar 9, 2020

ppalaga Mar 3, 2020

carlosthe19916 Mar 4, 2020

ppalaga Mar 4, 2020

carlosthe19916 Mar 9, 2020

carlosthe19916 Mar 11, 2020

ppalaga commented Mar 3, 2020

carlosthe19916 commented Mar 11, 2020

ppalaga left a comment

ppalaga Mar 12, 2020

ppalaga Mar 12, 2020

ppalaga commented Mar 12, 2020

ppalaga commented Nov 26, 2020


		\|`quarkus.camel.freemarker.include-patterns`

		Used for inclusive filtering scanning of Freemarker templates. By default all tree files inside 'locations' will be included.

Camel-freemarker component #835

Camel-freemarker component #835

Conversation

carlosthe19916 commented Mar 2, 2020 • edited

oscerd left a comment

Choose a reason for hiding this comment

ppalaga 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

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

ppalaga commented Mar 3, 2020

carlosthe19916 commented Mar 11, 2020

ppalaga left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ppalaga commented Mar 12, 2020

ppalaga commented Nov 26, 2020

carlosthe19916 commented Mar 2, 2020 •

edited