Fix BB-768 : Unset Author Credit leads to bugs

package.json

@@ -28,7 +28,7 @@
   },
   "browserslist": "> 0.25%, not dead",
   "overrides": {
-    "react-select-fast-filter-options":{
+    "react-select-fast-filter-options": {
       "react-select": "$react-select"
     }
   },
@@ -41,7 +41,7 @@
     "@fortawesome/free-solid-svg-icons": "^6.4.2",
     "@fortawesome/react-fontawesome": "^0.1.11",
     "array-move": "^3.0.1",
-    "bookbrainz-data": "^5.0.0",
+    "bookbrainz-data": "5.1.1",
     "chart.js": "^2.9.4",
     "chartjs-adapter-date-fns": "^1.0.0",
     "classnames": "^2.3.2",

sql/migrations/2024-02-07-credit-section/down.sql

@@ -0,0 +1,42 @@
+BEGIN TRANSACTION;
+
+ALTER TABLE bookbrainz.edition_data DROP COLUMN credit_section;
+ALTER TABLE bookbrainz.edition_group_data DROP COLUMN credit_section;
+
+-- Drop the existing view if it exists
+DROP VIEW IF EXISTS 
+    bookbrainz.edition,
+    bookbrainz.edition_group;
+
+CREATE VIEW bookbrainz.edition AS
+	SELECT
+		e.bbid, edd.id AS data_id, edr.id AS revision_id, (edr.id = edh.master_revision_id) AS master, edd.annotation_id, edd.disambiguation_id, dis.comment disambiguation,
+		als.default_alias_id, al."name", al.sort_name, edd.edition_group_bbid, edd.author_credit_id, edd.width, edd.height,
+		edd.depth, edd.weight, edd.pages, edd.format_id, edd.status_id,
+		edd.alias_set_id, edd.identifier_set_id, edd.relationship_set_id,
+		edd.language_set_id, edd.release_event_set_id, edd.publisher_set_id, e.type
+	FROM bookbrainz.edition_revision edr
+	LEFT JOIN bookbrainz.entity e ON e.bbid = edr.bbid
+	LEFT JOIN bookbrainz.edition_header edh ON edh.bbid = e.bbid
+	LEFT JOIN bookbrainz.edition_data edd ON edr.data_id = edd.id
+	LEFT JOIN bookbrainz.alias_set als ON edd.alias_set_id = als.id
+	LEFT JOIN bookbrainz.alias al ON al.id = als.default_alias_id
+	LEFT JOIN bookbrainz.disambiguation dis ON dis.id = edd.disambiguation_id
+	WHERE e.type = 'Edition';
+
+CREATE VIEW bookbrainz.edition_group AS
+	SELECT
+		e.bbid, egd.id AS data_id, pcr.id AS revision_id, (pcr.id = egh.master_revision_id) AS master, egd.annotation_id, egd.disambiguation_id, dis.comment disambiguation,
+		als.default_alias_id, al."name", al.sort_name, egd.type_id, egtype.label as edition_group_type, egd.author_credit_id, egd.alias_set_id, egd.identifier_set_id,
+		egd.relationship_set_id, e.type
+	FROM bookbrainz.edition_group_revision pcr
+	LEFT JOIN bookbrainz.entity e ON e.bbid = pcr.bbid
+	LEFT JOIN bookbrainz.edition_group_header egh ON egh.bbid = e.bbid
+	LEFT JOIN bookbrainz.edition_group_data egd ON pcr.data_id = egd.id
+	LEFT JOIN bookbrainz.alias_set als ON egd.alias_set_id = als.id
+	LEFT JOIN bookbrainz.alias al ON al.id = als.default_alias_id
+	LEFT JOIN bookbrainz.disambiguation dis ON dis.id = egd.disambiguation_id
+	LEFT JOIN bookbrainz.edition_group_type egtype ON egtype.id = egd.type_id
+	WHERE e.type = 'EditionGroup';
+
+COMMIT;

sql/migrations/2024-02-07-credit-section/up.sql

@@ -0,0 +1,92 @@
+-----------------------------------------------------------------------
+-- Adds a credit_section boolean column to edition_data and edition_group_data to make author credits optional --
+------------------------------------------------------------------------
+
+
+---------------------- ****** NOTICE ****** ----------------------
+-- Don't forget to run the create_trigger.sql script afterwards --
+------------------------------------------------------------------
+
+BEGIN TRANSACTION;
+
+-- Adding credit_section column in edition_data and edition_group_data table and intitalizing it with true
+ALTER TABLE bookbrainz.edition_data ADD COLUMN credit_section BOOLEAN DEFAULT TRUE;
+ALTER TABLE bookbrainz.edition_group_data ADD COLUMN credit_section BOOLEAN DEFAULT TRUE;
+
+DROP VIEW IF EXISTS 
+    bookbrainz.edition,
+    bookbrainz.edition_group;
+
+-- Recreate the view with the new definition
+-- Adding credit_section column in edition view and edition_group view
+CREATE VIEW bookbrainz.edition AS
+SELECT e.bbid,
+    edd.id AS data_id,
+    edr.id AS revision_id,
+    edr.id = edh.master_revision_id AS master,
+    edd.annotation_id,
+    edd.disambiguation_id,
+    dis.comment AS disambiguation,
+    als.default_alias_id,
+    al.name,
+    al.sort_name,
+    edd.edition_group_bbid,
+    edd.author_credit_id,
+    edd.width,
+    edd.height,
+    edd.depth,
+    edd.weight,
+    edd.pages,
+    edd.format_id,
+    edd.status_id,
+    edd.alias_set_id,
+    edd.identifier_set_id,
+    edd.relationship_set_id,
+    edd.language_set_id,
+    edd.release_event_set_id,
+    edd.publisher_set_id,
+    edd.credit_section,
+    e.type
+   FROM bookbrainz.edition_revision edr
+     LEFT JOIN bookbrainz.entity e ON e.bbid = edr.bbid
+     LEFT JOIN bookbrainz.edition_header edh ON edh.bbid = e.bbid
+     LEFT JOIN bookbrainz.edition_data edd ON edr.data_id = edd.id
+     LEFT JOIN bookbrainz.alias_set als ON edd.alias_set_id = als.id
+     LEFT JOIN bookbrainz.alias al ON al.id = als.default_alias_id
+     LEFT JOIN bookbrainz.disambiguation dis ON dis.id = edd.disambiguation_id
+  WHERE e.type = 'Edition';
+
+CREATE VIEW bookbrainz.edition_group AS
+SELECT e.bbid,
+    egd.id AS data_id,
+    pcr.id AS revision_id,
+    pcr.id = egh.master_revision_id AS master,
+    egd.annotation_id,
+    egd.disambiguation_id,
+    dis.comment AS disambiguation,
+    als.default_alias_id,
+    al.name,
+    al.sort_name,
+    egd.type_id,
+    egtype.label AS edition_group_type,
+    egd.author_credit_id,
+    egd.alias_set_id,
+    egd.identifier_set_id,
+    egd.relationship_set_id,
+    egd.credit_section,
+    e.type
+   FROM bookbrainz.edition_group_revision pcr
+     LEFT JOIN bookbrainz.entity e ON e.bbid = pcr.bbid
+     LEFT JOIN bookbrainz.edition_group_header egh ON egh.bbid = e.bbid
+     LEFT JOIN bookbrainz.edition_group_data egd ON pcr.data_id = egd.id
+     LEFT JOIN bookbrainz.alias_set als ON egd.alias_set_id = als.id
+     LEFT JOIN bookbrainz.alias al ON al.id = als.default_alias_id
+     LEFT JOIN bookbrainz.disambiguation dis ON dis.id = egd.disambiguation_id
+     LEFT JOIN bookbrainz.edition_group_type egtype ON egtype.id = egd.type_id
+  WHERE e.type = 'EditionGroup';
+
+---------------------- ****** NOTICE ****** ----------------------
+-- Don't forget to run the create_trigger.sql script afterwards --
+------------------------------------------------------------------
+
+COMMIT TRANSACTION;

sql/schemas/bookbrainz.sql

@@ -352,7 +352,8 @@ CREATE TABLE bookbrainz.edition_data (
 	weight SMALLINT CHECK (weight >= 0),
 	pages SMALLINT CHECK (pages >= 0),
 	format_id INT,
-	status_id INT
+	status_id INT,
+	credit_section BOOLEAN DEFAULT TRUE
 );
 ALTER TABLE bookbrainz.edition_data ADD FOREIGN KEY (author_credit_id) REFERENCES bookbrainz.author_credit (id);
 ALTER TABLE bookbrainz.edition_data ADD FOREIGN KEY (format_id) REFERENCES bookbrainz.edition_format (id);
@@ -375,8 +376,10 @@ CREATE TABLE bookbrainz.edition_group_data (
 	annotation_id INT,
 	disambiguation_id INT,
 	author_credit_id INT,
-	type_id INT
+	type_id INT,
+	credit_section BOOLEAN DEFAULT TRUE
 );
+
 ALTER TABLE bookbrainz.edition_group_data ADD FOREIGN KEY (type_id) REFERENCES bookbrainz.edition_group_type (id);
 ALTER TABLE bookbrainz.edition_group_data ADD FOREIGN KEY (author_credit_id) REFERENCES bookbrainz.author_credit (id);
 ALTER TABLE bookbrainz.edition_group_revision ADD FOREIGN KEY (data_id) REFERENCES bookbrainz.edition_group_data (id);
@@ -867,20 +870,41 @@ CREATE VIEW bookbrainz.author AS
 	WHERE e.type = 'Author';
 
 CREATE VIEW bookbrainz.edition AS
-	SELECT
-		e.bbid, edd.id AS data_id, edr.id AS revision_id, (edr.id = edh.master_revision_id) AS master, edd.annotation_id, edd.disambiguation_id, dis.comment disambiguation,
-		als.default_alias_id, al."name", al.sort_name, edd.edition_group_bbid, edd.author_credit_id, edd.width, edd.height,
-		edd.depth, edd.weight, edd.pages, edd.format_id, edd.status_id,
-		edd.alias_set_id, edd.identifier_set_id, edd.relationship_set_id,
-		edd.language_set_id, edd.release_event_set_id, edd.publisher_set_id, e.type
-	FROM bookbrainz.edition_revision edr
-	LEFT JOIN bookbrainz.entity e ON e.bbid = edr.bbid
-	LEFT JOIN bookbrainz.edition_header edh ON edh.bbid = e.bbid
-	LEFT JOIN bookbrainz.edition_data edd ON edr.data_id = edd.id
-	LEFT JOIN bookbrainz.alias_set als ON edd.alias_set_id = als.id
-	LEFT JOIN bookbrainz.alias al ON al.id = als.default_alias_id
-	LEFT JOIN bookbrainz.disambiguation dis ON dis.id = edd.disambiguation_id
-	WHERE e.type = 'Edition';
+SELECT e.bbid,
+    edd.id AS data_id,
+    edr.id AS revision_id,
+    edr.id = edh.master_revision_id AS master,
+    edd.annotation_id,
+    edd.disambiguation_id,
+    dis.comment AS disambiguation,
+    als.default_alias_id,
+    al.name,
+    al.sort_name,
+    edd.edition_group_bbid,
+    edd.author_credit_id,
+    edd.width,
+    edd.height,
+    edd.depth,
+    edd.weight,
+    edd.pages,
+    edd.format_id,
+    edd.status_id,
+    edd.alias_set_id,
+    edd.identifier_set_id,
+    edd.relationship_set_id,
+    edd.language_set_id,
+    edd.release_event_set_id,
+    edd.publisher_set_id,
+    edd.credit_section,
+    e.type
+   FROM bookbrainz.edition_revision edr
+     LEFT JOIN bookbrainz.entity e ON e.bbid = edr.bbid
+     LEFT JOIN bookbrainz.edition_header edh ON edh.bbid = e.bbid
+     LEFT JOIN bookbrainz.edition_data edd ON edr.data_id = edd.id
+     LEFT JOIN bookbrainz.alias_set als ON edd.alias_set_id = als.id
+     LEFT JOIN bookbrainz.alias al ON al.id = als.default_alias_id
+     LEFT JOIN bookbrainz.disambiguation dis ON dis.id = edd.disambiguation_id
+  WHERE e.type = 'Edition';
 
 CREATE VIEW bookbrainz.work AS
 	SELECT
@@ -914,19 +938,33 @@ CREATE VIEW bookbrainz.publisher AS
 	WHERE e.type = 'Publisher';
 
 CREATE VIEW bookbrainz.edition_group AS
-	SELECT
-		e.bbid, egd.id AS data_id, pcr.id AS revision_id, (pcr.id = egh.master_revision_id) AS master, egd.annotation_id, egd.disambiguation_id, dis.comment disambiguation,
-		als.default_alias_id, al."name", al.sort_name, egd.type_id, egtype.label as edition_group_type, egd.author_credit_id, egd.alias_set_id, egd.identifier_set_id,
-		egd.relationship_set_id, e.type
-	FROM bookbrainz.edition_group_revision pcr
-	LEFT JOIN bookbrainz.entity e ON e.bbid = pcr.bbid
-	LEFT JOIN bookbrainz.edition_group_header egh ON egh.bbid = e.bbid
-	LEFT JOIN bookbrainz.edition_group_data egd ON pcr.data_id = egd.id
-	LEFT JOIN bookbrainz.alias_set als ON egd.alias_set_id = als.id
-	LEFT JOIN bookbrainz.alias al ON al.id = als.default_alias_id
-	LEFT JOIN bookbrainz.disambiguation dis ON dis.id = egd.disambiguation_id
-	LEFT JOIN bookbrainz.edition_group_type egtype ON egtype.id = egd.type_id
-	WHERE e.type = 'EditionGroup';
+SELECT e.bbid,
+    egd.id AS data_id,
+    pcr.id AS revision_id,
+    pcr.id = egh.master_revision_id AS master,
+    egd.annotation_id,
+    egd.disambiguation_id,
+    dis.comment AS disambiguation,
+    als.default_alias_id,
+    al.name,
+    al.sort_name,
+    egd.type_id,
+    egtype.label AS edition_group_type,
+    egd.author_credit_id,
+    egd.alias_set_id,
+    egd.identifier_set_id,
+    egd.relationship_set_id,
+    egd.credit_section,
+    e.type
+   FROM bookbrainz.edition_group_revision pcr
+     LEFT JOIN bookbrainz.entity e ON e.bbid = pcr.bbid
+     LEFT JOIN bookbrainz.edition_group_header egh ON egh.bbid = e.bbid
+     LEFT JOIN bookbrainz.edition_group_data egd ON pcr.data_id = egd.id
+     LEFT JOIN bookbrainz.alias_set als ON egd.alias_set_id = als.id
+     LEFT JOIN bookbrainz.alias al ON al.id = als.default_alias_id
+     LEFT JOIN bookbrainz.disambiguation dis ON dis.id = egd.disambiguation_id
+     LEFT JOIN bookbrainz.edition_group_type egtype ON egtype.id = egd.type_id
+  WHERE e.type = 'EditionGroup';
 
 CREATE VIEW bookbrainz.series AS
 	SELECT
@@ -983,6 +1021,7 @@ CREATE VIEW bookbrainz.edition_import AS
 		edition_data.depth,
 		edition_data.weight,
 		edition_data.pages,
+		edition_data.credit_section,
 		edition_data.format_id,
 		edition_data.status_id,
 		edition_data.alias_set_id,
@@ -1028,6 +1067,7 @@ CREATE VIEW bookbrainz.edition_group_import AS
 		edition_group_data.disambiguation_id,
 		alias_set.default_alias_id,
 		edition_group_data.type_id,
+		edition_group_data.credit_section,
 		edition_group_data.alias_set_id,
 		edition_group_data.identifier_set_id,
 		import.type

sql/scripts/create_triggers.sql

@@ -60,14 +60,14 @@ CREATE OR REPLACE FUNCTION bookbrainz.process_edition() RETURNS TRIGGER
 				alias_set_id, identifier_set_id, relationship_set_id, annotation_id,
 				disambiguation_id, edition_group_bbid, author_credit_id,
 				publisher_set_id, release_event_set_id, language_set_id, width,
-				height, depth, weight, pages, format_id, status_id
+				height, depth, weight, pages, format_id, status_id, credit_section
 			) VALUES (
 				NEW.alias_set_id, NEW.identifier_set_id, NEW.relationship_set_id,
 				NEW.annotation_id, NEW.disambiguation_id, NEW.edition_group_bbid,
 				NEW.author_credit_id, NEW.publisher_set_id,
 				NEW.release_event_set_id, NEW.language_set_id, NEW.width,
 				NEW.height, NEW.depth, NEW.weight, NEW.pages, NEW.format_id,
-				NEW.status_id
+				NEW.status_id, NEW.credit_section
 			) RETURNING bookbrainz.edition_data.id INTO edition_data_id;
 
 			INSERT INTO bookbrainz.edition_revision VALUES(NEW.revision_id, NEW.bbid, edition_data_id);
