Displays author name on merge #9920

DanielleInkster · 2024-10-01T16:23:31Z

Displaying the author’s name next to the OL...A identifier making it easier to distinguish between works by different authors.

Technical

utils.js
Added get_author_name function to fetch the name of the author associated with the id and append to the record.

AuthorRoleTable.vue
Added p tag to display authors name, as well as class to formate with CSS.

MergeTable.vue
Created enhancedRecords to include author name and added to template in order to display. Added CSS to display name next to ID.

*** I've not added enhancedRecords to the merge function in this file as I couldn't verify if this would impact what is saved when merging works. Can someone please clarify?***

Testing

Run command npm run serve --component=MergeUI.
Open merge view (http://localhost:8080/static/components/?records=OL1233242W,OL12312W)
Verify merge view now displays the author names next to the ids
Verify merging works as expected.

*** I was not able to find any JS tests for the files associated with this ticket. If needed, I can create if directed to the correct directory.***

Screenshot

Stakeholders

@cdrini

cdrini

Awesome @DanielleInkster ! A few small fixes but looking great so far 😊 Note I noticed this in my testing erroring:

https://testing.openlibrary.org/works/merge?records=OL6151392W,OL31613496W

Some sort of error is happening and only the result row is getting rendered!

cdrini · 2024-10-02T19:28:35Z

openlibrary/components/MergeUI/AuthorRoleTable.vue

                                {{role[field].key.slice("/authors/".length)}}
                            </a>
+                            <p class="author-author-children"><b>{{role[field].name}}</b></p>


Let's put this in a new <td> element so it appears as its own column on the nested author roles table.

Oh actually, if we attach the author name to entry (eg the thing that has the author field) instead of to the entry.author, it should automatically show up! That might be easier.

Eg

entry.name = author_names[entry.author.key];

instead of

entry.author.name = author_names[entry.author.key];

I'm pretty sure I understand why this should work (should be captured under the else statement) but I couldn't get the name to render without making an else-if branch for it.

cdrini · 2024-10-02T19:32:48Z

openlibrary/components/MergeUI/MergeTable.vue

+            enhanced_records.flatMap(record =>
+                record.authors.map(entry=> {


Since we're not returning anything, we can use forEach instead. Actually a for loop here might be the cleanest approach!

We can also avoid the extra loop by change the get_author_names method to return the full key with the /authors/ prefix.

Suggested change

enhanced_records.flatMap(record =>

record.authors.map(entry=> {

for (const record of enhanced_records) {

for (entry of record.authors) {

entry.author.name = author_names[entry.author.key];

}

}

cdrini · 2024-10-02T19:33:43Z

openlibrary/components/MergeUI/utils.js

+        fields: 'key,name',
+    })
+
+    const response = await fetch(`${CONFIGS.OL_BASE_BOOKS}/search/authors.json?${queryParams}`)


Suggested change

const response = await fetch(`${CONFIGS.OL_BASE_BOOKS}/search/authors.json?${queryParams}`)

const response = await fetch(`${CONFIGS.OL_BASE_SEARCH}/search/authors.json?${queryParams}`)

cdrini · 2024-10-02T19:36:07Z

openlibrary/components/MergeUI/utils.js

+
+    const response = await fetch(`${CONFIGS.OL_BASE_BOOKS}/search/authors.json?${queryParams}`)
+
+    if (!response.ok) return {error: true};


Let's have this throw a new error, and then in the place we call it, wrap the call to this method in a try catch that...

cdrini · 2024-10-02T19:36:55Z

openlibrary/components/MergeUI/MergeTable.vue

+        async enhancedRecords(){
+            if (!this.records) return null;
+
+            const author_names = await get_author_names(this.records)


...to a try catch that just returns the clone without any modifications. Otherwise an error here will cause the entire UI to fail!

cdrini · 2024-10-02T19:38:30Z

*** I've not added enhancedRecords to the merge function in this file as I couldn't verify if this would impact what is saved when merging works. Can someone please clarify?***

Yes that's exactly correct! We don't want to use enhanced_records during merging since then it'll try to save the author names in a weird place :P

codecov-commenter · 2024-10-02T19:40:35Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 17.12%. Comparing base (ce16a79) to head (2253ae3).
Report is 467 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #9920      +/-   ##
==========================================
+ Coverage   16.06%   17.12%   +1.06%     
==========================================
  Files          90       89       -1     
  Lines        4769     4752      -17     
  Branches      832      831       -1     
==========================================
+ Hits          766      814      +48     
+ Misses       3480     3428      -52     
+ Partials      523      510      -13

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

cdrini · 2024-10-02T19:46:23Z

openlibrary/components/MergeUI/MergeTable.vue

@@ -113,6 +113,26 @@ export default {
            return records;
        },

+        async enhancedRecords(){


To avoid someone in the future accidentally saving!

Suggested change

async enhancedRecords(){

/** The records, with extra helpful metadata attached for display. Should NOT be saved to Open Library */

async enhancedRecords(){

DanielleInkster · 2024-10-05T13:21:54Z

https://testing.openlibrary.org/works/merge?records=OL6151392W,OL31613496W

@cdrini - I'm not able to access this unfortunately.

github-actions bot assigned cdrini Oct 1, 2024

cdrini added the On testing.openlibrary.org This PR has been deployed to testing.openlibrary.org for testing label Oct 2, 2024

cdrini requested changes Oct 2, 2024

View reviewed changes

cdrini reviewed Oct 2, 2024

View reviewed changes

cdrini added the Needs: Submitter Input Waiting on input from the creator of the issue/pr [managed] label Oct 2, 2024

DanielleInkster added 11 commits October 4, 2024 11:56

added get_author_names function

d3b4ae5

created enhanced records

ffca512

added author name and css

e8d65a5

Added enhancedRecord to merge function

d388967

remove from enhanced records

751d83f

Update book path to search

6dc98a4

throws new error

97652c5

added comment

b79e62d

used try/catch

337c062

updated enhancedRecords to use for loop

b5e7a95

add author name as td

9474056

DanielleInkster force-pushed the 9811/feature/display-author-name-on-merge branch from 2253ae3 to 9474056 Compare October 5, 2024 13:18

github-actions bot removed the Needs: Submitter Input Waiting on input from the creator of the issue/pr [managed] label Oct 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Displays author name on merge #9920

Displays author name on merge #9920

DanielleInkster commented Oct 1, 2024 •

edited

Loading

cdrini left a comment

cdrini Oct 2, 2024

cdrini Oct 2, 2024

cdrini Oct 2, 2024

DanielleInkster Oct 5, 2024

cdrini Oct 2, 2024 •

edited

Loading

cdrini Oct 2, 2024

cdrini Oct 2, 2024

cdrini Oct 2, 2024

cdrini commented Oct 2, 2024

codecov-commenter commented Oct 2, 2024

cdrini Oct 2, 2024 •

edited

Loading

DanielleInkster commented Oct 5, 2024

		enhanced_records.flatMap(record =>
		record.authors.map(entry=> {

-            enhanced_records.flatMap(record =>
-                record.authors.map(entry=> {
+            for (const record of enhanced_records) {
+                for (entry of record.authors) {
+                    entry.author.name = author_names[entry.author.key];
+                }
+            }

	const response = await fetch(`${CONFIGS.OL_BASE_BOOKS}/search/authors.json?${queryParams}`)
	const response = await fetch(`${CONFIGS.OL_BASE_SEARCH}/search/authors.json?${queryParams}`)


		const response = await fetch(`${CONFIGS.OL_BASE_BOOKS}/search/authors.json?${queryParams}`)

		if (!response.ok) return {error: true};

	async enhancedRecords(){
	/** The records, with extra helpful metadata attached for display. Should NOT be saved to Open Library */
	async enhancedRecords(){

Displays author name on merge #9920

Are you sure you want to change the base?

Displays author name on merge #9920

Conversation

DanielleInkster commented Oct 1, 2024 • edited Loading

Technical

Testing

Screenshot

Stakeholders

cdrini left a comment

Choose a reason for hiding this comment

cdrini Oct 2, 2024

Choose a reason for hiding this comment

cdrini Oct 2, 2024

Choose a reason for hiding this comment

cdrini Oct 2, 2024

Choose a reason for hiding this comment

DanielleInkster Oct 5, 2024

Choose a reason for hiding this comment

cdrini Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

cdrini Oct 2, 2024

Choose a reason for hiding this comment

cdrini Oct 2, 2024

Choose a reason for hiding this comment

cdrini Oct 2, 2024

Choose a reason for hiding this comment

cdrini commented Oct 2, 2024

codecov-commenter commented Oct 2, 2024

Codecov Report

cdrini Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

DanielleInkster commented Oct 5, 2024

DanielleInkster commented Oct 1, 2024 •

edited

Loading

cdrini Oct 2, 2024 •

edited

Loading

cdrini Oct 2, 2024 •

edited

Loading