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

fix: handle special characters in boldString util #942

Conversation

breadadams
Copy link
Contributor

Description

Closes #940

Types of Changes

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Documentation update
  • Breaking change (could cause existing functionality to not work as expected)
  • Other changes (non-breaking changes that does not fit any of the above)

Breaking changes include:

  • Removing a public function or component or prop
  • Adding a required argument to a function
  • Changing the data type of a function parameter or return value
  • Adding a new peer dependency to package.json

Changes

  • (change1)

How to Test-Drive This PR

  • (step1)

Checklists

General

  • Changes are covered by test cases
  • CHANGELOG.md updated with a short description of changes (not required for documentation updates)

Accessibility Compliance

You must check off all items in one of the follow two lists:

  • There are no changes to UI

or...

Localization

  • Changes include a UI text update in the Retail React App (which requires translation)

+ Add a new util for escaping special regex characters
+ Apply new util to `boldString`
+ Add and update util tests
@bfeister
Copy link
Collaborator

bfeister commented Jan 26, 2023

@breadadams thanks for re-opening, looks like we are ✅ on CLA PR check now 🎉

Quoting your comment on the now-closed #941 PR

I seem to be getting an error when signing the CLA, I've contacted the support email listed on the error page.

Additionally I just wanted to say hi 👋 , I'm Brad, a frontend consultant working with an agency on a pwa-kit project. I've got another couple of contributions on the way soon, and hope to be able to add more in the future!

I'm currently quite invested in porting parts of the project over to TypeScript, if that's a topic you're also working on internally and are open to contributions please let me know! 🚀

We're grateful to see interest in Typescript, our challenge has been that we are still trying to understand the willingness of customers / implementers / SIs / partners to move to Typescript. Personally, I'm in favor of doing so but it hasn't been prioritized for the current release. Next release it could be something with more traction.

In the meantime, feel free to add a link to a fork / branch where you're doing that migration work and it will help us justify the change knowing that we've got a head start from community-contributed code 🏅

cc @natemarcus (our PM re: roadmap considerations)

expect(escapedString).toEqual('\\{\\}\\(\\)\\*\\+\\?\\.\\,\\\\\\^\\$\\|\\#')
})
})

Copy link
Collaborator

Choose a reason for hiding this comment

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

👍

Copy link
Collaborator

@bfeister bfeister left a comment

Choose a reason for hiding this comment

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

Thanks for adding test coverage on this @breadadams. Appreciate the contribution 🏅

@bfeister bfeister merged commit 7cb2532 into SalesforceCommerceCloud:develop Jan 30, 2023
ecRobertEngel pushed a commit to ecRobertEngel/pwa-kit that referenced this pull request Feb 8, 2023
…ceCloud#942)

+ Add a new util for escaping special regex characters
+ Apply new util to `boldString`
+ Add and update util tests

Co-authored-by: Brian Feister <[email protected]>
ecRobertEngel pushed a commit to ecRobertEngel/pwa-kit that referenced this pull request Feb 8, 2023
…ceCloud#942)

+ Add a new util for escaping special regex characters
+ Apply new util to `boldString`
+ Add and update util tests

