Skip to content

[OSDEV-1785] Link to the forked aiokafka@0.8.0#534

Merged
vladsha-dev merged 3 commits intomainfrom
OSDEV-1785-pin-kafka-version-to-aiokafka
Feb 24, 2025
Merged

[OSDEV-1785] Link to the forked aiokafka@0.8.0#534
vladsha-dev merged 3 commits intomainfrom
OSDEV-1785-pin-kafka-version-to-aiokafka

Conversation

@VadimKovalenkoSNF
Copy link
Contributor

@VadimKovalenkoSNF VadimKovalenkoSNF commented Feb 24, 2025

Fix OSDEV-1785
Link to the forked aiokafka@0.8.0
Workaround for issue mentioned in aio-libs/aiokafka#1093

@VadimKovalenkoSNF VadimKovalenkoSNF self-assigned this Feb 24, 2025
@coderabbitai
Copy link

coderabbitai bot commented Feb 24, 2025

📝 Walkthrough

Walkthrough

This pull request updates the release documentation and Docker build process. The release notes and protocol files have been modified to shift the versioning from 2.x to 1.30.0, update release dates, remove redundant sections and legacy version entries, and streamline content. The Dockerfile now removes the aiokafka package from the requirements via a sed command and installs it from a custom Git repository while adding an installation for Git.

Changes

File(s) Change Summary
doc/release/RELEASE-NOTES.md, doc/release/RELEASE-PROTOCOL.md Updated release versioning from 2.1.0 to 1.30.0 and adjusted release dates. Removed legacy sections (including entries for v2.0.0 and v2.1.0) and streamlined bug fixes and post-deployment instructions.
src/django/Dockerfile Modified dependency handling: removed the aiokafka package from requirements.txt using sed, installed aiokafka from a custom Git repository compatible with kafka-python-2.0.3, and added Git installation.

Sequence Diagram(s)

sequenceDiagram
    participant Build as Docker Build Process
    participant Req as requirements.txt
    participant Git as Git Repository

    Build->>Req: Read requirements.txt
    Build->>Req: Execute sed to remove aiokafka
    Build->>Build: Install dependencies from modified requirements.txt
    Build->>Git: Clone and install aiokafka from the custom repository
    Git-->>Build: Provide the specified aiokafka package
    Build->>Build: Cleanup by removing requirements.txt
Loading

Possibly related PRs

  • Updated RELEASE-NOTES.md file for 1.24 version #396: The changes in the main PR regarding the restructuring of the RELEASE-NOTES.md file are related to the updates made in the retrieved PR, as both involve modifications to the same file for different release versions.
  • Update release protocol #501: The changes in the main PR, which involve updating the release version and restructuring the release notes, are directly related to the modifications in the retrieved PR that also address versioning in the RELEASE-PROTOCOL.md file, specifically regarding the removal of versions 2.0.0 and 2.1.0.
  • Update the release schedule in the release protocol after release v1.23 #411: The changes in the main PR regarding the release versioning and content structure in RELEASE-NOTES.md are directly related to the updates made to the release schedule in RELEASE-PROTOCOL.md in the retrieved PR, as both involve modifications to the versioning strategy and release dates.

Suggested reviewers

  • mazursasha1990
  • roman-stolar
  • Innavin369

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.

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: 0

🧹 Nitpick comments (1)
src/django/Dockerfile (1)

7-10: Removing aiokafka from Requirements

The addition of the comment and the sed command (

+# [OSDEV-1785][https://github.com/aio-libs/aiokafka/issues/1093] - Remove aiokafka in requirements.txt to avoid conflicts.
+RUN sed -i '/aiokafka/d' requirements.txt

) clearly documents why aiokafka is removed from requirements.txt to prevent conflicts.
Consider verifying that the regex exactly matches the intended package name in all cases, though this simple pattern should work in most scenarios.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 842aa4e and 68ee7b8.

