Magento Architectural Discussions, 26 Jun 2019

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Magento Architectural Discussion -- June, 26, 2019

Description

- MFTF Tests technical guidelines
- MFTF test packaging
- MFTF tests versioning
- Voting on Proposals
- Validation of backward incompatible changes for Virtual Types
- Clarification in Backward Compatibility guidelines
- View models to be considered public API

Meeting minutes - https://github.com/magento/architecture/issues/195

A

A

The faculty big agenda today so I propose to start and.

B

B

Should be able.

B

B

B

New model type I passed or something like that, an outhouse functional test will be located in a sibling volume with the same name, the same module name and suffix watch Malta. So what it gives us it gives us a civility to package tasks separately from magenta code. It gives us this ability to separately virtualize this this task, and it gives us possibility to build things publishing without tasks install Magento with us.

B

You have. We are a child. With this, we can build our infrastructure in CAC.

C

C

Located on the same level as.

B

The other thing we would like to have this always follow this, which will make easier for us to understand where to find this test.

B

B

This type of model suggests section which will suggest us what.

B

B

Do you, if you install you work as locally, you will be able to see with what, with what magenta dish you this, as also we have I, have an idea to build a separate package which a gentle functional test product communications with this meta package will contain. Only packages with functional tasks will give you easy way to install this task for release.

B

Let's say you have an instance of 2.3 that one you want installed test for this version.

C

From white just like preserved discharge shown here, propose and don't move. Why don't move this test to the depth test? Integration of the function you will preserve? You will have the same structure. They will be component wasted, they will be in separate modules, but they it won't be mix like the functional modules and testing modules at the same level, because, like right now we have a lot of modules in the core and the number of modules will grow, because we won't try to balls and little different modules and like in addition to these new modules.

C

You will have also the functional tests, like the navigation, for example,.

C

Yeah she would keep her boat like important place. It may be like metal packages if.

C

B

Just didn't considered.

A

D

A

I will work if you'll start splitting repository to several example, one with our source insulation work and we.

A

B

C

Probably this approach also loves to have a separate repository just for functional testing new framework and because you don't need the magenta in general, you just need.

E

C

I'm not forced to do it I'm just like saying.

A

Okay yeah: what's let's move on with other questions, we want to write down.

B

Yeah from the comments.

B

This I I could just will not be installed. We are Frieza because it just doesn't make sense to install this production, environment, a systems, development environment, and you can do this.

B

Yes, sir I have also the list of what should be done possible implementation tasks that, as modules to Syrian modules by Qatar and as I mentioned on your hand, function as probably this task will be under to move this, to the other part will be a.

B

New location and updated infrastructure which will package those.

A

Don't forget to document this new type, so I had a discussion with like instead channel I. Think people are asking not in the section of the reserved for requesting the blocks where people are describing five different types of packages that we have, and you just need to make sure that this one is also added to.

A

Okay, any critical questions, not let's move on to the next topic and then we'll have probably offline discussion for this document.

B

B

Currently, working was enabled to build a huge rules for every test entity was targeted with the smallest one, which is painless sections. We have four small goals for each of this entity. First of all, first row is page. Five names must follow this pattern and we describe this pattern, which look like the page name attribute, must be the same: Paulo main module.

F

B

This vendor name underscore module name, and there must be only one page to find some simple rules which.

B

Write the same intersection only how we should name our section files, this.

B

Currently, we want to enforce it via code review, and this document should help everyone to understand with what rules we should follow and.

B

B

Entities like this, this is just the beginning of technical guidelines for function.

B

A

How much do you need, by the way you still probably a little bit about watching.

B

5 minutes, ok,.

A

So, let's move on quickly through it, because you mentioned that you need five minutes, how much time you need for each topic. We already defined that simple quickly.

D

B

I'm actually a Russian before I'm at Kiev test, and currently we have dated this document with the version increase metrics we specified which change please first, so if you had it in you, action fine are the major challenges for all entities in our tests.

