starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-04 05:35:20 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Order of environment variables different in WT #12667

New Issue
Closed
opened 2026-01-31 03:21:35 +00:00 by claunia · 12 comments
claunia commented 2026-01-31 03:21:35 +00:00
Owner
Copy Link

Originally created by @vefatica on GitHub (Feb 20, 2021).

Environment

Microsoft Windows 10 Pro for Workstations
10.0.19042.804 (2009, 20H2)
Windows Terminal Preview
Version: 1.6.10412.0

Windows build number: [run `[Environment]::OSVersion` for powershell, or `ver` for cmd]
Windows Terminal version (if applicable):

Any other software?

Steps to reproduce

See below.

Expected behavior

Same behavior whether in WT or not

Actual behavior

Behavior different and undesirable when in WT.

In my three Windows shells (CMD, Powershell, TCC), when running in WT

  1. the environment block is ordered differently, and
  2. new environment variables seem to go in the wrong place

Here's a new CMD.EXE running in a Windows console; this is expected behavior.

image

And here's a new CMD.EXE running in Windows Terminal. Note that the variables __VIP (from the user environment) and WT (newly created) are out of place.

image

Originally created by @vefatica on GitHub (Feb 20, 2021). <!-- 🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨 I ACKNOWLEDGE THE FOLLOWING BEFORE PROCEEDING: 1. If I delete this entire template and go my own path, the core team may close my issue without further explanation or engagement. 2. If I list multiple bugs/concerns in this one issue, the core team may close my issue without further explanation or engagement. 3. If I write an issue that has many duplicates, the core team may close my issue without further explanation or engagement (and without necessarily spending time to find the exact duplicate ID number). 4. If I leave the title incomplete when filing the issue, the core team may close my issue without further explanation or engagement. 5. If I file something completely blank in the body, the core team may close my issue without further explanation or engagement. All good? Then proceed! --> <!-- This bug tracker is monitored by Windows Terminal development team and other technical folks. **Important: When reporting BSODs or security issues, DO NOT attach memory dumps, logs, or traces to Github issues**. Instead, send dumps/traces to secure@microsoft.com, referencing this GitHub issue. If this is an application crash, please also provide a Feedback Hub submission link so we can find your diagnostic data on the backend. Use the category "Apps > Windows Terminal (Preview)" and choose "Share My Feedback" after submission to get the link. Please use this form and describe your issue, concisely but precisely, with as much detail as possible. --> # Environment Microsoft Windows 10 Pro for Workstations 10.0.19042.804 (2009, 20H2) Windows Terminal Preview Version: 1.6.10412.0 ```none Windows build number: [run `[Environment]::OSVersion` for powershell, or `ver` for cmd] Windows Terminal version (if applicable): Any other software? ``` # Steps to reproduce <!-- A description of how to trigger this bug. --> See below. # Expected behavior Same behavior whether in WT or not <!-- A description of what you're expecting, possibly containing screenshots or reference material. --> # Actual behavior Behavior different and undesirable when in WT. <!-- What's actually happening? --> In my three Windows shells (CMD, Powershell, TCC), when running in WT 1. the environment block is ordered differently, and 2. new environment variables seem to go in the wrong place Here's a new CMD.EXE running in a Windows console; this is expected behavior. ![image](https://user-images.githubusercontent.com/61856645/108604119-d2372b00-7379-11eb-8afc-8be4a6879d12.png) And here's a new CMD.EXE running in Windows Terminal. Note that the variables __VIP (from the user environment) and WT (newly created) are out of place. ![image](https://user-images.githubusercontent.com/61856645/108604182-335efe80-737a-11eb-9055-ad68560f7ee4.png)
claunia commented 2026-01-31 03:21:37 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Feb 20, 2021):

I do not believe that the order of environment variables is a contract anybody needs to uphold. WT requests that the system generate a new environment block for every new subprocess, so this is the order returned by the system.

@DHowett commented on GitHub (Feb 20, 2021): I do not believe that the order of environment variables is a contract anybody needs to uphold. WT requests that the system generate a new environment block for every new subprocess, so this is the order returned by the system.
claunia commented 2026-01-31 03:21:37 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Feb 20, 2021):

I'm marking this "Won't Fix". If you can provide a reason why this matters to any software, I'll be happy to reopen it 😄

@DHowett commented on GitHub (Feb 20, 2021): I'm marking this "Won't Fix". If you can provide a reason why this _matters_ to any software, I'll be happy to reopen it :smile:
claunia commented 2026-01-31 03:21:38 +00:00
Author
Owner
Copy Link

@eryksun commented on GitHub (Feb 20, 2021):

See Changing Environment Variables:

All strings in the environment block must be sorted alphabetically by name. The sort is case-insensitive, Unicode order, without regard to locale. Because the equal sign is a separator, it must not be used in the name of an environment variable.

One aspect left unstated by the above quote is that the case-insensitive comparison converts to uppercase. For example, 'A' (ordinal 65) and 'a' (ordinal 97) should sort before '_' (ordinal 95).

An incorrect order may cause GetEnvironmentVariableW and SetEnvironmentVariableW to misbehave, if they assume a particular sorted order when searching for and inserting variables. Hopefully they're more robust than that nowadays.

Windows Terminal calls _wcsicmp, which is locale based (limited to ASCII A-Z in the "C" locale) and converts to lowercase. The expected sort order is possible using CompareStringOrdinal.

