Skip to content
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

v2: дефолтные значения в конструкторе сценария +тест #1482

Merged
merged 1 commit into from
Jan 2, 2025

Conversation

Mr-Rm
Copy link
Collaborator

@Mr-Rm Mr-Rm commented Jan 1, 2025

Исправляет падение в native.

Summary by CodeRabbit

  • New Features

    • Enhanced constructor parameter handling to support default values
    • Added a new test case for constructor parameter validation
  • Tests

    • Introduced a new test to verify constructor behavior with default parameters
    • Expanded test suite for constructor and method parameter handling

Copy link

coderabbitai bot commented Jan 1, 2025

Walkthrough

The pull request introduces enhancements to the script engine's handling of constructor parameters, focusing on improving parameter management during instance creation. The changes modify the UserScriptContextInstance class to better handle scenarios with varying numbers of constructor parameters. A new test case is added to verify the behavior of constructors with default parameters, and a corresponding test class is created to support this functionality.

Changes

File Change Summary
src/ScriptEngine/Machine/Contexts/UserScriptContextInstance.cs Updated parameter handling logic, replacing ConstructorParams.Count() with ConstructorParams.Length and implementing robust parameter management
tests/native-lib/test-native-use.os Added new test case ТестДолжен_ПроверитьВызовКонструктораСПараметрамиПоУмолчанию to test constructor parameter behavior
tests/native-lib/Классы/ПараметрыКонструктораПоУмолчанию.os Created a new class with a constructor procedure supporting default parameters

Sequence Diagram

sequenceDiagram
    participant ScriptEngine
    participant UserScriptContextInstance
    participant ScriptMethod

    ScriptEngine->>UserScriptContextInstance: Create Instance
    UserScriptContextInstance-->>ScriptEngine: Check Constructor Parameters
    alt Parameters Insufficient
        UserScriptContextInstance->>UserScriptContextInstance: Create Extended Parameters Array
        UserScriptContextInstance->>ScriptMethod: Call with Filled Parameters
    else Parameters Sufficient
        UserScriptContextInstance->>ScriptMethod: Call with Existing Parameters
    end
Loading

Possibly related PRs

Poem

🐰 Constructor's dance, parameters in line,
Default values bloom like springtime's design
Code leaps and bounds with elegant grace
Filling the gaps with a rabbit's embrace
Robust and nimble, our script engine sings! 🌟


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)
tests/native-lib/test-native-use.os (1)

90-94: Add an assertion to validate the constructor’s result
Currently, this test only instantiates the object without checking its state or behavior. Consider adding assert statements to confirm that the object is correctly initialized.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5a45a40 and d4aaf34.

📒 Files selected for processing (3)
  • src/ScriptEngine/Machine/Contexts/UserScriptContextInstance.cs (2 hunks)
  • tests/native-lib/test-native-use.os (2 hunks)
  • tests/native-lib/Классы/ПараметрыКонструктораПоУмолчанию.os (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • tests/native-lib/Классы/ПараметрыКонструктораПоУмолчанию.os
🔇 Additional comments (3)
tests/native-lib/test-native-use.os (1)

17-18: New test addition looks good!
The new test name is consistent and helps expand coverage for default constructor parameters.

src/ScriptEngine/Machine/Contexts/UserScriptContextInstance.cs (2)

68-68: Good switch to using .Length
Using ConstructorParams.Length avoids overhead and is more idiomatic than Count().


86-97: Constructor default parameter handling is well-structured
This logic appropriately copies constructor arguments and assigns default values to any missing parameters.

To validate usage across the codebase, consider searching for calls to OnInstanceCreation and confirming that default parameters are managed as expected:

✅ Verification successful

Let me verify the usage of default parameters by checking the method information and parameter handling.


Let me check one more aspect to verify the parameter handling implementation.


Default parameter handling implementation is correctly verified

The code's handling of default parameters is well-implemented and verified through the following findings:

  1. The UserScriptContextInstance correctly:

    • Checks for required parameters count vs provided parameters
    • Validates that any skipped parameters have default values
    • Properly copies constructor parameters and fills missing ones with their default values
    • Uses proper error handling for parameter mismatches
  2. The implementation is supported by a robust default value system throughout the codebase:

    • MethodSignature tracks default values through HasDefaultValue and DefaultValueIndex
    • MachineInstance handles default value application during execution
    • Parameter validation ensures all required parameters are provided

The original review comment's approval of the constructor default parameter handling is accurate and supported by the implementation details found in the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for usage of OnInstanceCreation and verify calls with default parameter usage.

rg -A 5 'OnInstanceCreation'

Length of output: 6180


Script:

#!/bin/bash
# Search for GetMethodInfo and related parameter handling
ast-grep --pattern 'GetMethodInfo($_)'

# Also check for any other relevant parameter handling in UserScriptContextInstance
rg -A 10 'parameters\[' src/ScriptEngine/Machine/Contexts/UserScriptContextInstance.cs

Length of output: 918


Script:

#!/bin/bash
# Check the implementation of GetMethodInfo and DefaultValue handling
rg -A 5 'DefaultValue' src/ScriptEngine/Machine/

Length of output: 11623

@EvilBeaver EvilBeaver merged commit 71ccd4f into EvilBeaver:develop Jan 2, 2025
1 of 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