Fill creator name in finnish museum DAG #978

krysal · 2023-01-30T17:50:09Z

Fixes

Fixes WordPress/openverse#1294 by @krysal

Description

This PR changes the query parameters of the Finnish museum to request only the fields that the DAG actually uses (including the creators). The creator can be of three types: "primary", "secondary" and/or "corporate". I made it include the available ones in said order, separated by a ";" since the names of an individual author can include commas as well.

Testing Instructions

Run the finnish_museums_workflow DAG, wait for a while and observe the rows in the image table.

Checklist

My pull request has a descriptive title (not a vague title likeUpdate index.md).
My pull request targets the default branch of the repository (main) or a parent feature branch.
My commit messages follow best practices.
My code follows the established code style of the repository.
I added or updated tests for the changes I made (if applicable).
[N/A] I added or updated documentation (if applicable).
I tried running the project locally and verified that there are no visible errors.
I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

tests/dags/providers/provider_api_scripts/test_finnish_museums.py

AetherUnbound

A couple of thoughts!

openverse_catalog/dags/providers/provider_api_scripts/finnish_museums.py

AetherUnbound · 2023-01-31T02:06:20Z

openverse_catalog/dags/providers/provider_api_scripts/finnish_museums.py

+            author = "; ".join(list(author.keys()))
+            authors.append(author)
+
+        return "; ".join(authors)


I think this will return an empty string if no authors are found, but it might be better to return None in that case to have NULL in the database rather than an empty string. Maybe we could do self.get_creator(data) or None above?

To make sure that we don't have different implementations for when creator name is not available ("" vs None), we could add a check and conversion here:

openverse-catalog/openverse_catalog/dags/common/storage/columns.py

Line 397 in 4c07e63

def prepare_string(self, value):

@AetherUnbound, should we create an issue for that?

Good catch! 😮 I was naive to believe it would return None this way. Fixed in last commits. Thanks, @AetherUnbound.

@obulat Adding an extra check there or/and in the MediaStore classes sounds good!

Your idea about adding a check in MediaStore is better than the columns one, @krysal. We could add

if title === "": title = None

in the MediaStore here:

openverse-catalog/openverse_catalog/dags/common/storage/media.py

Line 93 in 9987322

def clean_media_metadata(self, **media_data) -> dict | None:

Are there any other string fields that need that, too?

I think title and creator are both good fields to check for that!

obulat

LGTM!

We should fix the utf-8 issue in jsons, though.

obulat · 2023-01-31T17:15:02Z

tests/dags/providers/provider_api_scripts/resources/finnishmuseums/object_complete_example.json

-      "Kuva on julkaistu Nime\u00e4 4.0 Kansainv\u00e4linen (CC BY 4.0)-lisenssill\u00e4. Verkkopalvelussa julkaistua n\u00e4ytt\u00f6kuvaa voi k\u00e4ytt\u00e4\u00e4 vapaasti my\u00f6s kaupallisessa k\u00e4yt\u00f6ss\u00e4. Kuvan yhteydess\u00e4 on mainittava tekij\u00e4 ja/tai kuvaaja sek\u00e4 organisaation ja kokoelman nimi. Kuvan k\u00e4ytt\u00e4j\u00e4ll\u00e4 on vastuu tekij\u00e4noikeuksien ja yksityisyyden suojan kunnioittamisesta. Esimerkiksi henkil\u00f6kuvien k\u00e4ytt\u00f6 markkinoinnissa ja/tai mainonnassa on kielletty ilman kuvassa olevan henkil\u00f6n suostumusta. Museovirasto pyrkii julkaisemansa tiedon oikeellisuuteen. Kuvien tiedoissa voi kuitenkin olla puutteellisuuksia ja virheit\u00e4. Virheen huomatessanne pyyd\u00e4mme ottamaan yhteytt\u00e4 Kuvakokoelmien asiakaspalveluun. Kuvia ja tietoja julkaistaessa asiakkaan vastuulla on varmistaa niiden oikeellisuus. Painolaatuiset kuvat ovat maksullisia. Lis\u00e4tietoja tarvittaessa: Museoviraston Kuvakokoelmat (kuvakokoelmat@museovirasto.fi)."
-    ],
-    "link": "http://creativecommons.org/licenses/by/4.0/deed.fi"
+      "SA-kuvat ovat lisensoitu Nime\u00e4 4.0 Kansainv\u00e4linen (CC BY 4.0) -lisenssill\u00e4 ja ne ovat vapaasti k\u00e4ytett\u00e4viss\u00e4 ja julkaistavissa. Kuvat ovat n\u00e4ht\u00e4viss\u00e4 my\u00f6s www.sa-kuva.fi -palvelussa."