@@ -218,10 +218,10 @@ CREATE OR REPLACE FUNCTION bookbrainz.process_edition_group() RETURNS TRIGGER
 		IF (TG_OP <> 'DELETE') THEN
 			INSERT INTO bookbrainz.edition_group_data(
 				alias_set_id, identifier_set_id, relationship_set_id, annotation_id,
-				disambiguation_id, type_id, author_credit_id
+				disambiguation_id, type_id, author_credit_id, credit_section
 			) VALUES (
 				NEW.alias_set_id, NEW.identifier_set_id, NEW.relationship_set_id,
-				NEW.annotation_id, NEW.disambiguation_id, NEW.type_id, NEW.author_credit_id
+				NEW.annotation_id, NEW.disambiguation_id, NEW.type_id, NEW.author_credit_id, NEW.credit_section
 			) RETURNING bookbrainz.edition_group_data.id INTO edition_group_data_id;
 
 			INSERT INTO bookbrainz.edition_group_revision VALUES(NEW.revision_id, NEW.bbid, edition_group_data_id);

src/client/components/pages/entities/edition-group.js

@@ -92,6 +92,7 @@ function EditionGroupDisplayPage({entity, identifierTypes, user, wikipediaExtrac
 	}, [reviewsRef]);
 
 	const urlPrefix = getEntityUrl(entity);
