WIP: JSON adapter RFC #341

JamesWTruher · 2023-01-12T17:59:10Z

A proposal for automatically calling a function/script/command to convert text output to PowerShell objects.

StevenBucher98 · 2023-01-12T19:54:22Z

RFCXXX-Native-Json-Adapters.md

+drwxr-xr-x  10 james  staff  320 Dec  6 12:05 .
+```
+
+Can or should something like this be done for PowerShell?


An environmental variable is probably the easiest? If the main way to "opt-in" to this experience is to get these adapters then I think having a variable to opt out without getting rid of all the adapters is good too.

Another, rather redundant, option would be provide a PS cmdlet so folks could pipe adapted commands to, to unadapt them? i.e docker image ls | Out-Text or something like that.

add how to handle singular disablement into alternate considerations

StevenBucher98 · 2023-01-12T19:56:56Z

RFCXXX-Native-Json-Adapters.md

+### History
+
+It's not clear whether history should be altered to show the added pipeline elements. We don't currently do that for `out-default` which can also add to the pipeline.
+It should be relatively easy to determine whether the pipeline as the `app-json`, as `get-command app` will include the name of the json adapter.


I'm of the opinion we just save what is typed by the user and not added pipeline elements to avoid confusion. This could be another case for adding additional fields to history objects so show what is added to the pipeline.

I agree with Steven....From my perspective, I want to see what I typed in my history -- all the additional would confuse me as I did not type that. Should we have a way to show the underlying?

iSazonov · 2023-01-13T04:43:30Z

RFCXXX-Native-Json-Adapters.md

+
+Can or should something like this be done for PowerShell?
+
+## Alternatives


There is 2.5 year old proposal which cover all scenarios from the RFC and even more
PowerShell/PowerShell#13428
And as it was said there, it's great in combination with https://github.com/dotnet/command-line-api

SteveL-MSFT · 2023-03-08T22:08:44Z

RFCXXX-Native-Json-Adapters.md

+PS> MyCustomApp.exe -p1 MyString -p2 42 -p3 resource=blue
+```
+
+_and_ if `MyCustomApp-json` is available as a conversion too for `MyCustomApp.exe`,


Suggested change

_and_ if `MyCustomApp-json` is available as a conversion too for `MyCustomApp.exe`,

_and_ if `MyCustomApp-json` is available as a conversion tool for `MyCustomApp.exe`,

SteveL-MSFT · 2023-03-08T22:10:43Z

RFCXXX-Native-Json-Adapters.md

+we could automatically construct the following:
+
+```powershell
+PS> MyCustomApp.exe -p1 MyString -p2 42 -p3 resource=blue | MyCustomApp-json -ParameterBlock @{ p1 = "MyString"; p2 = 42; p3 = "resource=blue" } | ConvertFrom-Json


Is there a case where the JSON adapter needs ConvrtFrom-Json -AsHashTable as in the case of an empty key or keys that differ only in casing

SteveL-MSFT · 2023-03-08T22:13:36Z

RFCXXX-Native-Json-Adapters.md

+converter to automatically construct objects from tabular data could be called.
+This would enable the user to set it once and later sessions would be able to use it.
+
+#### PSDefaultNativeParameterValues


It's not clear to me if this section is actually proposing work to be done or just calling out a potential feature and problems with it. It seems like it's the latter which I would then recommend moving to Alternate Considerations which implies it's not in scope

SteveL-MSFT · 2023-03-08T22:14:22Z

RFCXXX-Native-Json-Adapters.md

+
+A number of follow-on activities should be considered to bring continued improvement of the native command experience.
+
+#### Improved TabCompletion


This seems orthogonal to json adapter?

StevenBucher98 · 2023-03-08T22:15:21Z

RFCXXX-Native-Json-Adapters.md

+
+There are two aspects of making this work well:
+
+- Automatically adding `ConvertFrom-Json` to the pipeline following the native command to automatically convert `Json` to object


How are we going to to know we need to automatically add the ConvertFrom-Json to the pipeline or not? Cause we dont need an adapter for example on line 37 to work

Think may have answered on line 80 but does that mean still requiring a basic adapter to only call ConvertFrom-Json to know if it is used or not

Maybe clarify here its always the adapter and not ConvertFrom-JSON being put at the end

SteveL-MSFT · 2023-03-08T22:15:37Z

RFCXXX-Native-Json-Adapters.md

+We already will tab-complete for file system items,
+a small effort should be able to increase our coverage for other native executables.
+
+#### Improved Formatting Tooling


For formatting, do TypeNames get automatically added to the resulting object? Maybe something like: <CommandName>.JsonAdapted so formatting can be built for it?

SteveL-MSFT · 2023-03-08T22:16:57Z

RFCXXX-Native-Json-Adapters.md

+
+### Adaptation of Native Apps by Fully Qualified Path
+
+Should the automatic json adaptation be suppressed when a fully qualified path (`/bin/ls` vs `ls`) is provided?


For now, whether full path or not should not affect insertion of json adapter if one is found

SteveL-MSFT · 2023-03-08T22:20:20Z

RFCXXX-Native-Json-Adapters.md

+drwxr-xr-x  10 james  staff  320 Dec  6 12:05 .
+```
+
+Can or should something like this be done for PowerShell?


PowerShell/PowerShell#3316 proposes new syntax for specifying env var, however, I would prefer just enhancing Start-Process. But what would this env var be if we chose this approach?

dcaro · 2023-03-08T22:20:57Z

RFCXXX-Native-Json-Adapters.md

+With stand-alone native applications, it means that providing for reasonable formatting will require an additional file.
+A more dynamic approach for formatting would improve the experience for the user.
+
+## Open Questions


How do we handle errors? For example, in the case the json is not formatted correctly?

