[BEAM-12534] Support the XDG Base Directory Specification

• Type: Wish
• Status: Open
• Priority: P3
• Resolution: Not A Problem
• Affects Version/s: 2.30.0
• Fix Version/s: Not applicable
• Component/s: cross-language, runner-core
• Environment: Linux
• Assignee: Unassigned
• Reporter: Ignacio Taranto
• Created: 24/Jun/21 13:34
• Updated: 24/Nov/24 07:29
• Resolved: 14/Apr/22 18:00

Description

Currently on Linux, Apache Beam puts it's cache under ~/.apache_beam/cache which is not nice for the user since it clutters he's/she's home directory.

I would suggest adding support for the XDG Base Directory Specification which basically states that:

• Cache files under go under $XDG_CACHE_HOME ($HOME/.cache if XDG_CACHE_HOME is not defined).
• Configuration files go under $XDG_CONFIG_HOME (with $HOME/.config if XDG_CONFIG_HOME is not defined)
• User data files go under $XDG_DATA_HOME ($HOME/.local/share if XDG_DATA_HOME is not defined)

In the case of Apache Beam the paths would be:

• $XDG_CACHE_HOME/apache_beam
• $XDG_CONFIG_HOME/apache_beam
• $XDG_DATA_HOME/apache_beam

This allow for easier backups and not cluttering the user's home directory with application files.

I know that the separation in this 3 categories require some refactor, but at least moving $HOME/.apache_beam to $HOME/.local/share/apache_beam would be a huge improvement.