Log to file #84

tijmenbruggeman · 2026-01-06T15:57:19Z

We had two customers reporting two different issues which we could not figure out. Often times this is due to setup configurations but it is hard to figure out.

Having some diagnostics and logs should make it easier to troubleshoot these issues.

This PR will also:

set the timeout for the entire request to 120 seconds
set the timeout to connect to the server to 8 seconds

Good to know

Max 2MB log file, if limit is reached, old log will be deleted and new one will be created. This is the simplest method and prevents from adding rotation;
Turn on logs will clear any previous logs;
Requires ziparchive to download;
No sensitive data will be logged;
Logging will slow down performance as it will open and write the log entry each time something compresses;

Screenshots

Customers can turn on logging and download a diagnostics zip file from within settings

_Logs are formatted nicely_

- use include pattern instead of rendering in class

- download zip file including logs and information about setup

- added utility classes

src/class-tiny-compress-client.php

src/class-tiny-diagnostics.php

…task/logging-troubleshooting

src/class-tiny-compress-client.php

Copilot

Pull request overview

This PR adds logging and diagnostics capabilities to help troubleshoot customer issues. It introduces a file-based logger with automatic rotation at 2MB, a diagnostics export feature that bundles logs and system information into a downloadable zip file, and sets API request timeouts (120s total, 8s connect) to prevent indefinite hanging.

Changes:

Introduced Tiny_Logger singleton for file-based logging with 2MB rotation
Added Tiny_Diagnostics class to collect system info and generate downloadable diagnostics zip files
Integrated logging calls throughout the compression workflow
Added settings UI for enabling/disabling logging and downloading diagnostics

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
tiny-compress-images.php	Added requires for new logger and diagnostics classes
test/unit/TinySettingsAjaxTest.php	Refactored test to use new assertHook helper method
test/unit/TinySettingsAdminTest.php	Added test for new logging_enabled setting registration
test/unit/TinyLoggerTest.php	Added comprehensive tests for logger singleton, file creation, rotation, and enable/disable behavior
test/unit/TinyDiagnosticsTest.php	Added tests for diagnostics action hook and info collection
test/helpers/wordpress.php	Added assertHook helper, WordPressMocks class with mock WordPress functions, and formatting updates
src/views/settings.php	Included new diagnostics settings partial
src/views/settings-diagnostics.php	New view for logging toggle and diagnostics download button
src/js/admin.js	Added AJAX handler for diagnostics download
src/css/admin.css	Added utility classes for diagnostics UI
src/class-tiny-settings.php	Instantiated diagnostics and registered logging_enabled setting
src/class-tiny-plugin.php	Initialized logger and added debug logging throughout compression flow
src/class-tiny-logger.php	New singleton logger with file rotation and WordPress option integration
src/class-tiny-image.php	Added detailed debug and error logging for compression operations
src/class-tiny-diagnostics.php	New class for collecting and exporting diagnostic information
src/class-tiny-compress-fopen.php	Added debug logging for fopen compression responses
src/class-tiny-compress-client.php	Added timeout constants, error logging, and applied timeout settings to client

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-12T13:21:42Z

src/class-tiny-logger.php

+
+	/**
+	 * Constructor.
+


Missing closing line in docblock. The docblock comment starting at line 54 is not properly closed before the function definition.

Suggested change

*

Copilot · 2026-01-12T13:21:42Z

test/helpers/wordpress.php

+	 * https://developer.wordpress.org/reference/classes/wpdb/db_version/
+	 *
+	 * @return string|null database version
+	 */


Incorrect docblock reference. The db_version function is documented as a wpdb class method, but this is a standalone mock function. The documentation link and description should reflect that this is a mock implementation.

Copilot · 2026-01-12T13:21:42Z

test/helpers/wordpress.php

+	 * https://developer.wordpress.org/reference/classes/wpdb/db_version/
+	 *
+	 * @return string|null database version


Incorrect docblock - wp_get_theme is documented with the db_version reference and return type. The documentation should reference the correct WordPress function and return a WP_Theme object description.

Suggested change

* https://developer.wordpress.org/reference/classes/wpdb/db_version/

*

* @return string|null database version

* Mocked function for https://developer.wordpress.org/reference/functions/wp_get_theme/

*

* @return \WP_Theme Mock WP_Theme-like object

Copilot · 2026-01-12T13:21:43Z

test/helpers/wordpress.php

+	 * https://developer.wordpress.org/reference/classes/wpdb/db_version/
+	 *
+	 * @return string|null database version


Incorrect docblock - get_home_url is documented with the db_version reference and return type. Should reference the correct WordPress function and return type (string URL).

Suggested change

* https://developer.wordpress.org/reference/classes/wpdb/db_version/

*

* @return string|null database version

* https://developer.wordpress.org/reference/functions/get_home_url/

*

* @return string Home URL

Copilot · 2026-01-12T13:21:43Z

test/helpers/wordpress.php

+	 * https://developer.wordpress.org/reference/classes/wpdb/db_version/
+	 *
+	 * @return string|null database version


Incorrect docblock - get_locale is documented with the db_version reference and return type. Should reference the correct WordPress function and return type (string locale code).

Suggested change

* https://developer.wordpress.org/reference/classes/wpdb/db_version/

*

* @return string|null database version

* https://developer.wordpress.org/reference/functions/get_locale/

*

* @return string Locale code

Copilot · 2026-01-12T13:21:43Z

test/helpers/wordpress.php

