Feature/94 webhooks baked in

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request introduces significant changes to the application's data handling, primarily focusing on webhook functionality. A new user document structure is established, alongside the creation of _llana_webhook and _llana_webhook_log collections. The package.json file is updated to include a new dependency, and various constants related to webhooks are added. Several controllers are modified to incorporate webhook-specific logic, including authentication and role checks. Additionally, a new TasksService class is introduced for managing scheduled tasks related to webhooks, enhancing the application's overall functionality.

Changes

File Path	Change Summary
demo/databases/mongodb.js	Added user document insertion, created `_llana_webhook` and `_llana_webhook_log` collections, modified insertion logic.
package.json	Added dependency: `"@nestjs/schedule": "^4.1.1"` in `dependencies`.
src/app.constants.ts	Added constants: `LLANA_WEBHOOK_TABLE`, `LLANA_WEBHOOK_LOG_TABLE`, `CACHE_DEFAULT_WEBHOOK_TTL`, `WEBHOOK_LOG_DAYS`.
src/app.controller.delete.test.spec.ts	Introduced test suite for delete functionality with tests for single and multiple customer deletions.
src/app.controller.delete.ts	Modified `DeleteController` to handle webhook-specific logic and authentication checks.
src/app.controller.get.ts	Updated `GetController` to use `LLANA_WEBHOOK_TABLE` for webhook requests.
src/app.controller.post.ts	Renamed `createOne` to `create`, added webhook-specific logic and authentication.
src/app.controller.put.ts	Enhanced `PutController` to manage webhook updates with specific authentication checks.
src/app.module.ts	Imported and registered `ScheduleModule`, added `TasksService`, removed `Websockets`.
src/app.service.bootup.ts	Extended `onApplicationBootstrap` to create `_llana_webhook` and `_llana_webhook_log` schemas.
src/app.service.tasks.ts	Introduced `TasksService` for managing scheduled tasks related to webhooks.
src/databases/mongo.database.ts	Updated logging in `createOne` and `findMany` methods for clarity.
src/databases/mysql.database.ts	Added foreign key constraint logic in `createTable` method.
src/databases/postgres.database.ts	Implemented foreign key constraint handling during table creation.
src/dtos/webhook.dto.ts	Added `Webhook` and `WebhookLog` classes with validation.
src/helpers/Documentation.ts	Expanded `generateDocumentation` to include new webhook endpoints.
src/helpers/Query.ts	Updated error logging and table listing logic.
src/helpers/Webhook.ts	Introduced `Webhook` class for managing webhook operations.
src/helpers/Websocket.ts	Renamed `Websockets` to `Websocket`, updated publish method signature.
src/main.ts	Added conditional logging for timezone information.
src/types/database.types.ts	Renamed `SocketType` to `PublishType`, corrected interface names.
src/utils/String.ts	Added `plural` function for generating plural forms of words.

Possibly related PRs

#41: Changes in the GetController class involve restructuring logic for handling requests, which may relate to the overall data retrieval process in the main PR.
#42: Modifications in the GetController class include formatting improvements and adjustments that could impact how user data is retrieved, relevant to the user document insertion in the main PR.
#44: Enhancements in the DeleteController for handling request identifiers may relate to the structured data insertion and retrieval logic in the main PR.
#46: The introduction of caching mechanisms could be relevant to the data handling improvements in the main PR, particularly regarding the efficiency of data retrieval.
#49: The addition of PostgreSQL support and related schema management could connect with the restructuring of data handling in the main PR, especially with the introduction of new collections.
#71: The introduction of API documentation features may relate to the new data structures and endpoints introduced in the main PR.
#92: Enhancements to the Query class for managing relations could connect with the new collection and data relationships established in the main PR.
#93: The test runner modifications may indirectly relate to the overall testing and validation of the new data handling features introduced in the main PR.

🐇 In the land of code where changes bloom,
New webhooks dance, dispelling gloom.
With tasks scheduled and logs refined,
Our rabbit's work is well-defined.
So hop along, let’s celebrate,
For every change, we elevate! 🎉

🪧 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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

juicyllama / llana