feat: Add support for Monolog 3.x #5334

jeromegamez · 2022-06-10T14:36:09Z

Hey everyone 👋,

this is a follow-up to #2302 and aims to add support for all currently available monolog/monolog versions.

AppEngineFlexHandlerV3 and AppEngineFlexFormatterV3 are the new implementations for Monolog 3.x.
The formatPayload method in the FormatterTrait should support arrays and the new LogRecord class

Prerequisites for this PR to be mergeable

~~Remove unused psr/log dependency phpDocumentor/Reflection#247 is merged but not released (this PR uses ^5.x-dev for now)~~
~~feat: Ensure support for PHP >= 7.4 gax-php#389 is not reviewed/merged/released (this PR uses my PR branch from over there for now)~~
~~Correspondence due to change of serializable interface of PHP8.1 GoogleCloudPlatform/grpc-gcp-php#45 is not (yet) merged - if it's just because of the CLA, I can create a new PR there~~

Things to look into

The ReflectionHandlerV5 class is a 90% copy of the ReflectionHandlerV4 - perhaps this can be deduplicated

Notes

There are deprecation warnings that I was not yet able to tackle yet:
- opis/closure
  
  Deprecated: Opis\Closure\SerializableClosure implements the Serializable interface, which is deprecated. Implement __serialize() and __unserialize() instead (or in addition, if support for old PHP versions is necessary) in /Users/jg/Code/opensource/google-cloud-php/vendor/opis/closure/src/SerializableClosure.php on line 18

jeromegamez · 2022-06-10T14:41:51Z

I'll ignore the conventionalcommits.org tests for now, but it's good to see that the "Generate Documentation" job fails, this shows that https://github.com/googleapis/google-cloud-php/blob/main/Core/src/Testing/Reflection/ReflectionHandlerFactory.php needs updating to support phpdocumentor/reflection ^5

I caved so that there's one less failing job 🤷😅

jeromegamez · 2022-06-10T15:17:10Z

The reflection handlers should probably be refactored to avoid much-duplicated code, I will get to that once I'm back at my desk in a few hours

jeromegamez · 2022-06-10T21:02:31Z

Alright, this is a rabbit hole - when I fix one problem, another one pops up, that's why I'm gradually working my way through the classes and force pushing all the time.

The good news is that we'll probably have PHP 8.1 compatibility when we're through (if that's even possible)

jeromegamez · 2022-06-12T23:51:17Z

Update: Sorry for all the force pushes - I needed to make a bunch of preparations in order to be able to run the tests without throwing errors with PHP 8.1 before adding Monolog 3 to the mix.

There's currently a blocker with a ReadOnly class because it collides with the reserved readonly in PHP 8.1.

This has already been addressed and a fix is on its way with protocolbuffers/protobuf#10041

Until then I think this PR is on hold, but I'm watching the protobuf repo and will continue as soon as it's through... perhaps google/gax und phpdocumentor/reflection will have released new versions as well by then 🤞

.github/workflows/release.yml

jeromegamez · 2022-11-29T08:39:31Z

@bshaffer I've seen that you merged main into this branch after #5442 but I rebased anyway to reduce the number of commits - just in case you didn't want to squash-merge later.

dwsupplee

My comments are mostly housekeeping related, structurally this looks great! Thanks @jeromegamez! 👍

Core/src/Logger/AppEngineFlexFormatterV3.php

Core/src/Logger/AppEngineFlexHandlerV3.php

Logging/src/LogMessageProcessor.php

Logging/src/LogMessageProcessor/MonologMessageProcessor.php

Logging/src/LogMessageProcessor/MonologV3MessageProcessor.php

Logging/src/LogMessageProcessorFactory.php

Logging/src/LogMessageProcessor.php

Core/src/Exception/ServiceException.php

Some tests explicitly set the message to `null` which breaks the creation of parent exceptions with newer PHP versions. Setting a default `$message = ''` does not prevent the problem, so we declare it with `null` being allowed, and check and replace it in the `ServiceException` constructor. The change is made in the `ServiceException` instead of the tests calling it incorrectly to reduce the scope of updated files in the context of the PR that handles the problem.

`phpdocumentor/reflection` started supporting `"psr/log": "^2.0|^3.0"` with v5.3. See phpDocumentor/Reflection#247

`psr/log` v1 included a TestLogger that was removed starting with v2. `fig/log-test` support all current versions of `psr/log`.

Logging/composer.json

bshaffer · 2022-12-14T21:45:57Z

We missed Debugger: #5711

bshaffer · 2022-12-19T17:24:25Z

We are going to wait until after the new year to release this, as our team is currently in a release freeze for the holidays!

jeromegamez · 2023-01-27T19:43:26Z

Super glad to see it released now! I enjoyed the process! We'll meet again at latest when Monolog 4 is released 😄

jeromegamez requested review from a team as code owners June 10, 2022 14:36

jeromegamez mentioned this pull request Jun 10, 2022

Add support for Monolog 2.x #2302

Merged

jeromegamez force-pushed the monolog-3 branch from 339aaf9 to f576c97 Compare June 10, 2022 15:13

jeromegamez force-pushed the monolog-3 branch 2 times, most recently from 4678789 to c15a529 Compare June 10, 2022 20:38

jeromegamez changed the title ~~Add support for Monolog 3.x~~ feat: Add support for Monolog 3.x Jun 10, 2022

jeromegamez mentioned this pull request Jun 12, 2022

feat: Ensure support for PHP >= 7.4 googleapis/gax-php#389

Merged

jeromegamez force-pushed the monolog-3 branch from 1680f75 to e2f81d0 Compare June 12, 2022 22:04

jeromegamez requested review from a team as code owners June 12, 2022 22:04

jeromegamez force-pushed the monolog-3 branch 5 times, most recently from 3111268 to 04033a9 Compare June 12, 2022 23:33

jeromegamez requested a review from a team as a code owner June 12, 2022 23:33

jeromegamez marked this pull request as draft June 12, 2022 23:52

bshaffer requested changes Jun 13, 2022

View reviewed changes

.github/workflows/release.yml Outdated Show resolved Hide resolved

lcobucci mentioned this pull request Jun 21, 2022

Add basic support to Google Cloud Logging format Seldaek/monolog#1690

Merged

jeromegamez force-pushed the monolog-3 branch 6 times, most recently from 52288ec to 5c79326 Compare July 28, 2022 21:48

jeromegamez force-pushed the monolog-3 branch from 53902be to 38c5eae Compare November 19, 2022 10:11

bshaffer mentioned this pull request Nov 28, 2022

fix(deps): update dependency psr/log to v3 #4248

Closed

1 task

jeromegamez force-pushed the monolog-3 branch from dd7f897 to bf29fc7 Compare November 29, 2022 08:08

jeromegamez force-pushed the monolog-3 branch from bf29fc7 to a81f106 Compare December 8, 2022 00:23

jeromegamez requested a review from bshaffer December 8, 2022 00:24

bshaffer mentioned this pull request Dec 13, 2022

Up monolog version #5478

Closed

bshaffer requested a review from dwsupplee December 13, 2022 16:18

bshaffer approved these changes Dec 13, 2022

View reviewed changes

dwsupplee suggested changes Dec 13, 2022

View reviewed changes

jeromegamez added 4 commits December 14, 2022 05:04

feat: Enable the usage of "psr/log": "^2.0|^3.0"

bdd6336

`phpdocumentor/reflection` started supporting `"psr/log": "^2.0|^3.0"` with v5.3. See phpDocumentor/Reflection#247

feat: Enable the installation of Monolog V3

2312f5d

`psr/log` v1 included a TestLogger that was removed starting with v2. `fig/log-test` support all current versions of `psr/log`.

feat: Introduce V3 versions of AppEngine Formatters and Handlers

5d52730

jeromegamez force-pushed the monolog-3 branch from 79ee85c to 4e3b274 Compare December 14, 2022 04:20

feat: Introduce LogMessageProcessors and their factory

1e3d64a

jeromegamez force-pushed the monolog-3 branch from 4e3b274 to 1e3d64a Compare December 14, 2022 04:24

dwsupplee suggested changes Dec 14, 2022

View reviewed changes

Logging/composer.json Show resolved Hide resolved

bshaffer added 5 commits December 14, 2022 09:01

add monolog 3 to root composer

7273234

remove provide

3aee7fc

allow log-test 1.0

de64261

remove log-test in favor of skipping tests

5bb40c0

ignore cs warning

ccb1896

dwsupplee approved these changes Dec 14, 2022

View reviewed changes

dwsupplee merged commit 6ad6bc3 into googleapis:main Dec 14, 2022

release-please bot mentioned this pull request Dec 14, 2022

chore(main): release 0.196.0 #5707

Merged

jeromegamez deleted the monolog-3 branch December 15, 2022 23:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add support for Monolog 3.x #5334

feat: Add support for Monolog 3.x #5334

jeromegamez commented Jun 10, 2022 •

edited

Loading

jeromegamez commented Jun 10, 2022 •

edited

Loading

jeromegamez commented Jun 10, 2022

jeromegamez commented Jun 10, 2022

jeromegamez commented Jun 12, 2022 •

edited

Loading

jeromegamez commented Nov 29, 2022

dwsupplee left a comment

bshaffer commented Dec 14, 2022

bshaffer commented Dec 19, 2022

jeromegamez commented Jan 27, 2023

feat: Add support for Monolog 3.x #5334

feat: Add support for Monolog 3.x #5334

Conversation

jeromegamez commented Jun 10, 2022 • edited Loading

Prerequisites for this PR to be mergeable

Things to look into

Notes

jeromegamez commented Jun 10, 2022 • edited Loading

jeromegamez commented Jun 10, 2022

jeromegamez commented Jun 10, 2022

jeromegamez commented Jun 12, 2022 • edited Loading

jeromegamez commented Nov 29, 2022

dwsupplee left a comment

Choose a reason for hiding this comment

bshaffer commented Dec 14, 2022

bshaffer commented Dec 19, 2022

jeromegamez commented Jan 27, 2023

jeromegamez commented Jun 10, 2022 •

edited

Loading

jeromegamez commented Jun 10, 2022 •

edited

Loading

jeromegamez commented Jun 12, 2022 •

edited

Loading