Request Validation

[aneeshsharma]

As discussed earlier in #12, divided the models among API and DB models

• Added API models in internal/models/api/
• Moved DB models to internal/models/db/

Implemented some basic validation for a Create Queue request

• Implemented Validate method on CreateQueueRequest
• Right now it just checks the length of QueueName to make sure its between 4 and 20
• Return a 400 HTTP error when the length is outside this range
• Also return 400 HTTP error when unable to parse the JSON

Next steps would be to

• Move Parsing of JSON to middleware
• Move Validation to a middleware

I need to look into how to proceed with implementing middleware in such a way as to have the parsed JSON passed down to subsequent middlewares or the handler.

[aneeshsharma]

I started working on implementing a middleware to decode the JSON into our model. But kind of hit a roadblock. I don't think it is possible to implement a single function that can decode all requests into corresponding models since golang doesn't support generics.

Since we cannot decode the request into the API models, it is not possible to use the Validate function as it is right now.

I was thinking that we can instead use map objects as requests instead of models for all requests. Then inside the handler we can just extract data from that map. The validator can just check for the kind of request and validate according to that.

The other way would be to decode and validate inside each handler itself. Although I don't think it will be useful since we will have to implement a separate Validator for each request anyways.

I would say the map approach would make things more simple in all other areas except validation.

What do you think @daltonfury42 @maaverik ?

[daltonfury42]

I see. Can I get on a call with you and then we can try the middleware approach together?

I see some support of generics, we can see if it will work: https://go.dev/doc/tutorial/generics

[aneeshsharma]

As discussed with @daltonfury42 over call, we should go for decoding and validation of request body inside the handler itself as other approaches are unnecessarily complex specially given the small number of handlers.

[maaverik]

Could you resolve the file conflicts pls?

[aneeshsharma]

Resolved conflicts with main

[maaverik]

Thanks for the PR!

[maaverik]

@daltonfury42 any idea why the status checks aren't running here?

[aneeshsharma]

I was thinking it might be waiting for the 2 reviews to be completed before running checks.

[maaverik]

I'm pretty sure that's not the issue, the checks normally run as soon as code is committed to the PR. I thought it might be due to a setting I had added to make sure the code is up-to-date with main on each PR, but I tried disabling that and reopened this PR (that shouldn't have caused a problem anyway since you merged with main), still nothing. I'll spend time later and try to figure it out, else we'll skip the checks this time.

[daltonfury42]

My guess is that it will not run against these commits from other action. It's either a bug or some feature to stop infinite loop of commits or maybe a security feature for some sake.

@aneeshsharma can you try adding some empty/random commit to unblock.

Or maybe the commits by an action doesn't qualify as a push.

[aneeshsharma]

The checks work now. @daltonfury42 Can you please review the changes?