Skip to content

[OSDEV-1558] Described that the action_type field was added to the moderation_events OpenSearch index.#499

Merged
vladsha-dev merged 2 commits intomainfrom
OSDEV-1558-update-the-release-notes-properly
Feb 4, 2025
Merged

[OSDEV-1558] Described that the action_type field was added to the moderation_events OpenSearch index.#499
vladsha-dev merged 2 commits intomainfrom
OSDEV-1558-update-the-release-notes-properly

Conversation

@vladsha-dev
Copy link
Contributor

@vladsha-dev vladsha-dev commented Feb 4, 2025

The release note related to OSDEV-1558 was rewritten in the Release Instructions section to properly describe the changes made in this task and the reason why the OpenSearch indexes need to be cleared while deploying 1.29.0 version.

@vladsha-dev vladsha-dev self-assigned this Feb 4, 2025
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:36 — with GitHub Actions Inactive
@coderabbitai
Copy link

coderabbitai bot commented Feb 4, 2025

📝 Walkthrough

Walkthrough

The pull request updates the release notes for version 1.29.0 of the Open Supply Hub project. It documents a PostgreSQL upgrade (from version 13 to 16) along with an update to the pg_trgm extension (to version 1.6) and the addition of an action_type field to the api_moderationevent table. The API now supports Geohex grid aggregation through the GET /api/v1/production-locations/ endpoint and includes handling for a new geohex_grid_precision parameter. Additionally, the release instructions have been updated to modify the deployment pipeline for updating index mappings in OpenSearch.

Changes

File(s) Change Summary
doc/release/RELEASE-NOTES.md Updated release notes for v1.29.0 detailing database changes (PostgreSQL upgrade, pg_trgm update, and addition of action_type to api_moderationevent with migration script adjustments), API changes (Geohex grid aggregation support with geohex_grid_precision parameter and Logstash mapping update), and revised release instructions for index mapping updates.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API_Server
    participant Database
    Client->>API_Server: GET /api/v1/production-locations?aggregation=geohex_grid[&geohex_grid_precision= (optional)]
    API_Server->>API_Server: Validate parameters (default geohex_grid_precision = 5 if omitted)
    API_Server->>Database: Query production locations with Geohex grid aggregation
    Database-->>API_Server: Return aggregated results
    API_Server-->>Client: Respond with aggregated data
Loading
sequenceDiagram
    participant DevOps
    participant Deployment_Pipeline
    participant OpenSearch
    DevOps->>Deployment_Pipeline: Trigger [Release] Deploy with clear flag (Clear the custom OpenSearch indexes and templates=true)
    Deployment_Pipeline->>OpenSearch: Clear indexes and update mappings for moderation-events index
    OpenSearch-->>Deployment_Pipeline: Acknowledge update
    Deployment_Pipeline-->>DevOps: Confirm successful deployment
Loading

Possibly related PRs

Suggested reviewers

  • Innavin369
  • roman-stolar
  • VadimKovalenkoSNF
  • mazursasha1990

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a9f0c94 and 4e6dd30.

📒 Files selected for processing (1)
  • doc/release/RELEASE-NOTES.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (13)
  • GitHub Check: run-fe-code-quality
  • GitHub Check: run-flake8-linter
  • GitHub Check: run-integration-test-code-quality
  • GitHub Check: run-eslint-linter-and-prettier-formatter
  • GitHub Check: run-django-code-quality
  • GitHub Check: run-dd-code-quality
  • GitHub Check: run-countries-code-quality
  • GitHub Check: run-contricleaner-code-quality
  • GitHub Check: get-base-branch-fe-cov
  • GitHub Check: get-base-branch-countries-cov
  • GitHub Check: get-base-branch-contricleaner-cov
  • GitHub Check: get-base-branch-dd-cov
  • GitHub Check: get-base-branch-django-cov
🔇 Additional comments (1)
doc/release/RELEASE-NOTES.md (1)

58-58: Clarification on Deployment Flag for OpenSearch Index Mapping Update

The updated release instruction in line 58 now clearly states that the [Release] Deploy pipeline must be run with the flag Clear the custom OpenSearch indexes and templates set to true. This ensures that the index mapping for the moderation-events index is updated to incorporate the new action_type field—and it also notes that the production-locations indexes will be affected. This addition is clear and directly supports the changes outlined under OSDEV-1558.

Please verify that the flag exists and is properly documented in your deployment configurations. If not already done, consider referencing OSDEV-1558 explicitly within the note for added clarity.


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
🪧 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. (Beta)
  • @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.

@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:39 — with GitHub Actions Inactive
@barecheck
Copy link

barecheck bot commented Feb 4, 2025

React App | Jest test suite - Code coverage report

Total: 28.88%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

Innavin369
Innavin369 previously approved these changes Feb 4, 2025
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:41 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:41 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:41 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:41 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:41 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:41 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:41 — with GitHub Actions Inactive
@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 4, 2025

Copy link
Contributor

@mazursasha1990 mazursasha1990 left a comment

Choose a reason for hiding this comment

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

LGTM

@vladsha-dev vladsha-dev enabled auto-merge (squash) February 4, 2025 08:42
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:43 — with GitHub Actions Inactive
@barecheck
Copy link

barecheck bot commented Feb 4, 2025

Dedupe Hub App | Unittest test suite - Code coverage report

Total: 56.14%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

@barecheck
Copy link

barecheck bot commented Feb 4, 2025

Contricleaner App | Unittest test suite - Code coverage report

Total: 98.91%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

@barecheck
Copy link

barecheck bot commented Feb 4, 2025

Countries App | Unittest test suite - Code coverage report

Total: 100%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:47 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:48 — with GitHub Actions Inactive
@vladsha-dev vladsha-dev temporarily deployed to Quality Environment February 4, 2025 08:48 — with GitHub Actions Inactive
@barecheck
Copy link

barecheck bot commented Feb 4, 2025

Django App | Unittest test suite - Code coverage report

Total: 80.4%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

@vladsha-dev vladsha-dev merged commit 5b7066d into main Feb 4, 2025
20 of 21 checks passed
@vladsha-dev vladsha-dev deleted the OSDEV-1558-update-the-release-notes-properly branch February 4, 2025 08:58
protsack-stephan pushed a commit that referenced this pull request Apr 12, 2025
…deration_events OpenSearch index. (#499)

The release note related to OSDEV-1558 was rewritten in the Release Instructions section to properly describe the
changes made in this task and the reason why the OpenSearch indexes need
to be cleared while deploying 1.29.0 version.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants