Update logging & memory management, retry certain HTTP requests, catch out of memory situations

README.md

@@ -109,13 +109,13 @@ While running, `vip-go-ci` will output log of its actions. Here is an example --
         "dry-run": false
     }
 }
-[ 2018-04-16T14:10:05+00:00 -- 0 ]  Fetching all open Pull-Requests from GitHub; {
+[ 2018-04-16T14:10:05+00:00 -- 0 ]  Fetching all open pull requests from GitHub; {
     "repo_owner": "mygithubuser",
     "repo_name": "testing123",
     "commit_id": "f978c17f8f648e5ce10aa16694c74a5544b1670e",
     "branches_ignore": []
 }
-[ 2018-04-16T14:10:14+00:00 -- 0 ]  Fetching information about all commits made to Pull-Request #17 from GitHub; {
+[ 2018-04-16T14:10:14+00:00 -- 0 ]  Fetching information about all commits made to pull request #17 from GitHub; {
     "repo_owner": "mygithubuser",
     "repo_name": "testing123",
     "pr_number": 17
@@ -146,7 +146,7 @@ While running, `vip-go-ci` will output log of its actions. Here is an example --
     "filename": "bla-2.php",
     "local_git_repo": "\/tmp\/git-testing123"
 }
-[ 2018-04-16T14:10:51+00:00 -- 0 ]  About to PHPCS-scan all files affected by any of the Pull-Requests; {
+[ 2018-04-16T14:10:51+00:00 -- 0 ]  About to PHPCS-scan all files affected by any of the pull requests; {
     "repo_owner": "mygithubuser",
     "repo_name": "testing123",
     "commit_id": "f978c17f8f648e5ce10aa16694c74a5544b1670e"

ap-file-types.php

@@ -101,17 +101,6 @@ function vipgoci_ap_file_types(
 		}
 	}
 
-	/*
-	 * Reduce memory-usage as possible.
-	 */
-	unset( $prs_implicated );
-	unset( $pr_diff );
-	unset( $pr_item );
-	unset( $pr_diff_file_extension );
-	unset( $pr_diff_file_name );
-
-	gc_collect_cycles();
-
 	vipgoci_runtime_measure( VIPGOCI_RUNTIME_STOP, 'ap_file_types' );
 }
 

ap-hashes-api.php

@@ -247,7 +247,7 @@ function vipgoci_ap_hashes_api_file_approved(
 
 /**
  * Scan a particular commit, look for altered
- * files in the Pull-Request we are associated with
+ * files in the pull request we are associated with
  * and for each of these files, check if they
  * are approved in the hashes-to-hashes API.
  *
@@ -267,7 +267,7 @@ function vipgoci_ap_hashes_api_scan_commit(
 	vipgoci_runtime_measure( VIPGOCI_RUNTIME_START, 'hashes_api_scan' );
 
 	vipgoci_log(
-		'Scanning altered or new files affected by Pull-Request(s) ' .
+		'Scanning altered or new files affected by pull request(s) ' .
 			'using hashes-to-hashes API',
 		array(
 			'repo_owner'     => $options['repo-owner'],
@@ -333,7 +333,7 @@ function vipgoci_ap_hashes_api_scan_commit(
 
 			/*
 			 * Add the file to a list of approved files
-			 * of these affected by the Pull-Request.
+			 * of these affected by the pull request.
 			 */
 			if ( true === $approval_status ) {
 				vipgoci_log(
@@ -366,17 +366,6 @@ function vipgoci_ap_hashes_api_scan_commit(
 		}
 	}
 
-	/*
-	 * Reduce memory-usage as possible
-	 */
-	unset( $prs_implicated );
-	unset( $pr_item );
-	unset( $pr_diff );
-	unset( $pr_diff_contents );
-	unset( $approval_status );
-
-	gc_collect_cycles();
-
 	vipgoci_runtime_measure( VIPGOCI_RUNTIME_STOP, 'hashes_api_scan' );
 }
 

ap-nonfunctional-changes.php

@@ -100,7 +100,7 @@ function vipgoci_ap_nonfunctional_changes(
 
 			/*
 			 * Save contents of version of
-			 * file at the base of the Pull-Request
+			 * file at the base of the pull request
 			 * to a temporary file ("old version").
 			 */
 
@@ -141,7 +141,7 @@ function vipgoci_ap_nonfunctional_changes(
 
 			/*
 			 * Save contents of version of
-			 * file at the head of the Pull-Request
+			 * file at the head of the pull request
 			 * to a temporary file ("new version").
 			 */
 
@@ -182,9 +182,9 @@ function vipgoci_ap_nonfunctional_changes(
 
 			/*
 			 * Check if the version at the base of
-			 * of the Pull-Request ("old version")
+			 * of the pull request ("old version")
 			 * is the same as the latest version at
-			 * the head of the Pull-Request ("new version")
+			 * the head of the pull request ("new version")
 			 * are exactly the same, given that we remove
 			 * all whitespacing changes.
 			 */
@@ -225,19 +225,6 @@ function vipgoci_ap_nonfunctional_changes(
 		}
 	}
 
-	/*
-	 * Reduce memory-usage as possible
-	 */
-	unset( $prs_implicated );
-	unset( $pr_diff );
-	unset( $pr_item );
-	unset( $pr_diff_file_extension );
-	unset( $pr_diff_file_name );
-	unset( $tmp_file_old );
-	unset( $tmp_file_new );
-
-	gc_collect_cycles();
-
 	vipgoci_runtime_measure( VIPGOCI_RUNTIME_STOP, 'ap_nonfunctional_changes' );
 }
 

ap-svg-files.php

@@ -186,19 +186,6 @@ function vipgoci_ap_svg_files(
 		}
 	}
 
-	/*
-	 * Reduce memory-usage as possible
-	 */
-	unset( $tmp_scan_results );
-	unset( $prs_implicated );
-	unset( $pr_diff );
-	unset( $pr_item );
-	unset( $pr_diff_file_extension );
-	unset( $pr_diff_file_name );
-	unset( $file_issues_arr_master );
-
-	gc_collect_cycles();
-
 	vipgoci_runtime_measure( VIPGOCI_RUNTIME_STOP, 'ap_svg_files' );
 }
 

