[ember] @ember/object Correct arguments for Evented #45978

wagenet · 2020-07-09T15:11:17Z

Please fill in this template.

Use a meaningful title for the pull request. Include the name of the package modified.
Test the change in your own code. (Compile and run.)
Add or edit tests to reflect the change. (Run with npm test.)
Follow the advice from the readme.
Avoid common mistakes.
Run npm run lint package-name (or tsc if no tslint.json is present).
NOTE: Lint is failing due to issues unrelated to my change.

If changing an existing definition:

Provide a URL to documentation or source code which provides context for the suggested changes:

https://api.emberjs.com/ember/3.19/classes/Evented/methods/
https://api.emberjs.com/ember/3.19/functions/@ember%2Fobject%2Fevented/on (see https://github.com/emberjs/ember.js/blob/v3.19.0/packages/%40ember/-internals/metal/lib/events.ts#L204 for clarification on the argument structure)

typescript-bot · 2020-07-09T15:11:26Z

@wagenet Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.

This is a live comment which I will keep updated.

Code Reviews

Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.

Status

✅ No merge conflicts
✅ Continuous integration tests have passed
✅ Most recent commit is approved by type definition owners or DT maintainers

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 45978,
  "author": "wagenet",
  "owners": [
    "mike-north",
    "chriskrycho",
    "dfreeman",
    "jamescdavis"
  ],
  "dangerLevel": "ScopedAndTested",
  "headCommitAbbrOid": "392cee0",
  "headCommitOid": "392cee084fca237adf71ef10b0481c8cd53257fe",
  "mergeIsRequested": true,
  "stalenessInDays": 0,
  "lastCommitDate": "2020-07-09T17:42:37.000Z",
  "lastCommentDate": "2020-07-09T19:23:43.000Z",
  "maintainerBlessed": false,
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/45978/files",
  "hasMergeConflict": false,
  "authorIsOwner": false,
  "isFirstContribution": true,
  "popularityLevel": "Popular",
  "anyPackageIsNew": false,
  "packages": [
    "ember__object"
  ],
  "files": [
    {
      "filePath": "types/ember__object/evented.d.ts",
      "kind": "definition",
      "package": "ember__object"
    },
    {
      "filePath": "types/ember__object/test/event.ts",
      "kind": "test",
      "package": "ember__object"
    }
  ],
  "hasDismissedReview": false,
  "ciResult": "pass",
  "lastReviewDate": "2020-07-09T17:57:16.000Z",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 2,
  "isChangesRequested": false
}

typescript-bot · 2020-07-09T15:11:27Z

🔔 @mike-north @chriskrycho @dfreeman @jamescdavis - please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

chriskrycho · 2020-07-09T15:32:46Z

types/ember__object/evented.d.ts

+        method: ((this: Target, ...args: any[]) => void) | string
    ): this;
-    on(name: string, method: (...args: any[]) => void): this;
+    on(name: string, method: ((...args: any[]) => void) | string): this;


Suuuuper nit: for readability, can we flip the order of these? I always have a devil of a time parsing parenthesized function expressions like this. So method: string | (this: Target, ...args: any[]) => void, etc.

chriskrycho · 2020-07-09T15:51:06Z

types/ember__object/evented.d.ts

@@ -51,6 +51,5 @@ export default Evented;
 * a specified event or events are triggered.
 */
 export function on(
-    eventNames: string,
-    func: (...args: any[]) => void
+    ...args: Array<string | ((...args: any[]) => void)>


I believe this type is wrong, because it's not actually possible for these to be mixed. The type as written here would let you write this:

on( 'click', (someEv) => { console.log(someEv); }, 'dblclick', 'mouseover' );

In order to make it take a spread of arguments followed by the callback, we should support it now via overloads, and then once we bump our minimum supported TS version to 4.0 (presumably in the first half 2021) I think we'll be able to use TS 4.0's support for variadic tuples to make this work as desired.

Yeah, I agree that this definition is too accepting. I just chose it because it was what's in the source and the existing definition disallows valid options.

@chriskrycho what do you have in mind for overloads? Just a number of variants with increasing numbers of eventName arguments?

Also, I'm not seeing how variadic tuples would help us here, but it's also very possible that I'm missing something.

Ah, looks like this would work in TS 4:

type EventNames = string[]; type OnArgs = [...EventNames, (...args: any[]) => void]; export function on(...args: OnArgs): (...args: any[]) => void;

Exactly that for TS 4. For TS <4, yeah, you’d do a bunch of increasing event names—we tend to go up to 5 or 6 most similar places in the Ember types.

typescript-bot · 2020-07-09T15:52:51Z

@wagenet One or more reviewers has requested changes. Please address their comments. I'll be back once they sign off or you've pushed new commits or comments. If you disagree with the reviewer's comments, you can "dismiss" the review using GitHub's review UI. Thank you!

typescript-bot · 2020-07-09T16:56:28Z

@chriskrycho Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

chriskrycho

Thanks for making the changes—one tiny further tweak, and we’ll be good!

chriskrycho · 2020-07-09T17:17:05Z

types/ember__object/evented.d.ts

+ * The actual implementation allows for any number of eventName strings followed by
+ * the function to be called. In TypeScript 4.0 this could be better described with:
+ *
+ *   type EventNames = string[];
+ *   type OnArgs = [...EventNames, (...args: any[]) => void];
+ *   export function on(...args: OnArgs): (...args: any[]) => void;


Let’s move these to a //-style comment above this, instead of in the docstring: the docstring will show up for everyone who uses the type definition… which includes all JS users who are using VS Code, since it does automatic type acquisition in the background to power completions for the language server. 😱

typescript-bot · 2020-07-09T17:17:38Z

@wagenet One or more reviewers has requested changes. Please address their comments. I'll be back once they sign off or you've pushed new commits or comments. If you disagree with the reviewer's comments, you can "dismiss" the review using GitHub's review UI. Thank you!

chriskrycho

Thanks so much for the quick iteration! Looks good!

wagenet · 2020-07-09T18:06:49Z

@chriskrycho thanks for your quick reviews!

wagenet · 2020-07-09T18:59:32Z

@chriskrycho any clue what's up with CI?

chriskrycho · 2020-07-09T19:22:23Z

Note sure why the benchmark is taking so long, but if you follow the good bot’s instructions and post “Ready to merge” in a comment I think it’ll get pushed through automatically as soon as that benchmark finishes! 😅

wagenet · 2020-07-09T19:23:32Z

@chriskrycho looks like the benchmark is stuck in a restart loop. Not sure who to escalate that to.

wagenet · 2020-07-09T19:23:43Z

Ready to merge

wagenet · 2020-07-09T19:24:03Z

Guess we didn't need that benchmark to finish!

typescript-bot · 2020-07-09T19:27:22Z

I just published @types/ember__object@3.12.1 to npm.

chriskrycho · 2020-07-09T19:43:56Z

Whew!

typescript-bot · 2020-07-09T19:46:58Z

👋 Hi there! I’ve run some quick measurements against master and your PR. These metrics should help the humans reviewing this PR gauge whether it might negatively affect compile times or editor responsiveness for users who install these typings.

Let’s review the numbers, shall we?

Before we get into it, I need to mention that the language service crashed while taking these measurements. This isn’t your fault—on the contrary, you helped us find a probably TypeScript bug! But, be aware that these results may or may not be quite what they should be, depending on how many locations in your tests caused a crash. Paging @andrewbranch to investigate.

Comparison details 📊

	master	#45978	diff
Batch compilation
Memory usage (MiB)	76.3	78.4	+2.8%
Type count	14971	15016	0%
Assignability cache size	4385	4385	0%

Language service
Samples taken	1348	1380	+2%
Identifiers in tests	1665	1697	+2%
`getCompletionsAtPosition`
Mean duration (ms)	420.9	418.8	-0.5%
Mean CV	10.6%	10.7%
Worst duration (ms)	803.2	804.3	+0.1%
Worst identifier	sort	notEmpty
`getQuickInfoAtPosition`
Mean duration (ms)	404.8	404.4	-0.1%
Mean CV	10.5%	10.8%	+2.5%
Worst duration (ms)	646.8	598.1	-7.5%
Worst identifier	a	reads

It looks like nothing changed too much. I won’t post performance data again unless it gets worse.

@wagenet

…nts for Evented by @wagenet

@wagenet

…nts for Evented by @wagenet

typescript-bot added the Popular package This PR affects a popular package (as counted by NPM download counts). label Jul 9, 2020

typescript-bot added this to Waiting for Code Reviews in New Pull Request Status Board Jul 9, 2020

chriskrycho suggested changes Jul 9, 2020

View reviewed changes

typescript-bot added the Revision needed This PR needs code changes before it can be merged. label Jul 9, 2020

typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Jul 9, 2020

typescript-bot removed the Revision needed This PR needs code changes before it can be merged. label Jul 9, 2020

typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Jul 9, 2020

wagenet force-pushed the ember-evented-fixes branch 2 times, most recently from 398e53e to 50d7a6d Compare July 9, 2020 16:52

chriskrycho suggested changes Jul 9, 2020

View reviewed changes

typescript-bot added the Revision needed This PR needs code changes before it can be merged. label Jul 9, 2020

typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Jul 9, 2020

[ember] @ember/object Correct arguments for Evented

392cee0

wagenet force-pushed the ember-evented-fixes branch from 50d7a6d to 392cee0 Compare July 9, 2020 17:42

typescript-bot removed the Revision needed This PR needs code changes before it can be merged. label Jul 9, 2020

typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Jul 9, 2020

chriskrycho approved these changes Jul 9, 2020

View reviewed changes

typescript-bot added Owner Approved A listed owner of this package signed off on the pull request. Self Merge This PR can now be self-merged by the PR author or an owner labels Jul 9, 2020

typescript-bot moved this from Waiting for Code Reviews to Waiting for Author to Merge in New Pull Request Status Board Jul 9, 2020

typescript-bot moved this from Waiting for Author to Merge to Recently Merged in New Pull Request Status Board Jul 9, 2020

typescript-bot merged commit 68523d9 into DefinitelyTyped:master Jul 9, 2020

wagenet deleted the ember-evented-fixes branch July 9, 2020 19:24

typescript-bot added the Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance. label Jul 9, 2020

ngbrown pushed a commit to ngbrown-forks/DefinitelyTyped that referenced this pull request Jul 11, 2020

🤖 Merge PR DefinitelyTyped#45978 [ember] @ember/object Correct argume…

cfbec2c

…nts for Evented by @wagenet

typescript-bot removed this from Recently Merged in New Pull Request Status Board Jul 13, 2020

danielrearden pushed a commit to danielrearden/DefinitelyTyped that referenced this pull request Sep 22, 2020

🤖 Merge PR DefinitelyTyped#45978 [ember] @ember/object Correct argume…

a96970d

…nts for Evented by @wagenet

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ember] @ember/object Correct arguments for Evented #45978

[ember] @ember/object Correct arguments for Evented #45978

wagenet commented Jul 9, 2020

typescript-bot commented Jul 9, 2020 •

edited

typescript-bot commented Jul 9, 2020

chriskrycho Jul 9, 2020

chriskrycho Jul 9, 2020

wagenet Jul 9, 2020

wagenet Jul 9, 2020

wagenet Jul 9, 2020

wagenet Jul 9, 2020

chriskrycho Jul 9, 2020

typescript-bot commented Jul 9, 2020

typescript-bot commented Jul 9, 2020

chriskrycho left a comment

chriskrycho Jul 9, 2020

typescript-bot commented Jul 9, 2020

chriskrycho left a comment

wagenet commented Jul 9, 2020

wagenet commented Jul 9, 2020

chriskrycho commented Jul 9, 2020

wagenet commented Jul 9, 2020

wagenet commented Jul 9, 2020

wagenet commented Jul 9, 2020

typescript-bot commented Jul 9, 2020

chriskrycho commented Jul 9, 2020

typescript-bot commented Jul 9, 2020

[ember] @ember/object Correct arguments for Evented #45978

[ember] @ember/object Correct arguments for Evented #45978

Conversation

wagenet commented Jul 9, 2020

typescript-bot commented Jul 9, 2020 • edited

Code Reviews

Status

typescript-bot commented Jul 9, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

typescript-bot commented Jul 9, 2020

typescript-bot commented Jul 9, 2020

chriskrycho left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

typescript-bot commented Jul 9, 2020

chriskrycho left a comment

Choose a reason for hiding this comment

wagenet commented Jul 9, 2020

wagenet commented Jul 9, 2020

chriskrycho commented Jul 9, 2020

wagenet commented Jul 9, 2020

wagenet commented Jul 9, 2020

wagenet commented Jul 9, 2020

typescript-bot commented Jul 9, 2020

chriskrycho commented Jul 9, 2020

typescript-bot commented Jul 9, 2020

typescript-bot commented Jul 9, 2020 •

edited