Adding support for @implements. #36292

dragomirtitian · 2020-01-18T20:10:00Z

Open issues:

How to handle interfaces that can't be implemented in JS, for example those with index signatures
Fix code fix that implements missing interface members (currently it does not show up, but it would be nice if it worked for JS as well)
Add more tests

@sandersn For 1 I would suppress these errors for JS. For 2, do you think it is worth showing the fix? Also maybe we could have a typescript-bot pack of this so @TimvdLippe can maybe give it a try.

One issue, unrelated to @implements necessarily, is that method in the classes used as interfaces in @TimvdLippe example don't have any return statement, so any return type will cause an error. Support for @abstract was taken out of the scope of #35629, but maybe adding support for @abstract could be useful to suppress these errors. Using @ts-ignore might also be a simpler workaround.

TimvdLippe · 2020-01-18T22:19:05Z

Yes I would like to try it out. I will be able to do so next week when I am back in the office.

TimvdLippe · 2020-01-20T16:10:53Z

To be able to debug, I would need a bot-pack build that I can try out. Let me know when you have one available 😄

dragomirtitian · 2020-01-20T17:38:22Z

@TimvdLippe I unfortunately can't summon the TS bot .. let me try something, <clears-throat />

<incantation-voice>
Oh mighty and benevolent TS overlords @sandersn @orta or @DanielRosenwasser could we have a pack of this ?
</incantation-voice>

orta · 2020-01-21T19:44:10Z

Sure!
@typescript-bot pack this

typescript-bot · 2020-01-21T19:44:14Z

Heya @orta, I've started to run the tarball bundle task on this PR at 5a7fdd5. You can monitor the build here. It should now contribute to this PR's status checks.

typescript-bot · 2020-01-21T20:01:33Z

Hey @orta, I've packed this into an installable tgz. You can install it for testing by referencing it in your package.json like so:

{
    "devDependencies": {
        "typescript": "https://typescript.visualstudio.com/cf7ac146-d525-443c-b23c-0d58337efebc/_apis/build/builds/61139/artifacts?artifactName=tgz&fileId=9B83D1D6A5EF666A0539602791C1631D23484EBBA1F4A0A5D118C77653B5832102&fileName=/typescript-3.8.0-insiders.20200121.tgz"
    }
}

and then running npm install.

There is also a playground for this build.

sandersn · 2020-01-22T18:59:40Z

@dragomirtitian re your questions:

Suppressing errors that can't be fixed in JS is a good idea. We can re-instate them later if we come up with a way to fix them.
I believe the code you emit for the code fix would have to be different, at least in that it uses jsdoc instead of type annotations. And it may have to fail because of errors from (1). That is a lot of work so you can open a new issue instead and assign it to me (or ping me on it).

I will look at the code now.

I'm a linguist, so I prefer the traditional 3 invocations. Like this: @NoamChomsky @NoamChomsky @NoamChomsky

sandersn

Looks good so far. I have a couple of initial suggestions.

As for tests, don't forget fourslash tests -- I think we suggest completions based on implements so the same thing should work for @implements.

src/compiler/types.ts

src/compiler/utilities.ts

src/compiler/utilitiesPublic.ts

TimvdLippe · 2020-01-23T16:36:57Z

