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

Jump to bottom

Make matomo.js and matomo.php the default Tracking API endpoints used #12785

Closed
mattab opened this issue Apr 29, 2018 · 2 comments · Fixed by #13596
Closed

Make matomo.js and matomo.php the default Tracking API endpoints used #12785

mattab opened this issue Apr 29, 2018 · 2 comments · Fixed by #13596
Assignees
@tsteur
Labels
Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical.
Milestone
3.8.0

Comments

@mattab
Copy link
Member

mattab commented Apr 29, 2018

As part of our ongoing to #12420 renaming of everything from Piwik to Matomo, the next most important step is that our JS Tracking code should reference matomo.js and matomo.php instead of piwik.js|php. This remaining use of "Piwik" seems to be the last highly visible mention left in the product.

Suggested steps:

  • The tracking code in Administration > Tracking code should reference matomo.js|php
  • The API output for SitesManager.getJavascriptTag and others like SitesManager.getImageTrackingCode should also reference matomo.js|php
  • it's very important that we keep backward compatibility, so the file "piwik.js" should still be there and be a copy of matomo.js file (we will need to update instructions on how to build the compiled matomo.js in https://github.com/matomo-org/matomo/blob/master/js/README.md#deployment
  • And add a ReleaseChecklist test that the matomo.js is the same as piwik.js
  • Search and check/replace all occurences of piwik.js in the codebase (there are many)
  • Ideally we also rename the CustomPiwikJs plugin to CustomMatomoJs or CustomTrackerJs
  • Possibly other steps I missed
@mattab mattab added the Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. label Apr 29, 2018
@mattab mattab added this to the 3.6.0 milestone Apr 29, 2018
@tsteur
Copy link
Member

tsteur commented Apr 29, 2018

  • Developer docs need to be adjust everywhere and mention piwik.js or matomo.js
  • It can ONLY be changed for new installs, otherwise this is a breaking change as many projects and hosters might block anything that does not go to index.php or piwik.php such as the popular nginx configuration: https://github.com/perusio/piwik-nginx/blob/master/apps/piwik/piwik.conf . Therefore we need to make sure in API output it is only returned for new installs.
  • This needs to be also announced in advance as otherwise can cause failures where people handle piwik.js in a custom way like we do.
  • Tests need to use matomo.js
  • A mechanism needs to be there that also copies js/matomo.js to js/piwik.js and needs to be tested they are the same in ReleaseCheckList test
  • the global Matomo will need to be defined within piwik.js same as Piwik and this may needs announcement as well.

@mattab mattab modified the milestones: 3.6.0, 3.7.0 Jun 28, 2018
@mattab mattab mentioned this issue Jul 12, 2018
Closed
@tsteur tsteur mentioned this issue Sep 26, 2018
Closed
This was referenced Oct 9, 2018
Merged
Merged
@tsteur tsteur self-assigned this Oct 12, 2018
@tsteur tsteur mentioned this issue Oct 14, 2018
Closed
@tsteur
Copy link
Member

tsteur commented Oct 14, 2018

fyi this issue will also need matomo-org/matomo-log-analytics#224

@tsteur tsteur mentioned this issue Oct 14, 2018
Closed
@tsteur tsteur mentioned this issue Nov 29, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tsteur tsteur

Labels
Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical.
Projects
None yet
Milestone
3.8.0
Development

Successfully merging a pull request may close this issue.

Make matomo.js and matomo.php the default Tracking API endpoints used matomo-org/matomo
2 participants
@tsteur @mattab