add disable archiving segment for plugins #18279

peterhashair · 2021-11-08T01:52:38Z

Description:

Fixes: #18134
add disable archiving segment configuration for plugins

Under [General]-> disable_archiving_segment_for_plugins accept string, sting with comma, array.
[General_{siteId}] can be enable by Site ID.

I guess this will be 4.7

Review

add disable archiving segment for plugins

add isset check

…configuration

update disable_archiving_segment_for_plugins to right place

update tests

config/global.ini.php

update wording

update wording and test

update tests

update config

config/global.ini.php

update wording

peterhashair · 2021-11-16T22:46:11Z

The last test runs fully passed https://app.travis-ci.com/github/matomo-org/matomo/builds/241828886. the Last update just one wording in global.config.php, I think no need to run the test again.

justinvelluppillai · 2021-11-16T22:47:18Z

@peterhashair changing the config changes one of the screenshots

peterhashair · 2021-11-16T23:09:33Z

@justinvelluppillai right, let me run it again.

update screen shot

…configuration

sgiehl · 2021-11-19T14:39:00Z

[General_{siteId}] can be enable by Site ID.

If I see that right, the site specific config would then only work for that specific configuration value, right? Imho we should do it the same way like in tracker config. So it would be available for all values in General section.

See

matomo/core/Tracker/TrackerConfig.php

Lines 28 to 47 in e041784

    
           public static function getConfigValue($name, $idSite = null) 
        
           { 
        
               $config = self::getConfig(); 
        
               if (!empty($idSite)) { 
        
                   $siteSpecificConfig = self::getSiteSpecificConfig($idSite); 
        
                   $config = array_merge($config, $siteSpecificConfig); 
        
               } 
        
               return $config[$name]; 
        
           } 
        
           private static function getConfig() 
        
           { 
        
               return Config::getInstance()->Tracker; 
        
           } 
        
           private static function getSiteSpecificConfig($idSite) 
        
           { 
        
               $key = 'Tracker_' . $idSite; 
        
               return Config::getInstance()->$key; 
        
           }

I'm not sure if it's easy to adjust the config class to support that. Maybe we need to introduce a new class GeneralConfig (like TrackerConfig) and replace all usages of the general config over time then...

peterhashair · 2021-11-19T23:50:26Z

@sgiehl right, that makes sense let me do the adjustment.

move general config to a file

update screenshot

update en and check unsegmented reports

update lang

sgiehl

@peterhashair Left a couple of comments for smaller improvements. Regarding a UI test: I guess it would be good to have one, as it would also be kind of an integration test, as it ensures that tracked data isn't archived and displayed. Besides that guess it should be ready to merge after the adjustments

core/Config/GeneralConfig.php

config/global.ini.php

plugins/CoreHome/lang/en.json

plugins/CoreHome/templates/_dataTable.twig

# Conflicts: # plugins/CoreHome/CoreHome.php # plugins/Dashboard/tests/UI/expected-screenshots/Dashboard_removed.png # tests/UI/expected-screenshots/Theme_home.png # tests/UI/expected-screenshots/UIIntegrationTest_dashboard1.png

Co-authored-by: Stefan Giehl <stefan@matomo.org>

add screenshot tests

…rg/matomo into m-18134-archiving-configuration

set up site

update config

update to overwrite

update screen shot

update config

update screen

# Conflicts: # tests/UI/expected-screenshots/UIIntegrationTest_admin_diagnostics_configfile.png

update screenshots

sgiehl

@peterhashair it seems you have updated a couple of screenshots that are unrelated to this issue. The updater screenshots are failing for a specific reason, and they should work again, once that issue is fixed. So the changes to them should be reverted. Also you added tests/UI/expected-screenshots/DisablePluginArchive.png, which is not used.

sgiehl · 2021-12-06T11:28:43Z

tests/PHPUnit/Fixtures/DisablePluginArchive.php

