Fix useServerContext returning isServerSide=false when on server.
#782
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
bfeister
approved these changes
Oct 20, 2022
vmarta
approved these changes
Oct 20, 2022
| */ | ||
| export const useServerContext = () => { | ||
| const serverContext = useContext(ServerContext) | ||
|
|
||
| return { | ||
| ...serverContext, | ||
| isServerSide: Boolean(serverContext.req) | ||
| ...serverContext |
There was a problem hiding this comment.
Minor: now that we're no longer extending the object, we can simply return the context directly like...
return useContext(ServerContext)
adamraya
added a commit
that referenced
this pull request
Oct 27, 2022
* [commerce-sdk-react] Add mutation hooks and refactor query hooks (#726) * add mutation hook and refactor query hook * lint * fix eslint * fix ts types * fix ts type for usequery * fix lint * fix test * lint * add mutation example * fix typo * DRY useAuthenticated * fix object.keys type * use better name * change mutation signature * fix types * rename mutations * fix typos * fix shopper login types * fix test * remove unused vars * refactor mutation types * allow useMutation to pass thru options * remove comment Co-authored-by: Alex Vuong <[email protected]> * Dynamic footer Copyright date (#741) * Update checkout-footer.jsx * whitespace to bump CLA check * Add translation and alternate footer changes (force push is to remove unsigned commits from git history) * Shopper promotions hooks (#759) * usePromotions and usePromotionsForCampaign hooks * Footer copyright: remove the remaining hardcoded year (#760) * Revert "Remove custom options for react query hoc (#755)" (#775) This reverts commit 9e0f596. * `<ImageGallery >` uses `image.link` when DIS is not set (#786) * Fix global context pollution coming from nock (#785) * Fix global context pollution coming from nock * remove nock debug env var * npm run lint:fix * remove IDE-inserted import * Use default locale as target if none is specified (#788) * Use default locale as target if none is specified * Update CHANGELOG.md * [commerce-sdk-react] Multisite support (#769) * add multisite support * add test * update comment * pr feedback * add locale * add locale props to queries * add cookie expire * attempt to address test issues * attempt to resolve test issue * fix test * fix test again Co-authored-by: Brian Feister <[email protected]> * ShopperOrders hooks & mutations (#766) * Implement useOrder and usePaymentMethodsForOrder hooks * Add useOrder shopper hook to test * Add usePaymentMethods hook to test * Added valid order # to test * Updating demo * Completed demo of useOrder and usePaymentMethods * Added tests * working on tests * Fix tests * remove custom mode * record mock * mock oauths/login endpoint * added more tests * Updating demos * add mock response * add mock response * Implement hooks in test-commerce * Began writing tests for mutation, implemented useTaxes hook, cleaned up test-commerce demo * Passing parameters and body to mutate function * Mutation test, tax hook, lint * mocked response * added removePaymentMethodForOrder hook test * lint * Remove mutation tests for now * remove mutation mocks * lint * remove nock for mutation * createOrder hook in test project Co-authored-by: Alex Vuong <[email protected]> * ShopperCustomer hooks and mutations (#762) * `useCustomer` hook * `useCustomerAddress` hook * `useCustomerOrders` hook * Solve merge conflicts * Refactor `useCustomer` test page * Add `useCustomerOrders` hook to test page * Add `useCustomerBaskets` hook * Add `useShopperCustomerProductList` hook * Clean up * Add ShopperCustomer mutations to test page * Solve merge conflicts * Wait to add test file until completed * Add initial `useCustomer` tests * add useRegisteredUser HOC * clean up * clean up * Add query hooks tests * Revert "Add use registered user HOC" (#783) * Add mutation test * Update query key structure & Invalidate cache onSuccess mutations * lint * Add `useQueryClient` * Update mock responses * Update usecustomer-returns-data.json * PR Feedback * Remove failing mutation test * update mock responses * try fix flaky test * restore test-utils * Solve merge conflict Co-authored-by: Alex Vuong <[email protected]> * [commerce-sdk-react] Implement shopper baskets hooks (#768) * Implement queries for shopperBasket hooks * Added UseShopperBasket page to test-commerce-sdk-react app * Added unit tests for ShopperBasket Queries * Added test integrations for ShopperBasket queries * Added test integrations for shopperbasket queries * wip * set cache keys * multiple refactors * bug fixes * lint * revert unnecessary changes * remove the bad test examples * revert temp shopper customer changes * fix test Co-authored-by: Jainam Tushar Sheth <[email protected]> Co-authored-by: Brian Feister <[email protected]> Co-authored-by: Adam Raya <[email protected]> * ApiClient config needs to be updated when cid is changed (#790) * Add Support policy to all SDKs (#764) * add Support policy to all SDKs * Additional default options for React Query (#791) * Explore having react-query config be on user land * PR feedback, and simplifying the default options * Revert to making this option applied server side only * Fix `useServerContext` returning `isServerSide=false` when on server. (#782) * Revert contraint on prepass JSX * PR feedback * Nock: clean up the list of mocks after each test (#792) * Update `instanceUrl` on `retail-react-app-demo` preset (#799) * Update changelog files * Bump alpha version * Upgrade minimatch (#793) * remove minimatch from sdk and update version in pwa-kit-dev * update lock files * update lock files * add more tests * add comment * lint * revert packge-lock file changes * update pwa-kit-dev package-lock.json * fix lockfile again Co-authored-by: Kevin He <[email protected]> Co-authored-by: Alex Vuong <[email protected]> Co-authored-by: Brian Feister <[email protected]> Co-authored-by: Alex Vuong <[email protected]> Co-authored-by: Vincent Marta <[email protected]> Co-authored-by: Charles Lavery <[email protected]> Co-authored-by: Ben Chypak <[email protected]> Co-authored-by: yunakim714 <[email protected]> Co-authored-by: Jainam Tushar Sheth <[email protected]>
adamraya
added a commit
that referenced
this pull request
Oct 27, 2022
* Starting release process for 2.3.0 * Add guards to result sent to Einstein (#756) * Add result guards to Einstein and PLP sendViewCategory Einstein * Bump alpha version * Update changelog * 🚢 `2.3.0-alpha.2` (#800) * [commerce-sdk-react] Add mutation hooks and refactor query hooks (#726) * add mutation hook and refactor query hook * lint * fix eslint * fix ts types * fix ts type for usequery * fix lint * fix test * lint * add mutation example * fix typo * DRY useAuthenticated * fix object.keys type * use better name * change mutation signature * fix types * rename mutations * fix typos * fix shopper login types * fix test * remove unused vars * refactor mutation types * allow useMutation to pass thru options * remove comment Co-authored-by: Alex Vuong <[email protected]> * Dynamic footer Copyright date (#741) * Update checkout-footer.jsx * whitespace to bump CLA check * Add translation and alternate footer changes (force push is to remove unsigned commits from git history) * Shopper promotions hooks (#759) * usePromotions and usePromotionsForCampaign hooks * Footer copyright: remove the remaining hardcoded year (#760) * Revert "Remove custom options for react query hoc (#755)" (#775) This reverts commit 9e0f596. * `<ImageGallery >` uses `image.link` when DIS is not set (#786) * Fix global context pollution coming from nock (#785) * Fix global context pollution coming from nock * remove nock debug env var * npm run lint:fix * remove IDE-inserted import * Use default locale as target if none is specified (#788) * Use default locale as target if none is specified * Update CHANGELOG.md * [commerce-sdk-react] Multisite support (#769) * add multisite support * add test * update comment * pr feedback * add locale * add locale props to queries * add cookie expire * attempt to address test issues * attempt to resolve test issue * fix test * fix test again Co-authored-by: Brian Feister <[email protected]> * ShopperOrders hooks & mutations (#766) * Implement useOrder and usePaymentMethodsForOrder hooks * Add useOrder shopper hook to test * Add usePaymentMethods hook to test * Added valid order # to test * Updating demo * Completed demo of useOrder and usePaymentMethods * Added tests * working on tests * Fix tests * remove custom mode * record mock * mock oauths/login endpoint * added more tests * Updating demos * add mock response * add mock response * Implement hooks in test-commerce * Began writing tests for mutation, implemented useTaxes hook, cleaned up test-commerce demo * Passing parameters and body to mutate function * Mutation test, tax hook, lint * mocked response * added removePaymentMethodForOrder hook test * lint * Remove mutation tests for now * remove mutation mocks * lint * remove nock for mutation * createOrder hook in test project Co-authored-by: Alex Vuong <[email protected]> * ShopperCustomer hooks and mutations (#762) * `useCustomer` hook * `useCustomerAddress` hook * `useCustomerOrders` hook * Solve merge conflicts * Refactor `useCustomer` test page * Add `useCustomerOrders` hook to test page * Add `useCustomerBaskets` hook * Add `useShopperCustomerProductList` hook * Clean up * Add ShopperCustomer mutations to test page * Solve merge conflicts * Wait to add test file until completed * Add initial `useCustomer` tests * add useRegisteredUser HOC * clean up * clean up * Add query hooks tests * Revert "Add use registered user HOC" (#783) * Add mutation test * Update query key structure & Invalidate cache onSuccess mutations * lint * Add `useQueryClient` * Update mock responses * Update usecustomer-returns-data.json * PR Feedback * Remove failing mutation test * update mock responses * try fix flaky test * restore test-utils * Solve merge conflict Co-authored-by: Alex Vuong <[email protected]> * [commerce-sdk-react] Implement shopper baskets hooks (#768) * Implement queries for shopperBasket hooks * Added UseShopperBasket page to test-commerce-sdk-react app * Added unit tests for ShopperBasket Queries * Added test integrations for ShopperBasket queries * Added test integrations for shopperbasket queries * wip * set cache keys * multiple refactors * bug fixes * lint * revert unnecessary changes * remove the bad test examples * revert temp shopper customer changes * fix test Co-authored-by: Jainam Tushar Sheth <[email protected]> Co-authored-by: Brian Feister <[email protected]> Co-authored-by: Adam Raya <[email protected]> * ApiClient config needs to be updated when cid is changed (#790) * Add Support policy to all SDKs (#764) * add Support policy to all SDKs * Additional default options for React Query (#791) * Explore having react-query config be on user land * PR feedback, and simplifying the default options * Revert to making this option applied server side only * Fix `useServerContext` returning `isServerSide=false` when on server. (#782) * Revert contraint on prepass JSX * PR feedback * Nock: clean up the list of mocks after each test (#792) * Update `instanceUrl` on `retail-react-app-demo` preset (#799) * Update changelog files * Bump alpha version * Upgrade minimatch (#793) * remove minimatch from sdk and update version in pwa-kit-dev * update lock files * update lock files * add more tests * add comment * lint * revert packge-lock file changes * update pwa-kit-dev package-lock.json * fix lockfile again Co-authored-by: Kevin He <[email protected]> Co-authored-by: Alex Vuong <[email protected]> Co-authored-by: Brian Feister <[email protected]> Co-authored-by: Alex Vuong <[email protected]> Co-authored-by: Vincent Marta <[email protected]> Co-authored-by: Charles Lavery <[email protected]> Co-authored-by: Ben Chypak <[email protected]> Co-authored-by: yunakim714 <[email protected]> Co-authored-by: Jainam Tushar Sheth <[email protected]> * 🚢 Version 2.3.0 (#802) * Version 2.3.0 * Update changelog files * Begin development on 2.4.0 Co-authored-by: Kevin He <[email protected]> Co-authored-by: Alex Vuong <[email protected]> Co-authored-by: Brian Feister <[email protected]> Co-authored-by: Alex Vuong <[email protected]> Co-authored-by: Vincent Marta <[email protected]> Co-authored-by: Charles Lavery <[email protected]> Co-authored-by: Ben Chypak <[email protected]> Co-authored-by: yunakim714 <[email protected]> Co-authored-by: Jainam Tushar Sheth <[email protected]>
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
A problem arose when investigating migrating the retail-react-app to use only
useQuery. When attempting to have a query only run on the server once (getting category data), we used theenabledoption set toisServerSideso that the query only ran when on the server.This however did not work as during the prepass stage
isServerSidewas false, meaning the query was never run.This logic of not having the response during prepass was intentional but had this side effect. We did this so that the response could not be mucked with during prepass and have other unintended results.
We decided to no enforce this and instead rely on educating users on proper and improper ways of modifying the response object. (e.g. only setting the response in a query function, or only setting it when the query is errored or succeeded).
Changes
isServerSidevalue from hook.How to Test-Drive This PR