[RFC] Blitz App Architecture

[flybayer]

Woohoo! Finally a draft for the architecture RFC! Let's make this as good as we possibly can before posting publicly!

View Rendered

[merelinguist]

What are the benefits of react-query over, say, swr?

[flybayer]

@merelinguist good question!

Their docs do a good job of answering this. Click on the "How is this different from Zeit's SWR?" toggle that's just under the Quick Features section.

We don't have to use react-query. We can use anything that does what we need or even write our own.

[rishabhpoddar]

Seems awesome! For middlewares, we should allow for the following:

• Apply one middleware to all or a few APIs
• Allow for arbitrary params (along with req and res to be passed to the middleware). If present, the extra params must be passed on a per API basis.

One use case of this is for authorisation. We can create a middleware that takes req, res and requiredRole as an input. If the user calling that API does not have that requiredRole, then the middleware throws an appropriate error. So here, we want to be able to specify, on a per API basis, what the requiredRole is, and we also want some APIs to not use this middleware.

Now even if the above example is not how authorisation will work in Blitz, there could be other use cases for this kind of behaviour. NodeJS allows for this level of control as well.

[rishabhpoddar]

We should define what the various default properties are in the Context object vs in the req object. For example, in the Context object, we will have an optional Session object while in the req object, we will have the request URL and headers.

If a user is creating a middleware, how should they decide is something should go in the req object, or Context?

[rishabhpoddar]

We should also define how the user can do database transactions. This is important since any serious app will require many transactions in them. One more important aspect of transactions is to also be able to specify the isolation level on a per transaction basis (the default one works for most cases).

[flybayer]

@rishabhpoddar great thoughts!

But can you please post all those in the public RFC instead of here in the drafts repo? Then everyone else will see your comments and can chime in too! :)