whip
whip copied to clipboard
Yoast
`WHIP_VERSION` constant logic is flawed
If I understood correctly, WHIP should work when installed in several different versions by different plugins. However, the way this is currently implemented will not work.
The constant WHIP_VERSION will only ever be defined once. If an old version gets loaded first, all other versions will use the version string of that version.
Do you have any idea how to solve this? I think we can never reliably discern which minor version is in use because we are always struggling with the autoloading order. We can discern major versions because we change the postfix of the classes for each major version.
I would opt for only returning the version in the file. Any location we need the version we just need to require that file then. We would drop the constant altogether.
Thoughts?
A mechanism I have seen that works with WP and uses the built-in mechanisms is to use the action priorities coupled to the version.
So, for example, you start at a high number with your hook priority, and the higher your version is, the more you subtract from the priority.
In this way, when you're loading several different versions at once, the one with the highest version will be triggered first. This one can then set a constant, that lets all the other versions know that stuff is already taken care of.
So, as an example:
WHIP 1.1 => init:9999
WHIP 2.2 => init:9988
WHIP 1.0 => init:10000
WHIP 2.0 => init:9990
The init:9988 hook will be triggered first, version 2.2. This one can then set constants to deactivate all the others.
Another way to do this is to use a static variable for the instance, and each time a new version loads, if it is more recent than the currently set instance, it replaces that instance. All the later code will always fetch that instance first before doing anything, so they always get the most recent version.
So, the object that a user instantiates would only be a proxy. The actual implementation set within that proxy could be replaced with more recent versions, without any of the consuming code noticing (provided that you remain backwards compatible).
For now, I have changed version.php to only return the version and not set a constant. This will fix the version reconciliation for major versions but not for minor&patch versions. This will do for now.
The plan is to fix minor versions later using Mozart.
I haven't checked the Mozart package in detail, but at a quick glance it looked to me like it string-replaced a given namespace with a prefixed namespace. As you don't have any namespace at all, that will likely not do anything.
@schlessera Coen is working on a classmap implementation that also works for PHP5.2: https://github.com/coenjacobs/mozart/pull/4/
Keep in mind that this will then load Whip multiple times in different versions with different namespaces. You still need to devise a way of only showing notices ones and communicating across versions to only let the newest one be active.
Ah, if I remember correctly, you use a global with the version number as key, right? That should probably be enough to start, just think of adding some kind of "killswitch" so that future versions can force older ones to not do anything.
You'll need to think of a different mechanism for the Facades when using Mozart, as the function cannot be autoloaded and will only be declared once. Within that function, you have class names and file paths that will point to one specific version (and probably not the correct one).