Introducing the Deprecation Toolkit

Edouard CHIN

Shopify

•

Edouard CHIN

•5 min read•beginner•

--

•View Original

RailsRubyYAML

Overview

Shopify has open-sourced the Deprecation Toolkit, a Ruby gem designed to efficiently track and manage deprecations in codebases. This toolkit aims to streamline the process of upgrading dependencies by minimizing the use of deprecated code, thus enhancing the overall development workflow.

What You'll Learn

1

How to implement the Deprecation Toolkit in your Ruby application

2

Why managing deprecations is crucial for maintaining a healthy codebase

3

When to use a whitelist approach for deprecation tracking

Prerequisites & Requirements

Familiarity with Ruby and Ruby on Rails concepts
Basic understanding of YAML file format(optional)

Key Questions Answered

How does the Deprecation Toolkit help manage deprecated code?

The Deprecation Toolkit uses a whitelist approach to track deprecations in a Ruby application. It records existing deprecations during test runs and compares them against a list of acceptable deprecations, raising errors for any new or removed deprecations. This allows developers to address deprecations gradually without blocking their workflow.

What is the motivation behind creating the Deprecation Toolkit?

The motivation for the Deprecation Toolkit arose from the need to prevent hundreds of developers at Shopify from unintentionally using deprecated code. By minimizing deprecated code usage, the toolkit aims to speed up the dependency upgrade process, which can often require significant human intervention.

What are the configuration options available in the Deprecation Toolkit?

The Deprecation Toolkit offers various configuration options, including the ability to ignore specific deprecations, dynamically determine where deprecations should be recorded, and create custom behaviors for new deprecations. The default configuration can be easily set up by adding the gem to the Gemfile.

Key Statistics & Figures

Number of merchants using Shopify

600,000+

This statistic highlights the scale at which Shopify operates, emphasizing the importance of maintaining a robust codebase for effective service delivery.

Number of countries where Shopify operates

over 175

This indicates the global reach of Shopify, underscoring the need for efficient code management across diverse environments.

Technologies & Tools

Some links below are affiliate links. We may earn a commission if you make a purchase.

Backend

Ruby

The Deprecation Toolkit is a Ruby gem designed to manage deprecations in Ruby applications.

Data Format

YAML

YAML files are used by the toolkit to store the whitelist of acceptable deprecations.

Key Actionable Insights

1
Integrate the Deprecation Toolkit into your development workflow to enhance code quality.
By using the toolkit, you can systematically track and manage deprecations, ensuring that your codebase remains clean and maintainable, which is essential for long-term project success.

2
Utilize the whitelist approach to manage existing deprecations without overwhelming your team.
This method allows you to gradually address deprecations while still enabling developers to work on new features, thus balancing maintenance and development efforts.

3
Gamify the process of fixing deprecations to encourage team participation.
Assigning ownership of deprecated code to team leads and tracking progress can motivate developers to actively participate in maintaining code quality.

Common Pitfalls

1

Relying solely on warning messages for deprecations can lead to missed issues.

Developers may overlook warning messages if there are many deprecations, making it crucial to implement a more robust tracking system like the Deprecation Toolkit.

Related Concepts

Code Quality Management

Dependency Management

Ruby On Rails Best Practices

8 minute read Hundreds of Shopify developers work on our largest codebase, the monolithic Rails application that powers most of our product offering. There are various benefits to having a “majestic monolith,” but also a few downsides. Chief among them is the amount of time people spend waiting for Rails to boot. Doing development, two of the most common tasks are running a development server and running a unit test file. By improving the performance of these tasks, we will also improve the experience for developers working on this codebase and achieve higher iteration speed. We started measuring and profiling the following code paths: Development server: time to first request Unit testing: time to first unit test

RubyRailsYAML

7 min read

Includes Code

Has Summary

--

Shopify

Intermediate

Upgrading Shopify to Rails 5

Today, Shopify runs on Rails 5.0, the latest version. It’s important to us to stay on the latest version so we can improve the performance and stability of the application without having to increase the maintenance cost of applying monkey patches. This guarantees we would always be in the version maintained by the community; and, that we would have access to new features soon. Upgrading the Shopify monolith—one of the oldest and the largest Rails applications in the industry—from Rails 4.2 to 5.0 took us nearly a year. In this post, I’ll share our upgrade story and the lessons we learned. If you're wondering how the Shopify scale looks like or you plan a major Rails upgrade, this post is for you.

DockerRubyRails

8 min read

Includes Code

Has Summary

--

Shopify

Advanced

Spark Joy by Running Fewer Tests

JavaScriptRubyRails

9 min read

Has Summary

--

These articles from Shopify and other leading engineering teams share similar topics with "Introducing the Deprecation Toolkit". Explore more engineering insights on Ruby, Rails, Docker.