-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
@stream Offset scalar extracted from type definition.
- Loading branch information
1 parent
2ac7636
commit 104eff5
Showing
7 changed files
with
178 additions
and
148 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace LastDragon_ru\LaraASP\GraphQL\Stream\Scalars; | ||
|
|
||
| use Exception; | ||
| use GraphQL\Error\Error; | ||
| use GraphQL\Error\InvariantViolation; | ||
| use GraphQL\Language\AST\IntValueNode; | ||
| use GraphQL\Language\AST\Node; | ||
| use GraphQL\Language\AST\NodeKind; | ||
| use GraphQL\Language\AST\StringValueNode; | ||
| use GraphQL\Language\AST\TypeDefinitionNode; | ||
| use GraphQL\Type\Definition\ScalarType; | ||
| use GraphQL\Utils\Utils; | ||
| use Illuminate\Container\Container; | ||
| use Illuminate\Contracts\Encryption\StringEncrypter; | ||
| use LastDragon_ru\LaraASP\Core\Utils\Cast; | ||
| use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\Context; | ||
| use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeDefinition; | ||
| use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\TypeSource; | ||
| use LastDragon_ru\LaraASP\GraphQL\Builder\Manipulator; | ||
| use LastDragon_ru\LaraASP\GraphQL\Stream\Directives\Directive; | ||
| use LastDragon_ru\LaraASP\GraphQL\Stream\Offset as StreamOffset; | ||
| use LastDragon_ru\LaraASP\Serializer\Contracts\Serializer; | ||
| use Override; | ||
|
|
||
| use function filter_var; | ||
| use function is_int; | ||
| use function is_string; | ||
| use function sprintf; | ||
|
|
||
| use const FILTER_VALIDATE_INT; | ||
|
|
||
| class Offset extends ScalarType implements TypeDefinition { | ||
| public string $name = Directive::Name.'Offset'; | ||
| public ?string $description = <<<'DESCRIPTION' | ||
| Represents a offset for the `@stream` directive. The value can be a | ||
| positive `Int` or a `String`. The `Int` value represents the offset | ||
| (zero-based) to navigate to any position within the stream (= offset | ||
| pagination). And the `String` value represents the cursor and allows | ||
| navigation only to the previous/current/next pages (= cursor | ||
| pagination). | ||
| DESCRIPTION; | ||
|
|
||
| // <editor-fold desc="Getters/Setters"> | ||
| // ========================================================================= | ||
| protected function getEncrypter(): StringEncrypter { | ||
| return Container::getInstance()->make(StringEncrypter::class); | ||
| } | ||
|
|
||
| protected function getSerializer(): Serializer { | ||
| return Container::getInstance()->make(Serializer::class); | ||
| } | ||
| // </editor-fold> | ||
|
|
||
| // <editor-fold desc="ScalarType"> | ||
| // ========================================================================= | ||
| /** | ||
| * @return string|int<0, max> | ||
| */ | ||
| #[Override] | ||
| public function serialize(mixed $value): string|int { | ||
| $value = $this->validate($value, InvariantViolation::class); | ||
|
|
||
| if ($value instanceof StreamOffset) { | ||
| $value = $this->getSerializer()->serialize($value, 'json'); | ||
| $value = $this->encrypt($value); | ||
| } | ||
|
|
||
| return $value; | ||
| } | ||
|
|
||
| /** | ||
| * @return StreamOffset|int<0, max> | ||
| */ | ||
| #[Override] | ||
| public function parseValue(mixed $value): StreamOffset|int { | ||
| if (is_string($value)) { | ||
| try { | ||
| $value = $this->decrypt($value); | ||
| $value = $this->getSerializer()->deserialize(StreamOffset::class, $value, 'json'); | ||
| } catch (Exception) { | ||
| throw new Error('The cursor is not valid.'); | ||
| } | ||
| } else { | ||
| $value = $this->validate($value, Error::class); | ||
| } | ||
|
|
||
| return $value; | ||
| } | ||
|
|
||
| /** | ||
| * @inheritDoc | ||
| * @return StreamOffset|int<0, max> | ||
| */ | ||
| #[Override] | ||
| public function parseLiteral(Node $valueNode, array $variables = null): StreamOffset|int { | ||
| $value = null; | ||
|
|
||
| if ($valueNode instanceof StringValueNode) { | ||
| $value = $this->parseValue($valueNode->value); | ||
| } elseif ($valueNode instanceof IntValueNode) { | ||
| $value = filter_var($valueNode->value, FILTER_VALIDATE_INT); | ||
| $value = $this->parseValue($value); | ||
| } else { | ||
| throw new Error( | ||
| sprintf( | ||
| 'The `%s`/`%s` value expected, `%s` given.', | ||
| NodeKind::STRING, | ||
| NodeKind::INT, | ||
| $valueNode->kind, | ||
| ), | ||
| ); | ||
| } | ||
|
|
||
| return $value; | ||
| } | ||
|
|
||
| /** | ||
| * @param class-string<Exception> $error | ||
| * | ||
| * @phpstan-assert StreamOffset|int<0, max> $value | ||
| */ | ||
| protected function validate(mixed $value, string $error): StreamOffset|int { | ||
| if ($value instanceof StreamOffset) { | ||
| // ok | ||
| } elseif (is_int($value)) { | ||
| if ($value < 0) { | ||
| throw new $error('The offset must be greater or equal to 0.'); | ||
| } | ||
| } else { | ||
| throw new $error( | ||
| sprintf( | ||
| 'The valid cursor/offset expected, `%s` given.', | ||
| Utils::printSafe($value), | ||
| ), | ||
| ); | ||
| } | ||
|
|
||
| return $value; | ||
| } | ||
|
|
||
| protected function encrypt(string $value): string { | ||
| return $this->getEncrypter()->encryptString($value); | ||
| } | ||
|
|
||
| protected function decrypt(string $value): string { | ||
| return Cast::toString($this->getEncrypter()->decryptString($value)); | ||
| } | ||
| // </editor-fold> | ||
|
|
||
| // <editor-fold desc="TypeDefinition"> | ||
| // ========================================================================= | ||
| #[Override] | ||
| public function getTypeName(TypeSource $source, Context $context): string { | ||
| return $this->name(); | ||
| } | ||
|
|
||
| #[Override] | ||
| public function getTypeDefinition( | ||
| Manipulator $manipulator, | ||
| TypeSource $source, | ||
| Context $context, | ||
| string $name, | ||
| ): TypeDefinitionNode|string|null { | ||
| return self::class; | ||
| } | ||
| // </editor-fold> | ||
| } |
2 changes: 1 addition & 1 deletion
2
...s/graphql/src/Stream/Types/OffsetTest.php → ...graphql/src/Stream/Scalars/OffsetTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters