Optimize formatting and data loading in resolvers

[claygorman]

The primary action taken in this commit was the optimization of GraphQL resolvers. This was done by including a the 'formatUserForGraphql' function in issues, projects, and issue comments resolvers which helped streamline the process of formatting users for GraphQL. In addition, the DataLoader was primed with 'findIssueComment', improving data loading efficiency. Lastly, code related to GraphQL after file write hooks and mappers were revised in 'codegen.ts'.

[github-actions]

PR Analysis

• 🎯 Main theme: Optimization of GraphQL resolvers and code cleanup in TypeScript codebase.
• 📝 PR summary: This PR introduces a new utility function to streamline user formatting for GraphQL, primes DataLoader with 'findIssueComment' for better data loading efficiency, and refactors the 'codegen.ts' file to clean up after file write hooks and remove unused mappers.
• 📌 Type of PR: Enhancement
• ⏱️ Estimated effort to review [1-5]: 2, because the changes are straightforward, focusing on refactoring and optimization, and the PR is well-described which makes it easier to understand the context and intent of the changes.
• 🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The PR seems well-structured and focuses on optimization and code cleanup, which is good. However, it's important to ensure that the new utility function 'formatUserForGraphql' is thoroughly tested in all scenarios where it's used to prevent any potential regressions. Additionally, the use of 'sed' in 'codegen.ts' should be cross-platform compatible, as the current implementation may not work on all operating systems.

🤖 Code feedback:

---

relevant file	backend/codegen.ts
suggestion	Consider using a cross-platform solution for string replacements in 'codegen.ts' to ensure compatibility across different development environments. [important]
relevant line	"sed -i '' 's/import { GraphQLResolveInfo, GraphQLScalarType, GraphQLScalarTypeConfig } from '\''graphql'\'';/import type { GraphQLResolveInfo, GraphQLScalarType, GraphQLScalarTypeConfig } from '\''graphql'\'';/g' src/generated/resolvers-types.ts\n",

---

relevant file	backend/src/resolvers/issue-comment/index.ts
suggestion	Ensure that 'dataLoaderContext.prime(findIssueComment)' is correctly implemented and that it does not introduce any unintended side effects, such as caching incomplete or incorrect data. [important]
relevant line	dataLoaderContext.prime(findIssueComment);

---

relevant file	backend/src/resolvers/issue/index.ts
suggestion	Verify that the import change from 'formatUserForGraphql' without '.js' to with '.js' does not affect module resolution, especially if the project is using a module bundler or a specific TypeScript configuration. [medium]
relevant line	import { formatUserForGraphql } from '../user/helpers.js';

---

relevant file	backend/src/resolvers/project/index.ts
suggestion	Similar to the previous suggestion, ensure that the change in the import statement for 'formatUserForGraphql' does not cause any issues with module resolution. [medium]
relevant line	import { formatUserForGraphql } from '../user/helpers.js';

---

---

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

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

About the 'Code feedback' section 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 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.

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_review, enable_review_labels_effort, and more.

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.