New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Core: jQuery.isFunction returns false for Function objects with custom @@toStringTag #3600

Closed
akihikodaki opened this Issue Apr 1, 2017 · 11 comments

Comments

Projects
None yet
5 participants
@akihikodaki

akihikodaki commented Apr 1, 2017

Description

jQuery.isFunction returns false for Function objects with custom @@toStringTag. That is undesirable in some case such as GeneratorFunction.
This flaw was pointed out at #3597 (comment).

Link to test case

https://jsbin.com/xocanozuye/1/edit?html,js,console

console.log(jQuery.isFunction(function *(){}));

@akihikodaki akihikodaki changed the title from Core: jQuery.isFunction returns false for objects inheriting Function objects. to Core: jQuery.isFunction returns false for Function objects with custom @@toStringTag Apr 1, 2017

@Krinkle

This comment has been minimized.

Show comment
Hide comment
@Krinkle

Krinkle Apr 1, 2017

Member

@gibson042 From a quick check seems like patching $.type() to align more with typeof should otherwise be harmless. We've already been going in that direction anyways.

As of 3.2, we already do this for most cases. We now only use class2type[toString] for values where typeof returns function or object.

If we remove function from that, reducing use of class2type to object only, should do the trick.

Although we may need to find another way to support Android 2.3's RegExp values in that case.

type: function( obj ) {
	if ( obj == null ) {
		return obj + "";
	}

	// Support: Android <=2.3 only (functionish RegExp)
	return typeof obj === "object" || typeof obj === "function" ?
		class2type[ toString.call( obj ) ] || "object" :
		typeof obj;
},
isFunction: function( obj ) {
	return jQuery.type( obj ) === "function";
},
Member

Krinkle commented Apr 1, 2017

@gibson042 From a quick check seems like patching $.type() to align more with typeof should otherwise be harmless. We've already been going in that direction anyways.

As of 3.2, we already do this for most cases. We now only use class2type[toString] for values where typeof returns function or object.

If we remove function from that, reducing use of class2type to object only, should do the trick.

Although we may need to find another way to support Android 2.3's RegExp values in that case.

type: function( obj ) {
	if ( obj == null ) {
		return obj + "";
	}

	// Support: Android <=2.3 only (functionish RegExp)
	return typeof obj === "object" || typeof obj === "function" ?
		class2type[ toString.call( obj ) ] || "object" :
		typeof obj;
},
isFunction: function( obj ) {
	return jQuery.type( obj ) === "function";
},
@mgol

This comment has been minimized.

Show comment
Hide comment
@mgol

mgol Apr 1, 2017

Member
Member

mgol commented Apr 1, 2017

@akihikodaki

This comment has been minimized.

Show comment
Hide comment
@akihikodaki

akihikodaki Apr 2, 2017

That breaks for some cases such as document.createElement( "object" ). It is/was actually a function (callable object), but jQuery.isFunction( document.createElement( "object" ) ) is expected to be false.

	obj = document.createElement( "object" );

	// Firefox says this is a function
assert.ok( !jQuery.isFunction( obj ), "Object Element" );

obj = document.createElement( "object" );

On the other hand, the documentation says:

Determine the internal JavaScript [[Class]] of an object.

https://github.com/jquery/api.jquery.com/blob/eceefcf142534cb51ae443157a4752c9357f3ebd/entries/jQuery.type.xml#L10

Though [[Class]] does no longer exist since ECMAScript 2015, it is similar to @@toStringTag and people may consider jQuery.type derives from that. The change regarding GeneratorFunction as function breaks this expectation.

We need to make clear what we expect for jQuery.isFunction and jQuery.type rather than considering only GeneratorFunction to prevent such confusions.

akihikodaki commented Apr 2, 2017

That breaks for some cases such as document.createElement( "object" ). It is/was actually a function (callable object), but jQuery.isFunction( document.createElement( "object" ) ) is expected to be false.

	obj = document.createElement( "object" );

	// Firefox says this is a function
assert.ok( !jQuery.isFunction( obj ), "Object Element" );

obj = document.createElement( "object" );

On the other hand, the documentation says:

Determine the internal JavaScript [[Class]] of an object.