B

We decided to document it this way here, because we also created analyzers for semantic version checker. If we, if everyone agrees that this this is good person, increasing metrics, we'll be able to deliver semantic version, checkout analyzers to our infrastructure and our test will have to comply.

A

Okay, thank you can follow the meat of wine or do you want to respond since we.

B

Did a quick review.

B

Please you must.

A

A

G

So the question I want to discuss today is voted on proposals.

G

This idea, like was inspired by PHP workflow for RFC voting and the problem we faced right now and this year that the problem exists is that right now we like to have one solution and one mechanism to handle public proposals, and since we want to reflect that, show community attitude to this, it would be great to have a kind of procedure of how we can vote on proposal and how community can dissipate in decision-making.

G

Sometimes like the recitation, when people have different opinions and in order to handle this, it would be good to have a procedure like this totally understand that architecture team will be responsible for this Oh approval process, but first of all, the procedure will start with proposal submission it's like it is right now, so the proposal is submitted by opening pull request to this repository.

G

Then the author must present this proposal and described problem describe the solution he is trying to resolve and after that, if there are any controversial opinions or like every like, every single idea is good, but has disadvantages. Fans was then architecture. You may consider starting oten by like an important label to this poor request.

G

We presume devoting is single or multiple answer survey and we need to enormous a valid voting period it. It should be announced once this label is added to the water quest.

G

The discussion may continue in the blue quest thread and the result. Voters can change their votes during this. What he prepared also we discussed that eligible voters are all github users. It doesn't matter what like we definitely will be attract. All of the voters, by name so after Morton, is finished despite information in the poll requests, but as the result, even if the majority ought to exist for a proposal, it like it, doesn't guarantee that this proposal will be adopted or implemented. So it always the final decision states with architecture team and to do item.

G

I added to this proposal is that we can use. Community portal was because it already has service features. So we can use link to community portal, then get help we'll use identification to user-centric. My name and an important period will finish, will just display this information who voted and results.

G

A

So one question that I have, which is still not clear for me: that's obvious voting for entire proposal, or we can see their voting just as a mechanism that can be used even multiple times or for multiple things in single proposal. I would.

G

Say depends on the proposal. Sometimes you just want to know if we need to do something or know so, it's like like binary. He responds yes or no and the case if there are few ideas how to implement and I think it's also okay to to create multiple choice. Survey to analyze those results, I.

G

Can actually add this, like clarification,.

G

F

Yeah, can you hear me? Yes, okay, cool. Can you see my screen? Yes, okay, so today, I would like to discuss another one like changing for our version and policy and in this case I would like to discuss how they going to manage our semantic question for 12 types. So far for now we have the next requirement, for you know, policy for all types, and here you can see that we're 12 tied in case we remove some dirt all types.

F

It will be my job change and in case we added in yogurt all types as this might not change, but we clear understand we're told ice, it's not the course. This is just configuration, but there is some exceptional cases, so all some exemptions. So there is some cases when we really need to follow semantic question for their toll types and what I found in our code base.

F

Sometimes we declare pool some composite object and in this case we clear understand that it will be extension point and external developers will use this extension point and in this case- and we can mark this class as API already, we have some declarations in our code base this API and, as you can see here in before section- and they have like text in this like comment in the XML API and and a bit later, I will propose another one approach: how to market so there's an exponent which food disgust accept like eliminate semantic version.

F

A semantic version policy for we've talked was accept, known and bi class next point, which I would like to discuss as like: remove unnecessary, API annotations, because some classes market as API. But if this class is I'm not supposed to be extended- and this is like configuration- and sometimes we market as API- something what we use in our.

F

So we declare add some class in in one model and we use in in decimal, and we mark this class as API I. Don't see any need to do it in our core device, because, as I mentioned before, we clear understands it, we've talked cause. This is like declaration and in in my understanding this something similar about. We have like when we use the I. When we declared dependency insist, we use a virtual class in the same way, so I proposed to remove unnecessary API annotation from some classes and the last one.

