[Themes] Theme Console - ensureReplEnv 1/2 - Storefront Password Prompting #4191

jamesmengo · 2024-07-11T22:25:48Z

WHY are these changes introduced?

Part of https://github.com/Shopify/develop-advanced-edits/issues/257

WHAT is this pull request doing?

graph LR
    A[Start] --> B{Is the storefront password protected?}
    B -- No --> I[End]
    B -- Yes --> D{Is the --store-password flag provided?}
    D -- No --> E[Prompt the user for a password]
    D -- Yes --> F[Validate the provided --store-password flag]
    E --> G[Validate the prompted password]
    F --> H{Is the password valid?}
    G --> H{Is the password valid?}
    H -- Yes --> I[End]
    H -- No --> E[Prompt the user for a password]

How to test your changes?

Ensure your storefront is password protected via the admin
pnpm shopify theme console --dev-preview
You should see a password prompt
a. Enter a couple of incorrect passwords, then the correct one
pnpm shopify theme console --dev-preview --store-password=<PASSWORD>
a. Try with some valid and invalid passwords.

iTerm2.-.jamesmeng@Jamess-MacBook-Pro-2_._src_github.com_Shopify_cli.mp4

Measuring impact

How do we know this change was effective? Please choose one:

n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix
Existing analytics will cater for this addition
PR includes analytics changes to measure impact

Checklist

I've considered possible cross-platform impacts (Mac, Linux, Windows)
I've considered possible documentation changes

…rrect

github-actions · 2024-07-11T22:26:05Z

Thanks for your contribution!

Depending on what you are working on, you may want to request a review from a Shopify team:

Themes: @shopify/advanced-edits
UI extensions: @shopify/ui-extensions-cli
- Checkout UI extensions: @shopify/checkout-ui-extensions-api-stewardship
Hydrogen: @shopify/hydrogen
Other: @shopify/app-management

github-actions · 2024-07-11T22:29:39Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	72.37%	7551/10434
🟡	Branches	69.01%	3719/5389
🟡	Functions	71.37%	1997/2798
🟡	Lines	72.68%	7131/9811

Test suite run success

1736 tests passing in 800 suites.

Report generated by 🧪jest coverage report action from a2b6b54

packages/theme/src/cli/commands/theme/console.ts

github-actions · 2024-07-13T00:36:25Z

