Initial PR to send scheduled reports to a Slack channel, #PG-4491 #1

AltamashShaikh · 2025-08-22T01:52:01Z

Description

Initial PR to send scheduled reports to a Slack channel, currently we support only Slack and Email

Issue No

#PG-4491

Steps to Replicate the Issue

Clone this repository under plugins directory as git clone [email protected]:matomo-org/plugin-Slack.git Slack
Activate the plugin ./console plugin:activate Slack
Now checkout to this branch
Try to create a new ScheduledReport, select "Slack" as "Send report via" option
You would notice, that the Slack Channel ID is disabled, as we haven't added the OAuth token
Add the OAuth token, token is added in keeper under plugins team - "Slack OAuth Bot Token - test"
Configure it and try step 4 again
You will see an option to Enter Slack Channel Id now
Add the channelID for Slack
Save the report and you can schedule the report from UI

11. Send the report and it should send a report to the specified Slack channel

Checklist

[✔] Tested locally or on demo2/demo3?
[✔] New test case added/updated?
[✔] Are all newly added texts included via translation?
[✔] Are text sanitized properly? (Eg use of v-text v/s v-html for vue)
[✔] Version bumped?

snake14

Looks alright overall. There's a lot to review. I left a few comments.

My biggest concern is whether this is going to be an open-source or premium plugin since it's in the matomo-org organisation and has GPL license throughout.

Slack.php

docs/faq.md

lang/en.json

snake14 · 2025-08-24T22:36:11Z

tests/UI/Slack_spec.js

This is very screenshot heavy. Could some of the test cases be DOM comparison instead? Maybe that would solve the issue of some of the test cases being tightly coupled (dependent on previous test cases)?

james-hill-matomo

I reviewed this as new code, then later realised it's based off existing plugins.

This would have been great if it was presented as a few extra PRs - e.g. one to setup up the repo with phpcs, .github etc, and a separate PR for the actual code.

I do think this makes sense as a separate repo now I've seen it.

Great work!

ScheduleReportSlack.php

.github/workflows/phpcs.yml

ScheduleReportSlack.php

tests/UI/Slack_spec.js

tests/UI/expected-ui-screenshots/Slack_slack_report_save_report.png

tests/UI/expected-ui-screenshots/Slack_slack_report_save.png

Slack.php

AltamashShaikh · 2025-08-25T03:06:11Z

Looks alright overall. There's a lot to review. I left a few comments.

My biggest concern is whether this is going to be an open-source or premium plugin since it's in the matomo-org organisation and has GPL license throughout.

@snake14 I confirmed it with Stan, it is going to be an open-source plugin.

AltamashShaikh · 2025-08-25T08:33:35Z

@james-hill-matomo @snake14 Updated the PR description with steps to test this.

lang/en.json

james-hill-matomo

Looking close, only required change is a "You" -> "Your". One of us (me or Jacob) also needs to do a good local test.

james-hill-matomo

The ability to trigger an immediate sending of the report is a great feature.

I can't get it to work though. I created a new channel, and invited the bot into it.

Clicking the test button (before and after creating things in the slack) gives a successful response, but no message arrives in slack.

I added a comment in JIRA about how scheduled reports was originally aimed at a single person, which isn't really making sense as we're extending it in this direction.

james-hill-matomo · 2025-08-27T01:20:59Z

@AltamashShaikh Please update the dashboard https://github.com/innocraft/plugin-build-dashboard

AltamashShaikh · 2025-08-27T10:34:07Z

@james-hill-matomo @snake14 I noticed that we need to show display options when reportType is PDF, so updated the code for that, but that won't work unless matomo-org/matomo#23546 is merged.

AltamashShaikh · 2025-08-27T10:39:36Z

@AltamashShaikh Please update the dashboard https://github.com/innocraft/plugin-build-dashboard

Created - https://github.com/innocraft/plugin-build-dashboard/pull/3

james-hill-matomo

Tested OK in dev when I learned what a slack channel ID is.

Possibly out of scope, but the error message "Please specify a value for 'description'. " isn't very enlightening if you don't tick any of the Statistics Included boxes at the bottom of the page:

james-hill-matomo · 2025-08-29T05:03:35Z

Has to wait for core PR

AltamashShaikh · 2025-08-29T05:50:27Z

Has to wait for core PR

@james-hill-matomo If I don't specify any report and description is set, I get Please specify a value for 'reports' error

* Adds PHPStan to Slack plugin * Changed the level to 8 * Bumped phpstan level up to 5 Can bump the level that high with (almost) no errors. * Don't check github action with phpstan * Test changes for multiple channels * Reverted changes * Adds the multiple channel logic back * Fixes for pre-push hook to work locally * Changes to work on all branches and reduced the phpstan level to 5 for both created and updated * Force to 8 to ensure github action is working * test for GH action * More fixes around pre-push and reverted to level 5 * Changed level to 5 for update * Get correct branch for comparison * PHPStan work correctly with DDEV * Fixed context of cd for non ddev phpstan * Changes for pre-push to work for non-dev --------- Co-authored-by: James Hill <[email protected]>

snake14 · 2025-09-01T00:25:49Z

.git-hooks-matomo/pre-push

+fi
+# Use ddev if setup (overridding local setup)
+if command -v ddev >/dev/null 2>&1; then


This was causing issues for me since I have both php and ddev installed.

