[Improvement] Bundle Config

At this point, Magepack doesn’t support a custom config for bundles. Ideally, it’s needed to be able to define bundles as complex Magento builds have more spaces than CMS, Product, Category and Checkout. With the current config, all those custom pages will be broken which makes Magepack impossible to use on such builds.

I would add a config file where I would define bundles and URLs which are included to them like this:

magepack.config.json:

{
    "bundles": {
        "cms": {
            // possibly other configs
            "urls": [
                "/homepage",
                "/404"
            ]
        },
        "category": {
            //...
        },
        "product": {
            //...
        },
        "checkout": {
            //...
        }
    }
}

As a result, the generate command would take baseUrl, httpAuthUser and httpAuthPass as a param.

The backend part (https://github.com/magesuite/magepack-magento) seems to be flexible enough to support custom bundles. Just need to adjust the generator.

[krzksz]

Alright, so I would like to summarize my take on this request.

First of all, we should be aware that preparing perfect bundles is not possible and there will most likely be modules that are loaded normally via RequireJS and for me that’s OK. The performance improvement of having most of them bundled is enough to get great results anyway.

That said, I think I am comfortable with making Magepack more configurable if somebody wishes to do so while preserving basing CLI usage for a nice baseline. My proposal would be to allow for the configuration that can be stored in the file in shape of:

module.exports = {
  'bundle-name': {
     urls: ['https://example.com'],
     additionalModules: [],
     ignoreModules: /something/,
     extractCommons: true,
 }
}

That way you could:

• Disable existing bundles, by passing for example 'cms': null in the config.
• Pass multiple URLs to visit which would solve #16
• Add additional modules by hand to cover #17
• Ignore modules when needed through RegExp.
• Create unlimited additional bundles.
• Pass custom checkout and cart URLs for checkout bundle to solve #22

The only issue I see, is that I think it would be best for this config to be named magepack.config.js and then Magepack would generate something like magepack.bundles.js with final bundling configuration so it would be a breaking change.

Waiting for your feedback. I think I could tackle this enhancements somewhere around weekend or next week if everyone agrees.

[roma-glushko]

@krzksz thank you for the replay 🙌

Those pages which don’t have their own bundles should still benefit from common bundle being loaded and all the other modules should be properly loaded via separate files using normal RequireJS mechanism.

Let me show you my real-life example to show the case. On the website, we have a completely custom space called - gallery. It consists of the album listing and album view pages. This is absolutely true, there are using some of the general JS files (collected in the common bundle). However, the crucial JS logic on those pages is unique and includes only there, because it’s not needed on the product, category or CMS pages. Without having an ability to create a separate bundle for this page, I just end up breaking it.

The second possible case here is to create a homepage bundle. The performance of the homepage is usually a big deal from a lot of angles. For example, that would be suboptimal to include relatively heavy lightbox or slider which are not used directly on the homepage, but using somewhere on the about us, how-to or other possible CMS pages.

Just like with the homepage, it’s completely possible to have functionality that is even more valuable for the business than the checkout flow (like forms from where shop leads come from). Naturally, that would be good to have an ability to optimize it or at least keep working.

What do you think about the mentioned cases?

it ended up being very cumbersome and hard to maintain.

What if there would be a possibility to specify bundles as a list of pages to check with CMS-like collection logic? This doesn’t sound like adjustments which are far away from what we have right now.