How to publish assets to public/ when installing a module via Composer?

[empiricompany]

Hi! 👋

I'm currently testing my OpenMage module (openmage-search), which is installable via Composer.
The composer.json file includes all necessary mappings using the type magento-module and the appropriate extra.map.

"extra": {
      "map": [
          ["app/code/community/MM/Search", "app/code/community/MM/Search"],
          ["app/etc/modules/MM_Search.xml", "app/etc/modules/MM_Search.xml"],
          ["app/design/frontend/base/default/layout/mm_search.xml", "app/design/frontend/base/default/layout/mm_search.xml"],
          ["app/design/frontend/base/default/template/mm/search", "app/design/frontend/base/default/template/mm/search"],
          ["app/design/adminhtml/default/default/template/mm/search", "app/design/adminhtml/default/default/template/mm/search"],
          ["skin/frontend/base/default/css/mm_search", "skin/frontend/base/default/css/mm_search"],
          ["skin/frontend/base/default/js/mm_search", "skin/frontend/base/default/js/mm_search"]
      ]
  },

Installation works fine, and extension code are loaded from vendor app/, but I’m wondering:

How can I automatically publish my static assets (e.g., JS, CSS, images) into the public/ folder upon installation?

Currently, I had to manually copy the two folders css/mm_search and js/mm_search into the appropriate public directories

Is there a recommended approach within Maho (or inherited from OpenMage) for this?

Here’s the project:

• OpenMage-Search
  composer require empiricompany/openmage-search
• Development branch with SEAL
  composer require empiricompany/openmage-search dev-seal

Thanks in advance!

[fballiano]

Hey @empiricompany, everything in the "skin" folder should be copied automatically but there could be a change/difference/bug with the latest version of plugin, for sure @justinbeaty knows what's going on but I'll also check it as soon as possible

[justinbeaty]

Neither modman nor extra.map actually work for the public folder. That's because those methods only create non-public symlinks in the vendor dir for the purpose of autoloading PHP files, as well as loading xml and csv files.

I don't believe we have ever automatically copied files from a module's public folders, but FileCopyPlugin.php is where this should be implemented, and the file mapping from modman and extra.map can be supported here.

However there were a few sticky points, such as what happens if a user wants to override a file in public, or if two modules defines the same file. One possible solution is putting public files from modules into public/vendor or something similar. We would need to have the default htaccess use a fallback mechanism to support that. I.e. https://example.com/js/foobar.js checks public/js/foobar.js first, else public/vendor/js/foobar.js.

One other thought I've had on the subject is that it would be pretty nice if we could minify CSS / JS during the copy. That would make it so we don't have to worry about bloat when adding JSDoc comments in the main maho repo.

[justinbeaty]

One thing we would lose is the ability for a starter project to override files like favicons and logos without making a child theme, and maybe some other use cases. I also somewhat worry about overriding files in the starter projects since places like /media may not be under version control, but this is probably less likely to happen.

But it's probably more important now to get it working at all, and the other questions could be answered later.

[fballiano]

One thing we would lose is the ability for a starter project to override files like favicons and logos without making a child theme, and maybe some other use cases.

that is true, mmmm I didn't think about it but I'm sure we'll come up with something

[fballiano]

@justinbeaty what do you think about MahoCommerce/maho-composer-plugin#4?

[justinbeaty]

I will check it out tomorrow. Also I'll add the support for modman files there since it's a simple change.

[fballiano]

@empiricompany https://github.com/MahoCommerce/maho-composer-plugin/releases/tag/v3.1.0 should do the trick 🤞🤞🤞

[luigifab]

Hello good guys,

I got a similar problem, but maybe I'm wrong for Maho (because it's working with om).
I installed Maho via git clone [email protected]:MahoCommerce/maho.git then via web installer.
All is working...

Then in composer.json I added a local repository:

    "repositories": [
        {
            "type": "path",
            "url": "/var/www/cool/code/maho-sentry"
        }
    ]

Then: composer require --ignore-platform-req=ext-zip "luigifab/maho-sentry @dev
I also tried composer update and install and maho clear cache.

In system > configuration > advanced, the module is displayed:

The only file loaded is app/etc/modules/Luigifab_Sentry.xml and all other files are ignored (code/community, design/adminhtml, js), because the module isn't displayed in developer section.

