A rising tide lifts all boats. -- United States President, John F. Kennedy (borrowed from the New England Council)
Inspired by the proverb "A rising tide lifts all boats", we want to lift the quality of code across the WordPress ecosystem. Tide’s vision is to run automated quality testing for all WordPress plugins and themes and make those test results visible for the authors and end users of those plugins and themes. This will help improve the quality of code throughout the WordPress ecosystem and help WordPress site owners make better choices about plugins and themes.
The Tide project is an official component of the WordPress project and in the early stages of development. Today, Tide scans all WordPress plugins and themes and provides scan results as JSON through the Tide API.
The next step is to use the JSON output in the WordPress plugin and theme repository to show PHP compatibility information. This will help drive the adoption of the newest PHP versions as both plugin/theme authors and WordPress site owners installing those plugins and themes will be more aware of the PHP compatibility of each plugin/theme.
Progress can be followed in the WordPress Meta issue tracker (ticket #4309).
Tide services are responsible for the following:
- The wptide.org website (built with VuePress) includes this documentation and serves the Tide API JSON endpoints. Visit the Specification page to see examples of the API response.
- The Lighthouse Server reads messages from a queue and runs Google Lighthouse reports against themes only, then writes the results back to the Tide API.
- The PHPCS Server reads messages from a queue and runs reports against both plugins and themes, then writes the results back to the Tide API.
- The Sync Server makes scheduled requests to the WordPress.org Themes and Plugins API's to determine which projects have changed since the last request, then adds them to a Pub/Sub queue associated by report type which is then processed by the relevant Report Server.
In addition, we are working on the meta repository of WordPress.org to handle fetching the reports generated by Tide and showing summaries of them in the WordPress.org plugin and theme directories.
- Tide syncer initiates an audit and fetches the reports from the Tide API.
- Plugin widget is where the Tide API data will be publicly visible.
The following diagram notes which Google Cloud Platform (GCP) components are used to represent the various Tide services, and how the themes and plugins API on WordPress.org connects to the Sync Server. The basic flow is that a User or an API Client will make a request to the Tide REST API, which sends back a response. The request could create messages in the queue where one or more services process them by running automated scripts and writing the results back to the Tide API. Additionally, the Sync Server will poll the WordPress.org API's for new themes and plugins to add to the message queue.
@todo
Currently, you can:
- Request plugins & themes using the Specification page which allows you to make requests to the various Tide API endpoints using a built-in UI generated from our OpenAPI v3 Specification.
- Install Tide to help test and develop locally.
- Deploy Tide to Google Cloud and run your own variation of Tide in the cloud.
In the future, we hope to provide authors with the ability to use Tide as a service to test their plugins or themes during development.
There are many ways to contribute to Tide. You can help us champion the adoption of the quality testing results in the WordPress project. You can also help by contributing code or documentation to Tide itself.
Please read our Contributing guide for details on the process of creating a ticket or submitting a pull request to Tide, and our Code of Conduct.
Derek Herman (@derekherman), and Jeff Paul (@jeffpaul)
Props: Anthony Burchell (@antpb), Bartosz Gadomski (@bartoszgadomski), Derek Herman (@derekherman), Jeff Paul (@jeffpaul), Jonathan Wold (@sirjonathan), Jozef Benko (joe-xwp), Ivan Kruchkoff (@ivankruchkoff), Piotr Bajer (@piotr-bajer)
The following contributors are those that helped support, manage, design, or develop Tide before the refactor to Node from Golang.
Props: Alberto A. Medina (@amedina), Bartek Makoś (@MakiBM), Brendan Woods (@brendanwoods-xwp), Cathi Bosco (@cathibosco), Daniel Louw (@danlouw), David Cramer (@davidcramer), David Lonjon (@davidlonjon), Derek Herman (@derekherman), Dušan D. Majkić (@dmajkic), Ilya Grigorik (@igrigorik), Janki Moradiya (@jankimoradiya), Jeff Paul (@jeffpaul), Jonathan Wold (@sirjonathan), Joshua Wold (@jwold), Justin Kopepasah (@kopepasah), Keanan Koppenhaver (@kkoppenhaver), Leo Postovoit (@postphotos), Lubos Kmetko (@luboskmetko), Luke Carbis (@lukecarbis), Meet Makadia (@mrmakadia94), Miina Sikk (@miina), Mike Crantea (@mehigh), Otto Kekäläinen (@ottok), Pierre Gordon (@pierlon), Scott Reilly (@coffee2code), Rheinard Korf (@rheinardkorf), Rob Stinson (@robstino), Sayed Taqui (@sayedtaqui), Ulrich Pogson (@grappler), Utkarsh Patel (@PatelUtkarsh)
Have questions? Join us in the #tide channel in
WordPress Slack. If you're new to Slack, keep in mind that it sometimes takes
several hours for community members to respond — thank you for being patient!