Issue-143: Implement Pretty Printing

[manstis]

See #143

[manstis]

Hi @SlyngDK IDK could you please approve running of the workflows?

This would make use of your extension easier in development environments where a formatted log output is handy.

Thank-you.

[manstis]

Hi @SlyngDK is this PR of any interest?

[manstis]

Hi @SlyngDK is this PR of any interest?

[manstis]

@gastaldi @gsmet IDK if this PR is of any interest?

I don't get much (erm, any) reply from @SlyngDK but I see you've both been involved with this repository over time

(and you're RH!)

[SlyngDK]

I remember i tested, but was not formatted pretty as expected, maybe only one of the formatters. Also the testing not check the pretty formatting is done.

[manstis]

Hi @SlyngDK

not formatted pretty as expected

"pretty print" is only supported for JSON

the testing not check the pretty formatting is done

The tests do check the if "pretty formatting" is done. See the change here.

See PrettyPrintingJsonProviderJsonbTest and PrettyPrintingJsonProviderJacksonTest.

[manstis]

As an example.

Test (the most complex in the suite)
assertEquals(format("{\"key\":{\"field1\":\"field1\",\"field2\":2389472389}}"), run("key", new TestPojo()));

KeyValueStructuredArgumentJsonbTest.testKeyValues() returns:

{"key":{"field1":"field1","field2":2389472389}}

PrettyPrintingJsonProviderJsonbTest.testKeyValues() returns:

{
    "key": {
        "field1": "field1",
        "field2": 2389472389
    }
}

[SlyngDK]

I don't like the way the test is created. And the test should not format the output, because what are you then running your test against, not the output of the actual JsonFormatter.

[manstis]

OK, fair enough.

I had tried to keep duplication to a minimum.

The JsonGenerator in quarkus-logging-json delegates "pretty printing" to their underlying JSON library and as such the format for the pretty printed JSON differs between the two (line breaks, indenting and spacing). I added the format(..) method (and related code) around the expected value so that the test could format the expected value with the underlying JSON library thus avoiding duplicating the literal values for the different JSON libraries.

I've added a new commit removing that and duplicating the literal expected values for each JsonGenerator.

This is your project and I respect that. I missed being able to "pretty print" when using it so thought I'd try adding the missing implementation. I'm happy to adhere to your requirements, guidelines etc. I think having the missing implementation remains a useful addition.

[manstis]

@SlyngDK Would you like me to make any further changes?

[manstis]

Closing.

It seems this will never be merged.