AppHarbor + SQL Server + EF CodeFirst 開発 - EF4.1はOK、EF4.3はNG ではまる

背景

まずはじめに: AppHarbor とは?

今回のお題にある "AppHarbor" ( 発音は アップハーバーですね ) とは、サービスないしはそのサービス提供のサイト名。

Ruby on Rails 開発されている方なら、「ASP.NET 版 Heroku」といったほうが通じるだろう。

すなわち、ASP.NET のクラウドプラットフォームサービスである。

AppHarbor - .NET Cloud Platform as a Service
https://appharbor.com/

Heroku 同様、ASP.NET アプリのデプロイを、分散型バージョン管理システムの Git ( 発音はギットですね? ) を使って行う。

AppHarbor にサインアップし、アプリを作ると、そのアプリの Git のリポジトリが、AppHarbor 上に用意される。

この AppHarbor 上のリポジトリへ、ローカルの開発環境に作成した自分の Git リポジトリから Push することで、デプロイとなるのだ。

ビルドしたバイナリ類をアップロードする、いわゆる "発行" とは異なり、Git Push したプロジェクトソースコード一式から AppHarbor 上でビルドされ、ビルド成功すれば配置されるという仕掛けだ。

単体テストプロジェクト ( MSTest? ) がソリューションに含まれている場合は、その単体テストがすべてパスした場合にのみ、配置されるらしい（自分は試していない）。

自分が試した範囲では、今日現在、.NET Framework 4、ASP.NET MVC3 のアプリのデプロイ & 稼働を確認できている。

F# のプロジェクトもビルド & 配置成功した。

しかも、1worker のみであれば利用料が ￥0 だというのだ。
フリーミアム万歳である。

俗に言うレンタルサーバとは異なり、あくまでも PaaS。
有償になるが簡単にスケールアウト可能な感じだ。

よって、ファイルストレージの永続性は当てにならない。
Git Push してビルドが走るたびに ~/App_Data を含めたファイルシステムがリセットされるようだし、それ以外の理由でも、仮想マシンがリセットされることだろう。
そもそも有償プラン契約してスケールさせる場合は、ファイルシステムが各インスタンス間で共有されるのかどうかすら今の自分には未知である。

よってファイルベースのデータベース、SQL Server CE や SQLite は使えない。

しかし、Add-on として、なんと、SQL Server によるデータベーススペースが、20MB までの上限付きであるものの、￥0 で使える。

具体的な使い方は割愛。
もし希望があればコメントまで。

Entity Framework - Code First 開発

そして今回のエピソードのもうひとつの要素、Entity Framework による Code First 開発について。

Enity Framework は Microsoft が提供するデータアクセスライブラリである(以下、"EF" と略記)。

EF の ver.4.1 からは、「C# などで作成した "素のクラス" (Plain Old CLR Object, POCO) をモデルとして、モデルからデータベースを生成する」という、"Code First" スタイルの開発が可能になった。

Ruby on Rails では古くから(?)、このスタイルによる開発がサポートされていたと記憶している（rake migrate とかやりますよね?）。

詳しくは下記記事がわかりやすくてよいかもしれない。

@IT 連載：～ScottGu氏のブログより～ Entity Framework 4でコード・ファースト開発
Scott Guthrie 著 / Chica 訳 2010/07/20
http://www.atmarkit.co.jp/fdotnet/scottgublog/20100726codefirst/codefirst.html

Code First スタイルの開発では、データベースが存在しない初回起動のときに自動でデータベースが新規作成される。

さらにモデルクラスにプロパティ追加などの変更が発生すると、次にアプリが動くときにデータベースを作り直すようになっている。

"データベースを、いつ、どう作り直すのか" を指定する、"イニシャライザ" クラスが EF 標準でいくつか用意されている。

CreateDatabaseIfNotExists

データベースがない場合に新規作成する

DropCreateDatabaseAlways

アプリ起動時に毎回データベースを削除して新規作成し直す

DropCreateDatabaseIfModelChanges

もしスキーマ変更が発生していたらデータベースを削除して新規作成し直す

Global.asax の App_Start のタイミングなどで、お好みのイニシャライザを EF ランタイムに登録しておくわけだ。