I can confirm that the updated build is catching issues like missing overrides. That said, we are hitting a couple of other issues with TypeScript (#19983) which makes it hard for us to fully test all of its internals. My understanding thus far is that this change is WAI.

One improvement that would be great is that methods with @return on an @interface do not result in the A function whose declared type is neither 'void' nor 'any' must return a value. error. At that point, I don't see any TypeScript blockers for supporting JSDoc interfaces (without special-casing for TypeScript).

Thank you for doing the work and for the quick implementation!

dragomirtitian · 2020-01-23T16:47:31Z

@TimvdLippe The scope of this was specifically defined as support for @implements but I saw the same issue as you with regard to the actual usability of this with functions using @return, and I mentioned it in my opening comment to this pr. If @sandersn gives me the go ahead to suppress the error for classes marked with @interface I can roll up that chage in this pr, no problem (would probably have it done by Monday).

If not I think the only workaround for now would be to @ts-ignore it, although I know that is not really a viable solution for this existing code base...

sandersn · 2020-01-23T16:53:16Z

@dragomirtitian I'd like to keep support for @interface in a separate PR. Anyway, I'm not keen on the idea of ignoring errors on what would be invalid Typescript.
@TimvdLippe Is // @ts-nocheck at the beginning of the interface file a solution? I assume that it will be replaced by a d.ts once you are further along in the migration.

TimvdLippe · 2020-01-23T17:05:35Z

@sandersn Given our extensive use of @interface, a no-check would probably not fly. Especially as the interfaces and usages are scattered throughout the codebase. I suppose adding ts-ignore for every single method is the least intrusive (interim) solution.

I am okay with punting that to a different PR though.

sandersn · 2020-01-23T18:10:36Z

Looking at the example in the jsdoc documentation (excerpted below), I note that throwing in the interface body satisfies Typescript because throwing causes the function to return never, which is assignable to anything:

/**
 * @interface
 */
function Color() {}

/**
 * @returns {Array<number>} An array containing the red, green, and blue values, in that order.
 */
Color.prototype.rgb = function() {
    throw new Error('not implemented');
};

Does that work with Closure?

TimvdLippe · 2020-01-27T15:21:47Z

@sandersn I just checked and the following does indeed compile in both Closure and TS (with this patch):

/**
 * @interface
 */
export class EventTarget {
  /**
   * @param {symbol} eventType
   * @param {function(!Common.Event)} listener
   * @param {!Object=} thisObject
   * @return {!Common.EventTarget.EventDescriptor}
   */
  addEventListener(eventType, listener, thisObject) {
    throw new Error(`Not implemented`);
  }
}

dragomirtitian · 2020-02-02T23:22:44Z

@sandersn I fixed the code review issues. I added a test for multiple interfaces. I ran into the following issues;

I am not sure exactly how to suppress the error for missing signature implementation in JS. I mean I know how the error is produced (the error is deep in the bowels of checkTypeRelatedTo which is called when checking the heritage clauses). My issue is I am unsure how to suppress errors coming from there. I could add a parameter to checkTypeRelatedTo to skip index checks during implements checks, but that seems very ad hoc. The other option might be to capture diagnostics using errorOutputContainer but I would have to see if that could work. If you can think of an example similar to this, I could use the 'inspiration' to make sure I don't go off the rails 😂.
You mentioned four-slash tests for type completions in @implements which would be similar to @extends. The issue is but I could not trigger it completions for @augments and @extends at all I would create a separate issue to fix both. Thoughts?

Also sorry for the delay, it's been a hectic week at work.

sandersn · 2020-02-20T22:50:10Z

I couldn't think of a way to suppress errors that was both easy and obviously correct. Plus, after more thought, I'm not sure it's the right thing. @implements is essentially just a check, which means that people will only use it get errors, not to provide better intellisense. (Disregarding the completions that don't work and should.) For people who care mainly about correctness, having JS behave differently from TS is only going to confuse them.
Definitely create a separate issue for completions.

sandersn

I think this is ready to go, at least as far as I can tell. @dragomirtitian do you want to take it off Draft status?

(Edit: When the minor test suggestions are done.)

src/compiler/utilities.ts

tests/cases/conformance/jsdoc/jsdocImplements_properties.ts

tests/cases/conformance/jsdoc/jsdocImplements_interface_multiple.ts

sandersn · 2020-02-20T23:05:58Z

@typescript-bot user test this

typescript-bot · 2020-02-20T23:06:04Z

Heya @sandersn, I've started to run the parallelized community code test suite on this PR at d7839fe. You can monitor the build here. It should now contribute to this PR's status checks.

sandersn · 2020-02-21T00:06:53Z

ha ha oh no now user tests are broken because of the new octokit.

sandersn · 2020-02-21T00:22:18Z

