feat: STRF-12941 Add channelUrl parameter to stencil start

[jairo-bc]

What?

Some users have a proxy or dns settings on the custom domain that block requests from stencil cli. By using --channelUrl you can directly set up bigcommerce domain to bypass custom domain protections

Tickets / Documentation

• STRF-12622

Screenshots (if appropriate)

cc @bigcommerce/storefront-team

[jairo-bc]

I think we can ignore snyk as it complains on the "hardcoded token" in tests

[bc-max]

LGTM

[huntario]

🍏
To test this out I took a domain that is applied to my store and pointed to the DNS to Google's IP to simulate a non-bc-compatible proxy.

On master:
➜ cornerstone git:(master) ✗ stencil start
Error: The BigCommerce Store you are pointing to either does not exist or is not available at this time.
Error details:
Request failed with status code 404
at Object.checkCliVersion (file:///Users/hunter.leachman/.nvm/versions/node/v20.16.0/lib/node_modules/@bigcommerce/stencil-cli/lib/theme-api-client.js:43:15)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
at async StencilStart.run (file:///Users/hunter.leachman/.nvm/versions/node/v20.16.0/lib/node_modules/@bigcommerce/stencil-cli/lib/stencil-start.js:62:34)

not ok -- Error: The BigCommerce Store you are pointing to either does not exist or is not available at this time.
Error details:
Request failed with status code 404

Please visit the troubleshooting page https://developer.bigcommerce.com/stencil-docs/deploying-a-theme/troubleshooting-theme-uploads.
If this error persists, please visit https://github.com/bigcommerce/stencil-cli/issues and submit an issue.

After:

➜ cornerstone git:(master) ✗ node ../../stencil-cli/bin/stencil.js init --url https://store-upsk9v87r9.mybigcommerce.com --token afsdfsdfsdfsdfsdfsdf
? What port would you like to run the server on? 3000
? What is your favourite Package Manager? npm
Set API host to: https://api.bigcommerce.com
✔ Dependencies installed successfully
You are now ready to go! To start developing, run $ stencil start
➜ cornerstone git:(master) ✗ node ../../stencil-cli/bin/stencil.js start --channelUrl https://store-upsk9v87r9.mybigcommerce.com

                                 `+h
                               `+ddd
                             .oddddd
                           .oddddddd
                         -sddddddddd
                      `-sddddddddddd
                     -shdddddddddddd
                     ...-:+ydddddddd
                `......`   `+ddddddd
                -ddddddh-    ddddddd
            `   .yyyyyyo.  `+ddddddd
          .o/    `````    :ydddddddd
        -ohd+   `//////:` `.sddddddd
      -sdddd+   -ddddddds   `hdddddd
    :sdddddd+   .sssssso-   `ddddddd
  :ydddddddd+              -yddddddd
/yddddddddddy+++++++++++oshddddddddd

`/hdddddddddddddddddddddddddddddddddddd
/hdddddddddddddddddddddddddddddddddddddd

---

BigCommerce Stencil

---

-----------------Startup Information-------------

config.stencil.json location: /Users/hunter.leachman/Desktop/projects/themes/cornerstone/config.stencil.json
secrets.stencil.json location: /Users/hunter.leachman/Desktop/projects/themes/cornerstone/secrets.stencil.json
config.json location: /Users/hunter.leachman/Desktop/projects/themes/cornerstone/config.json
Store URL: http://shirt.fyi
SSL Store URL: https://store-upsk9v87r9.mybigcommerce.com
Node Version: v20.16.0

---

[Browsersync] Proxying: http://localhost:3001
[Browsersync] Access URLs:

   Local: http://localhost:3000
External: http://192.168.1.185:3000

---

      UI: http://localhost:3002

UI External: http://localhost:3002

[Browsersync] Watching files...
Browserslist: caniuse-lite is outdated. Please run:
npx update-browserslist-db@latest
Why you should do it regularly: https://github.com/browserslist/update-db#readme
isModuleDeclaration has been deprecated, please migrate to isImportOrExportDeclaration
at isModuleDeclaration (/Users/hunter.leachman/Desktop/projects/themes/cornerstone/node_modules/@babel/types/lib/validators/generated/index.js:2748:35)
at PluginPass.Program (/Users/hunter.leachman/Desktop/projects/themes/cornerstone/node_modules/babel-plugin-lodash/lib/index.js:102:44)
Webpack Bundle Analyzer saved report to /Users/hunter.leachman/Desktop/projects/themes/cornerstone/assets/dist/report.html
[Browsersync] Reloading Browsers...

[jairo-bc]

cc @bigcommerce/dev-docs

[bc-traciporter]

Hi @jairo-bc Do I need to update the stencil start section in our devdocs?

[jairo-bc]

@bc-traciporter yes

[bc-traciporter]

@jairo-bc Can you review PR 763? I am not sure if the description is correct?