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

character_map appends a random string to the end #301

Open
alanking opened this issue Oct 8, 2024 · 0 comments
Open

character_map appends a random string to the end #301

alanking opened this issue Oct 8, 2024 · 0 comments
Labels
documentation Feature or usage needs explanation and/or example.

Comments

@alanking
Copy link
Collaborator

alanking commented Oct 8, 2024

Whenever the character_map event handler method is defined and it makes substitutions in a path, it also appends some random characters to the end of the resulting string, joined by an underscore.

For example: /data/ufs/tmpwv962nhj/test_character_mapped_top_level_file with a character_map which substitutes underscores (_) for hyphens (-) results in this logical path: /tempZone/home/rods/tmpwv962nhj/test-character-mapped-top-level-file-vuBRXjbeErHo6. Notice that the joining underscore was also substituted.

I believe this is here to prevent naming collisions in the event that multiple objects or collections are mapped to the same logical path. I could not find anything about this in the README, so we need to document this behavior and its justification.

Please be precise when documenting the behavior. It is very difficult to write tests for this behavior because I do not know how the random appendages are generated, so I cannot make assertions about expected logical paths.

@alanking alanking added the documentation Feature or usage needs explanation and/or example. label Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Feature or usage needs explanation and/or example.
Development

No branches or pull requests

1 participant