Fix `getConfig` referencing config from incorrect location #1049

bendvc · 2023-03-10T17:25:22Z

Description

This PR fixes #986. As described in the issue, the getConfig function is using the config defined in the projects source folder when pushing a bundle. Although this isn't major issue as the push command in a given project will build the project before pushing. But if you are to use the pwa-kit-dev cli directly outside of running in an npm script for a project that is already built, then you'll have issues.

The change involves passing an option argument to getConfig to override where the config should be loaded from. I also fixed a couple other bugs in the code that I came across. I've left comments in the PR about those.

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)

Changes

Fix target environment variable being "undefined"
Allow getConfig to be passed a buildDirectory path which will override the searchFrom value used in cosmifconfig
Fix push option description to be more clear

How to Test-Drive This PR

(step1)

bendvc · 2023-03-10T17:27:58Z

packages/pwa-kit-dev/bin/pwa-kit-dev.js

@@ -249,7 +249,7 @@ const main = async () => {
        .addOption(
            new program.Option(
                '-b, --buildDirectory <buildDirectory>',
-                'a custom project directory where your build is located'
+                'a custom project build directory that you want to push'


I feel like this description was a little misleading, and clarified that it's the build folder that we want.

bendvc · 2023-03-10T17:30:25Z

packages/pwa-kit-dev/bin/pwa-kit-dev.js

+                if (target) {
+                    process.env.DEPLOY_TARGET = target
+                }


I noticed that when this environment variable is used in the ssr-config.js file, its value was always defined. In fact it was a string literal "undefined", this meant that the locations were cosmiconfig searched included config/undefined.ext meaning you could drop a file named "undefined.json" in your config and it would try reading it.

Adding a guard fixed this.

bendvc · 2023-03-10T18:03:33Z

packages/pwa-kit-runtime/src/utils/ssr-config.server.js

    // Combined search places.
    const searchPlaces = [
-        ...targetSearchPlaces,
-        ...(!isRemote ? localeSearchPlaces : []),
+        ...(targetName ? targetSearchPlaces : []),


targetName is potentially undefined as mentioned in a previous comment. This condition ensures we aren't searching for files that we shouldn't. This condition could be places above, but I put it here to go with out the other condition below it works.

bendvc · 2023-03-10T18:05:05Z

packages/pwa-kit-runtime/src/utils/ssr-config.server.js

@@ -52,7 +59,7 @@ export const getConfig = () => {
    // Match config files based on the specificity from most to most general.
    const explorerSync = cosmiconfigSync(targetName, {
        packageProp: 'mobify',
-        searchPlaces: searchPlaces.map((path) => (isRemote ? `build/${path}` : path)),
+        searchPlaces: searchPlaces,


This logic is not required anymore as the same result is accomplished by using the searchFrom property in the search function below. (this option was also required to fix the original issue and look in a different folder).

vmarta · 2023-03-13T22:17:46Z

packages/pwa-kit-runtime/src/utils/ssr-config.server.test.js

+    })
+
+    afterEach(() => {
+        process.env = env


Minor: Should this be the same as on line 18 above?

I essentially borrowed that from here. I believe the idea is to restore to the actual value and not a copy of the original values. And to also only modify a copy, not modify (add/remove) values during the rest run.

vmarta · 2023-03-13T22:28:42Z

packages/pwa-kit-runtime/src/utils/ssr-config.server.js

    let targetName = process?.env?.DEPLOY_TARGET || ''

    const targetSearchPlaces = SUPPORTED_FILE_TYPES.map((ext) => `config/${targetName}.${ext}`)
    const localeSearchPlaces = SUPPORTED_FILE_TYPES.map((ext) => `config/local.${ext}`)
    const defaultSearchPlaces = SUPPORTED_FILE_TYPES.map((ext) => `config/default.${ext}`)

+    const searchFrom = buildDirectory || process.cwd() + '/' + configDirBase


🤔 what's the value for buildDirectory here? Do we need to prepend it with process.cwd() perhaps?

The the idea here was to have the buildDirectory option in the 'build' command be symmetrical with the buildDirectory option in the 'push' commend. So that being said, it can accept both a relative path and an absolute path.

The weird thing I just spotted after you brought this up was that cosmiconfig didn't really care if the buildDirectory existed or not, because by default it will start traversing the file tree upwards looking for configuration files.

This behaviour in the context of pushing wasn't great because it would take a while to fail since it's possible that it found a package.json file further up the file tree and used that for the push config, then only failed during the build step.

So I took extra precaution and decided to throw if the buildDirectory you supply doesn't exist.

So after all that, to answer you question we are taking the absolute or relative path and passing it to cosmiconfig, which from the documentation doesn't specify if it has to be relative or absolute. It's possible that it resolves it internally.

vmarta

Other than the 1 minor comment, this PR looks good to me.

* Update `develop` with `release-v2.7.0` (#1033) * Starting release process for 2.7.0 * Update Create MRT credentials file (#1025) * Release 2.7: fix order of hooks (#1027) * Return early only after all of the hooks are called * Bumper version --------- Co-authored-by: Ben Chypak <[email protected]> * Quick fix for einstein data (#1028) * Quick fix for einstein data * Bump Version * Re-lock package-lock files with npm 8 * Update package-lock.json * Update einstein.js * Regenerate lock files (#1030) * Regenerate lock files * Bump version to 2.7.0-alpha.3 * Bump to 2.7.0 (#1032) * Begin development on 2.8.0 --------- Co-authored-by: Adam Raya <[email protected]> Co-authored-by: Vincent Marta <[email protected]> * Move the MRT reference app to the SDKs, so that we can verify eg. Node support (#966) * BUG: Changed type of the phone number field to bring up numberic keyboard on mobile devices - W-9871940 (#1016) Co-authored-by: Ben Chypak <[email protected]> * Update Retail React App Page Designer integration README (#1041) Co-authored-by: Richard Sexton <[email protected]> * Implement `updateCustomerPassword` as no-op. (#1031) * Allow query hook parameters to be `null`. (#1046) * Remove unused util. * Allow query hook parameters to be `null`. * Fix addresses not having preferred address first. (#1051) * Fix addresses not having preferred address first. * Include all addresses, not just preferred address twice. * Correctly include preferred address. * Make `mergeBasket` Conditional More Robust (#1048) * Update merge logic * Update CHANGELOG.md * Lint * PR feedback * Rename isNewlyRegisters to isNew for simplicity * Lint * [commerce-sdk-react] Decode pre-fetched token and save auth data in storage (#1052) * add test * decode jwt data * lint * Update packages/commerce-sdk-react/src/auth/index.ts Co-authored-by: Will Harney <[email protected]> * rename parseSlasJWT * Update packages/commerce-sdk-react/src/auth/index.test.ts Co-authored-by: Will Harney <[email protected]> * convert all .thens to await * make fake token in tests more clear * lint --------- Co-authored-by: Will Harney <[email protected]> * Prevent modal to open when it fails to add an item to cart (#1053) * prevent modal to open when it fails to add an item to cart * Update comment --------- Co-authored-by: Alex Vuong <[email protected]> * Fix `getConfig` referencing config from incorrect location (#1049) * Initial Commit * Update CHANGELOG.md * Revert some testing code * Get test coverage back up * Test build directory folder before proceeding. * fix(template-retail-react-app): product-list refinements (#957) * fix(template-retail-react-app): product-list refinements + Ensure that the `selectedFilters` provided to the `Refinements` value components is always an array. And update said value components (checkbox, color, radio & size) to handle always receiving an array. + Apply some loose equality checks, catering for cases where a refinement URL param is parsed as a number but the refinement `.value` is a stringified number. + Fix bug where non-multiple filters could not be unchecked by selecting themselves (e.g. clicking an already checked checkbox). + Fix bug where a refinement URL param is parsed as a number, but was handled as a string (with `.split()`). + Fix bug where radio refinements would still appear as checked after clearing the value via `SelectedRefinements`. + Deprecate unused proptypes in `SizeRefinements` * feat(retail-react-app): update `CheckboxRefinements` + Adjust the `onChange` logic so that multiple checkbox refinements can be selected --------- Co-authored-by: Ben Chypak <[email protected]> * update docs for shopper-experience scope (#1059) * add docs for experience scope * Add `merge_group` event to trigger GA builds --------- Co-authored-by: Will Harney <[email protected]> Co-authored-by: Adam Raya Navarro <[email protected]> * Update lockfiles to reflect current version. (#1071) * [commerce-sdk-react] Implement remaining Shopper Baskets cache logic (#1070) * Refactor Shopper Basket cache following new pattern * Fix types * Update packages/commerce-sdk-react/src/hooks/ShopperBaskets/cache.ts Co-authored-by: Will Harney <[email protected]> * PR Feedback * Clean up unused utils and types after refactor * Add missing response basketId to queryKey * Implement cache for the remaining mutations * Tests WIP * PR Feedback & Use query key path in `deleteBasket` cache * Add tests for mutations returning void response * PR Feedback * Remove unused `and` hooks util * Revert "Remove unused `and` hooks util" This reverts commit c0a364a. --------- Co-authored-by: Will Harney <[email protected]> * [commerce-sdk-react] Fix Shopper Baskets Test case (#1082) * Fix Shopper Basket empty response test cases * lint * feat(pwa-kit-dev): minor performance improvements and added comments (#974) * feat(pwa-kit-dev): minor performance improvements and added comments * docs(pwa-kit-dev): clean up comments * refactor(pwa-kit-dev): update condition from PR feedback --------- Co-authored-by: Will Harney <[email protected]> * Update dependencies. (#1079) * Remove internal packages to bypass lerna nonsense. Include output.json to make restoring deps easier. * Disable build scripts to make changing deps easier. * Update root deps. * Fix typescript issue. * Create restore script to restore internal deps/scripts. * Update commerce-sdk-react deps. * Update test-commerce-sdk-react deps. * Update template-typescript-minimal deps * Improve restore script. * Fix trailing comma. * Update template-retail-react-app deps * npm prune everything * Update pwa-kit-runtime deps * Update pwa-kit-react-sdk deps * Update pwa-kit-create-app deps * Update pwa-kit-dev deps (except eslint) * Update pwa-kit-dev eslint deps * Update internal-lib-build deps (except eslint) * Update pwa-kit eslint deps * Restore internal deps. * Restore build scripts. * Remove temporary helper files. * Bump ua-parser-js to avoid vulnerable version. * Anchor cross-env common dep to version used by internal-lib-build. * Re-enable eslint. * Implement Cache Logic for Shopper APIs (Contexts/Customers/Login/Orders) (#1073) * Initial commit * Update packages/commerce-sdk-react/src/hooks/useAuthHelper.ts Co-authored-by: Will Harney <[email protected]> * Update packages/commerce-sdk-react/src/hooks/ShopperOrders/cache.ts Co-authored-by: Will Harney <[email protected]> * Update packages/commerce-sdk-react/src/hooks/ShopperOrders/cache.ts Co-authored-by: Will Harney <[email protected]> * Added root to all query keys, use remove over clear * Remove previous impemented "clear" from utils * Initial tests for shoppercontexts * Update ShopperLogin tests * Fix order tests * Update packages/commerce-sdk-react/src/hooks/ShopperContexts/cache.ts Co-authored-by: Will Harney <[email protected]> * Update cache.ts * Lint! * Update Json.tsx * Lint! * Testing race condition in tests * Re-add tests in other order. * Update CHANGELOG.md * Add todo to complete context cache work * Update packages/commerce-sdk-react/src/hooks/ShopperBaskets/mutation.test.ts Co-authored-by: Will Harney <[email protected]> * Update packages/commerce-sdk-react/src/components/ShopperExperience/Page/index.tsx Co-authored-by: Will Harney <[email protected]> * Update useAuthHelper.ts * Update packages/commerce-sdk-react/src/hooks/ShopperCustomers/cache.ts Co-authored-by: Adam Raya <[email protected]> --------- Co-authored-by: Will Harney <[email protected]> Co-authored-by: Adam Raya <[email protected]> * remove site alias and locale from location.state.directedFrom path (#1065) * remove site alias and locale from location.state.directedFrom path * moving call to removeSiteLocaleFromPath into use-navigation hook * fixing failing test, added tests for removeSiteLocaleFromPath * per code review, skipping failed test instead of using mocking * Fix Page Designer ImageWithText Link component (#1092) * Fix PD ImageWithText Link component by using Chakra UI Link * Use isAbsoluteURL to use react-router Link or Chakra Link component * PR Feedback * Clean up * Update packages/template-retail-react-app/app/page-designer/assets/image-with-text/index.jsx Co-authored-by: Ben Chypak <[email protected]> * Remove temporal page-viewer page to facilitate review --------- Co-authored-by: Ben Chypak <[email protected]> * split ssr build on local (#1155) * add suffix to ssr build files (#1157) * Added session bridge call to login for phased launch (#1159) * Added session bridge call to login for phased launch * Fix code smell for session-bridge in hybrid * Fix multi-value query params being lost (#1150) * Fix multi-value query params being lost * Update CHANGELOG.md * Snyk dependency updates (#1169) * Dependency updates * Update runtime package lock * Bump cosmiconfig version to latest * [Hybrid] PWA Kit should have a mechanism for replacing the access token when a SFRA login state is changed (#1171) * Implement mechanism to store refresh token copy and compare with sfra * Update tests and mocks for util function to check SFRA login state * Fix linting issues * FIx param types for util functionn * Rename old isTokenValid to isTokenExpired * Remove expiry for refresh_token in localstorage * Update packages/template-retail-react-app/app/commerce-api/utils.js Co-authored-by: Kevin He <[email protected]> * fix test * Fix linting on use-auth-modal.test.js * Update hasSFRAStateChanged logic to compare keys and values * Fix linting --------- Co-authored-by: Kevin He <[email protected]> * Add a redirect to login page after user signs out from checkout page (#1172) * Add a redirect to login page after user signs out from checkout page * Update CHANGELOG.md * Remove history since navigate handles similarly * Bump version number to 2.7.1-alpha.0 * Update changelogs * #1174 Replace invalid value for wrap property (#1179) * Update changelogs * Version bump to 2.7.1-preview.0 * Revert "Version bump to 2.7.1-preview.0" This reverts commit 985a7e0. * Update CHANGELOG.md * Rebuild lock files and fix ShopperLogin mutation test * Revert "Rebuild lock files and fix ShopperLogin mutation test" This reverts commit d9cfe50. * Add additional properties to ShopperLogin test types (#1185) * [V2] Re-generate lock files and fix hook lib tests (#1186) * re-generate lock files and fix test * Update packages/commerce-sdk-react/src/hooks/ShopperBaskets/index.test.ts * Rebuild lockfiles using node 14 npm 8 * Revert "Rebuild lockfiles using node 14 npm 8" This reverts commit 3d5c0cb. * Use pwa-kit-dev for lint and format * Revert "Use pwa-kit-dev for lint and format" This reverts commit f46d83e. * Add typescript to internal-lib-build and rebuild lock files --------- Co-authored-by: vcua-mobify <[email protected]> Co-authored-by: vcua-mobify <[email protected]> * [V2] Internal lib build typescript dev dependency (#1194) * Move typescript to dev and peer dependency * Update package lock file * Lockfile updates --------- Co-authored-by: Ben Chypak <[email protected]> Co-authored-by: Adam Raya <[email protected]> Co-authored-by: Vincent Marta <[email protected]> Co-authored-by: Oliver Brook <[email protected]> Co-authored-by: echessman <[email protected]> Co-authored-by: John Boxall <[email protected]> Co-authored-by: Richard Sexton <[email protected]> Co-authored-by: Will Harney <[email protected]> Co-authored-by: Kevin He <[email protected]> Co-authored-by: Alex Vuong <[email protected]> Co-authored-by: Brad Adams <[email protected]> Co-authored-by: Charles Lavery <[email protected]> Co-authored-by: Adam Raya Navarro <[email protected]> Co-authored-by: ecRobertEngel <[email protected]> Co-authored-by: Sandra Golden <[email protected]> Co-authored-by: Jainam Sheth <[email protected]> Co-authored-by: mdenchev-aiopsgroup <[email protected]>

bendvc added 2 commits March 10, 2023 09:18

Initial Commit

3696e80

Update CHANGELOG.md

1746460

bendvc commented Mar 10, 2023

View reviewed changes

Revert some testing code

c2c44ff

bendvc marked this pull request as ready for review March 13, 2023 16:35

bendvc requested a review from a team as a code owner March 13, 2023 16:35

Merge branch 'develop' into fix-get-config

57087bb

bendvc requested a review from vmarta March 13, 2023 16:55

bendvc and others added 3 commits March 13, 2023 14:03

Merge branch 'develop' into fix-get-config

08c410d

Get test coverage back up

242242d

Merge branch 'develop' into fix-get-config

5a0928c

vmarta reviewed Mar 13, 2023

View reviewed changes

Test build directory folder before proceeding.

5e18a6f

vmarta approved these changes Mar 13, 2023

View reviewed changes

bendvc merged commit a6c535b into develop Mar 13, 2023

vcua-mobify mentioned this pull request May 9, 2023

PWA Kit 2.7.1-alpha.0 release #1181

Merged

vcua-mobify mentioned this pull request May 11, 2023

[V2] PWA Kit Release 2.7.1 #1197

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix `getConfig` referencing config from incorrect location #1049

Fix `getConfig` referencing config from incorrect location #1049

bendvc commented Mar 10, 2023 •

edited

Loading

bendvc Mar 10, 2023

bendvc Mar 10, 2023

bendvc Mar 10, 2023

bendvc Mar 10, 2023

vmarta Mar 13, 2023

bendvc Mar 13, 2023 •

edited

Loading

vmarta Mar 13, 2023

bendvc Mar 13, 2023

vmarta left a comment

Fix getConfig referencing config from incorrect location #1049

Fix getConfig referencing config from incorrect location #1049

Conversation

bendvc commented Mar 10, 2023 • edited Loading

Description

Types of Changes

Changes

How to Test-Drive This PR

bendvc Mar 10, 2023

Choose a reason for hiding this comment

bendvc Mar 10, 2023

Choose a reason for hiding this comment

bendvc Mar 10, 2023

Choose a reason for hiding this comment

bendvc Mar 10, 2023

Choose a reason for hiding this comment

vmarta Mar 13, 2023

Choose a reason for hiding this comment

bendvc Mar 13, 2023 • edited Loading

Choose a reason for hiding this comment

vmarta Mar 13, 2023

Choose a reason for hiding this comment

bendvc Mar 13, 2023

Choose a reason for hiding this comment

vmarta left a comment

Choose a reason for hiding this comment

Fix `getConfig` referencing config from incorrect location #1049

Fix `getConfig` referencing config from incorrect location #1049

bendvc commented Mar 10, 2023 •

edited

Loading

bendvc Mar 13, 2023 •

edited

Loading