Merge branch 'develop' into fix/private-fields

.env.testing

@@ -1,18 +1,20 @@
-TEST_SITE_DB_DSN=mysql:host=localhost;dbname=test
-TEST_SITE_DB_HOST=localhost
+TEST_SITE_DB_DSN=mysql:host=db;dbname=test
+TEST_SITE_DB_HOST=db
 TEST_SITE_DB_NAME=test
 TEST_SITE_DB_USER=root
-TEST_SITE_DB_PASSWORD=
+TEST_SITE_DB_PASSWORD=password
 TEST_SITE_TABLE_PREFIX=wp_
 TEST_SITE_ADMIN_USERNAME=admin
 TEST_SITE_ADMIN_PASSWORD=password
 TEST_SITE_WP_ADMIN_PATH=/wp-admin
 WP_ROOT_FOLDER=/var/www/html
 TEST_DB_NAME=test
-TEST_DB_HOST=localhost
+TEST_DB_HOST=db
 TEST_DB_USER=root
-TEST_DB_PASSWORD=
+TEST_DB_PASSWORD=password
 TEST_TABLE_PREFIX=wp_
 TEST_SITE_WP_URL=http://wordpress.test
 TEST_SITE_WP_DOMAIN=wordpress.test
 TEST_SITE_ADMIN_EMAIL=[email protected]
+
+USING_CONTAINERS=1

.env.testing.slic

@@ -1,4 +1,4 @@
-TEST_SITE_DB_DSN=mysql:host=localhost;dbname=test
+TEST_SITE_DB_DSN=mysql:host=db;dbname=test
 TEST_SITE_DB_HOST=db
 TEST_SITE_DB_NAME=test
 TEST_SITE_DB_USER=root

.github/workflows/compatibility.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Configure PHP environment
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 7.4
+          php-version: '8.0'
           extensions: mbstring, intl
           coverage: none
 

.github/workflows/tests.yml

@@ -58,6 +58,7 @@ jobs:
         run: |
           cd ${GITHUB_WORKSPACE}/..
           ${SLIC_BIN} here
+          ${SLIC_BIN} php-version set 8.2 --skip-rebuild
           ${SLIC_BIN} interactive off
           ${SLIC_BIN} build-prompt off
           ${SLIC_BIN} build-subdir off

.lando.yml

@@ -9,7 +9,7 @@ excludes:
   - .github
 
 config:
-  php: '7.4'
+  php: '8.0'
   via: nginx
   database: mysql
   webroot: dev/public

README.md