@eryksun commented on GitHub (Feb 20, 2021): See [Changing Environment Variables](https://docs.microsoft.com/en-us/windows/win32/procthread/changing-environment-variables): > All strings in the environment block must be sorted alphabetically by name. The sort is case-insensitive, Unicode order, without regard to locale. Because the equal sign is a separator, it must not be used in the name of an environment variable. One aspect left unstated by the above quote is that the case-insensitive comparison converts to uppercase. For example, `'A'` (ordinal 65) and `'a'` (ordinal 97) should sort before `'_'` (ordinal 95). An incorrect order may cause `GetEnvironmentVariableW` and `SetEnvironmentVariableW` to misbehave, if they assume a particular sorted order when searching for and inserting variables. Hopefully they're more robust than that nowadays. Windows Terminal [calls](https://github.com/microsoft/terminal/blob/ae550e0969595f062b15c2ff5cc33d4afe8ebc3f/src/types/inc/Environment.hpp) `_wcsicmp`, which is locale based (limited to ASCII A-Z in the "C" locale) and converts to lowercase. The expected sort order is possible using [`CompareStringOrdinal`](https://docs.microsoft.com/en-us/windows/win32/api/stringapiset/nf-stringapiset-comparestringordinal).
claunia commented 2026-01-31 03:21:38 +00:00
Author
Owner
Copy Link

@eryksun commented on GitHub (Feb 20, 2021):

so this is the order returned by the system.

To be clear, it is not the order that CreateEnvironmentBlock returns. As shown by vefatica, it is also not the order used by SetEnvironmentVariableW, which inserts WT before __VIP in accordance with the expected uppercase, non-linguistic sort order.

@eryksun commented on GitHub (Feb 20, 2021): > so this is the order returned by the system. To be clear, it is not the order that `CreateEnvironmentBlock` returns. As shown by vefatica, it is also not the order used by `SetEnvironmentVariableW`, which inserts `WT` before `__VIP` in accordance with the expected uppercase, non-linguistic sort order.
claunia commented 2026-01-31 03:21:38 +00:00
Author
Owner
Copy Link

@vefatica commented on GitHub (Feb 20, 2021):

The behavior I mentioned seems to conflict with the documentation mentioned by @eryksun.

I don't know about upholding contracts, but what about tradition ... programs working as thay have for decades?

This just plain looks bad.

image

As for

why this matters

it makes environment variables hard to find when they're not where they're expected to be (and where they belong) in the list.

@vefatica commented on GitHub (Feb 20, 2021): The behavior I mentioned seems to conflict with the documentation mentioned by @eryksun. I don't know about upholding contracts, but what about tradition ... programs working as thay have for decades? This just plain looks bad. ![image](https://user-images.githubusercontent.com/61856645/108608934-57313d00-7398-11eb-83e0-dd565c406cc2.png) As for > why this matters it makes environment variables hard to find when they're not where they're expected to be (and where they belong) in the list.
claunia commented 2026-01-31 03:21:38 +00:00
Author
Owner
Copy Link

@vefatica commented on GitHub (Feb 20, 2021):

I, too, have confirmed (as @eryksun alluded to) CreateEnvironmentBlock() puts __VIP at the end.

@vefatica commented on GitHub (Feb 20, 2021): I, too, have confirmed (as @eryksun alluded to) CreateEnvironmentBlock() puts __VIP at the end.
claunia commented 2026-01-31 03:21:38 +00:00
Author
Owner
Copy Link

@vefatica commented on GitHub (Feb 20, 2021):

Please reopen this issue.

@vefatica commented on GitHub (Feb 20, 2021): Please reopen this issue.
claunia commented 2026-01-31 03:21:39 +00:00
Author
Owner
Copy Link

@DHowett commented on GitHub (Feb 20, 2021):

Huh, wild.

@DHowett commented on GitHub (Feb 20, 2021): Huh, wild.
claunia commented 2026-01-31 03:21:39 +00:00
Author
Owner
Copy Link

@vefatica commented on GitHub (Feb 20, 2021):

Thank you!

@vefatica commented on GitHub (Feb 20, 2021): Thank you!
claunia commented 2026-01-31 03:21:39 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Mar 21, 2023):

This might've been fixed by #14999. We should double check. Maybe not, if we're still just dumping into an unordered map and then dumping back out.

Actually yea I'm gonna reckon it probably wasn't.

@zadjii-msft commented on GitHub (Mar 21, 2023): ~This might've been fixed by #14999~. We should double check. Maybe not, if we're still just dumping into an unordered map and then dumping back out. Actually yea I'm gonna reckon it probably wasn't.
claunia commented 2026-01-31 03:21:40 +00:00
Author
Owner
Copy Link

@ianjoneill commented on GitHub (Apr 1, 2023):

This is fixed by #15082

image

@ianjoneill commented on GitHub (Apr 1, 2023): This is fixed by #15082 ![image](https://user-images.githubusercontent.com/5821575/229314392-5c543fa3-add3-43f8-b173-16f1f92c77d9.png)
claunia commented 2026-01-31 03:21:40 +00:00
Author
Owner
Copy Link

@ianjoneill commented on GitHub (Apr 1, 2023):

This might've been fixed by #14999. We should double check. Maybe not, if we're still just dumping into an unordered map and then dumping back out.

Actually yea I'm gonna reckon it probably wasn't.

The map was ordered, it was just ordered wrongly 🙂

@ianjoneill commented on GitHub (Apr 1, 2023): > ~This might've been fixed by #14999~. We should double check. Maybe not, if we're still just dumping into an unordered map and then dumping back out. > > Actually yea I'm gonna reckon it probably wasn't. The map was ordered, it was just ordered wrongly 🙂
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Area-TerminalConnection Help Wanted In-PR Issue-Bug Needs-Tag-Fix Priority-3 Product-Terminal
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#12667
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?