AO3-7214 AO3-7215 Bookmark Javascript Improvement #5499

ReverM · 2025-12-10T04:53:41Z

Issue

https://otwarchive.atlassian.net/browse/AO3-7214
https://otwarchive.atlassian.net/browse/AO3-7215

Purpose

This adresses both tickets 7214 and 7215 by making all buttons that could edit a bookmark disappear when the form is open, by allowing a closed form to be reopened (7215) and by fixing the opening and closing of multiple forms at the same time.
7214 was fixed by removing the variables and jquerying the appropriate component each time the form is closed or reopened.
7215 was fixed by changing the href of the opening buttons as part of the closing event, as well as changing the id to a class so every element is affected at the same time.

Credit

Danaël / Rever ( they / he )

Jira account goes by Danaël Villeneuve

Changed id to class so that every button that can do one feature behaves the same and changed the organisation of the jquery

Since the new tests have been moved to their new feature file to test javascript feature these are not needed

ReverM · 2025-12-10T04:55:10Z

Appologies if having multiple ticket in one PR is bad etiquette. I decided to put both in the same PR, as they were extremely closely related, and would likely be waiting on each other if done separately.

slavalamp · 2025-12-10T18:17:40Z

yeah, putting two tickets in one pr is fine when it's exact the same fix for both

though the pr name should begin like this: "AO3-7214 AO3-7215"

ReverM · 2025-12-10T18:20:53Z

though the pr name should begin like this: "AO3-7214 AO3-7215"

Changed the PR name accordingly

sarken

Thanks for working on this! In addition to the question I left on the JavaScript file, I think you also need to changeid to class for the buttons in the bookmarkable_blurb, which is used for pages where we show multiple bookmarks under a single item, e.g., a tag's bookmark listing.

app/views/bookmarks/bookmark_form_dynamic.js.erb

…AO3-7215

ReverM · 2026-01-08T19:04:08Z

I pushed changes to the gemfile.lock by accident. Disregard the Gem Updates tag

sarken · 2026-01-12T23:53:31Z

app/views/bookmarks/bookmark_form_dynamic.js.erb


-bookmark_div.html("<%= escape_javascript(render "bookmarks/bookmark_form", :bookmarkable => @bookmarkable, :bookmark => @bookmark, :button_name => @button_name, :action => @action, :in_page => true, :dynamic => true) %>");
-bookmark_open.hide();
+if (!bookmark_div.children().length) { bookmark_div.html("<%= escape_javascript(render "bookmarks/bookmark_form", :bookmarkable => @bookmarkable, :bookmark => @bookmark, :button_name => @button_name, :action => @action, :in_page => true, :dynamic => true) %>"); }


I didn't check -- does this work with the new bookmarkable: @bookmarkable syntax? If so, it'd be nice to fix that while we're touching this line.

What exactly is this new syntax?

I think sarken is talking about the hashmap syntax? https://ruby-doc.org/core-3.1.0/Hash.html#class-Hash-label-Hash+Data+Syntax

Right. It should be possible to use the JSON-style syntax from the example in my previous comment (bookmarkable: @bookmarkable) instead of the current hash rocket syntax (:bookmarkable => @bookmarkable).

app/views/bookmarks/bookmark_form_dynamic.js.erb

config/locales/views/en.yml

sarken · 2026-01-13T05:03:12Z

features/bookmarks/bookmark_javascript.feature

+    Given a canonical fandom "The Bookmarks"
+      And the work "Bookmark: The Beginnings" by "bookmarker" with fandom "The Bookmarks"
+      And the work "Bookmark: The Sequel" by "bookmarker" with fandom "The Bookmarks"
+      And all indexing jobs have been run
+      And the dashboard counts have expired
+      And I am logged in as "bookmarker"


I think we could simplify this considerably by just logging in and creating a bookmark: we don't need a canonical fandom unless we're testing a tag bookmark page, and we don't need to update any dashboard counts because we're not testing any dashboard pages.

We only need to run the indexing jobs if we're accessing pages that rely on Elasticsearch, but we have a workaround that lets us avoid constantly having to use all indexing jobs have been run. If you check out paths.rb, you'll see a lot of this:

otwarchive/features/support/paths.rb

Lines 128 to 130 in b23fe62

when /^(.*?)(?:'s)? bookmarks page$/i

step %{all indexing jobs have been run}

user_bookmarks_path(user_id: $1)

That way, instead of running indexing and following a link on the page, we can just say When I go to username's bookmarks page. (Not every page that relies on Elasticsearch is included in paths.rb, but you're always welcome to add any you need. It makes it easier for the next person who needs to test that page.)

However, I'm not sure we need any Background here at all. The second scenario seems to be broken in production and fixed in this branch with just one bookmark, so the bookmarks created in the background steps are unnecessary.

sarken · 2026-01-13T06:25:26Z

features/bookmarks/bookmark_javascript.feature

@@ -0,0 +1,41 @@
+@bookmarks
+Feature: Edit bookmarks with javascript enabled


Since there were a lot of places id needed to become class, and some of them were hard to track down, I think we need to be a bit more thorough with these tests. They should cover all of those locations, not just a few.

3a2d58f has some tests to get started. I think the only thing that isn't covered there are the Save buttons in the bookmark and bookmarkable blurbs. Can you try adding tests for those? There might also be some tweaks you can make to the code in my commit, e.g., standardizing some variable names, removing some comments, moving the Then step definitions into the Then section of the file. (You'll also need to change "Boorkmark" to "Bookmark" once you fix the locale file -- I wanted to make sure the tests would pass, so I used the version with the typo.)

