Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

separate tag-upgrade warnings from NSI suggestions #10801

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
+211 −81
Open

separate tag-upgrade warnings from NSI suggestions #10801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae9e3be
separate tag-upgrade warnings from NSI suggestions
k-yle Feb 22, 2025
5fb8dd0
Merge branch 'develop' into kh/split-nsi
tyrasd Feb 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ _Breaking developer changes, which may affect downstream projects or sites that
* Revalidate ways that are added to or removed from relations ([#10786])
* Preserve `crossing:markings` tag when fixing missing connection of crossing path and road ([#9586], thanks [@jtracey])
* Add a dedicated description to fix waterway-road intersections by adding a _culvert_ ([#10778], thanks [@matkoniecz])
* Separate tag-upgrade warnings from NSI suggestions ([#10800], thanks [@k-yle])
#### :bug: Bugfixes
* Prevent degenerate ways caused by deleting a corner of a triangle ([#10003], thanks [@k-yle])
* Fix briefly disappearing data layer during background layer tile layer switching transition ([#10748])
Expand Down Expand Up @@ -100,6 +101,7 @@ _Breaking developer changes, which may affect downstream projects or sites that
[#10776]: https://github.com/openstreetmap/iD/issues/10776
[#10778]: https://github.com/openstreetmap/iD/issues/10778
[#10798]: https://github.com/openstreetmap/iD/pull/10798
[#10800]: https://github.com/openstreetmap/iD/pull/10800
[@hlfan]: https://github.com/hlfan
[@Deeptanshu-sankhwar]: https://github.com/Deeptanshu-sankhwar
[@draunger]: https://github.com/draunger
Expand Down
7 changes: 6 additions & 1 deletion modules/util/util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,13 @@ export function utilTotalExtent(array, graph) {
return extent;
}


/**
* @typedef {{ type: '-' | '+'; key: string; oldVal: string; newVal: string; display: string; }} TagDiff
* @param {Tags} oldTags
* @param {Tags} newTags
*/
export function utilTagDiff(oldTags, newTags) {
/** @type {TagDiff[]} */
var tagDiff = [];
var keys = utilArrayUnion(Object.keys(oldTags), Object.keys(newTags)).sort();
keys.forEach(function(k) {
Expand Down
164 changes: 84 additions & 80 deletions modules/validations/outdated_tags.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import { utilHashcode, utilTagDiff } from '../util';
import { utilDisplayLabel } from '../util/utilDisplayLabel';
import { validationIssue, validationIssueFix } from '../core/validation';

/** @import { TagDiff } from '../util/util'. */


export function validationOutdatedTags() {
const type = 'outdated_tags';
Expand All @@ -30,7 +32,6 @@ export function validationOutdatedTags() {
if (!preset) return [];

const oldTags = Object.assign({}, entity.tags); // shallow copy
let subtype = 'deprecated_tags';

// Upgrade preset, if a replacement is available..
if (preset.replacement) {
Expand All @@ -40,8 +41,6 @@ export function validationOutdatedTags() {
preset = newPreset;
}

const upgradeReasons = [];

// Upgrade deprecated tags..
if (_dataDeprecated) {
const deprecatedTags = entity.deprecatedTags(_dataDeprecated);
Expand All @@ -56,10 +55,6 @@ export function validationOutdatedTags() {
if (deprecatedTags.length) {
deprecatedTags.forEach(tag => {
graph = actionUpgradeTags(entity.id, tag.old, tag.replace)(graph);
upgradeReasons.push({
source: 'id-tagging-schema--deprecated',
data: tag
});
});
entity = graph.entity(entity.id);
}
Expand All @@ -75,14 +70,12 @@ export function validationOutdatedTags() {
} else if (preset.addTags[k]) {
newTags[k] = preset.addTags[k];
}
upgradeReasons.push({
source: 'id-tagging-schema--preset-addTags',
data: preset
});
}
});
}

const deprecationDiff = utilTagDiff(oldTags, newTags);

// Attempt to match a canonical record in the name-suggestion-index.
const nsi = services.nsi;
let waitingForNsi = false;
Expand All @@ -91,81 +84,106 @@ export function validationOutdatedTags() {
waitingForNsi = (nsi.status() === 'loading');
if (!waitingForNsi) {
const loc = entity.extent(graph).center();
nsiResult = nsi.upgradeTags(newTags, loc);
if (nsiResult) {
newTags = nsiResult.newTags;
subtype = 'noncanonical_brand';
upgradeReasons.push({
source: 'name-suggestion-index',
data: nsiResult
});
}
nsiResult = nsi.upgradeTags(oldTags, loc);
}
}

const nsiDiff = nsiResult ? utilTagDiff(oldTags, nsiResult.newTags) : [];

let issues = [];
issues.provisional = (_waitingForDeprecated || waitingForNsi);

// determine diff
const tagDiff = utilTagDiff(oldTags, newTags);
if (!tagDiff.length) return issues;

const isOnlyAddingTags = tagDiff.every(d => d.type === '+');

let prefix = '';
if (nsiResult) {
prefix = 'noncanonical_brand.';
} else if (subtype === 'deprecated_tags' && isOnlyAddingTags) {
subtype = 'incomplete_tags';
prefix = 'incomplete.';
if (deprecationDiff.length) {
const isOnlyAddingTags = deprecationDiff.every(d => d.type === '+');
const prefix = isOnlyAddingTags ? 'incomplete.' : '';

issues.push(new validationIssue({
type: type,
subtype: isOnlyAddingTags ? 'incomplete_tags' : 'deprecated_tags',
severity: 'warning',
message: (context) => {
const currEntity = context.hasEntity(entity.id);
if (!currEntity) return '';

const feature = utilDisplayLabel(currEntity, context.graph(), /* verbose */ true);

return t.append(`issues.outdated_tags.${prefix}message`, { feature });
},
reference: selection => showReference(
selection,
t.append(`issues.outdated_tags.${prefix}reference`),
deprecationDiff
),
entityIds: [entity.id],
hash: utilHashcode(JSON.stringify(deprecationDiff)),
dynamicFixes: () => {
let fixes = [
new validationIssueFix({
title: t.append('issues.fix.upgrade_tags.title'),
onClick: (context) => {
context.perform(graph => doUpgrade(graph, deprecationDiff), t('issues.fix.upgrade_tags.annotation'));
}
})
];
return fixes;
}
}));
}

// don't allow autofixing brand tags
let autoArgs = subtype !== 'noncanonical_brand' ? [doUpgrade, t('issues.fix.upgrade_tags.annotation')] : null;

issues.push(new validationIssue({
type: type,
subtype: subtype,
severity: 'warning',
message: showMessage,
reference: showReference,
entityIds: [entity.id],
hash: utilHashcode(JSON.stringify(tagDiff)),
dynamicFixes: () => {
let fixes = [
new validationIssueFix({
autoArgs: autoArgs,
title: t.append('issues.fix.upgrade_tags.title'),
onClick: (context) => {
context.perform(doUpgrade, t('issues.fix.upgrade_tags.annotation'));
}
})
];

const item = nsiResult && nsiResult.matched;
if (item) {
fixes.push(
if (nsiDiff.length) {
const isOnlyAddingTags = nsiDiff.every(d => d.type === '+');

issues.push(new validationIssue({
type: type,
subtype: 'noncanonical_brand',
severity: 'warning',
message: (context) => {
const currEntity = context.hasEntity(entity.id);
if (!currEntity) return '';

const feature = utilDisplayLabel(currEntity, context.graph(), /* verbose */ true);

return isOnlyAddingTags
? t.append('issues.outdated_tags.noncanonical_brand.message_incomplete', { feature })
: t.append('issues.outdated_tags.noncanonical_brand.message', { feature });
},
reference: selection => showReference(
selection,
t.append('issues.outdated_tags.noncanonical_brand.reference'),
nsiDiff
),
entityIds: [entity.id],
hash: utilHashcode(JSON.stringify(nsiDiff)),
dynamicFixes: () => {
let fixes = [
new validationIssueFix({
title: t.append('issues.fix.tag_as_not.title', { name: item.displayName }),
title: t.append('issues.fix.upgrade_tags.title'),
onClick: (context) => {
context.perform(graph => doUpgrade(graph, nsiDiff), t('issues.fix.upgrade_tags.annotation'));
}
}),
new validationIssueFix({
title: t.append('issues.fix.tag_as_not.title', { name: nsiResult.matched.displayName }),
onClick: (context) => {
context.perform(addNotTag, t('issues.fix.tag_as_not.annotation'));
}
})
);
];
return fixes;
}
return fixes;
}));
}

}
}));
return issues;


function doUpgrade(graph) {
/** @param {iD.Graph} graph @param {TagDiff[]} diff */
function doUpgrade(graph, diff) {
const currEntity = graph.hasEntity(entity.id);
if (!currEntity) return graph;

let newTags = Object.assign({}, currEntity.tags); // shallow copy
tagDiff.forEach(diff => {
diff.forEach(diff => {
if (diff.type === '-') {
delete newTags[diff.key];
} else if (diff.type === '+') {
Expand Down Expand Up @@ -200,29 +218,15 @@ export function validationOutdatedTags() {
}


function showMessage(context) {
const currEntity = context.hasEntity(entity.id);
if (!currEntity) return '';

let messageID = `issues.outdated_tags.${prefix}message`;
if (subtype === 'noncanonical_brand' && isOnlyAddingTags) {
messageID += '_incomplete';
}
return t.append(messageID, {
feature: utilDisplayLabel(currEntity, context.graph(), true /* verbose */)
});
}


function showReference(selection) {
function showReference(selection, reference, tagDiff) {
let enter = selection.selectAll('.issue-reference')
.data([0])
.enter();

enter
.append('div')
.attr('class', 'issue-reference')
.call(t.append(`issues.outdated_tags.${prefix}reference`));
.call(reference);

enter
.append('strong')
Expand Down
Loading