[PLA-1708] Remove validation on GetBeam

[enjinabner]

Type

enhancement, tests

---

Description

• Enhanced the SingleUseCodeExist rule to support conditional claimability checks, improving the flexibility of beam claim validations.
• Added new tests to verify the functionality of retrieving beams with single-use codes, ensuring robustness.

---

Changes walkthrough

	Relevant files
Enhancement	ClaimBeamMutation.php Enhance Single Use Code Validation for Claiming                    src/GraphQL/Mutations/ClaimBeamMutation.php Added a boolean parameter to SingleUseCodeExist constructor to support conditional claimability checks. +1/-1      SingleUseCodeExist.php Conditional Claimability Check in Single Use Code Validation src/Rules/SingleUseCodeExist.php Introduced a constructor with a bool parameter to toggle claimability checks. Modified the validate method to conditionally check for claimability based on the new constructor parameter. +9/-1
Tests	GetBeamTest.php Add Tests for Single Use Code Beam Retrieval                          tests/Feature/GraphQL/Queries/GetBeamTest.php Added tests for getting beams with single-use codes. Utilized BeamType and BeamService for setting up test conditions. +27/-0

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[github-actions]

PR Description updated to latest commit (ad72f1c)

[github-actions]

PR Review

⏱️ Estimated effort to review [1-5]	3, because the PR involves changes in validation logic, which requires a careful review of the new conditional logic introduced. Additionally, the tests added need to be reviewed to ensure they adequately cover the new functionality.
🧪 Relevant tests	Yes
🔍 Possible issues	Conditional Logic Complexity: The introduction of conditional logic in SingleUseCodeExist.php increases complexity and could potentially introduce edge cases that are not covered by tests.
	Hardcoded Boolean in Constructor: The use of a hardcoded boolean value true in the ClaimBeamMutation.php file when instantiating SingleUseCodeExist might limit flexibility and could benefit from being dynamically set based on context.
🔒 Security concerns	No

Code feedback:

---

relevant file	src/GraphQL/Mutations/ClaimBeamMutation.php
suggestion	Consider passing the $singleUse variable directly to the SingleUseCodeExist constructor to increase flexibility and reduce the need for hardcoded boolean values. This change would allow the validation to dynamically adapt based on the context in which it is used. [important]
relevant line	$singleUse ? new SingleUseCodeExist(true) : '',

---

relevant file	src/Rules/SingleUseCodeExist.php
suggestion	Implement additional validation or a fallback mechanism within the validate method to handle unexpected scenarios or inputs. This could help in maintaining robustness and ensuring that the validation behaves predictably even with unusual or unexpected input values. [medium]
relevant line	BeamClaim::withSingleUseCode($value)

---

relevant file	tests/Feature/GraphQL/Queries/GetBeamTest.php
suggestion	Add assertions to specifically check for the expected behavior when retrieving beams with single-use codes, especially focusing on the claimability aspect. This would ensure that the conditional logic introduced in the validation rule is effectively tested. [important]
relevant line	public function test_it_can_get_beam_with_single_use_codes(): void

---

relevant file	src/Rules/SingleUseCodeExist.php
suggestion	Consider refactoring the conditional check within the validate method to a private method to improve readability and maintainability. This would make the main validation logic cleaner and more focused on its primary responsibility. [medium]
relevant line	->when($this->isClaiming, fn ($query) => $query->claimable())

---

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

• When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

• With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

See the review usage page for a comprehensive guide on using this tool.

[github-actions]

PR Code Suggestions

Category	Suggestions
Best practice	Use array filtering to handle conditional validation rules instead of ternary operators. Instead of using a ternary operator to conditionally add a validation rule, consider using array filtering to remove empty values after constructing the rules array. This approach keeps the rules definition cleaner and avoids inserting empty strings into the rules array. src/GraphQL/Mutations/ClaimBeamMutation.php [116] -$singleUse ? new SingleUseCodeExist(true) : '', +new SingleUseCodeExist($singleUse),
	Split tests with multiple scenarios into separate methods for clarity. The test method test_it_can_get_beam_with_single_use_codes is testing two scenarios: when singleUse is false and when it is true. For better test clarity and to follow the single responsibility principle, consider splitting this test into two separate test methods. tests/Feature/GraphQL/Queries/GetBeamTest.php [40] -public function test_it_can_get_beam_with_single_use_codes(): void +public function test_it_can_get_beam_with_single_use_code_not_claimed(): void +public function test_it_can_get_beam_with_single_use_code_claimed(): void
Maintainability	Improve readability by refactoring complex conditions into a descriptive method. The validate method's condition is complex and might be hard to understand at first glance. Refactoring this condition into a private method with a descriptive name can improve readability and maintainability. src/Rules/SingleUseCodeExist.php [27-30] -if (BeamService::isSingleUse($value) && - BeamClaim::withSingleUseCode($value) - ->when($this->isClaiming, fn ($query) => $query->claimable()) - ->exists() -) { +if ($this->isValidSingleUseCode($value)) {
	Reduce code duplication by extracting repeated logic into a method. The encryption of the single-use code is repeated in both parts of the test. Consider extracting this logic into a private method within the test class to avoid code duplication and improve readability. tests/Feature/GraphQL/Queries/GetBeamTest.php [49] -$singleUseCode = encrypt(implode(':', [$claim->code, $this->beam->code, $claim->nonce])); +$singleUseCode = $this->encryptSingleUseCode($claim);

---

✨ Improve tool usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

• When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

• With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

See the improve usage page for a comprehensive guide on using this tool.