Page MenuHomePhabricator

Add "phutil_describe_type()" and clean up a few obscure things in "libphutil/"
ClosedPublic

Authored by epriestley on Feb 26 2019, 3:13 AM.
Tags
None
Referenced Files
F15415055: D20213.id48271.diff
Thu, Mar 20, 3:44 AM
F15411741: D20213.id48274.diff
Wed, Mar 19, 9:41 AM
F15404053: D20213.diff
Tue, Mar 18, 6:01 AM
F15379793: D20213.id48262.diff
Thu, Mar 13, 11:25 PM
F15377471: D20213.id48272.diff
Thu, Mar 13, 9:03 AM
Unknown Object (File)
Feb 14 2025, 6:39 AM
Unknown Object (File)
Feb 14 2025, 6:39 AM
Unknown Object (File)
Feb 14 2025, 6:39 AM
Subscribers
None

Details

Summary

See PHI1096. With some frequency, I want to raise an exception like "expected method getSomething() to return an object of type X, but it actually returned a thing of type Y".

There's no great builtin function for producing a good value for "Y", the unexpected value's type. "get_type()" is somewhat close, but just returns "object" for objects, when we'd prefer to return the object's class name since this is significantly more useful.

We have a pretty good method for producing "Y" in "libphutil/", but it's hard to remember: PhutilTypeSpec::getTypeOf($value). Wrap it in a convenient name, phutil_describe_type().

Also, provide phutil_is_natural_list() for simplifying the array_keys(...) === range(...) test that we have in a handful of cases.

Finally, clean up a couple of error behaviors that give you a bad/misleading error if you make a syntax error in "utils.php" specifically.

Test Plan

Ran unit tests, see also next diff.

Diff Detail

Repository
rPHU libphutil
Branch
dtype1
Lint
Lint Errors
SeverityLocationCodeMessage
Errorsrc/parser/PhutilJSON.php:132XHP45PHP Compatibility
Unit
Tests Passed
Build Status
Buildable 22134
Build 30245: Run Core Tests
Build 30244: arc lint + arc unit

Event Timeline

amckinley added inline comments.
src/utils/utils.php
1769

Unfinished thought.

This revision is now accepted and ready to land.Feb 26 2019, 3:34 PM
  • One more similar language tweak.
This revision was automatically updated to reflect the committed changes.
src/conduit/ConduitClient.php
351

This accidentally fixed a bug, since PHP is a lovable trickster:

$ php -r 'echo (array("x") == array(0)) ? "SAME ARRAY" : "DIFFERENT";'
SAME ARRAY

That is, this should have been ===.

This bug isn't a huge issue, but it does change the signature algorithm.

This [signature] bug isn't a huge issue

Specifically, I mean it isn't a huge issue since we only use it internally today. If this was in widespread use it could be a real problem, since it would mean the signature algorithm doesn't protect against a MITM attacker very well, but you'd have to be inside the hosted cluster to do anything MITM-flavored today.