Selector: Inline Sizzle into the selector module: 3.x version #5113

mgol · 2022-09-09T14:48:22Z

Summary

The first commit is a cherry-pick of #4406.

The next commits are cherry-picks of the branch from which I landed #4395; see that PR for more details about this part. The last commit from this batch is named "Selector: Reduce selector-native.js". NOTE: not all of the changes were backported as on 3.x-stable we need to maintain backwards compatibility. The end of src/selector.js consists of a lot of assignments to jQuery.find to keep the old Sizzle interface intact.

All the subsequent commits are largely backporting changes to src/selector.js & src/selector/**/* that landed after #4395 and changes from Sizzle after the backport was done.

Some last commits are fixing minor browser issues.

This PR passes all jQuery tests in latest Firefox, Chrome & IE 9-11. All Sizzle tests also pass with Sizzle = jQuery.find. ~~There are minor issues in iOS 7 (just 2 tests failing that I'll fix) and I still need to verify old Android and generally all remaining browsers supported by 3.x~~. But considering IE is good ~~and old iOS has only minor issues~~, I'm optimistic this can work.

I'd love some ~~preliminary~~ reviews of this.

-851 bytes as of 0715705.

TODO for me:

Run the full TestSwarm run on browsers supported by 3.x from this branch
Manually run tests on browsers out of TestSwarm, like old iOS & Android Browser
Fix remaining browser issues, like the iOS 7 ones
Backport Sizzle method tests for backwards compatibility (https://github.com/jquery/sizzle/blob/main/test/unit/extending.js, https://github.com/jquery/sizzle/blob/main/test/unit/utilities.js)
Make sure all new selector updates from jQuery & Sizzle get merged to this branch before landing it (or immediately after that) to avoid regressions

Checklist

New tests have been added to show the fix or feature works
Grunt build and unit tests pass locally with these changes
~~If needed, a docs issue/PR was created at https://github.com/jquery/api.jquery.com~~

mgol · 2022-09-09T14:58:30Z

CI is failing due to Chrome :has issues I’m fixing in #5107.

mgol · 2022-09-13T15:11:52Z

-846 bytes as of 051909a.

mgol · 2022-09-13T15:16:39Z

I fixed iOS 7+ & Android 4.0-4.3 selector tests and I verified it by running both Sizzle & selector tests (from this branch) on iOS 7 & Android 4.0-4.2 (4.3 is not available in BrowserStack Live). I also run TestSwarm on this branch on the 3.x browsers at https://swarm.jquery.org/job/12556, results are green.

This looks good to go. Of course, just before merging I'll double check if there are any fixes to CP before merging (most notably, jquery/sizzle#486) but for now this is it! 🎉

mgol · 2022-09-13T15:49:43Z

I also run the entire jQuery test suite on Android 4.0 on this branch (it took ages to run!) and there were only two minor .offset() failures, likely unrelated to this PR.

mgol · 2022-09-13T15:52:28Z

src/selector.js

+	// Testing for detecting duplicates is unpredictable so instead assume we can't
+	// depend on duplicate detection in all browsers without a stable sort.
+	hasDuplicate = !support.sortStable;
+	sortInput = !support.sortStable && slice.call( results, 0 );


The last change in Sizzle affecting support.detectDuplicates landed in jquery/sizzle@07a5f1f but I had trouble relying on it. Even in Chrome the test sometimes was failing, despite my various attempts with expando tweaks for the test.

Since both of those tests only fail in Android Browser 4.x fro all of our supported browsers in jQuery 3.x, I started using support.sortStable here instead.

test/unit/selector.js

mgol · 2022-09-21T15:45:31Z

@timmywil @gibson042 this is passing on GitHub now; it's ready for a final review.

mgol · 2022-10-07T15:09:38Z

@timmywil @gibson042 If you want, I can extract test changes to a separate PR to be landed first. That way, this PR would be smaller and we'd have additional validation for the tests that they work in the same way both with the old & new implementation.

mgol · 2022-11-17T16:43:12Z

I rebased the PR & I added 4 new commits (the first one being titled "Selector:Manipulation: Fix DOM manip within template contents"). This is mostly to address items from other PRs and what already landed in Sizzle / jQuery main.

That way, `/* eslint-enable */` comments won't re-enable the rule.

jQuery has followed the following logic for selector handling for ages: 1. Modify the selector to adhere to scoping rules jQuery mandates. 2. Try `qSA` on the modified selector. If it succeeds, use the results. 3. If `qSA` threw an error, run the jQuery custom traversal instead. It worked fine so far but now CSS has a concept of forgiving selector lists that some selectors like `:is()` & `:has()` use. That means providing unrecognized selectors as parameters to `:is()` & `:has()` no longer throws an error, it will just return no results. That made browsers with native `:has()` support break selectors using jQuery extensions inside, e.g. `:has(:contains("Item"))`. Detecting support for selectors can also be done via: ```js CSS.supports( "selector(SELECTOR_TO_BE_TESTED)" ) ``` which returns a boolean. There was a recent spec change requiring this API to always use non-forgiving parsing: w3c/csswg-drafts#7280 (comment) However, no browsers have implemented this change so far. To solve this, two changes are being made: 1. In browsers supports the new spec change to `CSS.supports( "selector()" )`, use it before trying `qSA`. 2. Otherwise, add `:has` to the buggy selectors list. Ref jquerygh-5098 Ref jquerygh-5107 Ref jquery/sizzle#486 Ref w3c/csswg-drafts#7676

Backport some changes from jquerygh-5085 to make selector-native tests pass. Plus a few other fixes.

The tokenization stressor test needs to exclude `.qunit-source` or it sometimes fits into the results. This change has already landed on `main` in jquerygh-4550. Ref jquerygh-4550

This is a private API but since it's been tested in Sizzle, it makes sense to continue testing it on the jQuery 3.x line.

Previously, they were loaded after test files which meant top level usage was not evaluated correctly.

This backports custom pseudos tests from Sizzle; they were missed in original test backports. Also, the support for legacy custom pseudos has been dropped. The `jQuery.expr` test cleanup has been wrapped in `try-finally` for cleaner test isolation in case anything goes wrong. Ref jquerygh-5137

The `<template/>` element `contents` property is a document fragment that may have a `null` `documentElement`. In Safari 16 this happens in more cases due to recent spec changes - in particular, even if that document fragment is explicitly adopted into an outer document. We're testing both of those cases now. The crash used to happen in `jQuery.contains`. As it turns out, we don't need to query the supposed container `documentElement` if it has the `Node.DOCUMENT_NODE` (9) `nodeType`; we can call `.contains()` directly on the `document`. That avoids the crash. Fixes jquerygh-5147 Closes jquerygh-5158 (cherry picked from commit 3299236)

Firefox 106 adjusted to the spec mandating that `CSS.supports("selector(...)")` uses non-forgiving parsing which makes it pass the relevant support test. Closes jquerygh-5141 (cherry picked from commit 716130e)

`Sizzle.tokenize` is an internal Sizzle API, but exposed. As a result, it has historically been available in jQuery via `jQuery.find.tokenize`. That got dropped during Sizzle removal; this change restores the API. In addition to that, Sizzle tests have been backported for the following APIs: * `jQuery.find.matchesSelector` * `jQuery.find.matches` * `jQuery.find.compile` * `jQuery.find.select` * `jQuery.find.tokenize` Fixes jquerygh-5259 Ref jquery/sizzle#242 Ref jquerygh-5113 Ref jquerygh-4395 Ref jquerygh-4406

`Sizzle.tokenize` is an internal Sizzle API, but exposed. As a result, it has historically been available in jQuery via `jQuery.find.tokenize`. That got dropped during Sizzle removal; this change restores the API. In addition to that, Sizzle tests have been backported for the following APIs: * `jQuery.find.matchesSelector` * `jQuery.find.matches` * `jQuery.find.compile` * `jQuery.find.select` A new test was also added for `jQuery.find.tokenize` - even Sizzle was missing one. Fixes jquerygh-5259 Ref jquery/sizzle#242 Ref jquerygh-5113 Ref jquerygh-4395 Ref jquerygh-4406

`Sizzle.tokenize` is an internal Sizzle API, but exposed. As a result, it has historically been available in jQuery via `jQuery.find.tokenize`. That got dropped during Sizzle removal; this change restores the API. In addition to that, Sizzle tests have been backported for the following APIs: * `jQuery.find.matchesSelector` * `jQuery.find.matches` * `jQuery.find.compile` * `jQuery.find.select` A new test was also added for `jQuery.find.tokenize` - even Sizzle was missing one. Fixes jquerygh-5259 Ref jquerygh-5260 Ref jquery/sizzle#242 Ref jquerygh-5113 Ref jquerygh-4395 Ref jquerygh-4406

`Sizzle.tokenize` is an internal Sizzle API, but exposed. As a result, it has historically been available in jQuery via `jQuery.find.tokenize`. That got dropped during Sizzle removal; this change restores the API. In addition to that, Sizzle tests have been backported for the following APIs: * `jQuery.find.matchesSelector` * `jQuery.find.matches` * `jQuery.find.compile` * `jQuery.find.select` A new test was also added for `jQuery.find.tokenize` - even Sizzle was missing one. Fixes jquerygh-5259 Ref jquerygh-5263 Ref jquery/sizzle#242 Ref jquerygh-5113 Ref jquerygh-4395 Ref jquerygh-4406

`Sizzle.tokenize` is an internal Sizzle API, but exposed. As a result, it has historically been available in jQuery via `jQuery.find.tokenize`. That got dropped during Sizzle removal; this change restores the API. Some other APIs so far only exposed on the `3.x` line are also added back: * `jQuery.find.select` * `jQuery.find.compile` * `jQuery.find.setDocument` In addition to that, Sizzle tests have been backported for the following APIs: * `jQuery.find.matchesSelector` * `jQuery.find.matches` * `jQuery.find.compile` * `jQuery.find.select` A new test was also added for `jQuery.find.tokenize` - even Sizzle was missing one. Fixes jquerygh-5259 Ref jquerygh-5260 Ref jquery/sizzle#242 Ref jquerygh-5113 Ref jquerygh-4395 Ref jquerygh-4406

`Sizzle.tokenize` is an internal Sizzle API, but exposed. As a result, it has historically been available in jQuery via `jQuery.find.tokenize`. That got dropped during Sizzle removal; this change restores the API. Some other APIs so far only exposed on the `3.x` line are also added back: * `jQuery.find.select` * `jQuery.find.compile` * `jQuery.find.setDocument` In addition to that, Sizzle tests have been backported for the following APIs: * `jQuery.find.matchesSelector` * `jQuery.find.matches` * `jQuery.find.compile` * `jQuery.find.select` A new test was also added for `jQuery.find.tokenize` - even Sizzle was missing one. Fixes gh-5259 Closes gh-5263 Ref gh-5260 Ref jquery/sizzle#242 Ref gh-5113 Ref gh-4395 Ref gh-4406

`Sizzle.tokenize` is an internal Sizzle API, but exposed. As a result, it has historically been available in jQuery via `jQuery.find.tokenize`. That got dropped during Sizzle removal; this change restores the API. In addition to that, Sizzle tests have been backported for the following APIs: * `jQuery.find.matchesSelector` * `jQuery.find.matches` * `jQuery.find.compile` * `jQuery.find.select` A new test was also added for `jQuery.find.tokenize` - even Sizzle was missing one. Fixes gh-5259 Closes gh-5260 Ref gh-5263 Ref jquery/sizzle#242 Ref gh-5113 Ref gh-4395 Ref gh-4406

mgol added Selector Needs review Discuss in Meeting Reserved for Issues and PRs that anyone would like to discuss in the weekly meeting. labels Sep 9, 2022

mgol added this to the 3.7.0 milestone Sep 9, 2022

mgol self-assigned this Sep 9, 2022

mgol force-pushed the 3.x-inline-sizzle branch from ef52ef2 to 65f991e Compare September 12, 2022 13:49

mgol mentioned this pull request Sep 12, 2022

Selector: Use Sizzle :has if CSS.supports(selector(...)) non-compliant jquery/sizzle#486

Merged

mgol force-pushed the 3.x-inline-sizzle branch 2 times, most recently from 649cfb2 to 084fe49 Compare September 13, 2022 15:00

mgol marked this pull request as ready for review September 13, 2022 15:16

mgol commented Sep 13, 2022

View reviewed changes

mgol commented Sep 15, 2022

View reviewed changes

test/unit/selector.js Outdated Show resolved Hide resolved

mgol force-pushed the 3.x-inline-sizzle branch 3 times, most recently from 13bc0d0 to 5f88f31 Compare September 21, 2022 14:09

mgol removed the Discuss in Meeting Reserved for Issues and PRs that anyone would like to discuss in the weekly meeting. label Sep 21, 2022

mgol force-pushed the 3.x-inline-sizzle branch from 5f88f31 to 6899813 Compare September 21, 2022 15:09

mgol force-pushed the 3.x-inline-sizzle branch 2 times, most recently from 77fe8c0 to ac6fe32 Compare October 4, 2022 21:27

mgol force-pushed the 3.x-inline-sizzle branch 3 times, most recently from e6a0927 to 53e16ae Compare October 11, 2022 10:54

mgol force-pushed the 3.x-inline-sizzle branch from 53e16ae to 0d52bf7 Compare November 17, 2022 13:25

mgol added 14 commits December 14, 2022 00:49

Tests: Remove unneeded selector test code triggering setDocument

e1d4783

Selector: Disable the ESLint indent rule in the ESLint config

6914c9c

That way, `/* eslint-enable */` comments won't re-enable the rule.

Tests: Make selector-native tests work again

18241d2

Backport some changes from jquerygh-5085 to make selector-native tests pass. Plus a few other fixes.

Tests: Backport a selector test fix for the Karma mode

9a29c8d

The tokenization stressor test needs to exclude `.qunit-source` or it sometimes fits into the results. This change has already landed on `main` in jquerygh-4550. Ref jquerygh-4550

Selector: Backport Sizzle.attr tests to jQuery.find.attr tests

cd5f419

This is a private API but since it's been tested in Sizzle, it makes sense to continue testing it on the jQuery 3.x line.

Tests: Move QUnit.jQuerySelectors{,Pos} definitions up

5c1f3a7

Previously, they were loaded after test files which meant top level usage was not evaluated correctly.

Build: Rename the -selector-full flag to -selector

b262d26

Selector: Fix querying on document fragments

d78dd1f

Build: Fix the include mode

d00a091

Selector: Update some selector-native comments

b900d4e

Tests: Indicate Firefox 106+ passes the cssSupportsSelector test

0715705

Firefox 106 adjusted to the spec mandating that `CSS.supports("selector(...)")` uses non-forgiving parsing which makes it pass the relevant support test. Closes jquerygh-5141 (cherry picked from commit 716130e)

mgol force-pushed the 3.x-inline-sizzle branch from 50e0086 to 0715705 Compare December 13, 2022 23:50

mgol merged commit 6306ca4 into jquery:3.x-stable Dec 14, 2022

mgol deleted the 3.x-inline-sizzle branch December 14, 2022 00:41

mgol mentioned this pull request May 29, 2023

Selector: Re-expose jQuery.find.tokenize (3.x version) #5260

Merged

3 tasks

mgol mentioned this pull request Jun 1, 2023

Selector: Re-expose jQuery.find.{tokenize,select,compile,setDocument} #5263

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Selector: Inline Sizzle into the selector module: 3.x version #5113

Selector: Inline Sizzle into the selector module: 3.x version #5113

mgol commented Sep 9, 2022 •

edited

Loading

mgol commented Sep 9, 2022 •

edited

Loading

mgol commented Sep 13, 2022

mgol commented Sep 13, 2022 •

edited

Loading

mgol commented Sep 13, 2022

mgol Sep 13, 2022

mgol commented Sep 21, 2022

mgol commented Oct 7, 2022

mgol commented Nov 17, 2022

Selector: Inline Sizzle into the selector module: 3.x version #5113

Selector: Inline Sizzle into the selector module: 3.x version #5113

Conversation

mgol commented Sep 9, 2022 • edited Loading

Summary

Checklist

mgol commented Sep 9, 2022 • edited Loading

mgol commented Sep 13, 2022

mgol commented Sep 13, 2022 • edited Loading

mgol commented Sep 13, 2022

mgol Sep 13, 2022

Choose a reason for hiding this comment

mgol commented Sep 21, 2022

mgol commented Oct 7, 2022

mgol commented Nov 17, 2022

mgol commented Sep 9, 2022 •

edited

Loading

mgol commented Sep 9, 2022 •

edited

Loading

mgol commented Sep 13, 2022 •

edited

Loading