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

Deprecate no longer needed / wanted events #7837

Closed
tsteur opened this issue May 5, 2015 · 6 comments
Closed

Deprecate no longer needed / wanted events #7837

tsteur opened this issue May 5, 2015 · 6 comments
Assignees
Labels
c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself.
Milestone

Comments

@tsteur
Copy link
Member

tsteur commented May 5, 2015

Piwik 3.0.0 will be happening soon. Therefore we should mark some events as deprecated soon. This will allow us to remove them in Piwik 3.0.0. We also need to make sure to remove those events in a follow up issue in Piwik 3.0.0. Why is this important? Imagine you update from 2.X to 3.0.0. Your Piwik works fine. If we actually remove those events in 3.1.0 and someone else updates to 3.1.0 it can break his Piwik although such an update should not break as it is not a major version update.

In the past I noticed some events that are no longer really needed/wanted, should be renamed or cause performance problems (like Site.getSite did). We should go over the list of events (http://developer.piwik.org/api-reference/events) and see if this is the case for some of them. Please comment if you know any event.

Part of this issue is also to make sure that all deprecated events are documented in our developer changelog. Eg we already deprecated many events like Menu.Reporting.addItems, API.getReportMetadata, WidgetsList.addWidgets.

@tsteur tsteur added Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. labels May 5, 2015
@tsteur tsteur added this to the Piwik 2.14.0 milestone May 5, 2015
@tsteur
Copy link
Member Author

tsteur commented May 5, 2015

I'd like to deprecate following events:

  • Tracker.existingVisitInformation
  • Tracker.getVisitFieldsToPersist
  • Tracker.makeNewVisitObject
  • Tracker.newConversionInformation
  • Tracker.newVisitorInformation
  • Tracker.recordAction
  • Tracker.recordEcommerceGoal
  • Tracker.recordStandardGoals

They were kinda all replaced by Dimension classes. Deprecating them will at least allow us to remove them at some point.

Maybe:

  • View.ReportsByDimension.render I'm not sure if it's used / needed and for what.

I need to look later again re events.

@mattab
Copy link
Member

mattab commented May 6, 2015

It would be great if we could deprecate ScheduledReports events:

  • ScheduledReports.allowMultipleReports
  • ScheduledReports.getRendererInstance
  • ScheduledReports.getReportFormats
  • ScheduledReports.getReportMetadata
  • ScheduledReports.getReportParameters
  • ScheduledReports.getReportRecipients
  • ScheduledReports.getReportTypes
  • ScheduledReports.processReports
  • ScheduledReports.sendReport
  • ScheduledReports.validateReport

cc @julienmoumne

(possibly we could replace them with a single class or so. )

@tsteur
Copy link
Member Author

tsteur commented Jun 9, 2015

Those events are actually used so it would not be done by simply deprecating them. We'd need to refactor the ScheduledReports. I reckon this won't be rather not doable for Piwik 3.0.0 so would maybe leave them there? If we have no other deprecations I would deprecate the Tracker events soon and close the issue.

@mattab
Copy link
Member

mattab commented Jun 9, 2015

@tsteur if we exclude ScheduledReports.* what are the next steps / work scope to deprecate those Tracker.* events?

eg. will we maybe need to write better developer documentation Re: dimensions, to let them know how to hook into Tracker (eg. new visit, new action, new goal conversion, new ecommerce conversion, etc.)

@tsteur
Copy link
Member Author

tsteur commented Jun 9, 2015

Yes, and I will write a short guide then. Basically, we will only document how to generate them and the difference between VisitDimension, ActionDimension and ConversionDimension. The generated code is already documented and will help them to get something down. This will be enough for the beginning as Archiving etc is still very complex anyway. Also PiwikPHPTracker misses methods to track custom data etc.

@tsteur tsteur modified the milestones: 2.14.1, 2.14.0 Jun 23, 2015
@mattab mattab modified the milestones: 2.15.0, 2.14.1 Jul 10, 2015
tsteur added a commit to matomo-org/developer-documentation that referenced this issue Aug 5, 2015
@tsteur tsteur self-assigned this Aug 6, 2015
@tsteur
Copy link
Member Author

tsteur commented Aug 6, 2015

FYI: I created a PR for the docs in matomo-org/developer-documentation#100 as we deprecate the events we need to provide docs for the alternative solution

tsteur added a commit that referenced this issue Aug 6, 2015
tsteur added a commit that referenced this issue Aug 21, 2015
@mattab mattab removed the Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change. label Oct 13, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself.
Projects
None yet
Development

No branches or pull requests

2 participants