packwerk 1.1.2 → 1.3.1

data/lib/packwerk/parse_run.rb

@@ -0,0 +1,106 @@
+# typed: true
+# frozen_string_literal: true
+
+require "benchmark"
+require "parallel"
+
+module Packwerk
+  class ParseRun
+    extend T::Sig
+
+    def initialize(
+      files:,
+      configuration:,
+      progress_formatter: Formatters::ProgressFormatter.new(StringIO.new),
+      offenses_formatter: Formatters::OffensesFormatter.new
+    )
+      @configuration = configuration
+      @progress_formatter = progress_formatter
+      @offenses_formatter = offenses_formatter
+      @files = files
+    end
+
+    def detect_stale_violations
+      offense_collection = find_offenses
+
+      result_status = !offense_collection.stale_violations?
+      message = @offenses_formatter.show_stale_violations(offense_collection)
+
+      Result.new(message: message, status: result_status)
+    end
+
+    def update_deprecations
+      offense_collection = find_offenses
+      offense_collection.dump_deprecated_references_files
+
+      message = <<~EOS
+        #{@offenses_formatter.show_offenses(offense_collection.errors)}
+        ✅ `deprecated_references.yml` has been updated.
+      EOS
+
+      Result.new(message: message, status: offense_collection.errors.empty?)
+    end
+
+    def check
+      offense_collection = find_offenses(show_errors: true)
+
+      messages = [
+        @offenses_formatter.show_offenses(offense_collection.outstanding_offenses),
+        @offenses_formatter.show_stale_violations(offense_collection),
+      ]
+      result_status = offense_collection.outstanding_offenses.empty? && !offense_collection.stale_violations?
+
+      Result.new(message: messages.join("\n") + "\n", status: result_status)
+    end
+
+    private
+
+    def find_offenses(show_errors: false)
+      offense_collection = OffenseCollection.new(@configuration.root_path)
+      @progress_formatter.started(@files)
+
+      run_context = Packwerk::RunContext.from_configuration(@configuration)
+      all_offenses = T.let([], T.untyped)
+
+      process_file = -> (path) do
+        run_context.process_file(file: path).tap do |offenses|
+          failed = show_errors && offenses.any? { |offense| !offense_collection.listed?(offense) }
+          update_progress(failed: failed)
+        end
+      end
+
+      execution_time = Benchmark.realtime do
+        all_offenses = if @configuration.parallel?
+          Parallel.flat_map(@files, &process_file)
+        else
+          serial_find_offenses(&process_file)
+        end
+      end
+
+      @progress_formatter.finished(execution_time)
+
+      all_offenses.each { |offense| offense_collection.add_offense(offense) }
+      offense_collection
+    end
+
+    def serial_find_offenses
+      all_offenses = T.let([], T.untyped)
+      @files.each do |path|
+        offenses = yield path
+        all_offenses.concat(offenses)
+      end
+      all_offenses
+    rescue Interrupt
+      @progress_formatter.interrupted
+      all_offenses
+    end
+
+    def update_progress(failed: false)
+      if failed
+        @progress_formatter.mark_as_failed
+      else
+        @progress_formatter.mark_as_inspected
+      end
+    end
+  end
+end

data/lib/packwerk/parsed_constant_definitions.rb

@@ -3,8 +3,6 @@
 
 require "ast/node"
 
-require "packwerk/node"
-
 module Packwerk
   class ParsedConstantDefinitions
     def initialize(root_node:)

data/lib/packwerk/parsers.rb

@@ -1,8 +1,6 @@
 # typed: true
 # frozen_string_literal: true
 
-require "packwerk/offense"
-
 module Packwerk
   module Parsers
     autoload :Erb, "packwerk/parsers/erb"

data/lib/packwerk/parsers/erb.rb

@@ -6,8 +6,6 @@ require "better_html"
 require "better_html/parser"
 require "parser/source/buffer"
 
-require "packwerk/parsers"
-
 module Packwerk
   module Parsers
     class Erb

data/lib/packwerk/parsers/factory.rb

@@ -3,8 +3,6 @@
 
 require "singleton"
 
-require "packwerk/parsers"
-
 module Packwerk
   module Parsers
     class Factory

data/lib/packwerk/privacy_checker.rb

@@ -1,9 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "packwerk/violation_type"
-require "packwerk/checker"
-
 module Packwerk
   class PrivacyChecker
     extend T::Sig
