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.

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

fix(reusePaths): pass test-regression task #1791

Merged
merged 1 commit into from
Sep 25, 2023

Conversation

SethFalco
Copy link
Member

@SethFalco SethFalco commented Sep 23, 2023

Locally, I set reusePaths as a default plugin, then resolved any issues with existing tests so that it'll pass in those scenarios.

The issues I encountered:

  • We removed IDs that were being used in ID selectors in the global stylesheet.
  • If inlineStyles was run before reusePaths, this would break as it would copy the styles over as well, which got precedence over its own styles.
  • If convertShapeToPath ran before reusePaths, it would break because rects would become paths, and if that rect had *-opacity attributes, they would get copied over and take precedence for all paths.

This resolves them by:

  • Check if an ID is referenced in a selector in the document styles first, and if so, creates a new ID.
  • More accurately perform as the description describes. Only copy over fill, stroke, and d, and the id if appropriate.

With this, we have all tests passing and 0 mismatches in yarn run test-regression.
The only difference is that if reusing the original ID, it's moved to the end of the path def. This PR also results in making SVGs smaller, as we were duplicating attributes before.

Metrics

Executed with preset-default and reusePaths enabled:

SVG Time % reduced final size
Original N/A N/A 109.435 KiB
v3.0.2 118 ms 8.1% 100.567 KiB
this branch 118 ms 8.5% 100.16 KiB
SVG Time % reduced final size
Original N/A N/A 15060.532 KiB
v3.0.2 15625 ms 35.8% 9663.785 KiB
main (bd750ce) 15085 ms 36.1% 9628.565 KiB
this branch 14820 ms 36.8% 9515.798 KiB

Note

  • The reusePaths plugin is not enabled by default, this was just to minimize breaking SVGs.

@SethFalco SethFalco force-pushed the fix/reuse-paths-tests branch from 719e5df to e5ec61d Compare September 23, 2023 22:38
Signed-off-by: Seth Falco <seth@falco.fun>
@SethFalco SethFalco force-pushed the fix/reuse-paths-tests branch from e5ec61d to b8d5a73 Compare September 23, 2023 22:41
@SethFalco SethFalco merged commit 078a09c into svg:main Sep 25, 2023
5 checks passed
nono referenced this pull request in cozy/cozy-stack Nov 13, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [svgo](https://svgo.dev) ([source](https://github.com/svg/svgo)) |
[`3.0.2` -> `3.0.3`](https://renovatebot.com/diffs/npm/svgo/3.0.2/3.0.3)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/svgo/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/svgo/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/svgo/3.0.2/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/svgo/3.0.2/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>svg/svgo (svgo)</summary>

### [`v3.0.3`](https://github.com/svg/svgo/releases/tag/v3.0.3)

[Compare Source](https://github.com/svg/svgo/compare/v3.0.2...v3.0.3)

Includes various bug fixes and optimizations for existing plugins.

We're also revamped the documentation for the project. You can find it
on [svgo.dev](https://svgo.dev/)!
The frontend for svgo.dev is maintained in
[svg/svgo.dev](https://github.com/svg/svgo.dev), contributions are
welcome.

#### What's Changed

##### Settings

- **Remove Comments**, introduces `preservePatterns` parameter.
Preserves legal comments by default, same as the previous behavior, but
can now be overridden. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1812](https://github.com/svg/svgo/pull/1812)
- **Remove Description**, set the `removeAny` parameter to `false` by
default for accessibility. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1806](https://github.com/svg/svgo/pull/1806)

##### Bug Fixes

- **Remove Raster Images**, removes inlined JPEG images. By
[@&#8203;abejfehr](https://github.com/abejfehr) in
[https://github.com/svg/svgo/pull/1742](https://github.com/svg/svgo/pull/1742)
- **Cleanup IDs**, correctly handle when 2 IDs have been referenced in a
single attribute. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1795](https://github.com/svg/svgo/pull/1795)
- **Cleanup IDS**, correctly handle when we've encountered a reference
to a node that doesn't exist. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1817](https://github.com/svg/svgo/pull/1817)
- **Inline Styles**, treat style prop keys as case-insensitive. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1797](https://github.com/svg/svgo/pull/1797)
- **Inline Styles**, remove all classes in multiclass selector. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1801](https://github.com/svg/svgo/pull/1801)
- **Inline Styles**, ignore empty CSS blocks instead of adding empty
style attribute. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1823](https://github.com/svg/svgo/pull/1823)
- **Minify Styles**, removes unused class selectors when the document
has no classes. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1800](https://github.com/svg/svgo/pull/1800)
- **Prefix IDs**, reuse the same prefix when encountering an ID multiple
times. By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1814](https://github.com/svg/svgo/pull/1814)
- **Remove Hidden Elements**, stops removing non-rendering elements like
masks. By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1793](https://github.com/svg/svgo/pull/1793)
- **Reuse Paths**, creates a new ID if the current one is referenced by
another element. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1784](https://github.com/svg/svgo/pull/1784)
- **Reuse Paths**, removes redundant `defs` children after optimization.
By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1785](https://github.com/svg/svgo/pull/1785)
- **Reuse Paths**, stops duplicating attributes into the shared
definition. By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1791](https://github.com/svg/svgo/pull/1791)
- Don't crash on a `null`, `undefined`, or empty plugin. Instead, log a
warning and ignore it. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/issues/1128](https://github.com/svg/svgo/issues/1128)

##### SVG Optimization

- **Convert Transform**, omit spaces between functions. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1802](https://github.com/svg/svgo/pull/1802)
- **Remove Scripts**, removes callbacks (`on*`) and `href` attributes
with `javascript:` URIs. By
[@&#8203;cakeinpanic](https://github.com/cakeinpanic) and
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1807](https://github.com/svg/svgo/pull/1807),
[https://github.com/svg/svgo/pull/1818](https://github.com/svg/svgo/pull/1818),
[https://github.com/svg/svgo/pull/1819](https://github.com/svg/svgo/pull/1819),
[https://github.com/svg/svgo/pull/1820](https://github.com/svg/svgo/pull/1820)
- **Convert One-Stop Gradients**, new plugin to convert gradients with
one stop to a solid color, disabled by default. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1790](https://github.com/svg/svgo/pull/1790)

##### Performance

- Various optimizations for path handling. By
[@&#8203;marvinhagemeister](https://github.com/marvinhagemeister) in
[https://github.com/svg/svgo/pull/1716](https://github.com/svg/svgo/pull/1716)
and
[https://github.com/svg/svgo/pull/1717](https://github.com/svg/svgo/pull/1717)

##### Chores

- Revise the README. By [@&#8203;ADTC](https://github.com/ADTC) in
[https://github.com/svg/svgo/pull/1731](https://github.com/svg/svgo/pull/1731)
- Fix dead link to postcss-svgo in README. By
[@&#8203;Lehoczky](https://github.com/Lehoczky) in
[https://github.com/svg/svgo/pull/1770](https://github.com/svg/svgo/pull/1770)
- Replace webpack loader library in README as previous was deprecated.
By [@&#8203;tanyabouman](https://github.com/tanyabouman) in
[https://github.com/svg/svgo/pull/1771](https://github.com/svg/svgo/pull/1771)

#### Metrics

Before and after using vectors from various sources, with the default
preset of each respective version:

| SVG | Original | v3.0.2 | v3.0.3 | Delta |
|---|---|---|---|---|
| [Arch Linux Logo](https://archlinux.org/art/) | 8.584 KiB | 4.748 KiB
| 4.747 KiB | ⬇️ 0.001 KiB |
|
[Blobs](https://gitlab.gnome.org/GNOME/gnome-backgrounds/-/blob/main/backgrounds/blobs-d.svg)
| 50.45 KiB | 42.949 KiB | 42.949 KiB | |
| [Isometric
Madness](https://inkscape.org/~Denis_Kuznetsky/%E2%98%85isometric-madness)
| 869.034 KiB | 550.829 KiB | 550.699 KiB | ⬇️ 0.13 KiB |
| [tldr-pages
Banner](https://github.com/tldr-pages/tldr/blob/main/images/banner.svg)
| 2.071 KiB | 1.07 KiB | 1.07 KiB | |
| [Wikipedia
Logo](https://en.wikipedia.org/wiki/File:Wikipedia-logo-v2.svg) |
161.552 KiB | 118.441 KiB | 118.441 KiB | |

Before and after of the browser bundle of each respective version:

| | v3.0.2 | v3.0.3 | Delta |
|---|---|---|---|
| svgo.browser.js | 643.5 kB | 651.7 kB | ⬆️ 8.2 kB |

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 6am on Monday" in timezone
Europe/Paris, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/cozy/cozy-stack).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40Ni4wIiwidXBkYXRlZEluVmVyIjoiMzcuNDYuMCIsInRhcmdldEJyYW5jaCI6Im1hc3RlciJ9-->
sungik-choi referenced this pull request in channel-io/bezier-react Nov 16, 2023
[![Mend Renovate logo
banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [svgo](https://svgo.dev) ([source](https://github.com/svg/svgo)) |
[`3.0.2` -> `3.0.3`](https://renovatebot.com/diffs/npm/svgo/3.0.2/3.0.3)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/svgo/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/svgo/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/svgo/3.0.2/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/svgo/3.0.2/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>svg/svgo (svgo)</summary>

### [`v3.0.3`](https://github.com/svg/svgo/releases/tag/v3.0.3)

[Compare Source](https://github.com/svg/svgo/compare/v3.0.2...v3.0.3)

Includes various bug fixes and optimizations for existing plugins.

We're also revamped the documentation for the project. You can find it
on [svgo.dev](https://svgo.dev/)!
The frontend for svgo.dev is maintained in
[svg/svgo.dev](https://github.com/svg/svgo.dev), contributions are
welcome.

#### What's Changed

##### Settings

- **Remove Comments**, introduces `preservePatterns` parameter.
Preserves legal comments by default, same as the previous behavior, but
can now be overridden. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1812](https://github.com/svg/svgo/pull/1812)
- **Remove Description**, set the `removeAny` parameter to `false` by
default for accessibility. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1806](https://github.com/svg/svgo/pull/1806)

##### Bug Fixes

- **Remove Raster Images**, removes inlined JPEG images. By
[@&#8203;abejfehr](https://github.com/abejfehr) in
[https://github.com/svg/svgo/pull/1742](https://github.com/svg/svgo/pull/1742)
- **Cleanup IDs**, correctly handle when 2 IDs have been referenced in a
single attribute. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1795](https://github.com/svg/svgo/pull/1795)
- **Cleanup IDS**, correctly handle when we've encountered a reference
to a node that doesn't exist. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1817](https://github.com/svg/svgo/pull/1817)
- **Inline Styles**, treat style prop keys as case-insensitive. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1797](https://github.com/svg/svgo/pull/1797)
- **Inline Styles**, remove all classes in multiclass selector. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1801](https://github.com/svg/svgo/pull/1801)
- **Inline Styles**, ignore empty CSS blocks instead of adding empty
style attribute. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1823](https://github.com/svg/svgo/pull/1823)
- **Minify Styles**, removes unused class selectors when the document
has no classes. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1800](https://github.com/svg/svgo/pull/1800)
- **Prefix IDs**, reuse the same prefix when encountering an ID multiple
times. By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1814](https://github.com/svg/svgo/pull/1814)
- **Remove Hidden Elements**, stops removing non-rendering elements like
masks. By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1793](https://github.com/svg/svgo/pull/1793)
- **Reuse Paths**, creates a new ID if the current one is referenced by
another element. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1784](https://github.com/svg/svgo/pull/1784)
- **Reuse Paths**, removes redundant `defs` children after optimization.
By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1785](https://github.com/svg/svgo/pull/1785)
- **Reuse Paths**, stops duplicating attributes into the shared
definition. By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1791](https://github.com/svg/svgo/pull/1791)
- Don't crash on a `null`, `undefined`, or empty plugin. Instead, log a
warning and ignore it. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/issues/1128](https://github.com/svg/svgo/issues/1128)

##### SVG Optimization

- **Convert Transform**, omit spaces between functions. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1802](https://github.com/svg/svgo/pull/1802)
- **Remove Scripts**, removes callbacks (`on*`) and `href` attributes
with `javascript:` URIs. By
[@&#8203;cakeinpanic](https://github.com/cakeinpanic) and
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1807](https://github.com/svg/svgo/pull/1807),
[https://github.com/svg/svgo/pull/1818](https://github.com/svg/svgo/pull/1818),
[https://github.com/svg/svgo/pull/1819](https://github.com/svg/svgo/pull/1819),
[https://github.com/svg/svgo/pull/1820](https://github.com/svg/svgo/pull/1820)
- **Convert One-Stop Gradients**, new plugin to convert gradients with
one stop to a solid color, disabled by default. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1790](https://github.com/svg/svgo/pull/1790)

##### Performance

- Various optimizations for path handling. By
[@&#8203;marvinhagemeister](https://github.com/marvinhagemeister) in
[https://github.com/svg/svgo/pull/1716](https://github.com/svg/svgo/pull/1716)
and
[https://github.com/svg/svgo/pull/1717](https://github.com/svg/svgo/pull/1717)

##### Chores

- Revise the README. By [@&#8203;ADTC](https://github.com/ADTC) in
[https://github.com/svg/svgo/pull/1731](https://github.com/svg/svgo/pull/1731)
- Fix dead link to postcss-svgo in README. By
[@&#8203;Lehoczky](https://github.com/Lehoczky) in
[https://github.com/svg/svgo/pull/1770](https://github.com/svg/svgo/pull/1770)
- Replace webpack loader library in README as previous was deprecated.
By [@&#8203;tanyabouman](https://github.com/tanyabouman) in
[https://github.com/svg/svgo/pull/1771](https://github.com/svg/svgo/pull/1771)

#### Metrics

Before and after using vectors from various sources, with the default
preset of each respective version:

| SVG | Original | v3.0.2 | v3.0.3 | Delta |
|---|---|---|---|---|
| [Arch Linux Logo](https://archlinux.org/art/) | 8.584 KiB | 4.748 KiB
| 4.747 KiB | ⬇️ 0.001 KiB |
|
[Blobs](https://gitlab.gnome.org/GNOME/gnome-backgrounds/-/blob/main/backgrounds/blobs-d.svg)
| 50.45 KiB | 42.949 KiB | 42.949 KiB | |
| [Isometric
Madness](https://inkscape.org/~Denis_Kuznetsky/%E2%98%85isometric-madness)
| 869.034 KiB | 550.829 KiB | 550.699 KiB | ⬇️ 0.13 KiB |
| [tldr-pages
Banner](https://github.com/tldr-pages/tldr/blob/main/images/banner.svg)
| 2.071 KiB | 1.07 KiB | 1.07 KiB | |
| [Wikipedia
Logo](https://en.wikipedia.org/wiki/File:Wikipedia-logo-v2.svg) |
161.552 KiB | 118.441 KiB | 118.441 KiB | |

Before and after of the browser bundle of each respective version:

| | v3.0.2 | v3.0.3 | Delta |
|---|---|---|---|
| svgo.browser.js | 643.5 kB | 651.7 kB | ⬆️ 8.2 kB |

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "on Monday after 10am before 7pm" in
timezone Asia/Seoul, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/channel-io/bezier-react).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40Ni4wIiwidXBkYXRlZEluVmVyIjoiMzcuNDYuMCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Ed Sungik Choi <sungik.dev@gmail.com>
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.

1 participant