+	const hasAuthorCredits = entity.creditSection;
 
 	let authorCreditSection;
 	if (entity.authorCredit) {
@@ -101,7 +102,7 @@ function EditionGroupDisplayPage({entity, identifierTypes, user, wikipediaExtrac
 			/>
 		);
 	}
-	else if (!entity.deleted) {
+	else if (!entity.deleted && (hasAuthorCredits === true || hasAuthorCredits === null)) {
 		authorCreditSection = (
 			<div className="alert alert-warning text-center">
 				Author Credit unset; please&nbsp;

src/client/components/pages/entities/edition.js

@@ -113,6 +113,7 @@ function EditionDisplayPage({entity, identifierTypes, user, wikipediaExtract}) {
 	const worksContainedByEdition = getRelationshipTargetByTypeId(entity, relationshipTypeId);
 	const worksContainedByEditionWithAuthors = addAuthorsDataToWorks(entity.authorsData, worksContainedByEdition);
 	const urlPrefix = getEntityUrl(entity);
+	const hasAuthorCredits = entity.creditSection;
 
 	let authorCreditSection;
 	if (entity.authorCredit) {
@@ -122,7 +123,7 @@ function EditionDisplayPage({entity, identifierTypes, user, wikipediaExtract}) {
 			/>
 		);
 	}
-	else if (!entity.deleted) {
+	else if (!entity.deleted && (hasAuthorCredits === true || hasAuthorCredits === null)) {
 		authorCreditSection = (
 			<div className="alert alert-warning text-center">
 				Author Credit unset; please&nbsp;

src/client/entity-editor/author-credit-editor/actions.ts

@@ -224,3 +224,4 @@ export function toggleAuthorCredit(): Action {
 		type: TOGGLE_AUTHOR_CREDIT
 	};
 }
+

src/client/entity-editor/author-credit-editor/author-credit-section.tsx

@@ -24,8 +24,8 @@ import {Action,
 	removeEmptyCreditRows,
 	resetAuthorCredit,
 	showAuthorCreditEditor,
-	toggleAuthorCredit
-	, updateCreditAuthorValue} from './actions';
+	toggleAuthorCredit,
+	updateCreditAuthorValue} from './actions';
 import {Button, Col, Form, FormLabel, InputGroup, OverlayTrigger, Row, Tooltip} from 'react-bootstrap';
 
 import {get as _get, map as _map, values as _values, camelCase} from 'lodash';

src/server/helpers/diffFormatters/authorCredit.ts

@@ -35,7 +35,7 @@ function authorCreditNameForDisplay(authorCreditName: AuthorCreditNameT) {
 }
 
 function authorCreditNamesForDisplay(rhs: {names: AuthorCreditNameT[]}) {
-	return rhs.names.sort((a, b) => a.position - b.position)
+	return rhs?.names?.sort((a, b) => a.position - b.position)
 		.map(authorCreditNameForDisplay);
 }
 
@@ -45,7 +45,7 @@ function formatNewAuthorCredit(change) {
 
 function formatAuthorCreditAddOrDelete(change) {
 	return set.formatItemAddOrDelete(
-		change, `Author Credit ${change.item?.rhs?.position + 1}`, authorCreditNameForDisplay
+		change, `Author Credit ${change.item?.rhs?.position + 1 || 'removed'}`, authorCreditNamesForDisplay
 	);
 }