📒 Files selected for processing (3)
  • doc/release/RELEASE-NOTES.md (3 hunks)
  • doc/release/RELEASE-PROTOCOL.md (1 hunks)
  • src/django/Dockerfile (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (13)
  • GitHub Check: run-integration-test-code-quality
  • GitHub Check: run-flake8-linter
  • GitHub Check: run-fe-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-django-cov
  • GitHub Check: get-base-branch-contricleaner-cov
  • GitHub Check: get-base-branch-dd-cov
🔇 Additional comments (3)
doc/release/RELEASE-PROTOCOL.md (1)

56-56: Version Table Update: New Release Entry for v1.30.0

The new row

| v1.30.0 | March 1, 2025 | February 25, 2025 | @Vadim Kovalenko |

appears to correctly replace the removed v2.0.0 and v2.1.0 entries, reflecting the new minor versioning strategy. Please double-check that all related documentation (especially RELEASE-NOTES.md) matches this change.

src/django/Dockerfile (1)

24-25: Installing aiokafka from the Custom Repository

The custom pip install command:

+# [OSDEV-1785][https://github.com/aio-libs/aiokafka/issues/1093] - Install aiokafka from the custom repo.
+&& pip install --no-cache-dir git+https://github.com/VadimKovalenkoSNF/aiokafka.git@kafka-python-2.0.3 \

ensures that the forked version of aiokafka is installed from the specified Git repository at the desired branch or tag. Please confirm that the branch/tag “kafka-python-2.0.3” is maintained as expected and integrates well with the rest of the dependencies.

doc/release/RELEASE-NOTES.md (1)

6-11: Updated Release Notes for Version 1.30.0

The release notes now reflect the new release version and corresponding release date:

## Release 1.30.0
...
* Release date: March 01, 2025

This update is consistent with the changes made in the release protocol and supports the new versioning strategy. Everything looks clear and consistent.

@barecheck
Copy link

barecheck bot commented Feb 24, 2025

React App | Jest test suite - Code coverage report

Total: 29.56%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

@sonarqubecloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
B Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

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: 0

🧹 Nitpick comments (1)
doc/release/RELEASE-NOTES.md (1)

52-52: Default Search Tab Update (OSDEV-1745)
The release note for OSDEV-1745 now indicates that the "Search by Name and Address" tab is set as the default on the Production Location Search page. It would be helpful to include a brief description of why this change was made (for example, improvements in usability or addressing specific user feedback) to provide better context for the change.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e8762e8 and 7ef6133.

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

6-6: Release Version Update via Header
The header now reads "## Release 1.30.0", which updates the release version as intended. Please verify that this version change is consistent across all release documentation and deployment pipelines.


10-10: Updated Release Date
The release date has been changed to "March 01, 2025". Ensure that this date accurately reflects the planned release schedule and is consistent with any related documentation (e.g., RELEASE-PROTOCOL.md).


34-34: Architecture Diagram Update Description (OSDEV-1580)
The note for OSDEV-1580 now specifies that the new architecture diagram has been placed in the root of the ./doc/system_design/ folder with the old ones archived, and that a new README.md has been created. Please double-check that the file paths and descriptions match the actual file structure and that the testing timeline (pen testing in February 2025) is still valid.


35-35: aiokafka Fork Information (OSDEV-1785)
The release notes now document that the aiokafka repository has been forked, reverted to v0.8.0, and that a dedicated branch (kafka-python-2.0.3) has been created with the kafka-python version pinned to v2.0.3. This change directly addresses the PR objective. Please confirm that these details (branch name, version numbers, and reference links) are consistent with the Dockerfile and other release artifacts.

Copy link
Contributor

@vladsha-dev vladsha-dev 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 merged commit fb7376c into main Feb 24, 2025
16 of 21 checks passed
@vladsha-dev vladsha-dev deleted the OSDEV-1785-pin-kafka-version-to-aiokafka branch February 24, 2025 13:13
protsack-stephan pushed a commit that referenced this pull request Apr 12, 2025
Fix [OSDEV-1785](https://opensupplyhub.atlassian.net/browse/OSDEV-1785)
Link to the forked aiokafka@0.8.0
Workaround for issue mentioned in
aio-libs/aiokafka#1093
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.

4 participants