Remove unused performance metrics from Vector search instrumentation.js and mediawiki.page.ready
Closed, ResolvedPublic2 Estimated Story Points
Actions

Assigned To

Authored By

	KSarabia-WMF
	Nov 14 2024, 1:26 AM

Description

Background

Remove unused code from instrumentation.js in Vector 22 to simplify maintenance and improve performance. We are logging multiple events against the event platform for every search that we never use. This is requiring unnecessary additional processing and downloaded bytes for the user.

The removal here has no visible impact on end users, but it'll make future updates easier for developers.

instrumentation.js

User Story

As a developer, I want to remove unused code from instrumentation.js, so that the file is cleaner and easier to work with.

Identify and remove unused code from instrumentation.js.
Ensure no other parts of the app are broken after removal.
Test to confirm everything works as expected.
Update docs if needed.

Requirement

Remove unused performance metrics from instrumentation.js in Vector 2022 and mediawiki.page.ready to simplify maintenance and improve performance. Ensure that this removal does not break existing functionality or impact other parts of the application.

BDD

Feature: Remove unused performance metrics from Vector search instrumentation.js  

  Scenario: Search functionality with unused performance metrics removed  
    Given I am on the beta site  
    When I perform a search using Vector 2022 skin  
    Then the search results should appear correctly  
    And I should be able to navigate to a page without errors in the developer console

Test Steps

Test Case 1: Verify Search Functionality in Vector 2022 After Code Removal

Visit https://en.wikipedia.beta.wmflabs.org/w/index.php?title=T352930.
Perform a search for any valid term in the search bar.
✅ AC1: Confirm that the search results appear correctly and allow navigation to a page.
Open the browser’s developer console.
✅ AC2: Ensure no errors are logged in the console during the search workflow.

Test Case 2: Verify Search Functionality in Vector Skin

Visit https://en.wikipedia.beta.wmflabs.org/w/index.php?title=T352930&useskin=vector.
Perform a search for any valid term in the search bar.
✅ AC3: Confirm that the search results appear correctly and allow navigation to a page.
Open the browser’s developer console.
✅ AC4: Ensure no errors are logged in the console during the search workflow.

Acceptance Criteria

The code in mediawiki.page.ready is removed: https://gerrit.wikimedia.org/r/c/mediawiki/core/ /1088636/4/resources/src/mediawiki.page.ready/ready.js#b243
the code in Vevtor instrumentation.js is removed

Unused code is removed.
Everything still works.
No regressions.

QA

Visit https://en.wikipedia.beta.wmflabs.org/w/index.php?title=T352930 and perform a search. You should be able to find a page and navigate to a page without seeing any errors in the developer console.
Visit https://en.wikipedia.beta.wmflabs.org/w/index.php?title=T352930&useskin=vector and perform a search. You should be able to find a page and navigate to a page without seeing any errors in the developer console.

QA Results - Beta

AC	Status	Details
1	✅	T379861#10382091
2	✅	T379861#10382091
3	✅	T379861#10382091
4	✅	T379861#10382091

Details

Subject	Repo	Branch	Lines /-
Address searchbar bug in App.vue	mediawiki/skins/Vector	master	0 -1
Remove performance tracking for search	mediawiki/core	master	5 -65
Remove unused performance metrics	mediawiki/skins/Vector	master	1 -63

Customize query in gerrit

Related Objects

Mentioned In: T381356: Verify 1.44.0-wmf.8 deployment
T378101: [Spike] Decide where recommendations code should live

Event Timeline

KSarabia-WMF created this task.Nov 14 2024, 1:26 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptNov 14 2024, 1:26 AM

KSarabia-WMF renamed this task from Web Task Creation Form to Clean up instrumentation.js .Nov 14 2024, 1:26 AM

Reedy renamed this task from Clean up instrumentation.js to Clean up instrumentation.js.Nov 14 2024, 1:41 AM

Jdlrobson renamed this task from Clean up instrumentation.js to Remove unused performance metrics from Vector search instrumentation.js.Nov 15 2024, 1:47 AM

Jdlrobson moved this task from Backlog to Use the same search UI in mobile and desktop on the Web Team Essential Work 2024 board.

Jdlrobson edited projects, added Web Team Essential Work 2024 (Use the same search UI in mobile and desktop); removed Web Team Essential Work 2024.

Jdlrobson triaged this task as Medium priority.Nov 19 2024, 10:18 PM

Jdlrobson mentioned this in T378101: [Spike] Decide where recommendations code should live.Nov 20 2024, 10:44 PM

Jdlrobson moved this task from Backlog to Cleanup Typeahead Search in Vector on the Web Team Essential Work 2024 (Use the same search UI in mobile and desktop) board.Nov 21 2024, 4:37 PM

