Create sync model for webhook (#1736)

* This is used for Authors to track the internal processing status of each script.
* Only shows up per Author i.e. nobody else and you *must* be logged in to view
* Search might be incorrect atm... still tinkering with that part.
* Hide some pre-existing GH items if no auth strategy present.
* Eventually more is needed but this is a start.

Applies to #1730 and a few related others in the past; Will eventually affect #430 by moving debugging to Author page instead of OUJS intervention.

Auto-merge

Author: Martii

controllers/scriptStorage.js

@@ -2096,6 +2096,7 @@ exports.webhook = function (aReq, aRes) {
   var reponame = null;
   var repos = {};
   var repo = null;
+  var update = null;
 
   // Return if script storage is in read-only mode
   if (process.env.READ_ONLY_SCRIPT_STORAGE === 'true') {
@@ -2154,6 +2155,7 @@ exports.webhook = function (aReq, aRes) {
       break;
     case 'push':
       // Pushing a change
+      update = aReq.get('X-GitHub-Delivery');
       break;
     default:
       aRes.status(400).send(); // Bad request
@@ -2193,6 +2195,11 @@ exports.webhook = function (aReq, aRes) {
       return;
     }
 
+    if (aUser.strategies.indexOf('github') <= -1) { // Don't rely on just `ghUsername`!
+      aRes.status(403).send(); // Reject due to lack of GitHub as Auth
+      return;
+    }
+
     aRes.status(202).send(); // Close connection with Accepted but processing
 
     // Gather the modified user scripts
@@ -2206,10 +2213,19 @@ exports.webhook = function (aReq, aRes) {
 
     // Update modified scripts
     repoManager = RepoManager.getManager(null, aUser, repos);
-    repoManager.loadScripts(true, function (aErr) {
+
+    repoManager.loadSyncs(update, function (aErr) {
       if (aErr) {
-        console.error(aErr);
+        console.error(update, aErr);
+        return;
       }
+
+      repoManager.loadScripts(update, function (aErr) {
+        if (aErr) {
+          console.error(update, aErr);
+        }
+      });
     });
+
   });
 };

controllers/user.js

@@ -21,6 +21,7 @@ var SPDX = require('spdx-license-ids');
 //--- Model inclusions
 var Comment = require('../models/comment').Comment;
 var Script = require('../models/script').Script;
+var Sync = require('../models/sync').Sync;
 var Strategy = require('../models/strategy').Strategy;
 var User = require('../models/user').User;
 var Discussion = require('../models/discussion').Discussion;
@@ -284,6 +285,7 @@ var getUserPageTasks = function (aOptions) {
   var user = null;
   var userScriptListCountQuery = null;
   var userCommentListCountQuery = null;
+  var userSyncListCountQuery = null;
   var tasks = [];
 
   // Shortcuts
@@ -299,6 +301,10 @@ var getUserPageTasks = function (aOptions) {
   userCommentListCountQuery = Comment.find({ _authorId: user._id, flagged: { $ne: true } });
   tasks.push(countTask(userCommentListCountQuery, aOptions, 'commentListCount'));
 
+  // userSyncListCountQuery
+  userSyncListCountQuery = Sync.find({ _authorId: user._id });
+  tasks.push(countTask(userSyncListCountQuery, aOptions, 'syncListCount'));
+
   return tasks;
 };
 
@@ -838,6 +844,100 @@ exports.userScriptListPage = function (aReq, aRes, aNext) {
   });
 };
 
+exports.userSyncListPage = function (aReq, aRes, aNext) {
+  //
+  var username = aReq.params.username;
+
+  User.findOne({
+    name: caseInsensitive(username)
+  }, function (aErr, aUser) {
+    function preRender() {
+      // syncList
+      options.syncList = _.map(options.syncList, modelParser.parseSync);
+
+      // Pagination
+      options.paginationRendered = pagination.renderDefault(aReq);
+    }
+
+    function render() {
+      aRes.render('pages/userSyncListPage', options);
+    }
+
+    function asyncComplete() {
+      preRender();
+      render();
+    }
+
+    //
+    var options = {};
+    var authedUser = aReq.session.user;
+    var user = null;
+    var syncListQuery = null;
+    var pagination = null;
+    var tasks = [];
+
+    if (aErr || !aUser) {
+      aNext();
+      return;
+    }
+
+    // Session
+    options.authedUser = authedUser = modelParser.parseUser(authedUser);
+    options.isMod = authedUser && authedUser.isMod;
+    options.isAdmin = authedUser && authedUser.isAdmin;
+
+    // User
+    user = options.user = modelParser.parseUser(aUser);
+    options.isYou = authedUser && user && authedUser._id == user._id;
+
+    // If not you or not synacable auth strategy move along
+    if (!options.isYou || !options.user.canSync) {
+      aNext();
+      return;
+    }
+
+    // Page metadata
+    pageMetadata(options, [user.name, 'Users']);
+    options.isUserSyncListPage = true;
+
+    // Order dir
+    orderDir(aReq, options, 'target', 'desc');
+    orderDir(aReq, options, 'created', 'asc');
+    orderDir(aReq, options, 'updated', 'asc');
+    orderDir(aReq, options, 'response', 'desc');
+
+    // SyncListQuery
+    syncListQuery = Sync.find();
+
+    // syncListQuery: author=user
+    syncListQuery.find({ _authorId: user._id });
+
+    // syncListQuery: Defaults
+    modelQuery.applySyncListQueryDefaults(syncListQuery, options, aReq);
+
+    // syncListQuery: Pagination
+    pagination = options.pagination; // is set in modelQuery.apply___ListQueryDefaults
+
+    // SearchBar
+    options.searchBarPlaceholder = 'Search Syncs from ' + user.name;
+    options.searchBarFormAction = '';
+
+    //--- Tasks
+
+    // Pagination
+    tasks.push(pagination.getCountTask(syncListQuery));
+
+    // syncListQuery
+    tasks.push(execQueryTask(syncListQuery, options, 'syncList'));
+
+    // UserPage tasks
+    tasks = tasks.concat(getUserPageTasks(options));
+
+    //--
+    async.parallel(tasks, asyncComplete);
+  });
+};
+
 exports.userEditProfilePage = function (aReq, aRes, aNext) {
   var authedUser = aReq.session.user;
 
@@ -1176,6 +1276,14 @@ exports.userGitHubRepoListPage = function (aReq, aRes, aNext) {
   options.isAdmin = authedUser && authedUser.isAdmin;
 
   // GitHub
+  if (!options.authedUser.hasGithub) {
+    statusCodePage(aReq, aRes, aNext, {
+      statusCode: 403,
+      statusMessage: 'You do not have GitHub as an auth strategy'
+    });
+    return;
+  }
+
   options.githubUserId = githubUserId =
     aReq.query.user || authedUser.ghUsername || authedUser.githubUserId();
 
@@ -1283,6 +1391,14 @@ exports.userGitHubRepoPage = function (aReq, aRes, aNext) {
   options.isAdmin = authedUser && authedUser.isAdmin;
 
   // GitHub
+  if (!options.authedUser.hasGithub) {
+    statusCodePage(aReq, aRes, aNext, {
+      statusCode: 403,
+      statusMessage: 'You do not have GitHub as an auth strategy'
+    });
+    return;
+  }
+
   options.githubUserId = githubUserId =
     aReq.query.user || authedUser.ghUsername || authedUser.githubUserId();
 

libs/modelParser.js

@@ -656,6 +656,7 @@ var parseUser = function (aUser) {
   user.userPageUrl = '/users/' + user.slugUrl;
   user.userCommentListPageUrl = user.userPageUrl + '/comments';
   user.userScriptListPageUrl = user.userPageUrl + '/scripts';
+  user.userSyncListPageUrl = user.userPageUrl + '/syncs';
   user.userGitHubRepoListPageUrl = user.userPageUrl + '/github/repos';
   user.userGitHubRepoPageUrl = user.userPageUrl + '/github/repo';
   user.userGitHubImportPageUrl = user.userPageUrl + '/github/import';
@@ -668,6 +669,7 @@ var parseUser = function (aUser) {
   user.userPageUri = '/users/' + user.slugUri;
   user.userCommentListPageUri = user.userPageUri + '/comments';
   user.userScriptListPageUri = user.userPageUri + '/scripts';
+  user.userSyncListPageUri = user.userPageUri + '/syncs';
   user.userGitHubRepoListPageUri = user.userPageUri + '/github/repos';
   user.userGitHubRepoPageUri = user.userPageUri + '/github/repo';
   user.userGitHubImportPageUri = user.userPageUri + '/github/import';
@@ -689,6 +691,8 @@ var parseUser = function (aUser) {
 
   // Strategies
   user.userStrategies = user.strategies;
+  user.hasGithub = user.strategies && user.strategies.indexOf('github') > -1; // NOTE: Watchpoint
+  user.canSync = user.hasGithub;
 
   // Dates
   parseDateProperty(user, '_since'); // Virtual
@@ -913,6 +917,31 @@ exports.renderComment = function (aComment) {
   aComment.contentRendered = renderMd(aComment.content);
 };
 
+/**
+ * Sync
+ */
+
+//
+var parseSync = function (aSync) {
+  var sync = null;
+
+  if (!aSync) {
+    return;
+  }
+  sync = aSync.toObject ? aSync.toObject() : aSync;
+
+  sync.targetUrl = decodeURIComponent(sync.target);
+  sync.targetUrlBasename = decodeURIComponent(sync.target.split('/').pop());
+
+  // Dates
+  parseDateProperty(sync, 'created');
+  parseDateProperty(sync, 'updated');
+
+  return sync;
+};
+parseModelFnMap.Sync = parseSync;
+exports.parseSync = parseSync;
+
 /**
  * Category
  */

libs/modelQuery.js

@@ -151,6 +151,14 @@ var parseCommentSearchQuery = function (aCommentListQuery, aQuery) {
 };
 exports.parseCommentSearchQuery = parseCommentSearchQuery;
 
+var parseSyncSearchQuery = function (aSyncListQuery, aQuery) {
+  parseModelListSearchQuery(aSyncListQuery, aQuery, {
+    partialWordMatchFields: ['target'],
+    fullWordMatchFields: []
+  });
+};
+exports.parseSyncSearchQuery = parseSyncSearchQuery;
+
 var parseUserSearchQuery = function (aUserListQuery, aQuery) {
   parseModelListSearchQuery(aUserListQuery, aQuery, {
     partialWordMatchFields: ['name'],
@@ -311,7 +319,13 @@ var applyModelListQueryDefaults = function (aModelListQuery, aOptions, aReq, aDe
         break;
       case 'size':
         aOptions.orderedBySize = true;
-        // fallthrough
+        break;
+      case 'target':
+        aOptions.orderedByTarget = true;
+        break;
+      case 'response':
+        aOptions.orderedByResponse = true;
+        // fallsthrough
     }
   });
 
@@ -337,6 +351,15 @@ exports.applyCommentListQueryDefaults = function (aCommentListQuery, aOptions, a
   });
 };
 
+exports.applySyncListQueryDefaults = function (aSyncListQuery, aOptions, aReq) {
+  applyModelListQueryDefaults(aSyncListQuery, aOptions, aReq, {
+    defaultSort: '-created',
+    parseSearchQueryFn: parseSyncSearchQuery,
+    searchBarPlaceholder: 'Search Syncs',
+    filterFlaggedItems: false
+  });
+};
+
 exports.applyDiscussionListQueryDefaults = function (aDiscussionListQuery, aOptions, aReq) {
   applyModelListQueryDefaults(aDiscussionListQuery, aOptions, aReq, {
     defaultSort: '-updated -rating',
@@ -433,6 +456,18 @@ exports.applyRemovedItemCommentListQueryDefaults = function (aRemovedItemComment
   applyModelListQueryDefaults(aRemovedItemCommentListQuery, aOptions, aReq, removedItemCommentListQueryDefaults);
 };
 
+var syncListQueryDefaults = {
+  defaultSort: '-created',
+  parseSearchQueryFn: parseSyncSearchQuery,
+  searchBarPlaceholder: 'Search Syncs',
+  searchBarFormAction: '/',
+  filterFlaggedItems: false
+};
+exports.syncListQueryDefaults = syncListQueryDefaults;
+exports.applySyncListQueryDefaults = function (aSyncListQuery, aOptions, aReq) {
+  applyModelListQueryDefaults(aSyncListQuery, aOptions, aReq, syncListQueryDefaults);
+};
+
 var removedItemDiscussionListQueryDefaults = {
   defaultSort: '-removed',
   parseSearchQueryFn: parseRemovedItemSearchQuery,