auto-approval.php

@@ -8,7 +8,7 @@
 declare(strict_types=1);
 
 /**
- * Pull-Request is not approved,
+ * Pull request is not approved,
  * remove label if needed, leave messages
  * on files that are approved, dismiss
  * any previously approving PRs.
@@ -52,7 +52,7 @@ function vipgoci_auto_approval_non_approval(
 		'pull/' . (int) $pr_item->number;
 
 	vipgoci_log(
-		'Will not auto-approve Pull-Request #' .
+		'Will not auto-approve pull request #' .
 			(int) $pr_item->number . ' ' .
 			'as it contains ' .
 			'files which are not ' .
@@ -67,8 +67,7 @@ function vipgoci_auto_approval_non_approval(
 			'files_seen'              => $files_seen,
 			'pr_files_changed'        => $pr_files_changed,
 		),
-		0,
-		true // Send to IRC.
+		0
 	);
 
 	if ( false === $pr_label ) {
@@ -107,7 +106,7 @@ function vipgoci_auto_approval_non_approval(
 	) {
 		/*
 		 * Make sure that the file was
-		 * really altered in the Pull-Request;
+		 * really altered in the pull request;
 		 * this is to avoid any errors when
 		 * submitting inline comments.
 		 */
@@ -119,7 +118,7 @@ function vipgoci_auto_approval_non_approval(
 			vipgoci_log(
 				'Not adding auto-approved in hashes-api ' .
 				'database to results for file, as it ' .
-				'was not altered by the Pull-Request',
+				'was not altered by the pull request',
 				array(
 					'pr_number'        => $pr_item->number,
 					'file_name'        => $approved_file,
@@ -207,12 +206,12 @@ function vipgoci_auto_approval_non_approval(
 	}
 
 	/*
-	 * Get any approving reviews for the Pull-Request
+	 * Get any approving reviews for the pull request
 	 * submitted by us. Then dismiss them.
 	 */
 	vipgoci_log(
 		'Dismissing any approving reviews for ' .
-			'the Pull-Request, as it is not ' .
+			'the pull request, as it is not ' .
 			'approved anymore',
 		array(
 			'pr_number' => $pr_item->number,
@@ -249,7 +248,7 @@ function vipgoci_auto_approval_non_approval(
 }
 
 /**
- * Approve a particular Pull-Request,
+ * Approve a particular pull request,
  * alter label for the PR if needed,
  * remove old comments, and log everything
  * we do.
@@ -303,7 +302,7 @@ function vipgoci_autoapproval_do_approve(
 			'pull/' . (int) $pr_item->number;
 
 		vipgoci_log(
-			'Will auto-approve Pull-Request #' .
+			'Will auto-approve pull request #' .
 				(int) $pr_item->number . ' ' .
 				'as it alters or creates ' .
 				'only files that can be ' .
@@ -318,13 +317,12 @@ function vipgoci_autoapproval_do_approve(
 				'auto_approved_files_arr' => $auto_approved_files_arr,
 				'files_seen'              => $files_seen,
 			),
-			0,
-			true // Send to IRC.
+			0
 		);
 
 		/*
 		 * Actually approve, if not in dry-mode.
-		 * Also add a label to the Pull-Request
+		 * Also add a label to the pull request
 		 * if applicable.
 		 */
 		vipgoci_github_approve_pr(
@@ -333,7 +331,7 @@ function vipgoci_autoapproval_do_approve(
 			$options['token'],
 			$pr_item->number,
 			$options['commit'],
-			'Auto-approved Pull-Request #' .
+			'Auto-approved pull request #' .
 				(int) $pr_item->number . ' as it ' .
 				'contains only auto-approvable files' .
 				' -- either pre-approved files' .
@@ -364,7 +362,7 @@ function( $type ) {
 		);
 	} else {
 		vipgoci_log(
-			'Will not actually approve Pull-Request #' .
+			'Will not actually approve pull request #' .
 				(int) $pr_item->number .
 				', as it is already approved by us',
 			array(
@@ -376,13 +374,12 @@ function( $type ) {
 				'auto_approved_files_arr' => $auto_approved_files_arr,
 				'files_seen'              => $files_seen,
 			),
-			0,
-			true
+			0
 		);
 	}
 
 	/*
-	 * Add label to Pull-Request, but
+	 * Add label to pull request, but
 	 * only if it is not associated already.
 	 * If it is already associated, just log
 	 * that fact.
@@ -418,7 +415,7 @@ function( $type ) {
 		'Removing any previously submitted comments ' .
 			'indicating that a particular file ' .
 			'is approved as the whole ' .
-			'Pull-Request is approved',
+			'pull request is approved',
 		array(
 			'pr_number' => $pr_item->number,
 		)
@@ -452,7 +449,7 @@ function( $type ) {
 }
 
 /**
- * Process auto-approval(s) of the Pull-Request(s)
+ * Process auto-approval(s) of the pull request(s)
  * involved with the commit specified.
  *
  * @param array $options                 Array of options.
@@ -469,7 +466,7 @@ function vipgoci_auto_approval_scan_commit(
 	vipgoci_runtime_measure( VIPGOCI_RUNTIME_START, 'auto_approve_commit' );
 
 	vipgoci_log(
-		'Doing auto-approval',
+		'Performing auto-approval',
 		array(
 			'repo_owner'             => $options['repo-owner'],
 			'repo_name'              => $options['repo-name'],
@@ -508,7 +505,7 @@ function vipgoci_auto_approval_scan_commit(
 
 		/*
 		 * Loop through all files that are
-		 * altered by the Pull-Request, look for
+		 * altered by the pull request, look for
 		 * files that can be auto-approved.
 		 */
 		foreach ( $pr_diff['files'] as
@@ -551,7 +548,7 @@ function vipgoci_auto_approval_scan_commit(
 				'pull/' . (int) $pr_item->number;
 
 			vipgoci_log(
-				'No action taken with Pull-Request #' .
+				'No action taken with pull request #' .
 					(int) $pr_item->number . ' ' .
 					'since no files were found' .
 					' -- PR URL: ' . $tmp_github_url,
@@ -561,8 +558,7 @@ function vipgoci_auto_approval_scan_commit(
 					'pr_number'               => (int) $pr_item->number,
 					'pr_diff'                 => $pr_diff,
 				),
-				0,
-				true
+				0
 			);
 		} elseif (
 			( true === $did_foreach ) &&
@@ -593,23 +589,6 @@ function vipgoci_auto_approval_scan_commit(
 		unset( $files_seen );
 	}
 
-	/*
-	 * Reduce memory-usage as possible
-	 */
-
-	unset( $pr_diff );
-	unset( $pr_diff_file_name );
-	unset( $pr_diff_contents );
-	unset( $pr_item );
-	unset( $pr_label );
-	unset( $prs_implicated );
-	unset( $files_seen );
-	unset( $did_foreach );
-	unset( $can_auto_approve );
-	unset( $tmp_github_url );
-
-	gc_collect_cycles();
-
 	vipgoci_runtime_measure( VIPGOCI_RUNTIME_STOP, 'auto_approve_commit' );
 }
 
@@ -710,5 +689,10 @@ function vipgoci_auto_approval_process(
 		$results,
 		$auto_approved_files_arr
 	);
+
+	vipgoci_log(
+		'Auto-approval process complete',
+		array()
+	);
 }
 

defines.php

@@ -43,7 +43,7 @@
 define(
 	'VIPGOCI_REVIEW_COMMENTS_TOTAL_MAX',
 	'Total number of active review comments per ' .
-					'Pull-Request has been reached and some ' .
+					'pull request has been reached and some ' .
 					'comments might not appear as a result. ' .
 					'Please resolve some issues to see more'
 );
@@ -84,6 +84,11 @@
 					'<br />'
 );
 
+define(
+	'VIPGOCI_OUT_OF_MEMORY_ERROR',
+	'Unable to analyze the pull request due to resource constraints. The pull request may be too large to process. Please try submitting a smaller pull request'
+);
+
 define(
 	'VIPGOCI_NO_ISSUES_FOUND_MSG_AND_NO_REVIEWS',
 	'No issues were found to report when scanning latest commit'