Merge pull request #78 from Kit/fix-tests-creator-network

Creator Network: Save Settings on WPForms Lite 1.9.4.0+

Author: n7studios

.env.dist.testing

@@ -8,7 +8,7 @@ TEST_SITE_ADMIN_USERNAME=admin
 TEST_SITE_ADMIN_PASSWORD=password
 TEST_SITE_ADMIN_EMAIL="[email protected]"
 TEST_SITE_WP_ADMIN_PATH=/wp-admin
-WP_ROOT_FOLDER="/home/runner/work/convertkit-wpforms/convertkit-wpforms/wordpress"
+WP_ROOT_FOLDER="/var/www/html"
 TEST_DB_NAME=test
 TEST_DB_HOST=localhost
 TEST_DB_USER=root

.github/workflows/coding-standards.yml

@@ -17,7 +17,7 @@ jobs:
 
     # Virtual Environment to use.
     # @see: https://github.com/actions/virtual-environments
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     # Environment Variables.
     # Accessible by using ${{ env.NAME }}

.github/workflows/deploy-readme.yml

@@ -11,7 +11,7 @@ jobs:
 
     # Virtual Environment to use
     # @see: https://github.com/actions/virtual-environments
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     # Steps to deploy
     steps:

.github/workflows/deploy.yml

@@ -17,15 +17,15 @@ jobs:
 
     # Virtual Environment to use.
     # @see: https://github.com/actions/virtual-environments
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     # Environment Variables.
     # Accessible by using ${{ env.NAME }}
     # Use ${{ secrets.NAME }} to include any GitHub Secrets in ${{ env.NAME }}
     # The base folder will always be /home/runner/work/github-repo-name/github-repo-name
     env:
-      ROOT_DIR: /home/runner/work/convertkit-wpforms/convertkit-wpforms/wordpress
-      PLUGIN_DIR: /home/runner/work/convertkit-wpforms/convertkit-wpforms/wordpress/wp-content/plugins/convertkit-wpforms
+      ROOT_DIR: /var/www/html
+      PLUGIN_DIR: /var/www/html/wp-content/plugins/convertkit-wpforms
       DB_NAME: test
       DB_USER: root
       DB_PASS: root
@@ -72,6 +72,13 @@ jobs:
           replace: '-'
           replaceAll: true
 
+      # Checkout Plugin to /home/runner/work/convertkit-wpforms/convertkit-wpforms/convertkit-wpforms
+      # We cannot checkout to ${{ env.PLUGIN_DIR }} as GitHub Actions require it be first placed in /home/runner/work/repo/repo
+      - name: Checkout Plugin
+        uses: actions/checkout@v4
+        with:
+          path: /home/runner/work/convertkit-wpforms/convertkit-wpforms/convertkit-wpforms
+
       - name: Start MySQL
         run: sudo systemctl start mysql.service
 
@@ -86,17 +93,15 @@ jobs:
 
       # Some workflows checkout WordPress from GitHub, but that seems to bring a bunch of uncompiled files with it.
       # Instead download from wordpress.org stable.