+    public function setUp(): void
+    {
+      $this->setUpWebsitesAndGoals();
+      $this->setUpConfig();


It would be good to also track some visits in this fixture, maybe one or two with different referrers. That would ensure that no archiving is done. Otherwise the reports would show the data...

update unrelated screenshots and update tests

peterhashair · 2021-12-06T23:58:27Z

@sgiehl right, update below. I am not too sure the refer tracking is correct, copied from other fixtures.

remove the unrelated UI changes.
set up a refer tracking.
update screenshot name

sgiehl · 2021-12-07T11:15:38Z

plugins/CoreHome/lang/en.json

@@ -11,6 +11,7 @@
        "CloseWidgetDirections": "You can close this widget by clicking on the 'X' icon at the top of the widget.",
        "ChooseX": "Choose %1$s",
        "DataForThisReportHasBeenPurged": "The data for this report is more than %s months old and has been purged.",
+        "DataForThisReportHasBeenDisabled": "Segmentation is currently disabled for this report. Please check %1$sthis FAQ%2$s for more details.",


@tsteur Not sure if this will be a feature we are going to use on cloud maybe. In that case I was wondering if linking an FAQ in the message would actually be helpful, as the user can't change that 🤔

sgiehl

The remaining failing tests seem unrelated, so should be good to merge now. Left a comment regarding cloud, so might be good to wait for an answer.

tsteur · 2021-12-07T19:38:57Z

@sgiehl linking to an FAQ be great, the FAQ could also mention specifically the cloud that if they are on the cloud, to reach out to our support.

sgiehl · 2021-12-07T19:47:28Z

@peterhashair I have merged in the latest changes from 4.x-dev. If tests are passing, feel free to merge

Peter Zhang added 6 commits November 8, 2021 14:35

add disable archiving segment for plugins

07064f5

add disable archiving segment for plugins

Update Rules.php

fff7cc4

add isset check

Merge remote-tracking branch 'origin/4.x-dev' into m-18134-archiving-…

af0fe33

…configuration

Merge remote-tracking branch 'origin/4.x-dev' into m-18134-archiving-…

64e37d6

…configuration

Update global.ini.php

81b0b87

update disable_archiving_segment_for_plugins to right place

update tests

751467c

update tests

justinvelluppillai reviewed Nov 16, 2021

View reviewed changes

config/global.ini.php Outdated Show resolved Hide resolved

justinvelluppillai reviewed Nov 16, 2021

View reviewed changes

config/global.ini.php Outdated Show resolved Hide resolved

justinvelluppillai reviewed Nov 16, 2021

View reviewed changes

config/global.ini.php Outdated Show resolved Hide resolved

Peter Zhang added 3 commits November 16, 2021 15:05

Update global.ini.php

fbf9650

update wording

update wording and test

42c2a38

update wording and test

update tests

7c589be

update tests

peterhashair marked this pull request as ready for review November 16, 2021 05:28

peterhashair added Needs Review PRs that need a code review not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org. labels Nov 16, 2021

peterhashair added this to the 4.7.0 milestone Nov 16, 2021

Update UIIntegrationTest_admin_diagnostics_configfile.png

563071f

update config

bx80 approved these changes Nov 16, 2021

View reviewed changes

config/global.ini.php Outdated Show resolved Hide resolved

Update global.ini.php

8b31a91

update wording

Update UIIntegrationTest_admin_diagnostics_configfile.png

a4c674c

update screen shot

peterhashair self-assigned this Nov 17, 2021

Merge remote-tracking branch 'origin/4.x-dev' into m-18134-archiving-…

180ebfc

…configuration

Peter Zhang added 3 commits November 21, 2021 17:24

move general config to a file

149d747

move general config to a file

Merge branch '4.x-dev' into m-18134-archiving-configuration

f961974

update screenshot

d9aad0d

update screenshot

Peter Zhang added 2 commits December 1, 2021 09:32

core/Plugin/Visualization.php

320e365

update en and check unsegmented reports

Update en.json

7c361e5

update lang

sgiehl requested changes Dec 3, 2021

View reviewed changes

core/Config/GeneralConfig.php Outdated Show resolved Hide resolved

config/global.ini.php Show resolved Hide resolved

plugins/CoreHome/lang/en.json Outdated Show resolved Hide resolved

plugins/CoreHome/templates/_dataTable.twig Outdated Show resolved Hide resolved

Peter Zhang and others added 13 commits December 6, 2021 09:43

Update core/Config/GeneralConfig.php

41a6500

Co-authored-by: Stefan Giehl <stefan@matomo.org>

Update plugins/CoreHome/lang/en.json

2bb9421

Co-authored-by: Stefan Giehl <stefan@matomo.org>

add screenshot tests

6864425

add screenshot tests

Merge branch 'm-18134-archiving-configuration' of github.com:matomo-o…

0442bb8

…rg/matomo into m-18134-archiving-configuration

Update DisablePluginArchive.php

f049ffb

set up site

Update DisablePluginArchive.php

5e41d62

update config

Update DisablePluginArchive.php

673033a

update to overwrite

Create DisablePluginArchive_DisablePluginArchive.png

49c572c

update screen shot

update config

05ceac6

update config

update screen

b660915

update screen

Merge branch '4.x-dev' into m-18134-archiving-configuration

0b456be

# Conflicts: # tests/UI/expected-screenshots/UIIntegrationTest_admin_diagnostics_configfile.png

update screenshots

9ddd879

update screenshots

sgiehl requested changes Dec 6, 2021

View reviewed changes

sgiehl removed the Needs Review PRs that need a code review label Dec 6, 2021

Peter Zhang added 2 commits December 7, 2021 10:52

Merge branch '4.x-dev' into m-18134-archiving-configuration

9d6791a

update unrelated screenshots and update tests

1148f49

update unrelated screenshots and update tests

sgiehl reviewed Dec 7, 2021

View reviewed changes

sgiehl approved these changes Dec 7, 2021

View reviewed changes

Merge branch '4.x-dev' into m-18134-archiving-configuration

2914e5b

peterhashair merged commit 2da215c into 4.x-dev Dec 7, 2021

peterhashair deleted the m-18134-archiving-configuration branch December 7, 2021 23:28

tsteur mentioned this pull request Mar 16, 2022

Link to FAQ not working when segment archiving disabled for plugin #18954

Closed

Starker3 mentioned this pull request Mar 29, 2022

Allow site specific archive settings #19019

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add disable archiving segment for plugins #18279

add disable archiving segment for plugins #18279

peterhashair commented Nov 8, 2021 •

edited

peterhashair commented Nov 16, 2021

justinvelluppillai commented Nov 16, 2021

peterhashair commented Nov 16, 2021

sgiehl commented Nov 19, 2021

peterhashair commented Nov 19, 2021

sgiehl left a comment

sgiehl left a comment

sgiehl Dec 6, 2021

peterhashair commented Dec 6, 2021 •

edited

sgiehl Dec 7, 2021

sgiehl left a comment

tsteur commented Dec 7, 2021

sgiehl commented Dec 7, 2021

add disable archiving segment for plugins #18279

add disable archiving segment for plugins #18279

Conversation

peterhashair commented Nov 8, 2021 • edited

Description:

Review

peterhashair commented Nov 16, 2021

justinvelluppillai commented Nov 16, 2021

peterhashair commented Nov 16, 2021

sgiehl commented Nov 19, 2021

peterhashair commented Nov 19, 2021

sgiehl left a comment

Choose a reason for hiding this comment

sgiehl left a comment

Choose a reason for hiding this comment

sgiehl Dec 6, 2021

Choose a reason for hiding this comment

peterhashair commented Dec 6, 2021 • edited

sgiehl Dec 7, 2021

Choose a reason for hiding this comment

sgiehl left a comment

Choose a reason for hiding this comment

tsteur commented Dec 7, 2021

sgiehl commented Dec 7, 2021

peterhashair commented Nov 8, 2021 •

edited

peterhashair commented Dec 6, 2021 •

edited