lexicongovernance / pluraltools-backend

Backend implementation of the plural voting tool.
https://demo.lexicongovernance.org/
GNU General Public License v3.0
3 stars 1 forks source link

update alerts to navlinks #454

Closed diegoalzate closed 1 month ago

diegoalzate commented 1 month ago

overview

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

This migration introduces substantial updates to the database schema, including the renaming of the alerts table to nav_links and the addition of an event_id column to establish connections with events. These changes permeate the application, with adjustments made to handlers, routers, and schemas, thereby enhancing data integrity and improving the overall functionality regarding event-related navigation.

Changes

File(s) Change Summary
migrations/0029_mushy_vermin.sql Renamed alerts table to nav_links, added event_id column, and established a foreign key.
migrations/meta/0029_snapshot.json Defined schema for multiple tables, including nav_links, with relevant columns and constraints.
src/db/schema/events.ts Updated to include a relationship to navLinks.
src/db/schema/index.ts Changed export from alerts to nav-links.
src/db/schema/nav-links.ts Renamed table from alerts to nav_links, added eventId, and updated types and relations.
src/handlers/events.ts Introduced getEventNavLinksHandler to retrieve navigation links for specific events.
src/handlers/nav-links.ts Added getActiveNavLinks to fetch active navigation links, replacing getActiveAlerts.
src/routers/api.ts Replaced alertsRouter with navLinksRouter.
src/routers/events.ts Added endpoint to retrieve navigation links associated with events.
src/routers/nav-links.ts Renamed router from alertsRouter to navLinksRouter.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API
    participant EventHandler
    participant NavLinksHandler
    participant Database

    User->>API: Request navigation links by event ID
    API->>EventHandler: Route to event related handler
    EventHandler->>NavLinksHandler: Get navigation links
    NavLinksHandler->>Database: Query nav_links with event ID
    Database-->>NavLinksHandler: Return navigation links
    NavLinksHandler-->>EventHandler: Send navigation links back
    EventHandler-->>API: Return navigation links to user

Poem

🐇 In the garden, links now bloom,
Navigation paths dispel the gloom.
From alerts to navs, a joyful hop,
Events and stories never stop!
With every click, new journeys start,
A rabbit's cheer, from the heart! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.