Merge pull request #80 from nodezoo/malex

change response for seneca actions

Author: mirceaalexandru

lib/github.js

@@ -34,19 +34,27 @@ function cmdGet (msg, done) {
 
   context.log.debug(`Processing module:  ${moduleName}`)
   cache.load$(moduleName, (err, github) => {
-    if (err) return done(err)
+    if (err) {
+      context.log.debug(`Cannot load from cache module ${moduleName}, try now to get it remotely`)
+    }
 
     if (github && !msg.update) {
-      return done(null, github.data$(github))
+      return done(null, {ok: true, data: github.data$(github)})
     }
 
     Request.get({url: registry, gzip: true}, (err, res, body) => {
-      if (err) return done(err)
+      if (err) {
+        return done(err)
+      }
 
       var data = null
 
-      try { data = JSON.parse(body) }
-      catch (e) { return done(e) }
+      try {
+        data = JSON.parse(body)
+      }
+      catch (e) {
+        return done(e)
+      }
 
       var distTags = data['dist-tags'] || {}
       var latest = ((data.versions || {})[distTags.latest]) || {}
@@ -66,17 +74,17 @@ function cmdGet (msg, done) {
           }
 
           if (!params.user || !params.repo) {
-            return done(new Error(`module ${moduleName} not found on github`))
+            return done(null, {ok: false, err: new Error(`module ${moduleName} not found on github`)})
           }
 
           queryGithub(params, done)
         }
         else {
-          return done(new Error(`invalid github url: ${url}, for module: ${moduleName}`))
+          return done(null, {ok: false, err: new Error(`invalid github url: ${url}, for module: ${moduleName}`)})
         }
       }
       else {
-        return done(new Error(`module ${moduleName} not found on github`))
+        return done(null, {ok: false, err: new Error(`module ${moduleName} not found on github`)})
       }
     })
   })
@@ -104,7 +112,8 @@ function cmdGet (msg, done) {
         github.repos.getReadme({user: params.user, repo: params.repo}, (err, readme) => {
           if (err) {
             context.log.debug(`Read readme for ${moduleName} get error: ${err}`)
-            return cb(err)
+            // don't report error, as we want to search for other information, even if Readme is not loaded
+            return cb(null, false)
           }
 
           if (!readme || !readme.content) {
@@ -117,7 +126,8 @@ function cmdGet (msg, done) {
           }, (err, response) => {
             if (err && !response) {
               context.log.debug(`Render readme for ${moduleName} error: ${err}`)
-              return cb(err)
+              // don't report error, as we want to search for other information, even if Readme is not loaded
+              return cb(null, false)
             } // API fails expecting a JSON object
 
             cb(null, response.data)
@@ -126,27 +136,28 @@ function cmdGet (msg, done) {
       },
 
       getPullRequests: function (cb) {
-        github.pullRequests.getAll({user: params.user, repo: params.repo, state: 'open'}, function(err, data){
+        github.pullRequests.getAll({user: params.user, repo: params.repo, state: 'open'}, function (err, data) {
           if (err) {
             context.log.debug(`Read Github pull requests for ${moduleName} get error: ${err}`)
           }
 
-          cb(err, data)
+          // don't report error, as we might have useful data
+          return cb()
         })
       }
     }, (err, results) => {
       if (err) {
         context.log.debug(`Read pull requests for ${moduleName} got error: ${err}`)
-        return complete(err)
+        return done(null, {ok: false, err: err})
       }
       var data = {
         name: params.repo || '',
         user: params.user || '',
         repo: params.repo || '',
-        stars: results.getRepository.stargazers_count || 0,
-        watches: results.getRepository.subscribers_count || 0,
-        forks: results.getRepository.forks_count || 0,
-        last: results.getRepository.pushed_at || '',
+        stars: results.getRepository ? results.getRepository.stargazers_count || 0 : 0,
+        watches: results.getRepository ? results.getRepository.subscribers_count || 0 : 0,
+        forks: results.getRepository ? results.getRepository.forks_count || 0 : 0,
+        last: results.getRepository ? results.getRepository.pushed_at || '' : '',
         urlRepo: 'https://github.com/' + params.user + '/' + params.repo,
         urlClone: 'git+https://github.com/' + params.user + '/' + params.repo + '.git',
         urlSsh: 'git@github.com:' + params.user + '/' + params.repo + '.git',
@@ -174,7 +185,7 @@ function cmdGet (msg, done) {
           context.log.debug(`Save Github data for ${moduleName} got error: ${err}`)
           return done(err)
         }
-        else done(null, data ? data.data$(data) : data)
+        else done(null, {ok: true, data: data ? data.data$(data) : data})
       }
     })
   }
@@ -184,11 +195,16 @@ function aliasGet (msg, done) {
   var seneca = this
   var payload = {name: msg.name}
 
-  seneca.act('role:github,cmd:get', payload, (err, data) => {
-    if (err) return done(err)
+  seneca.act('role:github,cmd:get', payload, (err, res) => {
+    if (err) {
+      return done(null, {ok: false, err: err})
+    }
+
+    if (res && res.ok) {
+      payload.data = res.data
+      seneca.act('role:info,res:part,part:github', payload)
+    }
 
-    payload.data = data
-    seneca.act('role:info,res:part,part:github', payload)
     done(null, {ok: true})
   })
 }

test/github.test.js

@@ -80,13 +80,13 @@ describe('A valid "role:github,cmd:get" call', () => {
     seneca.act('role:github,cmd:get', payload, (err, reply) => {
       expect(err).to.not.exist()
 
-      var cachedOne = reply.cached
+      var cachedOne = reply.data.cached
       payload.update = true
 
       seneca.act('role:github,cmd:get', payload, (err, reply) => {
         expect(err).to.not.exist()
 
-        var cachedTwo = reply.cached
+        var cachedTwo = reply.data.cached
 
         expect(cachedOne).to.be.below(cachedTwo)
         done()