LINE Bot - GASプロジェクトをGitHubで管理

前書き

この記事は連作で、ラン記録をシェアし、メンバーの走行記録を集計する活動を、LINE Botで自動化しようとしている取り組みです。

Cloud Vision APIでテキスト検出できることから、目で読んで手で打つという手間を省けないかと取り組み始めました。

現在は作ったBotを加えたLINEグループにて、メンバーが上げてくれるラン画像で見つかる考慮漏れなどを修正するなど、日々小さく改善を繰り返しております。

前回の記事は8月でしたのでしばらく間が開きました。安定して運用できており、クリティカルな課題は以下の２点です。

１） １〜2週間で、GASのデプロイが権限の再承認を要求される状態になってWebhookがエラーになる。
２）　LINEのUserIDに対して名前を設定する仕組みがなく、メンバーが増えた際に管理人が手で設定している。

そろそろ修正が戻せなくなったりするのも怖くなってきました。いよいよGitHubにリポジトリを作成し、Google Apps Script GitHub アシスタントを導入して変更をPush、更新差分が確認できるようにしました。

本記事では、上記の２）について取り組んだ小さな変更を事例に、Google Apps Script GitHub アシスタントを使った変更管理をまとめたいと思います。

今回のプチ更新 - 新規ユーザの名前を設定

前回の記事までで、記録と修正取り消し、集計ができるようになりました。おともだちになっていないユーザの名前が取れないことや、そもそも記録表には氏名で表記したいことから、LINEのUserIDと記録用の氏名をUser ListとしてSpreadsheetで管理しています。

そして、このリストにないユーザが画像をアップし「ナイスラン！」を返す時には、User ListにLINE UserIDを追記（→こちらの記事参照）するようにしています。ただ、追加時は「unknown」さんになっていて、管理者さんがSpreadsheetに追記された行の氏名を手でunknownから修正していました。

ナイスラン！に名前も追加

たまに、「xxはyyyが走りました」と書かれる方がいるのと、グループに参加したばかりで名前が設定できていない方がおり、設定のきっかけにできそうなので、名前を入れるようにすることにしました。

入れた後のフキダシのレイアウトはこんな感じ

またここでタイムと距離が検出されていても、名前がunknownだった場合にはクイックリプライを出すようにしました。
名前だけ未設定の場合は別のクイックリプライが良さそうですが別issueにすることとします。

「修正」を選択したときの流れは以前のままで、テキスト入力欄に挿入された記録の氏名を書き換えて送信すると、記録が修正されます。

このとき、User Listに追加された unknownを入力された氏名で置き換えるように修正しました。

仕事では、１つの修正に１つのissueというルールで行っていますが、二つやっちゃいました。。
差分はこんな感じです。

このように、どう修正したか記録が残せるのは安心ですし協力者が増えた時にも必須の管理ですね。というわけで、これを実現しているGitHubとの連携について。

Google Apps Script GitHub アシスタントの導入

以下の記事を参考にしました。ほぼその通りに進めていき、導入できました。

Chromeのアドインで、インストールして Apps Script Editorを開くとツールバー部分にリポジトリ操作のコントロールが追加されています。GitHubアカウントを設定すると、リポジトリに接続できます。

リポジトリから更新を反映

SpreadsheetのApps Scriptを開き、リポジトリとブランチを指定します。

「↓」ボタンで指定のブランチをpullします。

pullにより反映される差分が表示され、Pullを選択すると更新されます。

これにより、以下の３種類の環境を更新します。

• 開発テスト環境
• 運用環境
• プロジェクト公開用テンプレート

まず開発テスト環境で修正、デプロイしてテストを行います。Webhookを更新してテストするLINE公式アカウントは、運用しているものとは別のものを用意します。

修正がFixしたら、ブランチを作成してプッシュ「↑」します。

ブランチの作成は、ブランチのプルダウンにある「Create new branch」から行えます。GitHub上で作っておくこともでき、リストから選択することができます。

GitHub上で、開発ブランチからmainブランチへのプルリクエストを作成し、マージします。このプルリクエストが、更新の差分を見ることのできる記録となります。
この操作は　Apps Script Editorに組み込まれた GitHub アシスタントではできない操作になります。

運用環境の更新

開発テスト環境で確認した修正をmainブランチにマージしたら、今度は運用環境用の Spreadsheetを開いて Apps Script Editorからmainブランチをpullし、デプロイを行います。
デプロイが成功したら、新しく発行されたWebhookアドレスで、line Developper Consoleから LINE Messeaging APIの設定を更新します。

プロジェクト公開用テンプレートの更新

プロジェクト公開用テンプレートとは、SpreadsheetのコピーからLINEBotをセットアップできるように用意した空のSpreadsheetです。Apps Scriptがそこそこ最新になるよう、ときどきリポジトリのmainブランチから更新を反映します。

※もうまもなく、公開予定！

PropertiesServiceでセキュリティキーの設定を外出し

GitHubリポジトリとSpreadsheetのテンプレートで公開するために、これまでコードに直書きしていたセキュリティキーを外出しにしました。

コードの修正

プロジェクト内のコードでグローバル変数をスクリプトプロパティから設定します。

code.gs

var CHANNEL_ACCESS_TOKEN = PropertiesService.getScriptProperties().getProperty("CHANNEL_ACCESS_TOKEN");
var GOOGLE_API_KEY = PropertiesService.getScriptProperties().getProperty("GOOGLE_API_KEY");

スクリプトプロパティの設定

プロジェクトの設定を下にスクロールすると、GCPプロジェクトの設定とスクリプトプロパティの項目があります。「スクリプトプロパティを編集」を選択すると、追加・削除・保存ができます。
こちらに、LINEのチャンネルアクセストークンと、Cloud Vision APIを使うためのGoogle API Keyを定義、設定します。

TODO

今朝もWebhookが403エラーになっていました。今回は3日で発生。この問題をなんとかせねば。