Disable Admin Usage Data Collection by Default

[pykettk]

Description (*)

Updates default behaviour to disable the data collection implemented by Magento_AdminAnalytics.

Fixed Issues

Fixes #43

Manual testing scenarios (*)

1. Install the 1.0.0 preview and log into the backend as an admin user.
2. Observe the related configuration option is disabled upon installation
   • Stores -> Settings -> Configuration -> Advanced -> Admin -> Admin Usage

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
• All automated tests passed successfully (all builds are green)

[Vinai]

Thank you for your PR!
There are a number of additional places that need to be changed, too.

The module is still referenced in the mageos-magento2 root composer.json:
https://github.com/mage-os/mageos-magento2/blob/2.4-develop/composer.json#L114

Also the module PageBuilderAdminAnalytics is built on top of it, and the composer package
mage-os/module-page-builder-admin-analytics depends on mage-os/module-admin-analytics.
https://github.com/mage-os/mageos-magento2-page-builder/tree/develop/app/code/Magento/PageBuilderAdminAnalytics

This module in turn is required in the page-builder metapackage:
https://github.com/mage-os/mageos-magento2-page-builder/blob/develop/app/code/Magento/_metapackage/composer.json#L8

Given it is likely more modules also depend on the AdminAnalytics module, and we want to promote Mage-OS as a drop-in replacement for Magento Open Source, I think it probably is better to short-circuit it instead of removing it.

Maybe we automatically opt-out of data collection as a first step. If we can go further and disable tracking on a deeper level without removing the module that would be good, too.

Removal then should be scheduled for a later date.

[pykettk]

Thanks, @Vinai ! I've changed the contents of this PR to now disable the collection by default instead of removing the module itself 👍

[Vinai]

@pykettk Does this hide the modal on the initial login into the admin panel?
If not, I think that would be a good change to include, too.

[pykettk]

@Vinai Just to echo my message elsewhere, it looks like I lost a commit when rebasing 🤦‍♂️ I've just re-committed my change. I had opted to rely on the value of the related admin config option to determine whether to show this block or not, rather than simply never showing it.

[Vinai]

Thank you! Very good.

I wonder, do we change the URL in here?

            <block name="tracking" as="tracking" template="Magento_AdminAnalytics::tracking.phtml" ifconfig="admin/usage/enabled">
                <arguments>
                    <argument name="tracking_url" xsi:type="string">//assets.adobedtm.com/a7d65461e54e/37baabec1b6e/launch-177bc126c8e6.min.js</argument>
                    <argument name="metadata" xsi:type="object">Magento\AdminAnalytics\ViewModel\Metadata</argument>
                </arguments>
            </block>

I guess we should set up our own tracking as an alternative 🤣

EDIT:
I never looked at the info that was collected before:

$scriptString = '
    var adminAnalyticsMetadata = {
        "secure_base_url": "' . $block->escapeJs($metadata->getSecureBaseUrlForScope()) . '",
        "version": "' . $block->escapeJs($metadata->getMagentoVersion()) . '",
        "product_edition": "' . $block->escapeJs($metadata->getProductEdition()) . '",
        "user": "' . $block->escapeJs($metadata->getCurrentUser()) . '",
        "mode": "' . $block->escapeJs($metadata->getMode()) . '",
        "store_name_default": "' . $block->escapeJs($metadata->getStoreNameForScope()) . '",
        "admin_user_created": "' . $block->escapeJs($metadata->getCurrentUserCreatedDate()) . '",
        "admin_user_logdate": "' . $block->escapeJs($metadata->getCurrentUserLogDate()) . '",
        "admin_user_role_name": "' . $block->escapeJs($metadata->getCurrentUserRoleName()) . '"
    };
';

If someone enables it, then Adobe will suddenly register installs for Community Edition 1.0.0 ...

[pykettk]

Change it for real or to something ineffective? Sorry, tone is hard through text 😅

EDIT: That might be fun 😅 I only looked into this recently when Adobe pushed an update to that external location and broke the admin for many people...

[Vinai]

Probably we should use some black hole URL.

[pykettk]

Probably we should use some black hole URL.

Any one you're particularly interested in using?

[Vinai]

Or we could submit even more troll values, like version 2.5.7-p2 enterprise edition.

[Vinai]

Probably we should use some black hole URL.

Any one you're particularly interested in using?

No idea what to use. I would have to search for one.

[pykettk]

Removing the value renders a <script> tag with an empty src value - perhaps this is sufficient? We could also edit the template to only produce output if the tracking_url argument exists? 🤷‍♂️

[Vinai]

Let's just remove the script value so it renders an empty script src and not modify the template.