Phase 2 of Premium Plugins Installation

Why these changes are being introduced:
Phase 1 of the premium plugins installation is complete across
Dev1, Stage-Workloads, and Prod-Workloads (that is, the plugin folders
are installed in the container and the plugins are listed in the
Plugin Directory in the UI, but they are not activated). The plugins
have been manually activated in Stage & Prod, so any database schema
changes are complete. As part of the testing, InnoCraft support let us
know that the `CustomJsTracker` plugin (a Core plugin) must be activated
for the HeatmapSessionRecording and the UsersFlow plugins to work
correctly (because both plugins actually make changes to the matomo.js
and piwik.js files).

How this addresses that need:
* Update the Dockerfile to include the updated `matomo.js and `piwik.js`
files (that are the result of activating the plugins); these files are
written to the `/usr/src/matomo/` directory because the `entrypoint.sh`
script is what actually creates the `/var/www/html/` directory when the
container is launched
* Update the `config.ini.php` file to correctly list all the plugins
that exist in the `plugins/` directory and sort them alphabetically to
make it easier to review them in the future
* Update the `config.ini.php` file to include the `CustomJsTracker` as
an activated plugin
* Update the `config.ini.php` file to include the UsersFlow and
HeatmapSessionRecording plugins as active plugins
* Include the version of the `matomo.js` and `piwik.js` files that are
generated by the new plugins

Side effects of this change:
None.
 Relevant ticket(s):
* https://mitlibraries.atlassian.net/browse/INFRA-517

Author: cabutlermit

Dockerfile

@@ -14,9 +14,16 @@ COPY ./files/plugin-HeatmapSessionRecording-5.2.3/ /var/www/html/plugins/Heatmap
 # Add the UsersFlow plugin
 COPY ./files/plugin-UsersFlow-5.0.5/ /var/www/html/plugins/UsersFlow
 
-# Preconfigure settings
+# Our custom configuration settings
 COPY ./files/config.ini.php /var/www/html/config/config.ini.php
 
+# The HeatmapSessionRecording and UsersFlow update the matomo.js and piwik.js
+# files when they are activated. Those updates have been captured and we
+# pre-load them here (we put them in /usr/src because the entrypoint.sh is what
+# actually builds the /var/www/html folder as a Docker VOLUME)
+COPY --chmod=0644 ./files/post_premium_plugins_matomo.js /usr/src/matomo/matomo.js
+COPY --chmod=0644 ./files/post_premium_plugins_piwik.js /usr/src/matomo/piwik.js
+
 # Address "public" directories problem
 COPY --chmod=0644 --chown=root:root ./files/lang-htaccess /var/www/html/lang/.htaccess
 COPY --chmod=0644 --chown=root:root ./files/config-htaccess /var/www/html/config/.htaccess

files/config.ini.php

@@ -88,81 +88,102 @@
 Plugins[] = "Resolution"
 Plugins[] = "DevicePlugins"
 Plugins[] = "Heartbeat"
-Plugins[] = "Marketplace"
 Plugins[] = "Intl"
+Plugins[] = "Marketplace"
+Plugins[] = "CustomJsTracker"
 Plugins[] = "Tour"
 Plugins[] = "PagePerformance"
 Plugins[] = "CustomDimensions"
 Plugins[] = "FeatureFlags"
 Plugins[] = "MobileAppMeasurable"
 Plugins[] = "CustomVariables"
 Plugins[] = "EnvironmentVariables"
+Plugins[] = "HeatmapSessionRecording"
+Plugins[] = "UsersFlow"
+
 
 [PluginsInstalled]
-PluginsInstalled[] = "Diagnostics"
-PluginsInstalled[] = "Login"
+PluginsInstalled[] = "API"
+PluginsInstalled[] = "Actions"
+PluginsInstalled[] = "Annotations"
+PluginsInstalled[] = "BulkTracking"
+PluginsInstalled[] = "Contents"
 PluginsInstalled[] = "CoreAdminHome"
-PluginsInstalled[] = "UsersManager"
-PluginsInstalled[] = "SitesManager"
-PluginsInstalled[] = "Installation"
-PluginsInstalled[] = "Monolog"
-PluginsInstalled[] = "Intl"
-PluginsInstalled[] = "CorePluginsAdmin"
+PluginsInstalled[] = "CoreConsole"
 PluginsInstalled[] = "CoreHome"
-PluginsInstalled[] = "WebsiteMeasurable"
-PluginsInstalled[] = "IntranetMeasurable"
+PluginsInstalled[] = "CorePluginsAdmin"
+PluginsInstalled[] = "CoreUpdater"
 PluginsInstalled[] = "CoreVisualizations"
-PluginsInstalled[] = "Proxy"
-PluginsInstalled[] = "API"
-PluginsInstalled[] = "Widgetize"
-PluginsInstalled[] = "Transitions"
-PluginsInstalled[] = "LanguagesManager"
-PluginsInstalled[] = "Actions"
+PluginsInstalled[] = "CoreVue"
+PluginsInstalled[] = "CustomDimensions"
+PluginsInstalled[] = "CustomVariables"
+PluginsInstalled[] = "CustomJsTracker"
+PluginsInstalled[] = "DBStats"
 PluginsInstalled[] = "Dashboard"
-PluginsInstalled[] = "MultiSites"
-PluginsInstalled[] = "Referrers"
-PluginsInstalled[] = "UserLanguage"
+PluginsInstalled[] = "DevicePlugins"
 PluginsInstalled[] = "DevicesDetection"
-PluginsInstalled[] = "Goals"
+PluginsInstalled[] = "Diagnostics"
 PluginsInstalled[] = "Ecommerce"
-PluginsInstalled[] = "SEO"
+PluginsInstalled[] = "EnvironmentVariables"
 PluginsInstalled[] = "Events"
-PluginsInstalled[] = "UserCountry"
-PluginsInstalled[] = "GeoIp2"
-PluginsInstalled[] = "VisitsSummary"
-PluginsInstalled[] = "VisitFrequency"
-PluginsInstalled[] = "VisitTime"
-PluginsInstalled[] = "VisitorInterest"
-PluginsInstalled[] = "RssWidget"
+PluginsInstalled[] = "FeatureFlags"
 PluginsInstalled[] = "Feedback"
-PluginsInstalled[] = "TwoFactorAuth"
-PluginsInstalled[] = "CoreUpdater"
-PluginsInstalled[] = "CoreConsole"
-PluginsInstalled[] = "ScheduledReports"
-PluginsInstalled[] = "UserCountryMap"
-PluginsInstalled[] = "Live"
-PluginsInstalled[] = "CustomVariables"
-PluginsInstalled[] = "PrivacyManager"
+PluginsInstalled[] = "GeoIp2"
+PluginsInstalled[] = "Goals"
+PluginsInstalled[] = "Heartbeat"
+PluginsInstalled[] = "HeatmapSessionRecording"
 PluginsInstalled[] = "ImageGraph"
-PluginsInstalled[] = "Annotations"
-PluginsInstalled[] = "MobileMessaging"
-PluginsInstalled[] = "Overlay"
-PluginsInstalled[] = "SegmentEditor"
 PluginsInstalled[] = "Insights"
-PluginsInstalled[] = "Morpheus"
-PluginsInstalled[] = "Contents"
-PluginsInstalled[] = "BulkTracking"
-PluginsInstalled[] = "Resolution"
-PluginsInstalled[] = "DevicePlugins"
-PluginsInstalled[] = "Heartbeat"
+PluginsInstalled[] = "Installation"
+PluginsInstalled[] = "Intl"
+PluginsInstalled[] = "IntranetMeasurable"
+PluginsInstalled[] = "JsTrackerInstallCheck"
+PluginsInstalled[] = "LanguagesManager"
+PluginsInstalled[] = "Live"
+PluginsInstalled[] = "Login"
 PluginsInstalled[] = "Marketplace"
-PluginsInstalled[] = "ProfessionalServices"
-PluginsInstalled[] = "Tour"
-PluginsInstalled[] = "EnvironmentVariables"
-PluginsInstalled[] = "CoreVue"
 PluginsInstalled[] = "MobileAppMeasurable"
+PluginsInstalled[] = "MobileMessaging"
+PluginsInstalled[] = "Monolog"
+PluginsInstalled[] = "Morpheus"
+PluginsInstalled[] = "MultiSites"
+PluginsInstalled[] = "Overlay"
 PluginsInstalled[] = "PagePerformance"
-PluginsInstalled[] = "CustomDimensions"
-PluginsInstalled[] = "FeatureFlags"
+PluginsInstalled[] = "PrivacyManager"
+PluginsInstalled[] = "ProfessionalServices"
+PluginsInstalled[] = "Proxy"
+PluginsInstalled[] = "Referrers"
+PluginsInstalled[] = "Resolution"
+PluginsInstalled[] = "RssWidget"
+PluginsInstalled[] = "SEO"
+PluginsInstalled[] = "ScheduledReports"
+PluginsInstalled[] = "SegmentEditor"
+PluginsInstalled[] = "SitesManager"
+PluginsInstalled[] = "TagManager"
+PluginsInstalled[] = "Tour"
+PluginsInstalled[] = "Transitions"
+PluginsInstalled[] = "TwoFactorAuth"
+PluginsInstalled[] = "UserCountry"
+PluginsInstalled[] = "UserCountryMap"
+PluginsInstalled[] = "UserId"
+PluginsInstalled[] = "UserLanguage"
 PluginsInstalled[] = "UsersFlow"
-PluginsInstalled[] = "HeatmapSessionRecording"
+PluginsInstalled[] = "UsersManager"
+PluginsInstalled[] = "VisitFrequency"
+PluginsInstalled[] = "VisitTime"
+PluginsInstalled[] = "VisitorInterest"
+PluginsInstalled[] = "VisitsSummary"
+PluginsInstalled[] = "WebsiteMeasurable"
+PluginsInstalled[] = "Widgetize"
+
+[HeatmapSessionRecording]
+add_tracking_code_only_when_needed = 1
+session_recording_sample_limits = "50,100,250,500,1000,2000,5000"
+load_css_from_db = 1
+max_time_allowed_on_page_column_limit = "9.2233720368548E+18"
+default_heatmap_width = 1920
+
+[UsersFlow]
+UsersFlow_num_max_steps = 10
+UsersFlow_num_max_rows_in_actions = 100
+UsersFlow_num_max_links_per_interaction = 5000