在JasmineJS测试中未触发AngularJS Promise回调

Question

问题介绍

我正在尝试对包装Facebook JavaScript SDK FB对象的AngularJS服务进行单元测试; 但是,测试不起作用,我无法弄清楚原因.此外,当我在浏览器中运行它而不是使用Karma测试运行器运行的JasmineJS单元测试时,服务代码可以正常工作.

我正在通过$q 对象使用Angular promises测试异步方法.我将测试设置为使用Jasmine 1.3.1异步测试方法异步运行,但该waitsFor() 函数永远不会返回true(请参阅下面的测试代码),它只是在5秒后超时.(Karma尚未附带Jasmine 2.0异步测试API).

我认为这可能是因为then()promise 的方法永远不会被触发(我有一个console.log()设置来显示),即使我$scope.$apply()在异步方法返回时调用,让Angular知道它应该运行一个摘要周期并触发then()回调...但我可能是错的.

这是运行测试时出现的错误输出:

Chrome 32.0.1700 (Mac OS X 10.9.1) service Facebook should return false
  if user is not logged into Facebook FAILED
  timeout: timed out after 5000 msec waiting for something to happen
Chrome 32.0.1700 (Mac OS X 10.9.1):
  Executed 6 of 6 (1 FAILED) (5.722 secs / 5.574 secs)

代码

这是我对服务的单元测试(请参阅内联注释,解释到目前为止我发现的内容):

'use strict';

describe('service', function () {
  beforeEach(module('app.services'));

  describe('Facebook', function () {
    it('should return false if user is not logged into Facebook', function () {
      // Provide a fake version of the Facebook JavaScript SDK `FB` object:
      module(function ($provide) {
        $provide.value('fbsdk', {
          getLoginStatus: function (callback) { return callback({}); },
          init: function () {}
        });
      });

      var done = false;
      var userLoggedIn = false;

      runs(function () {
        inject(function (Facebook, $rootScope) {
          Facebook.getUserLoginStatus($rootScope)
            // This `then()` callback never runs, even after I call
            // `$scope.$apply()` in the service :(
            .then(function (data) {
              console.log("Found data!");
              userLoggedIn = data;
            })
            .finally(function () {
              console.log("Setting `done`...");
              done = true;
            });
        });
      });

      // This just times-out after 5 seconds because `done` is never
      // updated to `true` in the `then()` method above :(
      waitsFor(function () {
        return done;
      });

      runs(function () {
        expect(userLoggedIn).toEqual(false);
      });

    }); // it()
  }); // Facebook spec
}); // Service module spec

这是我正在测试的Angular服务(请参阅内联注释,解释我到目前为止所发现的内容):

'use strict';

angular.module('app.services', [])
  .value('fbsdk', window.FB)
  .factory('Facebook', ['fbsdk', '$q', function (FB, $q) {

    FB.init({
      appId: 'xxxxxxxxxxxxxxx',
      cookie: false,
      status: false,
      xfbml: false
    });

    function getUserLoginStatus ($scope) {
      var deferred = $q.defer();
      // This is where the deferred promise is resolved. Notice that I call
      // `$scope.$apply()` at the end to let Angular know to trigger the
      // `then()` callback in the caller of `getUserLoginStatus()`.
      FB.getLoginStatus(function (response) {
        if (response.authResponse) {
          deferred.resolve(true);
        } else {
          deferred.resolve(false)
        }
        $scope.$apply(); // <-- Tell Angular to trigger `then()`.
      });

      return deferred.promise;
    }

    return {
      getUserLoginStatus: getUserLoginStatus
    };
  }]);

资源

以下列出了我已经尝试解决此问题的其他资源.

• Angular API参考: $q

  这解释了如何在Angular中使用promises,以及如何对使用promises的代码进行单元测试的示例(请注意为什么$scope.$apply()需要调用以触发then()回调的解释).

• Jasmine异步测试示例

  • Jasmine.Async:使用Jasmine Suck进行异步测试

  • 使用Jasmine 2.0.0测试异步Javascript

    这些示例说明了如何使用Jasmine 1.3.1异步方法来测试实现Promise模式的对象.它们与我在我自己的测试中使用的模式略有不同,后者是在直接来自Jasmine 1.3.1异步测试文档的示例之后建模的.

• StackOverflow答案

  • 在Angular JS中没有调用Promise回调
    • 答案1
    • 答案2
  • angularjs - 承诺永远不会在控制器中解决
  • AngularJS承诺从服务返回时不会触发

摘要

请注意,我知道Facebook JavaScript SDK已经有其他Angular库,例如:

• 角easyfb
• 角的Facebook

我现在对使用它们不感兴趣,因为我想学习如何自己编写Angular服务.所以请保持答案仅限于帮助我解决代码中的问题,而不是建议我使用别人的问题.

那么,话虽如此,有谁知道为什么我的测试不起作用？

Answer 1

TL; DR

$rootScope.$digest()从您的测试代码调用,它将通过:

it('should return false if user is not logged into Facebook', function () {
  ...

  var userLoggedIn;

  inject(function (Facebook, $rootScope) {
    Facebook.getUserLoginStatus($rootScope).then(function (data) {
      console.log("Found data!");
      userLoggedIn = data;
    });

    $rootScope.$digest(); // <-- This will resolve the promise created above
    expect(userLoggedIn).toEqual(false);
  });
});

这里的人物.

注意:我删除run()并wait()调用,因为这里不需要它们(没有执行实际的异步调用).

很长的解释

这就是正在发生的事情:当你打电话时getUserLoginStatus(),它会在内部运行FB.getLoginStatus(),然后立即执行其回调,因为你已经嘲笑它正是这样做的.但是你的$scope.$apply()调用是在回调中,所以它在测试中的语句之前执行.then().并且由于then()创建了新的承诺,因此需要新的摘要才能解决该承诺.

我相信这个问题不会在浏览器中发生,因为有两个原因:

1. FB.getLoginStatus()不会立即调用其回调,因此任何then()调用都会先运行; 要么
2. 应用程序中的其他内容会触发新的摘要周期.

因此,要将其包装起来,如果您在测试中明确或不明确地创建了承诺,则必须在某个时刻触发摘要周期,以便该承诺得到解决.

Answer 2

    'use strict';

describe('service: Facebook', function () {
    var rootScope, fb;
    beforeEach(module('app.services'));
    // Inject $rootScope here...
    beforeEach(inject(function($rootScope, Facebook){
        rootScope = $rootScope;
        fb = Facebook;
    }));

    // And run your apply here
    afterEach(function(){
        rootScope.$apply();
    });

    it('should return false if user is not logged into Facebook', function () {
        // Provide a fake version of the Facebook JavaScript SDK `FB` object:
        module(function ($provide) {
            $provide.value('fbsdk', {
                getLoginStatus: function (callback) { return callback({}); },
                init: function () {}
            });
        });
        fb.getUserLoginStatus($rootScope).then(function (data) {
            console.log("Found data!");
            expect(data).toBeFalsy(); // user is not logged in
        });
    });
}); // Service module spec

这应该做你想要的.通过使用beforeEach设置rootScope和afterEach来运行apply,您还可以轻松扩展测试,以便在用户登录时添加测试.