Skip to content

Latest commit

 

History

History
364 lines (247 loc) · 15.5 KB

USAGE.md

File metadata and controls

364 lines (247 loc) · 15.5 KB
Raw

Packwerk usage

Table of Contents

What problem does Packwerk solve?

Large applications need clear boundaries to avoid turning into a ball of mud. However, Ruby does not provide a good solution to enforcing boundaries between code.

Packwerk is a gem that can be used to enforce boundaries between groups of code we call packages.

What is a package?

A package is a folder containing autoloaded code. To decide whether code belongs together in a package, these are some design best practices:

  • We should package things together that have high functional cohesion.
  • Packages should be relatively loosely coupled to each other.

cohesion

Package principles

Package principles help to guide the organization of classes in a large system. These principles can also be applied to packages in large and complex codebases.

They are well described in Robert Martin's Design Principles and Design Patterns (right after the SOLID principles).

Getting started

After including Packwerk in the Gemfile, you will first want to generate a binstub: You can do this by running bundle binstub packwerk, which will generate a binstub at bin/packwerk.

Then, you can generate the necessary files to get Packwerk running by executing:

bin/packwerk init

Here is a list of files generated:

File Location Description
Packwerk configuration packwerk.yml See Setting up the configuration file
Root package package.yml A package for the root folder

After that, you may begin creating packages for your application. See Defining packages

Setting up Spring

Spring is a preloader for Rails. Because packwerk loads Rails, it can be sped up dramatically by enabling spring. Packwerk supports the usage of Spring. Firstly, spring needs to know about the packwerk spring command when spring is loading. To do that, add require 'packwerk/spring_command' to config/spring.rb in your application. Secondly, to enable Spring, first run bin/spring binstub packwerk which will "springify" the generated binstub.

Configuring Packwerk

Packwerk reads from the packwerk.yml configuration file in the root directory. Packwerk will run with the default configuration if any of these settings are not specified.

Key Default value Description
include **/*.{rb,rake,erb} list of patterns for folder paths to include
exclude {bin,node_modules,script,tmp,vendor}/**/* list of patterns for folder paths to exclude
package_paths **/ a single pattern or a list of patterns to find package configuration files, see: Defining packages
custom_associations N/A list of custom associations, if any
parallel true when true, fork code parsing out to subprocesses
cache false when true, caches the results of parsing files
cache_directory tmp/cache/packwerk the directory that will hold the packwerk cache

Using a custom ERB parser

You can specify a custom ERB parser if needed. For example, if you're using <%graphql> tags from https://github.com/github/graphql-client in your ERBs, you can use a custom parser subclass to comment them out so that Packwerk can parse the rest of the file:

class CustomParser < Packwerk::Parsers::Erb
  def parse_buffer(buffer, file_path:)
    preprocessed_source = buffer.source

    # Comment out <%graphql ... %> tags. They won't contain any object
    # references anyways.
    preprocessed_source = preprocessed_source.gsub(/<%graphql/, "<%#")

    preprocessed_buffer = Parser::Source::Buffer.new(file_path)
    preprocessed_buffer.source = preprocessed_source
    super(preprocessed_buffer, file_path: file_path)
  end
end

Packwerk::Parsers::Factory.instance.erb_parser_class = CustomParser

Using the cache

Packwerk ships with an cache to help speed up file parsing. You can turn this on by setting cache: true in packwerk.yml.

This will write to tmp/cache/packwerk.

Validating the package system

There are some criteria that an application must meet in order to have a valid package system. These criteria include having a valid autoload path cache, package definition files, and application folder structure. The dependency graph within the package system also has to be acyclic.

We recommend setting up the package system validation for your Rails application in a CI step (or through a test suite for Ruby projects) separate from bin/packwerk check.

Use the following command to validate the application:

bin/packwerk validate

Defining packages

You can create a package.yml in any folder to make it a package. The package name is the path to the folder from the project root.

Note: It is helpful to define a namespace that corresponds to the package name and contains at least all the public constants of the package. This makes it more obvious which package a constant is defined in.

Package metadata

Package metadata can be included in the package.yml. Metadata won't be validated, and can thus be anything. We recommend including information on ownership and stewardship of the package.

Example:

    # components/sales/package.yml
    metadata:
      stewards:
      - "@Shopify/sales"
      slack_channels:
      - "#sales"

Types of boundary checks

Packwerk ships with dependency boundary checking only. Other checking support may be added by extension gems.

Enforcing dependency boundary

A package's dependency boundary is violated whenever it references a constant in some package that has not been declared as a dependency.

Specify enforce_dependencies: true to start enforcing the dependencies of a package. The intentional dependencies of the package are specified as a list under a dependencies: key.

Example:

# components/shop_identity/package.yml
enforce_dependencies: true
dependencies:
  - components/platform

It will be a dependency violation when components/shop_identity tries to reference a constant that is not within components/platform or itself.

Using strict mode

You can turn on strict mode to prevent new violations from being added to the package's package_todo.yml. To use this, simply change enforce_dependencies: true to enforce_dependencies: strict in your package.yml.

Then, when you run bin/packwerk check, new violations will cause the following error to be displayed:

packs/referencing_package cannot have dependency violations on packs/defining_package because strict mode is enabled for dependency violations in packs/referencing_package/package.yml

Once the strict mode is enabled on a package, running bin/packwerk update-todo will not add new violations in the package_todo.yml file and the command will return an error.

Checking for violations

