REST API logic in Optimization Detective can be encapsulated into a ~static~ class

[westonruter]

Feature Description

Optimization Detective currently has static classes for OD_Storage_Lock and OD_URL_Metrics_Post_Type, but it has a rest-api.php includes file with global functions and constants. The REST API logic would make sense to also put into a static class so there is consistency. It would also help with reducing the API surface for functions not needing to be public.

[hbhalodia]

Hi @westonruter, If I had correctly understood, we need to update the file rest-api.php to class-rest-api.php and add all constants, action functions to static class variables and methods?

[westonruter]

Yes, to class-od-rest-api.php. Also, add an add_hooks() method which can be used in hooks.php instead of directly referencing the methods in adding hooks there. This was done for the storage lock and post type classes as well.

[hbhalodia]

Yes, thanks for the clarification, I would proceed with the changes and would update once done.

[westonruter]

Previous reference to this issue: #1098 (comment)

[westonruter]

I've merged #1863 so you can now branch off of trunk and not get merge conflicts.

[felixarntz]

Curious why we should use a static class instead of regular class that is instantiated. The Core endpoints are all written in the latter way.

[westonruter]

It doesn't have to be static but there's not really any value in it not being static. The classes for the storage lock and post type are also static.

[felixarntz]

But there's also no value in being static :)

Instances have a general advantage of being easier to test in case they have any state, because you can just create a new instance for every test. With static classes, you would need workarounds for this kind of thing. This may not be a huge concern depending on what the class does here, but worth considering.