Skip to content

Avoid error if missing xattr support #690

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

Merged
rauhul merged 2 commits into from
Aug 1, 2025
Merged

Avoid error if missing xattr support #690

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
b5d9c74
Avoid error if missing xattr support
rauhul Jul 30, 2025
eaab3d8
review feedback
rauhul Jul 31, 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
18 changes: 13 additions & 5 deletions Sources/SWBCore/WorkspaceContext.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,13 +401,21 @@ extension FSProxy {
return try getExtendedAttribute(path, key: Self.CreatedByBuildSystemAttribute) == Self.CreatedByBuildSystemAttributeOnValue
}

/// Sets the "CreatedByBuildSystem" extended attribute on the specified
/// path.
///
/// - Important: The caller is responsible for catching and handling
/// failures if the filesystem does not support extended attributes. Many
/// filesystems (e.g. various non-ext4 temporary filesystems on Linux)
/// don't support xattrs and will return `ENOTSUP`. In particular, tmpfs
/// doesn't support xattrs on Linux unless `CONFIG_TMPFS_XATTR` is enabled
/// in the kernel config.
///
/// - Parameter path: The path on which to set the extended attribute.
/// - Throws: An error if the operation fails, including when the filesystem
/// doesn't support extended attributes.
public func setCreatedByBuildSystemAttribute(_ path: Path) throws {
// Many filesystems on other platforms (e.g. various non-ext4 temporary filesystems on Linux) don't support xattrs and will return ENOTSUP.
// In particular, tmpfs doesn't support xattrs on Linux unless `CONFIG_TMPFS_XATTR` is enabled in the kernel config.
// FIXME: Detect whether the FS supports xattrs at runtime
#if canImport(Darwin)
try setExtendedAttribute(path, key: Self.CreatedByBuildSystemAttribute, value: Self.CreatedByBuildSystemAttributeOnValue)
#endif
}

public func commandLineArgumentsToApplyCreatedByBuildSystemAttribute(to path: Path) -> [String] {
Expand Down
14 changes: 12 additions & 2 deletions Sources/SWBTaskExecution/TaskActions/CreateBuildDirectoryTaskAction.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,22 @@ public final class CreateBuildDirectoryTaskAction: TaskAction {

do {
try fs.createDirectory(directoryPath, recursive: true)
try fs.setCreatedByBuildSystemAttribute(directoryPath)
return .succeeded
} catch {
outputDelegate?.emitError(error.localizedDescription)
return .failed
}

// Warn on Darwin if we are unable to set the "CreatedByBuildSystem"
// attribute
do {
try fs.setCreatedByBuildSystemAttribute(directoryPath)
Copy link
Collaborator

@jakepetroules jakepetroules Jul 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The other alternative is we just use try? and drop the diagnostic entirely. @owenv, what do you think?

The reason I suggested the if-Darwin to @rauhul is because we'd otherwise have to change tests to ignore this message since most Linux build environments are using containers, which use tmpfs, which don't support xattrs.

Copy link
Collaborator

@neonichu neonichu Jul 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the xattr still control whether we're willing to clean a directory? If yes, it could be quite confusing that we never told the user about the fact that we couldn't set it.

Copy link
Collaborator

@owenv owenv Jul 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a setting to allow deleting directories without the attr, but I think this warning still makes sense

} catch {
#if canImport(Darwin)
outputDelegate?.emitWarning("Failed to set build system attribute on \(directoryPath.str): \(error.localizedDescription)")
#endif
}

return .succeeded
}

public override func performTaskAction(
Expand Down