はじめに
Reactで開発した学習記録アプリをデータの永続化と自動テスト&デプロイに対応させました。
データベースとの接続、ホスティングサービスへのデプロイ、テストの導入、CI/CDでの自動化など初めて行うことばかりで躓きの連続でしたが、1つずつ向き合い何とか実装することが出来ました。
開発を通して学んだことや、苦労したことをまとめます。
アプリの構成
| 分類 | 使用技術 |
|---|---|
| 開発環境 | Vite |
| フレームワーク | React |
| DB | Supabase |
| CI/CD | GitHub Actions |
| テスト | Vitest/React Testing Libraly |
| ホスティング | Firebase Hosting |
GitHub
https://github.com/ryu0947/study-record
学習記録アプリ
https://study-record-31e61.web.app/
学習記録アプリについて
学習記録アプリはReact + Viteで開発しており、DBへデータを保存することはしていません。そのため、ブラウザをリロードすると登録した学習記録はリセットされます。またホスティングもしていないので開発者である私のPCでしか閲覧出来ません。
詳細については以下記事で解説しています。
このアプリのデータを永続化させて、さらに自分以外の誰かが使えるようにホスティングを行なっていきます。
データの永続化
まずはデータの永続化を行うためにDBへ接続を行えるようにしました。DBはSupabaseを利用しています。
Supabaseの利用自体が初めてだったこともあって、1つずつ調べながら対応していきました。
先人の記事の力を借りつつドキュメントとにらめっこしながらSupabaseに接続するための環境変数を設定したり、DBのレコードにアプリ側からデータを追加&削除をしていきました。
特にエラー等で大きく躓くことは無かったんですが、調べながらの対応だったので結構時間が掛かってしまいました。
Supabaseを利用する手順やその過程で知ったことを題材に記事を3本書きました。
特に印象に残っているのがSupabaseの無料プランだと1週間あたりの利用状況が低いと自動で利用停止されてしまうみたいです。
利用停止前にメールで通知は来ますが、見逃してしまうこともあるためアプリがSupabaseに接続できなかったら表示するエラー文を追加しました。
実際のWebアプリでも何かしらの原因で情報が取得できないことがあります。その時に画面が真っ白だと何が起きているのかユーザーは困惑してしまいます。
今回のアプリの規模は小さいもののそういったところまで気を配るのアプリの品質に繋がるのだと経験を通して学びました。
アプリをデプロイ
アプリのデプロイにはFirebase Hostingを使用しました。こちらも使うのは初めてなので1つずつ調べながら対応していきます。
Firebaseの操作画面が分かりやすいのもあってホスティング自体は特にエラーで躓いたりは無かったですが、手順が多かったので各ステップで行なっていることがなぜ必要なのかを整理しながら進めました。
1つだけミスしたことがあって、Firebaseのバックエンド機能を利用しないのにFirebase SDKをインストールしてしまったことです。
Firebaseの画面で設定を行なっていく手順の中にFirebase SDKのインストールがあったので脳死でインストールしましたが完全に不要でした。面倒がらずにちゃんと調べてからやるべきでした。
Firebaseへデプロイが完了したら、MakeFileを作成してビルドとデプロイを同時に行うコマンドを設定しました。地味ではありますが、毎度行う作業は自動化した方が良いですからね。
最後には復習も兼ねてFirebaseへホスティングする手順をまとめた記事を書きました。
CI/CDの設定
ここまでで、データの永続化とデプロイを行ったのでアプリとしては自分以外の人でも利用できる状態です。
さらに発展的な取り組みとして開発の現場と同様にテスト、ビルド、デプロイを自動で行えるようにCI/CDの設定を行いました。
CI/CDの設定にはGitHub Actionsを使用します。
GitHub ActionsでCI/CDを設定する
GitHub Actionsの知識が無かったのでまずはGitHub Actionsを使って簡単な処理を自動化してみました。
masterブランチにpushされたら「Hello World」を表示するワークフローを作成しました。GitHub Actionsのドキュメントを参考にしつつ、YAMLファイルの書き方に慣れていきました。
GitHub Actionsのワークフローは「どこで何が起きた時に何を行うのか」という書き方をしていくので比較的分かりやすいですし、GitHubなので検索すると情報がたくさんあります。それでもここに一番時間が掛かりましたし、エラーで躓きました。
GitHub Actionsにはランナーと呼ばれるワークフローの実行環境があります。今回はGitHubホステッドランナーのUbuntuを使用しました。
このUbuntuでビルドとテストを行ったところ早速エラーが。ビルドを行うためにワークフローで指定したNode.jsのバージョンが原因でした。
ここでの重要なのはワークフローの実行環境とアプリの実行環境は異なるということです。アプリの実行環境と同じバージョンや情報をランナーにも指定しないと今回のように予期せぬエラーが出ます。
他にもビルドしたはずのファイルが見つからないとエラーが出たり、デプロイが成功したのに画面が真っ白になったりと一歩進んでまたエラーという状態が続きましたがそこで諦めずに取り組んで解決できたのは自信になりました。
最初は「GitHubが色々上手いことやってくれている」という程度の理解でしたが、エラーを通してGitHub Actionsに対する解像度がどんどん上がっていく手応えを感じました。
無事にCI/CDを設定出来たので最後にはCI/CDの設定方法をまとめた記事を書きました。
テストの導入
GitHub Actionsでビルドとデプロイを自動化出来ました。最後はテストを導入してCIに組み込みます。ライブラリはVitestとReact Testing Libraryを使用しました。
アプリの開発環境にViteを使っていたのでnpmからインストールして設定ファイルを少し編集したらすぐにテストの実行環境が整いました。
テストに使用するメソッドはそこまで多くはないものの、通常のコードを書くときとは少し違った視点でコードを書いていくのに慣れず、結構苦戦しました。
一番苦戦したのがSupabaseとの接続をモックに差し替えてダミーデータを返す処理を書いた時です。
テストの実行時もSupabaseに接続していたため、意図せずデータが追加されてしまい要素を取得出来ないエラーが出てしまいました。基本的にテストを行うときは外部のAPIやDBに接続しないのですが、この事を知りませんでした。
アプリ側で行なっている外部サービスと接続を行う処理をモックに差し替えてダミーデータを返すことで外部サービスとの接続をさせずにテストを実行できます。
Vitestにはvi.fn()やvi.mock()などのモック関数がデフォルトで用意されていますが、イマイチ使い方や動作原理がピンと来ず実装するのに時間が掛かってしまいました。
他にもテストが成功しているのにターミナルに警告が表示されたこともありました。
テストを行う中で頻繁に非同期処理を使用しましたが、非同期処理の理解が弱かったのでテスト対象の要素の取得に失敗してエラーになったり、ボタンクリックされた時の処理のテストに失敗したりなど思わぬところで躓くことが多かったです。
テストを通して、何かの機能を作るコードとテストを行うコードでは書く時の考え方が異なることを学べました。コードを書く目的が異なるだけでこんなにも考え方や見え方が変わるものなんですね。
実際にアプリをどうテストしたのかは以下の記事に書いています。
開発を通して学んだこと
私はWeb制作会社で働いていて、主に静的サイトの開発を行い納品&公開しています。コーディング、動作確認、FTP経由でサーバーへアップロードなどWebサイトを作って公開する作業のほとんどを手動で行なっています。
そのため、今回行ったデータの永続化とCI/CDでの自動化は初めての経験ばかりでとても新鮮でした。
小規模なアプリでもデータベースに接続してホスティングサービスへデプロイするまでに何度も躓きましたし、その後のテストとCI/CDで自動化するのにはさらに苦戦しました。
でも躓くたびに立ち止まって、分からないことを調べて解決し、それをアウトプットして記事に残していった経験は大変だったけど楽しいとも感じていました。
作ったアプリは小規模で誰かに自慢できるような機能もデザインもありませんが、個人開発って楽しいんだなと感じられたが一番良かったのではないかと思います。
これからも幾度となくエラーにぶつかり、躓いて立ち止まることがあると思います。分からなくて出来ない状態に辛さを感じることが何度も出てくると思います。ただそれも個人開発の醍醐味の一つであって立ち止まった経験も含めて個人開発になるんだと思います。
今後も楽しむことを忘れずに普段の勉強や個人開発に取り組んでいきたいです。
JISOUのメンバー募集中!
プログラミングコーチングJISOUでは、新たなメンバーを募集しています。
日本一のアウトプットコミュニティでキャリアアップしませんか?
興味のある方は、ぜひホームページをのぞいてみてくださ!
▼▼▼

