Skip to content

[TT-11377] Adding “node_is_segmented” flag under “node” to complement “tags”#6093

Merged
mativm02 merged 2 commits into
masterfrom
TT-11377
Mar 5, 2024
Merged

[TT-11377] Adding “node_is_segmented” flag under “node” to complement “tags”#6093
mativm02 merged 2 commits into
masterfrom
TT-11377

Conversation

@mativm02

@mativm02 mativm02 commented Mar 4, 2024

Copy link
Copy Markdown
Contributor

Description

Adding node_is_segmented flag under node to complement tags.

MDCB PR: https://github.com/TykTechnologies/tyk-sink/pull/496

Related Issue

https://tyktech.atlassian.net/browse/TT-11377?atlOrigin=eyJpIjoiNmNiY2VjZjM3NGZlNDBiZjgwNmNlOTMyOWRjYzIwN2EiLCJwIjoiaiJ9

Motivation and Context

https://tyktech.atlassian.net/browse/TT-11377?atlOrigin=eyJpIjoiNmNiY2VjZjM3NGZlNDBiZjgwNmNlOTMyOWRjYzIwN2EiLCJwIjoiaiJ9

How This Has Been Tested

Unit tests

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Refactoring or add test (improvements in base code or adds test coverage to functionality)

Checklist

  • I ensured that the documentation is up to date
  • I explained why this PR updates go.mod in detail with reasoning why it's required
  • I would like a code coverage CI quality gate exception and have explained why

Type

enhancement, tests


Description

  • Added a new boolean field NodeIsSegmented to the NodeData struct to indicate if a node is segmented.
  • Updated buildNodeInfo in rpc_storage_handler.go to populate the NodeIsSegmented field from the configuration.
  • Introduced a new test case in rpc_storage_handler_test.go to verify the behavior when the NodeIsSegmented flag is set to true.

Changes walkthrough

Relevant files
Enhancement
rpc.go
Add NodeIsSegmented Field to NodeData Struct                         

apidef/rpc.go

  • Added NodeIsSegmented boolean field to NodeData struct.
+9/-8     
rpc_storage_handler.go
Populate NodeIsSegmented in buildNodeInfo Function             

