166
140

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

SPAリリヌスの倱敗から孊んだこず

166
Posted at

この蚘事はDMM.com #2 Advent Calendar 2017の14日目です。

はじめたしお、普段はDMMサヌビスのシステム開発、保守を行なっおいる@norihです。
SPAの蚘事を曞いおおりたすが業務的にはバック゚ンド偎に觊れるこずが倚い゚ンゞニアです。

今回は曞くこずは僕が2017幎の初旬にリリヌスしたSPAシングルペヌゞアプリケヌションの倱敗談ず、そこから孊んだこずに぀いおです。
基本的なこずかもしれたせんがよろしくお願いしたす :grinning:

ほかのカレンダヌURLはコチラです。
DMM.com #1 Advent Calendar 2017
DMM.com #2 Advent Calendar 2017

リリヌスしたSPAの抂芁

最初に今回リリヌスしたSPAに぀いお少しだけ玹介させおいただきたす。
詳しいこずは省略させおいただきたすが抂芁ずしおは次のようなものです。

  • React + ReduxのSPA
  • ビゞネス関係者が利甚するアプリケヌション
  • 365日24時間利甚
  • 各皮むベントやタむマヌによるREST APIぞの通信
  • 開発期間は2人䜓制で3ヶ月ほど芏暡は倧きめ

たた僕の所属する郚眲にはフロント゚ンド゚ンゞニアがいないため、SPAの蚭蚈からリリヌスたでを自分ずもう䞀人の開発メンバヌで行っおいたす。
フロント゚ンドが奜きなため2017幎にリリヌスした案件ずしおは䞀番蚘憶に残っおいるものですが、はじめおの倧芏暡SPA開発ずリリヌスだったので倱敗も倚かったです。

それでは倱敗談をさせおいただきたす
なお実際に開発したSPAのプログラムコヌドはES2015以降の文法で実装しおいたすが、本蚘事内のサンプルコヌドはES5の文法で曞いおおりたす。

倱敗談1 : クラむアントサむドの゚ラヌ調査

最初ぱラヌ調査に぀いおの倱敗です。

たず前提ずしおSPAはクラむアントサむドで凊理が行われるためバグを発芋するのが難しいです。
今回のSPAもテストをしっかり行なっおいたしたが、リリヌス埌には原因特定が難しいバグがいく぀か出おきたした :scream:

圓初はそのバグを人海戊術で数日かけお再珟させ、その人のブラりザ画面を盎接芋るこずで原因特定しおいたした。
これでもなんずか問題解決したしたが、1぀のバグを特定するために倚くのコスト払う非垞に効率の悪い方法でした。

孊んだこず : ゚ラヌ収集の仕組みは必ず甚意しおおく

この倱敗から孊んだこずはリリヌス埌もバグがある前提で、事前にクラむアントサむドの゚ラヌ情報を収集・可芖化する仕組みを甚意しおおくべきずいうこずです。
この仕組みは自前で実装するこずもできたすし、サヌビスを利甚するこずもできたす。

自前での実装

自分たちでクラむアントサむドの゚ラヌ情報を収集するには次のこずをすれば良いです。

  • errorむベントの監芖
  • ゚ラヌ情報のREST API送信
  • REST APIの実装
  • ゚ラヌ情報の保存ず可芖化

フロント゚ンド偎ではerrorむベントを監芖しおコヌルバック関数に枡される情報をREST APIにするずいうこずを実装したす。
ブラりザでは䞋蚘キャプチャのようにコン゜ヌル゚ラヌが衚瀺されるずきにはerrorむベントが発火したす。

コン゜ヌルの゚ラヌ情報

JS偎凊理の簡単なサンプルは䞋蚘のようなもので難しくありたせん。
sendErrorLog()ではXHRでREST APIに゚ラヌメッセヌゞなどの情報を送信しおいるむメヌゞです。

window.addEventListener('error', function(e) {
    var message      = e.message,
        fileName     = e.filename,
        lineNumber   = e.lineno,
        columnNumber = e.colnoa;

    // 自䜜したAPI送信甚の関数やメ゜ッドを実行
    sendErrorLog(message, fileName, lineNumber, columnNumber);
});

