search

OfflineHQ / marketplace

https://offline.live/
GNU General Public License v3.0
0 stars 0 forks source link

fix: types in nft/types and adjusting tests for currentOwnerAddres re… #229

Closed AlexandreG-tech closed 10 months ago

AlexandreG-tech commented 10 months ago

User description

…turn in packNftContract

Type

Enhancement

Description

Changes walkthrough

Relevant files                                                                                                                                 
Enhancement
index.ts                                                                                                       
    libs/nft/event-pass/src/lib/index.ts

    **This file has been significantly expanded. A new class
    `PackNftWrapper` has been added, which includes methods for
    handling NFT bundles, events, and transfers. The
    `EventPassNftWrapper` class has also been updated with new
    import statements.**
+235/-6
index.ts                                                                                                       
    libs/gql/admin/api/src/generated/index.ts

    **New GraphQL mutations and queries have been added to the
    admin SDK, including `UpdatePackNftSupplyManyDocument`,
    `CreatePackNftSupplyDocument`, and
    `GetPackNftSupplyWithNullNftsFromCurrentOwnerAddressDocument`.**
+38/-0
common.ts                                                                                                     
    libs/indexer/alchemy/webhooks/src/lib/common.ts

    **This new file includes functions for handling NFT activities
    and extracting NFT transfers from events. It also includes a
    function `extractNftTransfersFromEvent` to extract NFT
    transfers from Alchemy webhook events.**
+113/-0
eventPassNftActivity.ts                                                                         
    libs/indexer/alchemy/webhooks/src/lib/eventPassNftActivity.ts

    **This file has been refactored to use the
    `extractNftTransfersFromEvent` function from the new
    `common.ts` file. It also includes new logic for handling
    pack updates.**
+17/-46
index.ts                                                                                                       
    libs/gql/admin/types/src/generated/index.ts

    **New types have been added for the new GraphQL mutations and
    queries, including `UpdatePackNftSupplyManyMutation`,
    `CreatePackNftSupplyMutation`, and
    `GetPackNftSupplyWithNullNftsFromCurrentOwnerAddressQuery`.**
+22/-0
index.ts                                                                                                       
    libs/nft/thirdweb-organizer/src/index.ts

    **This file has been updated to create pack NFT supply when
    creating a new pack NFT contract.**
+13/-0
action.ts                                                                                                     
    libs/nft/thirdweb-organizer/src/action.ts

    **A new function `createPackNftSupply` has been added to
    create pack NFT supply in the database.**
+6/-0
Tests
eventPassNftActivity.integration.test.ts                                       
    libs/indexer/alchemy/webhooks/src/lib/eventPassNftActivity.integration.test.ts

    **The tests in this file have been updated to reflect the
    changes in `eventPassNftActivity.ts`.**