F

What I would to discuss is like change this approach and don't use API like as XML comment, but instead of introduce a new attribute API- and you can see this is here like little type and unnecessary, attribute API, not unless optional attribute API, and we can mark this class explicitly I di all right. Wait, though, I think this is better because sometimes when you change something in XML class, you can move some class heat below existing point and you can forego this API annotations and in class in case you move it Sampson.

F

Another one class will be a market as API. We don't have such problem when we use block annotation in the classes, because you really can't move quote from one class in another class. But physics mouse is easy to make this mistake and.

F

For now we we need this API attribute just for hours, we see tool, but it will be more easy to use it with any tool, because clear declarations, this is not a common, so we couldn't use it anyway, as we.

F

Other questions.

H

Everything can be confusing for developers because usually the validation doesn't mean any magic I'll. You write those wonderful versioning purposes, but it doesn't affect ecology, and in this case it might seem like if I attribute, somehow functionality of virtual type.

C

Not sure because, like for example, even in this example, we see that when we define the arguments for the build prototype, we can specify the type of argument it uses just only to recognize call to configure this argument. So for me, I'm not sure that, because I.

C

A

My pipe is used in runtime I, think I will not be used in runtime, but I think it's similar to some documentation. I put that but I agree that the research problem that you can move their child pipe from one location to another or remove it and API will be left marking now. Something else.

F

Here we can do it, but this is hard to read. You know in my ceiling, so why why they should use common sense XML. This is not like general approach, peach-pit o'clock. Yes, this is general approach. You used a bit of block argument like API is clear declaration. But what is it's here? We don't have I, never seen any agreement. What is it and this this as for me, this is more confusing than to use in a argument.

C

And other cons about moving inside, if you have like yu-gi-oh xml and in most cases like I, just swap all the all the clarification, but you just I see the name and type in this case. I will see they pay and this attribute, even if.

F

Really you don't need, because, most of the case, you will use API annotation, just for always static analysis, I mean for our semantic rationale and in case you want to reuse this virtual class inside of Magento you shouldn't care about, is its API or not about external, our external developers. They in this case. Yes, they should verify.

A

Or at least from another component, if we move to a lot, ideally it should so I'd, not familliar cell types in many cases, look like some a demo private code inside a single XML file, because how it's used you just want to configure with the class which is declared and not the card but configured in the same file. Right, that's fine! But if you mark it with API, you expected it can be used somewhere else, so somebody can look at it and use it and rely on it.

A

Right and I would say it's the say it should be the same rule for internal and external developers.

F

Yeah, in most cases, we use we've all typed exactly in the same file when we, where we declare it.

A

Ok, so any other questions like there are some wins here. So, first of all, we say that your shell types are not public API by default today, a private code by default, unless it is marked with API everybody as I understand, there were no comments.

A

What else then, then review and remove just new optional attribute? We discussed yeah. Okay, no other questions. Do we need some.

H

Previously previously, it was also the same, but the problem, not everybody, knew even if.

A

F

A

Documented because, right now it is the key multi that, with shell types of public API,.

A

Okay, then so I think about this item. Thank you. Girl, okay, I, have couple more items.

A

He's shown a screen.

A

So one item: it's actually also related to virtual farms, because I think I already started updating.

A

Okay, so I updated backward compatibility guidelines, so I looked through like based on some questions from people in the recent time, I want I, updated some items in the backward compatibility guidelines, so I'll start from those some just it was so I updated the tradition for private code, because I think it's confusing. It was written before that public API is everything which is marked with at API annotation, though private code is not accessible via the ATA classes and constants Marcus Marcus why they think it is incorrect.

A

This is the definition for teach people, but what we want to say here is that all other for this pilot or other meaning not not marked by a type while it's not the same, that is monthly private, then.

A

What do you use or change code should not rely because I demand since confusing nobody should change any code in magenta.