バック゚ンド偎のREST APIではPOSTされたデヌタをDBやストレヌゞに栌玍するようにしたす。
あずは管理サむトやメヌル送信で、゚ラヌ情報を可芖化できるようにすれば䞀通りの仕組みができたす。

今回のSPAではリリヌス埌の゚ラヌ収集めこれらの仕組みを実装しお皌働させおいたす。
たたREST APIヘの送信凊理ができたら、try-catchで拟った䟋倖にも適甚させおいくず良いです。

パフォヌマンス監芖サヌビスを利甚する

最近だずJS゚ラヌやパフォヌマンスを解析しおくれるサヌビス・ツヌルも充実しおいたす。
有料プランずなっおしたいたすが゚ラヌ収集だけではなくパフォヌマンスチュヌニングに必芁な情報も収集しおくれるため、導入を怜蚎する䟡倀は十分ありたす。

自前でバック゚ンド機胜を甚意するのが難しい堎合にもパフォヌマンス監芖サヌビスを利甚しおみるのも良さそうです。導入も最短でサヌビスが提䟛するjsラむブラリを読み蟌むだけでよかったりするので、途䞭から組み蟌む敷居が䜎いのもポむントです。

䞻なサヌビス

゚ラヌ情報収集の甚途だず基本的に有料プランを遞ぶこずになりそうですが、䟋えば開発からリリヌス埌の2ヶ月分だけ有料プランに加入しおバグ修正ずパフォヌマンスチュヌニングを行い、それ以降は無料プランにするなど柔軟にプランニングできたす。

倱敗談2 : Node.jsモゞュヌルのアップデヌトをしおいなかった

続いおの倱敗は䟝存するNode.jsモゞュヌルを開発期間䞭にアップデヌトしなかったこずです。

今回のSPAではReduxのミドルりェアの「redux-saga」を導入し、REST APIぞの通信凊理を実装しおいたした。
開発䞭は問題なく順調だったのですが、リリヌス埌しばらくしおからredux-sagaのバグで途䞭からAPIぞの通信が実行できなくなるずいう事象に遭遇したした。

調査の玆䜙曲折は省略したすが、この原因は自分たちの利甚しおいるredux-sagaのバヌゞョンがかなり叀いこずでした :cry:
開発圓初は「v0.11.0」だったredux-sagaが2017幎のSPAリリヌス時点には「v0.14.3」にバヌゞョンアップされおいたのです

しかもリリヌス内容を芋おみるず次のリビゞョンにあたる「v0.11.1」の説明にこんなこずが

Fix issues with Error handling

(^o^)

自分たちはたさにバグ修正前のバヌゞョンを利甚しおいたようで、結局redux-sagaをバヌゞョンアップするこずでバグがほが治るずいう苊い経隓をしたした。

孊んだこず : 開発期間䞭のモゞュヌルアップデヌト察応

2぀目の倱敗の察凊法ずしおは開発䞭にモゞュヌルのアップデヌトを行うようにするこずです。
圓たり前のこずかもしれたせんが、今回はバヌゞョンアップによっお䞋䜍互換性が無くなるこずを恐れお開発䞭にバヌゞョンアップをしおいたせんでした。

しかしメゞャヌなモゞュヌルでさえバグはありたす。特にただ枯れおいないものは泚意。
アップデヌトするこずによりプログラム修正や動䜜怜蚌のコストはかかっおしたいたすが、本番リリヌス埌にバグに悩たされるよりも絶察にマシです。

たたトレンドずなるフロント゚ンド技術は廃れも早いため、開発しおいる最䞭に利甚しおいるモゞュヌルの既にブヌムが過ぎお悲しい状況に远い蟌たれるこずもありたす。
ダメになった堎合の代替手段を甚意しおおいたり、マむグレヌションできるようにしおおくこずも倧切です。

倱敗談3 : タむマヌ凊理をなんずなく曞いおいた

最埌の倱敗は意倖なタむマヌ凊理に぀いお。これは問題にはなっおいたせんが備忘録ずしお曞きたす。

今回実装したSPAには䞀定間隔でREST APIを実行するタむマヌ凊理ポヌリングがありたした。
最初は䜕も気にするこずなくsetIntervalでタむマヌ凊理を実装しおいたしたが、リリヌス埌にサヌバのアクセスログを芋おいるず実際に蚭定しおいた間隔ずずれが生じおいたした :dizzy_face:

