Refactor Edges search interfaces: remove $.extend usage and extract reusable URL utility by varadekd · Pull Request #2562 · DOAJ/doaj

varadekd · 2026-03-09T10:01:06Z

Issue:

Refactor Edges search interfaces: remove $.extend usage and extract reusable URL utility

This change performs a small refactor of the Edges search interface code under /portality/static/js/edges/ to reduce duplicated infrastructure logic. The previous $.extend(true, doaj, {...}) pattern used to attach namespaces has been replaced with direct namespace assignments, as deep merge behaviour was not required. In addition, repeated URL construction logic (deriving scheme and host to build the search URL) has been extracted into a shared utility (doaj.edgeUtil.url.build). This keeps the search files focused on defining search behaviour while moving common infrastructure code into a reusable location. No functional behaviour has been changed; this update only improves code clarity and maintainability.

This PR...

Developer Checklist

Developers should review and confirm each of these items before requesting review

Code meets acceptance criteria from issue
Unit tests are written and all pass
User Test Scripts (if required) are written and have been run through
Project's coding standards are met
- No deprecated methods are used
- No magic strings/numbers - all strings are in constants or messages files
- ES queries are wrapped in a Query object rather than inlined in the code
- Where possible our common library functions have been used (e.g. dates manipulated via dates)
- Cleaned up commented out code, etc
- Urls are constructed with url_for not hard-coded
Code documentation and related non-code documentation has all been updated
- Core model documentation has been added to if needed: https://docs.google.com/spreadsheets/d/1lun2S9vwGbyfy3WjIjgXBm05D-3wWDZ4bp8xiIYfImM/edit
- Events and consumers documentation has been added if needed: https://docs.google.com/spreadsheets/d/1oIeG5vg-blm2MZCE-7YhwulUlSz6TOUeY8jAftdP9JE/edit
Migation has been created and tested
There is a recent merge from develop

Reviewer Checklist

Reviewers should review and confirm each of these items before approval
If there are multiple reviewers, this section should be duplicated for each reviewer

Code meets acceptance criteria from issue
Unit tests are written and all pass
User Test Scripts (if required) are written and have been run through
Project's coding standards are met
- No deprecated methods are used
- No magic strings/numbers - all strings are in constants or messages files
- ES queries are wrapped in a Query object rather than inlined in the code
- Where possible our common library functions have been used (e.g. dates manipulated via dates)
- Cleaned up commented out code, etc
- Urls are constructed with url_for not hard-coded
Code documentation and related non-code documentation has all been updated
- Core model documentation has been added to if needed: https://docs.google.com/spreadsheets/d/1lun2S9vwGbyfy3WjIjgXBm05D-3wWDZ4bp8xiIYfImM/edit
- Events and consumers documentation has been added if needed: https://docs.google.com/spreadsheets/d/1oIeG5vg-blm2MZCE-7YhwulUlSz6TOUeY8jAftdP9JE/edit
Migation has been created and tested
There is a recent merge from develop

Testing

List user test scripts that need to be run

List any non-unit test scripts that need to be run by reviewers

Deployment

