Configuration for report file location

[nderwin]

• added runtime configuration to enable / disable building the reports
• added source (.jrxml) and destination (.jasper) paths for the reports
• ignore another NetBeans specific file for git

Signed-off-by:Nathan Erwin [email protected]

[melloware]

in \runtime\src\main\resources\META-INF\quarkus-extension.yaml make sure to add the config line below now that we have configs.

config:
    - "quarkus.jasperreports."

Full example

name: JasperReports
description: JasperReports is an open source reporting library that can be embedded into any Java application.
artifact: ${project.groupId}:${project.artifactId}:${project.version}
metadata:
  short-name: "jasperreports"
  type: "test"
  keywords:
    - "reports"
    - "reporting"
    - "pdf"
    - "excel"
  categories:
    - "miscellaneous"
  config:
    - "quarkus.jasperreports."
  status: "preview"
  guide: "https://docs.quarkiverse.io/quarkus-jasperreports/dev/index.html"
  icon-url: "https://raw.githubusercontent.com/quarkiverse/quarkus-jasperreports/main/docs/modules/ROOT/assets/images/jasperreports.svg"

[nderwin]

in \runtime\src\main\resources\META-INF\quarkus-extension.yaml make sure to add the config line below now that we have configs.

Done. Now, to figure out why it's not adding the config to the generated docs. The "Writing You Own Extension" guide makes it sound like you don't have to do anything but add the config class(es).

[melloware]

You should not have to do anything
run mvn clean install from the root directory?

[nderwin]

#99 (comment)

@gastaldi I do the same, use a Maven plugin, but the purpose of this is to roll that into the deployment, though I'm not sure I'm producing the correct build item as I'm not getting a .jasper file to show up in the target directory or the .jar file.

[gastaldi]

Perhaps we need a processor producing a CompiledReportBuildItem with the path to the compiled jasper? Just thinking out loud

[nderwin]

@gastaldi Ok, I'm stuck. I tried writing the CompiledReportBuildItem, but then a build step has to consume it, and then do what with it? I just can't get it to output a .jasper file into the target directory someplace, or the .jar, and it's probably something really simple that I missed. Right now, I'm using a GeneratedClassBuildItem like what is being used for the native output.

[melloware]

@nderwin i think I can help with this. I will look tomorrow.

[melloware]

This is just pseudocode i didn't test it but to save to the output target directory the .jasper file.

@BuildStep
    void compileReports(ReportConfig config, List<ReportFileBuildItem> reportFiles,
            BuildProducer<GeneratedClassBuildItem> compiledReportProducer,
			OutputTargetBuildItem outputTarget) {

        Log.warnf("Found %s report(s) to compile? %s", reportFiles.size(), config.build().enable());
        if (config.build().enable()) {
            // TODO - only compile if the report file has changed
            for (ReportFileBuildItem item : reportFiles) {
                String outputFile = item.getFileName().replace("." + ReportFileBuildItem.EXT_REPORT,
                        "." + ReportFileBuildItem.EXT_COMPILED);
                String outputFilePath = outputTarget.getOutputDirectory().get(Path.of(config.build().destination().toString(), outputFile)).toString();
                Log.warnf("Compiling %s into %s", item.getFileName(), outputFilePath);

                try (InputStream inputStream = JRLoader.getLocationInputStream(item.getFileName())) {
                    ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
                    JasperCompileManager.compileReportToStream(inputStream, outputStream);
					// might have to reset or reload the input stream if its a bytearrayStream you can call reset
					JasperDesign jasperDesign = JRXmlLoader.load(inputStream);
					JasperCompileManager.compileReportToFile(jasperDesign, outputFilePath);

                    Log.warnf("Compiled size is %s", outputStream.size());
                    compiledReportProducer
                            .produce(new GeneratedClassBuildItem(true,
                                    outputFilePath, // TODO: this is supposed to be the class name ??
                                    outputStream.toByteArray()));
                } catch (JRException ex) {
                } catch (IOException ex) {
                }
            }
        } else {
            Log.debug("Automatic report compilation disabled");
        }
    }

It uses the OutpputTargetBuildItem to get the target directory and then you have to write the Jasper compiled file to that directory.

[nderwin]

@melloware Yes, now I have generated .jasper files. Needs some more cleanup, but this should be ready late today, and then it can be iterated and improved upon.

[melloware]

Awesome!

[gastaldi]

You need to call outputFilePath.getParent() if I am not mistaken

[nderwin]

I did try that at first, but it didn't work right. This one puts the output directory where I wanted it to be.

[nderwin]

@melloware This is so close... just barfing on the native tests if you could take a look?

[melloware]

Have you merged all my latest changes from main?

[melloware]

Oh I bet I know is it trying to compile on build? You can't compile in native mode so you have to add a LauncHMode check to your build step so it doesn't happen in Native mode.

[nderwin]

Yup, has the latest; I'm not as familiar with native mode (haven't needed to use it), but I thought we'd be able to use the output of the compile step to feed into whatever native mode needs?

[melloware]

I will take a closer look tomorrow.

[melloware]

This is the issue. You can't compile in Native mode that is why this check uses the .jasper file and not the compiled file. It checks if it's running on Native mode. You need to put this back.

[nderwin]

compile doesn't actually compile any more, it basically does what line 25 is doing - loading the previously compiled .jasper file.

[melloware]

Found the issue. You need to put the code back the way I had it because it runs the integration tests against the native build and that absolutely cannot compile.

[gastaldi]

I will take a closer look tomorrow.

Wow, your days are really short :)

[melloware]

I am seeing errors in the log saying "src/main/resources" is invalid. Like it's not actually compiling them?

[melloware]

@nderwin i am going to merge this and work on a fix. Its easier for me to figure it out working locally.

[nderwin]

@melloware Ok, let me know if there's anything I can do to help.