1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\CoreVue\Commands;
use Piwik\AssetManager\UIAssetFetcher\JScriptUIAssetFetcher;
use Piwik\AssetManager\UIAssetFetcher\PluginUmdAssetFetcher;
use Piwik\Container\StaticContainer;
use Piwik\Filesystem;
use Piwik\Plugin\ConsoleCommand;
use Piwik\Plugins\MobileMessaging\SMSProvider\Development;
use Psr\Log\LoggerInterface;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
class Build extends ConsoleCommand
{
const RECOMMENDED_NODE_VERSION = '16.0.0';
const RECOMMENDED_NPM_VERSION = '7.0.0';
protected function configure()
{
$this->setName('vue:build');
$this->setDescription('Builds vue modules for one or more plugins.');
$this->addArgument('plugins', InputArgument::IS_ARRAY | InputArgument::OPTIONAL, 'Plugins whose vue modules to build. Defaults to all plugins.', []);
$this->addOption('watch', null, InputOption::VALUE_NONE, 'If supplied, will watch for changes and automatically rebuild.');
$this->addOption('clear-webpack-cache', null, InputOption::VALUE_NONE);
$this->addOption('print-build-command', null, InputOption::VALUE_NONE);
}
public function isEnabled()
{
return \Piwik\Development::isEnabled();
}
protected function execute(InputInterface $input, OutputInterface $output)
{
self::checkVueCliServiceAvailable();
$this->checkNodeJsVersion($output);
$clearWebpackCache = $input->getOption('clear-webpack-cache');
if ($clearWebpackCache) {
$this->clearWebpackCache();
}
$printBuildCommand = $input->getOption('print-build-command');
$watch = $input->getOption('watch');
$plugins = $input->getArgument('plugins');
if (empty($plugins)) {
$plugins = $this->getAllPluginsWithVueLibrary();
} else {
$plugins = $this->filterPluginsWithoutVueLibrary($plugins);
if (empty($plugins)) {
$output->writeln("<error>No plugins to build!</error>");
return 1;
}
}
$plugins = PluginUmdAssetFetcher::orderPluginsByPluginDependencies($plugins);
// remove webpack cache since it can result in strange builds if present
Filesystem::unlinkRecursive(PIWIK_INCLUDE_PATH . '/node_modules/.cache', true);
$failed = $this->build($output, $plugins, $printBuildCommand, $watch);
return $failed;
}
private function build(OutputInterface $output, $plugins, $printBuildCommand, $watch = false)
{
if ($watch) {
$this->watch($plugins, $printBuildCommand, $output);
return;
}
$failed = 0;
foreach ($plugins as $plugin) {
$failed += (int) $this->buildFiles($output, $plugin, $printBuildCommand);
}
return $failed;
}
private function watch($plugins, $printBuildCommand, OutputInterface $output)
{
$commandSingle = "BROWSERSLIST_IGNORE_OLD_DATA=1 FORCE_COLOR=1 MATOMO_CURRENT_PLUGIN=%1\$s "
. self::getVueCliServiceBin() . ' build --mode=development --target lib --name '
. "%1\$s --filename=%1\$s.development --no-clean ./plugins/%1\$s/vue/src/index.ts --dest ./plugins/%1\$s/vue/dist --watch &";
$command = '';
foreach ($plugins as $plugin) {
$command .= sprintf($commandSingle, $plugin) . ' ';
}
if ($printBuildCommand) {
$output->writeln("<comment>$command</comment>");
return;
}
passthru($command);
}
private function buildFiles(OutputInterface $output, $plugin, $printBuildCommand)
{
$command = "BROWSERSLIST_IGNORE_OLD_DATA=1 FORCE_COLOR=1 MATOMO_CURRENT_PLUGIN=$plugin "
. self::getVueCliServiceBin() . ' build --target lib --name ' . $plugin
. " ./plugins/$plugin/vue/src/index.ts --dest ./plugins/$plugin/vue/dist";
if ($printBuildCommand) {
$output->writeln("<comment>$command</comment>");
return 0;
}
$this->clearPluginTypes($plugin);
$output->writeln("<comment>Building $plugin...</comment>");
if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
passthru($command, $returnCode);
} else {
exec($command, $cmdOutput, $returnCode);
if ($returnCode != 0
|| stripos(implode("\n", $cmdOutput), 'warning') !== false
) {
$output->writeln("<error>Failed:</error>\n");
$output->writeln($cmdOutput);
$output->writeln("");
}
}
@unlink(PIWIK_INCLUDE_PATH . "/plugins/$plugin/vue/dist/$plugin.common.js");
@unlink(PIWIK_INCLUDE_PATH . "/plugins/$plugin/vue/dist/$plugin.common.js.map");
@unlink(PIWIK_INCLUDE_PATH . "/plugins/$plugin/vue/dist/demo.html");
// delete cjs webpack chunks
shell_exec("rm " . PIWIK_INCLUDE_PATH . "/plugins/$plugin/vue/dist/$plugin.common.*.js* 2> /dev/null");
return $returnCode != 0;
}
private function getAllPluginsWithVueLibrary()
{
$pluginsDir = PIWIK_INCLUDE_PATH . '/plugins';
$plugins = scandir($pluginsDir);
return $this->filterPluginsWithoutVueLibrary($plugins, $isAll = true);
}
private function filterPluginsWithoutVueLibrary($plugins, $isAll = false)
{
$pluginsDir = PIWIK_INCLUDE_PATH . '/plugins';
$pluginsWithVue = [];
$logger = StaticContainer::get(LoggerInterface::class);
foreach ($plugins as $plugin) {
$pluginDirPath = $pluginsDir . '/' . $plugin;
$vueDir = $pluginDirPath . '/vue';
if (!is_dir($vueDir)) {
if (!$isAll) {
$logger->error("Cannot find vue library for plugin {plugin}, nothing to build.", ['plugin' => $plugin]);
}
continue;
}
$vueIndexFile = $vueDir . '/src/index.ts';
if (!is_file($vueIndexFile)) {
$logger->warning("NOTE: Plugin {plugin} has a vue folder but no webpack config, cannot build it.", ['plugin' => $plugin]);
continue;
}
$pluginsWithVue[] = $plugin;
}
return $pluginsWithVue;
}
public static function getVueCliServiceBin()
{
return PIWIK_INCLUDE_PATH . "/node_modules/@vue/cli-service/bin/vue-cli-service.js";
}
public static function checkVueCliServiceAvailable()
{
$vueCliBin = self::getVueCliServiceBin();
if (!is_file($vueCliBin)) {
throw new \Exception("Cannot find vue cli bin file, did you forget to run `npm install`?");
}
}
private function clearWebpackCache()
{
$path = PIWIK_INCLUDE_PATH . '/node_modules/.cache';
Filesystem::unlinkRecursive($path, true);
}
private function clearPluginTypes($plugin)
{
$path = PIWIK_INCLUDE_PATH . '/@types/' . $plugin;
Filesystem::unlinkRecursive($path, true);
}
private function checkNodeJsVersion(OutputInterface $output)
{
$nodeVersion = ltrim(trim(`node -v`), 'v');
$npmVersion = ltrim(trim(`npm -v`), 'v');
if (version_compare($nodeVersion, self::RECOMMENDED_NODE_VERSION, '<')) {
$output->writeln(sprintf("<comment>The recommended node version for working with Vue is version %s or "
. "greater and it looks like you're using %s. Building Vue files may not work with an older version, so "
. "we recommend upgrading. nvm can be used to easily install new node versions.</comment>",
self::RECOMMENDED_NODE_VERSION, $nodeVersion));
}
if (version_compare($npmVersion, self::RECOMMENDED_NPM_VERSION, '<')) {
$output->writeln(sprintf("<comment>The recommended npm version for working with Vue is version %s "
. "or greater and it looks like you're using %s. Using an older version may result in improper "
. "dependencies being used, so we recommend upgrading. You can upgrade to the latest version with the "
. "command %s</comment>",
self::RECOMMENDED_NPM_VERSION, $npmVersion, 'npm install -g npm@latest'));
}
}
}
|