@@ -7,37 +7,17 @@ A library for Opt-in and Telemetry data to be sent to the StellarWP Telemetry se
 	- [Table of Contents](#table-of-contents)
 	- [Installation](#installation)
 	- [Usage Prerequisites](#usage-prerequisites)
+	- [Filters \& Actions](#filters--actions)
 	- [Integration](#integration)
 	- [Uninstall Hook](#uninstall-hook)
 	- [Opt-In Modal Usage](#opt-in-modal-usage)
 		- [Prompting Users on a Settings Page](#prompting-users-on-a-settings-page)
 	- [Saving Opt-In Status on a Settings Page](#saving-opt-in-status-on-a-settings-page)
 	- [How to Migrate Users Who Have Already Opted In](#how-to-migrate-users-who-have-already-opted-in)
 	- [Utilizing a Shared Telemetry Instance](#utilizing-a-shared-telemetry-instance)
-	- [Filter Reference](#filter-reference)
-		- [stellarwp/telemetry/{hook-prefix}/should\_show\_optin](#stellarwptelemetryhook-prefixshould_show_optin)
-		- [stellarwp/telemetry/{hook-prefix}/option\_name](#stellarwptelemetryhook-prefixoption_name)
-		- [stellarwp/telemetry/{hook-prefix}/optin\_status](#stellarwptelemetryhook-prefixoptin_status)
-		- [stellarwp/telemetry/{hook-prefix}/optin\_status\_label](#stellarwptelemetryhook-prefixoptin_status_label)
-		- [stellarwp/telemetry/optin\_args](#stellarwptelemetryoptin_args)
-		- [stellarwp/telemetry/{stellar\_slug}/optin\_args](#stellarwptelemetrystellar_slugoptin_args)
-		- [stellarwp/telemetry/{hook-prefix}/show\_optin\_option\_name](#stellarwptelemetryhook-prefixshow_optin_option_name)
-		- [stellarwp/telemetry/{hook-prefix}/register\_site\_url](#stellarwptelemetryhook-prefixregister_site_url)
-		- [stellarwp/telemetry/{hook-prefix}/register\_site\_data](#stellarwptelemetryhook-prefixregister_site_data)
-		- [stellarwp/telemetry/{hook-prefix}/register\_site\_user\_details](#stellarwptelemetryhook-prefixregister_site_user_details)
-		- [stellarwp/telemetry/{hook-prefix}/send\_data\_args](#stellarwptelemetryhook-prefixsend_data_args)
-		- [stellarwp/telemetry/{hook-prefix}/send\_data\_url](#stellarwptelemetryhook-prefixsend_data_url)
-		- [stellarwp/telemetry/{hook-prefix}/last\_send\_expire\_seconds](#stellarwptelemetryhook-prefixlast_send_expire_seconds)
-		- [stellarwp/telemetry/exit\_interview\_args](#stellarwptelemetryexit_interview_args)
-		- [stellarwp/telemetry/{stellar\_slug}/exit\_interview\_args](#stellarwptelemetrystellar_slugexit_interview_args)
-		- [stellarwp/telemetry/{hook-prefix}/event\_data](#stellarwptelemetryhook-prefixevent_data)
-		- [stellarwp/telemetry/{hook-prefix}/events\_url](#stellarwptelemetryhook-prefixevents_url)
-	- [Action Reference](#action-reference)
-		- [stellarwp/telemetry/optin](#stellarwptelemetryoptin)
-		- [stellarwp/telemetry/{hook-prefix}/optin](#stellarwptelemetryhook-prefixoptin)
-		- [stellarwp/telemetry/{hook-prefix}/event](#stellarwptelemetryhook-prefixevent)
 	- [Adding Plugin Data to Site Health](#adding-plugin-data-to-site-health)
 	- [Capturing User Events](#capturing-user-events)
+	- [Contribution](#contribution)
 ## Installation
 
 It's recommended that you install Telemetry as a project dependency via [Composer](https://getcomposer.org/):
@@ -52,10 +32,12 @@ composer require stellarwp/telemetry
 > Luckily, adding Strauss to your `composer.json` is only slightly more complicated than adding a typical dependency, so checkout our [strauss docs](https://github.com/stellarwp/global-docs/blob/main/docs/strauss-setup.md).
 
 ## Usage Prerequisites
-To actually _use_ the telemetry library, you must have a Dependency Injection Container (DI Container) that is compatible with [di52](https://github.com/lucatume/di52) (_We recommend using di52_).
+To actually _use_ the telemetry library, you must have a Dependency Injection Container (DI Container) that is compatible with the [StellarWP Container Contract](https://github.com/stellarwp/container-contract).
 
-In order to keep this library as light as possible, a container is not included in the library itself. To avoid version compatibility issues, it is also not included as a Composer dependency. Instead, you must include it in your project. We recommend including it via composer [using Strauss](https://github.com/stellarwp/global-docs/blob/main/docs/strauss-setup.md), just like you have done with this library.
+In order to keep this library as light as possible, a container is not included in the library itself, however we do recommend [di52](https://github.com/lucatume/di52). To avoid version compatibility issues, it is also not included as a Composer dependency. Instead, you must include it in your project. We recommend including it via composer [using Strauss](https://github.com/stellarwp/global-docs/blob/main/docs/strauss-setup.md), just like you have done with this library.
 
+## Filters & Actions
+If you'd like to take a look at the existing filters & actions available through the library, [view that documentation here](docs/filters.md).
 ## Integration
 Initialize the library within your main plugin file after plugins are loaded (or anywhere else you see fit). You can configure a unique prefix (we suggest you use your plugin slug) so that hooks can be uniquely called for your specific instance of the library.
 
@@ -127,7 +109,10 @@ When a user deletes the plugin, WordPress runs the method from `Uninstall` and c
 
 ## Opt-In Modal Usage
 
+![The default modal shown to users that have not dismissed it yet.](docs/img/default-opt-in-modal.png)
+
 ### Prompting Users on a Settings Page
+
 On each settings page you'd like to prompt the user to opt-in, add a `do_action()`. _Be sure to include your defined stellar\_slug_.
 ```php
 do_action( 'stellarwp/telemetry/optin', '{stellar_slug}' );
@@ -232,212 +217,6 @@ function add_plugin_to_telemetry() {
 }
 ```
 
-## Filter Reference
-
-If you configured this library to use a hook prefix, note that all hooks will now use this prefix. For example:
-```php
-add_filter( 'stellarwp/telemetry/my-custom-prefix/should_show_optin', 'my-custom-filter', 10, 1 );
-```
-### stellarwp/telemetry/{hook-prefix}/should_show_optin
-Filters whether the user should be shown the opt-in modal.
-
-**Parameters**: _bool_ `$should_show`
-
-**Default**: `true`
-
-### stellarwp/telemetry/{hook-prefix}/option_name
-Filter the option name used to store current users' optin status.
-
-**Parameters**: _string_ `$option_name`
-
-**Default**: `stellarwp_telemetry`
-
-### stellarwp/telemetry/{hook-prefix}/optin_status
-Filter the optin status of the current site.
-
-**Parameters**: _integer_ `$status`
-
-**Default**: `1`
-
-Each status corresponds with an integer:
-```php
-1 = 'Active',
-2 = 'Inactive',
-3 = 'Mixed',
-```
-### stellarwp/telemetry/{hook-prefix}/optin_status_label
-Filter the label used to show the current opt-in status of the site.
-
-**Parameters**: _string_ `$optin_label`
-
-**Default**: see: [stellarwp/telemetry/optin_status](#stellarwptelemetryoptin_status)
-### stellarwp/telemetry/optin_args
-Filter the arguments passed to the opt-in modal.
-
-**Parameters**: _array_ `$args`, _string_ `$stellar_slug`
-
-**Default**:
-```php
-$args = [
-	'plugin_logo'           => Resources::get_asset_path() . 'resources/images/stellar-logo.svg',
-	'plugin_logo_width'     => 151,
-	'plugin_logo_height'    => 32,
-	'plugin_logo_alt'       => 'StellarWP Logo',
-	'plugin_name'           => 'The Events Calendar',
-	'plugin_slug'           => $stellar_slug,
-	'user_name'             => wp_get_current_user()->display_name,
-	'permissions_url'       => '#',
-	'tos_url'               => '#',
-	'privacy_url'           => '#',
-	'opted_in_plugins_text' => __( 'See which plugins you have opted in to tracking for', 'stellarwp-telemetry' ),
-	'heading'               => __( 'We hope you love {plugin_name}.', 'stellarwp-telemetry' ),
-	'intro'                 => __( 'Hi, {user_name}.! This is an invitation to help our StellarWP community. If you opt-in, some data about your usage of {plugin_name} and future StellarWP Products will be shared with our teams (so they can work their butts off to improve). We will also share some helpful info on WordPress, and our products from time to time. And if you skip this, that’s okay! Our products still work just fine.', 'stellarwp-telemetry' ),
-];
-```
-### stellarwp/telemetry/{stellar_slug}/optin_args
-This filter will be deprecated in future versions. Use [stellarwp/telemetry/optin_args](#stellarwptelemetrystellar_slugoptin_args) instead.
-
-### stellarwp/telemetry/{hook-prefix}/show_optin_option_name
-Filters the string used for the option that determines whether the opt-in modal should be shown.
-
-**Parameters**: _string_ `$option_name`
-
-**Default**: `stellarwp_telemetry_{plugin_slug}_show_optin`
-### stellarwp/telemetry/{hook-prefix}/register_site_url
-Filters the url of the telemetry server that will store the site data when registering a new site.
-
-**Parameters**: _string_ `$url`
-
-**Default**: `https://telemetry.example.com/api/v1/register-site`
-### stellarwp/telemetry/{hook-prefix}/register_site_data
-Filters the data that is sent to the telemetry server when registering a new site.
-
-**Parameters**: _array_ `$site_data`
-
-**Default**:
-```php
-$site_data = [
-	'telemetry' => json_encode( $this->provider->get_data() ),
-];
-```
-### stellarwp/telemetry/{hook-prefix}/register_site_user_details
-Filters the user details that is sent to the telemetry server when registering a new site.
-
-**Parameters**: _array_ `$user_details`
-
-**Default**:
-```php
-$user_details = [
-	'name'  => $user->display_name,
-	'email' => $user->user_email,
-	'plugin_slug' => Config::get_container()->get( Core::PLUGIN_SLUG ),
-];
-```
-### stellarwp/telemetry/{hook-prefix}/send_data_args
-
-**Parameters**: _array_ $data_args
-
-**Default**:
-```php
-$data_args = [
-	'token'     => $this->get_token(),
-	'telemetry' => json_encode( $this->provider->get_data() ),
-];
-```
-
-### stellarwp/telemetry/{hook-prefix}/send_data_url
-Filters the full url to use when sending data to the telemetry server.
-
-**Parameters**: _string_ `$url`
-
-**Default**: `https://telemetry.example.com/api/v1/telemetry`
-
-### stellarwp/telemetry/{hook-prefix}/last_send_expire_seconds
-Filters how often the library should send site health data to the telemetry server.
-
-**Parameters**: _integer_ `$seconds`
-
-**Default**: `7 * DAY_IN_SECONDS`
-
-### stellarwp/telemetry/exit_interview_args
-Filters the arguments used in the plugin deactivation "exit interview" form.
-
-**Parameters**: _array_ `$args`, _string_ `$stellar_slug`
-
-**Default**:
-```php
-$args = [
-	'plugin_slug'        => $stellar_slug,
-	'plugin_logo'        => plugin_dir_url( __DIR__ ) . 'public/logo.png',
-	'plugin_logo_width'  => 151,
-	'plugin_logo_height' => 32,
-	'plugin_logo_alt'    => 'StellarWP Logo',
-	'heading'            => __( 'We’re sorry to see you go.', 'stellarwp-telemetry' ),
-	'intro' 		     => __( 'We’d love to know why you’re leaving so we can improve our plugin.', 'stellarwp-telemetry' ),
-	'questions'          => [
-		[
-			'question'   => __( 'I couldn’t understand how to make it work.', 'stellarwp-telemetry' ),
-			'show_field' => true
-		],
-		[
-			'question'   => __( 'I found a better plugin.', 'stellarwp-telemetry' ),
-			'show_field' => true
-		],
-		[
-			'question'   => __( 'I need a specific feature it doesn’t provide.', 'stellarwp-telemetry' ),
-			'show_field' => true
-		],
-		[
-			'question'   => __( 'The plugin doesn’t work.', 'stellarwp-telemetry' ),
-			'show_field' => true
-		],
-		[
-			'question'   => __( 'It’s not what I was looking for.', 'stellarwp-telemetry' ),
-			'show_field' => true
-		]
-	],
-];
-```
-
-### stellarwp/telemetry/{stellar_slug}/exit_interview_args
-This filter will be deprecated in future versions. Use [stellarwp/telemetry/exit_interview_args](#stellarwptelemetrystellar_slugexit_interview_args) instead.
-
-### stellarwp/telemetry/{hook-prefix}/event_data
-Filters the array of data sent along with the event.
-
-**Parameters**: _array_ `$data`
-
-**Default**:
-```php
-$data = [
-	'token'        => $this->telemetry->get_token(),
-	'stellar_slug' => Config::get_stellar_slug(),
-	'event'        => $name,
-	'event_data'   => wp_json_encode( $data ),
-];
-```
-### stellarwp/telemetry/{hook-prefix}/events_url
-Filters the event URL used when sending events to the Telemetry server.
-
-**Parameters**: _string_ `$url`
-
-**Default**: `https://telemetry.stellarwp.com/api/v1/events`
-
-## Action Reference
-
-### stellarwp/telemetry/optin
-
-**Parameters**: _string_ `$stellar_slug` The stellar slug of the plugin for which the modal should be shown.
-### stellarwp/telemetry/{hook-prefix}/optin
-This filter will be deprecated in future versions. Use [stellarwp/telemetry/optin](#stellarwptelemetryoptin) instead.
-
-### stellarwp/telemetry/{hook-prefix}/event
-Sends a site event to the Telemetry server.
-
-**Parameters**:
-- _string_ `$event` The name of the event.
-- _array_ `$data` A set of data that should be passed along with the event.
-
 ## Adding Plugin Data to Site Health
 
 We collect the Site Health data as json on the server.  In order to pass additional plugin specific items that can be reported on, you will need to add a section to the Site Health Data. The process for adding a section is documented on [developer.wordpress.org](https://developer.wordpress.org/reference/hooks/debug_information/).
@@ -535,3 +314,10 @@ function user_creates_post( $post_id, $post, $update ) {
 	do_action( 'stellarwp/telemetry/{hook-prefix}/event', 'new_post', $event_data );
 }
 ```
+
+## Contribution
+
+There are more detailed docs that provide guidance on contributing to the library:
+- [Automated testing](/docs/automated-testing.md)
+- [Local Environment Configuration](/docs/local-environment.md)
+- [Quality Assurance](/docs/quality-assurance.md)

codeception.dist.yml

@@ -10,11 +10,9 @@ extensions:
         - Codeception\Extension\RunFailed
     commands:
         - Codeception\Command\GenerateWPUnit
-        - Codeception\Command\GenerateWPRestApi
-        - Codeception\Command\GenerateWPRestController
-        - Codeception\Command\GenerateWPRestPostTypeController
-        - Codeception\Command\GenerateWPAjax
-        - Codeception\Command\GenerateWPCanonical
-        - Codeception\Command\GenerateWPXMLRPC
 params:
     - .env.testing
+coverage:
+    enabled: true
+    include:
+      - src/Telemetry/*.php

composer.json

@@ -30,27 +30,20 @@
   },
   "require-dev": {
     "automattic/vipwpcs": "^2.3",
-    "codeception/module-asserts": "^1.0",
-    "codeception/module-cli": "^1.0",
-    "codeception/module-db": "^1.0",
-    "codeception/module-filesystem": "^1.0",
-    "codeception/module-phpbrowser": "^1.0",
-    "codeception/module-webdriver": "^1.0",
-    "codeception/util-universalframework": "^1.0",
     "dealerdirect/phpcodesniffer-composer-installer": "^0.7.2",
     "lucatume/di52": "3.0.0",
-    "lucatume/wp-browser": "^3.1",
-    "szepeviktor/phpstan-wordpress": "^1.1",
+    "lucatume/wp-browser": "^4.0",
     "phpcompatibility/phpcompatibility-wp": "*",
+    "phpunit/php-code-coverage": "^9.2",
+    "szepeviktor/phpstan-wordpress": "^1.1",
     "the-events-calendar/coding-standards": "dev-master",
     "wp-coding-standards/wpcs": "^2.3"
   },
   "repositories": [
     {
       "name": "the-events-calendar/coding-standards",
       "type": "github",
-      "url": "https://github.com/the-events-calendar/coding-standards",
-      "no-api": true
+      "url": "https://github.com/the-events-calendar/coding-standards"
     }
   ],
   "scripts": {