Magento Architectural Discussions, 8 May 2019

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Magento Architectural Discussion -- May 8, 2019

Description

- Adobe Stock integration
- simplified Composer project
- insecure functions
- backward compatibility

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

A

Yes, so let's start.

B

Yes, hi everyone, yeah I, would like to present the design for Adobe stock stock integration project. Let me share my screen.

B

So can you see my screen?

B

Yes good, so we are going to start and called the Magento domestic integration project at imagine, however, we already working on design and and the basic basic functionality that we are going to start on, and here are the design overview. Basically Magento. The basic integration is going to add an ability for admin user to use assets or media from Adobe stock.

B

Right now we are talking about images from admin panel there, the UI for a double circ integration will be accessible from the media gallery, so it will be available in all the functional areas in Magento where media gallery is available. It's a CMS content, WYSIWYG editors, category image. There is no no ability to use image for product from the media gallery, however, that ability can be added to the product page and in panel there integrate we'll, be provided here. Adobe stock integration mat a package that will contain from the beginning five five modules.

B

There is an API and implementation module for the basic functionality that will be shared and reused and reused by all the following modules and.

B

Api enter them implementation models for the image integration and also a separate module for admin, UI image integration. Here you can see there that relations between the modules, basically admin, will interact with with the UI provided by the module, Adobe stock image, admin, UI module.

C

B

Will be based on Magento module, UI and UI components.

B

And that you I will interact with API provided by the core register configuration module and image. That is the configuration module. The separate flows that will be covered by the integration here is a brief overview of the flows. So basically it's search, including.

B

Include including lots of filters that are available, but in Adobe stock API, the authorization for purchasing and licensing of images, in this case we'll use the Adobe identity, identity management system that will, after ID, outfall, Tiffa, kate and after eyes, a user and then call the callback and then return the callback dollar application. That is also an api.

B

Then there will be an endpoint for licensing, an image that will be available after user is authorized and finally safe an image. Actually, there will be two separate flows for saving or downloading an asset from Adobe stock. The first blow is saving the complementary asset or a preview.

B

That's for images that have worker water marked image that doesn't require funding that doesn't require for chaser license, but it's slow resolution and has a watermark and.

B

The admin user will be also able to a license the image and download the full license to a version of their asset.

B

We are going to use the the framework provided by Adobe Adobe stock API with the library provided by the way, instead of the stock API with PHP package. That will help us to communicate with Adobe stock API.

D

Can I ask what was the reason to proxy Adobe bike through magenta.

B

Through the back end, the reason for rock scene Adobe stock API through magenta is first of all the extensibility and second, its security, because we are going to start the API key on.

B

Backhand side and will not share it to the front end and.

B

Also, you will be able to reuse existing functionality of UI components and and other components and available in magenta.

D

B

Yes, so I also have seen your question about the data storage.

B

Yeah looks like that's okay, good, so the reason to store information on magenta site is to have this information available for downloaded assets and to be able to display the image and the attributes and use this attributes result additional calls to Adobe stock API.

D

B

Yeah, it's it's! It is kind of indexing at this point because, yes, we can. We can get the information from the API. However, in order to get this information or regain it after the image was first Saved.

B

We have to store at least some basic information about this image, like media ID, to be able to identify it on on the stock side and also licensing start type status. That is part of the data that we are storing.

B

We need this information, do you mean media ID and licensing status? Yep.

D

B

Need this information to like in the situation when well, basically, within this information, to get additional attributes of the asset, if you'll need them.

E

If we caching that locally, then maybe we get a problem with if somebody cancelled their model or monthly payment, we cannot check this. Maybe we need some crunch up for that or checking for valid license, but I any information there in this paper about how this, if somebody cans their monthly payment, so.

B

As far as I understand, even if somebody cancels the subscription another beast of the images that this person, this account have already done, loaded are staying with him, and the information and data that we are storing on our site is not is not the information that is provided together. His license. It's public information that that is returned. We searched API endpoint, so licensing bait, the impart of data is only the full-size asset or full size image file.

E

Okay, but if I understand correctly a smaller version.

F

In the database or.

D

Something like a.

E

Service on front-end.

B

So, basically, before you before the admin user after eyes, Adobe second before he purchase a concrete image, he is able to store to save the preview and use it on magenta pages after he purchase in that image and license it.

B

He is able to denote the full version and and use it instead of preview or in addition to preview on.

B

As part of magenta content, but we are storing in case the preview is downloaded and saved, we are storing it on our file system may go and store it in our file system and in case licensed images downloaded. It's also start on the file system.

G

G

As I understand this functionality, it will have a UI with a lot to insert image in a busy week, for instance, and like shown here, but there would be also you I said: Buddha love to upload new images to purchase. You need images to licensed images right.

B

Yeah, so basically the UI that that will allow to download the image from this from the screen that you see right now on the page is just a button that user that admin user will present. The image will be inserted to media gallery. Media gallery is behind the slight window shown on the on this demo and in case of licensing, it's also an additional button. That's that, from a user point of view, does exactly what almost the same. What download preview button does, but it's it.

