shopify-cli 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30e766112b0e09d6de0e907ecf7e002377fe8a0ecb6776bf0975ec1677a5858a
-  data.tar.gz: 3fbcc004481a0b06c8ccfcd0fb5890d7ab4bf6ee778a6b4dc43c773508376a05
+  metadata.gz: a1eb0f785e6ead5199faf7921e48209506987a24d942568e24661e96f2bc0861
+  data.tar.gz: 06e4effc8a4b95bf78404630b452e4cf364407019846660b0d293cace45ae245
 SHA512:
-  metadata.gz: d3b9f2da8984619e58cb73a5a066bd67b7b0e3f050a82f794b36079d3f0850d8c57e4e346e7f6ae0c0ea01601d07e26d54359cced3e132d23246ad88bbed314f
-  data.tar.gz: 1ec7d262e39e6b112cf25a35b85788faeb77fce56febdeb46e0f8630608ca19ec0eb032b668302515e23fbfa0831ad25492439cc8cb35e5fb376c6e2277e4596
+  metadata.gz: 65df9edf44e3c2ce1263acb79d619736ffc6c4b30c50d9d71f6943dfa7c740dd0a9c9440a6879d46c59387f9bc2db6671cd65a31f700bf964b65bfb9dc1da2dc
+  data.tar.gz: a1b9f5a17dc58b2570294205e33dd3fc1cb0a198bb4b7ca9594d91366d6169d4c92f7c9b7df0cbf8401f9a81123e78b55331ef8afd909247889a17cc046e58a2

data/.rubocop_todo.yml

@@ -1,11 +1,24 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-12-01 16:33:09 UTC using RuboCop version 1.4.1.
+# on 2021-04-08 18:25:36 UTC using RuboCop version 1.12.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 30
+# Offense count: 35
 Minitest/MultipleAssertions:
   Max: 9
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/PerlBackrefs:
+  Exclude:
+    - 'lib/docgen/markdown.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantBegin:
+  Exclude:
+    - 'lib/shopify-cli/shopifolk.rb'
+    - 'test/shopify-cli/tunnel_test.rb'

data/CHANGELOG.md

@@ -1,9 +1,12 @@
 Unreleased
 ------
 
-Version 1.8.0
+Version 1.9.0
 -------------
