Flow type workers #4903
Merged
Flow type workers #4903
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jfirebaugh
force-pushed
the
flow-worker
branch
2 times, most recently
from
9adfa41
to
b59c4a7
Compare
| */ | ||
| constructor(coord, size, sourceMaxZoom) { | ||
| constructor(coord: any, size: number, sourceMaxZoom: number) { |
There was a problem hiding this comment.
should this be coord: TileCoord?
There was a problem hiding this comment.
This was a rough pass; for many types I just used any where flow would otherwise complain. tile_coord.js hasn't been typed yet.
src/source/tile.js
Outdated
| this.state = 'loading'; | ||
|
|
||
| this.placementThrottler = new Throttler(300, this._immediateRedoPlacement.bind(this)); | ||
| } | ||
|
|
||
| registerFadeDuration(animationLoop, duration) { | ||
| registerFadeDuration(animationLoop: any, duration: any) { |
There was a problem hiding this comment.
why not duration: number?
src/source/worker.js
Outdated
| workerSources: { [string]: { [string]: WorkerSource } }; | ||
|
|
||
| constructor(self: WorkerGlobalScope) { | ||
| this.self = (self: any); |
There was a problem hiding this comment.
👍 I don't see a cleaner way to do this. Could we stick a // comment here explaining the cast to any?
There was a problem hiding this comment.
Yeah, would be nice if Object.assign(self, {registerWorkerSource: ..., registerRTLTextPlugin: ...}) worked, but it doesn't. I'll comment.
src/symbol/collision_tile.js
Outdated
| @@ -91,7 +119,7 @@ class CollisionTile { | |||
| ]; | |||
| } | |||
|
|
|||
| serialize(transferables) { | |||
| serialize(transferables /*: ?Array<Transferable> */): SerializedCollisionTile { | |||
There was a problem hiding this comment.
Why a comment for the parameter type?
anandthakker
approved these changes
Jun 28, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds flow annotations to the majority of the
Worker-related code. I started on #4876, wanted to make some refactors, and realized that it would be better to have the safety of some static type checking as I did.The first commit here switches the eslint
sourceTypeoption tomodule, so that we can use module types without resorting to flow comments.Q: Why not use flow comments?
A: They're ugly, and they're not as good as native type annotations: not syntax highlighted, not linted (e.g. no warnings if you import something and don't use it), no documentation.js support, no IDE integration.
Q: What are the side effects of
"sourceType": "module"?A: AFAICT, it doesn't force us to actually use non-type
import/exportrather than CommonJSrequire, it just means that we can't'use strict'in each file -- this is enforced by eslint because modules are always strict. I worked around this by writing a simplestrictifytransform that puts them back in. (I didn't use the published one because it's buggy and unmaintained.)Q: Shouldn't you be able to use
import typewithout requiring"sourceType": "module"?A: Yes, I think you should be. If you agree, 👍 this bug.
Beyond that, the eslint + flow combo pretty much works. The only issue I've found is that eslint chokes on unnamed parameters in function types. So just name them:
Works
Doesn't Work