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

Support backslash in getSlug util #6691

Merged
merged 1 commit into from Dec 8, 2022

Conversation

tedraykov
Copy link
Collaborator

Signed-off-by: tedraykov tedraykov@gmail.com

Impact: minor
Type: bugfix

Issue

When we save a slug that contains a /, the API automatically converts it to -.
For example, the tag slug men/jacket turns into men-jacket

Solution

Extend the slugify function to support / charecter.

Breaking changes

None

Testing

  • Create a new tag with a slug, that contains a /
  • Validate that the saved result contains the /

Signed-off-by: tedraykov <tedraykov@gmail.com>
@changeset-bot
Copy link

changeset-bot bot commented Dec 7, 2022

🦋 Changeset detected

Latest commit: 8392ba1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@reactioncommerce/api-utils Patch
reaction Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@@ -4,7 +4,7 @@
#
# See comment in docker-compose.dev.yml if you want to run for development.

version: "3.4"
version: "3.9"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why does this PR include a change to the docker file?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The syntax we use for the network declaration in the docker compose file is not supported in 3.4

networks:
  reaction:
    name: reaction.localhost
    external: true

I had errors in the IDE so I decided to bump it. This does not bring breaking behavior from what I've observed. I had all my docker-compose files to version 3.9 locally for months and haven't encountered any problems.

Copy link
Contributor

@sujithvn sujithvn left a comment

Choose a reason for hiding this comment

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

Good to go
Could add an additional test with string "new men/jacket" to get "new-men/jacket"

@zenweasel zenweasel merged commit 7e0f89c into reactioncommerce:trunk Dec 8, 2022
@github-actions github-actions bot mentioned this pull request Dec 8, 2022
@@ -13,5 +13,5 @@ const { slugify } = require("transliteration");
* @returns {String} slugified string
*/
export default function getSlug(slugString) {
return (typeof slugString === "string" && slugify(slugString)) || "";
return (typeof slugString === "string" && slugify(slugString, { allowedChars: "a-zA-Z0-9-/" })) || "";
Copy link
Collaborator

Choose a reason for hiding this comment

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

@tedraykov

Actually coming back to this I am concerned about this change being a global one and not specific to tags and may result in some unexpected behavior. I wonder if we can add a second argument of allowedChars, so that the default behavior remains the same.

This was referenced Dec 9, 2022
@tedraykov tedraykov deleted the fix/slash-slugs branch February 1, 2023 19:36
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.

None yet

4 participants