microsoft / microsoft/TypeScript

Inferred Promise type breaks ordering of completions

Open
#56,978 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: LS: Completion Lists Experience Enhancement Help Wanted Suggestion
Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

🔎 Search Terms

promise, generic, completion, inference

🕗 Version & Regression Information
  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about promise/completions (found nothing)
⏯ Playground Link

https://www.typescriptlang.org/play?#code/JYOwLgpgTgZghgYwgAgGIHt0B4AqA+ZCAD0hABMBnZABSnQFtgKJcCBvAKGWQHofkcACybIKg9AFcANmVHiA7sgkAHZDGBQKYZHCnoQAc2TzgYQcgRwwCQQBpkZiCHvqQuqQE97EawDouapgAFACUAFzIINJSANwcAL4cHFI+yAaYZBEY2ADaALp4cRx8yACSIMgAagDKyADC6GQQ9mBQHg4eyqAGYcU8fdxpGf5JMBIgCGDA+sgARnBkrEFEETjhaJisyJzcUD4SUBVRUlI6VHAgHnGJSSXlVbUNTS1tHV2GvXwD3PNkQfkhXxAA

💻 Code
interface Foo<T> extends Promise<T> {
  // This should show up first along with catch, then, finally, etc.
  foo(): null;
}

let good: Foo<[]>;

async () => {
  // In VS Code, try typing:
  //
  //   good.
}

function bad<T>(x: T): Foo<T> {
  return null as any;
}


async () => {
  // In VS Code, try typing:
  //
  //   bad([]).
}
🙁 Actual behavior

If a generic is used to infer the type contained in the Promise, then the completions ordering is lost.

This is the correct ordering, foo shows up towards the top:
Screenshot 2024-01-07 at 20 22 06

But if the function returning the Promise subclass is used, the ordering is lost:
Screenshot 2024-01-07 at 20 22 58

🙂 Expected behavior

The methods declared on the Promise and its subclasses / subinterfaces should show up before the "after adding await" properties of whatever is contained in the Promise.

Additional information about the issue

I'd be willing to work on fixing this with some guidance, if it's feasible.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the linked TypeScript Playground reproduction and compare completions for good versus bad([]). Trace the completion behavior for the Promise subtype and generic inference; done means foo and Promise methods appear before properties added from the contained value in both cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.