B

He uses the after iced account on my Adobe stock to download the full version and decrease the amount of credits that, after ice teaser have on.

G

Ui and after the service, this would allow us to maintain stock integration.

H

Separately from my channel.

G

Yes, but still this extension.

G

Will be trying to send some voltage to the direction where we can release new functionality independently from jet. This looks to be very similar. This is target mega, targeted, deviation, target integration, also original / supposed to be a Magento extension and well what it does in just in admin. You can manage some entities API in target, then you have on the storefront. You can see product recommendations, so this looks a little bit simpler than targeting, but this target we decided to move it to a separate service to be able to maintain an.

H

Adapter to communicate with API and like admin, UI.

G

G

We would be able to use.

H

Because it's like cannot afford me.

G

Maybe maybe, when you place this button it would it would open iframe this.

H

Service but anyway, you.

G

But I don't know if it makes sense for I'm just asking the question, but it can be the part. It would make sense when we can make this extension in Magento, very small. That would not have to change when we need to make changes to this functionality. So if we can make if we can implement our other functionality in this resonant in Magento, there will be just a genetic proxy, for instance unfree iframes, the lordís functionality and, and that logic was it.

G

What would never have to change it and it would make sense to implement it as a service. If we will have worship in most places, it would have to maintain them, probably doesn't make something: I meant it as a source. In the case of target integration, we we were able to move almost all of them back in part to a service, which was the part that would most likely change, and the only logic said what was part efficient extension was just some clue quote that was won't.

G

You see, ie in magenta and proxy calls from from admin to target service, and some I.

A

B

Want to add a comment in this case. We decided to implement it in magenta without an iframe, because, like Adobe stock integration is actually Adobe. Stock. Api is actually that third-party service that provides the images, but we wanted to reuse the Magento UI components functionality. In this case, we are going to implement the UI based on your list in UI component through magenta basic magenta, I agreed that grid will be slightly customized customized in terms of we're going change.

B

Maybe some templates remove headers from it and introduce several new column types, column, UI components for listen to use. We are going to deliver these.

B

This UI component listing and columns that will unable to render greet for images like you see on the screen: UI module to magenta module, UI and reuse them in the extension that we are going to implement.

B

This is filters, filters, components, filters component of listing UI component, and here we are going to to use it for like to mop the those filters to Adobe stock available filters.

F

Just social by keyboard is very limited and they provide rich variety of filters. Yeah.

B

Yeah we we will be. Actually. This is a brief introduction. We have more detailed design, documentation on Adobe stock integration wiki, and you will have several filters like the image type by.

B

Filter by color and so on, like I'd, basically.

B

Considering the search design, we are going to implement the request builder that will map the filters coming from the UI component to the request totally stock API. That will have an ability to extend the number of filters.

B

So, basically, we are going to implement several filters from the beginning of the project and then the builders can be extended by injecting them them into the configuration of the request builder to mop it with the API and to the to display on the.

F

B

Think, no because we would like to would like to make the integration as easy and lightweight as possible for the admin user, so that everything can be done on magenta and there is no need to navigate out of Magento admin. Panel interface.

F

In case you completely.

F

Okay, so they don't have all features. If you need mortgages, you just navigate.

B

Yeah, so, basically in in our case, the whole idea of the extension is to use the content. The content from the Adobe stock. Those ad is to open the CMS page right, put the cursor in the WYSIWYG and easily just opened the Adobe stock search, find the appropriate image and, with one click of a button, add this image to.

F

You can see.

A

So, thank you. Thank you for the presentation.

B

Yeah thanks thanks for attention. Please contact me: if you have any questions, I will try to answer them, and so I will be thankful for any comments as well.

A

A

So, what's the.

A

And this is how all those definitions here, the problem with that is, it becomes difficult of great magenta, because you cannot on their great version of magenta product. You also need to go and share the dependencies here, because they may be conflicting and also another problem. Is that some sections- they just don't don't belong to this project, for example,.

A

Specific packages that provide those files, so, for example, if you need to change something or something else, you need to change it here, which doesn't make sense, so my proposal basically is to simplifying it to this.

A

Let's just permissibility of the document more details on how exactly I came to this specific, but this version will be pretty simple: I propose to have a template for the project.

A

Addition can be substituted by the publication tool version also.

A

That's basically it so it's very simple. Every time that project owner needs to update you jump to anything require desktop version. If there are any project, it will be responsibility of the order to maintain those.

A

So what are the specific changes that I propose? First of all remove anything because.

A

Those things are not.

A

A

We need to remove those parts and components Pacific.

A

Which is much simpler, any.

I

Yeah cult related to this, so let's say we have right now.

I

So the first one is for contributors, the second one again, let's sign the developers users, the second one is somebody who issued an agenda on production and extension. So we understand for poor, contribute with the use get with this proposal. This is for production only and what about extension developers so.

