Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Shopify Themes CLI Plugin (The Second Attempt™️) #434

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

jerryzhou196
Copy link

@jerryzhou196 jerryzhou196 commented Feb 28, 2024

Overview

This PR fully implements the Shopify Theme CLI Shell Plugin. It builds off of the great work done by @ammiranda and @hculea on #397.

Shopify.CLI.Integration.Demo.mov

The video shows the 1Password Shopify Shell Plugin integrating with the shopify theme CLI and a theme access API key.

Incidentally, there were a few interesting things I stumbled upon.

  1. I couldn't implement the importer because the Shopify CLI stores the environment file by project directory rather than a fixed path.
    (instead of something like ~/config.toml, it's {PROJECT_DIRECTORY}/shopify.theme.toml).

  2. I noticed that importer.NoOp() would cause the op plugin init flow to fail with [ERROR]... credential not found for the Import into 1Password... option. The same issue was mentioned in new(mongosh): Support mongosh executable for connecting to a MongoDB database #283. Without being able to see the underlying code causing the error, I provide a band-aid solution in this PR that fixes the importer.NoOp() implementation to no longer give this error.

  3. Shopify CLI also has a lone Webhooks CLI integration called shopify webhook trigger that requires a --client-secret passkey. I'm very happy to implement this too. What are your thoughts?

Type of change

  • Created a new plugin
  • Improved an existing plugin
  • Fixed a bug in an existing plugin
  • Improved contributor utilities or experience

Related Issue(s)

How To Test

  1. Download the Shopify CLI.
  2. Create a Shopify Store on Shopify and configure the theme access app to your store.
  3. Provision a key through the theme access portal.
    (Side note: Not sure how to test the automatic chrome extension detection import here)
    image
  4. Build the plugin and run op plugin init shopify. Store the key through the import option.
  5. Try running the protected theme commands without the --password option or the Shopify built-in authentication. It should work.

Changelog

Added Shopify Themes Plugin.
Added an empty attempt to importer.NoOp() to correctly function without error.

@jerryzhou196 jerryzhou196 changed the title Shopify Themes CLI Plugin - The Second Attempt™️ Added Shopify Themes CLI Plugin (The Second Attempt™️) Feb 28, 2024
Copy link
Contributor

@AndyTitu AndyTitu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution and thanks for providing the usage video, that's very helpful when reviewing this PR! Looks good to me apart from a couple of minor doc suggestions. Will forward this for a security review.

Also, there are a few tests failing.

plugins/shopify/access_key.go Outdated Show resolved Hide resolved
plugins/shopify/access_key.go Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New plugin: Shopify
3 participants