Skip to content

Fix: Correctly flag always-truthy exported and imported enum conditions (ts2845)#4530

Open
iapoorv01 wants to merge 1 commit into
microsoft:mainfrom
iapoorv01:fix-ts2845-exported-enums
Open

Fix: Correctly flag always-truthy exported and imported enum conditions (ts2845)#4530
iapoorv01 wants to merge 1 commit into
microsoft:mainfrom
iapoorv01:fix-ts2845-exported-enums

Conversation

@iapoorv01

Copy link
Copy Markdown

🚀 Problem Statement

Fixes microsoft/TypeScript#63565.

Currently, the control flow analysis incorrectly suppresses the ts2845 error ("This condition will always return 'true'") for known truthy enum conditions if the enum is declared with the export modifier, or if it is imported from another module as an alias. For instance, testing AdapterOutputType.PAGES === 1 will fail to emit the error if AdapterOutputType is an exported enum.

🕵️ Root Cause Analysis

When testing truthiness in checkTestingKnownTruthyType, the compiler verifies whether the referenced expression belongs to an enum by checking SymbolFlagsEnum. However, the current logic only checks the resolved local symbol (c.getResolvedSymbolOrNil(location.Expression())).

This check inadvertently drops the SymbolFlagsEnum tag in two key scenarios:

  1. Exported Enums: The local symbol is bound strictly with SymbolFlagsExportValue. The actual SymbolFlagsEnum tag is stored in the underlying .ExportSymbol.
  2. Imported Enums: The resolved symbol acts as an alias (SymbolFlagsAlias), completely masking the underlying enum flags.

As a result, Flags & ast.SymbolFlagsEnum evaluates to 0, the compiler silently assumes it is an open-ended generic property access, and the truthiness validation is pessimistically bypassed.

🛠️ The Fix

This PR modifies internal/checker/checker.go -> checkTestingKnownTruthyType to properly traverse and unwrap the symbol tree before performing the SymbolFlagsEnum verification:

  1. Evaluates and resolves any SymbolFlagsAlias (covering cross-module imports).
  2. Unwraps SymbolFlagsExportValue via getExportSymbolOfValueSymbolIfExported to reach the true declaration flags.

📊 Pros & Cons

  • Pros:
    • Restores strict type-checking and control flow parity for ts2845 across both local and exported enums without overhauling binding mechanisms.
    • Re-uses existing, battle-tested alias-resolution internal helpers (resolveAlias and getExportSymbolOfValueSymbolIfExported).
  • Cons:
    • Negligible overhead (a single recursive alias unwrap) added to truthiness evaluations on logical conditions.

🧪 Testing

  • Verified logic locally against the checkTestingKnownTruthyType control flow pipeline.
  • Existing tests and baselines pass (no unintentional regressions to standard AST handling).
  • Note: A dedicated baseline for this specific issue has been deferred, as generating .types and .errors baselines requires go to execute npx hereby baseline-accept natively.

Copilot AI review requested due to automatic review settings July 3, 2026 09:20

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.

Pull request overview

Adjusts checker control-flow analysis in the TypeScript native port to correctly detect always-truthy enum-member conditions (TS2845) when the enum is exported or referenced through an import alias.

Changes:

  • Unwraps alias symbols (SymbolFlagsAlias) before checking enum-ness for TS2845 suppression logic.
  • Unwraps exported value symbols (SymbolFlagsExportValue via getExportSymbolOfValueSymbolIfExported) to access underlying enum flags.

Comment thread internal/checker/checker.go Outdated
Comment thread internal/checker/checker.go Outdated
@iapoorv01 iapoorv01 force-pushed the fix-ts2845-exported-enums branch from 6e1c618 to bb5e724 Compare July 3, 2026 09:26
When an enum is exported or imported, the control flow analysis incorrectly suppressed the ts2845 error (This condition will always return 'true') for known truthy conditions like testing AdapterOutputType.PAGES.

This occurred because checkTestingKnownTruthyType failed to resolve the local reference's SymbolFlagsExportValue or SymbolFlagsAlias back to the underlying SymbolFlagsEnum. Since Flags & ast.SymbolFlagsEnum resulted in 0, the check was skipped entirely.

This commit introduces resolveAlias and getExportSymbolOfValueSymbolIfExported checks to properly unwrap the symbol and correctly identify the Enum, thus restoring the expected truthiness evaluation logic for open-ended enums.

Fixes microsoft/TypeScript#63565
@iapoorv01

Copy link
Copy Markdown
Author

@iapoorv01 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.

@microsoft-github-policy-service agree

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

export modifier on enum disables This condition will always return * ts2845

2 participants