Add User Settings for Celebrating Completed Issues and Refactor User Formatting

[claygorman]

Type

enhancement, bug_fix

---

Description

• Added a settings JSONB column to the users table to store user preferences.
• Introduced formatUserForGraphql helper function to standardize user object formatting across different resolvers.
• Implemented user settings in GraphQL schema to allow storing and updating user preferences.
• Integrated confetti effects in the frontend to celebrate when an issue is marked as completed, with a toggle in user settings to enable or disable this feature.
• Performed various frontend enhancements, including style adjustments and code refactoring.
• Added new script dev:migrate in package.json for running database migrations.
• Included new dependencies js-confetti and react-canvas-confetti for implementing confetti effects.

---

Changes walkthrough

	Relevant files
Enhancement	18 files resolvers-types.ts                                                                                    backend/src/__generated__/resolvers-types.ts Added settings field to UpdateMeInput and User types. +3/-0 20240112143058-add-settings-to-user.ts                                            backend/src/db/migrations/20240112143058-add-settings-to-user.ts Created a migration to add a settings JSONB column to the users table. +16/-0 types.ts                                                                                                        backend/src/db/models/types.ts Added settings attribute to the User class to support JSONB type. +1/-0 user.ts                                                                                                          backend/src/db/models/user.ts Defined settings field of type JSONB in the user model. +4/-0 index.ts                                                                                                        backend/src/resolvers/issue/index.ts Refactored to use formatUserForGraphql helper function for reporter and assignee fields. +3/-8 index.ts                                                                                                        backend/src/resolvers/project/index.ts Refactored to use formatUserForGraphql helper function for users field. +2/-3 helpers.ts                                                                                                    backend/src/resolvers/user/helpers.ts Created formatUserForGraphql helper function to format user data for GraphQL responses. +9/-0 index.ts                                                                                                        backend/src/resolvers/user/index.ts Refactored user resolvers to use formatUserForGraphql helper function and added settings handling in updateMe mutation. +14/-12 type-defs.ts                                                                                                backend/src/type-defs.ts Added settings field to GraphQL schema for User type and UpdateMeInput. +2/-0 page.tsx                                                                                                        frontend/app/profile/page.tsx Updated profile page with style adjustments and removed unused username field. +11/-31 UploadComponent.tsx                                                                                  frontend/components/Avatar/UploadComponent.tsx Updated avatar upload component with style adjustments and added label style prop. +6/-3 DropdownUser.tsx                                                                                        frontend/components/Header/DropdownUser.tsx Updated user dropdown component with style adjustments and commented out settings link. +31/-29 index.tsx                                                                                                      frontend/components/KanbanBoard/index.tsx Integrated confetti effects for completed issues and added user settings check for enabling the feature. +24/-0 UserInfo.tsx                                                                                                frontend/components/Profile/UserInfo.tsx Added user settings form with a toggle for enabling celebration on issue completion. +67/-6 graphql.ts                                                                                                    frontend/gql/__generated__/graphql.ts Updated generated GraphQL types to include settings field. +2/-0 gql-queries-mutations.ts                                                                        frontend/gql/gql-queries-mutations.ts Added settings field to USER_FIELDS fragment. +1/-0 package.json                                                                                                backend/package.json Added a new script dev:migrate for database migrations. +1/-0 package.json                                                                                                frontend/package.json Added js-confetti and react-canvas-confetti packages for confetti effects. +2/-0
Bug_fix	1 files fastify-hooks.ts                                                                                        backend/src/server/fastify-hooks.ts Updated addUserToRequest to correctly type cast cached user. +3/-2
Dependencies	1 files pnpm-lock.yaml                                                                                            frontend/pnpm-lock.yaml Updated lock file with new dependencies for confetti effects. +28/-0

---

✨ 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 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 describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode 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 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: '<PR type>: <title>' - 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.

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 describe usage page for a comprehensive guide on using this tool.

[claygorman]

/describe

[github-actions]

PR Description updated to latest commit (436ca4c)