Differential D1656

Introduce Result class with Ok and Err types for status handling
ClosedPublic
Actions

Authored by dereckson on Sep 2 2018, 00:02.

Tags

None

Referenced Files

	F3752035: D1656.id9238.diff
	Sun, Nov 17, 14:34

	Unknown Object (File)
	Sat, Nov 9, 07:01

	Unknown Object (File)
	Fri, Nov 8, 16:18

	Unknown Object (File)
	Fri, Nov 8, 07:04

	Unknown Object (File)
	Fri, Nov 8, 06:44

	Unknown Object (File)
	Fri, Nov 8, 05:09

	Unknown Object (File)
	Thu, Nov 7, 22:07

	Unknown Object (File)
	Thu, Nov 7, 12:04

Subscribers

None

Details

Reviewers

Commits

rKOTb418fdefd1b0: Introduce Result class with Ok and Err types for status handling
rKERUALD8b2b9129c247: Introduce Result class with Ok and Err types for status handling

Summary

This change adds a Result class to improve error and success handling.

Inspired by Rust generic type Result, this approach allows functions to return
either an Ok type for successful outcomes or an Err type for errors.

In PHP, where generics and enums are not natively available, Result serves
as a base class with two implementations:

Err for exceptions
Ok for successful values

This pattern provides a more structured and readable way to handle
results and errors explicitly compared to traditional exception handling.

Reference:
https://doc.rust-lang.org/book/ch09-02-recoverable-errors-with-result.html

Test Plan

Implement in Zed story engine

Diff Detail

Repository

rKERUALD Keruald libraries development repository

Lint

Lint Errors

Severity	Location	Code	Message
Error	omnitools/src/DataTypes/Result/Err.php:45	PHPCS.E.Generic.NamingConventions.CamelCapsFunctionName.ScopeNotCamelCaps	Generic.NamingConventions.CamelCapsFunctionName.ScopeNotCamelCaps
Error	omnitools/src/DataTypes/Result/Err.php:45	PHPCS.E.PSR1.Methods.CamelCapsMethodName.NotCamelCaps	PSR1.Methods.CamelCapsMethodName.NotCamelCaps
Error	omnitools/src/DataTypes/Result/Err.php:51	PHPCS.E.Generic.NamingConventions.CamelCapsFunctionName.ScopeNotCamelCaps	Generic.NamingConventions.CamelCapsFunctionName.ScopeNotCamelCaps
Error	omnitools/src/DataTypes/Result/Err.php:51	PHPCS.E.PSR1.Methods.CamelCapsMethodName.NotCamelCaps	PSR1.Methods.CamelCapsMethodName.NotCamelCaps
Error	omnitools/src/DataTypes/Result/Ok.php:65	PHPCS.E.Generic.NamingConventions.CamelCapsFunctionName.ScopeNotCamelCaps	Generic.NamingConventions.CamelCapsFunctionName.ScopeNotCamelCaps
Error	omnitools/src/DataTypes/Result/Ok.php:65	PHPCS.E.PSR1.Methods.CamelCapsMethodName.NotCamelCaps	PSR1.Methods.CamelCapsMethodName.NotCamelCaps
Error	omnitools/src/DataTypes/Result/Ok.php:69	PHPCS.E.Generic.NamingConventions.CamelCapsFunctionName.ScopeNotCamelCaps	Generic.NamingConventions.CamelCapsFunctionName.ScopeNotCamelCaps
Error	omnitools/src/DataTypes/Result/Ok.php:69	PHPCS.E.PSR1.Methods.CamelCapsMethodName.NotCamelCaps	PSR1.Methods.CamelCapsMethodName.NotCamelCaps
Error	omnitools/src/DataTypes/Result/Result.php:12	PHPCS.E.Generic.NamingConventions.CamelCapsFunctionName.ScopeNotCamelCaps	Generic.NamingConventions.CamelCapsFunctionName.ScopeNotCamelCaps
Error	omnitools/src/DataTypes/Result/Result.php:12	PHPCS.E.PSR1.Methods.CamelCapsMethodName.NotCamelCaps	PSR1.Methods.CamelCapsMethodName.NotCamelCaps
Error	omnitools/src/DataTypes/Result/Result.php:14	PHPCS.E.Generic.NamingConventions.CamelCapsFunctionName.ScopeNotCamelCaps	Generic.NamingConventions.CamelCapsFunctionName.ScopeNotCamelCaps
Error	omnitools/src/DataTypes/Result/Result.php:14	PHPCS.E.PSR1.Methods.CamelCapsMethodName.NotCamelCaps	PSR1.Methods.CamelCapsMethodName.NotCamelCaps
Warning	omnitools/src/DataTypes/Result/Err.php:41	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass	Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warning	omnitools/src/DataTypes/Result/Ok.php:65	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass	Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warning	omnitools/src/DataTypes/Result/Ok.php:69	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass	Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass
Warning	omnitools/tests/DataTypes/Result/ErrTest.php:43	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.Found	Generic.CodeAnalysis.UnusedFunctionParameter.Found
Warning	omnitools/tests/DataTypes/Result/OkTest.php:51	PHPCS.W.Generic.CodeAnalysis.UnusedFunctionParameter.Found	Generic.CodeAnalysis.UnusedFunctionParameter.Found