It seems that ensureAscii=false wasn't used when saving the json file so that the utf-8 characters are not converted to \uxxx-type codes.

AetherUnbound

Looks great! It seems that the diff is also showing some changes from #934, it might be best to rebase before we merge just to resolve those!

* Fill creator name in finnish museum DAG (#978) * Bump pre-commit from 2.21.0 to 3.0.2 (#983) * 🔄 synced local '.pre-commit-config.yaml' with remote 'templates/.pre-commit-config.yaml.jinja' * Update docstrings to conform to linting * Update DAGs.md --------- Co-authored-by: Krystle Salazar <krystle.salazar@automattic.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: openverse-bot <null> Co-authored-by: Madison Swain-Bowden <bowdenm@spu.edu>

stacimc and others added 10 commits December 22, 2022 16:07

Dynamically generate timeslices depending on the amount of records

1ad3258

Raise error if num_divisions does not divide evenly

bf7914d

Clarify var name, remove TODOs

4b189f5

Clarify 'fetched' vs 'ingested'

541e3e5

Raise exception instead of continuing when error is hit

892d6c0

Clean up tests

4f8bcab

Remove slack reporting now that we're raising an error

2f9d4d6

Clean up error handling

52689e2

Fill creator name in finnish museum DAG

1c3344e

Update sample object for Finnish and tests

c87a8ea

krysal requested a review from a team as a code owner January 30, 2023 17:50

krysal requested review from obulat and stacimc and removed request for a team January 30, 2023 17:50

openverse-bot added this to Needs review in Openverse PRs Jan 30, 2023

openverse-bot added the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Jan 30, 2023

AetherUnbound reviewed Jan 31, 2023

View reviewed changes

tests/dags/providers/provider_api_scripts/test_finnish_museums.py Show resolved Hide resolved

AetherUnbound reviewed Jan 31, 2023

View reviewed changes

krysal added 2 commits January 31, 2023 10:36

Check for raw authors early

c160899

Add unit test for get_creator

5740895

krysal requested a review from AetherUnbound January 31, 2023 15:07

obulat approved these changes Jan 31, 2023

View reviewed changes

Openverse PRs automation moved this from Needs review to Reviewer approved Jan 31, 2023

Base automatically changed from fix/finnish-date-intervals to main January 31, 2023 18:37

AetherUnbound approved these changes Jan 31, 2023

View reviewed changes

Merge branch 'main' into add/finnish-creator

411c454

krysal merged commit 09b3a64 into main Feb 1, 2023

Openverse PRs automation moved this from Reviewer approved to Merged! Feb 1, 2023

krysal deleted the add/finnish-creator branch February 1, 2023 20:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fill creator name in finnish museum DAG #978

Fill creator name in finnish museum DAG #978

krysal commented Jan 30, 2023

AetherUnbound left a comment

AetherUnbound Jan 31, 2023

obulat Jan 31, 2023

krysal Jan 31, 2023

obulat Jan 31, 2023

AetherUnbound Jan 31, 2023

obulat left a comment

obulat Jan 31, 2023

AetherUnbound left a comment

Fill creator name in finnish museum DAG #978

Fill creator name in finnish museum DAG #978

Conversation

krysal commented Jan 30, 2023

Fixes

Description

Testing Instructions

Checklist

Developer Certificate of Origin

AetherUnbound left a comment

Choose a reason for hiding this comment

AetherUnbound Jan 31, 2023

Choose a reason for hiding this comment

obulat Jan 31, 2023

Choose a reason for hiding this comment

krysal Jan 31, 2023

Choose a reason for hiding this comment

obulat Jan 31, 2023

Choose a reason for hiding this comment

AetherUnbound Jan 31, 2023

Choose a reason for hiding this comment

obulat left a comment

Choose a reason for hiding this comment

obulat Jan 31, 2023

Choose a reason for hiding this comment

AetherUnbound left a comment

Choose a reason for hiding this comment