https://github.com/jquery/api.jquery.com/blob/eceefcf142534cb51ae443157a4752c9357f3ebd/entries/jQuery.type.xml#L10

Though [[Class]] does no longer exist since ECMAScript 2015, it is similar to @@toStringTag and people may consider jQuery.type derives from that. The change regarding GeneratorFunction as function breaks this expectation.

We need to make clear what we expect for jQuery.isFunction and jQuery.type rather than considering only GeneratorFunction to prevent such confusions.

@gibson042

This comment has been minimized.

Show comment
Hide comment
@gibson042

gibson042 Apr 2, 2017

Member

I'd rather deprecate jQuery.type than try to keep up with external changes. jQuery.isFunction doesn't need to rely on it, and shouldn't do so any longer IMO.

Member

gibson042 commented Apr 2, 2017

I'd rather deprecate jQuery.type than try to keep up with external changes. jQuery.isFunction doesn't need to rely on it, and shouldn't do so any longer IMO.

@gibson042 gibson042 added the Core label Apr 2, 2017

@mgol

This comment has been minimized.

Show comment
Hide comment
@mgol

mgol Apr 2, 2017

Member

@gibson042 if all jQuery.isFunction is going to do is checking if typeof is "function" then we should deprecate it as well.

Member

mgol commented Apr 2, 2017

@gibson042 if all jQuery.isFunction is going to do is checking if typeof is "function" then we should deprecate it as well.

@gibson042

This comment has been minimized.

Show comment
Hide comment
@gibson042

gibson042 Apr 2, 2017

Member

I'm fine with deprecating it, but unfortunately it's a little more than just typeof because typeof document.createElement("object") === "function" in Firefox.

Member

gibson042 commented Apr 2, 2017

I'm fine with deprecating it, but unfortunately it's a little more than just typeof because typeof document.createElement("object") === "function" in Firefox.

@mgol

This comment has been minimized.

Show comment
Hide comment
@mgol

mgol Apr 2, 2017

Member

typeof document.createElement("object") === "function" in Firefox

Not just in Firefox, in Chrome it's "function", too. And in both of them it's changed to "object" in a beta version. I couldn't find any other browser (among these we support) where it's "function" so it will soon stop being an issue. Unless we want to be extra-safe here that nothing DOM-based returns true in jQuery.isFunction.

What's funny is in Chrome it used be "object" in versions <=46.

Member

mgol commented Apr 2, 2017

typeof document.createElement("object") === "function" in Firefox

Not just in Firefox, in Chrome it's "function", too. And in both of them it's changed to "object" in a beta version. I couldn't find any other browser (among these we support) where it's "function" so it will soon stop being an issue. Unless we want to be extra-safe here that nothing DOM-based returns true in jQuery.isFunction.

What's funny is in Chrome it used be "object" in versions <=46.

@akihikodaki

This comment has been minimized.

Show comment
Hide comment
@akihikodaki

akihikodaki Apr 3, 2017

It's a DOM specific problem, so why not check if it is an element in the functions which deals with DOM? It is not reasonable to do that in jQuery.isFunction.

akihikodaki commented Apr 3, 2017

It's a DOM specific problem, so why not check if it is an element in the functions which deals with DOM? It is not reasonable to do that in jQuery.isFunction.

@dmethvin

This comment has been minimized.

Show comment
Hide comment
@dmethvin

dmethvin Apr 3, 2017

Member

I'm with @gibson042 that we should discourage the use of these utility functions and not set the expectation they'll be updated for bizarre usage. If someone passes a generator function to jQuery they're doing something mighty strange. DO NOT TAUNT HAPPY FUN JQUERY!

Member

dmethvin commented Apr 3, 2017

I'm with @gibson042 that we should discourage the use of these utility functions and not set the expectation they'll be updated for bizarre usage. If someone passes a generator function to jQuery they're doing something mighty strange. DO NOT TAUNT HAPPY FUN JQUERY!

@Krinkle

This comment has been minimized.

Show comment
Hide comment
@Krinkle

Krinkle Apr 3, 2017

Member

If we plan to deprecate these methods, that means people will eventually need to migrate use to typeof, isArray, and other native checks. In that case I propose we keep them unchanged and deprecate them in their current form. There's little point in improving them further to allow new usage of patterns only to require migration later. It's certainly less risky in terms of back-compat and more predictable / easier to document ([[Class]] / @@toStringTag).

