[JENKINS-73156] handle svg cleanup of symbols via an xml document #9266

mawinter69 · 2024-05-12T19:09:08Z

some attributes and elements where removed via regular expressions that removed more than what is necessary. Additionally stroke:#000 was replaced with currentColor because there are some icons that still use that.
This had side-effects when symbols are used that are not just black/white, e.g. using svgs from jenkins artwork via customizable-header plugin. There are constructs like using class attributes and a style definition referring to the classes. At other places there where color definitions with stroke:#000abc which were incorrectly modified.

svg cleanup is now implemented with DOM manipulation which is more robust.
5 icons that still used stroke:#000 are converted to use stroke:currentColor

opened jenkinsci/ionicons-api-plugin#64 as followup to fix some occurrences of stroke:#000

See JENKINS-73156.

Testing done

Manual testing, that the changed icons still work properly with dark theme.
Used some of the SVGs from https://www.jenkins.io/artwork/ and provided them as symbol in customizable-header plugin and verified they are properly shown

Proposed changelog entries

Handle svg cleanup via an xml document to avoid broken symbols.

Proposed upgrade guidelines

update ionicons-api plugin to at least version 74.v93d5eb_813d5f

Submitter checklist

Give feedback

The Jira issue, if it exists, is well-described.

The Jira issue, if it exists, is well-described.
Options
Successfully updated the issue's project

There was an error updating the issue's project
The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see [examples](https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/weekly.yml)). Fill in the **Proposed upgrade guidelines** section only if there are breaking changes or changes that may require extra steps from users during upgrade.

The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
Options
Successfully updated the issue's project

There was an error updating the issue's project
There is automated testing or an explanation as to why this change has no tests.

There is automated testing or an explanation as to why this change has no tests.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New public classes, fields, and methods are annotated with `@Restricted` or have `@since TODO` Javadocs, as appropriate.

New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New deprecations are annotated with `@Deprecated(since = "TODO")` or `@Deprecated(forRemoval = true, since = "TODO")`, if applicable.

New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
Options
Successfully updated the issue's project

There was an error updating the issue's project
New or substantially changed JavaScript is not defined inline and does not call `eval` to ease future introduction of Content Security Policy (CSP) directives (see [documentation](https://www.jenkins.io/doc/developer/security/csp/)).

New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
Options
Successfully updated the issue's project

There was an error updating the issue's project
For dependency updates, there are links to external changelogs and, if possible, full differentials.

For dependency updates, there are links to external changelogs and, if possible, full differentials.
Options
Successfully updated the issue's project

There was an error updating the issue's project
For new APIs and extension points, there is a link to at least one consumer.

For new APIs and extension points, there is a link to at least one consumer.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Options

Desired reviewers

@mention

Before the changes are marked as ready-for-merge:

Maintainer checklist

Give feedback

There are at least two (2) approvals for the pull request and no outstanding requests for change.

There are at least two (2) approvals for the pull request and no outstanding requests for change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.

Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Changelog entries in the pull request title and/or **Proposed changelog entries** are accurate, human-readable, and in the imperative mood.

Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
Options
Successfully updated the issue's project

There was an error updating the issue's project
Proper changelog labels are set so that the changelog can be generated automatically.

Proper changelog labels are set so that the changelog can be generated automatically.
Options
Successfully updated the issue's project

There was an error updating the issue's project
If the change needs additional upgrade steps from users, the `upgrade-guide-needed` label is set and there is a **Proposed upgrade guidelines** section in the pull request title (see [example](https://github.com/jenkinsci/jenkins/pull/4387)).

If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
Options
Successfully updated the issue's project

There was an error updating the issue's project
If it would make sense to backport the change to LTS, a Jira issue must exist, be a _Bug_ or _Improvement_, and be labeled as `lts-candidate` to be considered (see [query](https://issues.jenkins.io/issues/?filter=12146)).

If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).
Options
Successfully updated the issue's project

There was an error updating the issue's project
Options

mawinter69 · 2024-05-12T19:12:59Z

core/src/main/java/org/jenkins/ui/symbol/Symbol.java

+            Document doc = db.parse(new StringInputStream(markup));
+            Element root = doc.getDocumentElement();
+            NodeList titleList = root.getElementsByTagName("title");
+            for (int i = 0; i < titleList.getLength(); i++) {


As before just emptying the title elements. But why not just delete them completely?

some attributes and elements where removed via regular expressions. Additionally `stroke:#000 was replaced with currentColor because there are some icons that still use that. This had sideeffects when symbols are used that are not just black/white, e.g. using svg from jenkins artwork via customizable-header plugin. There are construct like using class attributes and a style definition referring to the classes. At other places there where color definitions with `stroke:#000abc` which were incorrectly modified. svg cleanup is now implemented with DOM manipulation which is more robust. 5 icons that still used `stroke:#000` are converted to use `stroke:currentColor`

NotMyFault

/label ready-for-merge

This PR is now ready for merge. We will merge it after ~24 hours if there is no negative feedback.
Please see the merge process documentation for more information about the merge process.
Thanks!

mawinter69 commented May 12, 2024

View reviewed changes

mawinter69 force-pushed the JENKINS-73156 branch from bbb57a3 to 289db0e Compare May 12, 2024 19:28

mawinter69 force-pushed the JENKINS-73156 branch from 289db0e to ea9c186 Compare May 12, 2024 19:45

mawinter69 changed the title ~~[JENKINS-73156] handle svg cleanup via an xml document~~ [JENKINS-73156] handle svg cleanup of symbols via an xml document May 12, 2024

timja added the bug For changelog: Minor bug. Will be listed after features label May 17, 2024

timja approved these changes May 17, 2024

View reviewed changes

NotMyFault approved these changes May 18, 2024

View reviewed changes

comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label May 18, 2024

MarkEWaite merged commit afaf96e into jenkinsci:master May 19, 2024
17 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JENKINS-73156] handle svg cleanup of symbols via an xml document #9266

[JENKINS-73156] handle svg cleanup of symbols via an xml document #9266

mawinter69 commented May 12, 2024 •

edited by MarkEWaite

Submitter checklist

Maintainer checklist

mawinter69 May 12, 2024 •

edited

NotMyFault left a comment

[JENKINS-73156] handle svg cleanup of symbols via an xml document #9266

[JENKINS-73156] handle svg cleanup of symbols via an xml document #9266

Conversation

mawinter69 commented May 12, 2024 • edited by MarkEWaite

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

mawinter69 May 12, 2024 • edited

Choose a reason for hiding this comment

NotMyFault left a comment

Choose a reason for hiding this comment

mawinter69 commented May 12, 2024 •

edited by MarkEWaite

mawinter69 May 12, 2024 •

edited