Update Data Bridge's Storybook major version from 5.3.21 to 6
Closed, ResolvedPublic5 Estimated Story Points
Actions

Description

Running npm audit in data-bridge reports 1 high vulnerability, namely Storybook being updated with a semver-major version.

Updating to Storybook 6 is not a straightforward task, as data-bridge uses the following storybook packages which also need to be updated accordingly:

"@storybook/addon-a11y": "^5.3.21",
 "@storybook/addon-actions": "^5.3.21",
 "@storybook/addon-docs": "^5.3.21",
 "@storybook/addon-knobs": "^5.3.21",
 "@storybook/addon-links": "^5.3.21",
 "@storybook/addons": "^5.3.21",
 "@storybook/vue": "^5.3.21",

As expected, there are quite a few breaking changes. Luckily the Storybook team wrote a migration guide.

Acceptance criteria ⛺✨ :

Storybook and all its packages used in data-bridge are updated to the latest major version 6
All stories look and behave as before
Optionally, the new syntax for writing stories is used instead of storiesOf(), as advised in step 3 of the migration guide, because the old way will be deprecated in version 7.
Optionally, we use Storybook Controls, “the no-code successor to Knobs”.

Details

Subject	Repo	Branch	Lines +/-
bridge: Update Storybook to v6	mediawiki/extensions/Wikibase	master	+7 K -1 K
bridge: replace knobs with controls	mediawiki/extensions/Wikibase	master	+65 -160
bridge: convert stories to Component Story Format	mediawiki/extensions/Wikibase	master	+539 -292
bridge: update to storybook 6	mediawiki/extensions/Wikibase	master	+8 K -2 K

Customize query in gerrit

Related Objects

Mentioned In: T276573: Update tainted-refs npm dependencies

Event Timeline

• Tonina_Zhelyazkova_WMDE created this task.Feb 25 2021, 2:58 PM

Restricted Application added a project: Wikidata. · View Herald TranscriptFeb 25 2021, 2:58 PM

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

• Tonina_Zhelyazkova_WMDE added a project: [DEPRECATED] wdwb-tech.Feb 26 2021, 3:59 PM

Change 667610 had a related patch set uploaded (by Lucas Werkmeister (WMDE); owner: Lucas Werkmeister (WMDE)):
[mediawiki/extensions/Wikibase@master] bridge: Update Storybook to v6

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

gerritbot added a project: Patch-For-Review.Mar 1 2021, 4:03 PM

Addshore subscribed.Mar 2 2021, 11:12 AM

Lucas_Werkmeister_WMDE updated the task description. (Show Details)Mar 2 2021, 11:16 AM

Addshore moved this task from Incoming to Prioritized Wikidata Tech Backlog (prioritised from top to bottom) on the Wikidata-Campsite board.Mar 2 2021, 12:00 PM

During polishing we realized that other storybooks in other places need updating.
@Jakob_WMDE will file tickets :)

darthmon_wmde set the point value for this task to 5.Mar 3 2021, 11:44 AM

darthmon_wmde moved this task from Prioritized Wikidata Tech Backlog (prioritised from top to bottom) to Wikidata-Campsite-Iteration-∞ (On Hold) on the Wikidata-Campsite board.

darthmon_wmde edited projects, added Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)); removed Wikidata-Campsite.

Maintenance_bot moved this task from incoming to in progress on the Wikidata board.Mar 3 2021, 12:15 PM

There is an official migration guide and an upgrade command provided to migrate from v5 to v6. For termbox the whole thing was done by running docker-compose run --rm node npx -p @storybook/cli sb upgrade without requiring any manual fixes.

Termbox patch: https://gerrit.wikimedia.org/r/c/wikibase/termbox/+/668070

Addshore moved this task from Inbox to legacy-backlog on the [DEPRECATED] wdwb-tech board.Mar 5 2021, 11:47 AM

Addshore edited projects, added [DEPRECATED] wdwb-tech (legacy-backlog); removed [DEPRECATED] wdwb-tech.

Addshore moved this task from Incoming to Active on the [DEPRECATED] wdwb-tech (legacy-backlog) board.

Jakob_WMDE mentioned this in T276573: Update tainted-refs npm dependencies.Mar 5 2021, 2:54 PM

Jakob_WMDE claimed this task.Mar 10 2021, 1:44 PM

Jakob_WMDE moved this task from To Do (prioritised from top to bottom) to Doing on the Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)) board.

Change 670511 had a related patch set uploaded (by Jakob; owner: Jakob):
[mediawiki/extensions/Wikibase@master] bridge: update to storybook 6

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

Change 671080 had a related patch set uploaded (by Jakob; owner: Jakob):
[mediawiki/extensions/Wikibase@master] bridge: convert stories to Component Story Format

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

Change 671081 had a related patch set uploaded (by Jakob; owner: Jakob):
[mediawiki/extensions/Wikibase@master] bridge: replace knobs with controls

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

Jakob_WMDE moved this task from Doing to Peer Review on the Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)) board.Mar 12 2021, 9:23 AM

Change 670511 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] bridge: update to storybook 6

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

ReleaseTaggerBot added a project: MW-1.36-notes (1.36.0-wmf.35; 2021-03-16).Mar 15 2021, 3:00 PM

Change 671080 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] bridge: convert stories to Component Story Format

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

Change 671081 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] bridge: replace knobs with controls

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

• Tonina_Zhelyazkova_WMDE moved this task from Peer Review to Test (Verification) on the Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)) board.Mar 15 2021, 4:28 PM

Addshore closed this task as Resolved.Mar 15 2021, 8:51 PM

Maintenance_bot moved this task from Test (Verification) to Done on the Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)) board.Mar 15 2021, 9:15 PM

Change 667610 abandoned by Lucas Werkmeister (WMDE):
[mediawiki/extensions/Wikibase@master] bridge: Update Storybook to v6

Reason:
superseded by Ie8dde64a28