Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow for marketplace provided plugin cover images #21879

Merged
merged 16 commits into from
Feb 14, 2024

Conversation

michalkleiner
Copy link
Contributor

@michalkleiner michalkleiner commented Feb 5, 2024

Description:

The change in this PR allows for use of cover images provided by the plugins marketplace while keeping the existing fallback images for Matomo vs 3rd party plugins.

The PR:

  • adds a mechanism to display a cover image specified in the plugin's metadata
  • tweaks the existing fallback logic so that all paid Matomo plugins without a cover image use the blue Matomo image and all other free plugins regardless of their vendor use the generic grey plugin image
  • adds a mechanism via the test config to replace remote image URLs with local test image URLs for UI tests
  • updates file formatting for all static marketplace fixtures for better legibility

There is also a follow-up draft PR #21915 which should be merged once the corresponding changes to the marketplace have been deployed so that the test there can pass.

ref. DEV-17378

Review

@michalkleiner
Copy link
Contributor Author

michalkleiner commented Feb 6, 2024

Failure for Piwik\Plugins\Marketplace\tests\System\Api\ClientTest::test_getPluginInfo_existingPluginOnTheMarketplace within the SystemTestsPlugins suites (for all 3 PHP versions) is expected until a corresponding change providing the category and coverImage fields is deployed to the marketplace.

I'd be happy to remove the change to the test and add it back after the marketplace change is deployed to production if that's preferred.

UPDATE: Discussed in person with MC and will move this to a separate PR that can be merged once the corresponding change is deployed to Marketplace PROD.

UPDATE 2: Moved to PR #21915

@michalkleiner michalkleiner added Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc. Needs Review PRs that need a code review labels Feb 6, 2024
@michalkleiner michalkleiner added this to the 5.1.0 milestone Feb 6, 2024
@michalkleiner
Copy link
Contributor Author

This change can be reviewed, merged and released independently of the marketplace changes as it provides defaults for the category and cover image in the same way how it worked before.

@caddoo caddoo self-assigned this Feb 8, 2024
@michalkleiner michalkleiner requested a review from a team February 14, 2024 05:54
Copy link
Member

@sgiehl sgiehl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me overall. Not sure how much sense it makes to merge it before the Marketplace change was applied.

@michalkleiner
Copy link
Contributor Author

Thanks @sgiehl. I know we don't want dead code that won't be used though I'm confident this will get through at the Marketplace end as well. Also, the change surface here is quite contained, so I think this can be merged. If we need to adjust anything I can follow up on that.

@michalkleiner michalkleiner merged commit 0e4c189 into 5.x-dev Feb 14, 2024
24 of 25 checks passed
@michalkleiner michalkleiner deleted the DEV-17378-marketplace-cover-images branch February 14, 2024 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc. Needs Review PRs that need a code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants