RevisionLogInterface is typehinted as always returning entity/ids, but cannot guarantee set/existing values

Open on Drupal.org →

Created on 12 September 2022, almost 2 years ago

Updated 3 February 2023, over 1 year ago

Problem/Motivation

\Drupal\Core\Entity\RevisionLogInterface is incorrectly typed and causes static analysis tools like PHPStan to trip up.

Steps to reproduce

Run PHPStan on max where code calls \Drupal\Core\Entity\EntityTypeInterface::getRevisionUser/getRevisionUserId/getRevisionLogMessage. PHPStan will assume the returned variable is non empty. However returned values may not actually be set.

Proposed resolution

Change typehint, adding null values.

Remaining tasks

Implement

🐛 Bug report

Status

Fixed

Version

10.1 ✨

Component

Documentation →

Last updated 1 day ago

No maintainer

Created by

🇦🇺Australia dpi Perth, Australia

Live updates comments and jobs are added and updated live.

static analysis

Novice
It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

Quickfix

Needs Review Queue Initiative

Incomplete comments

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment over 1 year ago →
🇺🇸United States smustgrave
Hiding the files to avoid confusion.

MR has no open threads and comments look good.

Not sure what else to verify.

Comment over 1 year ago →

catch → committed 56923991 on 10.1.x

Issue #3309157 by dpi, larowlan: RevisionLogInterface is typehinted as...

Status changed to Fixed over 1 year ago2:13pm 3 February 2023
Comment over 1 year ago →
🇬🇧United Kingdom catch
Removing credit for the patch in #5, it duplicates the MR and doesn't include the new test coverage.

This looks good to me, tests that confirm the existing behaviour, and interface docs changes (which doesn't change the API as such just document the existing one properly).

Committed/pushed to 10.1.x, thanks!
Comment over 1 year ago →
System Message
Automatically closed - issue fixed for 2 weeks with no activity.

contrib.social Blog FAQ Discussions

Production build 0.69.0 2024