Magento Architectural Discussions, 9 Oct 2019

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Magento Architectural Discussion -- October, 9, 2019

Description

* DB Information Schema - COLUMNS
* GraphQL schema for product compare

Meeting notes - https://github.com/magento/architecture/issues/316

A

Hi everyone, its sexual discussions meeting, so have some on topics today. First one is declarative. Schema proposal is to add on operation constraints, I.

A

B

A

Is about database information schema.

A

Information schema basically allows you to brief metadata about tables, combs and other entities and database. So.

A

Here I'm describing interfaces, tables tables and cones, so Wood Wood is proposed to AB separate, separate class actually for entity so for table, which includes schema name and.

A

Then we have also some specific classes for each type of column. The proposal is to you, have a class which is just a data object for each type that we want to support right now. It's like it's just an example, and we need to go through all the types and.

A

The child child at objects provide more specific information.

A

And then we have column provider and type interface which basically gets list of columns. If you provide table name and connection name and similar thing for table provider interface.

A

Any concerns so far.

B

No concerns the one creation in connection name be optional,.

A

B

This case we'll be able to fall back to default connection.

A

A

But the question is.

A

Require I'm asking because from one from one side it will simplify client code from another side. It's my those issues when people just forget that there is connection name parameter and they will not just they will just omit it.

A

That's what's already happening in Magento in in places where you can skip connection as an argument. Sometimes people do that and then we have box because default connection was used.

A

Many other opinions.

B

A

B

Maybe one more and also regarding connection NV, configure configure this object, this connection, okay, set it maybe explicitly, but do not use this, don't use it in in a code like instructor argument for four columns class, which will receive a connection name.

A

Mmhmm yeah, actually a question already I'm thinking. No that then it will mean this class will not really as a service clause, because you have to create multiple classes so like a class. / cannot not cross an object for connection right.

B

Maybe it's fine, we don't expect a significant number of touch classes, but.

A

It will complicate the cold like how exactly.

B

I believe that.

B

In case, we always will have to specify one more argument or for metadata call see, it will be more visible complication. This is just my personal opinion.

A

Yeah, okay, I have this question.

A

A

Examples of client code see I think it's better to keep it in the method explicitly. But let me write everything down and even discuss any other questions to this part.

A

Is no question so then another significant change, I think is such thing as profile that we want to introduce. So basically why we are doing what we are introducing is because different database engines, different databases.

A

Likely provides different implementation or metadata even already right now we have different results from.

C

A

C

A

Example and we need to solve it via the different implementations on the HP side, so like we get information from database and then we parse it differently. So how we want to solve it is first, is that we are breaking down. We provide the small interfaces like one separate columns on the protected face for table information, and so then we can have specific implementations if there are any differences in different databases.

A

So we propose to introduce the profiles which would be render and version and.

A

We can declare them.

A

A

Name of the file and.

A

A

A

A

So those are decorations of different profiles that we support and then the idea is that during installation, Magento installation Magento tries to determine which database is used for specific connections.

A

It happens for each connection that is specified by the user, and we try to figure out which profile we can use for this also also, it should be possible for for a user to specify a profile in case we determine it incorrectly or maybe we just cannot to determine if you cannot determine we fall back to default profile, but if there is profile specified by the user, then we just use that one profile will be stored in and HP together with each connection, so after magenta is installed in all of each profile should be used for each connection and I believe we can use the model field that we use right now in the in the connection configuration which is my signal for right now and then.

A

Instead, we can specify normal file names that make sense and, like my sequel, 4 is just something some information that is repeated everywhere.

A

D

A

What this approach may be was not very clear free to ask questions.

A

B

It's for me, you.

A

Can feel free to review it in your when you have I'm still here so I will update question about connection name, and my big question is whether this part about profiles can affect anybody. So is it possible to introduce it in 2.3 or it may affect somebody, and we need to write.

A

It should not, theoretically affect people, but I, don't know if somebody can, for example, reach and the pitch be directly and somehow rely on this model that is as far as Mexico, for maybe I should just use different.

A

Yes, that's that's.

A