+	/**
+	 * https://developer.wordpress.org/reference/functions/wp_timezone_string/
+	 *
+	 * @return string|null database version


Incorrect return type description. The function returns a timezone string, not a database version.

Suggested change

* @return string|null database version

* @return string|null Timezone string

Copilot · 2026-01-12T13:21:44Z

test/helpers/wordpress.php

+		return 'timezone';
+	}
+	/**
+	 * https://developer.wordpress.org/reference/functions/wp_timezone_string/


Incorrect docblock reference. The update_option function is documented with the wp_timezone_string reference. Should reference https://developer.wordpress.org/reference/functions/update_option/

Suggested change

* https://developer.wordpress.org/reference/functions/wp_timezone_string/

* https://developer.wordpress.org/reference/functions/update_option/

Copilot · 2026-01-12T13:21:44Z

src/class-tiny-compress-client.php

+	 * @since 3.6.8
+	 * @var int
+	 */
+	const API_TIMEOUT = 120;


Missing docblock for CONNECT_TIMEOUT constant. The API_TIMEOUT constant has documentation but CONNECT_TIMEOUT does not.

Suggested change

const API_TIMEOUT = 120;

const API_TIMEOUT = 120;

/**

* Connection timeout in seconds.

*

* @since 3.6.8

* @var int

*/

Copilot · 2026-01-12T13:21:44Z

test/helpers/wordpress.php

+	 */
+	public function get_locale()
+	{
+		return 'gb_GB';


Corrected locale code from 'gb_GB' to 'en_GB'. The correct WordPress locale code for Great Britain is 'en_GB', not 'gb_GB'.

Suggested change

return 'gb_GB';

return 'en_GB';

Copilot · 2026-01-12T13:21:45Z

src/views/settings-diagnostics.php

+						'Whenever you run into issues, we can help faster if we can see what is happening.
+                        Please enable logging for a short period, reproduce the problem, then send us a message at [email protected] with the diagnostics file attached.',


Long multi-line string has inconsistent indentation. The second line has leading whitespace that will appear in the output. Consider using a single line or properly formatting the multi-line string to avoid unintended whitespace.

Suggested change

'Whenever you run into issues, we can help faster if we can see what is happening.

Please enable logging for a short period, reproduce the problem, then send us a message at [email protected] with the diagnostics file attached.',

'Whenever you run into issues, we can help faster if we can see what is happening. Please enable logging for a short period, reproduce the problem, then send us a message at [email protected] with the diagnostics file attached.',

Add comprehensive test for nonce verification in the download_diagnostics AJAX endpoint. The test verifies that check_ajax_referer is called with the correct parameters and that wp_die is invoked when nonce verification fails. Also: - Add check_ajax_referer and wp_die mock implementations to WordPress test helpers - Add wp_json_encode mock for test compatibility - Rename test file to match class name convention (Tiny_Diagnostics_Test.php)

tijmenbruggeman added 20 commits January 2, 2026 11:19

chore: add settings view

2a3283c

- use include pattern instead of rendering in class

chore: add logger singleton

1625d03

chore: add diagnostics class

d3e3be1

- download zip file including logs and information about setup

chore: download zip file from settings page

f38b3c7

chore: add loader and improve markup

25bbc46

- added utility classes

Add various log points

47cd48f

Set timeout and proxy options on curl client

df29291

Scaffold tests

98eade7

formatting

e72c663

Add initial tests

178d63f

On constructor log enabled test

131a86a

Manual formatting logger

2cfabf1

Manual formatting fixes in diagnostics

f54b12d

chore: add tests for log path

9adff72

chore: simplify rotation

76ce4cb

Format

396ccbb

change file name, format and size

6cfae11

Clear logs when turned on

d430ff6

Add more tests

e4c3ef3

Add mocks for test

1d7cd63

rkoopmans reviewed Jan 7, 2026

View reviewed changes

src/class-tiny-compress-client.php Outdated Show resolved Hide resolved

rkoopmans reviewed Jan 7, 2026

View reviewed changes

src/class-tiny-diagnostics.php Show resolved Hide resolved

tijmenbruggeman added 2 commits January 7, 2026 22:13

set timeout to 300

85f8158

Merge branch 'master' of github.com:wcreateweb/wordpress-plugin into …

cd56cab

…task/logging-troubleshooting

rkoopmans reviewed Jan 9, 2026

View reviewed changes

src/class-tiny-compress-client.php Outdated Show resolved Hide resolved

tijmenbruggeman added 2 commits January 9, 2026 13:39

Seperate API timeout and connect timeout

f995de4

remove server info and add a phpinfo file

42623d1

rkoopmans requested a review from Copilot January 12, 2026 13:19

Copilot AI reviewed Jan 12, 2026

View reviewed changes

tijmenbruggeman added 5 commits January 13, 2026 10:41

Replace phpinfo with server info block

582d9d0

Use temp path and remove cleanup

8bfc16d

Check permissions

4b2e2b0

Use WP_Filesystem instead of low level php file handlers

753eb0a

formatting

4559ed6

	* @return string\|null database version
	* @return string\|null Timezone string

	* https://developer.wordpress.org/reference/functions/wp_timezone_string/
	* https://developer.wordpress.org/reference/functions/update_option/

		'Whenever you run into issues, we can help faster if we can see what is happening.
		Please enable logging for a short period, reproduce the problem, then send us a message at [email protected] with the diagnostics file attached.',

Log to file #84

Are you sure you want to change the base?

Log to file #84

Uh oh!

Conversation

tijmenbruggeman commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tijmenbruggeman commented Jan 6, 2026 •

edited

Loading