A

What else customization points modules, customizer request? Engine stimulation for one's models, use the simulation phones instead, I brought Richard pipes, an interface or a virtual type represents either an API or continuation who and I just left interface.

A

You just wanted to know types here, as we are discussing, because it's more our case, we used the lubrication strategies so what we had to have marking public bodies, duplicated I'm, not sure what means on the manga really so I just removed it, and what? If it's marked as deprecated, it can be remove them between in a future minor words, we don't have any specific expectations in which moment is now maybe more interesting. First, so I'm adding that a command and note that any change not listed in the table. We saw the changes.

A

Any change not listed below is considered the patch level change because, like I think this is default. Expectation I just wanted to make it more clear. Okay, we don't see changes in the table, so we're child pipe markers, I, think I know. Based on the discussion now the world there were some discussions about Ural paths. It's not very clear. I think it was not very clear why we have Europe was here.

A

I was like what what changes will affect so and which URLs are powered by this policy, so I'm verifying that URL possible for storefront and admin, and then I proposed the following, so we had removed reminder, cost parameter new articles parameter in optional. It was parameter so I'm, adding that this is from get request and those are major, major or minor changes as a phone before, though, for post request, I think this is a part. Reversion change, but I wanted to discuss it if it makes sense.

A

So from my understanding why we say that modifying get requests is a significant change, because somebody can somebody can have automation or maybe a bookmark for it as well as another module. Can have a link to another page I, don't know if we can see there, it's a normal customization that submits a form to another module, maybe things norm of them. We also need. We also should make it even problem, major change, but any opinions about this.

A

About this, one yeah.

H

Looks like you.

I

H

I

Is some business.

H

C

C

Just no question about.

I

It is not backwards. Compatibility of Quan brakes, it's good like starting point, but we can remove agenda completely and leave only index.php, which is receiving all get post requests and is it backwards compatible? Not because it is not just removing business logic.

A

I

A

A very confused based on the question with ABC people are forgetting about functional changes, that this is a separate topic and the closer should be considered one making changes, but we are talking I think this is about technical part. So, for me, major means that there will be an error.

A

The major for me means that there will be an error most likely I, don't know so. For me, a URL.

I

Is the our first level API if we change the structure of our URLs? Our regrets.

I

Not work and if we had some argument in the URL, which is doing something we cannot see.

I

It will work in a way which is not supported by.

E

Probably functional functional change was supposed to be done by the client, but.

A

If we introduce it as an optional done, there is default value for it and we cover this case, so it will be handled.

E

And achieved the processing of the URL proceed successfully, I.

A

Don't understand, if you add an optional parameter, why do you think that functionality there.

I

Is nothing about optional parameters in this statement, so let's take our Web API.

I

I believe ug about this one. We just marked.

A

So you say that removed parameter is a major on the scope. Yes,.

I

A

I

Good example is our Web API I mean panel I, think we're passing story, wizard argument and, let's imagine we just renamed it. It means nobody can specify store-specific anymore, but.

I

E

A

But what I want to say that functional change might happen even without changing any parameters right, you can go inside the code and modify behavior will lead to a function. Functional change, yes, means that any functional change should also be considered when we are setting a version. I think we are just missing this part, mostly like many people forget about it, because it's hard to validate grano tools acceptance.

A

So what I'm saying is that, for example, when we are removing an argument? Theoretically, nothing may change. For example, there was a mistake and at some point there was still an argument, but it was never used right if we remove it from a more functional change will be introduced. So is it a major change or not I? Think.

I

It's more like exception. If you have argument which was never used. Usually, if we have an argument, means that there is some business logic behind it and if we remove argument to a definite business logic and some behavior.

A

As soon as we change business logic, as soon as we make functional change roles on equalize, it will be a major change.

I

Probably but I'm talking about like different aspect of it. There is no need to have an argument if you don't have business logic and if you remove argument your business logic, this couldn't be considerate as backwards-compatible. In any case,.