Some alternative approach is about different adopters, but the idea is that we don't update an adapter itself, but we have something on top of adapters to get the metadata yeah. That's all my topic is next.

A

A

Let's go through other topics and if you still have time we can go back on update question. Let's move to Aleks topics.

D

Today, I'm going to cover couple of key schemas, which we are planning to add, so one of them is for product comparison.

D

It is pretty simple schema and it follows the same patterns that you have for card, a shopping, cart for guests. We will have to create compare list, and basically we will use this ad as identifier of compare list and you can work with it after that. For customer we will query existing compare list and the separation should work the same as card. If compare list doesn't exist yet anyone will be created and returned to the customer.

D

If the risk compared list already, it will be yeah, so it will be returned and at the moment we will have at product compare list and a list of excuse to be added, and in response you get output, which is just a rapper. His field called compare list, and then each item is contains. Compare list ID and a list of like array of products, product interfaces.

D

And you can also request, compare lists by comparative study, so what I'm looking at right? Now, probably, we also need to have removed from compare list because forget this easy to generate new one, but for customer looks like it is not possible. So I'm, sorry, you have to add one more mutation to remove items or clear, compare list, but so far we have dissipations.

A

Existing operations.

A

So for customer or customer creates comparison, is it just to get cup Farley's? Yes,.

D

Yeah it'll create if it's me, if.

A

It doesn't, at least for master.

D

A

Looks completely confusing like this mutation there is this mutation create comfort least, it will be quite accessible, I suppose.

D

We will just throw in as we plan to do in carton. Why.

A

Do we have different I just looks really confusing yeah.

D

So, basically, if, for example, follow this approach for customer, then device device sharing, we won't work. So if customer starts his comparison on laptop and continues on mobile device, he will have to start from scratch. This approach allows sharing between devices.

A

D

D

B

D

Cause for car that doesn't work as car should be definitely shared between devices and for comparison. It is not as critical.

A

A

We are both available.

A

Another concern that they have is that as a customer, you need to do two queries in order to get product control released per customer.

D

That's correct, but it is the same issue is unification of flow. We can do two separate flows, but in this case client-side developers will have to use different approach for this, and basically rotation will be also restrict. If you do that, let's forget. Compare this lady is always required for customer. We can make it optional, but then you'll have to move more logic to resolve.

A

And then why do we need unfairly stating product.

A

D

And and item is more product reviews.

D

So, first of all, sorry, first of all reviews field is added to customer. So if you are in customer account, you can fetch reviews for from your account and this field reviews will have pagination basic pagination same page, size and required page ID, and in response you will get product reviews object which contains items and pagination information. So items are individual product reviews, array of individual product reviews and find you. So this is individual product to you. It contains reference to all product being reviewed.

D

It contains review summary or title the actual review, content or review text, customers nickname and it will default to customer name if he is locked in then created at average rating written is those stars which you can see on reviews and average rating means average between. So you can probably remember that we can. We have feature which allows you to rate product on different parameters, will say price or quality, or something like that.

D

So you can have multiple ratings for single review, and this average rating is just calculation, like average, between all those different types of ratings for specific review, and then you have ratings breakdown, which is exactly those different kinds of reviews, so review rating it contains name of the review, would say, quality price and the actual socket value so really is configured. But.

D

It is actually configured in admin panel and I believe it can be set to some strings eventually, but they they will do map here are some ideas. That's why it is integer.

D

So the simplest case is when it maps to 1 to 5 writen. So you will get the quality rating 3 and then price ID of the value, so we'll say, 5.

D

Let's go back, we also have page inform page info is defined, I believe somewhere in the framework. It gives you a current page, page size and total count. So this should be enough to render each nation.

D

Additionally, if you look at so that that's it for customer account. So now, if you look at product interface, we are going to extend product interface as well to be able to display average review rating for the product. So this is star rating. On top of the page.

D

Usually it is displayed in blue might is displayed not far from product title and description, so it's like in the main section, as well as review count, so average review rating and review counts are displayed somewhere in main section of the product, and then we have again reviews which usually displayed in separate tab or separate section, and it has the same structure as customer review. So it has filtration capabilities by page size, current page and returns identical structure, as we have already discussed so now.

D