SPAの仕様的には問題になからなかったのですが、モダモダした気持ちを抱えたたただったので今回の蚘事を曞くにあたっおsetIntervalの間隔ずれを確認しおみたした。

確認甚に利甚したプログラムは次のように30秒毎に珟圚時刻を取埗しお出力するもの。
コヌルバック関数の実行時間による遅延はありたすが、これは蚱容するこずにしたす。

testInterval.js
var interval = 30 * 1000;

// setInterval
window.setInterval(function() {
     console.log(new Date);
 }, interval);

怜蚌結果は次の通り。
Firefox 56.0.2で実行しおいたす。

回数 時刻
01 11:19:22.537
02 11:19:52.549
03 11:20:22.562
04 11:20:52.570
05 11:21:22.580
06 11:21:52.588
07 11:22:23.502
08 11:22:53.513
09 11:23:23.523
10 11:23:53.534

7回目の実行で1秒ほどずれるこずを確認。
非垞に単玔なプログラムですが、思ったより早い時点でずれが生じおいた結果でした。

調べおみるずブラりザはsetInterval/setTimeoutに蚭定した䞀定間隔の粟床は保蚌しないようで、皌働時間に䌎いずれも倧きくなっおいくようです。
たたタむマヌ凊理が動いおいるタブが非アクティブの堎合は、ずれがさらに倧きくなっおいくようです。

stack overflowのスレッドではこのように蚘茉されおいたした :slight_frown:

setIntervalでは誀差の扱いは定められおいたせん。ブラりザの状態によっおは、自動的に頻床を䜎䞋させられる可胜性もありたす。このため、setTimeoutやsetIntervalではたったく芁求を達成できたせん。

匕甚 : javascript - 0から始たり5たでいったらたた0からスタヌトする - スタック・オヌバヌフロヌ

孊んだこず : タむマヌ凊理は慎重に考える

これが問題ずなるのは粟床の高いタむマヌ凊理を求められるアプリケヌションずなりたすが、実装前から䜜成するSPAの芁件に該圓するかは気を぀けたいずころです。
たたブラりザによっおも間隔の粟床が異なるため、クラむアントサむドで粟床の高いタむマヌ凊理を実装するこず自䜓を立ち止たっお考えるべきなのかもしれたせん :thinking:

応急凊眮の察凊法

ひずたずsetIntervalよりも粟床の高いタむマヌを䜜りたい、ずいう堎合には応急凊眮的な察凊法はありたす。
完党にずれをなくすこずはできないのですが、䞋蚘のサンプルコヌドのようにsetTimeoutの再垰凊理で毎回ずれ調敎すれば改善は芋蟌めたす。

var interval = 30 * 1000, 
    initMiliSecond = new Date().getMilliseconds(),
    begin, end, diff, adjustInterval, timer;

timer = function() {
    // コヌルバック関数の凊理開始時刻を取埗
    begin = new Date();

    // 凊理内容 API実行など
    console.log(new Date);

    // 凊理が終了した埌でendを取埗しお差分を算出
    end = new Date();
    diff = end - begin;

    adjustInterval = interval - begin.getMilliseconds() + initMiliSecond - diff;

    // 再垰実行
    setTimeout(timer, adjustInterval);
}

// 関数の呌び出し
setTimeout(timer, interval);

圓初のsetIntervalず比范するず開始時刻から1秒ずれるこずは回避できるかず思いたす。
なおサンプルコヌドのため実際にサヌビス運甚に耐えうるコヌドずしおはもう少し䜜り蟌んだ方がよさそうです。

おわりに

2017幎初旬頃の出来事でしたがはじめおSPAをリリヌスした振り返り蚘事でした。
曞いおみるず割ず圓たり前のこずができおいなかったんだなず反省です。
これからSPAをリリヌスする方にずっお少しでも圹に立぀情報を共有できたなら幞いです。

明日は@h_shinonomeさんです。よろしくお願いしたす

参考文献

゚ラヌ情報収集

setIntervalのずれ

166
140
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
166
140

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?