We detected some changes at either packages/*/src or packages/cli-kit/assets/cli-ruby/** and there are no updates in the .changeset.
If the changes are user-facing, run "pnpm changeset add" to track your changes and include them in the next release CHANGELOG.

isaacroldan · 2024-07-16T13:43:26Z

packages/theme/src/cli/utilities/theme-environment/storefront-session.ts

+export function promptPassword(prompt: string): Promise<string> {
+  const readline = createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  })
+
+  return new Promise((resolve) => {
+    readline.question(prompt, (password) => {
+      readline.close()
+      resolve(password)
+    })
+  })
+}


Why are we prompting with readline instead of using one of the prompts defined in cli-kit?
We should be consistent with the style CLI prompts

Good question - let me double check with @karreiro when he returns next week.
I agree that CLI UI-Kit should be used to prompt for the password. I have applied that change 🙂

I'm trying to get the cli-kit for the REPL loop, I would like a way to optionally hide the prompt message

Currently, the prompt looks like this if I pass an empty string in message: renderTextPrompt({message: ''})

Current State

Desired State
I would like to hide the prompt to achieve something like this - this will bring us to parity with the current theme console command

I have a PR enabling the above. Could you take a look and let me know what you think 🙏🏻 ? @isaacroldan

feat: Add prop to renderTextPrompt to hide prompt message and bottom bar #4216

Indeed, we should use cli-kit prompts to get the store password. However, we really need to rely on readline to power REPL DX, as readline also supports history of commands (when users press ꜛ), the minimal UI component cohesive with other REPL tools, and the life cycle callbacks.

packages/theme/src/cli/utilities/theme-environment/storefront-session.ts

lucyxiang · 2024-07-17T14:51:46Z

🎩 and works as expected

sleekping · 2024-09-19T05:35:24Z

WHY are these changes introduced?

Part of https://github.com/Shopify/develop-advanced-edits/issues/257

WHAT is this pull request doing?
graph LR
    A[Start] --> B{Is the storefront password protected?}
    B -- No --> I[End]
    B -- Yes --> D{Is the --store-password flag provided?}
    D -- No --> E[Prompt the user for a password]
    D -- Yes --> F[Validate the provided --store-password flag]
    E --> G[Validate the prompted password]
    F --> H{Is the password valid?}
    G --> H{Is the password valid?}
    H -- Yes --> I[End]
    H -- No --> E[Prompt the user for a password]
Loading
How to test your changes?

Ensure your storefront is password protected via the admin

pnpm shopify theme console --dev-preview

You should see a password prompt
a. Enter a couple of incorrect passwords, then the correct one

pnpm shopify theme console --dev-preview --store-password=<PASSWORD>
a. Try with some valid and invalid passwords.

iTerm2.-.jamesmeng@Jamess-MacBook-Pro-2_._src_github.com_Shopify_cli.mp4

Measuring impact

How do we know this change was effective? Please choose one:

n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix

Existing analytics will cater for this addition

PR includes analytics changes to measure impact

Checklist

I've considered possible cross-platform impacts (Mac, Linux, Windows)

I've considered possible documentation changes

Hello sir pls help.. mine keeps saying incorrect password even after I used the right one

jamesmengo · 2024-09-19T15:20:35Z

@sleekping can you ensure that you're accessing the correct storefront by passing the --store flag and specifying your store?

Could you also double check the password you set here?

If that doesn't work, please open an issue :)

jamesmengo added 3 commits July 10, 2024 17:09

Prompt user for password if storefront is password protected

3ba5a1e

Prompt for storefront password when required and not provided

cfb144f

Validate storefront password + allow user to correct password if inco…

1293121

…rrect

jamesmengo commented Jul 12, 2024

View reviewed changes

packages/theme/src/cli/commands/theme/console.ts Outdated Show resolved Hide resolved

jamesmengo force-pushed the jmeng/console-ensureRepl branch from bf0dad1 to b21e712 Compare July 12, 2024 23:38

jamesmengo changed the title ~~Jmeng/console ensure repl~~ [Themes] Theme Console - Prompt user for storefront password Jul 12, 2024

jamesmengo force-pushed the jmeng/console-ensureRepl branch from b21e712 to 90fa445 Compare July 12, 2024 23:50

jamesmengo changed the title ~~[Themes] Theme Console - Prompt user for storefront password~~ [Themes] Theme Console - ensureReplEnv 1/2 - Storefront Password Prompting Jul 12, 2024

jamesmengo force-pushed the jmeng/console-ensureRepl branch from 90fa445 to 3e9c4e7 Compare July 13, 2024 00:32

Fix: Init and consume store-password flag

4e4b900

jamesmengo force-pushed the jmeng/console-ensureRepl branch from 3e9c4e7 to 4e4b900 Compare July 13, 2024 00:34

jamesmengo marked this pull request as ready for review July 13, 2024 00:36

jamesmengo self-assigned this Jul 13, 2024

jamesmengo added the #gsd:40767 Fortify local development experience for Liquid themes label Jul 13, 2024

jamesmengo requested review from karreiro and a team July 13, 2024 00:36

jamesmengo force-pushed the jmeng/console-ensureRepl branch from 43e485e to 4e4b900 Compare July 15, 2024 19:04

isaacroldan reviewed Jul 16, 2024

View reviewed changes

packages/theme/src/cli/utilities/theme-environment/storefront-session.ts Outdated Show resolved Hide resolved

jamesmengo added 2 commits July 16, 2024 11:10

Add handling for 429 - Too Many Requests

5aaa952

Simplify ensureHttps -> prependHttps

4a52e1a

jamesmengo force-pushed the jmeng/console-ensureRepl branch from 02bffa9 to 4a52e1a Compare July 16, 2024 18:40

jamesmengo requested a review from isaacroldan July 16, 2024 18:42

jamesmengo added 2 commits July 16, 2024 12:32

Use renderTextPrompt from UI-Kit rather than readline to prompt password

07e774a

refactor: Move password prompt logic to separate module

a2b6b54

isaacroldan reviewed Jul 17, 2024

View reviewed changes

packages/theme/src/cli/utilities/theme-environment/storefront-session.ts Show resolved Hide resolved

jamesmengo merged this pull request into jmeng/themeconsole Jul 18, 2024

jamesmengo deleted the jmeng/console-ensureRepl branch July 18, 2024 16:50

karreiro mentioned this pull request Jul 22, 2024

[Themes] Theme Console - Handle the REPL lifecycle #4224

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Themes] Theme Console - ensureReplEnv 1/2 - Storefront Password Prompting #4191

[Themes] Theme Console - ensureReplEnv 1/2 - Storefront Password Prompting #4191

jamesmengo commented Jul 11, 2024 •

edited

Loading

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 11, 2024 •

edited

Loading

github-actions bot commented Jul 13, 2024

isaacroldan Jul 16, 2024

jamesmengo Jul 16, 2024 •

edited

Loading

karreiro Jul 22, 2024

lucyxiang commented Jul 17, 2024

sleekping commented Sep 19, 2024

WHY are these changes introduced?

WHAT is this pull request doing?

How to test your changes?

Measuring impact

Checklist

jamesmengo commented Sep 19, 2024

[Themes] Theme Console - ensureReplEnv 1/2 - Storefront Password Prompting #4191

[Themes] Theme Console - ensureReplEnv 1/2 - Storefront Password Prompting #4191

Conversation

jamesmengo commented Jul 11, 2024 • edited Loading

WHY are these changes introduced?

WHAT is this pull request doing?

How to test your changes?

Measuring impact

Checklist

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 11, 2024 • edited Loading

Coverage report

Test suite run success

github-actions bot commented Jul 13, 2024

isaacroldan Jul 16, 2024

Choose a reason for hiding this comment

jamesmengo Jul 16, 2024 • edited Loading

Choose a reason for hiding this comment

karreiro Jul 22, 2024

Choose a reason for hiding this comment

lucyxiang commented Jul 17, 2024

sleekping commented Sep 19, 2024

WHY are these changes introduced?

WHAT is this pull request doing?

How to test your changes?

Measuring impact

Checklist

jamesmengo commented Sep 19, 2024

jamesmengo commented Jul 11, 2024 •

edited

Loading

github-actions bot commented Jul 11, 2024 •

edited

Loading

jamesmengo Jul 16, 2024 •

edited

Loading