Let's move on, we also need to be able to fetch review Rajon metadata, and this is like a list of available ratings, so you can have again this quality price and something else. So you need to know what specific ratings are configured in Magento and how to display them.

D

So this allows you to render review rating form for the user. When user is given comment, you can render necessary.

D

Breakings available, so each rating will contain ID will contain name of.

C

D

Region and possible values, possible values will have an.

C

D

And they will have a global or basically display whatever it should be displayed for this specific region. Look like good, perfect, 3, 4, 5, etc.

D

And there will be one mutation, create product review.

D

It requires great product review input product through you, input contains product, the school user nickname which is which should be taken from customer, so it says default to customer name if locked in but I believe for now what we agreed and probably we need to remove the description, because it is not accurate because it's not it's not knowable, but what we agreed that client, the client application should be able to fetch customer name and insert it here.

D

Then we have review title or summary review text and select ratings started ratings, contain rating ID and value ID, and probably that and output of the mutation is a wrapper around single product to you, and this is done as usual. Folks needs ability in case some extension would like to add additional fields to participation, responsible questions.

A

Information, can you scroll up a little bit to like I.

D

A

Just reiterate what.

D

Use cases I'm going to be supported. First of all, we need lender product page and for product page in it like metadata. Yes,.

A

I just wanted to ask, or maybe to clarify so there is this int. Can you scroll down? There was like one to five for the writing.

A

A

Position in the metadata about writing because metadata includes I did, which is string and nine, or something like that, which is also string like good but bond three. What.

D

Is this in the.

A

D

No position is position should be generated on server side, so there is position for rating in the admin panel and you can choose like say if price should go first or quality should go first and as usual and Rafael we rely on server-side sorting. So this will not be read about to change from the storefront and instead we will take this second from admin panel sorted from server-side and return it sorted already. So this value is actually George.

D

I just want to I, don't want to show you lotta place, but basically, if you have two different ratings, let's say price and quality they can have values would say one through five. Each of those values.

C

D

Have different ID in database, so if this is option for one region and it's like five star for quality, do have different Angie in database than five star for price. So this ID value ID is exactly that option. Value idea like review, Reagan, ID.

D

In so this is basically generated, so this is given to you by my metadata service and what the users should do. They should just look find that metadata so which they should just look at metadata and render it as is, and so this is like value ad and and then one form is submitted.

D

Correct rel will be submitted here.

D

So user should not generate this field.

D

/ supported those cases again like quickly like grant so basically proposed schema will allow to render product page display average product rate and display review count, and, additionally, you will be able to render review submission form and provide all available ratings for input after user submits review. He can select, obviously like rate, and he can submit text, and after that you will be displayed on product page array of reviews of this patent product page.

D

Additionally, customer can go to his account and view all reviews that he left for all products so that in this I use cases that cannot be supported.

B

Maybe one do we support only one range, a one to five.

D

Now it is customizable, and so this is rating like option ideal, I'm, not sure how to code report value, but it's basically one of the options. It is also possible that rating will have multiple like more than five options or less than five options. Yeah I'm, not sure we have UI for configuring that in a panel, but we support it and database level and potentially some customizations can can use it. I.

B

Believe is this: does it make sense to change the statement possible values from one to five.

D

It's actually not one to five. It's ID.

B

D

It's a different database, so it can be yes, I said: let's say for quality: it can be five for price. It can be like nine, the actual ID, but the label will be five in both cases, like name will be five.

C

Maybe make sense to make it string instead of ID, because we want to change your ID in the future.

D

Yeah I would also like to mention that the schema was created resent on coupler and shunt. So Anton is actually architect for this functionality, but it was out that's why we started without humans and completed with anthem.

D

So if no questions- oh that's it.

D

A

Yeah I guess it's all for today, then thanks for joining.

A

If you have questions yeah.

B

Canopy discusses for a bit proposal which.

A

B

A

Mentioned little visual skills that we should do a job just.

B

Yeah, we don't have any votes for supported level, less rejected.

A

Do you want to go straight right now? Are you just think?

A

B

We can do the flame.

A

Then I guess that's all for today and thanks for joining see you next time.

B