Query String Support?

[DigitalDrifta]

Hi @tylerl0706 and @Tiberriver256

Firstly thanks for the great work done thus far! I really appreciate it and I'm loving Polaris!

I'm trying to find a way to get Polaris to accept a key-value paid in the form of a query string.
I tried ?environment=dev in bold but the URL parser seems to chop off everything from the ? onwards.

New-PolarisGetRoute -Path "/api/v1/workspace?environment=dev" -ScriptBlock {

This is the server response:

PS C:\WINDOWS\system32>
request came in: GET /api/v1/workspace?environment=dev

Parsed Route: /api/v1/workspace

Request Method: GET

This is the client response:

Windows PowerShell
Copyright (C) Microsoft Corporation. All rights reserved.

PS C:\WINDOWS\system32> Invoke-RestMethod http://localhost/api/v1/workspace?environment=dev
Invoke-RestMethod : Not found
At line:1 char:1
+ Invoke-RestMethod http://localhost/api/v1/workspace?environment=dev
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-RestMethod], WebExc
   eption
    + FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeRestMethodCommand

Any ideas? I really need to get the query sting working.

Thanks!

[sgnewman]

Think you’re doing it wrong. It should be: New-PolarisGetRoute -Path "/api/v1/workspace" -ScriptBlock { $environment = $Request.Query[‘Environment’] If($environment -eq ‘dev’){ ….what have you... }

[Tiberriver256]

@sgnewman is correct. I apologize for the lack of good examples in the documentation but here is an example of how it should work from our test cases.

Setting up the route

# Hello World passing in the Path, Method & Scriptblock
New-PolarisRoute -Path /hellome -Method GET -Scriptblock {
    if ($Request.Query['name']) {
        $Response.Send('Hello ' + $Request.Query['name'])
    }
    else {
        $Response.Send('Hello World')
    }
}

Using the route from PowerShell

$Result = Invoke-WebRequest -Uri "http://localhost:$Port/hellome?name=PowerShell" -UseBasicParsing
 $Result.Content | Should Be 'Hello PowerShell'

Does this solve your question?

[TylerLeonhardt]

@Tiberriver256 I feel like we should just have docs in a docs folder rather than using the wiki tab.

[Tiberriver256]

@tylerl0706 - I forgot about the wiki! I'm not against continuing to use that, I'm sure a lot of people are familiar with it, but possibly adding our information about the classes to an about_polaris help topic would benefit more PowerShell people. Should we open a new issue to discuss?

@DigitalDrifta - Here's what you're looking for in the docs: https://github.com/PowerShell/Polaris/wiki/$request.Query

[DigitalDrifta]

Thanks guys, this works as expected! Fantastic.

2 issues I did pick up though:

1. All the wiki entries reference the old cmdlets (guessing) New-WebRoute instead of New-PolarisRoute. Not sure if this has been done on purpose or just has not been updated?

2. Invoke-RestMethod returns a valid result even if the URL doesn't equal the -Path.
   For example If you use the code on https://github.com/PowerShell/Polaris/wiki/$request.Query then run the following command, you still get a valid result:
   PS> Invoke-RestMethod -Uri http://localhost:8082/hellome_THIS_SHOULD_NOT_WORK_SHOULD_IT?name=PowerShell
   or
   PS> Invoke-RestMethod -Uri http://localhost:8082/hellomeeeeeeeeeeeeeeeeeeeeeee?name=PowerShell
   or
   PS> Invoke-RestMethod -Uri http://localhost:8082/hellomexxxxxxxxxxx?name=PowerShell
   Is this expected behavior or a bug?

Thanks for the help!

EDIT:

This appears to be a bug. In Polaris\lib\Polaris.Class.ps1 on line 60:
$MatchingRoute = $Routes.keys.Where( { $Route -match $_ })[0]
This should be using -eq instead of -match
$MatchingRoute = $Routes.keys.Where( { $Route -eq $_ })[0]
As with -match "hellomeeeeeeeeeeeeeeeeeeeeeee" matches "hellome".

Cheers!

[TylerLeonhardt]

1. The wiki is horribly out of date - that's my bad. I'll do an overhaul of those soon (traveling at the moment 🙂)

2. If you wanted to submit a PR to fix that, that would be awesome! Seems pretty straightforward 😀 otherwise, we'll get to in soon.

[Tiberriver256]

Did we solve this one for you @DigitalDrifta? At least the original question on query strings anway?

@tylerl0706 has also provided some updated documentation in #122. They are now in the /docs folder for your reference.

[DigitalDrifta]

Yeah thanks @Tiberriver256 , my issue has been resolved 👍 For now I'll wait leave my change in place until the agreed upon solution is implemented.

With regards to the wiki, why not open it up for editing so anyone can update and add examples, obviously you guys would have the final approve/decline. It would just remove the sole responsibility on you two to maintain.

Sorry for all the hassle, feel like I've kicked a hornet's nest 😆

[Tiberriver256]

No hornets nest. Just people who care about making Polaris awesome, which is a good thing.

Let us know if you find anything else!

[TylerLeonhardt]

I think we need to document the Polaris request and Response classes. I wonder if Platyps can understand classes 🤔