Hygienic errors for connectors with tls configuration sections

[darach]

Problem

Bad configuration for the tls field in connector configuration such as:

"tls": "true" // should be a boolean not string encoded

Resulting in the confusing termination and error:

2022-09-23T07:16:29.206050376+00:00 ERROR tremor::server - We are SHUTTING DOWN due to errors during initialization!
Error: An error occurred while loading the file `/etc/tremor/config/main.troy`: Error deploying Flow main: data did not match any variant of untagged enum Either
We are SHUTTING DOWN due to errors during initialization!

This is not hygienic and is bad user experience.

Possible Solution(s)

Provide a hygienic error when "tls" is neither bool nor a valid tls record. The check should be coded defensively
and applied to all connectors that have a tls section.

Note

Discovered by a novice tremor production user and the error was very puzzling for them!

[vishal-chdhry]

/assign

[0xquark]

Hey @darach and @Licenser, I came across this issue and it caught my attention. I would love to contribute and work on it. Could you provide more information and guidance on where exactly the check needs to be performed?

[Licenser]

Heya,

sure thing, a fair warnings so I think the issue got miss tagged it's probably not simple or small.

The underlying "problem" here is that when we parse the definition for the TLS configuration serde doesn't provide a helpful error. To be fair it's not serdes fault either since it doesn't know the context which is what makes it so tough

Error deploying Flow main: data did not match any variant of untagged enum Either

kind of doesn't provide much information to the user.

I'm not 100% sure how to handle this to be honest so it'd require a fair bit of R&D to come up with a solution.

That all said if you're up to jumping into something more complex happy to help :)

[0xquark]

Hey @Licenser, I am currently working on another issue ( stdlib url one ). I'll like to give this issue a try once i fix the one which i am working on. Thanks for the information :)