Jdlrobson renamed this task from Remove unused performance metrics from Vector search instrumentation.js to Remove unused performance metrics from Vector search instrumentation.js and mediawiki.page.ready.Nov 21 2024, 4:48 PM

Jdlrobson updated the task description. (Show Details)

Jdlrobson set the point value for this task to 2.Nov 21 2024, 5:30 PM

Jdlrobson added a project: Web-Team.Tue, Nov 26, 11:43 PM

Jdlrobson updated the task description. (Show Details)

Jdlrobson moved this task from Product Backlog to Sprint Backlog on the Web-Team board.

SToyofuku-WMF moved this task from Sprint Backlog to FY2024-25 Q2 Sprint 5 (Dec 2 - Dec 13, 2024) on the Web-Team board.Mon, Dec 2, 7:15 PM

SToyofuku-WMF edited projects, added Web-Team ( FY2024-25 Q2 Sprint 5 (Dec 2 - Dec 13, 2024)); removed Web-Team.

KSarabia-WMF claimed this task.Mon, Dec 2, 8:30 PM

KSarabia-WMF moved this task from Ready for Development to In Progress on the Web-Team ( FY2024-25 Q2 Sprint 5 (Dec 2 - Dec 13, 2024)) board.

Change #1100145 had a related patch set uploaded (by Kimberly Sarabia; author: Kimberly Sarabia):

[mediawiki/skins/Vector@master] Remove unused performance metrics

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

gerritbot added a project: Patch-For-Review.Tue, Dec 3, 3:58 PM

SToyofuku-WMF reassigned this task from KSarabia-WMF to Jdlrobson.Tue, Dec 3, 4:58 PM

Change #1100182 had a related patch set uploaded (by Kimberly Sarabia; author: Kimberly Sarabia):

[mediawiki/core@master] Remove performance tracking for search

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

Change #1100182 merged by jenkins-bot:

[mediawiki/core@master] Remove performance tracking for search

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

Change #1100145 merged by jenkins-bot:

[mediawiki/skins/Vector@master] Remove unused performance metrics

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

Maintenance_bot removed a project: Patch-For-Review.Wed, Dec 4, 9:31 AM

ReleaseTaggerBot added a project: MW-1.44-notes (1.44.0-wmf.8; 2024-12-17).Wed, Dec 4, 10:00 AM

QA would likely be ensuring search is still working on the beta cluster

jk search is broken Jon to leave comment @Jdlrobson @Jdlrobson-WMF

There was a small mistake in https://gerrit.wikimedia.org/r/1100145, search is now throwing the following error. Passing back to @KSarabia-WMF to fix:

TypeError: instrumentation.listeners.onFetchStart is not a function
    at Proxy.updateUIWithSearchClientResult (App.vue:165:30)
    at Proxy.onInput (App.vue:130:9)
    at jt (vue.js:7:16029)
    at Ht (vue.js:7:16099)
    at un (vue.js:7:18093)
    at c (CdxTypeaheadSearch.cjs:1:2561)
    at eval (CdxTypeaheadSearch.cjs:1:2599)

Change #1100518 had a related patch set uploaded (by Kimberly Sarabia; author: Kimberly Sarabia):

[mediawiki/skins/Vector@master] Searchbar bug

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

gerritbot added a project: Patch-For-Review.Wed, Dec 4, 6:28 PM

Change #1100518 merged by jenkins-bot:

[mediawiki/skins/Vector@master] Address searchbar bug in App.vue

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

Jdlrobson reassigned this task from KSarabia-WMF to GMikesell-WMF.Wed, Dec 4, 7:23 PM

Jdlrobson updated the task description. (Show Details)

Maintenance_bot removed a project: Patch-For-Review.Wed, Dec 4, 7:31 PM

Edtadros claimed this task.Wed, Dec 4, 9:29 PM

Edtadros updated the task description. (Show Details)

Test Result - Beta

Status: ✅ PASS
Environment: Beta
OS: macOS
Browser: Chrome
Device: MS
Emulated Device: NA

Test Artifact(s):

Test Steps

Test Case 1: Verify Search Functionality in Vector 2022 After Code Removal

Visit https://en.wikipedia.beta.wmflabs.org/w/index.php?title=T352930.
Perform a search for any valid term in the search bar.
✅ AC1: Confirm that the search results appear correctly and allow navigation to a page.

See AC2.

Open the browser’s developer console.
✅ AC2: Ensure no errors are logged in the console during the search workflow.

Test Case 2: Verify Search Functionality in Vector Skin

Visit https://en.wikipedia.beta.wmflabs.org/w/index.php?title=T352930&useskin=vector.
Perform a search for any valid term in the search bar.
✅AC3: Confirm that the search results appear correctly and allow navigation to a page.

See AC4.