To "fix" the problem, I have to create symlinks: .../maho-git/app/code/community -> /var/www/cool/code/maho-sentry/src/app/code/community + for app/design + for public/js.

I don't understand why.

--

I tried looking in docs, but couldn't find anything.
I just tried to run composer create-project mahocommerce/maho-starter yourproject then ./maho serve, but when I go to http://127.0.0.1:8000, I'm redirected to http://127.0.0.1:8000/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/127.0.0.1:8000/index.php/install/

[fballiano]

not sure, @justinbeaty is the expert in this particular thing, did you composer dumpautoload just in case?

[luigifab]

I tried now, but this change nothing.

[justinbeaty]

Hey sorry I've been offline for a few weeks. Let me take a look at the problem now.Hey sorry I've been offline for a few weeks. Let me take a look at the problem now.

[justinbeaty]

@luigifab A few questions:

• Do you still have any manual symlinks that you've made?
• Is /var/www/cool/code/maho-sentry/src/app/design/adminhtml/default/default/template/luigifab/sentry/head.phtml outside the Maho webroot?
• Is there still an directory at maho-modman-symlinks/luigifab/maho-sentry ?

Since Maho doesn't dump all the module files into your webroot, when Maho gets a request for app/design/adminhtml/default/default/template/luigifab/sentry/head.phtml it needs to check each module's install folder in vendor. However since some modules organize different and use modman, we create the modman links folder to organize how Maho expects. So those symlinks should be organized in typical Magento fashion.

[luigifab]

Without the modman file, nothing works, except app/etc/modules/Luigifab_Sentry.xml.
With the modman file, without any manual symlinks, there is a problem with templates.

• I removed my manual symlinks
• Yes, /var/www/cool/... is outside Maho (/var/www/crashtest/maho-git & /var/www/crashtest/maho-cmp)
• Yes there is:

fabrice@mario:/var/www/crashtest/maho-git$ find . -iname luigifab
vendor/mahocommerce/maho-modman-symlinks/luigifab
vendor/mahocommerce/maho-modman-symlinks/luigifab/maho-sentry/app/code/community/Luigifab
vendor/mahocommerce/maho-modman-symlinks/luigifab/maho-sentry/app/design/adminhtml/default/default/layout/luigifab
vendor/mahocommerce/maho-modman-symlinks/luigifab/maho-sentry/app/design/adminhtml/default/default/template/luigifab
vendor/mahocommerce/maho-modman-symlinks/luigifab/maho-sentry/app/design/frontend/base/default/layout/luigifab
vendor/mahocommerce/maho-modman-symlinks/luigifab/maho-sentry/app/design/frontend/base/default/template/luigifab
vendor/luigifab

My modman file:

src/app/etc/modules/Luigifab_Sentry.xml app/etc/modules/Luigifab_Sentry.xml
src/app/code/community/Luigifab/Sentry/ app/code/community/Luigifab/Sentry/
src/app/design/adminhtml/default/default/layout/luigifab/sentry.xml app/design/adminhtml/default/default/layout/luigifab/sentry.xml
src/app/design/adminhtml/default/default/template/luigifab/sentry/ app/design/adminhtml/default/default/template/luigifab/sentry/
src/app/design/frontend/base/default/layout/luigifab/sentry.xml app/design/frontend/base/default/layout/luigifab/sentry.xml
src/app/design/frontend/base/default/template/luigifab/sentry/ app/design/frontend/base/default/template/luigifab/sentry/
src/js/sentry/ js/sentry/

My current wrong solution for app/code/core/Mage/Core/Block/Template.php:#297:

            if (is_file($fileName)) { // $fileName = /var/www/cool/code/maho-sentry/src/app/design/adminhtml/default/default/template/luigifab/sentry/head.phtml
                include $fileName;
                echo $fileName,'<br>';
            } else if (!str_contains($this->_viewDir . DS . $fileName, '..')
                &&
                ($this->_viewDir == Mage::getBaseDir('design') || str_starts_with(realpath($this->_viewDir), realpath(Mage::getBaseDir('design'))))
            ) {
                $fileToInclude = Maho::findFile($fileName);
                if (!$fileToInclude) {
                    $fileToInclude = Maho::findFile($this->_viewDir . DS . $fileName);
                }
                include $fileToInclude;
            } else {
                $thisClass = static::class;
                Mage::log('Not valid template file:' . $fileName . ' class: ' . $thisClass, Zend_Log::CRIT, null, true);
            }