(fix is at #36915; I'll merge it after I see that it can post a user test PR)

sandersn · 2020-02-21T18:02:56Z

@dragomirtitian can you merge from master and then I'll run the user tests?

dragomirtitian · 2020-02-21T18:22:31Z

@sandersn Yes, I'll merge from master. First I want to fix the declaration emit for @interface since it is not being emitted right now. (Forgot about declaration emit in JS)

…-35629-2

dragomirtitian · 2020-02-21T22:02:20Z

@sandersn I merged master, and fixed declaration emit. You should have a look at the emit fixes.

sandersn · 2020-02-21T22:40:55Z

@typescript-bot user test this

typescript-bot · 2020-02-21T22:40:59Z

Heya @sandersn, I've started to run the parallelized community code test suite on this PR at cedc792. You can monitor the build here. It should now contribute to this PR's status checks.

dragomirtitian · 2020-02-21T23:20:02Z

@sandersn The user tests seem to have failed again :(

sandersn

I haven’t had a chance to look at the test changes yet, but I had some requests for the code that I wanted to make before I quit for the weekend.

src/compiler/checker.ts

… used once.

sandersn · 2020-02-25T23:37:56Z

I think this will be ready once you get rid of the unneeded checks.

dragomirtitian · 2020-02-27T12:33:35Z

@sandersn Ok, I think we are good to go!

sandersn · 2020-02-27T17:27:56Z

@dragomirtitian Thanks for your hard work on this one!

Adding support for @implements.

5a7fdd5

sadikkuzu approved these changes Jan 18, 2020

View reviewed changes

dragomirtitian closed this Jan 19, 2020

dragomirtitian reopened this Jan 19, 2020

sandersn reviewed Jan 22, 2020

View reviewed changes

src/compiler/types.ts Outdated Show resolved Hide resolved

src/compiler/utilities.ts Show resolved Hide resolved

src/compiler/utilitiesPublic.ts Show resolved Hide resolved

Fixed code review issues for @implements, added some more tests.

d7839fe

dragomirtitian mentioned this pull request Feb 2, 2020

Make codefix for implementing interfaces work with @implements #36577

Open

sandersn approved these changes Feb 20, 2020

View reviewed changes

src/compiler/utilities.ts Outdated Show resolved Hide resolved

tests/cases/conformance/jsdoc/jsdocImplements_properties.ts Show resolved Hide resolved

tests/cases/conformance/jsdoc/jsdocImplements_interface_multiple.ts Outdated Show resolved Hide resolved

dragomirtitian marked this pull request as ready for review February 21, 2020 07:31

dragomirtitian mentioned this pull request Feb 21, 2020

Type completions in jsDoc @augments and @implements tags. #36939

Open

5 tasks

dragomirtitian added 2 commits February 21, 2020 23:54

Fixed declaration emit for @interface

7ddb796

Merge remote-tracking branch 'remotes/origin/master' into microsoftGH…

cedc792

…-35629-2

dragomirtitian requested a review from sandersn February 21, 2020 22:02

sandersn requested changes Feb 22, 2020

View reviewed changes

src/compiler/checker.ts Outdated Show resolved Hide resolved

src/compiler/checker.ts Outdated Show resolved Hide resolved

src/compiler/checker.ts Outdated Show resolved Hide resolved

sandersn reviewed Feb 22, 2020

View reviewed changes

src/compiler/checker.ts Outdated Show resolved Hide resolved

Improved getImplementsTypes to not cache the results since it is only…

6315dc5

… used once.

sandersn added the For Milestone Bug PRs that fix a bug with a specific milestone label Feb 26, 2020

Removed unnecessary checks from getImplementsTypes

9887717

sandersn approved these changes Feb 27, 2020

View reviewed changes

sandersn merged commit f883bf3 into microsoft:master Feb 27, 2020

TimvdLippe mentioned this pull request May 18, 2020

Declaration file for @implements of type specified in .d.ts file includes broken syntax #38640

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding support for @implements. #36292

Adding support for @implements. #36292

dragomirtitian commented Jan 18, 2020 •

edited

Loading

TimvdLippe commented Jan 18, 2020

TimvdLippe commented Jan 20, 2020

dragomirtitian commented Jan 20, 2020 •

edited

Loading

orta commented Jan 21, 2020

typescript-bot commented Jan 21, 2020 •

edited

Loading

typescript-bot commented Jan 21, 2020 •

edited

Loading

sandersn commented Jan 22, 2020

sandersn left a comment

TimvdLippe commented Jan 23, 2020

dragomirtitian commented Jan 23, 2020

sandersn commented Jan 23, 2020

TimvdLippe commented Jan 23, 2020

sandersn commented Jan 23, 2020

TimvdLippe commented Jan 27, 2020

dragomirtitian commented Feb 2, 2020 •

edited

Loading

sandersn commented Feb 20, 2020 •

edited

Loading

sandersn left a comment •

edited

Loading

sandersn commented Feb 20, 2020

typescript-bot commented Feb 20, 2020 •

edited

Loading

sandersn commented Feb 21, 2020

sandersn commented Feb 21, 2020

sandersn commented Feb 21, 2020

dragomirtitian commented Feb 21, 2020

dragomirtitian commented Feb 21, 2020

sandersn commented Feb 21, 2020

typescript-bot commented Feb 21, 2020 •

edited

Loading

dragomirtitian commented Feb 21, 2020

sandersn left a comment •

edited

Loading

sandersn commented Feb 25, 2020

dragomirtitian commented Feb 27, 2020 •

edited

Loading

sandersn commented Feb 27, 2020

Adding support for @implements. #36292

Adding support for @implements. #36292

Conversation

dragomirtitian commented Jan 18, 2020 • edited Loading

TimvdLippe commented Jan 18, 2020

TimvdLippe commented Jan 20, 2020

dragomirtitian commented Jan 20, 2020 • edited Loading

orta commented Jan 21, 2020

typescript-bot commented Jan 21, 2020 • edited Loading

typescript-bot commented Jan 21, 2020 • edited Loading

sandersn commented Jan 22, 2020

sandersn left a comment

Choose a reason for hiding this comment

TimvdLippe commented Jan 23, 2020

dragomirtitian commented Jan 23, 2020

sandersn commented Jan 23, 2020

TimvdLippe commented Jan 23, 2020

sandersn commented Jan 23, 2020

TimvdLippe commented Jan 27, 2020

dragomirtitian commented Feb 2, 2020 • edited Loading

sandersn commented Feb 20, 2020 • edited Loading

sandersn left a comment • edited Loading

Choose a reason for hiding this comment

sandersn commented Feb 20, 2020

typescript-bot commented Feb 20, 2020 • edited Loading

sandersn commented Feb 21, 2020

sandersn commented Feb 21, 2020

sandersn commented Feb 21, 2020

dragomirtitian commented Feb 21, 2020

dragomirtitian commented Feb 21, 2020

sandersn commented Feb 21, 2020

typescript-bot commented Feb 21, 2020 • edited Loading

dragomirtitian commented Feb 21, 2020

sandersn left a comment • edited Loading

Choose a reason for hiding this comment

sandersn commented Feb 25, 2020

dragomirtitian commented Feb 27, 2020 • edited Loading

sandersn commented Feb 27, 2020

dragomirtitian commented Jan 18, 2020 •

edited

Loading

dragomirtitian commented Jan 20, 2020 •

edited

Loading

typescript-bot commented Jan 21, 2020 •

edited

Loading

typescript-bot commented Jan 21, 2020 •

edited

Loading

dragomirtitian commented Feb 2, 2020 •

edited

Loading

sandersn commented Feb 20, 2020 •

edited

Loading

sandersn left a comment •

edited

Loading

typescript-bot commented Feb 20, 2020 •

edited

Loading

typescript-bot commented Feb 21, 2020 •

edited

Loading

sandersn left a comment •

edited

Loading

dragomirtitian commented Feb 27, 2020 •

edited

Loading