Skip to content

Comment out EnumField Labels#794

Merged
GergiH merged 1 commit intomasterfrom
hotfix/disable-enum-labels
Jun 30, 2020
Merged

Comment out EnumField Labels#794
GergiH merged 1 commit intomasterfrom
hotfix/disable-enum-labels

Conversation

@thenav56
Copy link
Copy Markdown
Member

Comment out Labels from EnumFields.

@thenav56 thenav56 requested review from GergiH and batpad June 30, 2020 08:57
@GergiH GergiH merged commit f2b145d into master Jun 30, 2020
@GergiH GergiH mentioned this pull request Jun 30, 2020
@thenav56 thenav56 deleted the hotfix/disable-enum-labels branch June 30, 2020 09:11
@nanometrenat
Copy link
Copy Markdown
Contributor

For xref purposes this was the symptom reported by users, that this PR fixed:
NB this is re csv exports (JSON unaffected)

Some of the standard values in columns have changed, not the structure.

For instance:
It used to be Dref, now it is DREF
It used to be appeal, now it is Emergency Appeal
It used to be Int, now it is International Appeal
It used to be MENA, now it is Middle East North Africa

And this was the explanation given:

As part of preparatory work toward making our APIs translatable, we accidentally made a change that caused ENUM values in the database to be represented by their verbose labels and not actual values in the CSV export. This was an accidental side-effect of marking strings for translations that caused us to change the structure of how we define ENUMs that caused this bug.

This did not get caught by either our manual QA process or our API test-suite, which currently only has tests for the JSON outputs, which were unaffected by this change. We are looking into improving our testing processes to ensure we catch these changes in the future before they affect downstream data consumers.

We are extremely sorry for the breakages this has caused on your end, but are very thankful for the catch. Rest assured, we will definitely be clear with communication when we do make purposeful changes to the API that may cause breakage for our users. In this case, it was an unintentional bug, and we are very grateful to your note that has helped us track it down and fix it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants