feat: add discourse table APIs

[Behzad-rabiei]

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced three new API endpoints for retrieving member activity data:
    • /active-members-composition-table
    • /active-members-onboarding-table
    • /disengaged-members-composition-table
  • Added functionality to query and retrieve detailed information about active and disengaged members.

• Bug Fixes

  • Improved error handling in member activity queries.

• Documentation

  • Updated API documentation to include new endpoints and their usage.

• Chores

  • Enhanced validation schemas for member activity parameters.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce new asynchronous functions and API endpoints in the Discourse module, focusing on member activity compositions. Three functions are added to handle active and disengaged members, each with corresponding validation schemas and routes. Additionally, a new service for querying members is created, enhancing the overall functionality of the Discourse platform. The updates also include improvements to existing services and validation schemas, ensuring robust error handling and data management.

Changes

Files	Change Summary
src/controllers/discourse.controller.ts	Added three asynchronous functions for handling active and disengaged members, including error handling and response formatting.
src/docs/discourse.doc.yml	Introduced three new API endpoints for member activity data retrieval, detailing request parameters and response structures.
src/routes/v1/discourse.route.ts	Added new POST routes for the three member activity endpoints, requiring admin authentication and validation.
src/services/discourse/core.service.ts	Introduced a new function to create a Discourse forum, with error handling and logging updates.
src/services/discourse/index.ts	Added membersService to the default export, expanding service functionality.
src/services/discourse/memberActivity.service.ts	Introduced new functions for handling member activity data and enhanced existing functions for improved data processing.
src/services/discourse/members.service.ts	Created a new service for querying members, implementing a MongoDB aggregation pipeline for activity composition data.
src/services/platform.service.ts	Modified the createPlatform function to include handling for Discourse alongside Discord.
src/validations/discourse.validation.ts	Added new validation schemas for member activity endpoints, ensuring proper parameter and query validation.
src/validations/platform.validation.ts	Added a new property isInProgress to track the state of discourse processes.

Possibly related PRs

• feat: add discourse support for framentation and decentralisation met… #386: Adds support for fragmentation and decentralization metrics in the discourse context, aligning with new functions for member activity compositions.
• feat: add discourse/heatmap APIs #387: Introduces discourse heatmap APIs, related to the new asynchronous functions managing member activity data.
• 390 discourse platform + violation detection module #392: Integrates the Discourse platform into the violation detection module, potentially linking to the member activity functions by enhancing platform capabilities.

Poem

🐇 In the land of code where rabbits play,
New functions hop in, brightening the day.
Active members gather, disengaged take flight,
With endpoints and services, all feels just right.
Validation's a friend, ensuring all's clear,
Let's celebrate changes, with a joyful cheer! 🎉

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.