WIP: Pure PowerShell Implementation #96

Tiberriver256 · 2018-03-31T00:01:25Z

I wanted to offer pulling this into the repo. I might have time to finish it up this weekend but really I think it's so close someone could accept this PR and finish it up pretty quick.

My goal was to do a straight port over to PowerShell without introducing any breaking changes. I wanted to do it by keeping all of the Pester tests the same and just coding PowerShell until I was finished. I broke my rule though and added a static file server and file browser which meant a modification of one of tests.

I'll see if I can run a Pester test tonight and get added to the comments exactly what tests are failing as work items left to be done.

Reference Enhancement Issue #81 for conversation.

Purepwsh

…ookie monster's suggested PowerShell module structure

TylerLeonhardt · 2018-03-31T00:18:11Z

Exciting! If you need help getting the CI to run the tests just let me know.

Tiberriver256 · 2018-03-31T01:13:05Z

That would be wicked. I don't know a whole lot about AppVeyor but it looks like it's asking for a Visual Studio project.

…rror

Tiberriver256 · 2018-03-31T01:37:38Z

Okay I believe I have it down to these tasks to complete:

Invoke-WebRequest commands in tests are giving an error about Internet Explorer. Suggests using -UseBasicParsing to prevent.
Some error with converting $rawRequest.QueryString to the Query property in the PolarisRequest class
The path matching when doing staticRoutes is failing on the "test /public/index.html static route" of PolarisServer.tests.ps1
Sending alternate streams when getlogsstring is enabled is not working (thought it was related to the query string issue originally)
Simplify the main class by adding async await c# class to handle threads
Figure out what needs to be done with the CI build to work and run the tests.

I think those three are it and all the tests should be passing.

TylerLeonhardt · 2018-03-31T03:12:36Z

@Tiberriver256 away from my laptop at the moment but basically add this file:
https://github.com/PowerShell/Polaris/blob/master/appveyor.yml

And instead of Invoke-Build we'll just Invoke-Pester.

Does that make sense?

TylerLeonhardt · 2018-03-31T03:27:06Z

Specifically, delete this line:
https://github.com/PowerShell/Polaris/blob/master/appveyor.yml#L27

And change this to be the right call to run Pester:
https://github.com/PowerShell/Polaris/blob/master/appveyor.yml#L33

Tiberriver256 · 2018-03-31T03:41:18Z

Makes sense. I'll give it a go.

Tiberriver256 · 2018-03-31T03:44:38Z

Looks like it's not attempting to run the build now.

This reverts commit 61f9b84.

… handling

Tiberriver256 · 2018-03-31T14:29:27Z

Alright, tests are now passing in PSCore on Windows. I'm installing the WSL Ubuntu to manually test with, if I can figure it out but if you can get the CI build to run again that might be faster.

*EDIT: Tests passed on my 16.04 Ubuntu!

TylerLeonhardt · 2018-03-31T17:25:52Z

AppVeyor seems to be a bit drunk at the moment and isn't triggering when you push.

TylerLeonhardt · 2018-03-31T17:26:19Z

Ohhhh because you're merging into pure-pwsh not master

TylerLeonhardt · 2018-03-31T17:33:56Z

The build passed!! 🎉

TylerLeonhardt · 2018-03-31T17:36:07Z

I'll actually review the code and give feedback :)

For starters, it looks like the .gitignore and README.md were deleted in this PR, can you add those?

TylerLeonhardt · 2018-03-31T17:36:49Z

You can take whatever applies from the old version

Tiberriver256 · 2018-03-31T17:56:54Z

Ah thanks. I put the examples back in as well. Did you want to change the merge to point at the master?

…and a non-existent HTTP method (405)

TylerLeonhardt

WOW. This PR is AWESOME. It's also already super close to being 100% ready to be merged.

I had a few comments on the code and my biggest feedback was some comments in the more complicated bits (which will help future contributors... contribute) and a "nice to have" of having to ability to pass in a Polaris object so that a user could have 2 instances of Polaris running in the same session.

"Nice to have" meaning, if you don't feel like doing it, no worries :) I won't block the PR from getting accepted if you don't want to.

