Skip to content

Invoke-RestMethod -FollowRelLink fix links containing commas - #18829

Merged
Ilya (iSazonov) merged 4 commits into
PowerShell:masterfrom
CarloToso:Invoke-RestMethod--FollowRelLink-add-suggested-fix
Jan 11, 2023
Merged

Ilya (iSazonov) merged 4 commits into
PowerShell:masterfrom
CarloToso:Invoke-RestMethod--FollowRelLink-add-suggested-fix

Conversation

@CarloToso

Copy link
Copy Markdown
Contributor

PR Summary

PR Context

Add the fix proposed by Ash (@ashscodes) in #17528

@iSazonov Ilya (iSazonov) added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Dec 20, 2022
@ghost ghost added the Review - Needed The PR is being reviewed label Dec 28, 2022
@ghost

Copy link
Copy Markdown

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@SteveL-MSFT Steve Lee (SteveL-MSFT) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is it possible to add a test?

@iSazonov

Copy link
Copy Markdown
Collaborator

Is it possible to add a test?

I guess we can add new constant in Constants.cs and use it in new branch in LinkController.cs.

@ghost ghost removed the Review - Needed The PR is being reviewed label Jan 10, 2023
@CarloToso

CarloToso commented Jan 10, 2023 •

Copy link
Copy Markdown
Contributor Author

Would this test be ok ?

    It "Validate Invoke-RestMethod -FollowRelLink correctly manages commas" {
        $maxLinks = 5
        $uri = Get-WebListenerUrl -Test 'Link' -Query @{maxlinks = $maxLinks; type = "with,comma"}
        $command = "Invoke-RestMethod -Uri '$uri' -FollowRelLink"
        $result = ExecuteWebCommand -command $command

        $result.Output.Count | Should -BeExactly $maxLinks
        1..$maxLinks | ForEach-Object { $result.Output[$_ - 1].linknumber | Should -BeExactly $_ }
    }

@iSazonov

Copy link
Copy Markdown
Collaborator

If this doesn't work before the PR, I am ok with the test.

@CarloToso

Copy link
Copy Markdown
Contributor Author

If this doesn't work before the PR, I am ok with the test.

I checked, the test fails before this PR

@pull-request-quantifier-deprecated

Copy link
Copy Markdown

This PR has 11 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Small
Size       : +9 -2
Percentile : 4.4%

Total files changed: 2

Change summary by file extension:
.cs : +2 -2
.ps1 : +7 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@iSazonov
Ilya (iSazonov) merged commit 465165f into PowerShell:master Jan 11, 2023
@CarloToso
CarloToso deleted the Invoke-RestMethod--FollowRelLink-add-suggested-fix branch January 11, 2023 16:41
@ghost

Copy link
Copy Markdown

🎉v7.4.0-preview.2 has been released which incorporates this pull request.:tada:

Handy links:

Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants