Fix coding standards & introduce GitHub action. #147

peterwilsoncc · 2023-07-25T04:40:17Z

Issue: #89

Ticket:

Slack Thread:

Description

Fixes all the coding standards warnings and errors for the plugin.
Introduces a GitHub action for sniffing the coding standards.

Most of the missing @since annotations were for really old functions so I used the version number 1.4.13 as that was the earliest available tag in the check-in so I could be sure that the functions were included in that version.

Most of the changes are cosmetic but there are a few changes that might have side effects:

changes to strict comparisons
yoda-ing comparisons
changes to recommended functions (eg json_encode to wp_json_encode)

I left this line unchanged as modifying it requires a significant refactor that is probably best done as a dedicated PR to make sure nothing breaks.

I also left urlencode calls as is, I didn't want to risk the payfast API chocking on %20 in place of +.

Steps to Test

This changes much of the plugin, there are main class includes 513 changes (about 1/3rd of the file). The following items should be checked:

Purchases
- Standard
- Pre-order
- Subscription
- Subscription renewal
- Subscription cancellation
- Unsuccessful payment
Privacy exports
- Standard orders removed
- Inactive subscriptions removed
- Active subscription retained (needed for cancelling)

Documentation

This PR needs documentation (has the "Documentation" label).

Changelog Entry

Dev - Resolve coding standards issues.

Closes #89 .

dkotter · 2023-07-26T14:57:55Z

.github/workflows/php-compatibility.yml

+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2


Suggest we update this to v3

Updated in 9e59aff.

dkotter · 2023-07-26T15:02:22Z

includes/class-wc-gateway-payfast.php

 	 *
 	 * @return string
 	 */