-      - name: Download WordPress
-        run: wget https://wordpress.org/wordpress-${{ matrix.wp-versions }}.tar.gz
-
-      - name: Extract WordPress
-        run: tar xfz wordpress-${{ matrix.wp-versions }}.tar.gz
-
-      # Checkout (copy) this repository's Plugin to this VM.
-      - name: Checkout Plugin
-        uses: actions/checkout@v4
-        with:
-          path: ${{ env.PLUGIN_DIR }}
+      - name: Download and Extract WordPress
+        run: |
+          sudo chown -R runner:docker /var/www/html
+          ls -la /var/www/html
+          cd /var/www/html
+          wget https://wordpress.org/wordpress-${{ matrix.wp-versions }}.tar.gz
+          tar xfz wordpress-${{ matrix.wp-versions }}.tar.gz
+          mv wordpress/* .
+          rm -rf wordpress wordpress-${{ matrix.wp-versions }}.tar.gz
 
       # We install WP-CLI, as it provides useful commands to setup and install WordPress through the command line.
       - name: Install WP-CLI
@@ -118,6 +123,10 @@ jobs:
         working-directory: ${{ env.ROOT_DIR }}
         run: wp-cli plugin install ${{ env.INSTALL_PLUGINS }}
 
+      # Move Plugin
+      - name: Move Plugin
+        run: mv /home/runner/work/convertkit-wpforms/convertkit-wpforms/convertkit-wpforms ${{ env.PLUGIN_DIR }} 
+
       # WP_DEBUG = true is required so all PHP errors are output and caught by tests (E_ALL).
       - name: Enable WP_DEBUG
         working-directory: ${{ env.ROOT_DIR }}
@@ -139,10 +148,37 @@ jobs:
           php-version: ${{ matrix.php-versions }}
           coverage: xdebug
 
-      # Make sure that an nginx configuration file exists in this repository at tests/nginx/php-x.x.conf.
-      # Refer to an existing .conf file in this repository if you need to create a new one e.g. for a new PHP version.
-      - name: Copy nginx configuration file
-        run: sudo cp ${{ env.PLUGIN_DIR }}/tests/nginx/php-${{ matrix.php-versions }}.conf /etc/nginx/conf.d/php-${{ matrix.php-versions }}.conf
+      # Configure nginx to use the PHP version and WOrdPress installation at /var/www/html
+      - name: Configure nginx site
+        run: |
+          sudo rm -f /etc/nginx/sites-enabled/default
+          sudo tee /etc/nginx/sites-available/default > /dev/null << 'EOF'
+
+          server {
+            listen 80 default_server;
+            listen [::]:80 default_server;
+
+            root /var/www/html;
+            index index.php;
+
+            server_name localhost;
+
+            location / {
+                try_files $uri $uri/ /index.php?$args;
+            }
+
+            location ~ \.php$ {
+                include snippets/fastcgi-php.conf;
+                fastcgi_pass unix:/run/php/php${{ matrix.php-versions }}-fpm.sock;
+            }
+
+            location ~ /\.ht {
+                deny all;
+            }
+          }
+          EOF
+
+          sudo ln -s /etc/nginx/sites-available/default /etc/nginx/sites-enabled/default || true
 
       - name: Test nginx
         run: sudo nginx -t
@@ -190,6 +226,21 @@ jobs:
         working-directory: ${{ env.PLUGIN_DIR }}
         run: composer dump-autoload
 
+      # This ensures that applicable files and folders can be written to by WordPress and cache Plugins.
+      - name: Set File and Folder Permissions
+        run: |
+          sudo chmod 767 ${{ env.ROOT_DIR }}
+          sudo chown www-data:www-data ${{ env.ROOT_DIR }}
+
+          sudo chmod 767 ${{ env.ROOT_DIR }}/wp-config.php
+          sudo chown www-data:www-data ${{ env.ROOT_DIR }}/wp-config.php
+
+          sudo chmod 767 ${{ env.ROOT_DIR }}/wp-content
+          sudo chown www-data:www-data ${{ env.ROOT_DIR }}/wp-content
+
+          sudo chmod -R 767 ${{ env.ROOT_DIR }}/wp-content/uploads
+          sudo chown www-data:www-data ${{ env.ROOT_DIR }}/wp-content/uploads
+
       # This ensures the Plugin's log file can be written to.
       # We don't recursively do this, as it'll prevent Codeception from writing to the /tests/_output directory.
       - name: Set Permissions for Plugin Directory

.github/workflows/tests.yml

@@ -60,6 +60,16 @@ class Integrate_ConvertKit_WPForms_Creator_Network_Recommendations {
 	 */
 	private $convertkit_billing_url = 'https://app.kit.com/account_settings/billing/?utm_source=wordpress&utm_content=convertkit-wpforms';
 
