Add proper localStorage availability checks to support Node v25 in @typescript/vfs

[yamcodes]

The package assumes it's running in a browser environment and directly calls localStorage.getItem("DEBUG"), however:, due to nodejs/node#57666:

Node.js <25: hasLocalStorage is false because localStorage is undefined, so the localStorage check is skipped entirely ✅
Node.js <=25: hasLocalStorage is true because localStorage exists, but it's a mock object that doesn't implement the full API ❌

So in Node.js 25, localStorage exists but localStorage.getItem is not a function.

Node <25, check if localStorage exists

Run:

node -e "console.log('localStorage exists:', typeof localStorage !== 'undefined'); console.log('localStorage type:', typeof localStorage); console.log('localStorage.getItem type:', typeof localStorage?.getItem);"

Prints:

localStorage exists: true
localStorage type: object
localStorage.getItem type: undefined
(node:30907) Warning: `--localstorage-file` was provided without a valid path
(Use `node --trace-warnings ...` to show where the warning was created)

Node 25, check if localStorage exists

Run:

node -e "console.log('localStorage exists:', typeof localStorage !== 'undefined'); console.log('localStorage type:', typeof localStorage); console.log('localStorage.getItem type:', typeof localStorage?.getItem);"

Prints:

localStorage exists: false
localStorage type: undefined
[eval]:1
console.log('localStorage exists:', typeof localStorage !== 'undefined'); console.log('localStorage type:', typeof localStorage); console.log('localStorage.getItem type:', typeof localStorage?.getItem);
                                                                                                                                                                                   ^

ReferenceError: localStorage is not defined
    at [eval]:1:180
    at runScriptInThisContext (node:internal/vm:219:10)
    at node:internal/process/execution:451:12
    at [eval]-wrapper:6:24
    at runScriptInContext (node:internal/process/execution:449:60)
    at evalFunction (node:internal/process/execution:283:30)
    at evalTypeScript (node:internal/process/execution:295:3)
    at node:internal/main/eval_string:71:3

This PR fixes it.

Closes #3449

[jakebailey]

This could be fine but requires a changeset to make a release. Run pnpm changeset and mark it as a patch release.

[jakebailey]

I somewhat expect that we need to detect this another way, though.

[yamcodes]

I somewhat expect that we need to detect this another way, though.

@jakebailey Sure! Let's analyze this.

Consider the following script.js:

console.log('localStorage type:', typeof localStorage);
console.log('localStorage value:', localStorage);
console.log('localStorage keys:', Object.keys(localStorage));
console.log('getItem type:', typeof localStorage.getItem);
console.log('instanceof Storage:', localStorage instanceof Storage);
console.log('prototype methods:', Object.getOwnPropertyNames(Object.getPrototypeOf(localStorage)));

try {
  localStorage.getItem('test');
  console.log('✅ Works');
} catch (e) {
  console.log('❌ Error:', e.message);
}

In Node 25,
We can run this script in two ways:

(1) node --localstorage-file=/tmp/test-storage script.js

localStorage type: object
localStorage value: Storage {}
localStorage keys: []
getItem type: function
instanceof Storage: true
prototype methods: [
  'length',
  'clear',
  'getItem',
  'key',
  'removeItem',
  'setItem',
  'constructor'
]
✅ Works

(2) node script.js

localStorage type: object
localStorage value: {}
localStorage keys: []
getItem type: undefined
instanceof Storage: false
prototype methods: [
  'constructor',
  '__defineGetter__',
  '__defineSetter__',
  'hasOwnProperty',
  '__lookupGetter__',
  '__lookupSetter__',
  'isPrototypeOf',
  'propertyIsEnumerable',
  'toString',
  'valueOf',
  '__proto__',
  'toLocaleString'
]
❌ Error: localStorage.getItem is not a function

Then, in Node 24 via node script.js:

localStorage type: undefined
/Users/yamcodes/code/test.js:7
console.log('localStorage value:', localStorage);
                                   ^

