Problem/Motivation

As mentioned in the parent issue #3238306: [META] Where possible, refactor existing jQuery uses to vanillaJS to reduce jQuery footprint, we are working towards reducing our jQuery footprint. One of the ways to accomplish this is to reduce the number of jQuery features used in Drupal core. We have added eslint rules that identify specific features and fail tests when those features are in use.

There are (or will be) individual issues for each jQuery-use eslint rule. This one is specific to jquery/no-serialize, which targets the jQuery serialize function.

Steps to reproduce

Proposed resolution

Remaining tasks

  • In core/.eslintrc.jquery.json Change "jquery/no-serialize": 0, to "jquery/no-serialize": 2, to enable eslint checks for uses of jQuery .serialize(). With this change, you'll be able to see uses of the undesirable jQuery feature by running yarn lint:core-js-passing from the core directory
  • Add the following lines to core/scripts/dev/commit-code-check.sh so the DrupalCI testing script can catch this jQuery usage on all files, not just those which have changed
    # @todo Remove the next chunk of lines before committing. This script only lints
    #  JavaScript files that have changed, so we add this to check all files for
    #  jQuery-specific lint errors.
    cd "$TOP_LEVEL/core"
    node ./node_modules/eslint/bin/eslint.js --quiet --config=.eslintrc.passing.json .
    
    CORRECTJQS=$?
    if [ "$CORRECTJQS" -ne "0" ]; then
      # No need to write any output the node command will do this for us.
      printf "${red}FAILURE ${reset}: unsupported jQuery usage. See errors above."
      STATUS=1
      FINAL_STATUS=1
    fi
    cd $TOP_LEVEL
    # @todo end lines to remove

    Add the block about 10 lines before the end of the file, just before if [[ "$FINAL_STATUS" == "1" ]] && [[ "$DRUPALCI" == "1" ]]; then, then remove it once all the jQuery uses have been refactored.

  • If it's determined to be feasible, refactor those uses of jQuery .serialize() to use Vanilla (native) JavaScript instead.

User interface changes

API changes

Data model changes

Release notes snippet

CommentFileSizeAuthor
#9 refactor-jquery-serialize-3238922-9.patch940 bytesomkar-pd

Issue fork drupal-3238922

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

hooroomoo created an issue. See original summary.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

omkar-pd made their first commit to this issue’s fork.

omkar-pd’s picture

Status: Active » Needs review

Removed uses of serialize(). The target branch needs to be changed from 9.3.x to 11.x.

omkar-pd’s picture

StatusFileSize
new940 bytes

Attaching a patch as well.

smustgrave’s picture

Status: Needs review » Needs work

MR is pointing to 9.3.x, needs to point to 11.x

FYI attaching patches + MRs is discouraged if people need an MR they can can down the diff.

Thanks!

omkar-pd’s picture

Yes, I was not able to change the target branch and also was not able to create a new branch. so added a patch.

omkar-pd’s picture

Status: Needs work » Needs review

All tests are passed for MR 5777.

Changing this to Needs Review.

smustgrave changed the visibility of the branch 3238922-refactor-if-feasible to hidden.

smustgrave’s picture

Status: Needs review » Reviewed & tested by the community

Since it's only replacing the one function, easy enough to review.

Applied the MR and submitted a node form, not sure how well to test.

  • catch committed 701a3f88 on 11.x
    Issue #3238922 by omkar-pd, hooroomoo, smustgrave: Refactor (if feasible...
catch’s picture

Status: Reviewed & tested by the community » Fixed

Committed/pushed to 11.x (which will also become 10.3.x soon), thanks!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.