リモート開発で実現した僕のSemi-ultimate coding experience

こんにちは。PCが遅くて困っていたラボルの中垣です。

Remote開発って知ってますか？リモート開発は開発環境（コード、実行環境）をリモートサーバーに置くことでDeveloper Experienceを良くするものです。IntelliJのサイトに分かりやすい説明があるので見てみてください。

The ultimate coding experience for a remote world
-- IntelliJのサイト

Ultimate coding experienceほしいですね。でも僕の場合はPCが遅い問題を解決するため、ローカルPCの負荷をリモートサーバーに移すような環境を作りました。

背景
試み１(失敗)：物理サーバーでリモート開発をする
試み２(成功)：Dockerだけリモートサーバーで起動
Choose your weapon wisely, my fellow devs
最後に

背景

PCが遅かったんです。どのくらい遅かったかの例として、日本語をタイプしてから文字が表示されるまでに秒単位のラグがありました。Labolの開発環境のせいでPC全体が遅くなっているんじゃないかと考え、リモート開発を試すことにしました。

Labolではローカル環境で開発しているため、ローカルPCで色々動いています。

Docker container(MySQL, Redis, SQSなど合計で6個)
SpringのApplication server(3つ)
Nuxt server
Vue用のbrowser-sync

一つのプロダクトでこんなにたくさんのものが動いている理由は管理面、Web面、送金などでサービスが分かれているためです。これらのサービスは連携してい動いているため、すべて起動した状態での開発が楽なんです。

これらの負荷をリモートサーバーに移せばPCが早くなると考え、あまりお金がかからない範囲でリモート開発を試みました。

試み１(失敗)：物理サーバーでリモート開発をする

社内の物理サーバー（KVM）に個人用サーバーがあったのでそれをリモート開発に使っちゃおうと考えてました。こんな感じに。

ローカルPCにはソースコードがなく、DockerやWeb serverも起動しません。リモートサーバーにソースコードを起き、そこでDockerやWeb serverなど開発に必要なものが起動している状態で、ローカルPCはただリモートサーバーにつなぎに行くだけです。僕の場合個人用サーバーがあったのでそれをリモートサーバーとして使いました。

これを設定するのに下記のような手順を踏みました。

Jetbrains Gatewayをインストール
個人用サーバーがJetbrains Gatewayの最低限のスペックを満たしていなかったのでスペック上げる
Jetbrains Gatewayで個人用サーバーに繋ごうとしてエラー出る
色々試してやっと繋げるようになる
リモート開発開始！
IDEがめっちゃ遅くて悲しくなる
このとき個人サーバーのCPUとMemoryが常に100%近い状態でした。補完が遅かったり、反応しなくなったりしてました。
リモート開発やめる

最終的にローカル開発よりも遅くなっちゃったのでリモート開発はやめちゃいました。遅いこと以外にもやりずらいところが複数ありました。

キーバインドが全然違う
MacOSのキーバインドではなくLinuxのキーバインドになっていた。例えばクラスを探すコマンドはMacOSでは⌘ + Oですが、LinuxではCtrl + N 。これはIDEのBackend処理を行うプログラムがLinuxサーバーにインストールされているため、デフォルトキーマップがLinux用になってしまったと考えられます。簡単にMacOSのキーバインドにすることができるかもしれないですが、僕はやり方が分からなかっです。
普通のIntelliJと挙動が違う
Project windowでハイライトしただけでなぜかファイルが開く。
Database clientの実行選択機能が無い、など。
設定方法が難しい
普通のIDEの設定とリモート開発用のHost Settingが分かれていて、重複もしているためどっとの設定を変えればいいかわかりずらい。
僕の大好きなPlantUMLが使えなかった

でも僕はまた別の方法でリモート開発を試みました。BUT! If this works, I am certain that my dev experience will go through the roof, so I'll try it again later when I have the chance :DZ

試み２(成功)：Dockerだけリモートサーバーで起動

前回の失敗を踏まえてもっといい感じにリモート開発できないか試みました。

前回の失敗で学んだこと:

僕の個人サーバーはLabolの開発環境を実行できるほどスペックが高くない
Jetbrains GatewayはいつものIDEと見た目は似てるけどちょこちょこ違うところがあって使いづらい

そこで僕はDockerだけリモートに立ち上げて、ローカルPCからはDockerにPort forwardingすることでSemi-ultimateでSemi-remoteな開発環境を作ることができました。こんな感じです。

この方法を取ることでこんないいことがありました。

ローカルPCが早くなった
Dockerで使っていたリソース分が浮いたのでローカルPCは負荷が減りました
MySQLのdumpやimportがめっちゃ早い
MacOSのDockerDesktopではdumpやimportが5~10秒ぐらいかかってましたが、Linuxだと1秒になりました。

でもこんな良くないこともありました。

Networkが変わったらPort forwardingし直す必要がある Networkが変わるときに一回Port forwardingが切れるのでつなぎ直す必要があります。
docker-composeに変更が入ったらリモートサーバーでpullする必要があるちょっと面倒ですが、docker-composeが変わることがあまりないのであまり気にしてません。