Skip to content

updated post-attachment table : #3377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

iamanishx
Copy link

@iamanishx iamanishx commented Mar 18, 2025

What kind of change does this PR introduce?

Issue Number: #3365

Fixes #

Snapshots/Videos:

If relevant, did you update the documentation?

Summary
made the new attributes notNull() in post attachment table .

Does this PR introduce a breaking change?

Checklist

CodeRabbit AI Review

  • I have reviewed and addressed all critical issues flagged by CodeRabbit AI
  • I have implemented or provided justification for each non-critical suggestion
  • I have documented my reasoning in the PR comments where CodeRabbit AI suggestions were not implemented

Test Coverage

  • I have written tests for all new changes/features
  • I have verified that test coverage meets or exceeds 95%
  • I have run the test suite locally and all tests pass

Other information

Have you read the contributing guide?

Summary by CodeRabbit

  • New Features

    • Introduced a new GraphQL mutation to allow membership cancellations.
  • Refactor

    • Enhanced file attachment handling by enforcing mandatory file data and standardizing naming for improved consistency.
    • Streamlined the GraphQL API by simplifying input fields and removing outdated mutation operations.

Signed-off-by: imanishx <[email protected]>
Copy link

coderabbitai bot commented Mar 18, 2025

Walkthrough

This pull request enforces stricter data integrity in the post_attachments table while also updating related artifacts. The SQL migration and TypeScript schema now require non-null values for attachment identifiers. Additional changes update the migration journal timestamps, rework lefthook pre-commit command numbering, modify JSON sample data key naming conventions, and adjust GraphQL type definitions by removing certain fields and adding a new mutation.

Changes

File(s) Change Summary
drizzle_migrations/20250319030651_swift_shiva.sql
src/drizzle/…/postAttachments.ts
Enforced NOT NULL constraints on object_name/objectName and file_hash/fileHash in the post_attachments table to prevent missing values.
drizzle_migrations/meta/_journal.json Updated the journal entry with a new timestamp and tag identifier.
lefthook.yaml Reordered pre-commit commands: removed the original 9_check_tests and introduced 10_check_tests while keeping other commands unchanged.
scripts/dbManagement/sample_data/post_attachments.json Renamed key "file_hash" to "fileHash" and added a new "objectName" key, shifting from snake_case to camelCase.
test/routes/graphql/gql.tada.d.ts Modified GraphQL types by removing objectName from FileMetadataInput, adding a new cancelMembershipRequest mutation (returning CancelMembershipResponse), and removing several other mutation fields.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant GraphQLService
    participant Database
    Client->>GraphQLService: Invoke cancelMembershipRequest mutation
    GraphQLService->>Database: Process membership cancellation update
    Database-->>GraphQLService: Return update confirmation
    GraphQLService-->>Client: Respond with CancelMembershipResponse
Loading

Possibly related PRs

Suggested labels

ignore-sensitive-files-pr

Suggested reviewers

  • palisadoes
  • disha1202

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

🪧 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 generate docstrings to generate docstrings for this 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.

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.

coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 18, 2025
Copy link

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

@iamanishx iamanishx changed the title changes lefthook.yaml updated post-attachment table : Mar 18, 2025
Copy link

codecov bot commented Mar 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.78%. Comparing base (d27eaa8) to head (6806de1).
Report is 2 commits behind head on develop-postgres.

Additional details and impacted files
@@                Coverage Diff                @@
##           develop-postgres    #3377   +/-   ##
=================================================
  Coverage             54.78%   54.78%           
=================================================
  Files                   483      483           
  Lines                 36535    36535           
  Branches               1398     1398           
=================================================
  Hits                  20014    20014           
  Misses                16516    16516           
  Partials                  5        5           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@palisadoes
Copy link
Contributor

  1. Please make coderabbit.ai approves your work.
  2. Resolve any conflicting files
  3. Make sure all tests pass and are valid.
  4. Ensure the test code coverage for your patch reaches as close to 100% as possible.

Signed-off-by: imanishx <[email protected]>
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between db07543 and a1014b6.

⛔ Files ignored due to path filters (1)
  • docs/docs/docs/auto-schema/graphql/inputs/MutationCreatePostInput/variables/MutationCreatePostInput.md is excluded by !**/docs/docs/**
📒 Files selected for processing (6)
  • drizzle_migrations/20250319030651_swift_shiva.sql (1 hunks)
  • drizzle_migrations/meta/_journal.json (1 hunks)
  • lefthook.yaml (1 hunks)
  • scripts/dbManagement/sample_data/post_attachments.json (6 hunks)
  • src/drizzle/tables/postAttachments.ts (1 hunks)
  • test/routes/graphql/gql.tada.d.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • test/routes/graphql/gql.tada.d.ts
🧰 Additional context used
🪛 YAMLlint (1.35.1)
lefthook.yaml

[error] 33-33: trailing spaces

(trailing-spaces)


[error] 42-42: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Validate CodeRabbit Approval
🔇 Additional comments (4)
drizzle_migrations/meta/_journal.json (1)

8-9: Updated migration metadata looks good.

The timestamp and tag have been updated to match the new migration file (20250319030651_swift_shiva.sql) that enforces NOT NULL constraints on the post_attachments table.

drizzle_migrations/20250319030651_swift_shiva.sql (1)

293-294: Improved data integrity for post_attachments table.

Adding NOT NULL constraints to object_name and file_hash columns ensures that all post attachment records will have these values populated, which prevents potential issues with missing file identifiers or invalid references.

scripts/dbManagement/sample_data/post_attachments.json (1)

9-10: Property naming updated to align with schema changes.

The sample data has been updated to include the new non-nullable objectName field and rename file_hash to fileHash, maintaining consistency between the database schema and the application code's camelCase convention.

Also applies to: 19-20, 29-30, 39-40, 49-50, 59-60

src/drizzle/tables/postAttachments.ts (1)

59-59: Added NOT NULL constraints to match database schema.

The TypeScript model now correctly requires objectName and fileHash fields, ensuring type safety and consistency with the database constraints. This change properly enforces data integrity in both the database and application layers.

Also applies to: 64-64

coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 19, 2025
Signed-off-by: imanishx <[email protected]>
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

♻️ Duplicate comments (1)
lefthook.yaml (1)

33-33: 🧹 Nitpick (assertive)

Nitpick: Remove Trailing Whitespace in 8_check_type_errors Command.
Please ensure that there are no trailing spaces at the end of the pnpm check_type_errors line. This aligns with our previous review comments and YAMLlint recommendations for clean formatting.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a1014b6 and 33b0970.

📒 Files selected for processing (1)
  • lefthook.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run tests for talawa api

coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 19, 2025
@iamanishx
Copy link
Author

  1. Please make coderabbit.ai approves your work.
  2. Resolve any conflicting files
  3. Make sure all tests pass and are valid.
  4. Ensure the test code coverage for your patch reaches as close to 100% as possible.

please review

@Cioppolo14 Cioppolo14 added the ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files label Mar 19, 2025
@Cioppolo14
Copy link
Contributor

@disha1202 @varshith257 Can you review this PR?

Signed-off-by: imanishx <[email protected]>
@palisadoes palisadoes merged commit 2b80073 into PalisadoesFoundation:develop-postgres Mar 20, 2025
16 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants