Skip to content

ES-conformant symbol typing - #64451

Open
Michael FIG (michaelfig) wants to merge 6 commits into
microsoft:mainfrom
agoric-labs:mfig/lawful-symbols
Open

Michael FIG (michaelfig) wants to merge 6 commits into
microsoft:mainfrom
agoric-labs:mfig/lawful-symbols

Conversation

@michaelfig

@michaelfig Michael FIG (michaelfig) commented Sep 25, 2026 •

Copy link
Copy Markdown

AI-generated from my test cases that showed discrepancies between TypeScript typing and ES standard behaviour.

Summary

  • Add a RegisteredSymbol<Key> intrinsic and preserve literal registry keys in the return type of Symbol.for.
  • Represent unresolved registry keys with a deferred symbol type, so separate generic calls do not receive one unsound unique-symbol identity.
  • Preserve narrow unique symbol types in const-like declarations and allow const assertions on them.
  • Emit and resolve symbol-keyed object properties using their registered and unique symbol types.
  • Add compiler cases and accepted baselines for symbol typing, property access, and deferred registry keys.

Tests

  • go -C ./tsc test -run='TestLocal/(registeredSymbolDeferredKey|registeredSymbolIntrinsic|registeredSymbolPropertyAccess|uniqueSymbolConstLikeWidening)\.ts$' ./internal/testrunner -count=1
  • go -C ./tsc test ./internal/checker ./internal/api

Refs: #35562, #37469, #54778, #60052

Closes: #35909
Closes: #27524
Closes: #55901

Co-authored-by: Codex codex@openai.com

Move the new test cases and accepted baselines into tsc/testdata so the compiler test runner executes them. Regenerate baselines with the repository's CRLF convention.

Co-authored-by: Codex <codex@openai.com>
Copilot AI balanced review requested due to automatic review settings September 25, 2026 20:12
@typescript-automation

Copy link
Copy Markdown

This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise.

@typescript-automation typescript-automation Bot added the For Uncommitted Bug PR for untriaged, rejected, closed or missing bug label Sep 25, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Non-literal and union registry keys currently receive unsound single unique-symbol identities.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: None

What changed in this PR

Adds registered-symbol typing and preserves symbol identities through inference, property access, and declaration emit.

Changes:

  • Introduces RegisteredSymbol<Key> and generic Symbol.for.
  • Preserves unique-symbol types in const-like contexts.
  • Adds compiler tests and baselines for symbol-keyed properties.
File Description
tsc/​internal/​checker/​checker.go Implements registered-symbol types and unique-symbol preservation.
tsc/​internal/​checker/​nodebuilderimpl.go Emits registered symbol types and computed property names.
tsc/​internal/​bundled/​libs/​lib.es2015.symbol.d.ts Declares the new intrinsic and Symbol.for signature.
tsc/​testdata/​tests/​cases/​compiler/​registeredSymbolIntrinsic.ts Tests intrinsic inference.
tsc/​testdata/​tests/​cases/​compiler/​registeredSymbolPropertyAccess.ts Tests symbol-keyed property access and emit.
tsc/​testdata/​tests/​cases/​compiler/​uniqueSymbolConstLikeWidening.ts Tests const-like unique-symbol widening.
tsc/​testdata/​baselines/​reference/​compiler/​registeredSymbolIntrinsic.types Records inferred types.
tsc/​testdata/​baselines/​reference/​compiler/​registeredSymbolIntrinsic.symbols Records resolved symbols.
tsc/​testdata/​baselines/​reference/​compiler/​registeredSymbolPropertyAccess.types Records property-access types.
tsc/​testdata/​baselines/​reference/​compiler/​registeredSymbolPropertyAccess.symbols Records property symbols.
tsc/​testdata/​baselines/​reference/​compiler/​registeredSymbolPropertyAccess.js Records declaration emit.
tsc/​testdata/​baselines/​reference/​compiler/​uniqueSymbolConstLikeWidening.types Records widening types.
tsc/​testdata/​baselines/​reference/​compiler/​uniqueSymbolConstLikeWidening.symbols Records widening symbols.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Resolve broad registered-symbol keys to symbol and distribute literal union keys over their possible registered symbol identities. Add compiler coverage for both cases.

Co-authored-by: Codex <codex@openai.com>
@typescript-automation

Copy link
Copy Markdown

The TypeScript team hasn't accepted the linked issue #27524. If you can get it accepted, this PR will have a better chance of being reviewed.

@michaelfig Michael FIG (michaelfig) changed the title Add registered symbol types and preserve symbol-keyed property access ES-conformant symbol typing Sep 25, 2026
Comment thread tsc/internal/checker/checker.go Outdated
Comment on lines +23388 to +23392
// Keep a type parameter deferred so instantiating Symbol.for's generic
// return type can resolve the actual key supplied at the call site.
if keyType.flags&(TypeFlagsStringOrNumberLiteral|TypeFlagsTypeParameter) == 0 {
return c.esSymbolType
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

How does this keep the type parameter deferred? Doesn't this just return symbol?

I think you not only need a new intrinsic type, you need a new kind of type (e.g. see newStringMappingType). Similar to how a type with TypeFlagsStringMapping doesn't have TypeFlagsString, it wouldn't have TypeFlagsSymbol - maybe because it could be instantiated to never? I'd have to consult with others.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I guess we just handle that in assignability separately and keeping the bitflags disjoint on this avoids other issues.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I agree that a separate type flag is a better way to represent a registered symbol whose key is still a type parameter. I’ve updated the PR to use that representation and added a regression test where two Symbol.for calls with generic keys previously shared an unsound unique-symbol identity.

My main hesitation was the limited remaining space in the TypeFlags uint32. It seems that all the bits up to bit 31 are already in use, so this uses the former Reserved3 bit at 31 and keeps TypeFlags as uint32. That consumes the remaining reserved bit, but seems justified for a distinct type kind.

I’d welcome your assessment of that tradeoff.

Avoid assigning a unique symbol identity to Symbol.for calls with unresolved keys. Add a regression case for indexed access through two generic registry keys.

Co-authored-by: Codex <codex@openai.com>
@microsoft-github-policy-service

Copy link
Copy Markdown

Michael FIG (@michaelfig) 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.
  1. 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.
  2. 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.
  3. 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.
  4. 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.
  5. 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.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

For Uncommitted Bug PR for untriaged, rejected, closed or missing bug

Projects

Status: Not started

3 participants