Update naming

Author: lizkenyon

app/controllers/shopify_app/callback_controller.rb

@@ -162,12 +162,12 @@ def install_webhooks(session)
     end
 
     def install_scripttags(session)
-      return unless ShopifyApp.configuration.has_scripttags?
+      return unless ShopifyApp.configuration.has_script_tags?
 
-      ScripttagsManager.queue(
+      ScriptTagsManager.queue(
         session.shop,
         session.access_token,
-        ShopifyApp.configuration.scripttags,
+        ShopifyApp.configuration.script_tags,
       )
     end
 

docs/shopify_app/script-tags.md

@@ -1,12 +1,14 @@
-# ScriptTags
+# Script Tags
 
-ShopifyApp can manage your app's [ScriptTags](https://shopify.dev/docs/admin-api/graphql/reference/online-store/scripttag) for you by setting which scripttags you require in the initializer.
+ShopifyApp can manage your app's [Script Tags](https://shopify.dev/docs/admin-api/graphql/reference/online-store/scripttag) for you by setting which script tags you require in the initializer.
+> [!NOTE]
+> Script tags should only be used for vintage themes that do not support app blocks.
 
 ## Configuration
 
 ```ruby
 ShopifyApp.configure do |config|
-  config.scripttags = [
+  config.script_tags = [
     # Basic script tag
     {cache: true, src: 'https://example.com/fancy.js'},
 
@@ -41,7 +43,7 @@ config.scope = 'write_products,write_script_tags,read_themes'
 
 ### Script Tag Creation
 
-Scripttags are created in the same way as [Webhooks](/docs/shopify_app/webhooks.md), with a background job which will create the required scripttags.
+Script tags are created in the same way as [Webhooks](/docs/shopify_app/webhooks.md), with a background job which will create the required scripttags.
 
 ### App Block Detection
 

lib/shopify_app.rb

@@ -64,11 +64,11 @@ def self.use_webpacker?
 
   # jobs
   require "shopify_app/jobs/webhooks_manager_job"
-  require "shopify_app/jobs/scripttags_manager_job"
+  require "shopify_app/jobs/script_tags_manager_job"
 
   # managers
   require "shopify_app/managers/webhooks_manager"
-  require "shopify_app/managers/scripttags_manager"
+  require "shopify_app/managers/script_tags_manager"
   # middleware
   require "shopify_app/middleware/jwt_middleware"
 

lib/shopify_app/auth/post_authenticate_tasks.rb

@@ -11,7 +11,7 @@ def perform(session)
 
           install_webhooks(session_for_shop)
           install_scripttags(session_for_shop)
-          
+
           perform_after_authenticate_job(session)
         end
 
@@ -30,9 +30,9 @@ def install_webhooks(session)
 
         def install_scripttags(session)
           ShopifyApp::Logger.debug("PostAuthenticateTasks: Installing scripttags")
-          return unless ShopifyApp.configuration.has_scripttags?
+          return unless ShopifyApp.configuration.has_script_tags?
 
-          ScripttagsManager.queue(session.shop, session.access_token, ShopifyApp.configuration.scripttags)
+          ScriptTagsManager.queue(session.shop, session.access_token, ShopifyApp.configuration.script_tags)
         end
 
         def perform_after_authenticate_job(session)

lib/shopify_app/configuration.rb

@@ -15,7 +15,7 @@ class Configuration
     attr_accessor :embedded_app
     alias_method  :embedded_app?, :embedded_app
     attr_accessor :webhooks
-    attr_accessor :scripttags
+    attr_accessor :script_tags
     attr_accessor :after_authenticate_job
     attr_accessor :api_version
 
@@ -33,7 +33,7 @@ class Configuration
     attr_accessor :custom_post_authenticate_tasks
 
     # customise ActiveJob queue names
-    attr_accessor :scripttags_manager_queue_name
+    attr_accessor :script_tags_manager_queue_name
     attr_accessor :webhooks_manager_queue_name
 
     # configure myshopify domain for local shopify development
@@ -58,7 +58,7 @@ def initialize
       @root_url = "/"
       @myshopify_domain = "myshopify.com"
       @unified_admin_domain = "shopify.com"
-      @scripttags_manager_queue_name = Rails.application.config.active_job.queue_name
+      @script_tags_manager_queue_name = Rails.application.config.active_job.queue_name
       @webhooks_manager_queue_name = Rails.application.config.active_job.queue_name
       @disable_webpacker = ENV["SHOPIFY_APP_DISABLE_WEBPACKER"].present?
       @scope = []
@@ -115,8 +115,8 @@ def has_webhooks?
       webhooks.present?
     end
 
-    def has_scripttags?
-      scripttags.present?
+    def has_script_tags?
+      script_tags.present?
     end
 
     def requires_billing?

lib/shopify_app/engine.rb

@@ -5,7 +5,7 @@ module RedactJobParams
     private
 
     def args_info(job)
-      log_disabled_classes = ["ShopifyApp::WebhooksManagerJob", "ShopifyApp::ScripttagsManagerJob"]
+      log_disabled_classes = ["ShopifyApp::WebhooksManagerJob", "ShopifyApp::ScriptTagsManagerJob"]
       return "" if log_disabled_classes.include?(job.class.name)
 
       super
@@ -30,7 +30,7 @@ class Engine < Rails::Engine
       ActiveSupport.on_load(:active_job) do
         if ActiveJob::Base.respond_to?(:log_arguments?)
           WebhooksManagerJob.log_arguments = false
-          ScripttagsManagerJob.log_arguments = false
+          ScriptTagsManagerJob.log_arguments = false
         elsif ActiveJob::Logging::LogSubscriber.private_method_defined?(:args_info)
           ActiveJob::Logging::LogSubscriber.prepend(RedactJobParams)
         end

lib/shopify_app/jobs/script_tags_manager_job.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ShopifyApp
+  class ScriptTagsManagerJob < ActiveJob::Base
+    queue_as do
+      ShopifyApp.configuration.script_tags_manager_queue_name
+    end
+
+    def perform(shop_domain:, shop_token:, script_tags:)
+      ShopifyAPI::Auth::Session.temp(shop: shop_domain, access_token: shop_token) do |session|
+        manager = ScriptTagsManager.new(script_tags, shop_domain)
+        manager.create_script_tags(session: session)
+      end
+    end
+  end
+end

lib/shopify_app/jobs/scripttags_manager_job.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 module ShopifyApp
-  class ScripttagsManager
-    def self.queue(shop_domain, shop_token, scripttags)
-      ShopifyApp::ScripttagsManagerJob.perform_later(
+  class ScriptTagsManager
+    def self.queue(shop_domain, shop_token, script_tags)
+      ShopifyApp::ScriptTagsManagerJob.perform_later(
         shop_domain: shop_domain,
         shop_token: shop_token,
         # Procs cannot be serialized so we interpolate now, if necessary
-        scripttags: build_src(scripttags, shop_domain),
+        script_tags: build_src(script_tags, shop_domain),
       )
     end
 
-    def self.build_src(scripttags, domain)
-      scripttags.map do |tag|
+    def self.build_src(script_tags, domain)
+      script_tags.map do |tag|
         next tag unless tag[:src].respond_to?(:call)
 
         tag = tag.dup
@@ -21,25 +21,25 @@ def self.build_src(scripttags, domain)
       end
     end
 
-    attr_reader :required_scripttags, :shop_domain
+    attr_reader :required_script_tags, :shop_domain
 
-    def initialize(scripttags, shop_domain)
-      @required_scripttags = scripttags
+    def initialize(script_tags, shop_domain)
+      @required_script_tags = script_tags
       @shop_domain = shop_domain
       @session = nil
     end
 
-    def recreate_scripttags!(session:)
-      destroy_scripttags(session: session)
-      create_scripttags(session: session)
+    def recreate_script_tags!(session:)
+      destroy_script_tags(session: session)
+      create_script_tags(session: session)
     end
 
-    def create_scripttags(session:)
+    def create_script_tags(session:)
       @session = session
-      return unless required_scripttags.present?
+      return unless required_script_tags.present?
 
       # Check if any scripttag has template_types defined
-      template_types_to_check = required_scripttags.flat_map { |tag| tag[:template_types] }.compact.uniq
+      template_types_to_check = required_script_tags.flat_map { |tag| tag[:template_types] }.compact.uniq
 
       # If template types are specified, check if the theme supports app blocks for those templates
       if template_types_to_check.any?
@@ -59,19 +59,19 @@ def create_scripttags(session:)
         end
       end
 
-      expanded_scripttags.each do |scripttag|
-        create_scripttag(scripttag) unless scripttag_exists?(scripttag[:src])
+      expanded_script_tags.each do |script_tag|
+        create_script_tag(script_tag) unless script_tag_exists?(script_tag[:src])
       end
     end
 
-    def destroy_scripttags(session:)
+    def destroy_script_tags(session:)
       @session = session
-      scripttags = expanded_scripttags
-      fetch_all_scripttags.each do |tag|
-        delete_scripttag(tag) if required_scripttag?(scripttags, tag)
+      script_tags = expanded_script_tags
+      fetch_all_script_tags.each do |tag|
+        delete_script_tag(tag) if required_script_tag?(script_tags, tag)
       end
 
-      @current_scripttags = nil
+      @current_script_tags = nil
     end
 
     private
@@ -236,15 +236,15 @@ def template_supports_app_blocks?(theme_id, template_type)
       end
     end
 
-    def expanded_scripttags
-      self.class.build_src(required_scripttags, shop_domain)
+    def expanded_script_tags
+      self.class.build_src(required_script_tags, shop_domain)
     end
 
-    def required_scripttag?(scripttags, tag)
-      scripttags.map { |w| w[:src] }.include?(tag["src"])
+    def required_script_tag?(script_tags, tag)
+      script_tags.map { |w| w[:src] }.include?(tag["src"])
     end
 
-    def create_scripttag(attributes)
+    def create_script_tag(attributes)
       client = graphql_client
 
       variables = {
@@ -287,7 +287,7 @@ def create_scripttag(attributes)
       end
     end
 
-    def delete_scripttag(tag)
+    def delete_script_tag(tag)
       client = graphql_client
 
       query = <<~QUERY
@@ -311,15 +311,15 @@ def delete_scripttag(tag)
       end
     end
 
-    def scripttag_exists?(src)
-      current_scripttags[src]
+    def script_tag_exists?(src)
+      current_script_tags[src]
     end
 
-    def current_scripttags
-      @current_scripttags ||= fetch_all_scripttags.index_by { |tag| tag["src"] }
+    def current_script_tags
+      @current_script_tags ||= fetch_all_script_tags.index_by { |tag| tag["src"] }
     end
 
-    def fetch_all_scripttags
+    def fetch_all_script_tags
       client = graphql_client
 
       query = <<~QUERY

lib/shopify_app/managers/scripttags_manager.rb lib/shopify_app/managers/script_tags_manager.rb

@@ -13,7 +13,7 @@ def self.call
       config.myshopify_domain = "myshopify.com"
       config.api_version = ShopifyAPI::LATEST_SUPPORTED_ADMIN_VERSION
       config.billing = nil
-      config.scripttags = nil
+      config.script_tags = nil
       config.embedded_redirect_url = nil
 
       config.shop_session_repository = ShopifyApp::InMemorySessionStore