OpenAuth 사용 시 System.Data.SqlClient.SqlException 예외가 Output 창에 출력되는 문제
가령 OpenAuth를 사용하는 웹 프로젝트를 F5 디버깅으로 Visual Studio에서 실행시키면 OpenAuth.Login 메서드를 호출하는 시점에,
bool loggedIn = OpenAuth.Login(authResult.Provider, authResult.ProviderUserId, createPersistentCookie: true);
출력창을 보면 다음과 같은 예외가 우수수 떨어지는 것을 볼 수 있습니다.
The thread 0x5cb8 has exited with code 259 (0x103).
The thread 0x5f80 has exited with code 259 (0x103).
A first chance exception of type 'System.Data.SqlClient.SqlException' occurred in System.Data.dll
A first chance exception of type 'System.Data.SqlClient.SqlException' occurred in System.Data.dll
A first chance exception of type 'System.Data.SqlClient.SqlException' occurred in System.Data.dll
A first chance exception of type 'System.Data.SqlClient.SqlException' occurred in EntityFramework.dll
A first chance exception of type 'System.Data.SqlClient.SqlException' occurred in EntityFramework.SqlServer.dll
A first chance exception of type 'System.Data.SqlClient.SqlException' occurred in System.Data.dll
A first chance exception of type 'System.Data.SqlClient.SqlException' occurred in System.Data.dll
A first chance exception of type 'System.Data.SqlClient.SqlException' occurred in System.Data.dll
A first chance exception of type 'System.Data.SqlClient.SqlException' occurred in EntityFramework.dll
A first chance exception of type 'System.Data.SqlClient.SqlException' occurred in EntityFramework.SqlServer.dll
System.Data.SqlClient.SqlException의 원인은 IntelliTrace 옵션을 켜고 다시 실행해 보면 IntelliTrace 뷰에 다음과 같은 예외로 좀 더 추측해 볼 수 있습니다.
Exception:Thrown: "There is already an object named 'UsersOpenAuthAccounts' in the database." (System.Data.SqlClient.SqlException)
A System.Data.SqlClient.SqlException was thrown: "There is already an object named 'UsersOpenAuthAccounts' in the database."
UsersOpenAuthAccounts는 OpenAuth에서 생성한 Database에 있는 테이블 이름입니다. 그런데 그 테이블을 다시 생성하려고 했다는 듯 싶은데요. 이제 소스코드 레벨로 내려가서 원인을 추적해봐야 할 차례가 된 것 같습니다. 이럴 때
.NET Reflector의 "Generate PDBs" 기능을 이용해 소스코드 디버깅의 도움을 받을 수 있습니다.
그리하여 추적해 보면 Microsoft.AspNet.Membership.OpenAuth.EFOpenAuthMembershipDatabase 타입의 GetContext 메서드에서 발생하는 것을 볼 수 있습니다.
// Microsoft.AspNet.Membership.OpenAuth.dll
private OpenAuthDbContext GetContext()
{
if (!_dbInitialized) // _dbInitialized == false
{
DatabaseInitialize();
}
OpenAuthDbContext db = new OpenAuthDbContext(this._connectionString);
if (!_dbCreated)
{
_dbCreated = true; // _dbInitialized == false
EnsureDatabaseCreated(db); // 이 시점에 출력 창에 예외 발생
}
return db;
}
즉, EFOpenAuthMembershipDatabase 타입은 응용 프로그램에서 최초 호출하는 시점에 EntityFramework의 DbContext를 상속받은 OpenAuthDbContext를 무조건 초기화하도록 만들어져 있기 때문입니다.
다행인 것은, EFOpenAuthMembershipDatabase는 최초 생성 시점에만 그런 동작을 할 뿐 이후로는 _dbInitialized == true, _dbInitialized == true로 설정된 타입을 갖는 동적 어셈블리(EntityFrameworkDynamicProxies-Microsoft.AspNet.Membership.OpenAuth)를 생성해 호출하므로 이로 인한 응용 프로그램의 부하는 없습니다.
이 외에도 System.Web.Providers.MembershipContext 타입에서도 초기화를 하기 때문에,
// System.Web.Providers.dll
internal static MembershipContext CreateMembershipContext(ConnectionStringSettings setting)
{
if (!DbInitialized)
{
DatabaseInitialize();
}
MembershipContext db = new MembershipContext(setting.Name);
if (!MembershipInitialized)
{
EnsureDatabaseCreated(db);
ExecuteSql(db, "CREATE NONCLUSTERED INDEX IDX_UserName ON Users (UserName)"); // 이 시점에 출력 창에 예외 발생
MembershipInitialized = true;
}
return db;
}
System.Data.SqlClient.SqlException 예외가 아래와 같은 항목으로 더 어지럽게 출력 창에 흩뿌려지게 됩니다.
Exception:Thrown: "There is already an object named 'Applications' in the database." (System.Data.SqlClient.SqlException)
A System.Data.SqlClient.SqlException was thrown: "There is already an object named 'Applications' in the database."
Exception:Thrown: "The operation failed because an index or statistics with name 'IDX_UserName' already exists on table 'Users'." (System.Data.SqlClient.SqlException)
A System.Data.SqlClient.SqlException was thrown: "The operation failed because an index or statistics with name 'IDX_UserName' already exists on table 'Users'."
결론적으로 보면, 이런 오류가 발생했다고 해서 별다르게 취할 조치는 없습니다. 의도된 것이므로 취할 필요도 없습니다.
개인적으로 "
깨진 유리창" 이론이 프로그래밍의 버그 발생에도 적용된다고 생각합니다. 즉, 이번 글에서처럼 저런 식으로 어쩔 수 없이 예외가 발생해 출력 창을 어지럽히면 점점 더 해당 프로젝트는 '
first-chance 예외'의 발생에 관대해지게 되고 결국에는 아무도 신경쓰지 않는 상황으로 바뀝니다.
문제는, 개발자들이 습관적으로 하는 try/catch로 인해 나중에 정말로 중요한 예외가 먹혔을때(좀 더 전문 용어로 씹혔을때!) 그 사실을 인지하지 못해 외관상 잘 동작하는 프로그램이 내부적으로는 잘 파악도 되지 않는 버그로 발전하게 되는 경우가 다분하다는 것입니다. 그럴 때 그 문제를 수정하기 위해 얼마나 많은 시간을 소비해야 하는지... 그리고 그로 인한 시간 소비가 버그를 해결했다는 정신적인 쾌감보다는 '이런 쓸데없는 것에...'라는 짜증이 더 많은 비중으로 차지한다는 것은 경험자만 알 수 있을 것입니다.
따라서, 저는 저렇게 출력 창에 내보내지는 예외를 가능한 없애려고 하는 주의를 고수합니다.
자... 그럼 어떻게 해야 할까요? 간단합니다. 해당 멤버들이 private static 필드이니 Global.Application_Start 같은 함수에서 Reflection을 이용해 true로 명시해 주면 됩니다. 단지, 릴리스 상황에서의 관리를 편하게 할 수 있도록 DEBUG 전처리기를 추가해 주면 좋을 것입니다. 이렇게!
#if DEBUG
Type efdb = typeof(Microsoft.AspNet.Membership.OpenAuth.EFOpenAuthMembershipDatabase);
FieldInfo fieldInfo = efdb.GetField("_dbCreated", System.Reflection.BindingFlags.Static | System.Reflection.BindingFlags.NonPublic);
if (fieldInfo != null)
{
fieldInfo.SetValue(null, true);
}
Type mhdb = Assembly.GetAssembly(typeof(System.Web.Providers.DefaultMembershipProvider)).GetType("System.Web.Providers.ModelHelper");
fieldInfo = mhdb.GetField("MembershipInitialized", System.Reflection.BindingFlags.Static | System.Reflection.BindingFlags.NonPublic);
if (fieldInfo != null)
{
fieldInfo.SetValue(null, true);
}
#endif
역시... 디버그 출력창은 조용해야 합니다. 한마디로, 개발자의 관리하에 놓여야 합니다.
반면, 아래와 같은 오류가 발생할 수 있습니다.
Server Error in '/' Application.
Cannot attach the file '...\App_Data\TestDB.mdf' as database 'TestDB'.
Description: An unhandled exception occurred during the execution of the current web request. Please review the stack trace for more information about the error and where it originated in the code.
Exception Details: System.Data.SqlClient.SqlException: Cannot attach the file '...\App_Data\TestDB.mdf' as database 'TestDB'.
원인은 간단합니다. TestDB를 지운 다음 DEBUG로 인해 DB 생성이 안되는 문제입니다. 따라서 이런 오류가 발생하면 다시 위의 리플렉션 코드를 주석처리해야 합니다. ^^
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]