ReferenceError: localStorage is not defined
    at Object.<anonymous> (/Users/yamcodes/code/node.js:7:36)
    at Module._compile (node:internal/modules/cjs/loader:1760:14)
    at Object..js (node:internal/modules/cjs/loader:1893:10)
    at Module.load (node:internal/modules/cjs/loader:1480:32)
    at Module._load (node:internal/modules/cjs/loader:1299:12)
    at TracingChannel.traceSync (node:diagnostics_channel:328:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:244:24)
    at Module.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:154:5)
    at node:internal/main/run_main_module:33:47

Node.js v24.10.0

This proves that Node 25 introduces a case where localStorage can be a plain empty object! (API) With that in mind we can discuss some solutions.

In this PR I proposed directly checking for the existence of the getItem function right before we use it to access the debug flag. I can guess why you might have an issue with, because localStorage: LocalStorageLike | undefined "lies" to us in that it tells us that it cannot be an empty object. Also, arguably, hasLocalStorage should be false in this case too.

I can think of a few solutions.

1. An inherent fix by checking if the object is of the Storage instance using instanceof:

interface LocalStorageLike {
	getItem(key: string): string | null;
	setItem(key: string, value: string): void;
	removeItem(key: string): void;
}

declare var localStorage: LocalStorageLike | undefined;
declare var fetch: FetchLike | undefined;
declare var Storage: any;
let hasLocalStorage = false;
try {
	hasLocalStorage =
		typeof localStorage !== `undefined` &&
		typeof Storage !== `undefined` &&
		localStorage instanceof Storage;
} catch (error) {}

const hasProcess = typeof process !== `undefined`;
const shouldDebug =
	(hasLocalStorage && localStorage!.getItem("DEBUG")) ||
	(hasProcess && process.env.DEBUG);
const debugLog = shouldDebug
	? console.log
	: (_message?: any, ..._optionalParams: any[]) => "";

This works, but I'm not sure about BC (though I tested it in Node 24 and Node 25 with both flags, and it works in all cases). Also, my suggestion here is not the prettiest since it uses any and it also seemingly introduces some divergence and duplication against the existing LocalStorageLike model.

2. Making localStorage correct from the beginning by changing its type to:

declare var localStorage: LocalStorageLike | undefined | Record<string, never>;

This is a more fair type declaration in Node 25 because it considers the case the object can be empty.:

1. Node.js < 25: localStorage is undefined
2. Node.js 25 without flag: localStorage is {} (empty object with no methods)
3. Node.js 25 with flag: localStorage is proper LocalStorageLike implementation
4. Browser environments: localStorage is proper LocalStorageLike implementation

Then, we can either (2a) directly check for the function(s) we need inside the hasLocalStorage check:

let hasLocalStorage = false;
try {
	hasLocalStorage =
		typeof localStorage !== `undefined` &&
		typeof localStorage.getItem === `function`; // Potentially check for `setItem` and `removeItem` too
} catch (error) {}

I like this solution because it's as tight as we can get which makes it resilient.

However, if you want to avoid direct getItem checks and infer it instead, we can maybe (2b) check that localStorage is not a plain empty object, which if we trust the type means under process of elimination it must be a valid LocalStorageLike object;

let hasLocalStorage = false;
try {
	hasLocalStorage =
		typeof localStorage !== `undefined` && Object.getPrototypeOf(localStorage) !== Object.prototype;
} catch (error) {}

I'm leaning towards (2a) for the reasons stated above, which one sounds better to you?

[jakebailey]

Honestly, what you have in the PR already is probably fine. It just needs the changeset

[microsoft-github-policy-service]

@yamcodes please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

1. Definitions.
   “Code” means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   “Project” means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative (www.opensource.org).
   “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   “Submission” means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.
5. Licenses.

• Copyright License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.
• Patent License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.
• Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.
8. Information about Submissions. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.
9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.
10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

[jakebailey]

Sigh, the inclusion of the changeset (even though I did that) makes the PR need a CLA due to modifying more than a single line