@@ -16,10 +13,10 @@ module Packwerk
 
     sig do
       override
-        .params(reference: Packwerk::Reference, reference_lister: Packwerk::ReferenceLister)
+        .params(reference: Packwerk::Reference)
         .returns(T::Boolean)
     end
-    def invalid_reference?(reference, reference_lister)
+    def invalid_reference?(reference)
       return false if reference.constant.public?
 
       privacy_option = reference.constant.package.enforce_privacy
@@ -28,19 +25,9 @@ module Packwerk
       return false unless privacy_option == true ||
         explicitly_private_constant?(reference.constant, explicitly_private_constants: privacy_option)
 
-      return false if reference_lister.listed?(reference, violation_type: violation_type)
-
       true
     end
 
-    sig { override.params(reference: Packwerk::Reference).returns(String) }
-    def message_for(reference)
-      source_desc = reference.source_package ? "'#{reference.source_package}'" : "here"
-      "Privacy violation: '#{reference.constant.name}' is private to '#{reference.constant.package}' but " \
-        "referenced from #{source_desc}.\n" \
-        "Is there a public entrypoint in '#{reference.constant.package.public_path}' that you can use instead?"
-    end
-
     private
 
     sig do

data/lib/packwerk/reference_extractor.rb

@@ -1,14 +1,6 @@
 # typed: true
 # frozen_string_literal: true
 
-require "sorbet-runtime"
-
-require "packwerk/constant_discovery"
-require "packwerk/constant_name_inspector"
-require "packwerk/node"
-require "packwerk/parsed_constant_definitions"
-require "packwerk/reference"
-
 module Packwerk
   # extracts a possible constant reference from a given AST node
   class ReferenceExtractor

data/lib/packwerk/reference_offense.rb

@@ -0,0 +1,49 @@
+# typed: true
+# frozen_string_literal: true
+
+module Packwerk
+  class ReferenceOffense < Offense
+    extend T::Sig
+    extend T::Helpers
+
+    attr_reader :reference, :violation_type
+
+    sig do
+      params(
+        reference: Packwerk::Reference,
+        violation_type: Packwerk::ViolationType,
+        location: T.nilable(Node::Location)
+      )
+        .void
+    end
+    def initialize(reference:, violation_type:, location: nil)
+      super(file: reference.relative_path, message: build_message(reference, violation_type), location: location)
+      @reference = reference
+      @violation_type = violation_type
+    end
+
+    private
+
+    def build_message(reference, violation_type)
+      violation_message = case violation_type
+      when ViolationType::Privacy
+        source_desc = reference.source_package ? "'#{reference.source_package}'" : "here"
+        "Privacy violation: '#{reference.constant.name}' is private to '#{reference.constant.package}' but " \
+        "referenced from #{source_desc}.\n" \
+        "Is there a public entrypoint in '#{reference.constant.package.public_path}' that you can use instead?"
+      when ViolationType::Dependency
+        "Dependency violation: #{reference.constant.name} belongs to '#{reference.constant.package}', but " \
+        "'#{reference.source_package}' does not specify a dependency on " \
+        "'#{reference.constant.package}'.\n" \
+        "Are we missing an abstraction?\n" \
+        "Is the code making the reference, and the referenced constant, in the right packages?\n"
+      end
+
+      <<~EOS
+        #{violation_message}
+        Inference details: this is a reference to #{reference.constant.name} which seems to be defined in #{reference.constant.location}.
+        To receive help interpreting or resolving this error message, see: https://github.com/Shopify/packwerk/blob/main/TROUBLESHOOT.md#Troubleshooting-violations
+      EOS
+    end
+  end
+end

data/lib/packwerk/result.rb

@@ -0,0 +1,9 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  class Result < T::Struct
+    prop :message, String
+    prop :status, T::Boolean
+  end
+end

data/lib/packwerk/run_context.rb

@@ -3,17 +3,6 @@
 
 require "constant_resolver"
 
-require "packwerk/association_inspector"
-require "packwerk/constant_discovery"
-require "packwerk/const_node_inspector"
-require "packwerk/dependency_checker"
-require "packwerk/file_processor"
-require "packwerk/inflector"
-require "packwerk/package_set"
-require "packwerk/privacy_checker"
-require "packwerk/reference_extractor"
-require "packwerk/node_processor_factory"
-
 module Packwerk
   class RunContext
     extend T::Sig
