@W-14118931: Require getToken prop if enabled to true in StorefrontPreview Component #1440
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vmarta
reviewed
Sep 15, 2023
| * @param {boolean} enabled - flag to turn on/off Storefront Preview feature | ||
| * @param {{function():string}} getToken - a STOREFRONT_PREVIEW customised function that fetches token of storefront | ||
| * @param {boolean} enabled - flag to turn on/off Storefront Preview feature. By default, it is set to true | ||
| * @param {function(): string | Promise<string>} getToken - A method that returns the access token for the current user |
There was a problem hiding this comment.
Yes, with the latest change in Preview code, we expect the function to return either a string or a promise 👍
| props['enabled'] === true && | ||
| (props[propName] === undefined || typeof props[propName] !== 'function') | ||
| ) { | ||
| return new Error(`${propName} is required for ${componentName} when enabled is true`) |
There was a problem hiding this comment.
Minor: not only the prop is required, it should also be a function.
Suggested change
| return new Error(`${propName} is required for ${componentName} when enabled is true`) | |
| return new Error(`${propName} is a required function for ${componentName} when enabled is true`) |
| @@ -113,7 +113,7 @@ const App = (props) => { | |||
| const {children} = props | |||
| const {data: categoriesTree} = useLazyLoadCategories() | |||
| const categories = flatten(categoriesTree || {}, 'categories') | |||
|
|
|||
| const {token} = useAccessToken() | |||
There was a problem hiding this comment.
Suggested change
| const {token} = useAccessToken() | |
| const {getTokenWhenReady} = useAccessToken() |
How about using getTokenWhenReady instead? Because the token can be null initially.
wjhsf
previously approved these changes
Sep 18, 2023
packages/template-retail-react-app/app/components/_app/index.jsx
Outdated
Show resolved
Hide resolved
| @@ -12,8 +12,8 @@ import {detectStorefrontPreview, getClientScript} from './utils' | |||
|
|
|||
| /** | |||
| * | |||
| * @param {boolean} enabled - flag to turn on/off Storefront Preview feature | |||
| * @param {{function():string}} getToken - a STOREFRONT_PREVIEW customised function that fetches token of storefront | |||
| * @param {boolean} enabled - flag to turn on/off Storefront Preview feature. By default, it is set to true | |||
There was a problem hiding this comment.
Do we want to explain here that enabled: true still only applies when the storefront is in a Runtime Admin iframe?
wjhsf
approved these changes
Sep 19, 2023
vmarta
approved these changes
Sep 19, 2023
12 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR made change to StorefrontPreview component in the SDK to require getToken prop if enabled to true, and set it up in the retail app
Types of Changes
Changes
How to Test-Drive This PR
You need to test this change in the Preview context
Check out the code
Build your pwa-kit-react-sdk
Run the storefront
Run the Runtime Admin
Go to: http://localhost:4000/salesforce-systems/scaffold-pwa/alex/preview
Observe that script is loaded as expected, no error about getToken function is prompted in the console
To trigger the getProp error, remove the getToken in Retail App _app component
Checklists
General
Accessibility Compliance
You must check off all items in one of the follow two lists:
or...
Localization