なお、同じ EF でも、今日時点の最新リリース版 ver.4.3 からは、スキーマ変更に対するやり方が変わっているらしい。

まめしば雑記
Entity Framework 4.3 Beta 1 のコードベースマイグレーションを試してみた
http://d.hatena.ne.jp/shiba-yan/20120118/1326815828

AppHarbor では、EF 標準のイニシャライザは使えない

さてさて、AppHarbor とその Add-on の SQL Server を利用した、ASP.NET アプリをデプロイする場合、注意すべき点がある。

まず、データベースを削除(Drop)することはできない。

なんとなれば、それはレンタルされたデータベースであり、自分のものではなく、AppHarbor 彼らのものだからだ。

AppHarbor の管理画面上で SQL Server の Add-on をアプリに追加すると、所定のデータベースとその接続文字列が提供されるわけである。

また同様の理由から、データベースを新規作成することもできない。
繰り返しになるが、データベースが貸し出されるのであって、SQL Server そのものが貸し出されるわけではないからだ。

となると、EF 標準で付属しているイニシャライザは、軒並み利用できない。
いずれも、データベースを削除したり、新規作成したりする動作がともなうイニシャライザだからだ。

しかしこれでは、EF + Code First スタイルによる ASP.NET アプリを配置することが難しくなる。

EFCodeFirst.CreateTablesOnly を使え!

しかし朗報。

データベースは削除せずにテーブルだけ削除して作り直すイニシャライザが NuGet パッケージとして公開されている。

EF Code First (CTP5) IDatabaseIntializer that only recreates tables 1.0.2
EFCodeFirst.CreateTablesOnly
http://nuget.org/packages/EFCodeFirst.CreateTablesOnly

このイニシャライザを使わせてもらえば、データベースは削除せず、データベース内のテーブルを削除して作り直してくれるようになるのだ。

具体的な使い方としては、NuGet から上記パッケージをプロジェクトにインストールし、Global.asax の Application_Start 内でイニシャライザを以下の要領で設定しておけばよい。

using Devtalk.EF.CodeFirst;

...

protected void Application_Start()

{

  Database.SetInitializer(

    new DontDropDbJustCreateTablesIfModelChanged());

本題

ということで、AppHarbor 上でも、EF の ver.4.1 を使って、Code First な開発をエンジョイしていたある日。

ついうっかりというか、何というか、あまり気にも留めずに、AppHarbor に Push しているとある ASP.NET アプリにインストールされている EF のバージョンを、4.1 から 4.3 にアップグレードした。

すると、とたんに例外発生するようになってしまった。

例外の内容は以下のとおり。

InvalidOperationException:

The entity type EdmMetadata is not part of the model 

    for the current context.

なにが起きたのか?

ネット上で調べたところ、StackOverflow にスレッドができていた。

どうやた EF 4.3 からはスキーマ変更の追跡のやり方が変わり、EdmMeatadata テーブルが作られないから、ということらしい。

EF4.1 にダウングレードして終了

ということで、すったもんだあったが、EF を 4.1 にダウングレードして終息させた。

ダウングレードさせるには、いったん EF 4.3 を削除して、改めて EF 4.1 をインストール、という手順になる。

たぶん、GUI の NuGet Package Manager からはこの操作を行うのは難しいと思うので、Visual Studio 内の NuGet Package Manager Console を開き、コマンドで処置するのがよいと思う。

PM> Uninstall-Package EntityFramework -f

PM> Install-Package EntityFramework -version 4.1

なお、このとき、web.config 中にアセンブリバージョンのリダイレクタが記述されていた。

<configuration>

 ...

 <runtime>

  <assemblyBinding...>

  ...

   <dependentAssembly>

    <assemblyIdentity 

name="EntityFramework" 

publicKeyToken="b77a5c561934e089" />

     <bindingRedirect 

 oldVersion="1.0.0.0-4.1.0.0"

 newVersion="4.3.1.0" />

   </dependentAssembly>

  </assemblyBinding>

 </runtime>

この記述が残っていると、EF を 4.3 から 4.1 にダウングレードさせても、アプリは ver.4.3 のアセンブリを読み込もうとしてこけてしまう。

上記記述は削除しておくべし。