Co-authored-by: Brian Feister <[email protected]>
alexvuong added a commit that referenced this pull request Feb 13, 2023
* New year, new look! (#876)

* New year, new look!

* Use JS to compute current year.

* Small bump to max deps allowed.

Needed to so that non-code changes will pass CI.
Hitting the limit can be addressed later.

* Update from 2.5.0 (#881)

* Starting release process for 2.5.0

* allow commerce react sdk to release

* bump version to 2.5.0 (#879)

* bump version to 2.5.0

* bump max packages

* Begin development on 2.6.0

* Set commerce-sdk-react package to private (#882)

* test-commerce: comment out not-implemented customer hooks (#877)

* Change padding (#899)

* [Snyk] Security upgrade eslint-import-resolver-webpack from 0.10.0 to 0.13.1 (#887)

* fix: packages/internal-lib-build/package.json & packages/internal-lib-build/package-lock.json to reduce vulnerabilities

The following vulnerabilities are fixed with an upgrade:
- https://snyk.io/vuln/SNYK-JS-DEBUG-3227433

* upgrade eslint-webpack-plugin-import, regen lock file

Co-authored-by: Alex Vuong <[email protected]>
Co-authored-by: Will Harney <[email protected]>

* Cache SLAS callback using request processor (#884)

* cache callback in request processor

* fix import path

* cache callback for a year

* use native URLSearchParams

* revert use native URLSearchParams

* Rotate fingerprint ssh for deploy commerce sdk doc (#905)

* Feature/megamenu fixes (#875)

* [W-11996527] WIP - commit megamenu spike results / findings to feature branch

* resolve search error

* move default variables to constants file

* cleanup code

* add aria-live to menu categories

* lint

* implement aria live and busy

* fix failing tests

* update mock categories data, implement aria busy for listmenu

* update mock data and fix list-menu test

* lint

* resolve unmounted component error

* temporary testing server errors fix

* set spinner opacity to 0 and increase max package value

* lint

* remove mock data from app code, clean up

* allow padding of categories with loaded: true to bypass initial useEffect API call

* fix last failing test

* Update list-menu/index.jsx

Co-authored-by: Will Harney <[email protected]>

* fix aria-busy implementation and cleanup

* add more test cases - when there is no root categories

* remove mit license comment

* add depndency array to useeffect

* globally mock getcategory api call

* WIP

* fix tests WIP

* remove all instances of setupmockserver in test files

* globally mock istokenvalid AND many other cleanup items

* refactor tree walking code

* add locale checks and time to localstorage

* WIP removing tree walking logic

* remove tree walking code, update setroot and extract stale time

* add catch to promise all

* lint

* namespace constants, remove unnecessary try catch...

* final cleanup

* fix lint

Co-authored-by: Brian Feister <[email protected]>
Co-authored-by: Will Harney <[email protected]>
Co-authored-by: Kevin He <[email protected]>

* Mega menu fixes (#910)

* Remove unnecessary catch clause.

* Update copyright.

* Don't return error when category is expected.

* Fix bug preventing cache invalidation.

* Set fetchTime when data is fetched, rather than every page load.

* Update comment.

* Convert promise chain to async/await for readability.

* Guard against missing category items.

* Move comment inside code block.

* Change useEffect back to promise chain, not async/await.

useEffect expects the callback to return nothing or a function;
returning a promise could break things.

* GitHub Actions (#854)

* Add test workflow

* Use actions/checkout v3

* Don't use CI image

* Add step install npm dependencies

* Add setup action

* Set DEVELOP and RELEASE env variables

* Add required shell property

* Update action.yml

* Update action.yml

* Adding test matrix

* cleanup

* Split setup windows and ubuntu

* Update test.yml

* Update test.yml

* Add Lighthouse and smoketest scripts

* Not using actions/cache for now

* Add generated matrix

* Add missing runs-on prop to generated matrix

* Add Setup Node step to generated matrix

* Add Setup machine to generated matrix

* Add cron schedule

* Add timeout-minutes 5

* Move timeout to generate project step

* Add Run tests on generated projects

* Use dynamic generated-project folder

* Run tests on test-project and retail-react-app-demo

* Add Push Bundle step

* Skip flaky test

* Disable fail-fast strategy

* Use env variables

* Re-arrange env

* Add step before push bundle

* cleanup

* cleanup

* Use temp test-env-3

* testing slack notifs

* testing

* add publish to npm step

* fix indent

* python-dev does not exist anymore

* use python2

* increase max packages

* test slack notifs

* add snyk cli and datadog step

* update mrt user credentials

* testing slack with pwa kit channel

* syntax

* fix conditionals

* test push bundle

* add push bundle step for generated

* syntax

* fix syntax error

* update slack payload

* run steps in container

* testing

* refactor

* syntax

* sudo container error

* testing

* update

* add pip

* use different docker

* no container

* container

* testing

* add user to container

* fix

* syntax add shell

* syntax errors

* remove container, use act

* syntax errors

* add snyk audit and other syntax stuff

* extract steps to own actions

* add inputs for actions

* add shell for steps in actions with run

* project cannot be generated in action file

* updated snyk token, uncommenting code

* Fix typo.

* Add missing appkey property.

* Use snake_case names for legibility.

* Restore missing clean check

* Fix skipped conversion to snake_case.

* Trim trailing whitespace.

* Extract conditionals to vars and clean up vars.

* Change env IS_TESTABLE_TEMPLATE to more clear IS_TEMPLATE_FROM_RETAIL_REACT_APP

* Fix YAML breaking conditional.

* Try explicitly checking value.

* Try explicitly checking true/false string values.

* Try string comparisons.

* Fix bad YAML.

* Replace " with '

* Get ready for the prime time!

* Fail fast!

* Update TODOs.

* Clean up npm version management.

* Add TODO to merge workflows.

* Update step names.

* End files with newline.

* Run on pull_request to support forked repos.

* Only run on push for develop/release.

We can assume all other branches will eventually have a PR.

* Only push to MRT when actually desired.

* Get that JavaScript nonsense outta here!

* Check DEVELOP in step conditional, not in action execution.

* Add some TODOs.

* Too many newlines!

Co-authored-by: yunakim714 <[email protected]>
Co-authored-by: yunakim714 <[email protected]>
Co-authored-by: Will Harney <[email protected]>
Co-authored-by: Will Harney <[email protected]>

* GitHub Actions fixes (#915)

* Update is not fork check

* Add single quote to cron expression

* Add cron docs

* Remove Circle CI config, fix IS_NOT_FORK (#921)

* Fix develop branch name (#923)

* Fix wrong proptypes (#924)

* fix wrong proptypes

* Update packages/template-retail-react-app/app/components/recommended-products/index.jsx

Co-authored-by: Vincent Marta <[email protected]>

Co-authored-by: Brian Feister <[email protected]>
Co-authored-by: Vincent Marta <[email protected]>

* Update createOrder to send SLAS USID (#920)

* Update createOrder to send SLAS USID

* Modify some tests to include setting the header

Co-authored-by: echessman <[email protected]>

* Upgrade prettier to v2 (#926)

* Upgrade to prettier v2 for modern TypeScript support.

* Change trailing comma to prettier v1 default.

Minimizes changes during v2 upgrade.

* Apply prettier v2 formatting changes.

Yaaay touching all of the files!

* Set end of line to LF.

* Remove unnecessary map statement (#929)

* fix: packages/pwa-kit-runtime/package.json & packages/pwa-kit-runtime/package-lock.json to reduce vulnerabilities (#935)

The following vulnerabilities are fixed with an upgrade:
- https://snyk.io/vuln/SNYK-JS-UAPARSERJS-3244450

Co-authored-by: snyk-bot <[email protected]>

* Update `develop` with v2.6.0 (#939)

* Starting release process for 2.6.0

* 🚢 Release v2.6.0 (#937)

* Update changelog files

* Set `commerce-sdk-react-preview` as public

* Version 2.6.0

* Begin development on 2.7.0

* Clean changelog files

* Allow support for multiple sites concurrently w/ `commerce-sdk-react` (#911)

* Namespace storage keys using the current siteId.

Co-authored-by: Will Harney <[email protected]>

* @W-11920099 Re-write 'npm push' in Typescript, warn if Node deprecated (#763)

* Rewrite ancient scripts in Typescript.
* Show warnings on push when using a deprecated Node version.
* Automatically select a `.mobify` credentials file based on `--cloud-origin`.

* Fix broken CI – confusing path to package.json in the 'dist' directory! (#946)

* Reliably look up project and pwa-kit-dev package.json in scripts

* fix: handle special characters in `boldString` util (#942)

+ Add a new util for escaping special regex characters
+ Apply new util to `boldString`
+ Add and update util tests

Co-authored-by: Brian Feister <[email protected]>

* Replace isomorphic jest mocks with msw handlers (#944)

* replace most manual mocks

* more replacements

* more replacements in addresses test

* lint

* resolve flaky cart test

* remove some jest mocks

* replace all isomorphic mocks

* cleanup

* fix auth modal mocks

* remove timers from auth hooks test, fix password test

* remove timer from create account test

* add timeout

* cleanup

---------

Co-authored-by: Brian Feister <[email protected]>

* Remove the PersistentCache functionality (#949)

* Initial pass at PersistentCache

* Drop test coverage

* Change test

* Update customer baskets cache when there is a basket mutation (#945)

* update customer baskets cache on basket mutations

* Fix layout shift for mega menu (#952)

* remove custom styling

* remove theme in theme file

* spinners in drawer menu should be visible

* Serialize category data once only (#953)

* serialize data only once

* remove console log

---------

Co-authored-by: Brian Feister <[email protected]>

* chore: update pwa-kit-dev eslint config (#950)

+ Bump `eslint-plugin-react` to latest version
+ Auto-detect React version

Co-authored-by: Adam Raya <[email protected]>

* resolving testing/merge errors

* Add Shopper Experience hooks (#958)

* Initial commit

* Update license

* Update test project to use bjnl_dev

* Fix usePage hook and Refactor test page

* Add usePages hook

* Add usePages pdp and plp test cases

* Clean up

* Update Changelog & Restore `zzrf-001` config

---------

Co-authored-by: Ben Chypak <[email protected]>

* add changelog

* Apply changes from commerce react sdk in feature branch (#964)

* apply change from commerce react sdk in feature branch

* Remove wrong changlog

* keep the same as develop

* linting

* fix formatMessage

* bump sizes temporarily

* fix product list tests

* fix header tests

* fix add to cart modal

* skip tests and low test coverate temporarily

* linting

---------

Co-authored-by: Will Harney <[email protected]>
Co-authored-by: Alex Vuong <[email protected]>
Co-authored-by: vcua-mobify <[email protected]>
Co-authored-by: Vincent Marta <[email protected]>
Co-authored-by: Pavel <[email protected]>
Co-authored-by: Snyk bot <[email protected]>
Co-authored-by: Alex Vuong <[email protected]>
Co-authored-by: yunakim714 <[email protected]>
Co-authored-by: Brian Feister <[email protected]>
Co-authored-by: Adam Raya <[email protected]>
Co-authored-by: yunakim714 <[email protected]>
Co-authored-by: Will Harney <[email protected]>
Co-authored-by: Brian Feister <[email protected]>
Co-authored-by: echessman <[email protected]>
Co-authored-by: CC ProdSec <[email protected]>
Co-authored-by: Ben Chypak <[email protected]>
Co-authored-by: Oliver Brook <[email protected]>
Co-authored-by: Brad Adams <[email protected]>
Co-authored-by: Kieran Haberstock <[email protected]>
Co-authored-by: Ben Chypak <[email protected]>
bfeister added a commit that referenced this pull request Feb 16, 2023
* develop: (52 commits)
  fix localstorage key by add siteId prefix (#988)
  [Shopper Experience] `ImageTile` component (#967)
  Skip Snyk CLI (#983)
  fix(retail-react-app): recent searches (#969)
  [Feature] Shopper Experience / Page Designer Components (#963)
  fix(template-retail-react-app): improved handling of blocked einstein requests (#970)
  remove getResetPasswordToken from not implemented list (#973)
  Apply changes from commerce react sdk in feature branch (#964)
  Add Shopper Experience hooks (#958)
  chore: update pwa-kit-dev eslint config (#950)
  Serialize category data once only (#953)
  Fix layout shift for mega menu (#952)
  Update customer baskets cache when there is a basket mutation (#945)
  Remove the PersistentCache functionality (#949)
  Replace isomorphic jest mocks with msw handlers (#944)
  fix: handle special characters in `boldString` util (#942)
  Fix broken CI – confusing path to package.json in the 'dist' directory! (#946)
  @W-11920099 Re-write 'npm push' in Typescript, warn if Node deprecated (#763)
  Allow support for multiple sites concurrently w/ `commerce-sdk-react` (#911)
  Update `develop` with v2.6.0 (#939)
  ...

# Conflicts:
#	lerna.json
#	package-lock.json
#	package.json
#	packages/commerce-sdk-react/CHANGELOG.md
#	packages/commerce-sdk-react/package-lock.json
#	packages/commerce-sdk-react/package.json
#	packages/internal-lib-build/package-lock.json
#	packages/internal-lib-build/package.json
#	packages/pwa-kit-create-app/package-lock.json
#	packages/pwa-kit-create-app/package.json
#	packages/pwa-kit-dev/CHANGELOG.md
#	packages/pwa-kit-dev/bin/pwa-kit-dev.js
#	packages/pwa-kit-dev/package-lock.json
#	packages/pwa-kit-dev/package.json
#	packages/pwa-kit-react-sdk/CHANGELOG.md
#	packages/pwa-kit-react-sdk/package-lock.json
#	packages/pwa-kit-react-sdk/package.json
#	packages/pwa-kit-react-sdk/src/ssr/browser/main.jsx
#	packages/pwa-kit-runtime/CHANGELOG.md
#	packages/pwa-kit-runtime/package-lock.json
#	packages/pwa-kit-runtime/package.json
#	packages/template-express-minimal/package-lock.json
#	packages/template-express-minimal/package.json
#	packages/template-retail-react-app/app/commerce-api/mock-data.js
#	packages/template-retail-react-app/package-lock.json
#	packages/template-retail-react-app/package.json
#	packages/template-typescript-minimal/package-lock.json
#	packages/template-typescript-minimal/package.json
#	packages/test-commerce-sdk-react/package-lock.json
#	packages/test-commerce-sdk-react/package.json
@breadadams
Copy link
Contributor Author

Hey @bfeister @natemarcus, I know it's been a while, but I've had pending note to leave a response here 🙂.

In the meantime, feel free to add a link to a fork / branch where you're doing that migration work and it will help us justify the change knowing that we've got a head start from community-contributed code 🏅

Based on the way my client's project is handled we're not really able to create a public fork unfortunately. We've moved a large portion of the template codebase over to TS, however of course with all the customisations it's not at all 1:1 with the template anymore.

Nevertheless, if this gets added to the roadmap for a future release and you need any assistance I'd be more than happy to help, be that reviewing PRs or whatever ✌️ .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] template-retail-react-app: search suggestions with special characters
2 participants