I

But this doesn't.

A

A

We can have probably separate project but again the consequence is.

E

Yeah but the most projects working like we have asking git or github for give me version, 2.2 or 2.3 and installing them on a container and then reinstalling our extension and run the test of our integration. If we clean up this, it can be good for our most project but for extension developers working process like you have a you: ask: guitar pay in Sami 2.2. If all dependencies are grown, the integration tasks and be complex, I think.

A

So you don't need to do the same thing.

D

This changes breaking changes for integration scenario, because if we currently have some deployment scenario and use magenta like composer install, require a create project, these dependency and just a currently put what in a vapor coat. So these changes will break this scenario.

E

Also, how we can make sure if somebody installing this kind of dependencies, because currently and I, think some agencies run also static tests on their CI over installing tough dependencies. How we can make sure we get the correct versions of each def dependencies for the correct magenta version. We need some extra meta meta packages or something like that to make sure we can install the like the same dependencies for local development and checking the code on CI, and then we deployed the stuff on tests or reaction. Then we don't need the dev dependencies part.

E

If you have a complex CI, it breaks I think also. We cannot make sure to get the correct version of Megantic coding standard, get the correct version of PHP CS get the new piece and.

A

Second, the transition between.

A

This is the one to run.

E

Yeah, it's mostly yeah. We have different developers and CI system and yeah. We we using installing the dev dependencies and running tests over from PHP or something like that outside of own projects, but we using the dependencies from Magento. We have outside of our projects a composite chasing with chrome or some additional CI stuff, and then we using internal dev.

F

Dependencies from again to to running static test code.

E

F

E

And we already using and just change the break, our mostly all new projects from us.

A

Okay and so yeah, one of the questions. How do you know.

A

Production I.g: oh you shouldn't have this dependence.

F

A

Production you just.

A

A

What we do right now is upgrades right now.

A

And find you match up this project.

A

I

I

I

Everything that you need for a system, including MST of this packages, including in quantity framework for test etc. So if you want to have this, you stole everything. If you don't want to, we just skip down dependency, probably not a package with all of the test frameworks packages.

A

A

Yes, this one is.

A

Okay, so we can still.

I

Sometimes it's ready to coding standard. You have a proposal from community like to add some which be native functions to the list insecure or to.

I

To add something to discourage to list, shall we discuss all such questions? You know architectures meeting or how we can handle this, or do you think the first question.

I

Okay, so we have a proposal, two options.

I

So the the question is: should we have Jason to the list of insecure options.

D

Actually is, you should not add to thank secure because it's not about security.

D

But I agree that we should avoid to use JSON, encode and decode mottos.

D

D

I

I

I

I

A

I, don't know, maybe you will be sending it somewhere.

A

D

It makes sense to spend some Sarai's of link to other system which can secure and sterilize it.

D

Their possible scenario.

D

If you decide to enter an external system that NPP I use some PHP sterilizes.

G

In the news, HP functions directly.

D

Remove it from insecure to the list of.

I

Like and I buy the list, this huge list of.

A

Because it's 90 as well.

I

As Sarabhai script.

I

I

H

Does this like JSON encode functions will become forage on the court or just for models and framework like to be include our tests for scanning.

I

In case, if insecure, yes, all of the files in case of the list of discourage the connections, we skip test files, yeah.

F

A

Okay, so you have a yes.

A

Okay, good anything else.

G

It's about it's about because.

G

G

We it's a template, HP.

G

Technology so he had a new parameter that will be available in the template yeah this PRS skipper, so the skipper is a variable new variables that will be available. It's a template just like.

G

G

Would not break.

I

G

Extensions but.

G

Technically this is but particle change, because extension depends.

G

And you start using this escape variables and extension will not be compatible with previous budget releases. We currently don't.

G

Work in this case, but I guess, my question is like dude wrong agrees that this is backwards, but you go change and they make sense. It will be.

G

F

Every thought this is not change.

F

The same as I knew it.

C

How many currently files.

G

But it's always very.

G

D

You need to discuss, maybe, instead of it variable to complete, we can extend our template. You can join and provide additional way to escape variable because once they want the problems that granting it don't escape by default,.

D

G

Possible solution was generation code generation for the templates, where you would parse templates and Rob our output in escapers, tml and save.

G

Scheme and the.

F

Other option was introduced.

G

Other rendering engine awake week that was better solution that we decided to not to do it because it would increase complexity of magenta. We use the already kappa / HP HTML template just start using. Even if you.

F

Know how to implement how to you know.

F

Yeah automatically, as you see you know, in most cases you can skip.

G

It, but in some cases,.

G

You will have to maybe, if you know.

G

Yeah, it means that you cannot do it gradually.

F

If you neighborhood automatic before the core system, you may just get box with you. Yes, don't go through everything.

A

Maybe just okay I guess: that's all.

A

Thanks everyone for joining and see you next time.