That said, I'm going to leave a couple comments on the tests you have here just to provide some information that might be helpful in the future.

sarken · 2026-01-13T06:45:03Z

features/bookmarks/bookmark_javascript.feature

+      And I bookmark the work "Bookmark: The Beginnings"
+      And I bookmark the work "Bookmark: The Sequel"
+      And all indexing jobs have been run
+    When I follow "Bookmarks"


When I go to the bookmarks page would be better here, since it includes some cache expiration we wouldn't get by just following the link:

otwarchive/features/support/paths.rb

Lines 30 to 34 in b23fe62

when /^the bookmarks page$/i

# This cached page only expires by time, not by any user action;

# just clear it every time.

Rails.cache.delete "bookmarks/index/latest/v2_true"

bookmarks_path

sarken · 2026-01-13T06:51:51Z

app/views/bookmarks/_bookmarkable_blurb.html.erb

-                    edit_bookmark_path(current_user_bookmark),
-                    id: "bookmark_form_trigger_for_#{bookmarkable.id}",
-                    remote: true %>
+        <%= link_to t(".saved"), edit_bookmark_path(current_user_bookmark), data: { path: edit_bookmark_path(current_user_bookmark) }, class: "bookmark_form_trigger_for_#{bookmarkable.id}", remote: true %>


I think the multiline format was a little easier to read, if you could keep that here. (Reviewdog might have some opinions about the indenting, though. It usually takes me a few tries to figure out exactly what it wants.)

ReverM · 2026-01-14T21:02:17Z

Gonna put this to draft while I add the rest of the test coverage.

ReverM · 2026-01-15T19:56:55Z

Some of the steps in the test are very inconsistent. I'm unsure what could be the cause. Is cucumber not the best friend with javascript? They overall seem very flaky. What could be explaining this?

ReverM · 2026-01-15T21:12:30Z

I shall put this as ready for review as I do not understand why the step fails in the test.

ReverM and others added 8 commits December 4, 2025 10:37

First batch of change

69ca95a

Changed id to class so that every button that can do one feature behaves the same and changed the organisation of the jquery

Merge branch 'otwcode:master' into AO3-7215

3af400b

Added test and translation

3f055af

Added tests

df354d9

Adressed style issues

9146e6d

Fixed translation

3678690

Remove leftover test

3affd95

Since the new tests have been moved to their new feature file to test javascript feature these are not needed

These spaces thought we wouldn't see them

dc7d11b

github-actions bot added the Awaiting Review label Dec 10, 2025

Normalizing

d2dfbd3

ReverM changed the title ~~AO3 7214 + 7215 Bookmark Javascript Improvement~~ AO3-7214 AO3-7215 Bookmark Javascript Improvement Dec 10, 2025

sarken requested changes Dec 31, 2025

View reviewed changes

app/views/bookmarks/bookmark_form_dynamic.js.erb Outdated Show resolved Hide resolved

sarken added Reviewed: Action Needed and removed Awaiting Review labels Dec 31, 2025

Changed an id to class

9c90fe5

github-actions bot added Coder Has Actioned Review and removed Reviewed: Action Needed labels Jan 1, 2026

ReverM and others added 5 commits January 1, 2026 14:08

fixed linter issue

b4bbe6e

Normalized

7a33cf6

Merge branch 'master' into AO3-7215

fff39a9

Added fix to allow right click

48127a9

Merge branch 'AO3-7215' of https://github.com/ReverM/otwarchive into …

d2bbc38

…AO3-7215

github-actions bot added the Gem Updates label Jan 8, 2026

Pushed gemfile.lock by accident

3a9a6d3

ReverM requested a review from sarken January 8, 2026 21:08

sarken removed the Gem Updates label Jan 12, 2026

sarken requested changes Jan 13, 2026

View reviewed changes

sarken added Reviewed: Action Needed and removed Coder Has Actioned Review labels Jan 13, 2026

Adding more test coverage and adressing various PR comments

e785c8c

github-actions bot added Coder Has Actioned Review and removed Reviewed: Action Needed labels Jan 14, 2026

ReverM marked this pull request as draft January 14, 2026 21:01

ReverM added 2 commits January 14, 2026 16:10

Addressing style and adding forgotten file

8b4b03c

Added test for the rest of the buttons

171167e

ReverM marked this pull request as ready for review January 15, 2026 21:12

Changed to new syntax

a2e39dc

	when /^(.*?)(?:'s)? bookmarks page$/i
	step %{all indexing jobs have been run}
	user_bookmarks_path(user_id: $1)

		@@ -0,0 +1,41 @@
		@bookmarks
		Feature: Edit bookmarks with javascript enabled

	when /^the bookmarks page$/i
	# This cached page only expires by time, not by any user action;
	# just clear it every time.
	Rails.cache.delete "bookmarks/index/latest/v2_true"
	bookmarks_path

AO3-7214 AO3-7215 Bookmark Javascript Improvement #5499

Are you sure you want to change the base?

AO3-7214 AO3-7215 Bookmark Javascript Improvement #5499

Conversation

ReverM commented Dec 10, 2025

Issue

Purpose

Credit

Uh oh!

ReverM commented Dec 10, 2025

Uh oh!

slavalamp commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ReverM commented Dec 10, 2025

Uh oh!

sarken left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ReverM commented Jan 8, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ReverM commented Jan 14, 2026

Uh oh!

ReverM commented Jan 15, 2026

Uh oh!

ReverM commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

slavalamp commented Dec 10, 2025 •

edited

Loading

ReverM commented Jan 15, 2026 •

edited

Loading