Client-side filtering #393

brywang-msft · 2018-01-17T18:20:48Z

Fixes:

Quick fix for when psmeta file doesn't contain optional properties

Features:

Client-side filtering support. Azure/AzureStack will automatically add client-side filtering for the "Name" property of the object when *_Get and *_List cmdlets are combined. In general usage, this feature is not recommended. Multiple filters are AND'd together.
run-tests.ps1 has -Tag support

Example of filtering:

# Get all batch accounts
$accounts = Get-BatchAccount
$accounts.Count # 3
$accounts.Name # "test", "tom", "bob"
$accounts = Get-BatchAccount -Name test -ResourceGroupName test
$accounts.Count # 1
$accounts = Get-BatchAccount -Name t* -ResourceGroupName test
$accounts.Count #2

bmanikm · 2018-01-17T21:36:25Z

docs/extensions/readme.md

+    "clientSideParameterSet": "BatchAccount_Get",
+    "filters": ...
+}


Currently, I see only one element is allowed.
Should we support an array of x-ps-client-side-filter in x-ps-cmdlet-info Object for providing this wild card support for other clientSideParameterSet parameter sets?

bmanikm · 2018-01-17T21:50:06Z

docs/extensions/readme.md

+Field Name | Type | Description
+---|:---:|---
+type | `string` | Type of filter. Supported: 'wildcard', 'logicalOperation'


logicalOperation [](start = 58, length = 16)

What is the purpose of logicalOperation type?

bmanikm · 2018-01-17T22:40:14Z

PSSwagger/Paths.psm1

+                                    if (-not $clientSideParameterSet) {
+                                        # Warning: Missing client-side parameter
+                                        Write-Warning "Required server-side parameter '$($parameterDetailEntry.Value.Name)' is not required by the client-side, which will cause issues in client-side filtering. Can't include client-side filtering."
+                                        $valid = $false


$valid [](start = 40, length = 6)

Is this required?

bmanikm · 2018-01-17T22:46:14Z

PSSwagger/Test-FilteredResult.ps1

+
+    $regex = $Filter.Value.Replace($Filter.Character, ".*")
+    ($Result.($Filter.Property)) -match $regex
+}


Please consider using System.Management.Automation.WildcardPattern.

For example:
$inputNameWithOptionalWildcard = "Module*"
$resultName = "ModuleName"

$wildcardOptions = [System.Management.Automation.WildcardOptions]::CultureInvariant -bor [System.Management.Automation.WildcardOptions]::IgnoreCase
$wildcardPattern = New-Object System.Management.Automation.WildcardPattern $inputNameWithOptionalWildcard,$wildcardOptions
$wildcardPattern.IsMatch($resultName)

Agreed to change default to '%' but option to change needs to stay (for cases where '%' is valid in the parameter string).

brywang-msft · 2018-01-18T00:34:39Z

Also move strings to Resources.psd1

Fixed: 4d0c04f

bmanikm · 2018-01-18T00:37:47Z

PSSwagger/PSSwagger.psm1

+                                    foreach ($parameterDetailEntry in $parametersDetail.GetEnumerator()) {
+                                        $getParameters += $parameterDetailEntry.Value
+                                        if ($parameterDetailEntry.Value.ContainsKey('Alias')) {
+                                            if ($parameterDetailEntry.Value.Alias -eq 'Name') {


Actual parameter name of a resource can be Name itself. In that case, wildcard functionality is not enabled, right?

bmanikm

brywang-msft · 2018-01-23T23:54:26Z

Add 'powershellWildcard' filter

brywang-msft · 2018-01-24T00:01:27Z

Add option for Azure not to automatically generate filter

automatic client-side filtering

brywang-msft added 9 commits January 16, 2018 13:45

Remove filter for TestSuite (Tag) since it doesn't make sense

68b0304

Add check for optional properties

12d31d2

Actually, separate -TestSuite and -Tag

fc4e7af

Add client-side filter tests

a48aeb9

Quick change to ClientSideFilter test, add missing test data

70fcc73

Add multi-filter test, changing metadata schema

4262f06

Add client-side filtering

9e435da

Add missing .psmeta.json file

a53cfa0

Client-side filter docs

22703b0

brywang-msft requested a review from bmanikm January 17, 2018 18:20

Add missing files

9d2d085

bmanikm reviewed Jan 17, 2018

View reviewed changes

bmanikm reviewed Jan 18, 2018

View reviewed changes

brywang-msft added 7 commits January 17, 2018 17:00

Change logicalOperation to equalityOperator, add docs

80f233f

Use array of clientSideFilter

f82a3f7

Fix issue where invalid filter would generate filter code

57751ba

Use % as default wildcard char

70eadcb

Handle regex-specific characters

e36fb69

Resource strings + fix

4d0c04f

Support -Name parameter filtering for Azure specs

68afddd

bmanikm previously approved these changes Jan 23, 2018

View reviewed changes

Add 'powershellWildcard' filter for Azure, add option to disable

1d19131

automatic client-side filtering

brywang-msft dismissed bmanikm’s stale review via 1d19131 January 24, 2018 01:33

bmanikm approved these changes Jan 24, 2018

View reviewed changes

brywang-msft merged commit 21671ec into PowerShell:developer Jan 24, 2018

brywang-msft deleted the 1-16-2018 branch January 24, 2018 21:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Client-side filtering #393

Client-side filtering #393

brywang-msft commented Jan 17, 2018

bmanikm Jan 17, 2018

brywang-msft Jan 18, 2018

bmanikm Jan 17, 2018

brywang-msft Jan 18, 2018

bmanikm Jan 17, 2018

brywang-msft Jan 18, 2018

bmanikm Jan 17, 2018

brywang-msft Jan 18, 2018

brywang-msft Jan 18, 2018

brywang-msft commented Jan 18, 2018 •

edited

bmanikm Jan 18, 2018

brywang-msft Jan 18, 2018

bmanikm left a comment

brywang-msft commented Jan 23, 2018

brywang-msft commented Jan 24, 2018

Client-side filtering #393

Client-side filtering #393

Conversation

brywang-msft commented Jan 17, 2018

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

brywang-msft commented Jan 18, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bmanikm left a comment

Choose a reason for hiding this comment

brywang-msft commented Jan 23, 2018

brywang-msft commented Jan 24, 2018

brywang-msft commented Jan 18, 2018 •

edited