+	/**
+	 * Holds the creator network settings that were defined when saving
+	 * a WPForms Form.
+	 *
+	 * @since   1.8.0
+	 *
+	 * @var     bool|array
+	 */
+	private $creator_network_settings = false;
+
 	/**
 	 * Constructor
 	 *
@@ -68,7 +78,9 @@ class Integrate_ConvertKit_WPForms_Creator_Network_Recommendations {
 	public function __construct() {
 
 		add_filter( 'wpforms_builder_settings_sections', array( $this, 'settings_section' ), 20, 1 );
-		add_filter( 'wpforms_form_settings_panel_content', array( $this, 'settings_section_content' ), 20 );
+		add_action( 'wpforms_form_settings_panel_content', array( $this, 'settings_section_content' ), 20 );
+		add_filter( 'wpforms_save_form_args', array( $this, 'store_settings_on_form_edit' ), 10, 2 );
+		add_action( 'wpforms_save_form', array( $this, 'apply_stored_settings_on_form_save' ) );
 		add_action( 'wpforms_frontend_js', array( $this, 'maybe_enqueue_creator_network_recommendations_script' ) );
 
 	}
@@ -226,6 +238,73 @@ public function settings_section_close_and_return() {
 
 	}
 
+	/**
+	 * Store the form values for Creator Network Recommendations when the Form's save button is clicked,
+	 * immediately before the form is saved in WPForms.
+	 *
+	 * @since   1.8.0
+	 *
+	 * @param   array $post_data  WPForms Form posted data on save.
+	 * @param   array $form_data  WPForms Form settings data posted on save.
+	 * @return  array
+	 */
+	public function store_settings_on_form_edit( $post_data, $form_data ) {
+
+		// Define the settings which will be saved to the WPForms Form.
+		$this->creator_network_settings = array(
+			$this->connection_id_key => ( isset( $form_data['settings'][ $this->connection_id_key ] ) ? $form_data['settings'][ $this->connection_id_key ] : '' ),
+			$this->creator_network_recommendations_script_key => ( isset( $form_data['settings'][ $this->creator_network_recommendations_script_key ] ) ? $form_data['settings'][ $this->creator_network_recommendations_script_key ] : '' ),
+		);
+
+		return $post_data;
+
+	}
+
+	/**
+	 * Apply the form values for Creator Network Recommendations after the form is saved in WPForms,
+	 * because WPForms Lite 1.9.4.0 and higher introduces a nasty bug where changes made to settings
+	 * on an existing WPForms Form won't be honored.
+	 *
+	 * @param   int $form_id    WPForms Form ID.
+	 *
+	 * @since   1.8.0
+	 */
+	public function apply_stored_settings_on_form_save( $form_id ) {
+
+		// Bail if Creator Network settings isn't an array.
+		if ( ! $this->creator_network_settings ) {
+			return;
+		}
+
+		// Get Form.
+		$form = get_post( $form_id );
+
+		// Bail if the Form could not be fetched.
+		if ( ! $form ) {
+			return;
+		}
+
+		// Decode WPForms Form settings.
+		$data = wpforms_decode( $form->post_content );
+
+		// Bail if the WPForms Form settings could not be decoded.
+		if ( ! $data ) {
+			return;
+		}
+
+		// Merge settings.
+		$data['settings'] = array_merge( $data['settings'], $this->creator_network_settings );
+
+		// Update Post.
+		wp_update_post(
+			array(
+				'ID'           => $form_id,
+				'post_content' => wpforms_encode( $data ),
+			)
+		);
+
+	}
+
 	/**
 	 * Enqueues the Creator Network Recommendations script, if the WPForms form
 	 * has the 'Enable Creator Network Recommendations' setting enabled.

includes/class-integrate-convertkit-wpforms-creator-network-recommendations.php

@@ -109,8 +109,10 @@ public function testFormSettingsPrefixAddedToSettingsOnUpgrade(AcceptanceTester
 			// Other required settings.
 			'field_id'  => '0',
 			'settings'  => [
-				'store_spam_entries' => '0',
-				'submit_text'        => 'Submit',
+				'store_spam_entries'       => '0',
+				'submit_text'              => 'Submit',
+				'convertkit_connection_id' => '',
+				'convertkit_wpforms_creator_network_recommendations' => '',
 			],
 		];