gateway/rpc_storage_handler.go

  • Populated NodeIsSegmented in buildNodeInfo function from
    configuration.
  • +8/-7     
    Tests
    rpc_storage_handler_test.go
    Test Case for NodeIsSegmented Flag                                             

    gateway/rpc_storage_handler_test.go

    • Added test case for NodeIsSegmented flag being true.
    +26/-0   

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @github-actions

    github-actions Bot commented Mar 4, 2024

    Copy link
    Copy Markdown
    Contributor

    API Changes

    --- prev.txt	2024-03-04 12:37:46.635607896 +0000
    +++ current.txt	2024-03-04 12:37:43.947597856 +0000
    @@ -1559,14 +1559,15 @@
     }
     
     type NodeData struct {
    -	NodeID      string                     `json:"node_id"`
    -	APIKey      string                     `json:"api_key"`
    -	GroupID     string                     `json:"group_id"`
    -	NodeVersion string                     `json:"node_version"`
    -	TTL         int64                      `json:"ttl"`
    -	Tags        []string                   `json:"tags"`
    -	Health      map[string]HealthCheckItem `json:"health"`
    -	Stats       GWStats                    `json:"stats"`
    +	NodeID          string                     `json:"node_id"`
    +	APIKey          string                     `json:"api_key"`
    +	GroupID         string                     `json:"group_id"`
    +	NodeVersion     string                     `json:"node_version"`
    +	TTL             int64                      `json:"ttl"`
    +	NodeIsSegmented bool                       `json:"node_is_segmented"`
    +	Tags            []string                   `json:"tags"`
    +	Health          map[string]HealthCheckItem `json:"health"`
    +	Stats           GWStats                    `json:"stats"`
     }
     
     type NotificationsManager struct {

    @github-actions

    github-actions Bot commented Mar 4, 2024

    Copy link
    Copy Markdown
    Contributor

    PR Description updated to latest commit (e856632)

    @github-actions

    github-actions Bot commented Mar 4, 2024

    Copy link
    Copy Markdown
    Contributor

    PR Review

    ⏱️ Estimated effort to review [1-5]

    2, because the changes are straightforward and localized to a specific feature implementation. The PR adds a new boolean field NodeIsSegmented to a data structure and ensures it is populated correctly. The changes are well-contained within existing structures and functions.

    🧪 Relevant tests

    Yes

    🔍 Possible issues

    Default Value Concern: The new boolean field NodeIsSegmented defaults to false if not explicitly set. Ensure this default behavior aligns with the application's expectations in all use cases.

    🔒 Security concerns

    No

    Code feedback:
    relevant filegateway/rpc_storage_handler.go
    suggestion      

    Consider validating NodeIsSegmented value or ensuring it's intentionally set in all relevant contexts to avoid unintentional behavior due to its default value. [important]

    relevant lineNodeIsSegmented: config.DBAppConfOptions.NodeIsSegmented,

    relevant fileapidef/rpc.go
    suggestion      

    Ensure that the addition of NodeIsSegmented does not impact serialization or deserialization processes, especially in backward compatibility scenarios. [important]

    relevant lineNodeIsSegmented bool `json:"node_is_segmented"`

    relevant filegateway/rpc_storage_handler_test.go
    suggestion      

    Add negative test cases to ensure NodeIsSegmented behaves correctly when set to false or not set at all, to cover all logical branches. [medium]

    relevant lineglobalConf.DBAppConfOptions.NodeIsSegmented = true


    ✨ Review tool usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
    When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

    /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
    

    With a configuration file, use the following template:

    [pr_reviewer]
    some_config1=...
    some_config2=...
    
    Utilizing extra instructions

    The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

    Examples for extra instructions:

    [pr_reviewer] # /review #
    extra_instructions="""
    In the 'possible issues' section, emphasize the following:
    - Does the code logic cover relevant edge cases?
    - Is the code logic clear and easy to understand?
    - Is the code logic efficient?
    ...
    """
    

    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

    How to enable\disable automation
    • When you first install PR-Agent app, the default mode for the review tool is:
    pr_commands = ["/review", ...]
    

    meaning the review tool will run automatically on every PR, with the default configuration.
    Edit this field to enable/disable the tool, or to change the used configurations

    Auto-labels

    The review tool can auto-generate two specific types of labels for a PR:

    • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
    • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
    Extra sub-tools

    The review tool provides a collection of possible feedbacks about a PR.
    It is recommended to review the possible options, and choose the ones relevant for your use case.
    Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
    require_score_review, require_soc2_ticket, and more.

    Auto-approve PRs

    By invoking:

    /review auto_approve
    

    The tool will automatically approve the PR, and add a comment with the approval.

    To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:

    [pr_reviewer]
    enable_auto_approval = true
    

    (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)

    You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag:

    [pr_reviewer]
    maximal_review_effort = 5
    
    More PR-Agent commands

    To invoke the PR-Agent, add a comment using one of the following commands:

    • /review: Request a review of your Pull Request.
    • /describe: Update the PR title and description based on the contents of the PR.
    • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
    • /ask <QUESTION>: Ask a question about the PR.
    • /update_changelog: Update the changelog based on the PR's contents.
    • /add_docs 💎: Generate docstring for new components introduced in the PR.
    • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
    • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

    See the tools guide for more details.
    To list the possible configuration parameters, add a /config comment.

    See the review usage page for a comprehensive guide on using this tool.

    @github-actions

    github-actions Bot commented Mar 4, 2024

    Copy link
    Copy Markdown
    Contributor

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Best practice
    Initialize complex structures with default values or through a constructor.

    Consider initializing complex structures like Health and Stats with default values or
    through a constructor function to ensure they are always in a valid state when a NodeData
    instance is created. This can help prevent nil pointer dereferences and other runtime
    errors.

    apidef/rpc.go [31-34]

     NodeIsSegmented bool                       `json:"node_is_segmented"`
     Tags            []string                   `json:"tags"`
    -Health          map[string]HealthCheckItem `json:"health"`
    -Stats           GWStats                    `json:"stats"`
    +Health          map[string]HealthCheckItem `json:"health"` // Initialized within a constructor or default function
    +Stats           GWStats                    `json:"stats"`  // Initialized within a constructor or default function
     
    Use a more descriptive variable name for NodeVersion.

    Consider using a more descriptive variable name than VERSION for NodeVersion to clarify
    what version it refers to, such as GatewayVersion or NodeSoftwareVersion.

    gateway/rpc_storage_handler.go [165]

    -NodeVersion:     VERSION,
    +NodeVersion:     GatewayVersion, // Assuming GatewayVersion is a more descriptive variable name
     
    Possible issue
    Ensure safe conversion of intCheckDuration to int64 for TTL.

    Ensure that intCheckDuration is correctly calculated and does not result in unexpected
    values when converted to int64 for the TTL field. This is important to avoid potential
    overflows or precision loss.

    gateway/rpc_storage_handler.go [166]

    -TTL:             intCheckDuration,
    +TTL:             int64(someSafeConversionFunction(intCheckDuration)),
     
    Enhancement
    Add assertions for new fields in test cases.

    Add assertions for the new fields NodeIsSegmented and APIKey in the test cases to ensure
    they are correctly set and propagated through the system.

    gateway/rpc_storage_handler_test.go [478-488]

     expectedNodeInfo: apidef.NodeData{
       NodeID:          "test-node-id",
       GroupID:         "group",
       TTL:             1,
       Tags:            []string{"tag1", "tag2"},
       NodeIsSegmented: true,
    +  APIKey:          "expected-api-key", // Assert this field
       NodeVersion:     VERSION,
       Stats: apidef.GWStats{
         APIsCount:     0,
         PoliciesCount: 0,
       },
     },
     
    Maintainability
    Abstract the creation of NodeData into a separate function.

    For better maintainability, consider abstracting the creation of NodeData into a separate
    function or method. This can help encapsulate the logic for building node information and
    make the code easier to read and modify.

    gateway/rpc_storage_handler.go [161-170]

    -node := apidef.NodeData{
    -  NodeID:          r.Gw.GetNodeID(),
    -  GroupID:         config.SlaveOptions.GroupID,
    -  APIKey:          config.SlaveOptions.APIKey,
    -  NodeVersion:     VERSION,
    -  TTL:             intCheckDuration,
    -  NodeIsSegmented: config.DBAppConfOptions.NodeIsSegmented,
    -  Tags:            config.DBAppConfOptions.Tags,
    -  Health:          r.Gw.getHealthCheckInfo(),
    -  Stats: apidef.GWStats{
    -    APIsCount:     r.Gw.apisByIDLen(),
    -    PoliciesCount: r.Gw.policiesByIDLen(),
    -},
    +node := createNodeData(r.Gw, config) // Assuming createNodeData is a new function that encapsulates this logic
     

    ✨ Improve tool usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
    When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
    

    With a configuration file, use the following template:

    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    
    Enabling\disabling automation

    When you first install the app, the default mode for the improve tool is:

    pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]
    

    meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

    Utilizing extra instructions

    Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.

    Examples for extra instructions:

    [pr_code_suggestions] # /improve #
    extra_instructions="""
    Emphasize the following aspects:
    - Does the code logic cover relevant edge cases?
    - Is the code logic clear and easy to understand?
    - Is the code logic efficient?
    ...
    """
    

    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

    A note on code suggestions quality
    • While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
    • Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
    • Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
    • With large PRs, best quality will be obtained by using 'improve --extended' mode.
    More PR-Agent commands

    To invoke the PR-Agent, add a comment using one of the following commands:

    • /review: Request a review of your Pull Request.
    • /describe: Update the PR title and description based on the contents of the PR.
    • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
    • /ask <QUESTION>: Ask a question about the PR.
    • /update_changelog: Update the changelog based on the PR's contents.
    • /add_docs 💎: Generate docstring for new components introduced in the PR.
    • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
    • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

    See the tools guide for more details.
    To list the possible configuration parameters, add a /config comment.

    See the improve usage page for a more comprehensive guide on using this tool.

    @sonarqubecloud

    sonarqubecloud Bot commented Mar 4, 2024

    Copy link
    Copy Markdown

    @buger

    buger commented Mar 4, 2024

    Copy link
    Copy Markdown
    Member

    API tests result - postgres15-sha256 env: success
    Branch used: refs/heads/master
    Commit: 3799d4f TT-11377 Adding “node_is_segmented” flag under “node” to complement “tags” (#6093)

    Description

    Adding node_is_segmented flag under node to complement tags.

    MDCB PR: https://github.com/TykTechnologies/tyk-sink/pull/496

    Related Issue

    https://tyktech.atlassian.net/browse/TT-11377?atlOrigin=eyJpIjoiNmNiY2VjZjM3NGZlNDBiZjgwNmNlOTMyOWRjYzIwN2EiLCJwIjoiaiJ9

    Motivation and Context

    https://tyktech.atlassian.net/browse/TT-11377?atlOrigin=eyJpIjoiNmNiY2VjZjM3NGZlNDBiZjgwNmNlOTMyOWRjYzIwN2EiLCJwIjoiaiJ9

    How This Has Been Tested

    Unit tests

    Screenshots (if appropriate)

    Types of changes

    • Bug fix (non-breaking change which fixes an issue)
    • New feature (non-breaking change which adds functionality)
    • Breaking change (fix or feature that would cause existing
      functionality to change)
    • Refactoring or add test (improvements in base code or adds test
      coverage to functionality)

    Checklist

    • I ensured that the documentation is up to date
    • I explained why this PR updates go.mod in detail with reasoning
      why it's required
    • I would like a code coverage CI quality gate exception and have
      explained why

    Type

    enhancement, tests


    Description

    • Added a new boolean field NodeIsSegmented to the NodeData struct
      to indicate if a node is segmented.
    • Updated buildNodeInfo in rpc_storage_handler.go to populate the
      NodeIsSegmented field from the configuration.
    • Introduced a new test case in rpc_storage_handler_test.go to verify
      the behavior when the NodeIsSegmented flag is set to true.

    Changes walkthrough

    Relevant files
    Enhancement
    rpc.go
    Add NodeIsSegmented Field to NodeData Struct                         

    apidef/rpc.go

    • Added NodeIsSegmented boolean field to NodeData struct.
    +9/-8     
    rpc_storage_handler.go
    Populate NodeIsSegmented in buildNodeInfo Function             

    gateway/rpc_storage_handler.go

  • Populated NodeIsSegmented in buildNodeInfo function from
    configuration.
  • +8/-7     
    Tests
    rpc_storage_handler_test.go
    Test Case for NodeIsSegmented Flag                                             

    gateway/rpc_storage_handler_test.go

    • Added test case for NodeIsSegmented flag being true.
    +26/-0   

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools
    and their descriptions
    Triggered by: push (@mativm02)
    Execution page

    @buger

    buger commented Mar 4, 2024

    Copy link
    Copy Markdown
    Member

    API tests result - mongo44-sha256 env: success
    Branch used: refs/heads/master
    Commit: 3799d4f TT-11377 Adding “node_is_segmented” flag under “node” to complement “tags” (#6093)

    Description

    Adding node_is_segmented flag under node to complement tags.

    MDCB PR: https://github.com/TykTechnologies/tyk-sink/pull/496

    Related Issue

    https://tyktech.atlassian.net/browse/TT-11377?atlOrigin=eyJpIjoiNmNiY2VjZjM3NGZlNDBiZjgwNmNlOTMyOWRjYzIwN2EiLCJwIjoiaiJ9

    Motivation and Context

    https://tyktech.atlassian.net/browse/TT-11377?atlOrigin=eyJpIjoiNmNiY2VjZjM3NGZlNDBiZjgwNmNlOTMyOWRjYzIwN2EiLCJwIjoiaiJ9

    How This Has Been Tested

    Unit tests

    Screenshots (if appropriate)

    Types of changes

    • Bug fix (non-breaking change which fixes an issue)
    • New feature (non-breaking change which adds functionality)
    • Breaking change (fix or feature that would cause existing
      functionality to change)
    • Refactoring or add test (improvements in base code or adds test
      coverage to functionality)

    Checklist

    • I ensured that the documentation is up to date
    • I explained why this PR updates go.mod in detail with reasoning
      why it's required
    • I would like a code coverage CI quality gate exception and have
      explained why

    Type

    enhancement, tests


    Description

    • Added a new boolean field NodeIsSegmented to the NodeData struct
      to indicate if a node is segmented.
    • Updated buildNodeInfo in rpc_storage_handler.go to populate the
      NodeIsSegmented field from the configuration.
    • Introduced a new test case in rpc_storage_handler_test.go to verify
      the behavior when the NodeIsSegmented flag is set to true.

    Changes walkthrough

    Relevant files
    Enhancement
    rpc.go
    Add NodeIsSegmented Field to NodeData Struct                         

    apidef/rpc.go

    • Added NodeIsSegmented boolean field to NodeData struct.
    +9/-8     
    rpc_storage_handler.go
    Populate NodeIsSegmented in buildNodeInfo Function             

    gateway/rpc_storage_handler.go

  • Populated NodeIsSegmented in buildNodeInfo function from
    configuration.
  • +8/-7     
    Tests
    rpc_storage_handler_test.go
    Test Case for NodeIsSegmented Flag                                             

    gateway/rpc_storage_handler_test.go

    • Added test case for NodeIsSegmented flag being true.
    +26/-0   

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools
    and their descriptions
    Triggered by: push (@mativm02)
    Execution page

    @mativm02
    mativm02 merged commit 3799d4f into master Mar 5, 2024
    @mativm02
    mativm02 deleted the TT-11377 branch March 5, 2024 12:01
    @buger

    buger commented Mar 5, 2024

    Copy link
    Copy Markdown
    Member

    API tests result - postgres15-murmur64 env: success
    Branch used: refs/heads/master
    Commit: 3799d4f TT-11377 Adding “node_is_segmented” flag under “node” to complement “tags” (#6093)

    Description

    Adding node_is_segmented flag under node to complement tags.

    MDCB PR: https://github.com/TykTechnologies/tyk-sink/pull/496

    Related Issue

    https://tyktech.atlassian.net/browse/TT-11377?atlOrigin=eyJpIjoiNmNiY2VjZjM3NGZlNDBiZjgwNmNlOTMyOWRjYzIwN2EiLCJwIjoiaiJ9

    Motivation and Context

    https://tyktech.atlassian.net/browse/TT-11377?atlOrigin=eyJpIjoiNmNiY2VjZjM3NGZlNDBiZjgwNmNlOTMyOWRjYzIwN2EiLCJwIjoiaiJ9

    How This Has Been Tested

    Unit tests

    Screenshots (if appropriate)

    Types of changes

    • Bug fix (non-breaking change which fixes an issue)
    • New feature (non-breaking change which adds functionality)
    • Breaking change (fix or feature that would cause existing
      functionality to change)
    • Refactoring or add test (improvements in base code or adds test
      coverage to functionality)

    Checklist

    • I ensured that the documentation is up to date
    • I explained why this PR updates go.mod in detail with reasoning
      why it's required
    • I would like a code coverage CI quality gate exception and have
      explained why

    Type

    enhancement, tests


    Description

    • Added a new boolean field NodeIsSegmented to the NodeData struct
      to indicate if a node is segmented.
    • Updated buildNodeInfo in rpc_storage_handler.go to populate the
      NodeIsSegmented field from the configuration.
    • Introduced a new test case in rpc_storage_handler_test.go to verify
      the behavior when the NodeIsSegmented flag is set to true.

    Changes walkthrough

    Relevant files
    Enhancement
    rpc.go
    Add NodeIsSegmented Field to NodeData Struct                         

    apidef/rpc.go

    • Added NodeIsSegmented boolean field to NodeData struct.
    +9/-8     
    rpc_storage_handler.go
    Populate NodeIsSegmented in buildNodeInfo Function             

    gateway/rpc_storage_handler.go

  • Populated NodeIsSegmented in buildNodeInfo function from
    configuration.
  • +8/-7     
    Tests
    rpc_storage_handler_test.go
    Test Case for NodeIsSegmented Flag                                             

    gateway/rpc_storage_handler_test.go

    • Added test case for NodeIsSegmented flag being true.
    +26/-0   

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools
    and their descriptions
    Triggered by: push (@mativm02)
    Execution page

    @buger

    buger commented Mar 5, 2024

    Copy link
    Copy Markdown
    Member

    API tests result - mongo44-murmur64 env: success
    Branch used: refs/heads/master
    Commit: 3799d4f TT-11377 Adding “node_is_segmented” flag under “node” to complement “tags” (#6093)

    Description

    Adding node_is_segmented flag under node to complement tags.

    MDCB PR: https://github.com/TykTechnologies/tyk-sink/pull/496

    Related Issue

    https://tyktech.atlassian.net/browse/TT-11377?atlOrigin=eyJpIjoiNmNiY2VjZjM3NGZlNDBiZjgwNmNlOTMyOWRjYzIwN2EiLCJwIjoiaiJ9

    Motivation and Context

    https://tyktech.atlassian.net/browse/TT-11377?atlOrigin=eyJpIjoiNmNiY2VjZjM3NGZlNDBiZjgwNmNlOTMyOWRjYzIwN2EiLCJwIjoiaiJ9

    How This Has Been Tested

    Unit tests

    Screenshots (if appropriate)

    Types of changes

    • Bug fix (non-breaking change which fixes an issue)
    • New feature (non-breaking change which adds functionality)
    • Breaking change (fix or feature that would cause existing
      functionality to change)
    • Refactoring or add test (improvements in base code or adds test
      coverage to functionality)

    Checklist

    • I ensured that the documentation is up to date
    • I explained why this PR updates go.mod in detail with reasoning
      why it's required
    • I would like a code coverage CI quality gate exception and have
      explained why

    Type

    enhancement, tests


    Description

    • Added a new boolean field NodeIsSegmented to the NodeData struct
      to indicate if a node is segmented.
    • Updated buildNodeInfo in rpc_storage_handler.go to populate the
      NodeIsSegmented field from the configuration.
    • Introduced a new test case in rpc_storage_handler_test.go to verify
      the behavior when the NodeIsSegmented flag is set to true.

    Changes walkthrough

    Relevant files
    Enhancement
    rpc.go
    Add NodeIsSegmented Field to NodeData Struct                         

    apidef/rpc.go

    • Added NodeIsSegmented boolean field to NodeData struct.
    +9/-8     
    rpc_storage_handler.go
    Populate NodeIsSegmented in buildNodeInfo Function             

    gateway/rpc_storage_handler.go

  • Populated NodeIsSegmented in buildNodeInfo function from
    configuration.
  • +8/-7     
    Tests
    rpc_storage_handler_test.go
    Test Case for NodeIsSegmented Flag                                             

    gateway/rpc_storage_handler_test.go

    • Added test case for NodeIsSegmented flag being true.
    +26/-0   

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools
    and their descriptions
    Triggered by: push (@mativm02)
    Execution page

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    3 participants