@@ -27,23 +16,20 @@ module Packwerk
       :checker_classes,
     )
 
-    attr_accessor :reference_lister
-
     DEFAULT_CHECKERS = [
       ::Packwerk::DependencyChecker,
       ::Packwerk::PrivacyChecker,
     ]
 
     class << self
-      def from_configuration(configuration, reference_lister:)
+      def from_configuration(configuration)
         inflector = ::Packwerk::Inflector.from_file(configuration.inflections_file)
         new(
           root_path: configuration.root_path,
           load_paths: configuration.load_paths,
           package_paths: configuration.package_paths,
           inflector: inflector,
-          custom_associations: configuration.custom_associations,
-          reference_lister: reference_lister,
+          custom_associations: configuration.custom_associations
         )
       end
     end
@@ -54,8 +40,7 @@ module Packwerk
       package_paths: nil,
       inflector: nil,
       custom_associations: [],
-      checker_classes: DEFAULT_CHECKERS,
-      reference_lister:
+      checker_classes: DEFAULT_CHECKERS
     )
       @root_path = root_path
       @load_paths = load_paths
@@ -63,7 +48,6 @@ module Packwerk
       @inflector = inflector
       @custom_associations = custom_associations
       @checker_classes = checker_classes
-      @reference_lister = reference_lister
     end
 
     sig { params(file: String).returns(T::Array[T.nilable(::Packwerk::Offense)]) }
@@ -84,8 +68,7 @@ module Packwerk
         context_provider: context_provider,
         checkers: checkers,
         root_path: root_path,
-        constant_name_inspectors: constant_name_inspectors,
-        reference_lister: reference_lister
+        constant_name_inspectors: constant_name_inspectors
       )
     end
 

data/lib/packwerk/sanity_checker.rb

@@ -1,8 +1,6 @@
 # typed: false
 # frozen_string_literal: true
 
-require "packwerk/application_validator"
-
 module Packwerk
   # To do: This alias and file should be removed as it is deprecated
   warn("DEPRECATION WARNING: Packwerk::SanityChecker is deprecated, use Packwerk::ApplicationValidator instead.")

data/lib/packwerk/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Packwerk
-  VERSION = "1.1.2"
+  VERSION = "1.3.1"
 end

data/lib/packwerk/violation_type.rb

@@ -1,8 +1,6 @@
 # typed: true
 # frozen_string_literal: true
 
-require "sorbet-runtime"
-
 module Packwerk
   class ViolationType < T::Enum
     enums do

data/library.yml

@@ -3,4 +3,4 @@ name: Packwerk
 stewards:
 - "@Shopify/kernel-architecture-patterns"
 slack_channels:
-- architecture-patterns
+- code-foundations

data/packwerk.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency("activesupport", ">= 5.2")
   spec.add_dependency("constant_resolver")
+  spec.add_dependency("parallel")
   spec.add_dependency("sorbet-runtime")
 
   spec.add_development_dependency("bundler")

data/service.yml

@@ -1,6 +1,3 @@
-# https://services.shopify.io/services/packwerk/production
-org_line: Kernel
-owners: Shopify/kernel-architecture-patterns
 classification: library
 slack_channels:
-  - architecture-patterns
+- core-stewardship

data/shipit.rubygems.yml

@@ -1 +1,5 @@
-# default configs
+dependencies:
+  override: []
+deploy:
+  override:
+  - release-gem packwerk.gemspec rake release

data/sorbet/rbi/gems/{actioncable@6.1.0.alpha-d80c18a391e33552ae2d943e68af56946f883f65.rbi → actioncable@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi}

@@ -1,6 +1,6 @@
 # DO NOT EDIT MANUALLY
 # This is an autogenerated file for types exported from the `actioncable` gem.
-# Please instead update this file by running `dev typecheck update`.
+# Please instead update this file by running `bin/tapioca sync`.
 
 # typed: true
 
@@ -49,12 +49,12 @@ class ActionCable::Channel::Base
   def _unsubscribe_callbacks; end
   def connection; end
   def identifier; end
-  def logger(*args, &block); end
+  def logger(*_arg0, &_arg1); end
   def params; end
   def perform_action(data); end
-  def periodic_timers=(_); end
+  def periodic_timers=(_arg0); end
   def rescue_handlers; end