-	protected function _generate_parameter_string( $api_data, $sort_data_before_merge = true, $skip_empty_values = true ) {
+	protected function _generate_parameter_string( $api_data, $sort_data_before_merge = true, $skip_empty_values = true ) {  // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore


Wondering if we should globally disable this rule since we're having to ignore that on multiple lines within this file?

Wondering if we should globally disable this rule since we're having to ignore that on multiple lines within this file?

Done in aac4e4d. I excluded the rule for this file only as none of the other files were affected.

vikrampm1 · 2023-10-03T11:49:03Z

@ankitguptaindia This has been in QA status for a while now, so bumping this up in your queue.

ankitguptaindia · 2023-10-04T16:10:16Z

Hello @peterwilsoncc Could you please fix the conflict in this PR?

# Conflicts: # .github/workflows/php-compatibility.yml # gateway-payfast.php

peterwilsoncc · 2023-10-04T22:45:13Z

@ankitguptaindia The merge conflicts are resolved.

ankitguptaindia · 2023-10-07T12:03:47Z

Simple Product Purchase:

Order Updated. ✅
ITN Updated ✅

Subscription Purchase:

Order Updated ✅
ITN Updated ✅

Renewal Subscription (from customer side):

Order Updated ✅
ITN Updated ✅

Subscription Cancellation:

From Customer Side ✅

Subscription Reactivation and Payment (from customer side):

Order Updated ✅
ITN Updated ✅

Unsuccessful Payment:

Order Updated ✅

Canceled Transactions: ✅

QA Updates - WIP

Remains - Pre-order, Privacy exports (need to discuss with Dev)

peterwilsoncc · 2023-10-10T02:34:28Z

@ankitguptaindia Following up your slack message re:privacy exports:

Firstly, I made a typo and meant erasing private data, wp-admin/erase-personal-data.php.

The plugin ties in to the WordPress functionality for erasing data and will remove a customers orders when their email is entered on the screen above.

Subscriptions

Orders containing active or on-hold subscriptions are retained
Orders containing subscriptions with other status are removed, the payfast payment token is deleted first. Source code.

Pre-orders

Pre-orders are deleted and the pre-order tokens are removed as part of this, this is to ensure the user is not charged when the pre-order release date arrives.

ankitguptaindia · 2023-10-12T12:44:06Z

I tested this PR by following the provided instructions. I encountered some issues during the testing, but these issues are not specific to the changes made in this PR. I was able to reproduce these issues with older versions of the PayFast extension, including versions 1.5.0, 1.5.5, and 1.5.8. I have reported these issues separately for further discussion and potential fixes.

The issues reported are as follows:

Payment Fails when Pre Order Product has 'Upon Release' setting enabled for Payment
Renewal Orders Fail in Subscription Products with PayFast - Note that this issue was due to the Sandbox environment, and it has been closed.

The PR functions the same way as the stable version of this extension.

jeffpaul · 2023-10-16T19:39:36Z

@faisal-alvi when we get back to the PHPCS work, please look at merging in or pulling across work from @peterwilsoncc's PR here into #160 so that we've got a single PR that handles these updates for PayFast... thanks!

faisal-alvi · 2023-12-04T08:19:04Z

#160 is merged in the trunk, we can now merge the trunk here and proceed with the pending work.

jeffpaul · 2023-12-04T15:34:45Z

@faisal-alvi would you please help take over this PR to handle that trunk merge & getting any additional/helpful changes from this PR ready for final review/merge?

https://github.com/woocommerce/woocommerce-gateway-payfast/actions/runs/7178169594/job/19545867589#step:9:17

peterwilsoncc self-assigned this Jul 25, 2023

peterwilsoncc force-pushed the fix/89-phpcs-sniffs branch 3 times, most recently from 3d9f17e to 7efa4d6 Compare July 25, 2023 04:56

peterwilsoncc changed the title ~~Fix/89 phpcs sniffs~~ Fix coding standards & introduce GitHub action. Jul 25, 2023

vikrampm1 added this to the Future Release milestone Jul 25, 2023

peterwilsoncc requested a review from dkotter July 25, 2023 23:28

dkotter reviewed Jul 26, 2023

View reviewed changes

peterwilsoncc added 11 commits July 31, 2023 09:49

Fix auto-fixable coding standard errors and warnings.

069e7ef

Exclude existing file from invalid name check.

8119297

Introduce/fix file comments.

2cb28cb

Fix code sniffing errors.

a5ef627

Fix code sniffing warnings.

836d3bd

Coding standards: add docblocks.

4f41b63

Fix coding standards errors.

0aa667a

Add PHP coding standards tests.

4763194

Show sniffs in messages.

c4652e3

Exclude PSR2.Methods.MethodDeclaration.Underscor in affected file.

aac4e4d

Exclude build folder from sniffs.

9b03d33

peterwilsoncc force-pushed the fix/89-phpcs-sniffs branch from eac719d to 9b03d33 Compare July 30, 2023 23:49

Update checkout action to v3.

9e59aff

dkotter approved these changes Jul 31, 2023

View reviewed changes

dkotter requested a review from ankitguptaindia July 31, 2023 16:38

Merge branch 'trunk' into fix/89-phpcs-sniffs

842bc37

# Conflicts: # .github/workflows/php-compatibility.yml # gateway-payfast.php

ankitguptaindia approved these changes Oct 12, 2023

View reviewed changes

faisal-alvi added 3 commits December 12, 2023 12:49

Merge branch 'trunk' into fix/89-phpcs-sniffs

bde1fb2

remove duplicate exclude-pattern

7cd6d67

fix phpcs for base url,

c85aba8

https://github.com/woocommerce/woocommerce-gateway-payfast/actions/runs/7178169594/job/19545867589#step:9:17

faisal-alvi requested a review from dkotter December 12, 2023 08:54

dkotter approved these changes Dec 12, 2023

View reviewed changes

vikrampm1 modified the milestones: Future Release, 1.6.1 Dec 15, 2023

vikrampm1 marked this pull request as ready for review December 15, 2023 12:31

vikrampm1 merged commit 9567bbc into trunk Dec 15, 2023
5 checks passed

vikrampm1 deleted the fix/89-phpcs-sniffs branch December 15, 2023 12:31

vikrampm1 mentioned this pull request Jan 5, 2024

Release version 1.6.1 #192

Closed

21 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix coding standards & introduce GitHub action. #147

Fix coding standards & introduce GitHub action. #147

peterwilsoncc commented Jul 25, 2023 •

edited by jeffpaul

Loading

dkotter Jul 26, 2023

peterwilsoncc Jul 30, 2023

dkotter Jul 26, 2023

peterwilsoncc Jul 30, 2023

vikrampm1 commented Oct 3, 2023

ankitguptaindia commented Oct 4, 2023

peterwilsoncc commented Oct 4, 2023

ankitguptaindia commented Oct 7, 2023 •

edited

Loading

peterwilsoncc commented Oct 10, 2023

ankitguptaindia commented Oct 12, 2023

jeffpaul commented Oct 16, 2023

faisal-alvi commented Dec 4, 2023

jeffpaul commented Dec 4, 2023

Fix coding standards & introduce GitHub action. #147

Fix coding standards & introduce GitHub action. #147

Conversation

peterwilsoncc commented Jul 25, 2023 • edited by jeffpaul Loading

Description

Steps to Test

Documentation

Changelog Entry

dkotter Jul 26, 2023

Choose a reason for hiding this comment

peterwilsoncc Jul 30, 2023

Choose a reason for hiding this comment

dkotter Jul 26, 2023

Choose a reason for hiding this comment

peterwilsoncc Jul 30, 2023

Choose a reason for hiding this comment

vikrampm1 commented Oct 3, 2023

ankitguptaindia commented Oct 4, 2023

peterwilsoncc commented Oct 4, 2023

ankitguptaindia commented Oct 7, 2023 • edited Loading

peterwilsoncc commented Oct 10, 2023

ankitguptaindia commented Oct 12, 2023

jeffpaul commented Oct 16, 2023

faisal-alvi commented Dec 4, 2023

jeffpaul commented Dec 4, 2023

peterwilsoncc commented Jul 25, 2023 •

edited by jeffpaul

Loading

ankitguptaindia commented Oct 7, 2023 •

edited

Loading