+* [1181](https://github.com/Shopify/shopify-app-cli/pull/1181): Remove the subcommand references of the `generate` command for node apps (fixes [1176](https://github.com/Shopify/shopify-app-cli/issues/1176))
 
+Version 1.8.0
+-------------
 * [1119](https://github.com/Shopify/shopify-app-cli/pull/1119): Enable guest serialization for scripts
 
 Version 1.7.1

data/Gemfile.lock

@@ -22,7 +22,7 @@ GEM
       ruby-progressbar
     mocha (1.11.2)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -34,8 +34,8 @@ GEM
     rainbow (3.0.0)
     rake (13.0.1)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
-    rubocop (1.11.0)
+    rexml (3.2.5)
+    rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)

data/dev.yml

@@ -5,6 +5,9 @@ type:
 up:
   - ruby: 2.5.1
   - bundler
+  - node:
+      version: 14.9.0
+      yarn: true
 
 test:
   desc: 'Run tests.'

data/lib/graphql/extension_create.graphql

@@ -1,7 +1,22 @@
-mutation ExtensionCreate($api_key: String!, $type: ExtensionType!, $title: String!, $config: JSON!, $extension_context: String) {
-  extensionCreate(input: {apiKey: $api_key, type: $type, title: $title, config: $config, context: $extension_context}) {
+mutation ExtensionCreate(
+  $api_key: String!
+  $type: ExtensionType!
+  $title: String!
+  $config: JSON!
+  $extension_context: String
+) {
+  extensionCreate(
+    input: {
+      apiKey: $api_key
+      type: $type
+      title: $title
+      config: $config
+      context: $extension_context
+    }
+  ) {
     extensionRegistration {
       id
+      uuid
       type
       title
       draftVersion {

data/lib/project_types/extension/cli.rb

@@ -57,6 +57,8 @@ module Extension
   end
 
   module Features
+    autoload :ArgoRendererPackage, Project.project_filepath("features/argo_renderer_package")
+    autoload :ArgoServe, Project.project_filepath("features/argo_serve")
     autoload :ArgoSetup, Project.project_filepath("features/argo_setup")
     autoload :ArgoSetupStep, Project.project_filepath("features/argo_setup_step")
     autoload :ArgoSetupSteps, Project.project_filepath("features/argo_setup_steps")

data/lib/project_types/extension/commands/extension_command.rb

@@ -8,16 +8,16 @@ module Extension
         @project ||= ExtensionProject.current
       end
 
-      def extension_type
-        @extension_type ||= begin
-          identifier = project.extension_type_identifier
+      def specification_handler
+        @specification_handler ||= begin
+          identifier = project.specification_identifier
           Models::LazySpecificationHandler.new(identifier) do
             specifications = Models::Specifications.new(
               fetch_specifications: Tasks::FetchSpecifications.new(api_key: project.app.api_key, context: @ctx)
             )
 
             unless specifications.valid?(identifier)
-              @ctx.abort(@ctx.message("errors.unknown_type", project.extension_type_identifier))
+              @ctx.abort(@ctx.message("errors.unknown_type", project.specification_identifier))
             end
 
             specifications[identifier]

data/lib/project_types/extension/commands/push.rb

@@ -59,8 +59,8 @@ module Extension
             context: @ctx,
             api_key: project.app.api_key,
             registration_id: project.registration_id,
-            config: extension_type.config(@ctx),
-            extension_context: extension_type.extension_context(@ctx)
+            config: specification_handler.config(@ctx),
+            extension_context: specification_handler.extension_context(@ctx)
           )
         end
       end

data/lib/project_types/extension/commands/register.rb

@@ -27,7 +27,7 @@ module Extension
       private
 
       def confirm_registration
-        @ctx.puts(@ctx.message("register.confirm_info", extension_type.name))
+        @ctx.puts(@ctx.message("register.confirm_info", specification_handler.name))
         CLI::UI::Prompt.confirm(@ctx.message("register.confirm_question"))
       end
 
@@ -37,10 +37,10 @@ module Extension
         Tasks::CreateExtension.call(
           context: @ctx,
           api_key: app.api_key,
-          type: extension_type.graphql_identifier,
+          type: specification_handler.graphql_identifier,
           title: project.title,
           config: {},
-          extension_context: extension_type.extension_context(@ctx)
+          extension_context: specification_handler.extension_context(@ctx)
         )
       end
 
@@ -50,6 +50,7 @@ module Extension
           api_key: app.api_key,
           api_secret: app.secret,
           registration_id: registration.id,
+          registration_uuid: registration.uuid,
           title: project.title
         )
       end

data/lib/project_types/extension/commands/serve.rb

@@ -3,27 +3,8 @@
 module Extension
   module Commands
     class Serve < ExtensionCommand
-      YARN_SERVE_COMMAND = %w(server)
-      NPM_SERVE_COMMAND = %w(run-script server)
-
       def call(_args, _command_name)
-        if argo_admin?
-          ShopifyCli::Tasks::EnsureEnv.call(@ctx, required: [:api_key, :secret, :shop])
-          ShopifyCli::Tasks::EnsureDevStore.call(@ctx)
-          validate_env
-        end
-
-        CLI::UI::Frame.open(@ctx.message("serve.frame_title")) do
-          yarn_serve_command = YARN_SERVE_COMMAND
-          npm_serve_command = NPM_SERVE_COMMAND
-          if argo_admin?
-            serve_args = %W(--shop=#{project.env.shop} --apiKey=#{project.env.api_key})
-            yarn_serve_command += serve_args
-            npm_serve_command += %w(--) + serve_args
-          end
-          success = ShopifyCli::JsSystem.call(@ctx, yarn: yarn_serve_command, npm: npm_serve_command)
-          @ctx.abort(@ctx.message("serve.serve_failure_message")) unless success
-        end
+        specification_handler.serve(@ctx)
       end
 
       def self.help
@@ -32,21 +13,6 @@ module Extension
             Usage: {{command:#{ShopifyCli::TOOL_NAME} serve}}
         HELP
       end
-
-      private
-
-      def argo_admin?
-        ShopifyCli::Shopifolk.check &&
-          ShopifyCli::Feature.enabled?(:argo_admin_beta) &&
-          extension_type.specification.features&.argo&.surface == "admin"
-      end
-
-      def validate_env
-        ExtensionProject.reload
-        @ctx.abort(@ctx.message("serve.serve_missing_information")) if
-          project.env.shop.nil? || project.env.api_key.nil? ||
-          project.env.shop.strip.empty? || project.env.api_key.strip.empty?
-      end
     end
   end
 end

data/lib/project_types/extension/extension_project.rb

@@ -9,17 +9,20 @@ module Extension
           context,
           project_type: :extension,
           organization_id: nil,
-          "#{ExtensionProjectKeys::EXTENSION_TYPE_KEY}": type
+          "#{ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY}": type
         )
       end
 
-      def write_env_file(context:, title:, api_key: "", api_secret: "", registration_id: nil)
+      def write_env_file(
+        context:, title:, api_key: "", api_secret: "", registration_id: nil, registration_uuid: nil
+      )
         ShopifyCli::Resources::EnvFile.new(
           api_key: api_key,
           secret: api_secret,
           extra: {
             ExtensionProjectKeys::TITLE_KEY => title,
             ExtensionProjectKeys::REGISTRATION_ID_KEY => registration_id,
+            ExtensionProjectKeys::REGISTRATION_UUID_KEY => registration_uuid || generate_temporary_uuid,
           }.compact
         ).write(context)
 
@@ -49,8 +52,8 @@ module Extension
       get_extra_field(ExtensionProjectKeys::TITLE_KEY)
     end
 
-    def extension_type_identifier
-      config[ExtensionProjectKeys::EXTENSION_TYPE_KEY]
+    def specification_identifier
+      config[ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY]
     end
 
     def registration_id?
@@ -63,10 +66,18 @@ module Extension
       get_extra_field(ExtensionProjectKeys::REGISTRATION_ID_KEY).to_i
     end
 
+    def registration_uuid
+      get_extra_field(ExtensionProjectKeys::REGISTRATION_UUID_KEY)
+    end
+
     def reload
       @env = nil
     end
 
+    def self.generate_temporary_uuid
+      "dev-#{SecureRandom.uuid}"
+    end
+
     private
 
     def get_extra_field(key)

data/lib/project_types/extension/extension_project_keys.rb

@@ -4,7 +4,8 @@ require "shopify_cli"
 module Extension
   module ExtensionProjectKeys
     REGISTRATION_ID_KEY = "EXTENSION_ID"
-    EXTENSION_TYPE_KEY = "EXTENSION_TYPE"
+    REGISTRATION_UUID_KEY = "EXTENSION_UUID"
+    SPECIFICATION_IDENTIFIER_KEY = "EXTENSION_TYPE"
     TITLE_KEY = "EXTENSION_TITLE"
   end
 end

data/lib/project_types/extension/features/argo.rb

@@ -47,6 +47,12 @@ module Extension
         end
       end
 
+      def renderer_package(context)
+        Features::ArgoRendererPackage.new(
+          package_name: renderer_package_name, version: extract_argo_renderer_version(context)
+        )
+      end
+
       private
 
       def extract_argo_renderer_version(context)

data/lib/project_types/extension/features/argo_renderer_package.rb

@@ -0,0 +1,32 @@
+module Extension
+  module Features
+    class ArgoRendererPackage
+      include SmartProperties
+
+      ARGO_CHECKOUT = "@shopify/argo-checkout"
+      ARGO_ADMIN = "@shopify/argo-admin"
+
+      PACKAGE_NAMES = [
+        ARGO_CHECKOUT,
+        ARGO_ADMIN,
+      ].freeze
+      MINIMUM_ARGO_VERSION = "0.9.3".freeze
+
+      property! :package_name, accepts: PACKAGE_NAMES
+      property! :version, accepts: String
+
+      def checkout?
+        package_name == ARGO_CHECKOUT
+      end
+
+      def admin?
+        package_name == ARGO_ADMIN
+      end
+
+      def supports_uuid_flag?
+        return false if checkout?
+        Gem::Version.new(version) > Gem::Version.new(MINIMUM_ARGO_VERSION)
+      end
+    end
+  end
+end

data/lib/project_types/extension/features/argo_serve.rb

@@ -0,0 +1,69 @@
+module Extension
+  module Features
+    class ArgoServe
+      include SmartProperties
+
+      property! :specification_handler, accepts: Extension::Models::SpecificationHandlers::Default
+      property! :context, accepts: ShopifyCli::Context
+
+      YARN_SERVE_COMMAND = %w(server)
+      NPM_SERVE_COMMAND = %w(run-script server)
+
+      def call
+        validate_env!
+
+        CLI::UI::Frame.open(context.message("serve.frame_title")) do
+          success = ShopifyCli::JsSystem.call(context, yarn: yarn_serve_command, npm: npm_serve_command)
+          context.abort(context.message("serve.serve_failure_message")) unless success
+        end
+      end
+
+      private
+
+      def specification
+        specification_handler.specification
+      end
+
+      def validate_env!
+        ExtensionProject.reload
+
+        ShopifyCli::Shopifolk.check && ShopifyCli::Feature.enabled?(:argo_admin_beta)
+
+        required_fields = specification.features.argo.required_fields
+
+        return if required_fields.none?
+
+        ShopifyCli::Tasks::EnsureEnv.call(context, required: required_fields)
+        ShopifyCli::Tasks::EnsureDevStore.call(context) if required_fields.include?(:shop)
+
+        project = ExtensionProject.current
+
+        return if required_fields.all? do |field|
+          value = project.env.public_send(field)
+          value && !value.strip.empty?
+        end
+
+        context.abort(context.message("serve.serve_missing_information"))
+      end
+
+      def yarn_serve_command
+        YARN_SERVE_COMMAND + serve_options(specification.features.argo.required_fields)
+      end
+
+      def npm_serve_command
+        NPM_SERVE_COMMAND + ["--"] + serve_options(specification.features.argo.required_fields)
+      end
+
+      def serve_options(required_fields)
+        renderer_package = specification_handler.renderer_package(context)
+        project = ExtensionProject.current
+        @serve_options ||= [].tap do |options|
+          options << "--shop=#{project.env.shop}" if required_fields.include?(:shop)
+          options << "--apiKey=#{project.env.api_key}" if required_fields.include?(:api_key)
+          options << "--argoVersion=#{renderer_package.version}" if renderer_package.admin?
+          options << "--uuid=#{project.registration_uuid}" if renderer_package.supports_uuid_flag?
+        end
+      end
+    end
+  end
+end

data/lib/project_types/extension/messages/message_loading.rb

@@ -16,7 +16,9 @@ module Extension
 
       def self.load_current_type_messages
         return unless ShopifyCli::Project.has_current?
-        messages_for_type(ShopifyCli::Project.current.config[Extension::ExtensionProjectKeys::EXTENSION_TYPE_KEY])
+        messages_for_type(
+          ShopifyCli::Project.current.config[Extension::ExtensionProjectKeys::SPECIFICATION_IDENTIFIER_KEY]
+        )
       end
 
       def self.messages_for_type(type_identifier)

data/lib/project_types/extension/models/registration.rb

@@ -7,6 +7,7 @@ module Extension
       include SmartProperties
 
       property! :id, accepts: Integer
+      property! :uuid, accepts: String
       property! :type, accepts: String
       property! :title, accepts: String
       property! :draft_version, accepts: Extension::Models::Version

data/lib/project_types/extension/models/specification.rb

@@ -10,6 +10,8 @@ module Extension
           property! :surface, converts: :to_str
           property! :renderer_package_name, converts: :to_str
           property! :git_template, converts: :to_str
+          property! :required_fields, accepts: Array, default: []
+          property! :required_shop_beta_flags, accepts: Array, default: []
         end
 
         def self.build(feature_set_attributes)