-  def rescue_handlers=(_); end
+  def rescue_handlers=(_arg0); end
   def rescue_handlers?; end
   def subscribe_to_channel; end
   def unsubscribe_from_channel; end
@@ -107,8 +107,8 @@ module ActionCable::Channel::Broadcasting
 
   mixes_in_class_methods(::ActionCable::Channel::Broadcasting::ClassMethods)
 
-  def broadcast_to(*args, &block); end
-  def broadcasting_for(*args, &block); end
+  def broadcast_to(*_arg0, &_arg1); end
+  def broadcasting_for(*_arg0, &_arg1); end
 end
 
 module ActionCable::Channel::Broadcasting::ClassMethods
@@ -139,7 +139,7 @@ module ActionCable::Channel::Naming
 
   mixes_in_class_methods(::ActionCable::Channel::Naming::ClassMethods)
 
-  def channel_name(*args, &block); end
+  def channel_name(*_arg0, &_arg1); end
 end
 
 module ActionCable::Channel::Naming::ClassMethods
@@ -167,13 +167,13 @@ end
 module ActionCable::Channel::Streams
   extend(::ActiveSupport::Concern)
 
-  def pubsub(*args, &block); end
+  def pubsub(*_arg0, &_arg1); end
   def stop_all_streams; end
   def stop_stream_for(model); end
   def stop_stream_from(broadcasting); end
   def stream_for(model, callback = T.unsafe(nil), coder: T.unsafe(nil), &block); end
   def stream_from(broadcasting, callback = T.unsafe(nil), coder: T.unsafe(nil), &block); end
-  def stream_or_reject_for(record); end
+  def stream_or_reject_for(model); end
 
   private
 
@@ -194,7 +194,7 @@ class ActionCable::Channel::TestCase < ::ActiveSupport::TestCase
   extend(::ActionCable::Channel::TestCase::Behavior::ClassMethods)
 
   def _channel_class; end
-  def _channel_class=(_); end
+  def _channel_class=(_arg0); end
   def _channel_class?; end
   def connection; end
   def subscription; end
@@ -264,9 +264,9 @@ class ActionCable::Connection::Base
   def close(reason: T.unsafe(nil), reconnect: T.unsafe(nil)); end
   def dispatch_websocket_message(websocket_message); end
   def env; end
-  def event_loop(*args, &block); end
+  def event_loop(*_arg0, &_arg1); end
   def identifiers; end
-  def identifiers=(_); end
+  def identifiers=(_arg0); end
   def identifiers?; end
   def logger; end
   def on_close(reason, code); end
@@ -275,10 +275,10 @@ class ActionCable::Connection::Base
   def on_open; end
   def process; end
   def protocol; end
-  def pubsub(*args, &block); end
+  def pubsub(*_arg0, &_arg1); end
   def receive(websocket_message); end
   def rescue_handlers; end
-  def rescue_handlers=(_); end
+  def rescue_handlers=(_arg0); end
   def rescue_handlers?; end
   def send_async(method, *arguments); end
   def server; end
@@ -438,7 +438,7 @@ class ActionCable::Connection::Subscriptions
   def add(data); end
   def execute_command(data); end
   def identifiers; end
-  def logger(*args, &block); end
+  def logger(*_arg0, &_arg1); end
   def perform_action(data); end
   def remove(data); end
   def remove_subscription(subscription); end
@@ -477,7 +477,7 @@ class ActionCable::Connection::TestCase < ::ActiveSupport::TestCase
   extend(::ActionCable::Connection::TestCase::Behavior::ClassMethods)
 
   def _connection_class; end
-  def _connection_class=(_); end
+  def _connection_class=(_arg0); end
   def _connection_class?; end
   def connection; end
 
@@ -556,7 +556,7 @@ class ActionCable::RemoteConnections::RemoteConnection
 
   def disconnect; end
   def identifiers; end
-  def identifiers=(_); end
+  def identifiers=(_arg0); end
   def identifiers?; end
 
   protected
@@ -593,7 +593,7 @@ class ActionCable::Server::Base
   def connection_identifiers; end
   def disconnect(identifiers); end
   def event_loop; end
-  def logger(*args, &block); end
+  def logger(*_arg0, &_arg1); end
   def mutex; end
   def pubsub; end
   def remote_connections; end
@@ -625,26 +625,26 @@ class ActionCable::Server::Configuration
   def initialize; end
 
   def allow_same_origin_as_host; end
