Add Osmose Q/A layer

[kymckay]

Closes #5682

This is a functional Q/A layer with support for a reasonable number of issue types. Supporting new issues is as simple as giving them an icon entry in the qa_errors.json data file.

Some implementation notes:

• Osmose issues are uniquely identified by a unique item and class combination (both integer values). To identify specific issues we concatenate as a string item-class.
• Adding a new issue type to iD is as simple as adding an icon entry for the item-class in data/qa_errors.json.
• When requesting issues for a tile, we use the item= filter since Osmose tiles can return a maximum number of issues (we want to show the user as many as possible).
• All issue colors and static translation strings (besides UI headings) are pulled in from the Osmose API when the layer is first enabled. To reduce the overall data being requested, this is done using a langs= filter and as individual requests for each item-class (as Promises).
  • The API automatically falls back to English if a string is untranslated or if the requested locale doesn't exist in Osmose
• The list of elements and a dynamic details string (contains information like keys and values of the issue) associated with each issue has to be requested individually - this is done upon UI creation.
• The UI subsections (other than the issue description) are only created as needed, in order:
  • Description (always created)
  • Issue Details (the dynamic string)
  • Issue Elements (list of element links)
  • Fix Guidelines (string giving direction on how to fix the issue)
  • Common Mistakes (string giving information on traps to avoid while fixing)

Preview of the UI in action:

[quincylvania]

@SilentSpike Thanks for your continued work on this! Let us know if you need any advice/assistance and when this is ready for review.

There's also potential to use the provided translation strings for titles and descriptions - although I'm not sure they're all written in a way iD would typically present information to users.

Hmm we don't really have any other external translation integrations like this but it'd be worth looking into if there are are lots of strings.

[frodrigo]

For now the Osmose analyzers (backend) have more than 500 strings. But I am on integrating doc to transifex. Each class of issue will have a title, a description, a how to fix, a tips on trap to avoid and example plus a contextual message with placeholder. For now only title and contextual message are present. The process of adding the others is ongoing. The text with placeholder are already replaced and translated on Osmose API, the placeholder are not available at the API level.

Osmose analyzers also run JOSM validator and reuse the JOSM translation.

The Osmose API aka Frontend aka Website also contains issues reported by other parties. We have no the hand over thus texts and availability of translations.

[frodrigo]

Note this API http://osmose.openstreetmap.fr/api/0.3beta/items

[frodrigo]

It is better to use "issue" than "error" on buttons.

The ignore button is not well named. It is not an ignore action, but flag the issue as false positive for the current user, but all the users. Then no more displayed.

[kymckay]

Easily changed, those are just reused strings from the other QA services. We actually seem to interchange "error" and "issue" in a few places would be good to make those all consistent.

[frodrigo]

@SilentSpike Okay, that's not too many. Let's continue with separate translations since it's easiest and allows us to use wording suited to iD mappers.

I am interested in improving the wording directly into Osmose. Plus it can help to avoid re-wording/translation in iD.

@frodrigo Thanks for your continued advice. When do you expect the v0.3 API to be stable?

When it will be ready! The API 0.3 was started in summer '18, so I do not know I will be completed. Sure, it will take some more months. But if you choose to use the 0.3beta we will pay attention to it. Some other few softwares already use it.

[kymckay]

@frodrigo Had a quick discussion and we agree that it'd be ideal to use the Osmose strings directly and align our interests.

In terms of the API "wants" to make this possible for iD:

1. Language filter to reduce data when requesting static strings for caching
2. Long descriptions available via API - will these be dynamic strings or also static?

In the meantime I've forked the backend and will see about updating some of the English titles

[quincylvania]

Thanks again, @SilentSpike, this looks awesome. I made a few nitpicky comments about UI stuff but the underlying functionality appears to work fine.

The one thing I'd like to hold back on for the moment is adding the closed issue changeset tags. Other than that we can address the UI stuff before or after merging.

[quincylvania]

Might just say "Translate", and maybe hide the button unless there are untranslated strings onscreen.

Separately, we should add text to iD's documentation about where you can translate the Osmose strings.

[kymckay]

I believe there's no way for us to check whether untranslated strings are present (since the API automatically falls back to English strings and they all get cached under the current language code).

My thinking with not using a "call to action" here is that if there are issues with the strings or missing translations then a user inclined to improve them knows where they come from - and if there aren't then it's still nice to acknowledge they're supplied by a 3rd party.

[quincylvania]

Hmm we could fetch the English strings too and see if they're equivalent? The issue for me is that the string is sort of long and overly draws my attention. "Translations by Osmose" might be a small improvement. It'd also help to put the button under the grey box or to at least give it a greater margin.

Another issue is that I think we use a verb phrase everywhere else we use the outlink icon. Something like "View translations" would keep that while being less "asky". We could also use a different icon.

[frodrigo]

Just note that the API 0.3 of Osmose is now released. No change in the API, just it is now 0.3 in place of 0.3beta. The 0.3beta is still valid URL path and redirect to 0.3.

[kymckay]

Just note that the API 0.3 of Osmose is now released. No change in the API, just it is now 0.3 in place of 0.3beta. The 0.3beta is still valid URL path and redirect to 0.3.

Great to hear! I'll update the iD source to use the new path 🥳