Replace binary images with lighter SVG counterparts about autoware

[xmfcx]

@kenji-miyake I think we should add a rule in documentation to not allow binary image contributions.

(I don't know if it's practical to add a CI check for this.)

Maybe we can use this https://github.com/ppremk/lfs-warning to prevent them from being contributed.

[VRichardJP]

I don't know a thing about graphic software, but from a quick google it seems Inkscape has quick auto-vectorization tool:

https://github.com/autowarefoundation/autoware.universe/blob/main/planning/behavior_path_planner/image/lane_change/lane_change-enable_collision_check_at_prepare_phase.png

• Path > Trace Bitmap...
• Tab: Multicolor
• Detection Mode: Color
• Remove Background

Took me 30 seconds (sorry for dark mode users):

Size before: 7MB
Size after: 650KB

I don't know if it is a very clean SVG, in particular text is not stored as text, but it could be a quick and effective way to reduce image size. The better way would be to have access to the original files.

[kenji-miyake]

https://github.com/autowarefoundation/autoware.universe/blob/main/planning/behavior_path_planner/image/avoidance/avoidance_design.fig1.drawio.svg
Has no reason to be this large.

I'm not sure, but it might have some meta data for re-editing in draw.io.

[kenji-miyake]

@kenji-miyake I think we should add a rule in documentation to not allow binary image contributions.

@xmfcx I remember you said we can consider utilizing git-lfs for images.
Did you find any problem with git-lfs and change your mind?

(I don't know if it's practical to add a CI check for this.)

If we really disallow image files, I think checking on CI is good.

[xmfcx]

@xmfcx I remember you said we can consider utilizing git-lfs for images.
Did you find any problem with git-lfs and change your mind?

We had a discussion with the Autoware Planning & Control team in the WG meeting.

@kenji-miyake

The common agreement was that the draw.io metadata information (the binary blob) in the files are important for the team. We should keep them.

And to allow this, I had 2 solutions:

• Add git-lfs support for the image and binary files. (my preference)
• Replace the .svg files with smaller versions. But collect and host the original .drawio.svg files in some google drive, have links to them in the documentation. (too complicated and hard to maintain)

@esteve do you think adding git-lfs tracking to the generic image files in the middle of repository timeline might have any unknown side effects?

I would like to go with this option but we also need to update the documentation, maybe ansible scripts, maybe for certain CI actions (like mk-docs generation) to have this support.

[esteve]

@esteve do you think adding git-lfs tracking to the generic image files in the middle of repository timeline might have any unknown side effects?

I don't know of any side effects, but I agree with using git-lfs for storing the .svg files.

[xmfcx]

For example,
Following file:

https://github.com/autowarefoundation/autoware.universe/blob/main/planning/behavior_path_planner/image/avoidance/avoidance_design.fig1.drawio.svg

Has no reason to be this large.

But it has many binary images inside which can be replaced with vector images.

[xmfcx]

@VRichardJP thanks, I didn't know Inkscape could do it too.

I could get following in Illustrator following https://helpx.adobe.com/illustrator/using/image-trace.html

I'm not sure, but it might have some meta data for re-editing in draw.io

@kenji-miyake it's likely. Because when I opened the file with Illustrator and just saved it back without doing anything, it got reduced to 25KB.

We can still utilize git-lfs, but just for light vector files, it might not be necessary.

[kenji-miyake]

@xmfcx By the way, how critical is this issue? Do you have any specific problems caused by the repository size?

[xmfcx]

By the way, how critical is this issue? Do you have any specific problems caused by the repository size?

I'd say it has normal priority. Keeping repo small in general is a good practice. And earlier we do this, better it is. Because these binary files keep making the .git folder larger and larger with no return.

I've realized this while investigating why the autoware folder was so large. Then realized these images and it'd be a good thing to do if anyone would like to spare some time.

It'd be the best if people who contributed these files put here the lighter versions instead, since we might lose some quality otherwise.

[mehmetdogru]

@xmfcx agrees on closing the issue.