📝

[Rails]そのコードって本当に使ってない...?

2025/01/20に公開

Daily Blogging30日目

業務中に不要そうなコード(分岐)を見かけたので消そうかなって思った
でも結構システムの根幹に関わる部分にあるコードだったのでめちゃくちゃ躊躇いながらも消した。
何事もありませんように...

そのコードって本当に使われてないよね??

例えば、どこからも参照されていないメソッドを消すのは比較的簡単
基本的には全文検索してどこからも呼ばれてなかったら消しても大体問題ない
でも条件分岐とかの場合はどうだろうか
例えばデータの状態によって条件分岐するコードがあったとして、
その分岐に行くことはもう確実にないってどうやったら言えるかな...?
こういうのは消してもいいのかの判断がなかなかつかない
そして消したいけど消せないコードが増える
その結果、新入社員に「このコードってなんですか?」っていう質問をされた時に何も答えられなくなるんだっ

みんなこの手の問題に直面してるらしい

ネットで解決策を軽く調べてるとみんなこの問題に直面してるらしい
特にサービス歴が長いとより直面してるっぽい

分析基盤を作るのは結構手間かかるし、業務でじゃあやろうとは多分ならない
少なくともうちじゃ無理だ

ログを仕込むは結構簡単にできる
でも最初に目星つけるのが結構大変かも??

Coverbandで一目瞭然

AIにもっと簡単にできる方法ないか聞いてみた
Coverband勧められた

Coverband の主な目的は、アプリケーションのプロダクション環境での実行コード使用状況を詳細に把握することです。パフォーマンスへの影響を最小限に抑えつつ、実行されたコードの行数をカウントします。

なんだか使えそう
Demo用のプロジェクトがあったのでとりあえず起動してみる

デモアプリ起動

githubにGetting Startedってあるけど、Dockerfileあるのでそっちで起動する
M1 Macbook air使ってる影響もあり、Dockerfileとか修正必要だった

  1. 下記コマンドを実行
    bundle lock --add-platform aarch64-linux

  2. Dockerfileを修正

# syntax = docker/dockerfile:1

# Define Ruby version
ARG RUBY_VERSION=3.2.2
FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim as base

# Rails app lives here
WORKDIR /rails

# Set development environment variables
ENV RAILS_ENV="development" \
    BUNDLE_DEPLOYMENT="1" \
    BUNDLE_PATH="/usr/local/bundle"

# Throw-away build stage to reduce size of final image
FROM base as build

# Install packages needed to build gems
RUN apt-get update -qq && \
    apt-get install --no-install-recommends -y build-essential git libvips pkg-config

# Copy Gemfile and Gemfile.lock first for caching layer
COPY Gemfile Gemfile.lock ./

# Install application gems
RUN bundle install && \
    gem install bundler && \
    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
    bundle exec bootsnap precompile --gemfile

# Copy application code (includes the rest of the app files)
COPY . .

# Precompile bootsnap code for faster boot times
RUN bundle exec bootsnap precompile app/ lib/

# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile

# Final stage for app image
FROM base

# Install packages needed for deployment
RUN apt-get update -qq && \
    apt-get install --no-install-recommends -y curl libsqlite3-0 libvips && \
    rm -rf /var/lib/apt/lists /var/cache/apt/archives

# Copy built artifacts: gems, application
COPY --from=build /usr/local/bundle /usr/local/bundle
COPY --from=build /rails /rails

# Run and own only the runtime files as a non-root user for security
RUN useradd rails --create-home --shell /bin/bash && \
    chown -R rails:rails db log storage tmp
USER rails:rails

# Entrypoint prepares the database
ENTRYPOINT ["/rails/bin/docker-entrypoint"]

# Start the server by default, this can be overwritten at runtime
EXPOSE 3000
CMD ["./bin/rails", "server", "-b", "0.0.0.0"] # ここ修正
  1. docker build -t coverband_example .
  2. docker run -p 3000:3000 -e REDIS_URL=redis://host.docker.internal:6379 coverband_example

これで起動できる(はず)
http://localhost:3000/coverage#_Coverage

こんな感じになる

サイト的には超簡易的にpostできる機能が実装されているので、それでどう変化するのかみてみる

before

after

posts_controllerの数値が若干増えてる

ファイルごとに詳細が見れる

今回で言うと、postを2回作ってみたのでcreateメソッドがの数値が2になってた
ちなみに、集計情報はファイルごとにクリアできたりもする

Discussion