I

You're talking about some required argument invited by mistake, this is not our general case, it's just mistake and exception, but if we have argument I assume we are using it in.

H

General case I, don't think we are removing argument. This will probably be also an exception. We usually extend do not shrink interfaces.

A

Yes, I, don't know. For me, technical field talk from technical perspective. Major change means that it will break something technical, it will break something.

A

Functional change is different things, so you're talking about functional change and I, don't know if we should make any assumptions. Yes, in most cases, this is.

I

We are talking about.

I

I

Interface, our interface are the arguments of.

A

What about others?

A

What about like I'm, most interested.

I

If pass was removed again for me, the resource was used. Someone else.

A

I think everything should be breaking like I put everything assuming that nobody should be submitting post request from one module to another about me. If you think this is a valid case, then it should be with major change.

H

We can because examples when.

H

It's possible that somebody.

H

Protection might be a problem for them, but tragically they can build some automation.

A

Okay, so then I'll change the tile should I use the same. The same level of change writers will get across.

A

The new optional argument is a minor change. It's in my consultant. Surely the new optional argument: it will not break existing automation.

A

A

No I think it's different because we see Li, for example, remove all. If you remove an argument house you like works, it will file if you still pass the so.

A

I can tell you how its implemented it does not take more if I think it's intentional in case somebody makes a typo, so I also know me differently. So I think it should be my job. You know what else AHA statically files. So some time ago there was complain about us moving javascript files from one folder to another, so I added a rule about that static profiles. Yes, yes, as less files removed most its major change, just successful as files file added what change you make it minor I.

C

Think here we should like to the like: we cut the J's API and become the private implementation. This rule will be applicable for all files.

A

So it's alright I'm, not sure if I didn't.

A

Okay, so we mark with API.

A

Okay, let's say.

A

Mutual types, what we had, we shall type okay, I sold, marked with I, think the I, what we had switch total considerably short type in the DI that XML file, and it was the power. This is different file. By the way this is dependences file. So it's for extension developers on shows which version they should be point form.

A

It was virtual five. If you continue, we shall fight in the XML file as a quantum dependency. For me, it sounded a little bit weird, the first way so I'm changing to use an existing virtual file. So if we say if we use existing app shortcut from Magento example, my marked with API it's you should depend on major version.

A

Submit a post request to the URL based on what we discussed, testing will be minor or major change. I will check.

A

Particular files I will adhere marked with a flag. So if you rely on any of those files, the condom major version. Yes, so that's about guidelines also I wanted to add a section somewhere about extension points just to list to them explicitly because there is a lot of text, description and explanation more abstract way. I just wanted to add some general extension points that we have in magenta. Six more visual I will discuss mr.

A

duckstein bar what will be the best place for it, but in general, I describe between the faces of Marcos at API plugins.

A

A

My Beach, okay, maybe not customizations, oh you can customize, but I think my idea was to exactly describe what what features of magenta magenta, but when you can use to the customizations. Maybe I should rephrase this and if you recall, or have in mind something else.

A

We are with this meeting.

A

It's a small one, it's about view models, but right now they are not marked respond with a thank you. I said they are not considered public API. Maybe just think about this. We can discuss later later. I, don't think it's urgent question, but I think those should be public API because they, which means that.

A

G

C

All changes by blocks and including mark view models as API.

C

Core template in the question is just a minor. It's.

A

Not it's not exactly the same, because you still have an ability to add new model, compare it to modifying entire block by adding a method. It means a few things.

A

Yes, you cannot change the model, but you can introduce new model. You have at least this people and we we can discuss how what's our strategy on on actually marking with at API. Maybe we should be marking only that minor release like 2.4 bits 0, and we should maybe we should not mark doing. Maybe we should we need to discuss so. I will move this item to the next meeting. Maybe you can just think about it. Meanwhile, it's not urgent, so we can finish this meeting c'mon. Thank you all and great discussions today. Bye.