Member

Krinkle commented Apr 3, 2017

If we plan to deprecate these methods, that means people will eventually need to migrate use to typeof, isArray, and other native checks. In that case I propose we keep them unchanged and deprecate them in their current form. There's little point in improving them further to allow new usage of patterns only to require migration later. It's certainly less risky in terms of back-compat and more predictable / easier to document ([[Class]] / @@toStringTag).

@akihikodaki

This comment has been minimized.

Show comment
Hide comment
@akihikodaki

akihikodaki Apr 4, 2017

There's little point in improving them further to allow new usage of patterns only to require migration later.

Closing this issue.

akihikodaki commented Apr 4, 2017

There's little point in improving them further to allow new usage of patterns only to require migration later.

Closing this issue.

@akihikodaki akihikodaki closed this Apr 4, 2017

gibson042 added a commit to gibson042/jquery that referenced this issue Apr 8, 2017

@gibson042 gibson042 self-assigned this Apr 24, 2017

@gibson042 gibson042 added this to the 3.3.0 milestone Apr 24, 2017

@gibson042 gibson042 referenced this issue Jan 28, 2018

Closed

use toType in isFunction, fixes #3955 #3956

2 of 4 tasks complete

restonexyz added a commit to restonexyz/jquery that referenced this issue Feb 3, 2018