-  def allow_same_origin_as_host=(_); end
+  def allow_same_origin_as_host=(_arg0); end
   def allowed_request_origins; end
-  def allowed_request_origins=(_); end
+  def allowed_request_origins=(_arg0); end
   def cable; end
-  def cable=(_); end
+  def cable=(_arg0); end
   def connection_class; end
-  def connection_class=(_); end
+  def connection_class=(_arg0); end
   def disable_request_forgery_protection; end
-  def disable_request_forgery_protection=(_); end
+  def disable_request_forgery_protection=(_arg0); end
   def log_tags; end
-  def log_tags=(_); end
+  def log_tags=(_arg0); end
   def logger; end
-  def logger=(_); end
+  def logger=(_arg0); end
   def mount_path; end
-  def mount_path=(_); end
+  def mount_path=(_arg0); end
   def pubsub_adapter; end
   def url; end
-  def url=(_); end
+  def url=(_arg0); end
   def worker_pool_size; end
-  def worker_pool_size=(_); end
+  def worker_pool_size=(_arg0); end
 end
 
 module ActionCable::Server::Connections
@@ -659,15 +659,29 @@ ActionCable::Server::Connections::BEAT_INTERVAL = T.let(T.unsafe(nil), Integer)
 
 class ActionCable::Server::Worker
   include(::ActiveSupport::Callbacks)
+  include(::ActionCable::Server::Worker::ActiveRecordConnectionManagement)
   extend(::ActiveSupport::Callbacks::ClassMethods)
   extend(::ActiveSupport::DescendantsTracker)
 
+  def initialize(max_size: T.unsafe(nil)); end
+
   def __callbacks; end
   def __callbacks?; end
   def _run_work_callbacks(&block); end
   def _work_callbacks; end
+  def async_exec(receiver, *args, connection:, &block); end
+  def async_invoke(receiver, method, *args, connection: T.unsafe(nil), &block); end
   def connection; end
   def connection=(obj); end
+  def executor; end
+  def halt; end
+  def invoke(receiver, method, *args, connection:, &block); end
+  def stopping?; end
+  def work(connection); end
+
+  private
+
+  def logger; end
 
   class << self
     def __callbacks; end
@@ -680,6 +694,12 @@ class ActionCable::Server::Worker
   end
 end
 
+module ActionCable::Server::Worker::ActiveRecordConnectionManagement
+  extend(::ActiveSupport::Concern)
+
+  def with_database_connections; end
+end
+
 module ActionCable::SubscriptionAdapter
   extend(::ActiveSupport::Autoload)
 end
@@ -738,8 +758,8 @@ module ActionCable::TestHelper
   def assert_broadcasts(stream, number, &block); end
   def assert_no_broadcasts(stream, &block); end
   def before_setup; end
-  def broadcasts(*args, &block); end
-  def clear_messages(*args, &block); end
+  def broadcasts(*_arg0, &_arg1); end
+  def clear_messages(*_arg0, &_arg1); end
   def pubsub_adapter; end
 
   private
@@ -766,7 +786,7 @@ module ActionCable::Channel::ChannelStub
   def start_periodic_timers; end
   def stop_all_streams; end
   def stop_periodic_timers; end
-  def stream_from(broadcasting, *_); end
+  def stream_from(broadcasting, *_arg1); end
   def streams; end
 end
 
@@ -806,9 +826,9 @@ end
 
 class ActionCable::Connection::TestRequest < ::ActionDispatch::TestRequest
   def cookie_jar; end
-  def cookie_jar=(_); end
+  def cookie_jar=(_arg0); end
   def session; end
-  def session=(_); end
+  def session=(_arg0); end
 end
 
 class ActionCable::SubscriptionAdapter::Async < ::ActionCable::SubscriptionAdapter::Inline
@@ -821,12 +841,12 @@ end
 class ActionCable::SubscriptionAdapter::Async::AsyncSubscriberMap < ::ActionCable::SubscriptionAdapter::SubscriberMap
   def initialize(event_loop); end
 
-  def add_subscriber(*_); end
-  def invoke_callback(*_); end
+  def add_subscriber(*_arg0); end
+  def invoke_callback(*_arg0); end
 end
 
 class ActionCable::SubscriptionAdapter::Inline < ::ActionCable::SubscriptionAdapter::Base
-  def initialize(*_); end
+  def initialize(*_arg0); end
 
   def broadcast(channel, payload); end
   def shutdown; end