Page MenuHomePhabricator
Create Task
Maniphest T184251

Upgrade Select2 in Page Forms (was formerly: Upgrade JS libraries included in Page Forms)
Closed, ResolvedPublic
Actions

Description

The Page Forms extension includes a number of JavaScript libraries, and all of them are at least somewhat in need of upgrading. In some cases, the library being used is already defunct and needs to be replaced altogether.

The JS libraries used by Page Forms, and the version being used of each one, are:

  • FancyBox - version being used is from 2010 (has been replaced by fancyBox3, which is apparently a separate library) (this was done)
  • Select2 - version being used is from 2014
  • Dynatree - version used is from 2013 (has been replaced by Fancytree - http://wwwendt.de/tech/fancytree/demo/) (this was done)
  • RateYo! - version is from 2014 (this was done)
  • jsGrid - version is from 2016 (no point)

jsGrid is probably not worth upgrading at the moment, because it's still fairly recent, and Page Forms' version of it has some customizations. But the others should all get upgraded.

In MediaWiki 1.30, the version of jQuery bundled in with MediaWiki jumped from 1.11 to 3 - and when jQuery 3 is used, it leads to JS warnings for at least Dynatree and RateYo!, and possibly some of these other libraries. Additionally, there are probably useful features and bug fixes that have gone into these libraries in the intervening years.

Update from 2020: there is now a plan to replace jsGrid altogether (see T241632), so it doesn't make sense to upgrade it.

Details

SubjectRepoBranchLines +/-
Upgrade Select2mediawiki/extensions/PageFormsmaster+7 K -4 K
Upgrade select2.js in Page Formsmediawiki/extensions/PageFormsmaster+7 K -3 K
Upgrade FancyBox library to fancyBox3mediawiki/extensions/PageFormsmaster+5 K -1 K
Customize query in gerrit

Related Objects
Search...

Event Timeline

Yaron_Koren created this task.Jan 5 2018, 4:42 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJan 5 2018, 4:42 AM
Fz-29 subscribed.Jan 5 2018, 10:06 AM
xSavitar awarded a token.Jan 5 2018, 4:22 PM
xSavitar subscribed.
Fz-29 added a subtask: T184348: Upgrade Rate Yo (JS library) included in Page Forms.Jan 6 2018, 6:06 PM
Himanshuc3 subscribed.Jan 9 2018, 8:31 PM

I would update the libraries and see if any breaks happen.

Fz-29 added a comment.Jan 10 2018, 4:27 AM
This comment was removed by Fz-29.
Himanshuc3 added a comment.Jan 10 2018, 4:35 AM

Got it. Just didn't had a GCI tag, so thought why not.

Fz-29 added a comment.Jan 10 2018, 4:38 AM

Yeah, sure. I'm sorry, I got a bit confused. I thought your comment was on its subtask.

Yaron_Koren closed subtask T184348: Upgrade Rate Yo (JS library) included in Page Forms as Resolved.Feb 13 2018, 4:54 PM
Yaron_Koren updated the task description. (Show Details)
yashdeep97 subscribed.Feb 16 2018, 7:20 PM

Could bower be used as a package manager to take care of the JS libraries included in Page Forms ?

Yaron_Koren added a comment.Feb 16 2018, 9:08 PM

Do you mean, require everyone installing Page Forms to use Bower to also install the necessary JS files?

yashdeep97 added a comment.Feb 17 2018, 4:46 AM

Thinking about it, yes it would complicate the installation process. I guess it's better not to use bower.

Yaron_Koren mentioned this in T188414: Replace Dynatree JS library with Fancytree in Page Forms.Feb 27 2018, 5:47 PM
yashdeep97 added a comment.Mar 8 2018, 4:28 AM

Can I take up this task to upgrade the libraries?

Yaron_Koren added a comment.Mar 8 2018, 5:16 AM

@yashdeep97 - well, someone's already working on the Dynatree one, and jsGrid probably isn't worth doing, so that just leaves Select2 and FancyBox. I looked into Select2 at some point and I think it might be quite challenging. But the FancyBox upgrade may be doable. Sure, feel free to take it if you're interested.

yashdeep97 claimed this task.Mar 8 2018, 10:47 AM

@Yaron_Koren - Thanks! I'll work on the FancyBox upgrade then.

gerritbot subscribed.Mar 11 2018, 7:35 PM

Change 418734 had a related patch set uploaded (by Yashdeep97; owner: Yashdeep97):
[mediawiki/extensions/PageForms@master] Upgrade FancyBox library to fancyBox3

https://gerrit.wikimedia.org/r/418734

gerritbot added a project: Patch-For-Review.Mar 11 2018, 7:35 PM
yashdeep97 mentioned this in rEPFM344e6fcd6d0c: Upgrade FancyBox library to fancyBox3.Mar 11 2018, 7:36 PM
Yaron_Koren mentioned this in rEPFMb1bb7e8bd808: Upgrade FancyBox library to fancyBox3.Mar 11 2018, 10:46 PM
gerritbot added a comment.Mar 11 2018, 10:51 PM

Change 418734 merged by jenkins-bot:
[mediawiki/extensions/PageForms@master] Upgrade FancyBox library to fancyBox3

https://gerrit.wikimedia.org/r/418734

Yaron_Koren removed yashdeep97 as the assignee of this task.Mar 11 2018, 11:00 PM
Yaron_Koren updated the task description. (Show Details)
Yaron_Koren updated the task description. (Show Details)
Yaron_Koren added a comment.Mar 11 2018, 11:19 PM

The FancyBox upgrade has now been done, thanks to a patch from @yashdeep97, and there's also a patch in place for the Dynatree/Fancytree upgrade (https://gerrit.wikimedia.org/r/#/c/416920/), though it needs a little work. So the only upgrade really left to do is the Select2 one, and, as noted before, that's the hardest one. Still, this has been great progress.

yashdeep97 mentioned this in T189743: GSoC 2018 Proposal: Add a spreadsheet interface for modifying multiple pages to the Page Forms extension.Mar 14 2018, 8:50 PM
Yaron_Koren updated the task description. (Show Details)Jan 9 2019, 1:22 AM
Yaron_Koren updated the task description. (Show Details)
Yaron_Koren renamed this task from Upgrade JS libraries included in Page Forms to Upgrade Select2 in Page Forms (was formerly: Upgrade JS libraries included in Page Forms).Feb 11 2019, 3:22 PM
Maintenance_bot removed a project: Patch-For-Review.May 22 2019, 2:56 PM
Krabina subscribed.Jul 29 2019, 9:42 AM
Krabina added a comment.Jul 29 2019, 9:47 AM

I guess the following problem is related to this:

When you use the filtered format in SMW which uses a newer version of select2, you cannot have a #forminput: call on the same page where the filtered format is used. What happens is that the token-filters of the filtered format are broken as long as the forminput call is on the same page. If you remove it from the page, the token-filters work again.

Krabina added a comment.Feb 18 2020, 12:46 PM

any plans to upgrade the select2 library?

Yaron_Koren added a comment.Feb 18 2020, 2:33 PM

Not any immediate plans, but I do still want to get this done, yes.

Yaron_Koren updated the task description. (Show Details)Feb 18 2020, 9:58 PM
priyanshu_varshney subscribed.Feb 28 2020, 1:27 PM
gerritbot added a comment.Apr 14 2020, 5:40 PM

Change 588761 had a related patch set uploaded (by Priyanshu varshney; owner: priyanshu-3390):
[mediawiki/extensions/PageForms@master] Upgrade select2.js in Page Forms

https://gerrit.wikimedia.org/r/588761

gerritbot added a project: Patch-For-Review.Apr 14 2020, 5:40 PM
Krabina added a comment.Apr 15 2020, 7:30 AM

Great, I can confirm that this patch works in my wikis. Now a #forminput call on the same page as as filtered result format are working (before that, the tokens input in the filtered result format was broken if both were present on the same page)!
Thank you!

Yaron_Koren added a comment.Apr 15 2020, 12:56 PM

@Krabina - that's great to hear! This patch isn't quite ready for merging in yet, but it's very good to know that it's working for you already.

gerritbot added a comment.Apr 15 2020, 6:02 PM

Change 589077 had a related patch set uploaded (by Priyanshu varshney; owner: priyanshu-3390):
[mediawiki/extensions/PageForms@master] Upgrade select2.js in Page Forms

https://gerrit.wikimedia.org/r/589077

gerritbot added a comment.Apr 15 2020, 6:09 PM

Change 588761 abandoned by Priyanshu varshney:
Upgrade select2.js in Page Forms

Reason:
New patch has been uploaded with more code on behalf.

https://gerrit.wikimedia.org/r/588761

Krabina added a comment.Apr 16 2020, 1:47 PM

What I realized with the initial patch: the tokens input was broken in query forms. So this is something to consider. I moved back to master and token inputs in query forms worked again.

Yaron_Koren added a comment.Apr 16 2020, 2:11 PM

What do you mean by "broken"?

Krabina added a comment.Apr 16 2020, 2:16 PM

It showed a much smaller field, you could not click on it and select existing values (none where shown) or add new values.

Yaron_Koren added a comment.Apr 17 2020, 8:35 PM

@Krabina - could you try the latest patch (https://gerrit.wikimedia.org/r/#/c/mediawiki/extensions/PageForms/+/589077/) and see if it's fully working for you?

Krabina added a comment.Apr 22 2020, 1:37 PM

yes, this is looking very good!

gerritbot added a comment.Apr 22 2020, 5:24 PM

Change 589077 merged by jenkins-bot:
[mediawiki/extensions/PageForms@master] Upgrade Select2

https://gerrit.wikimedia.org/r/589077

Yaron_Koren mentioned this in rEPFMd5c5194107ef: Upgrade Select2.Apr 22 2020, 5:25 PM
Yaron_Koren closed this task as Resolved.Apr 22 2020, 5:38 PM
Yaron_Koren claimed this task.

@Krabina - that's great to hear. The patch (by @priyanshu_varshney) has been merged in.

After 2 1/2 years, I'm excited to finally close this task!

Maintenance_bot removed a project: Patch-For-Review.Apr 22 2020, 6:10 PM
MarkAHershberger mentioned this in T256063: PageForms: "values dependent on" in PFFormField uses the wrong name.Jun 22 2020, 9:01 PM
MarkAHershberger mentioned this in T256149: PageForms: token list is appending instead of replacing the contents of updated "is dependent on".Jun 23 2020, 5:58 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits