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.

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

remove site alias and locale from location.state.directedFrom path #1065

Merged
merged 4 commits into from
Mar 25, 2023
+58 −4
Merged

remove site alias and locale from location.state.directedFrom path #1065

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
72f0e07
remove site alias and locale from location.state.directedFrom path
sandragolden Mar 15, 2023
6bebe3c
moving call to removeSiteLocaleFromPath into use-navigation hook
sandragolden Mar 18, 2023
d3917b0
fixing failing test, added tests for removeSiteLocaleFromPath
sandragolden Mar 23, 2023
9559181
per code review, skipping failed test instead of using mocking
sandragolden Mar 24, 2023
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
5 changes: 3 additions & 2 deletions packages/template-retail-react-app/app/hooks/use-navigation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
/*
* Copyright (c) 2021, salesforce.com, inc.
* Copyright (c) 2023, Salesforce, Inc.
* All rights reserved.
* SPDX-License-Identifier: BSD-3-Clause
* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
*/
import {useCallback} from 'react'
import {useHistory} from 'react-router'
import useMultiSite from './use-multi-site'
import {removeSiteLocaleFromPath} from '../utils/url'

/**
* A convenience hook for programmatic navigation uses history's `push` or `replace`. The proper locale
Expand All @@ -26,7 +27,7 @@ const useNavigation = () => {
* @param {...any} args - additional args passed to `.push` or `.replace`
*/
(path, action = 'push', ...args) => {
const updatedHref = buildUrl(path)
const updatedHref = buildUrl(removeSiteLocaleFromPath(path))
history[action](path === '/' ? '/' : updatedHref, ...args)
},
[localeShortCode, site]
Expand Down
7 changes: 7 additions & 0 deletions packages/template-retail-react-app/app/pages/checkout/confirmation.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@ jest.mock('../../commerce-api/auth', () => {
}
})

jest.mock('../../utils/url', () => {
return {
...jest.requireActual('../../utils/url'),
removeSiteLocaleFromPath: jest.fn()
}
})

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
jest.mock('../../utils/url', () => {
return {
...jest.requireActual('../../utils/url'),
removeSiteLocaleFromPath: jest.fn()
}
})

This makes the test pass, but it does so by not actually testing the code, so it doesn't really solve the problem. 😕

Copy link
Contributor Author

@sandragolden sandragolden Mar 24, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

yes, i know. see same conversation here.

f8f4504#r105815160

the test is failing on the navigate back to the account page where removeSiteLocaleFromPath is called.

The chain ultimately goes:
removeSiteLocaleFromPath -> getParamsFromPath -> absoluteUrl -> getAppOrigin

which ultimately breaks here with TypeError: Cannot read properties of null (reading '_location')

const getAppOrigin = () => {
  if (typeof window !== 'undefined') {
    return window.location.origin;
  }
  ...
}

no amount of mocking any of the above functions would work. if you console out the window.location.pathname in the test, you will see it's the same as what the test expects (expect(window.location.pathname).toEqual('/uk/en-GB/account')). I'm open to ideas. 🤷‍♀️

this is a minor bug that i'm trying to get in to support hybrid deployments and just trying to clear this failing test. I'll attempt more efforts later

Copy link
Contributor

Choose a reason for hiding this comment

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

Given the nature of the bug fix and the fact that all of our tests are super flaky (not just this one), I think it's fine if you just disable the broken one with test.skip for now, and we'll re-enable it once we've fixed our testing setup.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

perfect, thanks @wjhsf, all set.

const mockOrder = keysToCamel({
basket_id: 'testorderbasket',
...ocapiOrderResponse
Expand Down
26 changes: 26 additions & 0 deletions packages/template-retail-react-app/app/utils/url.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,3 +259,29 @@ export const removeQueryParamsFromPath = (path, keys) => {

return `${pathname}${paramStr && '?'}${paramStr}`
}

/*
* Remove site alias and locale from a given url, to be used for "navigate" urls
*
* @param {string} pathName - The part of url to have site alias and locale removed from
* @returns {string} - the path after site alias and locale have been removed
* @example
* import {removeSiteLocaleFromPath} from /path/to/util/url
*
* removeSiteLocaleFromPath(/RefArch/en-US/account/wishlist)
* // returns '/account/wishlist'
*/
export const removeSiteLocaleFromPath = (pathName = '') => {
let {siteRef, localeRef} = getParamsFromPath(pathName)

// remove the site alias from the current pathName
if (siteRef) {
pathName = pathName.replace(new RegExp(`/${siteRef}`, 'g'), '')
}
// remove the locale from the current pathName
if (localeRef) {
pathName = pathName.replace(new RegExp(`/${localeRef}`, 'g'), '')
}

return pathName
}
25 changes: 24 additions & 1 deletion packages/template-retail-react-app/app/utils/url.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ import {
rebuildPathWithParams,
removeQueryParamsFromPath,
absoluteUrl,
createUrlTemplate
createUrlTemplate,
removeSiteLocaleFromPath
} from './url'
import {getUrlConfig} from './utils'
import mockConfig from '../../config/mocks/default'
Expand Down Expand Up @@ -389,3 +390,25 @@ describe('absoluteUrl', function () {
expect(url).toEqual('https://www.example.com/uk/en/women/dresses')
})
})

describe('removeSiteLocaleFromPath', function () {
test('return path without site alias and locale', () => {
const pathName = removeSiteLocaleFromPath('/uk/en-GB/account/wishlist')
expect(pathName).toEqual('/account/wishlist')
})

test('return path without site alias if they appear multiple times', () => {
const pathName = removeSiteLocaleFromPath('/uk/en-GB/uk/en-GB/account/wishlist')
expect(pathName).toEqual('/account/wishlist')
})

test('return expected path name when no locale or site alias appear', () => {
const pathName = removeSiteLocaleFromPath('/account/wishlist')
expect(pathName).toEqual('/account/wishlist')
})

test('return empty string when no path name is passed', () => {
const pathName = removeSiteLocaleFromPath()
expect(pathName).toEqual('')
})
})