Adds validation View and some code fixes by marmoure · Pull Request #7 · evolvedbinary/bbl-validator

marmoure · 2025-12-31T17:47:49Z

This PR primarily Adds the validation web view, but since then this branch diverted more toward the new develop branch.
Here's everything this PR is supposed to deliver:

Web UI for validating broadband label files.
Docker image for running the server.
Update the Open API specs.
Some bug fixes and code improvements based on previous feed back

PS: the review process already started up to this commit 1de92e4

adamretter · 2026-01-07T10:09:51Z

+      mock-data:
+        enabled: true
+        mapping: "/mock-data/**"
+        paths: "classpath:schemas"


Can we please rename the actual folder src/test/resources/schemas to mock-data please?

adamretter · 2026-01-07T10:11:33Z

-                    request,
-                    HttpResponse.BodyHandlers.ofInputStream()
-            );
+            try (CloseableHttpResponse response = httpClient.execute(httpGet)) {


Make variable as final please

adamretter · 2026-01-07T10:11:47Z

-            );
+            try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
+
+                int statusCode = response.getStatusLine().getStatusCode();


Mark variable as final please

adamretter · 2026-01-07T10:12:03Z


-            try (InputStream inputStream = response.body()) {
-                Files.copy(inputStream, tempFile, StandardCopyOption.REPLACE_EXISTING);
+                try (InputStream inputStream = response.getEntity().getContent()) {


Mark variable as final please

adamretter · 2026-01-07T10:13:56Z

-                .followRedirects(HttpClient.Redirect.NORMAL)
+        this.poolingHttpClientConnectionManager = new PoolingHttpClientConnectionManager();
+
+        this.httpRequestConfig = RequestConfig.custom()


You also need:

poolingHttpClientConnectionManager.setMaxTotal(20); poolingHttpClientConnectionManager.setDefaultMaxPerRoute(15); poolingHttpClientConnectionManager.setValidateAfterInactivity(15_000);

adamretter · 2026-01-07T10:17:39Z

+        .setConnectionRequestTimeout(3_000)
+        .build();
+
+        this.httpClient = HttpClients


You need to build a new client for each request - this should not be in the constructor, it needs to be done in downloadToTemp - see the https://github.com/evolvedbinary/expath-package-repository-plugin/blob/main/src/main/java/com/evolvedbinary/maven/plugins/expath/pkg/repository/ResolveMojo.java as an example

adamretter · 2026-01-07T10:18:41Z

            <artifactId>micronaut-reactor</artifactId>
            <version>3.9.1</version>
        </dependency>



If this is just an example - please remove this commit or merge it into the final relevant view commit

if you delete this commit from the history, when doing a git interactive rebase, your following commit (6540ac7) that removes this should be automatically skipped and excluded

adamretter · 2026-01-07T10:25:16Z

+    @View("validate")
+    @Get("/validate")
+    public Map<String, Object> validate() {
+        Map<String, Object> model = new HashMap<>(); 


Please mark all variables, parameters, and class fields as final where possib;e

adamretter · 2026-01-07T10:27:03Z

+    @Post(value = "/validate", consumes = MediaType.APPLICATION_FORM_URLENCODED)
+    public Map<String, Object> validateSubmit(@Body Map<String, String> formData) {
+        String schemaId = formData.get("schemaId");
+        String csvContent = formData.get("csvContent");


If required parameters are not present, this should generate a BadRequest, or if going back to a HTML page then it should alert the user to the error

adamretter · 2026-01-07T10:29:22Z

+        // }
+
+        try {
+            Path tempFile = fileDownloadService.saveContentToTemp(csvContent);


Please make sure to delete/close any temporary resources that you own once you are finished with them! e.g. tempFile here.

adamretter · 2026-01-07T10:30:05Z

  version: ${project.version}
 schema:
-  directory: schemas
+  directory: C:\Users\x\Documents\bbl-validator\src\main\resources\schemas


Should not be hard-coded to your local environment

adamretter · 2026-01-07T10:31:58Z


        try {
-            Path tempFile = fileDownloadService.saveContentToTemp(csvContent);
+            Path tempFile = isUrl ? fileDownloadService.downloadToTemp(csvUrl) : fileDownloadService.saveContentToTemp(csvContent);


Please make sure to cleanup your temporary resources

adamretter · 2026-01-07T10:32:36Z

    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link rel="stylesheet" href="https://cdn.simplecss.org/simple.min.css">
    <title>BBL Validator</title>
+    <style>


It feels to me that this would be better in a seperate .css file that is <link from here please

adamretter · 2026-01-07T10:35:15Z

+    static-resources:
+      default:
+        enabled: true
+        mapping: "/**"


Change mapping to from /** -> /static/**

adamretter · 2026-01-07T10:35:32Z

    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <link rel="stylesheet" href="https://cdn.simplecss.org/simple.min.css">
+    <link rel="stylesheet" href="/css/simple.min.css">


/static/css/simple.min.css

adamretter · 2026-01-07T10:49:24Z

@@ -0,0 +1,49 @@
+# Builder stage


You should add docker-maven-plugin to your pom.xml (see: https://github.com/evolvedbinary/elemental/blob/main/exist-docker/pom.xml#L276)

You can then template this Dockerfile, using Maven by moving it into src/main/resources - you can then use Maven Variables in your Dockerfile for the version number and anything else you need.

When you then run maven package it will also build your Docker image for you.

adamretter · 2026-01-07T10:54:05Z

+FROM eclipse-temurin:21-jre-alpine
+
+# metadata
+LABEL maintainer="Evolved Binary <https://www.evolvedbinary.com>"


Can you update these to the OpenContainer format for labels please - see: https://github.com/evolvedbinary/elemental/blob/main/exist-docker/src/main/resources-filtered/Dockerfile#L74C1-L81C61

adamretter · 2026-01-07T10:56:00Z

@@ -0,0 +1,322 @@
+openapi: 3.1.0


We should serve this as a static file, from our view page - we should have a link to view our API documentation - either "YAML"(link to the static file) or "Swagger" (link to the remote Swagger OpenAPI spec we built)

adamretter · 2026-01-07T10:57:29Z

@@ -81,8 +81,8 @@ paths:
              schema:
                type: string
                description: The CSV Schema
-        '404':
-          $ref: '#/components/responses/NotFound'
+        '400':


If there is no such resource - that is a 404 not a 400, please fix.

adamretter · 2026-01-07T10:58:01Z

-        executionTime:
-          type: number
-          format: double
+        executionTimeMs:


Fix the code not the label in the OpenAPI spec please

adamretter · 2026-01-07T10:58:26Z

          type: boolean
-          description: True if the Boradband Label file validated against the Schema, false otherwise
-        failures:
+          description: True if the CSV file is valid UTF-8 encoded


CSV file -> Broadband Label file

adamretter · 2026-01-07T10:58:54Z

-          description: True if the Boradband Label file validated against the Schema, false otherwise
-        failures:
+          description: True if the CSV file is valid UTF-8 encoded
+        errors:


Please change this back to how it was.

adamretter · 2026-01-07T10:59:05Z


-    ValidationFailure:
+    ValidationError:


Please rename this back

adamretter · 2026-01-07T11:00:30Z

      type: object
      required:
-        - line
-        - column
+        - lineNumber


Please fix the code here and not the schema

… never get it

… a new http client for each request

…atches the expected API response

marmoure force-pushed the web/views branch 2 times, most recently from a534aa6 to e14dc2a Compare January 5, 2026 12:27

adamretter reviewed Jan 7, 2026

View reviewed changes

marmoure force-pushed the web/views branch 4 times, most recently from ef83bb0 to 9ca3b38 Compare January 10, 2026 09:07

marmoure added 24 commits January 21, 2026 10:43

[feature] validation view

135cf4c

[feature] the web ui can take in remote url

fb36978

[feature] css improvments

0b94262

[feature] simple table for showing errors

ccd92a7

[refactor] code clean up

3b4e86c

[feature] clean up the error message from the vlidation results as we…

05a461d

… never get it

[feature] let the user know if the file is not UTF-8 valid

55f3d03

[feature] include utf8 flag in tests

f0f01ab

[feature] docker image

c28fa00

[feature] open api specs

0b88db0

[bugfix] improve open api specs

4dcfbce

[feature] introduce maven docker plugin

9c2b950

[bugfix] mark all possible final variables as final

6faf892

[feature] improve poolingHttpClientConnectionManager config and build…

ab53721

… a new http client for each request

[feature] clean up resources once the valdiation is completed

65ddd8f

[feature] move inline css to external file

1cbf015

[feature] match the file path to the micronaut serverings

13461da

[feature] show the api docs in the html view

a9ec61b

[bugfix] Return 404 for not found schema id

32d913c

[bugifx] fix docker issues

87cdd60

[bugfix] Fix OpenAPI specs spelling mistakes and make sure the code m…

6f9726b

…atches the expected API response

[feature] mont the schema dir from disk

f169257

[bugfix] fix viaraible names in the velocity view

0fb61a2

[feature] instruction on how to run the docker image

6f04bd2

marmoure force-pushed the web/views branch from e860bc0 to 6f04bd2 Compare January 21, 2026 09:43

marmoure mentioned this pull request Jan 21, 2026

Add a comprehensive readme to the project #9

Merged

marmoure changed the title ~~Adds validation API route and view, tests~~ Adds validation View and some code fixes Jan 21, 2026

adamretter approved these changes Jan 21, 2026

View reviewed changes

marmoure merged commit fb8a86b into main Jan 21, 2026
1 check passed

marmoure deleted the web/views branch January 30, 2026 11:49

Conversation

marmoure commented Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adamretter Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

marmoure commented Dec 31, 2025 •

edited

Loading

adamretter Jan 7, 2026 •

edited

Loading