Skip to content

Conversation

@sfaqer
Copy link
Contributor

@sfaqer sfaqer commented Jan 14, 2025

Исправлена ошибка с тем что в фоновых заданиях не срабатывали подписки на события

closes: #1485

Summary by CodeRabbit

  • Tests

    • Enhanced test coverage for background task event handling
    • Added new test to verify event handlers in background tasks
    • Introduced new test variables and procedures to support event processing verification
  • Bug Fixes

    • Improved event processor context preservation during background task execution

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

Walkthrough

The changes address an issue with event handlers not being triggered in background tasks. The modifications involve updating the BackgroundTasksManager in the standard library to preserve the EventProcessor context during background task execution. Additionally, a new test case has been added to tests/tasks.os to verify that event handlers are correctly invoked in background tasks.

Changes

File Change Summary
src/OneScript.StandardLibrary/Tasks/BackgroundTasksManager.cs Added logic to capture and preserve EventProcessor context in worker tasks
tests/tasks.os Added new test procedure to validate event handler invocation in background tasks

Sequence Diagram

sequenceDiagram
    participant BG as Background Task
    participant MI as MachineInstance
    participant EP as EventProcessor
    
    BG->>MI: Capture Current EventProcessor
    MI-->>BG: Return EventProcessor
    BG->>MI: Set EventProcessor Context
    BG->>EP: Trigger Event
    EP->>BG: Execute Event Handlers
Loading

Assessment against linked issues

Objective Addressed Explanation
Event handlers should be triggered in background tasks [#1485]

Poem

🐰 In the realm of background's might,
Events now dance with pure delight!
Processors preserved with care,
No handler left behind to spare
Code rabbits hop with joyous flair! 🚀


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
Contributor

@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)
tests/tasks.os (1)

274-294: LGTM! Well-structured test with proper cleanup.

The test follows good practices:

  • Clear Arrange-Act-Assert pattern
  • Proper cleanup by unsubscribing from the event
  • Descriptive assertion message

Consider enhancing the test to verify that the event handler is actually called in the background thread context.

 Процедура ТестДолжен_ПроверитьЧтоОбработчикиСобытийВызываютсяВФоновомЗадании() Экспорт
 
     СобытиеВызвано = Ложь;
+    ВызваноВФоновомПотоке = Ложь;
 
     Параметры = Новый Массив;
     Параметры.Добавить("ЯСобытие");
     Параметры.Добавить(Новый Массив);
 
     ДобавитьОбработчик ЭтотОбъект.ЯСобытие, Событие;
 
     ФоновоеЗадание = ФоновыеЗадания.Выполнить(ЭтотОбъект, "ВызватьСобытие", Параметры);
     ФоновоеЗадание.ОжидатьЗавершения();
 
     УдалитьОбработчик ЭтотОбъект.ЯСобытие, Событие;
 
     юТест.ПроверитьИстину(
         СобытиеВызвано,
         "Ожидали что при вызове события в фоновом задании вызовется, а это не так"
     );
+    юТест.ПроверитьИстину(
+        ВызваноВФоновомПотоке,
+        "Ожидали что событие вызовется в фоновом потоке"
+    );
 
 КонецПроцедуры
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 985c65d and 0c96d6b.

📒 Files selected for processing (2)
  • src/OneScript.StandardLibrary/Tasks/BackgroundTasksManager.cs (1 hunks)
  • tests/tasks.os (4 hunks)
🔇 Additional comments (4)
src/OneScript.StandardLibrary/Tasks/BackgroundTasksManager.cs (1)

50-56: LGTM! Clean fix for event handling in background tasks.

The implementation correctly preserves the EventProcessor context across thread boundaries by capturing it before task creation and restoring it within the worker task. This ensures event handlers work properly in background tasks.

tests/tasks.os (3)

6-6: LGTM! Clear and purposeful variable declaration.

The variable name clearly indicates its purpose of tracking event handler invocation.


27-27: LGTM! Test case name is descriptive and follows conventions.

The test case name clearly communicates its purpose of verifying event handler invocation in background tasks.


74-76: LGTM! Simple and focused event handler implementation.

The event handler is correctly exported and has a clear, single responsibility of setting the event flag.

@EvilBeaver EvilBeaver merged commit 9cf7ebe into EvilBeaver:develop Jan 16, 2025
2 checks passed
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.

Обработчики событий не вызываются в фоновом задании

2 participants