[PLA-1608] Token metadata fallback, and {id} replacement.

[v16Studios]

Type

enhancement

---

Description

• Enhanced URI attribute resolution in AttributeType.php to include both collection_chain_id and token_chain_id.
• Updated documentation for the return type of the prunable method in Block.php.
• Introduced a new mechanism in Token.php for fetching metadata using the collection's URI attribute as a fallback when token's metadata is not directly available.
• Updated GetTokenTest.php to assert the new format of URI values that include both collection and token chain IDs.

---

Changes walkthrough

	Relevant files
Enhancement	AttributeType.php Enhanced URI Attribute Resolution with Collection ID Support src/GraphQL/Types/Substrate/AttributeType.php Enhanced URI attribute resolution to include collection_chain_id along with token_chain_id. +1/-1      Token.php Enhanced Metadata Fetching with Collection URI Fallback    src/Models/Laravel/Token.php Added support for fetching metadata using collection's URI attribute when token's metadata is not available. Introduced a fallback mechanism to use collection's URI attribute for metadata fetching. +20/-1
Documentation	Block.php Documentation Update for Prunable Method Return Type          src/Models/Laravel/Block.php Updated the return type documentation for the prunable method. +1/-1
Tests	GetTokenTest.php Test Update for New URI Value Format                                          tests/Feature/GraphQL/Queries/GetTokenTest.php Updated test to assert the new URI value format including collection_chain_id and token_chain_id. +1/-1

---

✨ 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 (3d9892c)

[github-actions]

PR Review

⏱️ Estimated effort to review [1-5]	3, because the PR involves changes across multiple files including model logic enhancements, test updates, and documentation adjustments. Understanding the context and impact of these changes requires a moderate level of effort.
🧪 Relevant tests	Yes
🔍 Possible issues	Possible Bug: In Token.php, the check for Str::contains($collectionUriAttribute, '{id}') might not work as intended because $collectionUriAttribute is an object, not a string. The correct property to check would be $collectionUriAttribute->value.
	Performance Concern: The metadata attribute getter in Token.php uses load('attributes') which might lead to N+1 query problems if not used carefully in a loop.
🔒 Security concerns	No

Code feedback:

---

relevant file	src/Models/Laravel/Token.php
suggestion	Consider using $collectionUriAttribute->value instead of $collectionUriAttribute when checking for the presence of {id} in the URI attribute value. This change ensures that the string operations are performed on the actual URI value rather than the attribute object. [important]
relevant line	if ($collectionUriAttribute && Str::contains($collectionUriAttribute, '{id}')) {

---

relevant file	src/Models/Laravel/Token.php
suggestion	To avoid potential N+1 query issues, consider eager loading the attributes relation outside of the metadata attribute getter or ensure that the Token instances are properly preloaded with attributes when used in a loop. This optimization can help improve the performance of operations involving multiple Token instances. [important]
relevant line	$tokenUriAttribute = $this->load('attributes')->getRelation('attributes')

---

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review. 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=...

Utilizing extra instructions The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: [pr_reviewer] # /review # extra_instructions=""" In the 'possible issues' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation When you first install PR-Agent app, the default mode for the review tool is: pr_commands = ["/review", ...] meaning the review tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (enable_review_labels_security flag) a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)

Extra sub-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, and more.

Auto-approve PRs By invoking: /review auto_approve The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: [pr_reviewer] enable_auto_approval = true (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag: [pr_reviewer] maximal_review_effort = 5

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

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

[github-actions]

PR Code Suggestions

Category	Suggestions
Enhancement	Improve the accuracy of the {id} placeholder replacement in URIs. Consider using a more robust method for replacing the {id} placeholder in URIs to ensure that it only replaces the intended placeholder and not any accidental occurrences of {id} within the URI string. For example, you could use a more specific placeholder or a regular expression to ensure accurate replacement. src/GraphQL/Types/Substrate/AttributeType.php [43] -return str_replace('{id}', "{$attribute->token->collection->collection_chain_id}-{$attribute->token->token_chain_id}", $attribute->value); +return preg_replace('/\{id\}/', "{$attribute->token->collection->collection_chain_id}-{$attribute->token->token_chain_id}", $attribute->value, 1);
	Add more assertions to the test for increased robustness. To ensure the test's robustness, consider adding more assertions to verify the entire structure and content of the response, not just the URI value. This will help catch any unintended changes in the response format or other attributes. tests/Feature/GraphQL/Queries/GetTokenTest.php [83-89] $this->assertArraySubset([ 'attributes' => [[ 'key' => 'uri', 'value' => "https://example.com/{$this->collection->collection_chain_id}-{$this->token->token_chain_id}", ], + 'other_attribute' => 'expected_value', ], ], $response);
Maintainability	Refactor repeated URI attribute fetching logic into a separate method. To improve the performance and readability of the metadata fetching logic, consider refactoring the repeated code for fetching URI attributes into a separate method. This will reduce duplication and make the code easier to maintain. src/Models/Laravel/Token.php [145-147] -$tokenUriAttribute = $this->load('attributes')->getRelation('attributes') - ->filter(fn ($attribute) => 'uri' == $attribute->key) - ->first(); +$tokenUriAttribute = $this->fetchUriAttribute();
	Use more descriptive variable names for clarity. To improve code readability and maintainability, consider using a more descriptive variable name than $metadata for the result of the MetadataService::fetch call. This will make it clearer what type of data is being handled. src/Models/Laravel/Token.php [149] -$metadata = $this->attributes['metadata'] ?? MetadataService::fetch($tokenUriAttribute); +$fetchedMetadata = $this->attributes['metadata'] ?? MetadataService::fetch($tokenUriAttribute);
Bug	Correct the variable checked by Str::contains to prevent potential bugs. Ensure that the Str::contains method call is correctly checking the $collectionUriAttribute->value instead of $collectionUriAttribute. This prevents a potential bug where the method might not work as intended due to checking the wrong variable. src/Models/Laravel/Token.php [154] -if ($collectionUriAttribute && Str::contains($collectionUriAttribute, '{id}')) { +if ($collectionUriAttribute && Str::contains($collectionUriAttribute->value, '{id}')) {

---

✨ 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=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

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