After enforcing the boundary checks for a package, you may execute:

bin/packwerk check

Packwerk will check the entire codebase for any new or stale violations.

You can also specify folders for a shorter run time. When checking against folders all subfolders will be analyzed, irrespective of nested package boundaries.

bin/packwerk check components/your_package

You can also specify packages for a shorter run time. When checking against packages any packages nested underneath the specified packages will not be checked. This can be helpful to test packages like the root package, which can have many nested packages.

bin/packwerk check --packages=components/your_package,components/your_other_package

Using the following command line option you can also enable or disable parallel processing. It is enabled by default.

bin/packwerk check --[no-]parallel

In order to keep the package system valid at each version of the application, we recommend running bin/packwerk check in your CI pipeline.

See: TROUBLESHOOT.md - Sample violations

Resolving new violations

Understanding how to respond to new violations

When you have a new dependency violation, what do you do?

See: RESOLVING_VIOLATIONS.md

Recording existing violations

For existing codebases, packages are likely to have existing boundary violations.

If so, you will want to stop the bleeding and prevent more violations from occuring. The existing violations in the codebase can be recorded in a todo list by executing:

bin/packwerk update-todo

bin/packwerk update-todo should only be run to record existing violations and to remove violations that have been worked off. Running bin/packwerk update-todo to resolve a violation should be the very last resort.

See: TROUBLESHOOT.md - Troubleshooting violations

Understanding the package todo file

The package TODO list is called package_todo.yml and can be found in the package folder. The list outlines the constant violations of the package, where the violation is located, and the file defining the violation.

The package TODO list should not be added to, but worked off over time.

components/merchant:
  "::Checkouts::Core::CheckoutId":
    violations:
    - dependency
    files:
    - components/merchant/app/public/merchant/generate_order.rb

Above is an example of a constant violation entry in package_todo.yml.

  • components/merchant - package where the constant violation is found
  • ::Checkouts::Core::CheckoutId - violated constant in question
  • dependency - type of violation, typically dependency
  • components/merchant/app/public/merchant/generate_order.rb - path to the file containing the violated constant

Violations exist within the package that makes a violating reference.

Loading Extensions

You can optionally specify ruby files that you'd like to be loaded with packwerk by specifying a require directive in packwerk.yml:

require:
  - ./path/to/file.rb
  - my_gem

packwerk will directly call require with these paths. You can prefix local files with a dot to define them relative to packwerk.yml, or you can use absolute paths. You can also reference the name of a gem.

Examples

Custom Offense Formatter

While packwerk ships with its own offense formatter, you may specify a custom one in your configuration file via the offenses_formatter: key. Your custom formatter will be used when bin/packwerk check is run.

Firstly, you'll need to create an OffensesFormatter class that includes Packwerk::OffensesFormatter. You can use Packwerk::Formatters::OffensesFormatter as a point of reference for this. Then, in the require directive described above, you'll want to tell packwerk about it:

# ./path/to/file.rb
class MyOffensesFormatter
  include Packwerk::OffensesFormatter
  # implement the `OffensesFormatter` interface

  def identifier
    'my_offenses_formatter'
  end
end

Then in packwerk.yml, you can set the formatter to the identifier for your class:

offenses_formatter: my_offenses_formatter

You can also pass in a formatter on the command line:

bin/packwerk check --offenses-formatter=my_offenses_formatter

Custom Checkers

Packwerk ships with a way to analyze dependencies and also supports custom checkers from extension gems.

Custom checkers will allow references to constants to be analyzed in new ways, and for those invalid references to show up as violations in package_todo.yml.

To create a custom checker, you'll first need to create a checker class that includes Packwerk::Checker. You can use Packwerk::ReferenceChecking::Checkers::DependencyChecker as a point of reference for this. Here is an example:

# ./path/to/file.rb
class MyChecker
  include Packwerk::Checker
  # implement the `Checker` interface

  sig { override.returns(String) }
  def violation_type
    'my_custom_violation_type'
  end

  sig { override.params(listed_offense: ReferenceOffense).returns(T::Boolean) }
  def strict_mode_violation?(listed_offense)
    # This will allow "strict mode" to be supported in your checker
    referencing_package = listed_offense.reference.package
    referencing_package.config["enforce_custom"] == "strict"
  end

  sig { override.params(reference: Reference).returns(T::Boolean) }
  def invalid_reference?(reference)
    # your logic here
  end

  sig { override.params(reference: Reference).returns(String) }
  def message(reference)
    # your message here
  end
end

Then, in the require directive described above, you'll want to tell packwerk about it:

require:
  - ./path/to/file.rb

Custom Validators

Similar to checkers, you can define your own validator to be executed when bin/packwerk validate is invoked. This can be used to support your custom checker (by specifying permitted keys) or to provide any other validations you want to impose on packages.

To create a custom validator, you'll first need to create a validator class that includes Packwerk::Validator. You can use Packwerk::Validators::DependencyValidator as a point of reference for this. Here is an example:

# ./path/to/file.rb
class MyValidator
  include Packwerk::Validator
  # implement the `Validator` interface

  sig { override.returns(T::Array[String]) }
  def permitted_keys
    ['enforce_my_custom_checker']
  end

  sig { override.params(package_set: PackageSet, configuration: Configuration).returns(ApplicationValidator::Result) }
  def call(package_set, configuration)
    # your logic here
  end
end

Then, in the require directive described above, you'll want to tell packwerk about it:

require:
  - ./path/to/file.rb