What deployment considerations are there? (delete any sections you don't need)

Configuration changes

What configuration changes are included in this PR, and do we need to set specific values for production

Scripts

What scripts need to be run from the PR (e.g. if this is a report generating feature), and when (once, regularly, etc).

Migrations

What migrations need to be run to deploy this

Monitoring

What additional monitoring is required of the application as a result of this feature

New Infrastructure

What new infrastructure does this PR require (e.g. new services that need to run on the back-end).

Continuous Integration

What CI changes are required for this

richard-jones

A couple of changes to get this to a mergeable state:

Could you just put the url.js functions into the main doaj.js library? That's used everywhere, and I could see these functions being useful in other places.
The search object searches don't seem to be wired in. Could you add an admin view route (in view/admin.py) for each one and serve the page with the appropriate search initialised. They should also be added to the "System Objects" navigation entry in the admin area.

Could you also make sure to run over all the interfaces and do a side-by-side comparison with the live interfaces to make sure we haven't lost any functionality by accident. Particularly we should focus on the public views.

@usman-cottagelabs maybe this is a good place to bring you in too, to review the functionality? I'll assign you to the issue and add some notes.

usman-cottagelabs · 2026-04-23T10:49:12Z

Open Requirement in TestQuality

Test Test Admin Application Search Interactions.
Test Test Admin Application Search Display.
Test Test Admin Background Jobs Search Interactions.
Test Test Editor Groups Search Interactions.
Test Test Restrict editing group name.
Test Test New Editor Group Form.
Test Test Admin Journal Search Interactions.
Test Test Admin Journal Search Display.
Test Test notes searchable for admin and not for public.
Test Test notes not searchable for public.
Test Test notes searchable for Editor.
Test Test notes searchable for Associate Editor.
Test Test notes not searchable for fixed query widget (joint journal/article search).
Test Test Admin Journals and Articles Search Interactions.
Test Test Admin Articles Search Display.
Test Test Admin Journals Search Display.
Test Test Admin Users Search Interactions.
Test Test Admin Users Search Display.
Test Test Associate Application Search.
Test Test Associate Journal Search Interactions.
Test Bulk Edit General + Status Change.
Test Assign to Editor Group.
Test Add a note.
Test Bulk Edit General.
Test Withdraw from DOAJ.
Test Reinstate into DOAJ.
Test Journal: edit metadata....
Test Journal: Assign to editor group.
Test Journal: Add a note.
Test Journal: Delete records.
Test Test Editors Application Search.
Test Test Editors Journal Search.
Test Test Admin Journal Search Display.
Test Launching off from Home Page.
Test Skip to main content button (Accessibility).
Test Test minisearch section.
Test Test Public Search Interactions.
Test Test Public Search Results Display: Journals.
Test Test Public Search Results Display: Articles.
Test Test Public Search Results Display: Accessibility.
Test Export article in RIS format.
Test Test Public Search Ascii Folding: Articles/Journals.
Test Test Exploring the Subject Tree.
Test Multiple Subject Selection.
Test Search for an entry.
Test Test Correctly Displayed Discontinued Date.
Test Test articles journal's page.
Test Journal with Last Full Review date.
Test Test Publisher Journal Search Interactions.
Test Test Publisher Journal Search Display.
Test Test Publisher Update Request Search Interactions.
Test Test Admin Application Search Display.

usman-cottagelabs · 2026-04-23T15:10:26Z

Open Defect in TestQuality

Test Test Admin Application Search Interactions in Run PR2562 Run 1 (linked to Cycle All tests).

usman-cottagelabs · 2026-04-23T15:21:57Z

@varadekd bug found:
Precondition
User Role: admin

Steps to Reproduce:
Step 1
Go to the DOAJ admin applications search at /admin/applications

Step 2
Change the search results dropdown from 10 to 25

Step 3
Attempt to change it back to 10

Expected Result
All the options should always be displayed

Actual Result
The option for 10 disappears

See recording attached.
Screen Recording 2026-04-23 155707.mp4

Note: This works fine on the Prod site

This also isn't working on /search/journals
Screen Recording 2026-04-28 161433.mp4

usman-cottagelabs · 2026-04-27T10:17:51Z

@varadekd bug found:

Precondition

User Role: admin

Steps to Reproduce:

Step 1

Go to the DOAJ admin application search at /admin/applications

Step 2

Filter for Rejected

Step 3

Click View Application button within a rejected Journal

Expected Result

In the Notes section on the RHS, There should a note attached to the record which indicates that the record was rejected

Actual Result

No note indicting this

Recording

Screen Recording 2026-04-27 110800.mp4

Note

I have checked Prod site, and it does show this note:

usman-cottagelabs · 2026-04-28T09:55:01Z

@varadekd a high priority bug found:

Precondition

User Role: admin

Steps to Reproduce:

Step 1

Go to the DOAJ admin users search at /account

Expected Result

Data should show, and search/filter functionality etc

Actual Result

Nothing shows

Screenshot

varadekd · 2026-05-06T03:11:37Z

UPDATE:
Not a bug. Was a data issue that caused this most likely.

@varadekd bug found:

Precondition

User Role: admin

Steps to Reproduce:

Step 1

Go to the DOAJ admin application search at /admin/applications

Step 2

Filter for Rejected

Step 3

Click View Application button within a rejected Journal

Expected Result

In the Notes section on the RHS, There should a note attached to the record which indicates that the record was rejected

Actual Result

No note indicting this

Recording

Screen Recording 2026-04-27 110800.mp4

Note

I have checked Prod site, and it does show this note:

Hi @usman-cottagelabs
I will verify this on https://latest.doaj.cottagelabs.com/ since on my local I am able to see this

usman-cottagelabs · 2026-05-06T11:39:39Z

Thanks @varadekd
Let me know when all bugs are fixed, and i can retest them in 1 go.

varadekd · 2026-06-02T07:20:43Z

Thanks @varadekd Let me know when all bugs are fixed, and i can retest them in 1 go.

@usman-cottagelabs All the valid changes are pushed under the branch feature/4185_code_refactor. You can go ahead with your testing

usman-cottagelabs · 2026-06-02T10:19:45Z

@varadekd bug found: Precondition User Role: admin

Steps to Reproduce: Step 1 Go to the DOAJ admin applications search at /admin/applications

Step 2 Change the search results dropdown from 10 to 25

Step 3 Attempt to change it back to 10

Expected Result All the options should always be displayed

Actual Result The option for 10 disappears

See recording attached. Screen Recording 2026-04-23 155707.mp4

Note: This works fine on the Prod site

This also isn't working on /search/journals Screen Recording 2026-04-28 161433.mp4

Bug fixed

usman-cottagelabs · 2026-06-02T10:20:12Z

@varadekd a high priority bug found:

Precondition

User Role: admin

Steps to Reproduce:

Step 1

Go to the DOAJ admin users search at /account

Expected Result

Data should show, and search/filter functionality etc

Actual Result

Nothing shows

Screenshot

Bug fixed

usman-cottagelabs · 2026-06-02T14:54:53Z

Testing complete. @varadekd

varadekd added 30 commits March 2, 2026 11:49

Alert is moved from $.extend to proper function

265a3a0

admin-application moved from $.extend

ff8591c

autoassign moved from $.extend

93742c9

admin.journal moved from $.extend

037d040

admin.users moved from $.extend

6ddc47a

admin.background moved from $.extend

20fae5d

admin.editor moved from $.extend

cc968cd

admin.journalarticle moved from $.extend

e4a7cbb

admin.notification moved from $.extend

3dfa03e

admin.reports moved from $.extend

c65b296

admin.reports moved from $.extend

69593a9

admin.ris moved from $.extend

fa86fd8

admin.update_request moved from $.extend

b9f1a91

associate files moved from $.extend

3378f6a

associate files moved from $.extend

1d67879

editor.groupapp files moved from $.extend

522c905

editor.groupjournal files moved from $.extend

8f5bad7

notification moved from $.extend

6005f5a

public.article is moved from $.extend

ac07fff

public.journal is moved from $.extend

59e063f

public.toc is moved from $.extend

19bc5fa

publisher.journal is moved from $.extend

cddd064

publisher.mydraft is moved from $.extend

2df6887

pub.update_req is moved from $.extend

45ff7fd

Moved search build url to a factory

9bf1edf

Moved search build url to a factory

8577158

Moved admin.application to search build url to a factory

c7c71ec

Moved admin.autoassign to search build url to a factory

7d819dc

search_url for admin.background moved to factory

d72c115

search_url for admin.editor moved to factory

f13216a

Merge branch 'develop' into feature/4185_code_refactor

17d20ae

richard-jones requested changes Apr 16, 2026

View reviewed changes

varadekd added 2 commits April 17, 2026 11:48

Moved url to doaj.builUrl

b83dfb5

Moved url to doaj.builUrl and system objects added

064f70b

usman-cottagelabs added requirement TestQuality bug labels Apr 23, 2026 — with TestQuality App

usman-cottagelabs changed the title ~~Refactor Edges search interfaces: remove $.extend usage and extract reusable URL utility~~ Results per page dropdown not working as expected Apr 23, 2026

usman-cottagelabs assigned varadekd Apr 23, 2026

usman-cottagelabs added Medium bug and removed bug requirement TestQuality labels Apr 23, 2026 — with TestQuality App

usman-cottagelabs removed the bug label Apr 27, 2026

usman-cottagelabs changed the title ~~Results per page dropdown not working as expected~~ Refactor Edges search interfaces: remove $.extend usage and extract reusable URL utility Apr 27, 2026

varadekd added 3 commits May 6, 2026 07:21

10 entries per page option went missing handled

f114c22

Handled the users list not shown issue

5445efd

Enteries per page handled for users, editors

cd2a98c

Uh oh!

Conversation

varadekd commented Mar 9, 2026 • edited by usman-cottagelabs Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!