up (#1)
* Dimensions: ignore transforms when retrieving width/height

Close gh-3561
Fixes gh-3193

* CSS: remove dead code in getWidthOrHeight

- getCSS already falls back to inline styles

Ref gh-3561

* Release: update release dependencies

* Release: update AUTHORS.txt

* Release: update version to 3.2.0-pre

* Release: md5sum -> md5 -r for MAC

* Build: Updating the master version to 3.2.1-pre.

* Release: edit dist README version on release

Fixes gh-3574

* Build: update PR template

- Comment out things we don't need to see in the PR description
- Change CLA link

* Tests: move readywait to an iframe test

Close gh-3576
Fixes gh-3573

* Dimensions: fall back to offsetWidth/Height for inline elems

Close gh-3577
Fixes gh-3571

* Revert "Event: Trigger checkbox and radio click events identically"

This reverts commit b442aba.

* Revert "Event: Add radio click triggering tests"

This reverts commit 5f35b5b.

* Tests: add test for passing trigger data to radio click handler

Close gh-3581
Fixes gh-3579

* Build: Updating the master version to 3.2.2-pre.

* CSS: retrieve inline style before computed

- Fixes an issue with getting computed style on detached elements

* Revert "Build: Updating the master version to 3.2.2-pre."

This reverts commit 066bd86.

* Build: Updating the master version to 3.2.2-pre.

* Tests: Fix incorrect assert name for ensure_iterability_es6

Closes gh-3584
Ref bb026fc.

* Docs: Update links to HTML spec for stripAndCollapse (#3594)

* Offset: Use correct offset parents; include all border/scroll values

Thanks @anseki

Fixes gh-3080
Fixes gh-3107
Closes gh-3096
Closes gh-3487

* Core: Update isFunction to handle unusual-@@toStringTag input

Ref gh-3597
Fixes gh-3600
Fixes gh-3596
Closes gh-3617

* Tests: Improve offset test setup and labels

Hopefully this fixes iOS testing: http://swarm.jquery.org/job/5226

Ref 1d2df77
Closes gh-3641

* Tests: Be even more async for iOS

Ref 1d2df77
Closes gh-3643

* Tests: Attach test iframes to the body for visibility-dependent code

Ref 1d2df77
Closes gh-3645

* Tests: Allow a mock QUnit.test for perfect testIframe fidelity

Ref 1d2df77
Closes gh-3647

* Tests: Prepend test iframes for even *more* consistency

Ref 1d2df77

* Tests: Reset iframe window scroll after updating html/document position

Ref 1d2df77
Closes gh-3649

* Tests: Add debugging to investigate iOS failures

Ref 1d2df77

* Tests: Keep iframes visible in TestSwarm

Ref 1d2df77

* Tests: Adjust by actual scroll position, rather than expected

Ref 1d2df77

* Tests: Clean up offset debugging

Ref 1d2df77
Ref c0edd8d

* Tests: Correct expected assertion count

Ref e94b5b0

* Tests: Revert some testIframe changes to fix dimensions tests

Ref c0edd8d

* Revert "Tests: Revert some testIframe changes to fix dimensions tests"

This reverts commit c4368a9.

* Tests: Revert some testIframe changes to fix dimensions tests

Ref c0edd8d

* CSS: Drop the float mapping from cssProps

Firefox 35 and newer support style.float directly.

Closes #3569

* Docs:Tests: Update IE/Edge-related support comments & tests

Closes gh-3661

* Build: Test on Node.js 8, stop testing on Node.js 7

* Tests: minor typos

Close gh-3671

* Dimensions: Include scroll gutter in "padding" box

Fixes gh-3589
Closes gh-3656

* Deferred: fix memory leak of promise callbacks

Fixes gh-3606
Closes gh-3657

* Build: update node dependencies; commit package-lock.json

- Also ignore yarn.lock
Close gh-3669

* Build: Update sinon, husky, and qunitjs

* Build: fix uglify options for uglify update

- Uses new typeofs option for compression
- See mishoo/UglifyJS2#2198

Close gh-3710

* Event: `stopPropagation()` on native event-handler

Fixes gh-3693
Close gh-3694

* Core: Deprecate jQuery.isWindow

Fixes gh-3629
Close gh-3702

* Test: ensure position/offset return mutable objects

Fixes gh-3612
Closes gh-3695

* Revert "Offset: Resolve strict mode ClientRect "no setter" exception"

This reverts commit 3befe59.

* Offset: fix error from bad merge in #3695

* Dimensions: Detect and account for content-box dimension mishandling

Fixes gh-3699
Closes gh-3700

* Support: Properly check for IE9 absolute scrollbox mishandling

Ref gh-3589
Fixes gh-3699
Fixes gh-3730
Closes gh-3729

* Tests: Try extra hard to control focus

Ref gh-3732

* Tests: Abort focus tests when the environment doesn't cooperate

Ref gh-3732

* Tests: Reduce the abort timeout for simple focus testing

Ref gh-3732

* Tests: Simulate events when CI hinders use of native ones

Ref gh-3732

* Tests: Account for TestSwarm focus issues

Closes gh-3732

* Ajax: add an ontimeout handler to all requests

Fixes gh-3586
Close gh-3590

* Dimensions: Improve offsetWidth/offsetHeight fallback

Fixes gh-3698
Fixes gh-3602
Closes gh-3738

* Tests: Replace non-ASCII whitespace in source code

* Dimensions: Don't trust non-pixel computed width/height

Fixes gh-3611
Closes gh-3741

* Build: Fix comment typo

Closes gh-3747

* Build: Update my name in .mailmap

I got married! 🎉

* Build: Update my name in ATHORS.txt

I forgot .mailmap isn't everything.

* Tests: Update path calculation

Fixes gh-3756
Closes gh-3757

* CSS: Avoid unit-conversion interference from CSS upper bounds

Fixes gh-2144
Closes gh-3745

* Tests: Update lineHeight adjustments to give Android more slop

* CSS: Detect more WebKit styles erroneously reported as percentages

Ref 692f9d4
Fixes gh-3777
Closes gh-3778

* Build: Update to Babel 7, use for-of plugin instead of preset-es2015

Closes gh-3786

* Build: Drop cross-spawn, use child_process.spawn shell option

* Build: increase timeout in Promises/A+ tests 10 times

The promises-aplus-tests sets up a default 200 ms Mocha timeout. This makes
our tests randomly fail on Jenkins. 2 seconds will be safer.

Closes gh-3791

* Build: Remove package-lock.json, add it to .gitignore

npm 5, even the version included in the latest Node.js 8.5.0 re-generates
`package-lock.json` on each install. And when it does on a system that doesn't
support all the optional dependencies that are supported on the OS where the
lockfile was generated, it removes those optional deps from the lockfile.

The effect is that everyone firing `npm install` on our repo on any OS other
than macOS will immediately get a dirty state of the repo as the `fsevents`
dependency subtree gets removed from `package-lock.json`. That's a really bad
experience.

This commit removes package-lock.json from the repository and adds it to
.gitignore. We'll start committing the file again once the issue is resolved
on npm's part.

Fixes gh-3792

* Tests: Make Node tests work for paths with spaces in them

Without this patch Jenkins tests fail as jQuery job names there contain spaces,
e.g. "jQuery Core".

Closes gh-3821

* Tests: Add Safari 11 support test results

* Build: Test on Node.js 9

Closes gh-3840

* Tests: Add iOS 11 support test results

* Manipulation: Reduce size by eliminating single-use variable

Closes gh-3851

* CSS: Correctly set support properties with non-default zoom

Fixes gh-3808
Closes gh-3872

* Docs: Create CODE_OF_CONDUCT.md

Close gh-3865

* Tests: Add support for running unit tests via grunt with karma

- Update QUnit to 1.23.1
- Remove unused dl#dl from test/index.html
- Remove unused map#imgmap from test/index.html
- Ensure all urls to data use baseURI
- Add the 'grunt karma:main' task
  - customContextFile & customDebugFile
- Add 'npm run jenkins' script

Close gh-3744
Fixes gh-1999

* Build: Only run browser tests in one Node version on Travis

Ref gh-3744
Closes gh-3894

* Core: make camelCase function available only for internal usage

Close gh-3604
Fixes gh-3384

* Core: adjust data tests to ensure proper camelCasing

- Add back camelCase to the public object (deprecate not remove)
Ref #3384

* Core: deprecate jQuery.now

Fixes gh-2959
Close gh-3884

* Core: deprecate jQuery.proxy (not slated for removal)

Fixes gh-2958
Close gh-3885

* Manipulation: use `.children` to select tbody elements

- selectors beginning with a child combinator are not valid natively.
  This fixes the tests when using selector-native.js

* Attributes: allow array param in add/remove/toggleClass

+30 bytes instead of +182

Thanks to @faisaliyk for the first pass on this feature.

Fixes gh-3532
Close gh-3917

* Ajax: add unit test for getScript(Object)

Fixes gh-3736
Close gh-3918

* Tests: only run ontimeout test if ontimeout exists

Fixes gh-3742
Close gh-3919

* Build: Fix UglifyJS output in Android 4.0; update uglify

- Thanks to @mgol for first pass

Fixes gh-3743
Close gh-3920

* Tests: fix function reference for unbinding

Ref gh-2958

* Build: Remove CRLF line endings to fix builds on Windows

Close gh-3929

* Core: deprecate jQuery.isFunction

Fixes gh-3609

* Event: Move event aliases to deprecated

Fixes gh-3214

* Ajax: Don't process non-string data property on no-entity-body requests

Fixes gh-3438
Closes gh-3781

* Core: deprecate jQuery.isNumeric

Fixes gh-2960
Closes gh-3888

* Tests: fix weird failure in Edge 16 CSS

Fixes gh-3866
Close gh-3932

* Tests: fix weird flaky attributes test in Edge 16

Fixes gh-3867
Close gh-3931

* Core: deprecate jQuery.type

Fixes gh-3605
Close gh-3895

* Tests: fix number of expected assertions in basic core

* Tests: temporarily require sudo access for karma:main on travis

- This should fix the broken travis build on Node 8
- See travis-ci/travis-ci#8836

* Tests: correctly set sudo in travis config, not karma config

* Manipulation: Add support for scripts with module type

Fixes gh-3871
Close gh-3869

* Tests: fix tests in AMD mode

* Tests: ensure that module assertions run on supported browsers

- Also fixes tests for karma, where the URL for the module is different

Ref gh-3871

* Filter: Use direct filter in winnow

for both simple and complex selectors

Fixes gh-3272
Closes gh-3910

* Build: Add "-debug" suffix to name of karma debug tasks

Ref gh-3922
Close gh-3936

* Tests: skip test with invalid selector for selector-native tests

* Release: add new authors to AUTHORS.txt

* Release: update version to 3.3.0-pre

* Build: Updating the master version to 3.3.1-pre.

* Build: Updating the master version to 3.3.2-pre.

@lock lock bot locked as resolved and limited conversation to collaborators Jun 18, 2018

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