mgreenegit · 2023-03-08T22:22:03Z

RFCXXX-Native-Json-Adapters.md

+This means that rather than just capturing the parameter name and default value, we will need to be able to run arbitrary code (ala scriptblock)
+which includes the command line AST so the proper parameter values may be created.
+
+However, with an approach which provides for this complexity, we can continue to simplify the experience for our users to from:


Suggested change

However, with an approach which provides for this complexity, we can continue to simplify the experience for our users to from:

However, with an approach which provides for this complexity, we can continue to simplify the experience for our users from:

mgreenegit · 2023-03-08T22:22:22Z

RFCXXX-Native-Json-Adapters.md

+### Parser Modification
+
+The parser does not make any disambiguation of the type of command to be executed.
+It simple identifies the token which _will_ be executed at run time.


Suggested change

It simple identifies the token which _will_ be executed at run time.

It simply identifies the token which _will_ be executed at run time.

SteveL-MSFT · 2023-03-08T22:29:09Z

RFCXXX-Native-Json-Adapters.md

+. . .
+```
+
+### Follow-on Work


Define tag for publishing modules to PSGallery that includes json adapters

Would there be anything stopping someone from making an adapter that is just a keylogger or something that steals the users data?

StevenBucher98 · 2023-03-08T22:45:10Z

RFCXXX-Native-Json-Adapters.md

+
+- Automatically adding `ConvertFrom-Json` to the pipeline following the native command to automatically convert `Json` to object
+- Automatically adding a parameter to a native command similarly to what `$PSDefaultParameterValue` does for cmdlets
+


Can we maybe do a call out somewhere in the doc to talk about the user experience being just installing a PowerShell module that contains these adapters?

Addressed a number of comments provided during first review.

create json adapter RFC

3e6cf93

StevenBucher98 reviewed Jan 12, 2023

View reviewed changes

iSazonov reviewed Jan 13, 2023

View reviewed changes

JamesWTruher changed the title ~~WIP: JSON adapter RFC~~ JSON adapter RFC Mar 1, 2023

JamesWTruher mentioned this pull request Mar 1, 2023

WIP: Provide a way to convert the output of native executables to objects PowerShell/PowerShell#19257

Closed

22 tasks

SteveL-MSFT reviewed Mar 8, 2023

View reviewed changes

StevenBucher98 reviewed Mar 8, 2023

View reviewed changes

SteveL-MSFT reviewed Mar 8, 2023

View reviewed changes

dcaro reviewed Mar 8, 2023

View reviewed changes

mgreenegit reviewed Mar 8, 2023

View reviewed changes

SteveL-MSFT reviewed Mar 8, 2023

View reviewed changes

StevenBucher98 reviewed Mar 8, 2023

View reviewed changes

JamesWTruher changed the title ~~JSON adapter RFC~~ WIP: JSON adapter RFC Mar 21, 2023

Added the approach to use feedback provider as primary.

2782940

Addressed a number of comments provided during first review.

JamesWTruher closed this Mar 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: JSON adapter RFC #341

WIP: JSON adapter RFC #341

JamesWTruher commented Jan 12, 2023

StevenBucher98 Jan 12, 2023 •

edited

JamesWTruher Mar 15, 2023

StevenBucher98 Jan 12, 2023 •

edited

theJasonHelmick Mar 8, 2023

iSazonov Jan 13, 2023

SteveL-MSFT Mar 8, 2023

SteveL-MSFT Mar 8, 2023

SteveL-MSFT Mar 8, 2023

SteveL-MSFT Mar 8, 2023

StevenBucher98 Mar 8, 2023

StevenBucher98 Mar 8, 2023

StevenBucher98 Mar 8, 2023

SteveL-MSFT Mar 8, 2023

SteveL-MSFT Mar 8, 2023

SteveL-MSFT Mar 8, 2023

dcaro Mar 8, 2023 •

edited

mgreenegit Mar 8, 2023

mgreenegit Mar 8, 2023

SteveL-MSFT Mar 8, 2023

StevenBucher98 Mar 8, 2023

StevenBucher98 Mar 8, 2023


		Can or should something like this be done for PowerShell?

		## Alternatives

	_and_ if `MyCustomApp-json` is available as a conversion too for `MyCustomApp.exe`,
	_and_ if `MyCustomApp-json` is available as a conversion tool for `MyCustomApp.exe`,


		A number of follow-on activities should be considered to bring continued improvement of the native command experience.

		#### Improved TabCompletion


		There are two aspects of making this work well:

		- Automatically adding `ConvertFrom-Json` to the pipeline following the native command to automatically convert `Json` to object


		### Adaptation of Native Apps by Fully Qualified Path

		Should the automatic json adaptation be suppressed when a fully qualified path (`/bin/ls` vs `ls`) is provided?

	However, with an approach which provides for this complexity, we can continue to simplify the experience for our users to from:
	However, with an approach which provides for this complexity, we can continue to simplify the experience for our users from:

	It simple identifies the token which _will_ be executed at run time.
	It simply identifies the token which _will_ be executed at run time.


		- Automatically adding `ConvertFrom-Json` to the pipeline following the native command to automatically convert `Json` to object
		- Automatically adding a parameter to a native command similarly to what `$PSDefaultParameterValue` does for cmdlets

WIP: JSON adapter RFC #341

WIP: JSON adapter RFC #341

Conversation

JamesWTruher commented Jan 12, 2023

StevenBucher98 Jan 12, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StevenBucher98 Jan 12, 2023 • edited

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

dcaro Mar 8, 2023 • edited

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

StevenBucher98 Jan 12, 2023 •

edited

StevenBucher98 Jan 12, 2023 •

edited

dcaro Mar 8, 2023 •

edited