Unit

Tests Passed

Branch

Result

Build Status

Buildable 5695
Build 5977: arc lint + arc unit

Event Timeline

dereckson requested review of this revision.Sep 2 2018, 00:02

dereckson created this revision.

Harbormaster completed remote builds in B2601: Diff 4230.Sep 2 2018, 00:02

Some ideas to make this code more useful:

a constructor to allow new Ok(42)
implement map methods:
- or_else(defaultValue) -> return defaultValue for Err, $this->value for Ok
- map() -> no op for Err, change value allowing type mutability for Value
- map_err() -> no op for Value, change value allowing any Exception for Err

dereckson planned changes to this revision.Jan 21 2020, 12:59

dereckson edited the summary of this revision. (Show Details)Jan 23 2022, 20:40

In PHP 8.1, could be interesting to do this:

Result sample use

use Keruald\OmniTools\DataTypes\Result;
use Keruald\OmniTools\DataTypes\ResultShape;

#[ResultShape(string, string)]
function doSomething() : Result {
    return ...;
}

$result = match (doSomething()) {
    $result->isOk() => $result->getValue(),
    default => throw new RuntimeException($result->getError()),
};

For this to work, we need two things:

Declare getError() in Result too
A ResultShape attribute to be able to typehint the Result

dereckson edited the summary of this revision. (Show Details)Mon, Nov 11, 13:02

Moved to keruald monorepo and rebased.

Harbormaster completed remote builds in B5692: Diff 9236.Mon, Nov 11, 13:58

dereckson retitled this revision from Implement a similar datatype than Rust result to Introduce Result class with Ok and Err types for status handling.Mon, Nov 11, 13:59

Update PHPUnit tests for PHPUnit 10+

Harbormaster completed remote builds in B5693: Diff 9237.Mon, Nov 11, 14:07

dereckson edited the summary of this revision. (Show Details)Mon, Nov 11, 14:17

More types

Harbormaster completed remote builds in B5694: Diff 9238.Mon, Nov 11, 14:21

Switch from Exception to Thowrable. Implement constructors/map/mapErr/or_else per previous comment.

Harbormaster completed remote builds in B5695: Diff 9239.Mon, Nov 11, 15:03

Switch method names to camel case

Harbormaster completed remote builds in B5696: Diff 9240.Mon, Nov 11, 15:08

Rebased against c3fe233eeb0b.

Harbormaster completed remote builds in B5698: Diff 9243.Mon, Nov 11, 15:16

dereckson accepted this revision.Mon, Nov 11, 15:16

This revision is now accepted and ready to land.Mon, Nov 11, 15:16

This revision was landed with ongoing or failed builds.Mon, Nov 11, 15:17

Closed by commit rKERUALD8b2b9129c247: Introduce Result class with Ok and Err types for status handling (authored by dereckson). · Explain Why

This revision was automatically updated to reflect the committed changes.

dereckson added a commit: rKERUALD8b2b9129c247: Introduce Result class with Ok and Err types for status handling.

dereckson mentioned this in D3595: Bump keruald/omnitools version to 0.13.0.Sun, Nov 17, 00:41

dereckson added a commit: rKOTb418fdefd1b0: Introduce Result class with Ok and Err types for status handling.Sun, Nov 17, 00:43

dereckson mentioned this in rKERUALD0666ca0d7378: Bump keruald/omnitools version to 0.13.0.

Revision Contents
Changeset List

Path

Size

omnitools/

src/

DataTypes/

Result/

54 lines

72 lines

15 lines

tests/

DataTypes/

Result/

56 lines

65 lines

4 lines

Diff 9239

omnitools/src/DataTypes/Result/Err.php

Loading...

omnitools/src/DataTypes/Result/Ok.php

Loading...

omnitools/src/DataTypes/Result/Result.php

Loading...

omnitools/tests/DataTypes/Result/ErrTest.php

Loading...

omnitools/tests/DataTypes/Result/OkTest.php

Loading...

phpunit.xml

Loading...