+6/-6
✨ Usage guide:
**Overview:** The `describe` tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR. When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L46) related to the describe tool (`pr_description` section), use the following template: ``` /describe --pr_description.some_config1=... --pr_description.some_config2=... ``` With a [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template: ``` [pr_description] some_config1=... some_config2=... ```
Enabling\disabling automation
- When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the describe tool is: ``` pr_commands = ["/describe --pr_description.add_original_user_description=true" "--pr_description.keep_original_user_title=true", ...] ``` meaning the `describe` tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. - Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: ``` pr_commands = ["/describe --pr_description.use_description_markers=true", ...] ``` the tool will replace every marker of the form `pr_agent:marker_name` in the PR description with the relevant content, where `marker_name` is one of the following: - `type`: the PR type. - `summary`: the PR summary. - `walkthrough`: the PR walkthrough. Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
Custom labels
The default labels of the `describe` tool are quite generic: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`]. If you specify [custom labels](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem) in the repo's labels page or via configuration file, you can get tailored labels for your use cases. Examples for custom labels: - `Main topic:performance` - pr_agent:The main topic of this PR is performance - `New endpoint` - pr_agent:A new endpoint was added in this PR - `SQL query` - pr_agent:A new SQL query was added in this PR - `Dockerfile changes` - pr_agent:The PR contains changes in the Dockerfile - ... The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
Utilizing extra instructions
The `describe` tool can be configured with extra instructions, 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. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description. Examples for extra instructions: ``` [pr_description] extra_instructions=""" - The PR title should be in the format: ': ' - The title should be short and concise (up to 10 words) - ... """ ``` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. </details></td></tr> <tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> > 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](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details. >To list the possible configuration parameters, add a **/config** comment. </details></td></tr> </table> See the [describe usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md) page for a comprehensive guide on using this tool. </details> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/vercel[bot]"><img src="https://avatars.githubusercontent.com/in/8329?v=4" />vercel[bot]</a> commented <strong> 10 months ago</strong> </div> <div class="markdown-body"> <p><strong>The latest updates on your projects</strong>. Learn more about <a href="https://vercel.link/github-learn-more">Vercel for Git ↗︎</a></p> <table> <thead> <tr> <th style="text-align: left;">Name</th> <th style="text-align: left;">Status</th> <th style="text-align: left;">Preview</th> <th style="text-align: left;">Comments</th> <th style="text-align: left;">Updated (UTC)</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;"><strong>back-office</strong></td> <td style="text-align: left;">❌ Failed (<a href="https://vercel.com/offline/back-office/9Vzjgo2wGAigLMxxFyiM4bfPG84S">Inspect</a>)</td> <td style="text-align: left;"></td> <td style="text-align: left;"></td> <td style="text-align: left;">Jan 10, 2024 0:26am</td> </tr> <tr> <td style="text-align: left;"><strong>marketplace</strong></td> <td style="text-align: left;">❌ Failed (<a href="https://vercel.com/offline/marketplace/GZatS5UCPTEzemeh36Gnb6bUzsdz">Inspect</a>)</td> <td style="text-align: left;"></td> <td style="text-align: left;"></td> <td style="text-align: left;">Jan 10, 2024 0:26am</td> </tr> </tbody> </table> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/codiumai-pr-agent-free[bot]"><img src="https://avatars.githubusercontent.com/in/354216?v=4" />codiumai-pr-agent-free[bot]</a> commented <strong> 10 months ago</strong> </div> <div class="markdown-body"> <p><strong><a href="https://github.com/Offline-Project/marketplace/pull/229">PR Description</a></strong> updated to latest commit (<a href="https://github.com/Offline-Project/marketplace/commit/689a99a193b9c264bd9f26826ce6d17e14e27b74">https://github.com/Offline-Project/marketplace/commit/689a99a193b9c264bd9f26826ce6d17e14e27b74</a>)</p> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/codiumai-pr-agent-free[bot]"><img src="https://avatars.githubusercontent.com/in/354216?v=4" />codiumai-pr-agent-free[bot]</a> commented <strong> 10 months ago</strong> </div> <div class="markdown-body"> <h2>PR Analysis</h2> <ul> <li>🎯 <strong>Main theme:</strong> Enhancements to NFT handling and GraphQL queries</li> <li>📝 <strong>PR summary:</strong> This PR introduces a new class <code>PackNftWrapper</code> for handling NFT bundles, events, and transfers. It also adds new GraphQL mutations and queries to the admin SDK, creates a new file for handling NFT activities, and refactors existing code to use the new functions. The PR also updates tests to reflect these changes.</li> <li>📌 <strong>Type of PR:</strong> Enhancement</li> <li>🧪 <strong>Relevant tests added:</strong> Yes</li> <li>⏱️ <strong>Estimated effort to review [1-5]:</strong> 4, because the PR involves significant changes to the codebase, including the introduction of new classes and methods, and changes to existing methods. The changes also involve several different files and areas of the codebase.</li> <li>🔒 <strong>Security concerns:</strong> No security concerns found <h2>PR Feedback</h2></li> </ul> <p><strong>💡 General suggestions:</strong> The PR is well-structured and the changes are logically grouped. The new <code>PackNftWrapper</code> class and the changes to the GraphQL queries and mutations are particularly well done. However, there are some areas where error handling could be improved, and some of the new methods could benefit from additional comments to explain their purpose and functionality.</p> <details><summary> <strong>🤖 Code feedback:</strong></summary><hr><table><tr><td>relevant file</td><td>libs/nft/event-pass/src/lib/index.ts</td></tr><tr><td>suggestion      </td><td><br> **Consider adding more detailed error messages to help with debugging. For example, in the `getCurrentOwnerAddressByContractAndTokenId` method, the error message could include the contract address and token id that caused the error. [important]** <br></td></tr><tr><td>relevant line</td><td>throw new Error('Failed to get current owner address by contract and token id');</td></tr></table><hr><table><tr><td>relevant file</td><td>libs/nft/event-pass/src/lib/index.ts</td></tr><tr><td>suggestion      </td><td><br> **The `handleBundles` method could benefit from additional comments explaining the purpose of the method and the logic behind the for loop. [medium]** <br></td></tr><tr><td>relevant line</td><td>async handleBundles({ numOfPacksOpened, bundleSize, nftToBundle, opener, contractAddress, }: HandleBundlesProps) {</td></tr></table><hr><table><tr><td>relevant file</td><td>libs/indexer/alchemy/webhooks/src/lib/common.ts</td></tr><tr><td>suggestion      </td><td><br> **The `extractNftTransfersFromEvent` method could benefit from additional comments explaining the purpose of the method and the logic behind the for loop. [medium]** <br></td></tr><tr><td>relevant line</td><td>export const extractNftTransfersFromEvent = async ( alchemyWebhookEvent: AlchemyNFTActivityEvent, ) => {</td></tr></table><hr><table><tr><td>relevant file</td><td>libs/nft/thirdweb-organizer/src/index.ts</td></tr><tr><td>suggestion      </td><td><br> **The `createPackNftSupply` method could benefit from additional comments explaining the purpose of the method and the logic behind the for loop. [medium]** <br></td></tr><tr><td>relevant line</td><td><a href='https://github.com/Offline-Project/marketplace/pull/229/files#diff-80b26817489489d8498897af632d05d0f4662c8d8ebdcb70de6613f0297b72d6R475'>await createPackNftSupply(packNftSupplyArray);</a></td></tr></table><hr></details> <hr> <details> <summary><strong>✨ Usage guide:</strong></summary><hr> **Overview:** The `review` tool scans the PR code changes, and generates a PR review. The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on any PR. When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L19) 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template: ``` [pr_reviewer] some_config1=... some_config2=... ``` <table><tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr> 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 code feedback 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. </details></td></tr> <tr><td><details> <summary><strong> How to enable\disable automation</strong></summary><hr> - When you first install PR-Agent app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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 </details></td></tr> <tr><td><details> <summary><strong> About the 'Code feedback' section</strong></summary><hr> The `review` tool provides several type of feedbacks, one of them is code suggestions. If you are interested **only** in the code suggestions, it is recommended to use the [`improve`](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md) feature instead, since it dedicated only to code suggestions, and usually gives better results. Use the `review` tool if you want to get a more comprehensive feedback, which includes code suggestions as well. </details></td></tr> <tr><td><details> <summary><strong> Auto-labels</strong></summary><hr> The `review` tool can auto-generate two specific types of labels for a PR: - a `possible security issue` label, that detects possible [security issues](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`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) </details></td></tr> <tr><td><details> <summary><strong> Extra sub-tools</strong></summary><hr> The `review` tool provides a collection of possible feedbacks about a PR. It is recommended to review the [possible options](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#enabledisable-features), 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_review`, `enable_review_labels_effort`, and more. </details></td></tr> <tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> > 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](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details. >To list the possible configuration parameters, add a **/config** comment. </details></td></tr> </table> See the [review usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md) page for a comprehensive guide on using this tool. </details> </div> </div> <div class="page-bar-simple"> </div> <div class="footer"> <ul class="body"> <li>© <script> document.write(new Date().getFullYear()) </script> Githubissues.</li> <li>Githubissues is a development platform for aggregating issues.</li> </ul> </div> <script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js"></script> <script src="/githubissues/assets/js.js"></script> <script src="/githubissues/assets/markdown.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/highlight.min.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/languages/go.min.js"></script> <script> hljs.highlightAll(); </script> </body> </html>