Thank you SO much for doing this. Polaris is really looking great in pure PowerShell! 🎉

Please let me know if you have any comments about my comments. I'm here to help you get this merged in!

TylerLeonhardt · 2018-03-31T23:43:50Z

LICENSE.txt

-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining a copy 
-of this software and associated documentation files (the ""Software""), to deal 


We need this file in the repo. Can you keep this in?

Should be set now

TylerLeonhardt · 2018-03-31T23:49:04Z

Polaris.psm1

-{
-    Add-Type -Path "$PSScriptRoot/PolarisCore/bin/Debug/net451/Polaris.dll"
-}
+


nitpick: first line shouldn't be an empty line

TylerLeonhardt · 2018-03-31T23:53:08Z

Polaris.psm1

 $script:Polaris = $null

 # Handles the removal of the module
 $ExecutionContext.SessionState.Module.OnRemove =
 {
-    If ( $script:Polaris )
-    {
+    If ( $script:Polaris ) {


Both Stop-Polaris and Clear-Polaris check if $script:Polaris exists before doing anything so we don't need this check :)

TylerLeonhardt · 2018-03-31T23:55:17Z

lib/MimeTypes.cs

+
+namespace Polaris
+{
+    public static class MimeTypes


Does this file need to C#? This could be just PowerShell, right?

Yeah... I was being lazy :) It's in PowerShell now and learned an important lesson about PowerShell classes.

C# classes are available globally across runspaces. PowerShell classes are not so they have to be injected into the runspace before execution... blech.

TylerLeonhardt · 2018-04-01T00:11:29Z

Polaris.psm1

-        $ScriptBlock,
+#Get public and private function definition files.
+$Classes = @( Get-ChildItem -Path $PSScriptRoot\lib\*.ps1 -ErrorAction SilentlyContinue | where {$_.Name -ne "Polaris.Class.ps1"})
+$Classes += @( Get-ChildItem -Path $PSScriptRoot\lib\Polaris.Class.ps1 -ErrorAction SilentlyContinue )


Is this because we want to load Polaris.Class.ps1 last? If so, can you add a small comment saying that so people know?

TylerLeonhardt · 2018-04-01T07:19:50Z

Tests/PolarisServer.Tests.ps1

            $result.Content | Should Be 'test file'
            $result.StatusCode | Should Be 200
        }

        It "test /public/index.html static route" {
            $expectedHtml = `
-'<div>hello world</div>
+                '<div>hello world</div>


Is this indentation from being on the next line of $expectedHtml?

TylerLeonhardt · 2018-04-01T07:25:18Z

lib/Polaris.Class.ps1

+
+    [Int]$Port
+    [System.Collections.Generic.List[PolarisMiddleWare]]$RouteMiddleWare = [System.Collections.Generic.List[PolarisMiddleWare]]::new()
+    [System.Collections.Generic.Dictionary[string, [System.Collections.Generic.Dictionary[string, string]]]]$ScriptBlockRoutes = [System.Collections.Generic.Dictionary[string, [System.Collections.Generic.Dictionary[string, string]]]]::new()


I mentioned this in another comment but now that we're in PowerShell do the Script Blocks have to be stored as a string?

It doesn't have to be stored as strings but they eventually would need to be converted to strings in order to be passed to the AddScript method as it only accepts strings.

https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.powershell.addscript?view=powershellsdk-1.1.0

TylerLeonhardt · 2018-04-01T07:32:10Z

lib/Polaris.Class.ps1

+        $this.PowerShellPool.Open()
+        $this.Listener = $this.InitListener($port)
+
+        $syncHash = [hashtable]::Synchronized(@{})


Some comments here would be really helpful for future contributors.

Sorry I'm running short on time here but I pointed towards some blogs that explain how synchronized hashtables work.

TylerLeonhardt · 2018-04-01T07:42:09Z

lib/Polaris.Class.ps1

+                            $response.ByteResponse = $bytes
+                        }
+                        $rawResponse.StatusCode = $response.statusCode;
+                        $rawResponse.Headers = $response.Headers;


Could you use [Polaris]::Send here?

TylerLeonhardt · 2018-04-01T07:42:59Z

lib/Polaris.Class.ps1

+            $this.Logger($logString)
+        }
+        catch {
+            [Console]::WriteLine($_.Message)


Any reason for [Console]::WriteLine instead of Write-Host or something?

…idation appears to not be aware of PowerShell classes :(

Tiberriver256 · 2018-04-02T02:45:37Z

Alrighty, good stuff man! I believe I've addressed all of the requested changes here. Let me know what you think.

TylerLeonhardt · 2018-04-03T03:53:27Z

Private/New-DirectoryBrowser.ps1

+
+    <#
+    .SYNOPSIS
+        Renders a directory browser in HTML


I'm so excited to try this out :D

TylerLeonhardt · 2018-04-03T03:58:12Z

README.md

 There have been a great list of [other](https://github.com/StartAutomating/Pipeworks) [micro](https://github.com/toenuff/flancy) [web](https://github.com/Jaykul/NancyPS/) [frameworks](https://github.com/toenuff/PshOdata) [written](https://github.com/straightdave/presley) [over](https://github.com/cofonseca/WebListener) [the](https://github.com/DataBooster/PS-WebApi) [years](https://github.com/ChristopherGLewis/PowerShellWebServers) (Thanks @jaykul for the list!).

 Polaris' differentiation is that it is cross-platform and uses the .NET HttpListener class.

 ## Getting Started

 ### Prereqs
-* [.NET Standard 2.0 SDK](https://www.microsoft.com/net/download/core) or .NET Framework 4.5.1
+
 * [PowerShell](https://github.com/powershell/powershell)


TylerLeonhardt

LGTM 🎉 Thank you SO much for such an awesome PR

Chris Kuech and others added 14 commits November 19, 2017 14:32

removed use of global namepace

07f2a8e

added docs

bedd78c

pure powershell

c94758b

checkpoint

2e8bda9

stable for literal server definitions

332f2ee

stable for literal server definitions

cfa7be1

Removed non PowerShell stuffs

8c7944e

Merge conflicts

e3301d5

Merge pull request #1 from chriskuech/purepwsh

7808f21

Purepwsh

Re-imported tests

575c9f5

Rneamed test to Tests

a4b5889

Added PowerShell suggested vscode tasks.json for easy testing

5b89e4d

Split into file per function and folder structure to match rambling c…

20d66af

…ookie monster's suggested PowerShell module structure

Fixed more code

d7cb51a

Added -UseBasicParsing switch to tests to prevent Internet Explorer e…

fd1d5d8

…rror

Tiberriver256 added 3 commits March 30, 2018 21:58

Fix for query string handling

b462b24

Moved headers test after the module import

dd2c0da

Fix for GetLogsString. Bytes and backticks.

8b56171

Added appveyor to only execute Pester tests instead of using msbuild

71d07f3

typo in filename

61f9b84

Tiberriver256 added 3 commits March 31, 2018 00:11

Revert "typo in filename"

89ed40e

This reverts commit 61f9b84.

typo in filename

84a12a9

Last fix for server shutting down properly, route handling, and error…

e06fd3f

… handling

Tiberriver256 added 2 commits March 31, 2018 13:55

Added .gitignore and README.md back

463fa46

Added examples back in

d703f7d

Tiberriver256 added 2 commits March 31, 2018 15:37

Added two tests and fixed for handling routes that don't exist (404) …

7cf9fd9

…and a non-existent HTTP method (405)

Fixed a bug with relative paths in the directory browser

b3f0c0a

TylerLeonhardt suggested changes Apr 1, 2018

View reviewed changes

Micah Rairdon added 12 commits April 1, 2018 17:23

License file restored

63d0101

MimeTypes to PowerShell Classes

58caa06

Corrected odd formatting

f975268

Added other HTTP Methods

4bdb8a5

Added Polaris Parameter to all functions that made sense

f7714fc

Clarified middleware checking / removal with some comments

6db0348

Removed references to $script:Polaris outside of the param()

57ac3e1

Removed [Polaris] class specification for Polaris parameter. This val…

356feee

…idation appears to not be aware of PowerShell classes :(

Comment with hint on how the $synchash works

bcc61e2

Changed from console to write-host

94a8d0d

Modified class to use [Polaris]::Send

9fc78e5

Refactored static route code to be more readable.

18ff5ff

TylerLeonhardt reviewed Apr 3, 2018

View reviewed changes

Private/New-DirectoryBrowser.ps1

<#

.SYNOPSIS

Renders a directory browser in HTML

Copy link

Member

TylerLeonhardt Apr 3, 2018

Choose a reason for hiding this comment

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

I'm so excited to try this out :D

TylerLeonhardt reviewed Apr 3, 2018

View reviewed changes

TylerLeonhardt approved these changes Apr 3, 2018

View reviewed changes

TylerLeonhardt merged commit 15a7061 into PowerShell:pure-pwsh Apr 3, 2018

Tiberriver256 deleted the pure-pwsh branch May 5, 2018 02:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Pure PowerShell Implementation #96

WIP: Pure PowerShell Implementation #96

Tiberriver256 commented Mar 31, 2018 •

edited

Loading

TylerLeonhardt commented Mar 31, 2018

Tiberriver256 commented Mar 31, 2018

Tiberriver256 commented Mar 31, 2018 •

edited

Loading

TylerLeonhardt commented Mar 31, 2018

TylerLeonhardt commented Mar 31, 2018

Tiberriver256 commented Mar 31, 2018

Tiberriver256 commented Mar 31, 2018

Tiberriver256 commented Mar 31, 2018 •

edited

Loading

TylerLeonhardt commented Mar 31, 2018

TylerLeonhardt commented Mar 31, 2018

TylerLeonhardt commented Mar 31, 2018

TylerLeonhardt commented Mar 31, 2018

TylerLeonhardt commented Mar 31, 2018

Tiberriver256 commented Mar 31, 2018

TylerLeonhardt left a comment

TylerLeonhardt Mar 31, 2018

Tiberriver256 Apr 1, 2018

TylerLeonhardt Mar 31, 2018

TylerLeonhardt Mar 31, 2018

TylerLeonhardt Mar 31, 2018

Tiberriver256 Apr 1, 2018

TylerLeonhardt Apr 1, 2018

TylerLeonhardt Apr 1, 2018

TylerLeonhardt Apr 1, 2018

Tiberriver256 Apr 2, 2018

TylerLeonhardt Apr 1, 2018

Tiberriver256 Apr 2, 2018

TylerLeonhardt Apr 1, 2018

TylerLeonhardt Apr 1, 2018

Tiberriver256 commented Apr 2, 2018

TylerLeonhardt Apr 3, 2018

TylerLeonhardt Apr 3, 2018

TylerLeonhardt left a comment

WIP: Pure PowerShell Implementation #96

WIP: Pure PowerShell Implementation #96

Conversation

Tiberriver256 commented Mar 31, 2018 • edited Loading

TylerLeonhardt commented Mar 31, 2018

Tiberriver256 commented Mar 31, 2018

Tiberriver256 commented Mar 31, 2018 • edited Loading

TylerLeonhardt commented Mar 31, 2018

TylerLeonhardt commented Mar 31, 2018

Tiberriver256 commented Mar 31, 2018

Tiberriver256 commented Mar 31, 2018

Tiberriver256 commented Mar 31, 2018 • edited Loading

TylerLeonhardt commented Mar 31, 2018

TylerLeonhardt commented Mar 31, 2018

TylerLeonhardt commented Mar 31, 2018

TylerLeonhardt commented Mar 31, 2018

TylerLeonhardt commented Mar 31, 2018

Tiberriver256 commented Mar 31, 2018

TylerLeonhardt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tiberriver256 commented Apr 2, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TylerLeonhardt left a comment

Choose a reason for hiding this comment

Tiberriver256 commented Mar 31, 2018 •

edited

Loading

Tiberriver256 commented Mar 31, 2018 •

edited

Loading

Tiberriver256 commented Mar 31, 2018 •

edited

Loading