Suggested change

fi

# Use ddev if setup (overridding local setup)

if command -v ddev >/dev/null 2>&1; then

# Use ddev if setup (overridding local setup)

elif command -v ddev >/dev/null 2>&1; then

@james-hill-matomo Looks good to me this suggestion, what about you ?

@AltamashShaikh @snake14 I'd rather ddev was the first choice, but even more than that I'm happy to merge this as is, as it'll probably never matter anyway.

Anything works for me, having ddev first should also work

AltamashShaikh · 2025-09-01T02:23:49Z

@james-hill-matomo @snake14 Are we good to merge this PR ? We won't be releasing the plugin this week hopefully next release cycle, when we have all the FAQs and helptext ready.

james-hill-matomo · 2025-09-01T03:00:52Z

@james-hill-matomo @snake14 Are we good to merge this PR ? We won't be releasing the plugin this week hopefully next release cycle, when we have all the FAQs and helptext ready.

I'm OK to merge this.

I've got various UI complaints (no way for users to know what a Slack Channel ID is without looking up FAQs, no feedback if you put in an invalid slack channel ID, confusing error message if you don't choose any of the Statistics Included options - but this is to the standard of the UI in general so I won't insist on fixes.

AltamashShaikh added 11 commits August 22, 2025 07:21

Initial PR to send scheduled reports to a Slack channel, #PG-4491

5e707e7

test fixes

edadd47

Added UI test

6e8dd35

updated UI screenshot

699a841

Fixes for test

30720e9

Test fix

d3629e1

Test fixes

1b674ec

UI test fixes

0158fca

Fixes UI test

99c5115

Ui test

70e3172

Updated UI screenshot

ed18883

AltamashShaikh added the Needs Review For pull requests that need a code review. label Aug 22, 2025

AltamashShaikh requested a review from a team August 22, 2025 12:11

AltamashShaikh added 2 commits August 22, 2025 17:52

Image uodated

2349db0

UI screenshot updated

8bec9b9

snake14 reviewed Aug 24, 2025

View reviewed changes

james-hill-matomo requested changes Aug 25, 2025

View reviewed changes

AltamashShaikh added 2 commits August 25, 2025 13:42

Applied PR feedback

862733f

Fixes UI test

67c420f

AltamashShaikh requested review from james-hill-matomo and snake14 August 25, 2025 08:33

james-hill-matomo reviewed Aug 26, 2025

View reviewed changes

lang/en.json Outdated Show resolved Hide resolved

james-hill-matomo requested changes Aug 26, 2025

View reviewed changes

AltamashShaikh added 2 commits August 26, 2025 07:57

Fix typo

f5b5c2a

Adds missing group and updated UI screenshot

3cf03a3

AltamashShaikh requested a review from james-hill-matomo August 26, 2025 02:33

james-hill-matomo previously approved these changes Aug 27, 2025

View reviewed changes

adds code for display and evolution graph to work

5e47178

AltamashShaikh dismissed james-hill-matomo’s stale review via 5e47178 August 27, 2025 10:16

Fixes failing tests

c74d2d2

AltamashShaikh requested a review from james-hill-matomo August 27, 2025 10:34

Updated code to send file to multiple slack channels

35cd206

james-hill-matomo previously approved these changes Aug 29, 2025

View reviewed changes

james-hill-matomo dismissed their stale review via ebbbc48 August 31, 2025 21:21

snake14 reviewed Sep 1, 2025

View reviewed changes

Release date updated

37fd322

AltamashShaikh requested review from james-hill-matomo and snake14 September 1, 2025 02:28

james-hill-matomo approved these changes Sep 1, 2025

View reviewed changes

AltamashShaikh merged commit 13b71a2 into 5.x-dev Sep 1, 2025
8 checks passed

AltamashShaikh deleted the PG-4491-schedule-report-slack branch September 1, 2025 05:08

Initial PR to send scheduled reports to a Slack channel, #PG-4491 #1

Initial PR to send scheduled reports to a Slack channel, #PG-4491 #1

Uh oh!

Conversation

AltamashShaikh commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issue No

Steps to Replicate the Issue

Checklist

Uh oh!

snake14 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

snake14 Aug 24, 2025

Choose a reason for hiding this comment

Uh oh!

james-hill-matomo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AltamashShaikh commented Aug 25, 2025

Uh oh!

AltamashShaikh commented Aug 25, 2025

Uh oh!

Uh oh!

james-hill-matomo left a comment

Choose a reason for hiding this comment

Uh oh!

james-hill-matomo left a comment

Choose a reason for hiding this comment

Uh oh!

james-hill-matomo commented Aug 27, 2025

Uh oh!

AltamashShaikh commented Aug 27, 2025

Uh oh!

AltamashShaikh commented Aug 27, 2025

Uh oh!

james-hill-matomo left a comment

Choose a reason for hiding this comment

Uh oh!

james-hill-matomo commented Aug 29, 2025

Uh oh!

AltamashShaikh commented Aug 29, 2025

Uh oh!

snake14 Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

AltamashShaikh Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

james-hill-matomo Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

AltamashShaikh Sep 1, 2025

Choose a reason for hiding this comment

Uh oh!

AltamashShaikh commented Sep 1, 2025

Uh oh!

james-hill-matomo commented Sep 1, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

AltamashShaikh commented Aug 22, 2025 •

edited

Loading