diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 000000000..9e1ee91e0 --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,292 @@ +# job_defaults applies all the defaults for each job. +job_defaults: &job_defaults + working_directory: ~/coralproject/talk + docker: + - image: circleci/node:8 + +# integration_environment is the environment that configures the tests. +integration_environment: &integration_environment + NODE_ENV: test + CIRCLE_TEST_REPORTS: /tmp/circleci-test-results + E2E_MAX_RETRIES: 3 + +# integration_job runs the integration tests and saves the test results. +integration_job: &integration_job + <<: *job_defaults + environment: + <<: *integration_environment + docker: + - image: circleci/node:8-browsers + - image: circleci/mongo:3 + - image: circleci/redis:4-alpine + steps: + - checkout + - attach_workspace: + at: ~/coralproject/talk + - run: + name: Setup the database with defaults + command: ./bin/cli setup --defaults + - run: + name: Run the integration tests + command: bash .circleci/e2e.sh + - store_test_results: + when: always + path: /tmp/circleci-test-results + +version: 2 +jobs: + # npm_dependencies will install the dependencies used by all other steps. + npm_dependencies: + <<: *job_defaults + steps: + - checkout + - attach_workspace: + at: ~/coralproject/talk + - restore_cache: + key: dependency-cache-{{ checksum "yarn.lock" }} + - run: + name: Install dependencies + command: | + yarn global add node-gyp && + yarn install --frozen-lockfile + - save_cache: + key: dependency-cache-{{ checksum "yarn.lock" }} + paths: + - ./node_modules + - persist_to_workspace: + root: . + paths: node_modules + + # lint will perform file linting. + lint: + <<: *job_defaults + steps: + - checkout + - attach_workspace: + at: ~/coralproject/talk + - run: + name: Perform linting + command: yarn lint + + # build_assets will build the static assets. + build_assets: + <<: *job_defaults + steps: + - checkout + - attach_workspace: + at: ~/coralproject/talk + - restore_cache: + keys: + - build-cache-{{ .Branch }}-{{ .Revision }} + - build-cache-{{ .Branch }}- + - build-cache- + - run: + name: Build static assets + command: yarn build + - save_cache: + key: build-cache-{{ .Branch }}-{{ .Revision }} + paths: + - ./node_modules/.cache/hard-source + - persist_to_workspace: + root: . + paths: dist + + # test_unit will run the unit tests. + test_unit: + <<: *job_defaults + docker: + - image: circleci/node:8 + - image: circleci/mongo:3 + - image: circleci/redis:4-alpine + steps: + - checkout + - attach_workspace: + at: ~/coralproject/talk + - run: + name: Setup the test results directory + command: mkdir -p /tmp/circleci-test-results + - run: + name: Run the client unit tests + command: yarn test:client --ci + environment: + JEST_JUNIT_OUTPUT: /tmp/circleci-test-results/jest/test-results.xml + JEST_REPORTER: jest-junit + - run: + name: Run the server unit tests + command: yarn test:server + environment: + MOCHA_FILE: /tmp/circleci-test-results/mocha/test-results.xml + MOCHA_REPORTER: mocha-junit-reporter + - store_test_results: + when: always + path: /tmp/circleci-test-results + + # test_integration_chrome_local will run the integration tests locally with + # chrome headless. + test_integration_chrome_local: + <<: *integration_job + environment: + <<: *integration_environment + E2E_BROWSERS: chrome + + # test_integration_firefox_local will run the integration tests locally with + # firefox headless. + test_integration_firefox_local: + <<: *integration_job + environment: + <<: *integration_environment + E2E_BROWSERS: firefox + + # test_integration_chrome will run the integration tests with chrome in + # browserstack. + test_integration_chrome: + <<: *integration_job + environment: + <<: *integration_environment + BROWSERSTACK: true + E2E_BROWSERS: chrome + + # test_integration_firefox will run the integration tests with firefox in + # browserstack. + test_integration_firefox: + <<: *integration_job + environment: + <<: *integration_environment + BROWSERSTACK: true + E2E_BROWSERS: firefox + + # test_integration_edge will run the integration tests with edge in + # browserstack. + test_integration_edge: + <<: *integration_job + environment: + <<: *integration_environment + BROWSERSTACK: true + E2E_BROWSERS: edge + + # test_integration_ie will run the integration tests with ie in + # browserstack. + test_integration_ie: + <<: *integration_job + environment: + <<: *integration_environment + BROWSERSTACK: true + E2E_BROWSERS: ie + # TODO: remove when more reliable + E2E_MAX_RETRIES: 1 + + # test_integration_safari will run the integration tests with safari in + # browserstack. + test_integration_safari: + <<: *integration_job + environment: + <<: *integration_environment + BROWSERSTACK: true + E2E_BROWSERS: safari + # TODO: remove when more reliable + E2E_MAX_RETRIES: 1 + + # deploy will deploy the application as a docker image. + deploy: + <<: *job_defaults + steps: + - checkout + - setup_remote_docker + - run: + name: Deploy the code + command: bash ./scripts/docker.sh deploy + +# filter_deploy will add the filters for a deploy job in a workflow to make it +# only execute on a deploy related job. +filter_deploy: &filter_deploy + filters: + branches: + only: + - master + - next + tags: + only: /v[0-9]+(\.[0-9]+)*/ + +# filter_develop will add the filters for a development related commit. +filter_develop: &filter_develop + filters: + branches: + ignore: + - master + - next + +workflows: + version: 2 + + # All PR's will hit this workflow. + build-and-test: + jobs: + - npm_dependencies: + <<: *filter_develop + - lint: + <<: *filter_develop + requires: + - npm_dependencies + - test_unit: + <<: *filter_develop + requires: + - npm_dependencies + - build_assets: + <<: *filter_develop + requires: + - npm_dependencies + - test_integration_chrome_local: + <<: *filter_develop + requires: + - build_assets + - test_integration_firefox_local: + <<: *filter_develop + requires: + - build_assets + deploy-tagged: + jobs: + - npm_dependencies: + <<: *filter_deploy + - lint: + <<: *filter_deploy + requires: + - npm_dependencies + - test_unit: + <<: *filter_deploy + requires: + - npm_dependencies + - build_assets: + <<: *filter_deploy + requires: + - npm_dependencies + - test_integration_chrome: + <<: *filter_deploy + requires: + - build_assets + - test_integration_firefox: + <<: *filter_deploy + requires: + - build_assets + - test_integration_edge: + <<: *filter_deploy + requires: + - build_assets + - test_integration_ie: + <<: *filter_deploy + requires: + - build_assets + - test_integration_safari: + <<: *filter_deploy + requires: + - build_assets + - deploy: + <<: *filter_deploy + requires: + - lint + - test_unit + - test_integration_chrome + - test_integration_firefox + - test_integration_edge + # TODO: uncomment when more reliable + # - test_integration_ie + # - test_integration_safari \ No newline at end of file diff --git a/scripts/e2e-ci.sh b/.circleci/e2e.sh similarity index 65% rename from scripts/e2e-ci.sh rename to .circleci/e2e.sh index a509ccee7..2d9fc25af 100755 --- a/scripts/e2e-ci.sh +++ b/.circleci/e2e.sh @@ -19,11 +19,11 @@ if [[ "${E2E_DISABLE}" == "true" ]]; then exit fi -if [[ "${CIRCLE_BRANCH}" == "master" && -n "$BROWSERSTACK_KEY" ]]; then +if [[ "$BROWSERSTACK" == "true" && -n "$BROWSERSTACK_KEY" ]]; then echo Testing on browserstack - yarn e2e --reports-folder "$REPORTS_FOLDER" --bs-key "$BROWSERSTACK_KEY" --retries "$E2E_MAX_RETRIES" --timeout "$E2E_WAIT_FOR_TIMEOUT" --browsers "$E2E_BROWSERS" + node scripts/e2e.js --reports-folder "$REPORTS_FOLDER" --retries "$E2E_MAX_RETRIES" --timeout "$E2E_WAIT_FOR_TIMEOUT" --browsers "$E2E_BROWSERS" --browserstack else # When browserstack is not available test locally using chrome headless. echo Testing locally - yarn e2e --reports-folder "$REPORTS_FOLDER" --retries "$E2E_MAX_RETRIES" --headless + node scripts/e2e.js --reports-folder "$REPORTS_FOLDER" --retries "$E2E_MAX_RETRIES" --timeout "$E2E_WAIT_FOR_TIMEOUT" --browsers "$E2E_BROWSERS" --headless fi diff --git a/.eslintignore b/.eslintignore index ad58230e0..a9543d933 100644 --- a/.eslintignore +++ b/.eslintignore @@ -2,4 +2,5 @@ dist docs node_modules -public \ No newline at end of file +public + diff --git a/.gitignore b/.gitignore index 48ce6e5d5..b7a79b2bd 100644 --- a/.gitignore +++ b/.gitignore @@ -23,39 +23,49 @@ browserstack.err plugins.json plugins/* + !plugins/talk-plugin-akismet -!plugins/talk-plugin-facebook-auth -!plugins/talk-plugin-google-auth !plugins/talk-plugin-auth -!plugins/talk-plugin-respect -!plugins/talk-plugin-offtopic -!plugins/talk-plugin-like -!plugins/talk-plugin-mod -!plugins/talk-plugin-love -!plugins/talk-plugin-viewing-options +!plugins/talk-plugin-author-menu !plugins/talk-plugin-comment-content -!plugins/talk-plugin-permalink +!plugins/talk-plugin-deep-reply-count +!plugins/talk-plugin-facebook-auth !plugins/talk-plugin-featured-comments -!plugins/talk-plugin-toxic-comments -!plugins/talk-plugin-sort-newest -!plugins/talk-plugin-sort-oldest -!plugins/talk-plugin-sort-most-replied +!plugins/talk-plugin-flag-details +!plugins/talk-plugin-google-auth +!plugins/talk-plugin-ignore-user +!plugins/talk-plugin-like +!plugins/talk-plugin-love +!plugins/talk-plugin-member-since +!plugins/talk-plugin-mod +!plugins/talk-plugin-moderation-actions +!plugins/talk-plugin-notifications +!plugins/talk-plugin-notifications-category-featured +!plugins/talk-plugin-notifications-category-reply +!plugins/talk-plugin-notifications-category-staff +!plugins/talk-plugin-offtopic +!plugins/talk-plugin-permalink +!plugins/talk-plugin-profile-settings +!plugins/talk-plugin-remember-sort +!plugins/talk-plugin-respect +!plugins/talk-plugin-slack-notifications !plugins/talk-plugin-sort-most-liked !plugins/talk-plugin-sort-most-loved +!plugins/talk-plugin-sort-most-replied !plugins/talk-plugin-sort-most-respected -!plugins/talk-plugin-author-menu -!plugins/talk-plugin-member-since -!plugins/talk-plugin-ignore-user -!plugins/talk-plugin-moderation-actions -!plugins/talk-plugin-toxic-comments -!plugins/talk-plugin-remember-sort -!plugins/talk-plugin-deep-reply-count +!plugins/talk-plugin-sort-newest +!plugins/talk-plugin-sort-oldest !plugins/talk-plugin-subscriber +<<<<<<< HEAD !plugins/talk-plugin-flag-details !plugins/talk-plugin-slack-notifications !plugins/talk-plugin-rich-text !plugins/talk-plugin-rich-text-pell !plugins/talk-plugin-profile-settings +======= +!plugins/talk-plugin-toxic-comments +!plugins/talk-plugin-viewing-options +>>>>>>> 8d147dbf47104cdcfb8c3bc2ebb02b6c73c7b8ab **/node_modules/* yarn-error.log diff --git a/README.md b/README.md index 89474bf6d..db9f65c3d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Talk · [![CircleCI](https://circleci.com/gh/coralproject/talk.svg?style=svg)](https://circleci.com/gh/coralproject/talk) · [![NSP Status](https://nodesecurity.io/orgs/coralproject/projects/07ce2e4c-99fb-48f8-b50b-69d2d2c081b8/badge)](https://nodesecurity.io/orgs/coralproject/projects/07ce2e4c-99fb-48f8-b50b-69d2d2c081b8) · [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md#pull-requests) +# Talk · [![CircleCI](https://circleci.com/gh/coralproject/talk.svg?style=svg)](https://circleci.com/gh/coralproject/talk) · [![NSP Status](https://nodesecurity.io/orgs/coralproject/projects/7bd7d26c-47ed-4a5f-8c4a-b919bf1c2946/badge)](https://nodesecurity.io/orgs/coralproject/projects/7bd7d26c-47ed-4a5f-8c4a-b919bf1c2946) · [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md#pull-requests) Online comments are broken. Our open-source commenting platform, Talk, rethinks how moderation, comment display, and conversation function, creating the opportunity for safer, smarter discussions around your work. [Read more about Talk here](https://coralproject.net/products/talk.html). diff --git a/app.js b/app.js index e962e41ff..c2bf9648d 100644 --- a/app.js +++ b/app.js @@ -1,7 +1,6 @@ const express = require('express'); const morgan = require('morgan'); const path = require('path'); -const uuid = require('uuid'); const merge = require('lodash/merge'); const helmet = require('helmet'); const plugins = require('./services/plugins'); @@ -13,13 +12,6 @@ const { ENABLE_TRACING, APOLLO_ENGINE_KEY, PORT } = require('./config'); const app = express(); -// Request Identity Middleware -app.use((req, res, next) => { - req.id = uuid.v4(); - - next(); -}); - //============================================================================== // PLUGIN PRE APPLICATION MIDDLEWARE //============================================================================== diff --git a/bin/cli-jobs b/bin/cli-jobs index 672a5a70d..a9599213d 100755 --- a/bin/cli-jobs +++ b/bin/cli-jobs @@ -6,8 +6,7 @@ const util = require('./util'); const program = require('commander'); -const scraper = require('../services/scraper'); -const mailer = require('../services/mailer'); +const jobs = require('../jobs'); const mongoose = require('../services/mongoose'); const kue = require('../services/kue'); @@ -21,11 +20,8 @@ function processJobs() { // started. util.onshutdown([() => kue.Task.shutdown()]); - // Start the scraper processor. - scraper.process(); - - // Start the mail processor. - mailer.process(); + // Start the jobs processor. + jobs.process(); } /** diff --git a/bin/cli-plugins b/bin/cli-plugins index ee331bff2..f2e76de21 100755 --- a/bin/cli-plugins +++ b/bin/cli-plugins @@ -143,7 +143,7 @@ async function reconcileRemotePlugins({ dryRun, upgradeRemote }) { if (fetchable.length > 0) { console.log( - `$ yarn add --ignore-scripts ${fetchable.map( + `$ yarn add --ignore-scripts --ignore-workspace-root-check ${fetchable.map( ({ name, version }) => `${name}@${version}`.cyan )}` ); @@ -152,6 +152,7 @@ async function reconcileRemotePlugins({ dryRun, upgradeRemote }) { let args = [ 'add', '--ignore-scripts', + '--ignore-workspace-root-check', ...fetchable.map(({ name, version }) => `${name}@${version}`), ]; diff --git a/circle.yml b/circle.yml deleted file mode 100644 index bd5c2c520..000000000 --- a/circle.yml +++ /dev/null @@ -1,75 +0,0 @@ -machine: - node: - version: 8 - services: - - docker - - redis - environment: - PATH: "${PATH}:${HOME}/${CIRCLE_PROJECT_REPONAME}/node_modules/.bin" - NODE_ENV: "test" - MOCHA_FILE: "${CIRCLE_TEST_REPORTS}/junit/test-results.xml" - MOCHA_REPORTER: "mocha-junit-reporter" - pre: - # TODO: use the following to add in support for MongoDB 3.4. - # # Upgrade the database version to 3.4. - # - sudo apt-get purge mongodb-org* - # - sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 0C49F3730359A14518585931BC711F9BA15703C6 - # - echo "deb [ arch=amd64 ] http://repo.mongodb.org/apt/ubuntu precise/mongodb-org/3.4 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.4.list - # - sudo apt-get update - # - sudo apt-get install -y mongodb-org - # - sudo service mongod restart - - # Force sync the time. - - date - - sudo service ntp stop - - sudo ntpdate -s time.nist.gov - - sudo service ntp start - - date - - # Install chromium for e2e and remove old google-chrome - - sudo rm -rf /opt/google/chrome - - sudo rm -f /usr/bin/google-chrome* - - sudo apt-get update - - sudo apt-get install chromium-browser - -dependencies: - override: - - # Install node dependencies. - - yarn --version - - yarn global add node-gyp --force - - yarn - - post: - # Build the static assets. - - yarn build - # Lint the project here, before tests are ran. - - yarn lint - -database: - post: - # Initialize the settings in the database, this will create indicies for the - # database. - - ./bin/cli setup --defaults - - sleep 2 - -test: - override: - # Run the tests using the junit reporter. - - yarn test - # Run the end to end tests - - yarn e2e:ci - -deployment: - release: - tag: /v[0-9]+(\.[0-9]+)*/ - commands: - - bash ./scripts/docker.sh deploy - - latest: - branch: - - master - - next - owner: coralproject - commands: - - bash ./scripts/docker.sh deploy diff --git a/client/coral-auth-callback/src/index.js b/client/coral-auth-callback/src/index.js index b7f3ed226..41a83dcd2 100644 --- a/client/coral-auth-callback/src/index.js +++ b/client/coral-auth-callback/src/index.js @@ -1,14 +1,34 @@ +import { HANDLE_SUCCESSFUL_LOGIN } from 'coral-framework/constants/auth'; +import { getStaticConfiguration } from 'coral-framework/services/staticConfiguration'; +import { createPostMessage } from 'coral-framework/services/postMessage'; + document.addEventListener('DOMContentLoaded', () => { - // Get the auth element and parse it as JSON by decoding it. - const auth = document.getElementById('auth'); - const doc = document.implementation.createHTMLDocument(''); - doc.body.innerHTML = auth.innerText; + try { + const staticConfig = getStaticConfiguration(); + const { STATIC_ORIGIN: origin } = staticConfig; + const postMessage = createPostMessage(origin); - // Set the item in localStorage. - localStorage.setItem('auth', doc.body.textContent); + // Get the auth element and parse it as JSON by decoding it. + const auth = document.getElementById('auth'); + const doc = document.implementation.createHTMLDocument(''); + doc.body.innerHTML = auth.innerText; - // Close the window. - setTimeout(() => { - window.close(); - }, 50); + // Auth state is contained within the node. + const { err, data } = JSON.parse(doc.body.textContent); + if (err) { + // TODO: send back the error message. + console.error(err); + } else { + // The data will contain a user and a token. + const { user, token } = data; + + // Send the state back. + postMessage.post(HANDLE_SUCCESSFUL_LOGIN, { user, token }); + } + } finally { + // Always close the window. + setTimeout(() => { + window.close(); + }, 50); + } }); diff --git a/client/coral-embed-stream/src/actions/asset.js b/client/coral-embed-stream/src/actions/asset.js deleted file mode 100644 index 158e65594..000000000 --- a/client/coral-embed-stream/src/actions/asset.js +++ /dev/null @@ -1,75 +0,0 @@ -import * as actions from '../constants/asset'; -import { notify } from 'coral-framework/actions/notification'; - -import t from 'coral-framework/services/i18n'; - -export const fetchAssetRequest = () => ({ type: actions.FETCH_ASSET_REQUEST }); -export const fetchAssetSuccess = asset => ({ - type: actions.FETCH_ASSET_SUCCESS, - asset, -}); -export const fetchAssetFailure = error => ({ - type: actions.FETCH_ASSET_FAILURE, - error, -}); - -const updateAssetSettingsRequest = () => ({ - type: actions.UPDATE_ASSET_SETTINGS_REQUEST, -}); -const updateAssetSettingsSuccess = settings => ({ - type: actions.UPDATE_ASSET_SETTINGS_SUCCESS, - settings, -}); -const updateAssetSettingsFailure = error => ({ - type: actions.UPDATE_ASSET_SETTINGS_FAILURE, - error, -}); - -export const updateConfiguration = newConfig => ( - dispatch, - getState, - { rest } -) => { - const assetId = getState().asset.id; - dispatch(updateAssetSettingsRequest()); - rest(`/assets/${assetId}/settings`, { method: 'PUT', body: newConfig }) - .then(() => { - dispatch(notify('success', t('framework.success_update_settings'))); - dispatch(updateAssetSettingsSuccess(newConfig)); - }) - .catch(error => { - console.error(error); - dispatch(updateAssetSettingsFailure(error)); - }); -}; - -export const updateOpenStream = closedBody => ( - dispatch, - getState, - { rest } -) => { - const assetId = getState().asset.id; - dispatch(fetchAssetRequest()); - rest(`/assets/${assetId}/status`, { method: 'PUT', body: closedBody }) - .then(() => { - dispatch(notify('success', t('framework.success_update_settings'))); - dispatch(fetchAssetSuccess(closedBody)); - }) - .catch(error => { - console.error(error); - dispatch(fetchAssetFailure(error)); - }); -}; - -const openStream = () => ({ type: actions.OPEN_COMMENTS }); -const closeStream = () => ({ type: actions.CLOSE_COMMENTS }); - -export const updateOpenStatus = status => dispatch => { - if (status === 'open') { - dispatch(openStream()); - dispatch(updateOpenStream({ closedAt: null })); - } else { - dispatch(closeStream()); - dispatch(updateOpenStream({ closedAt: new Date().getTime() })); - } -}; diff --git a/client/coral-embed-stream/src/actions/config.js b/client/coral-embed-stream/src/actions/config.js deleted file mode 100644 index e30dc24cf..000000000 --- a/client/coral-embed-stream/src/actions/config.js +++ /dev/null @@ -1,6 +0,0 @@ -import { ADD_EXTERNAL_CONFIG } from '../constants/config'; - -export const addExternalConfig = config => ({ - type: ADD_EXTERNAL_CONFIG, - config, -}); diff --git a/client/coral-embed-stream/src/actions/login.js b/client/coral-embed-stream/src/actions/login.js index c602bf7b6..fe1f76149 100644 --- a/client/coral-embed-stream/src/actions/login.js +++ b/client/coral-embed-stream/src/actions/login.js @@ -1,14 +1,10 @@ import * as actions from '../constants/login'; -import { checkLogin } from 'coral-framework/actions/auth'; export const showSignInDialog = () => ({ type: actions.SHOW_SIGNIN_DIALOG, }); -export const hideSignInDialog = () => dispatch => { - dispatch(checkLogin()); - dispatch({ type: actions.HIDE_SIGNIN_DIALOG }); -}; +export const hideSignInDialog = () => ({ type: actions.HIDE_SIGNIN_DIALOG }); export const focusSignInDialog = () => ({ type: actions.FOCUS_SIGNIN_DIALOG, diff --git a/client/coral-embed-stream/src/constants/asset.js b/client/coral-embed-stream/src/constants/asset.js deleted file mode 100644 index 40f746706..000000000 --- a/client/coral-embed-stream/src/constants/asset.js +++ /dev/null @@ -1,10 +0,0 @@ -export const FETCH_ASSET_REQUEST = 'FETCH_ASSET_REQUEST'; -export const FETCH_ASSET_FAILURE = 'FETCH_ASSET_FAILURE'; -export const FETCH_ASSET_SUCCESS = 'FETCH_ASSET_SUCCESS'; - -export const UPDATE_ASSET_SETTINGS_REQUEST = 'UPDATE_ASSET_SETTINGS_REQUEST'; -export const UPDATE_ASSET_SETTINGS_SUCCESS = 'UPDATE_ASSET_SETTINGS_SUCCESS'; -export const UPDATE_ASSET_SETTINGS_FAILURE = 'UPDATE_ASSET_SETTINGS_FAILURE'; - -export const OPEN_COMMENTS = 'OPEN_COMMENTS'; -export const CLOSE_COMMENTS = 'CLOSE_COMMENTS'; diff --git a/client/coral-embed-stream/src/constants/config.js b/client/coral-embed-stream/src/constants/config.js deleted file mode 100644 index 5821316c5..000000000 --- a/client/coral-embed-stream/src/constants/config.js +++ /dev/null @@ -1 +0,0 @@ -export const ADD_EXTERNAL_CONFIG = 'ADD_EXTERNAL_CONFIG'; diff --git a/client/coral-embed-stream/src/containers/Embed.js b/client/coral-embed-stream/src/containers/Embed.js index f8486fd14..d365af50d 100644 --- a/client/coral-embed-stream/src/containers/Embed.js +++ b/client/coral-embed-stream/src/containers/Embed.js @@ -2,7 +2,6 @@ import React from 'react'; import { compose, gql } from 'react-apollo'; import { connect } from 'react-redux'; import { bindActionCreators } from 'redux'; -import isEqual from 'lodash/isEqual'; import get from 'lodash/get'; import branch from 'recompose/branch'; import renderComponent from 'recompose/renderComponent'; @@ -14,12 +13,11 @@ import { hideSignInDialog, } from '../actions/login'; import { updateStatus } from 'coral-framework/actions/auth'; -import { fetchAssetSuccess } from '../actions/asset'; import { getDefinitionName, getSlotFragmentSpreads, } from 'coral-framework/utils'; -import { withQuery } from 'coral-framework/hocs'; +import { withQuery, withPopupAuthHandler } from 'coral-framework/hocs'; import Embed from '../components/Embed'; import Stream from '../tabs/stream/containers/Stream'; import AutomaticAssetClosure from './AutomaticAssetClosure'; @@ -107,12 +105,6 @@ class EmbedContainer extends React.Component { this.props.data.refetch(); this.resubscribe(nextProps); } - - const { fetchAssetSuccess } = this.props; - if (!isEqual(nextProps.root.asset, this.props.root.asset)) { - // TODO: remove asset data from redux store. - fetchAssetSuccess(nextProps.root.asset); - } } componentDidUpdate(prevProps) { @@ -298,7 +290,6 @@ EmbedContainer.propTypes = { activeTab: PropTypes.string, parentUrl: PropTypes.string, data: PropTypes.object, - fetchAssetSuccess: PropTypes.func, showSignInDialog: PropTypes.bool, signInDialogFocus: PropTypes.bool, }; @@ -322,7 +313,6 @@ const mapDispatchToProps = dispatch => bindActionCreators( { setActiveTab, - fetchAssetSuccess, notify, focusSignInDialog, blurSignInDialog, @@ -333,6 +323,7 @@ const mapDispatchToProps = dispatch => ); export default compose( + withPopupAuthHandler, connect(mapStateToProps, mapDispatchToProps), branch(props => !props.checkedInitialLogin, renderComponent(Spinner)), withEmbedQuery diff --git a/client/coral-embed-stream/src/graphql/utils.js b/client/coral-embed-stream/src/graphql/utils.js index 720cb7f2e..96cf49cad 100644 --- a/client/coral-embed-stream/src/graphql/utils.js +++ b/client/coral-embed-stream/src/graphql/utils.js @@ -141,7 +141,7 @@ export function findCommentInAsset(asset, callbackOrId) { callback = node => node.id === callbackOrId; } if (asset.comment) { - return findComment([getTopLevelParent(asset.comment)], callback); + return findComment([reverseCommentParentTree(asset.comment)], callback); } if (!asset.comments) { return false; @@ -187,11 +187,12 @@ export function insertFetchedCommentsIntoEmbedQuery(root, comments, parent_id) { ); } -/** - * attachCommentToParent recurses through the comment tree starting at `topLevelComment` - * to find the parent of `comment` and attach it to the replies. - */ -export function attachCommentToParent(topLevelComment, comment) { +function attachComment(topLevelComment, comment) { + if (!topLevelComment.replies) { + topLevelComment = update(topLevelComment, { + replies: { $set: { nodes: [] } }, + }); + } if (topLevelComment.id === comment.parent.id) { return update(topLevelComment, { replies: { @@ -204,16 +205,40 @@ export function attachCommentToParent(topLevelComment, comment) { }, }); } + if (!topLevelComment.replies.nodes.length) { + return topLevelComment; + } return update(topLevelComment, { replies: { nodes: { - $apply: nodes => - nodes.map(node => attachCommentToParent(node, comment)), + $apply: nodes => nodes.map(node => attachComment(node, comment)), }, }, }); } +/** + * attachCommentToParent recurses through the comment tree starting at `topLevelComment` + * to find the ancestor of `comment` and attach it to the replies. + */ +export function attachCommentToParent(topLevelComment, comment) { + let result = topLevelComment; + if (comment.parent.parent) { + result = attachCommentToParent(result, comment.parent); + } + return attachComment(result, comment); +} + +/** + * reverseCommentParentTree reverses a comment parent relationship tree + * like `comment -> parent -> parent` into `parent -> parent -> comment -> replies`. + */ +export function reverseCommentParentTree(comment) { + return comment.parent + ? attachCommentToParent(getTopLevelParent(comment), comment) + : comment; +} + /** * Nest a string in itself repeatly until `level` has been reached. * diff --git a/client/coral-embed-stream/src/reducers/asset.js b/client/coral-embed-stream/src/reducers/asset.js deleted file mode 100644 index b683eae30..000000000 --- a/client/coral-embed-stream/src/reducers/asset.js +++ /dev/null @@ -1,28 +0,0 @@ -import * as actions from '../constants/asset'; - -const initialState = { - closedAt: null, - settings: null, - title: null, - url: null, - features: {}, - status: 'open', - moderation: null, -}; - -export default function asset(state = initialState, action) { - switch (action.type) { - case actions.FETCH_ASSET_SUCCESS: - return { - ...state, - ...action.asset, - }; - case actions.UPDATE_ASSET_SETTINGS_SUCCESS: - return { - ...state, - settings: action.settings, - }; - default: - return state; - } -} diff --git a/client/coral-embed-stream/src/reducers/config.js b/client/coral-embed-stream/src/reducers/config.js deleted file mode 100644 index 09a89a743..000000000 --- a/client/coral-embed-stream/src/reducers/config.js +++ /dev/null @@ -1,15 +0,0 @@ -import { ADD_EXTERNAL_CONFIG } from '../constants/config'; - -const initialState = {}; - -export default function config(state = initialState, action) { - switch (action.type) { - case ADD_EXTERNAL_CONFIG: - return { - ...state, - ...action.config, - }; - default: - return state; - } -} diff --git a/client/coral-embed-stream/src/reducers/index.js b/client/coral-embed-stream/src/reducers/index.js index f8eed72d4..15056d414 100644 --- a/client/coral-embed-stream/src/reducers/index.js +++ b/client/coral-embed-stream/src/reducers/index.js @@ -1,5 +1,4 @@ import login from './login'; -import asset from './asset'; import embed from './embed'; import configure from './configure'; import stream from './stream'; @@ -7,7 +6,6 @@ import profile from './profile'; export default { login, - asset, embed, configure, stream, diff --git a/client/coral-embed-stream/src/tabs/stream/components/Comment.css b/client/coral-embed-stream/src/tabs/stream/components/Comment.css index 15d42bef0..58ff0e731 100644 --- a/client/coral-embed-stream/src/tabs/stream/components/Comment.css +++ b/client/coral-embed-stream/src/tabs/stream/components/Comment.css @@ -22,6 +22,10 @@ .commentLevel0 { padding-left: 0px; + + &.highlightedComment { + margin-top: 8px; + } } .commentLevel1 { @@ -41,8 +45,8 @@ } .highlightedComment { - padding-left: 15px; - border-left: 3px solid rgb(35,118,216); + padding: 1px 15px 8px 15px; + background-color: #E3F2FD; } .bylineSecondary { diff --git a/client/coral-embed-stream/src/tabs/stream/components/Comment.js b/client/coral-embed-stream/src/tabs/stream/components/Comment.js index f17e7adec..acd791ba4 100644 --- a/client/coral-embed-stream/src/tabs/stream/components/Comment.js +++ b/client/coral-embed-stream/src/tabs/stream/components/Comment.js @@ -13,6 +13,7 @@ import styles from './Comment.css'; import { THREADING_LEVEL } from '../../../constants/stream'; import merge from 'lodash/merge'; import mapValues from 'lodash/mapValues'; +import get from 'lodash/get'; import LoadMore from './LoadMore'; import { getEditableUntilDate } from './util'; @@ -169,7 +170,7 @@ export default class Comment extends React.Component { postFlag: PropTypes.func.isRequired, deleteAction: PropTypes.func.isRequired, parentId: PropTypes.string, - highlighted: PropTypes.string, + highlighted: PropTypes.object, notify: PropTypes.func.isRequired, postComment: PropTypes.func.isRequired, depth: PropTypes.number.isRequired, @@ -186,28 +187,7 @@ export default class Comment extends React.Component { postDontAgree: PropTypes.func, animateEnter: PropTypes.bool, commentClassNames: PropTypes.array, - comment: PropTypes.shape({ - depth: PropTypes.number, - action_summaries: PropTypes.array.isRequired, - body: PropTypes.string.isRequired, - id: PropTypes.string.isRequired, - tags: PropTypes.arrayOf( - PropTypes.shape({ - name: PropTypes.string, - }) - ), - replies: PropTypes.object, - user: PropTypes.shape({ - id: PropTypes.string.isRequired, - username: PropTypes.string.isRequired, - }).isRequired, - editing: PropTypes.shape({ - edited: PropTypes.bool, - - // ISO8601 - editableUntil: PropTypes.string, - }), - }).isRequired, + comment: PropTypes.object.isRequired, setCommentStatus: PropTypes.func.isRequired, // edit a comment, passed (id, asset_id, { body }) @@ -301,6 +281,14 @@ export default class Comment extends React.Component { this.props.setActiveReplyBox(''); }; + undoStatus = () => + this.props.setCommentStatus({ + commentId: this.props.comment.id, + status: this.props.comment.status_history[ + this.props.comment.status_history.length - 2 + ].type, + }); + // getVisibileReplies returns a list containing comments // which were authored by current user or comes before the `idCursor`. getVisibileReplies() { @@ -329,6 +317,27 @@ export default class Comment extends React.Component { return view; } + /** + * getConditionalClassNames + * conditionalClassNames adds classNames based on condition + * classnames is an array of objects with key as classnames and value as conditions + * i.e: + * { + * 'myClassName': { tags: [STAFF]} + * } + * + * This will add myClassName to comments tagged with STAFF TAG. + **/ + getConditionalClassNames() { + const { commentClassNames = [] } = this.props; + return mapValues(merge({}, ...commentClassNames), condition => { + if (condition.tags) { + return condition.tags.some(tag => hasTag(this.props.comment.tags, tag)); + } + return false; + }); + } + componentDidMount() { this._isMounted = true; if (this.editWindowExpiryTimeout) { @@ -343,25 +352,51 @@ export default class Comment extends React.Component { }, Math.max(msLeftToEdit, 0)); } } + componentWillUnmount() { if (this.editWindowExpiryTimeout) { this.editWindowExpiryTimeout = clearTimeout(this.editWindowExpiryTimeout); } this._isMounted = false; } - render() { + + renderReplyBox() { + const { + asset, + depth, + comment, + parentId, + postComment, + currentUser, + setActiveReplyBox, + maxCharCount, + notify, + charCountEnable, + } = this.props; + return ( + + ); + } + + renderReplies(view) { const { asset, - data, - root, depth, comment, postFlag, - parentId, highlighted, postComment, currentUser, - postDontAgree, setActiveReplyBox, activeReplyBox, loadMore, @@ -372,39 +407,47 @@ export default class Comment extends React.Component { charCountEnable, showSignInDialog, liveUpdates, - animateEnter, emit, - commentClassNames = [], } = this.props; + return ( + + {view.map(reply => { + return ( + + ); + })} + + ); + } - if (!highlighted && this.commentIsRejected(comment)) { - return ( - { - this.props.setCommentStatus({ - commentId: comment.id, - status: - comment.status_history[comment.status_history.length - 2].type, - }); - }} - /> - ); - } - - if (this.commentIsIgnored(comment)) { - return ; - } - - const view = this.getVisibileReplies(); - - // Inactive comments can be viewed by moderators and admins (e.g. using permalinks). - const isActive = isCommentActive(comment.status); - + renderLoadMoreReplies(view) { + const { comment } = this.props; const { loadingState } = this.state; - const isPending = comment.id.indexOf('pending') >= 0; - const isHighlighted = highlighted === comment.id; - const hasMoreComments = comment.replies && (comment.replies.hasNextPage || @@ -412,6 +455,57 @@ export default class Comment extends React.Component { const moreRepliesCount = this.hasIgnoredReplies() ? -1 : comment.replyCount - view.length; + return ( +
+ +
+ ); + } + + renderRepliesContainer() { + const { highlighted, comment } = this.props; + + // Only render highlighted reply when we are the parent of it. + if (get(highlighted, 'parent.id') === comment.id) { + return this.renderReplies([highlighted]); + } + + // Otherwise render replies in current view and a load more button if needed. + const view = this.getVisibileReplies(); + return [this.renderReplies(view), this.renderLoadMoreReplies(view)]; + } + + renderComment() { + const { + asset, + data, + root, + depth, + comment, + postFlag, + parentId, + highlighted, + currentUser, + postDontAgree, + deleteAction, + disableReply, + maxCharCount, + notify, + charCountEnable, + showSignInDialog, + } = this.props; + + // Inactive comments can be viewed by moderators and admins (e.g. using permalinks). + const isActive = isCommentActive(comment.status); + + const isPending = comment.id.indexOf('pending') >= 0; + const isHighlighted = highlighted && highlighted.id === comment.id; const flagSummary = getActionSummary('FlagActionSummary', comment); const dontAgreeSummary = getActionSummary( 'DontAgreeActionSummary', @@ -424,38 +518,6 @@ export default class Comment extends React.Component { myFlag = dontAgreeSummary.find(s => s.current_user); } - /** - * conditionClassNames - * adds classNames based on condition - * classnames is an array of objects with key as classnames and value as conditions - * i.e: - * { - * 'myClassName': { tags: [STAFF]} - * } - * - * This will add myClassName to comments tagged with STAFF TAG. - * **/ - const conditionalClassNames = mapValues( - merge({}, ...commentClassNames), - condition => { - if (condition.tags) { - return condition.tags.some(tag => hasTag(comment.tags, tag)); - } - return false; - } - ); - - const rootClassName = cn( - 'talk-stream-comment-wrapper', - `talk-stream-comment-wrapper-level-${depth}`, - styles.root, - styles[`rootLevel${depth}`], - { - ...conditionalClassNames, - [styles.enter]: animateEnter, - } - ); - const commentClassName = cn( 'talk-stream-comment', `talk-stream-comment-level-${depth}`, @@ -482,183 +544,183 @@ export default class Comment extends React.Component { }; return ( -
-
- +
+ + +
+
+
+ -
-
+ {isStaff(comment.tags) ? Staff : null} + + +
+ + + {comment.editing && comment.editing.edited ? ( + +   + ({t('comment.edited')}) + + + ) : null} + +
-
+ + {isActive && + (currentUser && comment.user.id === currentUser.id) && ( + /* User can edit/delete their own comment for a short window after posting */ + + {this.state.isEditable && ( + + Edit + )} - > - {isStaff(comment.tags) ? Staff : null} - + + )} + {!isActive && } +
+
+ {this.state.isEditing ? ( + + ) : ( +
+ +
+ )} +
+
+ {isActive && ( +
+
-
- - - {comment.editing && comment.editing.edited ? ( - -   - ({t('comment.edited')}) - - - ) : null} - -
- - - - {isActive && - (currentUser && comment.user.id === currentUser.id) && ( - /* User can edit/delete their own comment for a short window after posting */ - - {this.state.isEditable && ( - - Edit - - )} - - )} - {!isActive && } -
-
- {this.state.isEditing ? ( - - ) : ( -
- -
- )} -
-
- {isActive && ( -
-
- - - {!disableReply && ( - - - - )} -
-
- + {!disableReply && ( - -
+ )}
- )} -
+
+ + + + +
+
+ )}
+
+ ); + } +<<<<<<< HEAD {activeReplyBox === comment.id ? (
+======= + render() { + const { + depth, + comment, + activeReplyBox, + highlighted, + animateEnter, + } = this.props; + + if (!highlighted && this.commentIsRejected(comment)) { + return ; + } + + if (this.commentIsIgnored(comment)) { + return ; + } + + const rootClassName = cn( + 'talk-stream-comment-wrapper', + `talk-stream-comment-wrapper-level-${depth}`, + styles.root, + styles[`rootLevel${depth}`], + { + ...this.getConditionalClassNames(), + [styles.enter]: animateEnter, + } + ); + + const id = `c_${comment.id}`; + + return ( +
+ {this.renderComment()} + {activeReplyBox === comment.id && this.renderReplyBox()} + {this.renderRepliesContainer()} +>>>>>>> 8d147dbf47104cdcfb8c3bc2ebb02b6c73c7b8ab
); } diff --git a/client/coral-embed-stream/src/tabs/stream/components/Stream.js b/client/coral-embed-stream/src/tabs/stream/components/Stream.js index a431b1986..c8a304214 100644 --- a/client/coral-embed-stream/src/tabs/stream/components/Stream.js +++ b/client/coral-embed-stream/src/tabs/stream/components/Stream.js @@ -12,15 +12,11 @@ import RestrictedMessageBox from 'coral-framework/components/RestrictedMessageBo import t, { timeago } from 'coral-framework/services/i18n'; import CommentBox from '../containers/CommentBox'; import QuestionBox from '../../../components/QuestionBox'; -import { isCommentActive } from 'coral-framework/utils'; import { Tab, TabCount, TabPane } from 'coral-ui'; import cn from 'classnames'; import get from 'lodash/get'; -import { - getTopLevelParent, - attachCommentToParent, -} from '../../../graphql/utils'; +import { reverseCommentParentTree } from '../../../graphql/utils'; import AllCommentsPane from './AllCommentsPane'; import ExtendableTabPanel from '../../../containers/ExtendableTabPanel'; @@ -64,16 +60,10 @@ class Stream extends React.Component { viewAllComments, } = this.props; - // even though the permalinked comment is the highlighted one, we're displaying its parent + replies - let topLevelComment = getTopLevelParent(comment); - if (topLevelComment) { - // Inactive comments can be viewed by moderators and admins (e.g. using permalinks). - const isInactive = !isCommentActive(comment.status); - if (comment.parent && isInactive) { - // the highlighted comment is not active and as such not in the replies, so we - // attach it to the right parent. - topLevelComment = attachCommentToParent(topLevelComment, comment); - } + let topLevelComment = null; + if (comment) { + // Reverse the comment tree that we get from bottom-top (comment -> parent) to top-bottom (parent -> comment) + topLevelComment = reverseCommentParentTree(comment); } return ( @@ -112,7 +102,7 @@ class Stream extends React.Component { postComment={postComment} asset={asset} currentUser={currentUser} - highlighted={comment.id} + highlighted={comment} postFlag={postFlag} postDontAgree={postDontAgree} loadMore={loadNewReplies} diff --git a/client/coral-embed-stream/src/tabs/stream/containers/Comment.js b/client/coral-embed-stream/src/tabs/stream/containers/Comment.js index e5d42a86e..928bb098a 100644 --- a/client/coral-embed-stream/src/tabs/stream/containers/Comment.js +++ b/client/coral-embed-stream/src/tabs/stream/containers/Comment.js @@ -67,7 +67,7 @@ const withAnimateEnter = hoistStatics(BaseComponent => { return WithAnimateEnter; }); -const singleCommentFragment = gql` +export const singleCommentFragment = gql` fragment CoralEmbedStream_Comment_SingleComment on Comment { id body diff --git a/client/coral-embed-stream/src/tabs/stream/containers/Stream.js b/client/coral-embed-stream/src/tabs/stream/containers/Stream.js index e80719646..191490914 100644 --- a/client/coral-embed-stream/src/tabs/stream/containers/Stream.js +++ b/client/coral-embed-stream/src/tabs/stream/containers/Stream.js @@ -24,7 +24,7 @@ import { viewAllComments, } from '../../../actions/stream'; import Stream from '../components/Stream'; -import Comment from './Comment'; +import { default as Comment, singleCommentFragment } from './Comment'; import { withFragments, withEmit } from 'coral-framework/hocs'; import { getDefinitionName, @@ -282,7 +282,7 @@ StreamContainer.propTypes = { previousTab: PropTypes.string, }; -const commentFragment = gql` +const streamCommentFragment = gql` fragment CoralEmbedStream_Stream_comment on Comment { id status @@ -294,6 +294,18 @@ const commentFragment = gql` ${Comment.fragments.comment} `; +const streamSingleCommentFragment = gql` + fragment CoralEmbedStream_Stream_singleComment on Comment { + id + status + user { + id + } + ...${getDefinitionName(singleCommentFragment)} + } + ${singleCommentFragment} +`; + const COMMENTS_ADDED_SUBSCRIPTION = gql` subscription CommentAdded($assetId: ID!, $excludeIgnored: Boolean) { commentAdded(asset_id: $assetId) { @@ -303,7 +315,7 @@ const COMMENTS_ADDED_SUBSCRIPTION = gql` ...CoralEmbedStream_Stream_comment } } - ${commentFragment} + ${streamCommentFragment} `; const COMMENTS_EDITED_SUBSCRIPTION = gql` @@ -351,7 +363,7 @@ const LOAD_MORE_QUERY = gql` endCursor } } - ${commentFragment} + ${streamCommentFragment} `; const slots = [ @@ -398,7 +410,7 @@ const fragments = { ${nest( ` parent { - ...CoralEmbedStream_Stream_comment + ...CoralEmbedStream_Stream_singleComment ...nest } `, @@ -437,7 +449,8 @@ const fragments = { ...${getDefinitionName(Comment.fragments.asset)} } ${Comment.fragments.asset} - ${commentFragment} + ${streamCommentFragment} + ${streamSingleCommentFragment} `, }; diff --git a/client/coral-framework/actions/auth.js b/client/coral-framework/actions/auth.js index 0c4780548..17b1c38f9 100644 --- a/client/coral-framework/actions/auth.js +++ b/client/coral-framework/actions/auth.js @@ -63,13 +63,25 @@ export const setAuthToken = token => (dispatch, _, { localStorage }) => { export const handleSuccessfulLogin = (user, token) => ( dispatch, _, - { client, localStorage } + { client, localStorage, postMessage } ) => { + const { exp } = jwtDecode(token); + if (localStorage) { - localStorage.setItem('exp', jwtDecode(token).exp); + localStorage.setItem('exp', exp); localStorage.setItem('token', token); } + // Send the message via the messages service to the window.opener if it + // exists. + if (window.opener) { + postMessage.post( + actions.HANDLE_SUCCESSFUL_LOGIN, + { user, token }, + window.opener + ); + } + client.resetWebsocket(); dispatch({ diff --git a/client/coral-framework/components/Slot.js b/client/coral-framework/components/Slot.js index dfe2d80d5..952844ed0 100644 --- a/client/coral-framework/components/Slot.js +++ b/client/coral-framework/components/Slot.js @@ -72,7 +72,8 @@ class Slot extends React.Component { } = this.props; const { plugins } = this.context; let children = this.getChildren(); - const pluginConfig = get(reduxState, 'config.pluginConfig') || emptyConfig; + const pluginConfig = + get(reduxState, 'config.plugins_config') || emptyConfig; if (children.length === 0 && DefaultComponent) { const props = plugins.getSlotComponentProps( DefaultComponent, diff --git a/client/coral-framework/components/TalkProvider.js b/client/coral-framework/components/TalkProvider.js index 3164d8e9d..343d559ea 100644 --- a/client/coral-framework/components/TalkProvider.js +++ b/client/coral-framework/components/TalkProvider.js @@ -17,6 +17,7 @@ class TalkProvider extends React.Component { store: this.props.store, pymLocalStorage: this.props.pymLocalStorage, pymSessionStorage: this.props.pymSessionStorage, + postMessage: this.props.postMessage, }; } @@ -39,6 +40,7 @@ TalkProvider.childContextTypes = { pymSessionStorage: PropTypes.object, history: PropTypes.object, store: PropTypes.object, + postMessage: PropTypes.object, }; TalkProvider.propTypes = TalkProvider.childContextTypes; diff --git a/client/coral-framework/graphql/mutations.js b/client/coral-framework/graphql/mutations.js index f34a2cc88..1b3b4c6fc 100644 --- a/client/coral-framework/graphql/mutations.js +++ b/client/coral-framework/graphql/mutations.js @@ -698,7 +698,7 @@ export const withCloseAsset = withMutation( const fragmentId = `Asset_${id}`; const data = { __typename: 'Asset', - closedAt: new Date(), + closedAt: new Date().toISOString(), isClosed: true, }; proxy.writeFragment({ fragment, id: fragmentId, data }); diff --git a/client/coral-framework/hocs/index.js b/client/coral-framework/hocs/index.js index eb481de99..5e2e3dd40 100644 --- a/client/coral-framework/hocs/index.js +++ b/client/coral-framework/hocs/index.js @@ -10,6 +10,7 @@ export { default as withSignIn } from './withSignIn'; export { default as withSignUp } from './withSignUp'; export { default as withForgotPassword } from './withForgotPassword'; export { default as withSetUsername } from './withSetUsername'; +export { default as withPopupAuthHandler } from './withPopupAuthHandler'; export { default as withResendEmailConfirmation, } from './withResendEmailConfirmation'; diff --git a/client/coral-framework/hocs/withPopupAuthHandler.js b/client/coral-framework/hocs/withPopupAuthHandler.js new file mode 100644 index 000000000..ab2530e66 --- /dev/null +++ b/client/coral-framework/hocs/withPopupAuthHandler.js @@ -0,0 +1,54 @@ +import React from 'react'; +import hoistStatics from 'recompose/hoistStatics'; +import PropTypes from 'prop-types'; +import { HANDLE_SUCCESSFUL_LOGIN } from 'coral-framework/constants/auth'; +import { + handleSuccessfulLogin, + setAuthToken, +} from 'coral-framework/actions/auth'; + +/** + * WithPopupAuthHandler listens to successful logins over + * the `postMessage` service. + */ +export default hoistStatics(WrappedComponent => { + class WithPopupAuthHandler extends React.Component { + static contextTypes = { + store: PropTypes.object, + postMessage: PropTypes.object, + }; + + constructor(props, context) { + super(props, context); + context.postMessage.subscribe(this.handleAuth); + } + + componentWillUnmount() { + this.context.postMessage.unsubscribe(this.handleAuth); + } + + handleAuth = ({ name, data }) => { + if (name !== HANDLE_SUCCESSFUL_LOGIN) { + return; + } + + const { store } = this.context; + // data will contain the user and token. + const { user, token } = data; + + if (user && token) { + store.dispatch(handleSuccessfulLogin(user, token)); + } else if (token) { + store.dispatch(setAuthToken(token)); + } else { + console.error('Invalid auth data supplied', data); + } + }; + + render() { + return ; + } + } + + return WithPopupAuthHandler; +}); diff --git a/client/coral-framework/lib/action.js b/client/coral-framework/lib/action.js new file mode 100644 index 000000000..6f22d01e3 --- /dev/null +++ b/client/coral-framework/lib/action.js @@ -0,0 +1,21 @@ +export default class Action { + listeners = []; + + listen = cb => { + this.listeners.push(cb); + }; + + unlisten = cb => { + this.listeners = this.listeners.filter(i => i !== cb); + }; + + event = { listen: this.listen, unlisten: this.unlisten }; + + call(...args) { + this.listeners.forEach(cb => cb(...args)); + } + + asEvent() { + return this.event; + } +} diff --git a/client/coral-framework/reducers/config.js b/client/coral-framework/reducers/config.js index a3a0409eb..f7aebd9e2 100644 --- a/client/coral-framework/reducers/config.js +++ b/client/coral-framework/reducers/config.js @@ -1,9 +1,15 @@ import { MERGE_CONFIG } from '../constants/config'; +import { LOGOUT } from '../constants/auth'; const initialState = {}; export default function config(state = initialState, action) { switch (action.type) { + case LOGOUT: + return { + ...state, + auth_token: null, + }; case MERGE_CONFIG: return { ...state, diff --git a/client/coral-framework/services/bootstrap.js b/client/coral-framework/services/bootstrap.js index a7dd6df98..691404369 100644 --- a/client/coral-framework/services/bootstrap.js +++ b/client/coral-framework/services/bootstrap.js @@ -14,6 +14,7 @@ import { createPluginsService } from './plugins'; import { createNotificationService } from './notification'; import { createGraphQLRegistry } from './graphqlRegistry'; import { createGraphQLService } from './graphql'; +import { createPostMessage } from './postMessage'; import globalFragments from 'coral-framework/graphql/fragments'; import { createStorage, @@ -118,7 +119,7 @@ export async function createContext({ }); const staticConfig = getStaticConfiguration(); - let { LIVE_URI: liveUri } = staticConfig; + let { LIVE_URI: liveUri, STATIC_ORIGIN: origin } = staticConfig; if (liveUri == null) { // The protocol must match the origin protocol, secure/insecure. const protocol = location.protocol === 'https:' ? 'wss' : 'ws'; @@ -128,6 +129,8 @@ export async function createContext({ liveUri = `${protocol}://${location.host}${BASE_PATH}api/v1/live`; } + const postMessage = createPostMessage(origin); + const client = createClient({ uri: `${BASE_PATH}api/v1/graph/ql`, liveUri, @@ -158,6 +161,7 @@ export async function createContext({ pymLocalStorage, pymSessionStorage, inIframe, + postMessage, }; // Load framework fragments. diff --git a/client/coral-framework/services/postMessage.js b/client/coral-framework/services/postMessage.js new file mode 100644 index 000000000..ef9311e64 --- /dev/null +++ b/client/coral-framework/services/postMessage.js @@ -0,0 +1,87 @@ +import set from 'lodash/set'; +import has from 'lodash/has'; +import get from 'lodash/get'; +import remove from 'lodash/remove'; + +/** + * createPostMessage returns a service that deals with cross + * window communication using the postMessage API. + * @param {string} origin + * @param {string} scope + * @return {Object} postMessage service + */ +export function createPostMessage(origin, scope = 'client') { + // Store a reference to each listener added. + const listeners = {}; + + // withOriginCheck wraps a given handler for a messages event with a check to + // see if the origin matches. + const withOriginCheck = handler => { + return event => { + if (get(event, 'origin') !== origin) { + return; + } + + if (get(event, 'data.scope') !== scope) { + return; + } + + // Pass the handler the event details. + handler(event); + }; + }; + + // withParseData will parse the data. + const withParseData = handler => { + return event => { + const data = get(event, 'data.data'); + const name = get(event, 'data.name'); + if (!data || !name) { + return; + } + + handler({ data, name, event }); + }; + }; + + return { + post(name, data, target = window.opener) { + if (!target) { + return; + } + + // Serialize the message to be sent via postMessage. + const msg = { name, data, scope }; + + // Send the message. + target.postMessage(msg, origin); + }, + subscribe: (handler, target = window) => { + // If this handler is already attached to the target, detach it. + if (has(listeners, [target, handler])) { + this.unsubscribeFromMessages(handler, target); + } + + // Wrap the listener with a origin check. + const listener = withOriginCheck(withParseData(handler)); + + // Save a reference to the compiled listener. + set(listeners, [target, handler], listener); + + // Attach the listener to the target. + target.addEventListener('message', listener); + }, + unsubscribe: (handler, target = window) => { + if (!has(listeners, [target, handler])) { + return; + } + + const listener = get(listeners, [target, handler]); + + // Remove the listener from the target. + target.removeEventListener('message', listener); + + remove(listeners, [target, handler]); + }, + }; +} diff --git a/client/coral-framework/services/storage.js b/client/coral-framework/services/storage.js index de96fdf4c..66e2c96cd 100644 --- a/client/coral-framework/services/storage.js +++ b/client/coral-framework/services/storage.js @@ -1,9 +1,10 @@ import uuid from 'uuid/v4'; function getStorage(type) { - let storage = window[type], - x = '__storage_test__'; + let storage; try { + storage = window[type]; + const x = '__storage_test__'; storage.setItem(x, x); storage.removeItem(x); } catch (e) { @@ -11,6 +12,8 @@ function getStorage(type) { e instanceof DOMException && // everything except Firefox (e.code === 22 || + // SecurityError related to having 3rd party cookies disabled. + e.code === 18 || // Firefox e.code === 1014 || @@ -19,14 +22,18 @@ function getStorage(type) { // everything except Firefox e.name === 'QuotaExceededError' || // Firefox - e.name === 'NS_ERROR_DOM_QUOTA_REACHED') && - // acknowledge QuotaExceededError only if there's something already stored - storage.length !== 0; + e.name === 'NS_ERROR_DOM_QUOTA_REACHED'); if (!ignore) { - console.warning(e); // eslint-disable-line - return null; + console.warn(e); + } + + // When third party cookies are disabled, session storage is readable/ + // writable, but localStorage is not. Try to get the sessionStorage to use. + if (type !== 'sessionStorage') { + return getStorage('sessionStorage'); } } + return storage; } diff --git a/docs/_docs/04-03-additional-plugins.md b/docs/_docs/04-03-additional-plugins.md index 062904200..b88d8437c 100644 --- a/docs/_docs/04-03-additional-plugins.md +++ b/docs/_docs/04-03-additional-plugins.md @@ -118,3 +118,42 @@ Configuration: - `TALK_AKISMET_API_KEY` (**required**) - The Akismet API key located on your account page. - `TALK_AKISMET_SITE` (**required**) - The URL where you are embedding the comment stream on to provide context to Akismet. If you're hosting talk on https://talk.mynews.org/, and your news site is https://mynews.org/, then you should set this parameter to `https://mynews.org/` + +## talk-plugin-notifications + +Source: [plugins/talk-plugin-notifications](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-notifications){:target="_blank"} + +Enables the Notification system for sending out enabled email notifications to +users when they interact with Talk. By itself, this plugin will not send +anything. You need to enable one of the `talk-plugin-notifications-category-*` plugins. + +**Note that all `talk-plugin-notifications-*` plugins must be registered +*before* this plugin in order to work. For example:** + +```js +{ + "server": [ + // ... + "talk-plugin-notifications-category-reply", + "talk-plugin-notifications", + // ... + ] +} +``` +{:.no-copy} + +### talk-plugin-notifications-category-reply +{:.param} + +Source: [plugins/talk-plugin-notifications-category-reply](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-notifications-category-reply){:target="_blank"} + +Replies made to each user will trigger an email to be sent with the notification +details if enabled. + +### talk-plugin-notifications-category-featured +{:.param} + +Source: [plugins/talk-plugin-notifications-category-featured](https://github.com/coralproject/talk/tree/master/plugins/talk-plugin-notifications-category-featured){:target="_blank"} + +When a comment is featured (via the `talk-plugin-featured-comments` plugin), the +user will receive a notification email. diff --git a/docs/_sass/talk.scss b/docs/_sass/talk.scss index dfacc549c..4b779962c 100644 --- a/docs/_sass/talk.scss +++ b/docs/_sass/talk.scss @@ -264,7 +264,7 @@ pre { .toc { a { @extend .coral-link; - border-bottom: none; + border-bottom: none !important; } } diff --git a/graph/connectors.js b/graph/connectors.js index 976f05b71..3ba71fbfb 100644 --- a/graph/connectors.js +++ b/graph/connectors.js @@ -1,9 +1,23 @@ const debug = require('debug')('talk:graph:connectors'); const merge = require('lodash/merge'); +// Config. +const config = require('../config'); + +// Secrets. +const secrets = require('../secrets'); + // Errors. const errors = require('../errors'); +// Graph. +const { getBroker } = require('./subscriptions/broker'); +const { getPubsub } = require('./subscriptions/pubsub'); +const resolvers = require('./resolvers'); +const mutators = require('./mutators'); +const loaders = require('./loaders'); +const schema = require('./schema'); + // Models. const Action = require('../models/action'); const Asset = require('../models/asset'); @@ -28,7 +42,6 @@ const Moderation = require('../services/moderation'); const Mongoose = require('../services/mongoose'); const Passport = require('../services/passport'); const Plugins = require('../services/plugins'); -const Pubsub = require('../services/pubsub'); const Redis = require('../services/redis'); const Regex = require('../services/regex'); const Scraper = require('../services/scraper'); @@ -40,9 +53,11 @@ const Tokens = require('../services/tokens'); const Users = require('../services/users'); const Wordlist = require('../services/wordlist'); -// Connector. -const connectors = { +// Connectors. +const defaultConnectors = { errors, + config, + secrets, models: { Action, Asset, @@ -67,7 +82,6 @@ const connectors = { Mongoose, Passport, Plugins, - Pubsub, Redis, Regex, Scraper, @@ -79,14 +93,23 @@ const connectors = { Users, Wordlist, }, + graph: { + subscriptions: { getBroker, getPubsub }, + resolvers, + mutators, + loaders, + schema, + }, }; -module.exports = Plugins.get('server', 'connectors').reduce( +const connectors = Plugins.get('server', 'connectors').reduce( (defaultConnectors, { plugin, connectors: pluginConnectors }) => { debug(`adding plugin '${plugin.name}'`); // Merge in the plugin connectors. return merge(defaultConnectors, pluginConnectors); }, - connectors + defaultConnectors ); + +module.exports = connectors; diff --git a/graph/context.js b/graph/context.js index 35d84dd82..adf5be06a 100644 --- a/graph/context.js +++ b/graph/context.js @@ -1,12 +1,13 @@ const loaders = require('./loaders'); const mutators = require('./mutators'); -const uuid = require('uuid'); -const merge = require('lodash/merge'); +const uuid = require('uuid/v4'); const connectors = require('./connectors'); - +const { get, merge } = require('lodash'); const plugins = require('../services/plugins'); -const pubsub = require('../services/pubsub'); +const { getBroker } = require('./subscriptions/broker'); const debug = require('debug')('talk:graph:context'); +const { createLogger } = require('../services/logging'); +const { graphql } = require('graphql'); /** * Contains the array of plugins that provide context to the server, these top @@ -45,15 +46,16 @@ const decorateContextPlugins = (context, contextPlugins) => { * Stores the request context. */ class Context { - constructor(parent) { + constructor(ctx) { // Generate a new context id for the request if the parent doesn't provide // one. - this.id = parent.id || uuid.v4(); + this.id = ctx.id || uuid.v4(); + + // Attach a logger or create one. + this.log = ctx.log || createLogger('context', this.id); // Load the current logged in user to `user`, otherwise this will be null. - if (parent.user) { - this.user = parent.user; - } + this.user = get(ctx, 'user'); // Attach the connectors. this.connectors = connectors; @@ -68,14 +70,48 @@ class Context { this.plugins = decorateContextPlugins(this, contextPlugins); // Bind the publish/subscribe to the context. - this.pubsub = pubsub.getClient(); + this.pubsub = getBroker(); // Bind the parent context. - this.parent = parent; + this.parent = ctx; } /** + * graphql will execute a graph request for the current context. * + * @param {String} requestString A GraphQL language formatted string + * representing the requested operation. + * @param {Object} variableValues A mapping of variable name to runtime value + * to use for all variables defined in the requestString. + * @param {Object} rootValue The value provided as the first argument to + * resolver functions on the top level type (e.g. the query object type). + * @param {String} operationName The name of the operation to use if + * requestString contains multiple possible operations. Can be omitted if + * requestString contains only one operation. + * @returns {Promise} + */ + async graphql( + requestString, + variableValues = {}, + rootValue = {}, + operationName = undefined + ) { + // Perform the graph request directly using the graphql client. + return graphql( + // Use the connected graph schema. + this.connectors.graph.schema, + requestString, + rootValue, + // Use this, the context as the context. + this, + variableValues, + operationName + ); + } + + /** + * forSystem returns a system context object that can be used for internal + * operations. */ static forSystem() { const { models: { User } } = connectors; @@ -87,4 +123,15 @@ class Context { } } +// Attach the Context to the connectors. +connectors.graph.Context = Context; + +// Connect the connect based plugins after the server has started. +plugins.defer('server', 'connect', ({ plugin, connect }) => { + debug(`connecting plugin to connectors '${plugin.name}'`); + + // Pass the connectors down to the connect plugin. + connect(connectors); +}); + module.exports = Context; diff --git a/graph/index.js b/graph/index.js index c05d878e6..97974d30c 100644 --- a/graph/index.js +++ b/graph/index.js @@ -2,6 +2,7 @@ const schema = require('./schema'); const Context = require('./context'); const { createSubscriptionManager } = require('./subscriptions'); const { ENABLE_TRACING } = require('../config'); +const connectors = require('./connectors'); module.exports = { createGraphOptions: req => ({ @@ -10,11 +11,12 @@ module.exports = { // Load in the new context here, this will create the loaders + mutators for // the lifespan of this request. - context: new Context(req), + context: new Context(req.context), // Tracing request options, needed for Apollo Engine. tracing: ENABLE_TRACING, cacheControl: ENABLE_TRACING, }), createSubscriptionManager, + connectors, }; diff --git a/graph/loaders/users.js b/graph/loaders/users.js index a3ec3c54e..2c1e9fbac 100644 --- a/graph/loaders/users.js +++ b/graph/loaders/users.js @@ -1,12 +1,7 @@ const DataLoader = require('dataloader'); - const util = require('./util'); - const { SEARCH_OTHER_USERS } = require('../../perms/constants'); - -const UsersService = require('../../services/users'); const { escapeRegExp } = require('../../services/regex'); -const UserModel = require('../../models/user'); const mergeState = (query, state) => { const { status } = state; @@ -51,17 +46,14 @@ const mergeState = (query, state) => { } }; -const genUserByIDs = async (context, ids) => { +const genUserByIDs = async (ctx, ids) => { if (!ids || ids.length === 0) { return []; } - if (ids.length === 1) { - const user = await UsersService.findById(ids[0]); - return [user]; - } + const { connectors: { models: { User } } } = ctx; - return UsersService.findByIdArray(ids).then(util.singleJoinBy(ids, 'id')); + return User.find({ id: { $in: ids } }).then(util.singleJoinBy(ids, 'id')); }; /** @@ -71,10 +63,10 @@ const genUserByIDs = async (context, ids) => { * @param {Object} query query terms to apply to the users query */ const getUsersByQuery = async ( - { user }, + { user, connectors: { models: { User } } }, { limit, cursor, value = '', state, action_type, sortOrder } ) => { - let query = UserModel.find(); + let query = User.find(); if (action_type || state || value.length > 0) { if (!user || !user.can(SEARCH_OTHER_USERS)) { @@ -182,8 +174,11 @@ const getUsersByQuery = async ( * @return {Promise} resolves to the counts of the users from the * query */ -const getCountByQuery = async ({ user }, { action_type, state }) => { - let query = UserModel.find(); +const getCountByQuery = async ( + { user, connectors: { models: { User } } }, + { action_type, state } +) => { + const query = User.find(); if (action_type || state) { if (!user || !user.can(SEARCH_OTHER_USERS)) { @@ -203,7 +198,7 @@ const getCountByQuery = async ({ user }, { action_type, state }) => { } } - return UserModel.find(query).count(); + return query.count(); }; /** diff --git a/graph/resolvers/action.js b/graph/resolvers/action.js index 8a58cbbc0..ff827e481 100644 --- a/graph/resolvers/action.js +++ b/graph/resolvers/action.js @@ -1,4 +1,4 @@ -const { SEARCH_OTHER_USERS } = require('../../perms/constants'); +const { decorateUserField } = require('./util'); const Action = { __resolveType({ action_type }) { @@ -11,14 +11,8 @@ const Action = { return undefined; } }, - - // This will load the user for the specific action. We'll limit this to the - // admin users only or the current logged in user. - user({ user_id }, _, { loaders: { Users }, user }) { - if (user && (user.can(SEARCH_OTHER_USERS) || user_id === user.id)) { - return Users.getByID.load(user_id); - } - }, }; +decorateUserField(Action, 'user', 'user_id'); + module.exports = Action; diff --git a/graph/resolvers/comment.js b/graph/resolvers/comment.js index 37594ce49..7005701ec 100644 --- a/graph/resolvers/comment.js +++ b/graph/resolvers/comment.js @@ -1,4 +1,6 @@ -const { decorateWithTags } = require('./util'); +const { property } = require('lodash'); +const { SEARCH_ACTIONS } = require('../../perms/constants'); +const { decorateWithTags, decorateWithPermissionCheck } = require('./util'); const Comment = { hasParent({ parent_id }) { @@ -29,15 +31,8 @@ const Comment = { return Comments.getByQuery(query); }, - replyCount({ reply_count }) { - // A simple remap from the underlying database model to the graph model. - return reply_count; - }, - actions({ id }, _, { user, loaders: { Actions } }) { - if (!user || !user.can('SEARCH_ACTIONS')) { - return null; - } - + replyCount: property('reply_count'), + actions({ id }, _, { loaders: { Actions } }) { return Actions.getByID.load(id); }, action_summaries(comment, _, { loaders: { Actions } }) { @@ -65,4 +60,9 @@ const Comment = { // Decorate the Comment type resolver with a tags field. decorateWithTags(Comment); +// Protect direct action access. +decorateWithPermissionCheck(Comment, { + actions: [SEARCH_ACTIONS], +}); + module.exports = Comment; diff --git a/graph/resolvers/flag_action.js b/graph/resolvers/flag_action.js index f03fb6afe..b48d566c6 100644 --- a/graph/resolvers/flag_action.js +++ b/graph/resolvers/flag_action.js @@ -1,18 +1,11 @@ -const FlagAction = { - // Stored in the metadata, extract and return. - message({ metadata: { message } }) { - return message; - }, - reason({ group_id }) { - return group_id; - }, - user({ user_id }, _, { loaders: { Users } }) { - if (!user_id) { - return null; - } +const { decorateUserField } = require('./util'); +const { property } = require('lodash'); - return Users.getByID.load(user_id); - }, +const FlagAction = { + message: property('metadata.message'), + reason: property('group_id'), }; +decorateUserField(FlagAction, 'user', 'user_id'); + module.exports = FlagAction; diff --git a/graph/resolvers/flag_action_summary.js b/graph/resolvers/flag_action_summary.js index 9572d9743..e4c332b23 100644 --- a/graph/resolvers/flag_action_summary.js +++ b/graph/resolvers/flag_action_summary.js @@ -1,7 +1,7 @@ +const { property } = require('lodash'); + const FlagActionSummary = { - reason({ group_id }) { - return group_id; - }, + reason: property('group_id'), }; module.exports = FlagActionSummary; diff --git a/graph/resolvers/index.js b/graph/resolvers/index.js index 8da8859e1..74b006ebb 100644 --- a/graph/resolvers/index.js +++ b/graph/resolvers/index.js @@ -1,4 +1,4 @@ -const _ = require('lodash'); +const { merge } = require('lodash'); const debug = require('debug')('talk:graph:resolvers'); const Action = require('./action'); @@ -70,7 +70,7 @@ resolvers = plugins .reduce((acc, { plugin, resolvers }) => { debug(`added plugin '${plugin.name}'`); - return _.merge(acc, resolvers); + return merge(acc, resolvers); }, resolvers); module.exports = resolvers; diff --git a/graph/resolvers/root_query.js b/graph/resolvers/root_query.js index bf221610b..23fdef288 100644 --- a/graph/resolvers/root_query.js +++ b/graph/resolvers/root_query.js @@ -1,3 +1,4 @@ +const { decorateWithPermissionCheck } = require('./util'); const { SEARCH_ASSETS, SEARCH_OTHERS_COMMENTS, @@ -5,11 +6,7 @@ const { } = require('../../perms/constants'); const RootQuery = { - assets(_, { query }, { loaders: { Assets }, user }) { - if (user == null || !user.can(SEARCH_ASSETS)) { - return null; - } - + assets(_, { query }, { loaders: { Assets } }) { return Assets.getByQuery(query); }, asset(_, query, { loaders: { Assets } }) { @@ -33,11 +30,7 @@ const RootQuery = { return Comments.get.load(id); }, - async commentCount(_, { query }, { user, loaders: { Comments, Assets } }) { - if (user == null || !user.can(SEARCH_OTHERS_COMMENTS)) { - return null; - } - + async commentCount(_, { query }, { loaders: { Comments, Assets } }) { const { asset_url, asset_id } = query; if ( (!asset_id || asset_id.length === 0) && @@ -53,11 +46,7 @@ const RootQuery = { return Comments.getCountByQuery(query); }, - async userCount(_, { query }, { user, loaders: { Users } }) { - if (user == null || !user.can(SEARCH_OTHER_USERS)) { - return null; - } - + async userCount(_, { query }, { loaders: { Users } }) { return Users.getCountByQuery(query); }, @@ -72,23 +61,40 @@ const RootQuery = { }, // this returns an arbitrary user - user(_, { id }, { user, loaders: { Users } }) { - if (user == null || !user.can(SEARCH_OTHER_USERS)) { - return null; - } - + user(_, { id }, { loaders: { Users } }) { return Users.getByID.load(id); }, // This endpoint is used for loading the user moderation queues (users whose username has been flagged), // so hide it in the event that we aren't an admin. - users(_, { query }, { user, loaders: { Users } }) { - if (user == null || !user.can(SEARCH_OTHER_USERS)) { - return null; - } - + users(_, { query }, { loaders: { Users } }) { return Users.getByQuery(query); }, }; +// Protect some query fields that are privileged. +decorateWithPermissionCheck(RootQuery, { + assets: [SEARCH_ASSETS], + users: [SEARCH_OTHER_USERS], + userCount: [SEARCH_OTHER_USERS], + commentCount: [SEARCH_OTHERS_COMMENTS], +}); + +// Protect the user field so only users who have permission to look up another +// user may do so as well as a user looking up themselves. +decorateWithPermissionCheck( + RootQuery, + { + user: [SEARCH_OTHER_USERS], + }, + (obj, { id }, { user }) => { + if (user && user.id === id) { + return true; + } + + // We don't return false because we want to fallthrough to the permission + // check if the custom check fails. + } +); + module.exports = RootQuery; diff --git a/graph/resolvers/subscription.js b/graph/resolvers/subscription.js index aa5d45565..ace5b1a0d 100644 --- a/graph/resolvers/subscription.js +++ b/graph/resolvers/subscription.js @@ -1,40 +1,23 @@ -const Subscription = { - commentAdded(comment) { - return comment; - }, - commentEdited(comment) { - return comment; - }, - commentAccepted(comment) { - return comment; - }, - commentRejected(comment) { - return comment; - }, - commentReset(comment) { - return comment; - }, - commentFlagged(comment) { - return comment; - }, - userBanned(user) { - return user; - }, - userSuspended(user) { - return user; - }, - usernameApproved(user) { - return user; - }, - usernameRejected(user) { - return user; - }, - usernameFlagged(user) { - return user; - }, - usernameChanged(payload) { - return payload; - }, -}; +const Subscription = {}; + +// All of the subscription endpoints need to have an object to serialize when +// pushing out via PubSub, this simply ensures that all these entries will +// return the root object from the subscription to the PubSub framework. +[ + 'commentAdded', + 'commentEdited', + 'commentAccepted', + 'commentRejected', + 'commentReset', + 'commentFlagged', + 'userBanned', + 'userSuspended', + 'usernameApproved', + 'usernameRejected', + 'usernameFlagged', + 'usernameChanged', +].forEach(field => { + Subscription[field] = obj => obj; +}); module.exports = Subscription; diff --git a/graph/resolvers/tag_link.js b/graph/resolvers/tag_link.js index 5df43d05b..b81d5c743 100644 --- a/graph/resolvers/tag_link.js +++ b/graph/resolvers/tag_link.js @@ -1,11 +1,7 @@ -const { SEARCH_OTHER_USERS } = require('../../perms/constants'); +const { decorateUserField } = require('./util'); -const TagLink = { - assigned_by({ assigned_by }, _, { user, loaders: { Users } }) { - if (user && user.can(SEARCH_OTHER_USERS) && assigned_by != null) { - return Users.getByID.load(assigned_by); - } - }, -}; +const TagLink = {}; + +decorateUserField(TagLink, 'assigned_by'); module.exports = TagLink; diff --git a/graph/resolvers/user.js b/graph/resolvers/user.js index c72a5923c..46fe0ac3c 100644 --- a/graph/resolvers/user.js +++ b/graph/resolvers/user.js @@ -1,4 +1,8 @@ -const { decorateWithTags } = require('./util'); +const { + decorateWithTags, + decorateWithPermissionCheck, + checkSelfField, +} = require('./util'); const KarmaService = require('../../services/karma'); const { SEARCH_ACTIONS, @@ -7,86 +11,65 @@ const { VIEW_USER_ROLE, LIST_OWN_TOKENS, VIEW_USER_STATUS, + VIEW_USER_EMAIL, } = require('../../perms/constants'); +const { property } = require('lodash'); const User = { action_summaries(user, _, { loaders: { Actions } }) { return Actions.getSummariesByItem.load(user); }, - actions({ id }, _, { user, loaders: { Actions } }) { - // Only return the actions if the user is not an admin. - if (user && user.can(SEARCH_ACTIONS)) { - return Actions.getByID.load(id); - } + actions({ id }, _, { loaders: { Actions } }) { + return Actions.getByID.load(id); }, - comments({ id }, { query }, { loaders: { Comments }, user }) { - // If there is no user, or there is a user, but they are requesting someone - // else's comments, and they aren't allowed, don't return then anything! - if (!user || (user.id !== id && !user.can(SEARCH_OTHERS_COMMENTS))) { - return null; - } - + comments({ id }, { query }, { loaders: { Comments } }) { // Set the author id on the query. query.author_id = id; return Comments.getByQuery(query); }, - profiles({ profiles }, _, { user }) { - // if the user is not an admin, do not return the profiles - if (user && user.can(SEARCH_OTHER_USERS)) { - return profiles; - } - - return null; - }, - tokens({ id, tokens }, args, { user }) { - if (!user || (user.id !== id && !user.can(LIST_OWN_TOKENS))) { - return null; - } - - return tokens; - }, - ignoredUsers({ id }, args, { user, loaders: { Users } }) { - // Only allow a logged in user that is either the current user or is a staff - // member to access the ignoredUsers of a given user. - if (!user || (user.id !== id && !user.can(SEARCH_OTHER_USERS))) { - return null; - } + ignoredUsers({ ignoresUsers }, args, { user, loaders: { Users } }) { // Return nothing if there is nothing to query for. if (!user.ignoresUsers || user.ignoresUsers.length <= 0) { return []; } - return Users.getByID.loadMany(user.ignoresUsers); - }, - role({ id, role }, _, { user }) { - // If the user is not an admin, only return the current user's roles. - if (user && (user.can(VIEW_USER_ROLE) || user.id === id)) { - return role; - } - - return null; + return Users.getByID.loadMany(ignoresUsers); }, // Extract the reliability from the user metadata if they have permission. - reliable(user, _, { user: requestingUser }) { - if (requestingUser && requestingUser.can(SEARCH_ACTIONS)) { - return KarmaService.model(user); - } - }, + reliable: user => KarmaService.model(user), - state(user, args, ctx) { - if ( - ctx.user && - (ctx.user.id === user.id || ctx.user.can(VIEW_USER_STATUS)) - ) { - return user; - } - }, + // The state requires the whole user object to make decisions. + state: user => user, + + // Get the first email on the user. + email: property('firstEmail'), }; // Decorate the User type resolver with a tags field. decorateWithTags(User); +// decorate the fields on the User resolver with a permission check where the +// current user can also get their own properties. +decorateWithPermissionCheck( + User, + { + actions: [SEARCH_ACTIONS], + email: [VIEW_USER_EMAIL], + state: [VIEW_USER_STATUS], + role: [VIEW_USER_ROLE], + ignoredUsers: [SEARCH_OTHER_USERS], + tokens: [LIST_OWN_TOKENS], + profiles: [SEARCH_OTHER_USERS], + comments: [SEARCH_OTHERS_COMMENTS], + }, + checkSelfField('id') +); + +// Decorate the fields on the User resolver where the current user has no impact +// on the resolvability of a field. +decorateWithPermissionCheck(User, { reliable: [SEARCH_ACTIONS] }); + module.exports = User; diff --git a/graph/resolvers/user_state.js b/graph/resolvers/user_state.js index 0436101e0..8d1843a43 100644 --- a/graph/resolvers/user_state.js +++ b/graph/resolvers/user_state.js @@ -1,14 +1,12 @@ +const { decorateWithPermissionCheck, checkSelfField } = require('./util'); const { VIEW_USER_STATUS } = require('../../perms/constants'); -const UserState = { - status: (user, args, ctx) => { - if ( - ctx.user && - (ctx.user.id === user.id || ctx.user.can(VIEW_USER_STATUS)) - ) { - return user.status; - } - }, -}; +const UserState = {}; + +decorateWithPermissionCheck( + UserState, + { status: [VIEW_USER_STATUS] }, + checkSelfField('id') +); module.exports = UserState; diff --git a/graph/resolvers/util.js b/graph/resolvers/util.js index 992148b4f..cec2a71dd 100644 --- a/graph/resolvers/util.js +++ b/graph/resolvers/util.js @@ -2,59 +2,167 @@ const { ADD_COMMENT_TAG, SEARCH_OTHER_USERS, } = require('../../perms/constants'); -const property = require('lodash/property'); +const { property, isBoolean } = require('lodash'); /** - * Decorates the typeResolver with the tags field. + * getResolver will get the resolver from the typeResolver or apply the default + * resolver. + * + * @param {Object} typeResolver the type resolver + * @param {String} field the field name of the resolver we're getting */ -const decorateWithTags = typeResolver => { - typeResolver.tags = ({ tags = [] }, _, { user }) => { - if (user && user.can(ADD_COMMENT_TAG)) { - return tags; +const getResolver = (typeResolver, field) => { + if (field in typeResolver) { + return typeResolver[field]; + } + + return property(field); +}; + +/** + * + * @param {Object} typeResolver the type resolver + * @param {String} field the name of the field being wrapped + * @param {Function} customCheck the function that can return a boolean + * indicating the resolution status + * @param {Function} skipFieldResolver the optional skip resolver that can be used + * skip out from the oldFieldResolver. + */ +const wrapCheck = ( + typeResolver, + field, + customCheck, + skipFieldResolver = getResolver(typeResolver, field) +) => { + // Cache the old field resolver. In the event that the check does not return + // with a boolean, we'll use this. + const oldFieldResolver = getResolver(typeResolver, field); + + // Override the field resolver on the type resolver with this wrapped + // function. + typeResolver[field] = (obj, args, ctx, info) => { + const decision = customCheck(obj, args, ctx, info); + if (isBoolean(decision)) { + if (decision) { + // The custom check returns a boolean true, so we should execute the + // underlying field resolver (which may just be the old resolver). + return skipFieldResolver(obj, args, ctx, info); + } + + // The custom check returns a boolean false, then we should return null, + // because the check explicity said that we weren't allowed to access that + // field. + return null; } - return tags.filter(t => t.tag.permissions.public); + // The custom check yielded no decision, so we should just fall back to the + // oldFieldResolver. + return oldFieldResolver(obj, args, ctx, info); }; }; +/** + * checkPermissions checks that the current user has all the required + * permissions. + * + * @param {Object} ctx graph context + * @param {Array} permissions permissions that the user must have + */ +const checkPermissions = (ctx, permissions) => + !ctx.user || !ctx.user.can(...permissions); + +/** + * wrapCheckPermissions will wrap a specific field with a permission check. + * + * @param {Object} typeResolver the type resolver + * @param {String} field the field name of the resolver we're wrapping + * @param {Array} permissions array of permissions to check against + * @param {Function} fieldResolver base resolver for the field + */ +const wrapCheckPermissions = ( + typeResolver, + field, + permissions, + skipFieldResolver = getResolver(typeResolver, field) +) => + wrapCheck( + typeResolver, + field, + (obj, args, ctx) => !checkPermissions(ctx, permissions), + skipFieldResolver + ); + /** * decorateWithPermissionCheck will decorate the field resolver with * permission checks. * * @param {Object} typeResolver the type resolver * @param {Object} protect the object with field -> Array of permissions + * @param {Function} customCheck a function that can return a boolean based on a + * custom check */ -const decorateWithPermissionCheck = (typeResolver, protect) => { +const decorateWithPermissionCheck = ( + typeResolver, + protect, + customCheck = null +) => { for (const [field, permissions] of Object.entries(protect)) { - let fieldResolver = property(field); - if (field in typeResolver) { - fieldResolver = typeResolver[field]; + const baseFieldResolver = getResolver(typeResolver, field); + wrapCheckPermissions(typeResolver, field, permissions, baseFieldResolver); + + if (customCheck !== null) { + wrapCheck(typeResolver, field, customCheck, baseFieldResolver); } - - typeResolver[field] = (obj, args, ctx, info) => { - if (!ctx.user || !ctx.user.can(...permissions)) { - return null; - } - - return fieldResolver(obj, args, ctx, info); - }; } }; /** - * decorateUserField will decorate the user field accesses with correct - * permission checks. + * checkSelf will check if the current object is the same as the current user. + * + * @param {String} referenceField the field for the user id to check. + */ +const checkSelfField = referenceField => (obj, args, ctx) => { + if ( + ctx.user && + obj[referenceField] !== null && + ctx.user.id === obj[referenceField] + ) { + return true; + } +}; + +/** + * wrapCheckSelf wraps a typeResolver with a check for self (if the type is + * referencing the current user). * * @param {Object} typeResolver the type resolver * @param {String} field the field to decorate + * @param {String} referenceField the field to pull the user id from. + * @param {Function} fieldResolver base resolver for the field */ -const decorateUserField = (typeResolver, field) => { +const wrapCheckSelf = ( + typeResolver, + field, + referenceField = field, + fieldResolver = getResolver(typeResolver, field) +) => + wrapCheck(typeResolver, field, checkSelfField(referenceField), fieldResolver); + +/** + * decorateUserField will decorate the user field accesses with correct + * permission checks and will load the user. + * + * @param {Object} typeResolver the type resolver + * @param {String} field the field to decorate + * @param {String} referenceField the field to pull the user id from. + */ +const decorateUserField = (typeResolver, field, referenceField = field) => { // The default resolver for the user decorator is loading the user by id. let fieldResolver = (obj, args, ctx) => { - if (!obj[field]) { + if (!obj[referenceField]) { return null; } - return ctx.loaders.Users.getByID.load(obj[field]); + return ctx.loaders.Users.getByID.load(obj[referenceField]); }; // The resolver can be overridden however. This decorator will simply wrap the @@ -63,16 +171,39 @@ const decorateUserField = (typeResolver, field) => { fieldResolver = typeResolver[field]; } - typeResolver[field] = (obj, args, ctx, info) => { - if ( - !ctx.user || - obj[field] === null || - (ctx.user.id !== obj[field] && !ctx.user.can(SEARCH_OTHER_USERS)) - ) { - return null; + // Wrap the current fieldResolver with the resolver which will return the + // user. + wrapCheckPermissions( + typeResolver, + field, + [SEARCH_OTHER_USERS], + fieldResolver + ); + + // Wrap the checked resolver with a check to see if the current user is the + // one being retrieved, in which case we should allow it. + wrapCheckSelf(typeResolver, field, referenceField, fieldResolver); +}; + +/** + * decorateWithTags decorates a typeResolver with a tags getter that will + * sanitize the tag output for users without permission to see non-public + * tags. + * + * @param {Object} typeResolver base type resolver + * @param {Function} fieldResolver the field resolver that gets the tags + */ +const decorateWithTags = ( + typeResolver, + fieldResolver = getResolver(typeResolver, 'tags') +) => { + typeResolver.tags = async (obj, args, ctx, info) => { + const tags = await fieldResolver(obj, args, ctx, info); + if (checkPermissions(ctx, [ADD_COMMENT_TAG])) { + return tags; } - return fieldResolver(obj, args, ctx, info); + return tags.filter(t => t.tag.permissions.public); }; }; @@ -80,4 +211,5 @@ module.exports = { decorateUserField, decorateWithTags, decorateWithPermissionCheck, + checkSelfField, }; diff --git a/graph/subscriptions/broker.js b/graph/subscriptions/broker.js new file mode 100644 index 000000000..93f57d219 --- /dev/null +++ b/graph/subscriptions/broker.js @@ -0,0 +1,48 @@ +const { EventEmitter2 } = require('eventemitter2'); +const debug = require('debug')('talk:graph:subscriptions:broker'); +const { getPubsub } = require('./pubsub'); + +/** + * Broker acts as a pubsub client adapter. Any calls to publish will push into + * the PubSub client and the local event emitter. + */ +class Broker extends EventEmitter2 { + constructor(pubsub) { + // Create the underlying event emitter. + super({ + wildcard: true, // Allow wildcard listeners. + maxListeners: 0, // Disable maximum for listeners. + }); + + this.pubsub = pubsub; + } + + /** + * Publishes the event out to the pubsub system and to the broker. + * + * @param {String} event the name of the event to publish + * @param {Any} args the + */ + publish(event, ...args) { + debug(`publish:${event}`); + this.pubsub.publish(event, ...args); + this.emit(event, ...args); + } +} + +let client = null; +const getBroker = () => { + if (client !== null) { + return client; + } + + // Create the new Broker to manage events being published out to + // the pubsub so that we may intercept. + client = new Broker(getPubsub()); + + debug('created'); + + return client; +}; + +module.exports.getBroker = getBroker; diff --git a/graph/subscriptions.js b/graph/subscriptions/index.js similarity index 87% rename from graph/subscriptions.js rename to graph/subscriptions/index.js index 948d10a8f..5ade76feb 100644 --- a/graph/subscriptions.js +++ b/graph/subscriptions/index.js @@ -2,18 +2,18 @@ const { SubscriptionManager } = require('graphql-subscriptions'); const { SubscriptionServer } = require('subscriptions-transport-ws'); const debug = require('debug')('talk:graph:subscriptions'); -const pubsub = require('../services/pubsub'); -const schema = require('./schema'); -const Context = require('./context'); -const plugins = require('../services/plugins'); +const { getPubsub } = require('./pubsub'); +const schema = require('../schema'); +const Context = require('../context'); +const plugins = require('../../services/plugins'); -const { deserializeUser } = require('../services/subscriptions'); +const { deserializeUser } = require('../../services/subscriptions'); const setupFunctions = require('./setupFunctions'); const ms = require('ms'); -const { KEEP_ALIVE } = require('../config'); +const { KEEP_ALIVE } = require('../../config'); -const { BASE_PATH } = require('../url'); +const { BASE_PATH } = require('../../url'); // Collect all the plugin hooks that should be executed onConnect and // onDisconnect. @@ -99,7 +99,7 @@ const createSubscriptionManager = server => { subscriptionManager: new SubscriptionManager({ schema, - pubsub: pubsub.getClient(), + pubsub: getPubsub(), setupFunctions, }), onConnect, diff --git a/graph/subscriptions/pubsub.js b/graph/subscriptions/pubsub.js new file mode 100644 index 000000000..54761bdfb --- /dev/null +++ b/graph/subscriptions/pubsub.js @@ -0,0 +1,29 @@ +const { RedisPubSub } = require('graphql-redis-subscriptions'); +const { createClient: createRedisClient } = require('../../services/redis'); +const debug = require('debug')('talk:graph:subscriptions:pubsub'); + +/** + * getPubsub returns the pubsub singleton for this instance. + */ +let pubsub = null; +const getPubsub = () => { + if (pubsub !== null) { + return pubsub; + } + + // Create the publisher and subscriber redis clients. + const publisher = createRedisClient(); + const subscriber = createRedisClient(); + + // Create the new PubSub client, we only need one per instance of Talk. + pubsub = new RedisPubSub({ + publisher, + subscriber, + }); + + debug('created'); + + return pubsub; +}; + +module.exports.getPubsub = getPubsub; diff --git a/graph/setupFunctions.js b/graph/subscriptions/setupFunctions.js similarity index 98% rename from graph/setupFunctions.js rename to graph/subscriptions/setupFunctions.js index 12d9d5685..467c4e98f 100644 --- a/graph/setupFunctions.js +++ b/graph/subscriptions/setupFunctions.js @@ -11,11 +11,11 @@ const { SUBSCRIBE_ALL_USERNAME_APPROVED, SUBSCRIBE_ALL_USERNAME_FLAGGED, SUBSCRIBE_ALL_USERNAME_CHANGED, -} = require('../perms/constants'); +} = require('../../perms/constants'); const merge = require('lodash/merge'); const debug = require('debug')('talk:graph:setupFunctions'); -const plugins = require('../services/plugins'); +const plugins = require('../../services/plugins'); const setupFunctions = { commentAdded: (options, args, comment, context) => { diff --git a/graph/typeDefs.graphql b/graph/typeDefs.graphql index cec8e0015..f108a7ad4 100644 --- a/graph/typeDefs.graphql +++ b/graph/typeDefs.graphql @@ -63,7 +63,7 @@ type Token { } type UserProfile { - # the id is an identifier for the user profile (email, facebook id, etc) + # The id is an identifier for the user profile (email, facebook id, etc) id: String! # name of the provider attached to the authentication mode @@ -184,13 +184,17 @@ type User { # Actions completed on the parent. actions: [Action!] - # the current roles of the user. + # The current roles of the user. role: USER_ROLES - # the current profiles of the user. + # The current profiles of the user. profiles: [UserProfile] - # the tags on the user + # The primary email address of the user. Only accessible to Administrators or + # the current user. + email: String + + # The tags on the user. tags: [TagLink!] # ignored users. @@ -421,7 +425,7 @@ input CommentCountQuery { # The URL that the asset is located on. asset_url: String - # the parent of the comment that we want to retrieve. + # The parent of the comment that we want to retrieve. parent_id: ID # comments returned will only be ones which have at least one action of this @@ -479,13 +483,13 @@ type Comment { # The body history of the comment. body_history: [CommentBodyHistory!]! - # the tags on the comment + # The tags on the comment tags: [TagLink!] - # the user who authored the comment. + # The user who authored the comment. user: User - # the replies that were made to the comment. + # The replies that were made to the comment. replies(query: RepliesQuery = {}): CommentConnection! # replyCount is the number of replies with a depth of 1. Only direct replies @@ -765,7 +769,7 @@ type Settings { infoBoxContent: String # questionBoxEnable will enable the Question Box's content to be visible above - # the comment box. + # The comment box. questionBoxEnable: Boolean # questionBoxContent is the content of the Question Box. @@ -858,7 +862,7 @@ type Asset { # The date that the asset was created. created_at: Date - # the tags on the asset + # The tags on the asset tags: [TagLink!] # The author(s) of the asset. @@ -1091,7 +1095,7 @@ input AssetSettingsInput { moderation: MODERATION_MODE # questionBoxEnable will enable the Question Boxs' content to be visible above - # the comment box. + # The comment box. questionBoxEnable: Boolean # questionBoxContent is the content of the Question Box. @@ -1167,7 +1171,7 @@ input ModifyTagInput { item_type: TAGGABLE_ITEM_TYPE! # asset_id is used when the item_type is `COMMENTS`, the is needed to rectify - # the settings to get the asset specific tags/settings. + # The settings to get the asset specific tags/settings. asset_id: ID } @@ -1225,7 +1229,7 @@ input UpdateSettingsInput { infoBoxContent: String # questionBoxEnable will enable the Question Box's content to be visible above - # the comment box. + # The comment box. questionBoxEnable: Boolean # questionBoxContent is the content of the Question Box. diff --git a/jest.config.js b/jest.config.js index 654b72cd0..7150d1066 100644 --- a/jest.config.js +++ b/jest.config.js @@ -27,6 +27,8 @@ module.exports = { '\\.ya?ml$': '/test/client/yamlTransformer.js', }, + testResultsProcessor: process.env.JEST_REPORTER, + moduleNameMapper: { '^plugin-api\\/(.*)$': '/plugin-api/$1', '^plugins\\/(.*)$': '/plugins/$1', diff --git a/jobs/index.js b/jobs/index.js new file mode 100644 index 000000000..b64e59362 --- /dev/null +++ b/jobs/index.js @@ -0,0 +1,5 @@ +const jobs = [require('./mailer')]; + +const process = () => jobs.forEach(job => job()); + +module.exports = { process }; diff --git a/jobs/mailer.js b/jobs/mailer.js new file mode 100644 index 000000000..6415f5241 --- /dev/null +++ b/jobs/mailer.js @@ -0,0 +1,147 @@ +const { task } = require('../services/mailer'); +const nodemailer = require('nodemailer'); +const debug = require('debug')('talk:jobs:mailer'); +const Context = require('../graph/context'); +const { get } = require('lodash'); + +const { + SMTP_HOST, + SMTP_USERNAME, + SMTP_PORT, + SMTP_PASSWORD, + SMTP_FROM_ADDRESS, +} = require('../config'); + +// parseSMTPPort will return the port for SMTP. +const parseSMTPPort = () => { + if (!SMTP_PORT) { + return 25; + } + + try { + return parseInt(SMTP_PORT); + } catch (e) { + throw new Error('TALK_SMTP_PORT is not an integer'); + } +}; + +// createTransport will create a new transport. +const createTransport = () => { + const options = { + host: SMTP_HOST, + }; + + if (SMTP_USERNAME && SMTP_PASSWORD) { + options.auth = { + user: SMTP_USERNAME, + pass: SMTP_PASSWORD, + }; + } + + // Get the SMTP port. + options.port = parseSMTPPort(); + + return nodemailer.createTransport(options); +}; + +// sharedTransport is the transport singleton. +let sharedTransport; + +// getTransport will retrieve the mailer transport singleton. +const getTransport = () => { + if (sharedTransport) { + return sharedTransport; + } + + // enabled is true when the required configuration is available. When testing + // is enabled, we will be simulating that emails are being sent, because in a + // production system, emails should and would be sent. + + // If the transport details aren't available, we will return null as the + // transport. + if (!SMTP_HOST || !SMTP_FROM_ADDRESS) { + return null; + } + + // Create the transport. + sharedTransport = createTransport(); + + return sharedTransport; +}; + +// getEmailAddress will retrieve the email address to send the message to from +// the job data. +const getEmailAddress = async ({ email, user }) => { + // If the message has a specific email already to sent it to, just assign + // that to the message. If the email does not have an email, and instead has + // a user id, then we should lookup the user with the graph and get their + // email. + if (email) { + return email; + } else { + // Get the user to send the message to. + const ctx = Context.forSystem(); + + const { data, errors } = await ctx.graphql( + ` + query GetUserEmail($user: ID!) { + user(id: $user) { + email + } + } + `, + { user } + ); + if (errors) { + throw errors; + } + + const email = get(data, 'user.email'); + if (!email) { + throw errors.ErrMissingEmail; + } + + return email; + } +}; + +// processJob will handle new jobs sent via this queue. +const processJob = transport => async ({ id, data }, done) => { + const { message } = data; + + // Get the email address from the job data. + message.to = await getEmailAddress(data); + + debug(`Starting to send mail for Job[${id}]`); + + // Actually send the email. + transport.sendMail(message, err => { + if (err) { + debug(`Failed to send mail for Job[${id}]:`, err); + return done(err); + } + + debug(`Finished sending mail for Job[${id}]`); + return done(); + }); +}; + +/** + * Start the queue processor for the mailer job. + */ +module.exports = () => { + // Get a transport. + const transport = getTransport(); + if (transport === null) { + console.warn( + new Error( + 'sending email is not enabled because required configuration is not available' + ) + ); + return; + } + + debug(`Now processing ${task.name} jobs`); + + return task.process(processJob(transport)); +}; diff --git a/jobs/scraper.js b/jobs/scraper.js new file mode 100644 index 000000000..424304ba8 --- /dev/null +++ b/jobs/scraper.js @@ -0,0 +1,76 @@ +const Asset = require('../models/asset'); +const scraper = require('../services/scraper'); +const Assets = require('../services/assets'); +const debug = require('debug')('talk:jobs:scraper'); +const metascraper = require('metascraper'); + +/** + * Scrapes the given asset for metadata. + */ +async function scrape(asset) { + return metascraper.scrapeUrl( + asset.url, + Object.assign({}, metascraper.RULES, { + section: $ => $('meta[property="article:section"]').attr('content'), + modified: $ => $('meta[property="article:modified"]').attr('content'), + }) + ); +} + +/** + * Updates an Asset based on scraped asset metadata. + */ +function update(id, meta) { + return Asset.update( + { id }, + { + $set: { + title: meta.title || '', + description: meta.description || '', + image: meta.image ? meta.image : '', + author: meta.author || '', + publication_date: meta.date || '', + modified_date: meta.modified || '', + section: meta.section || '', + scraped: new Date(), + }, + } + ); +} + +module.exports = () => { + debug(`Now processing ${scraper.task.name} jobs`); + + scraper.task.process(async (job, done) => { + debug(`Starting on Job[${job.id}] for Asset[${job.data.asset_id}]`); + + try { + // Find the asset, or complain that it doesn't exist. + const asset = await Assets.findById(job.data.asset_id); + if (!asset) { + return done(new Error('asset not found')); + } + + // Scrape the metadata from the asset. + const meta = await scrape(asset); + + debug( + `Scraped ${JSON.stringify(meta)} on Job[${job.id}] for Asset[${ + job.data.asset_id + }]` + ); + + // Assign the metadata retrieved for the asset to the db. + await update(job.data.asset_id, meta); + } catch (err) { + debug( + `Failed to scrape on Job[${job.id}] for Asset[${job.data.asset_id}]:`, + err + ); + return done(err); + } + + debug(`Finished on Job[${job.id}] for Asset[${job.data.asset_id}]`); + done(); + }); +}; diff --git a/middleware/context.js b/middleware/context.js new file mode 100644 index 000000000..57620f827 --- /dev/null +++ b/middleware/context.js @@ -0,0 +1,8 @@ +const Context = require('../graph/context'); + +// Attach a new context to the request. +module.exports = (req, res, next) => { + req.context = new Context(req); + + next(); +}; diff --git a/middleware/staticTemplate.js b/middleware/staticTemplate.js index 6848e59e1..5a7c34b60 100644 --- a/middleware/staticTemplate.js +++ b/middleware/staticTemplate.js @@ -1,6 +1,12 @@ const SettingsService = require('../services/settings'); -const { BASE_URL, BASE_PATH, MOUNT_PATH, STATIC_URL } = require('../url'); +const { + BASE_URL, + BASE_PATH, + MOUNT_PATH, + STATIC_URL, + STATIC_ORIGIN, +} = require('../url'); const { RECAPTCHA_PUBLIC, WEBSOCKET_LIVE_URI } = require('../config'); @@ -15,6 +21,7 @@ const TEMPLATE_LOCALS = { TALK_RECAPTCHA_PUBLIC: RECAPTCHA_PUBLIC, LIVE_URI: WEBSOCKET_LIVE_URI, STATIC_URL, + STATIC_ORIGIN, }, }; diff --git a/models/setting.js b/models/setting.js index c4b20a4ed..1cca9c989 100644 --- a/models/setting.js +++ b/models/setting.js @@ -99,6 +99,12 @@ const SettingSchema = new Schema( default: 30 * 1000, }, tags: [TagSchema], + + // Additional metadata to let plugins write settings. + metadata: { + default: {}, + type: Object, + }, }, { timestamps: { diff --git a/nightwatch.conf.js b/nightwatch.conf.js index ac5887e51..76a5c291b 100644 --- a/nightwatch.conf.js +++ b/nightwatch.conf.js @@ -49,5 +49,12 @@ module.exports = { }, }, }, + 'firefox-headless': { + desiredCapabilities: { + 'moz:firefoxOptions': { + args: ['-headless'], + }, + }, + }, }, }; diff --git a/package.json b/package.json index 68cbc809e..e54ad11d4 100644 --- a/package.json +++ b/package.json @@ -78,6 +78,7 @@ "bcryptjs": "^2.4.3", "bowser": "^1.7.2", "brotli-webpack-plugin": "^0.5.0", + "bunyan": "^1.8.12", "cli-table": "^0.3.1", "clipboard": "^1.7.1", "colors": "^1.1.2", @@ -114,15 +115,17 @@ "graphql-tag": "^1.2.3", "graphql-tools": "^0.10.1", "hammerjs": "^2.0.8", + "hard-source-webpack-plugin": "^0.6.0", "helmet": "3.8.2", "history": "^3.0.0", + "hjson": "^3.1.1", + "hjson-loader": "^1.0.0", "immutability-helper": "^2.2.0", "imports-loader": "^0.7.1", "inquirer": "^3.2.2", "inquirer-autocomplete-prompt": "^0.12.1", "ioredis": "3.1.4", "joi": "^13.0.0", - "json-loader": "^0.5.7", "jsonwebtoken": "^8.0.0", "jwt-decode": "^2.2.0", "keymaster": "^1.6.2", @@ -136,7 +139,7 @@ "minimist": "^1.2.0", "moment": "^2.18.1", "mongoose": "^4.12.3", - "morgan": "1.9.0", + "morgan": "^1.9.0", "ms": "^2.0.0", "murmurhash-js": "^1.0.0", "node-emoji": "^1.8.1", @@ -213,6 +216,7 @@ "identity-obj-proxy": "^3.0.0", "ip": "^1.1.5", "jest": "^21.2.1", + "jest-junit": "^3.6.0", "lint-staged": "^7.0.0", "mocha": "^3.1.2", "mocha-junit-reporter": "^1.12.1", diff --git a/perms/constants/query.js b/perms/constants/query.js index 4cc07109c..b846b15ce 100644 --- a/perms/constants/query.js +++ b/perms/constants/query.js @@ -9,4 +9,5 @@ module.exports = { VIEW_PROTECTED_SETTINGS: 'VIEW_PROTECTED_SETTINGS', LIST_OWN_TOKENS: 'LIST_OWN_TOKENS', VIEW_USER_ROLE: 'VIEW_USER_ROLE', + VIEW_USER_EMAIL: 'VIEW_USER_EMAIL', }; diff --git a/perms/reducers/query.js b/perms/reducers/query.js index 4fc5ba79e..0852d8e2b 100644 --- a/perms/reducers/query.js +++ b/perms/reducers/query.js @@ -8,11 +8,11 @@ module.exports = (user, perm) => { case types.SEARCH_ACTIONS: case types.SEARCH_NON_NULL_OR_ACCEPTED_COMMENTS: case types.SEARCH_OTHERS_COMMENTS: - return check(user, ['ADMIN', 'MODERATOR']); case types.SEARCH_COMMENT_STATUS_HISTORY: case types.VIEW_USER_STATUS: case types.VIEW_PROTECTED_SETTINGS: case types.VIEW_USER_ROLE: + case types.VIEW_USER_EMAIL: return check(user, ['ADMIN', 'MODERATOR']); case types.LIST_OWN_TOKENS: return check(user, ['ADMIN']); diff --git a/plugin-api/beta/client/hocs/index.js b/plugin-api/beta/client/hocs/index.js index 397d8b94d..8b91c83de 100644 --- a/plugin-api/beta/client/hocs/index.js +++ b/plugin-api/beta/client/hocs/index.js @@ -6,6 +6,7 @@ export { withEmit, excludeIf, withFragments, + withMutation, withForgotPassword, withSignIn, withSignUp, diff --git a/plugin-api/client/lib/index.js b/plugin-api/client/lib/index.js new file mode 100644 index 000000000..20e084806 --- /dev/null +++ b/plugin-api/client/lib/index.js @@ -0,0 +1 @@ +export { default as Action } from 'coral-framework/lib/action'; diff --git a/plugins.js b/plugins.js index 8ffe89e3a..05d245c8a 100644 --- a/plugins.js +++ b/plugins.js @@ -4,6 +4,7 @@ const resolve = require('resolve'); const debug = require('debug')('talk:plugins'); const Joi = require('joi'); const amp = require('app-module-path'); +const hjson = require('hjson'); const pkg = require('./package.json'); const PLUGINS_JSON = process.env.TALK_PLUGINS_JSON; @@ -33,7 +34,9 @@ try { pluginsPath = defaultPlugins; } - plugins = require(pluginsPath); + // Load/parse the plugin content using hjson. + const pluginContent = fs.readFileSync(pluginsPath, 'utf8'); + plugins = hjson.parse(pluginContent); } catch (err) { if (err.code === 'ENOENT') { console.error( @@ -73,6 +76,7 @@ const hookSchemas = { onConnect: Joi.func(), onDisconnect: Joi.func(), }), + connect: Joi.func().maxArity(1), }; /** @@ -293,14 +297,42 @@ class PluginManager { plugins[section] ); } + + this.deferredHooks = []; + this.ranDeferredHooks = false; } /** * Utility function which combines the Plugins.section and PluginSection.hook * calls. */ - get(section, hook) { - return this.section(section).hook(hook); + get(sectionName, hookName) { + return this.section(sectionName).hook(hookName); + } + + /** + * Utility function which combines the Plugins.section and PluginSection.hook + * calls and runs them when the `runDeferred` is called. + */ + defer(sectionName, hookName, callback) { + const plugins = this.section(sectionName).hook(hookName); + + // If we've already ran the callbacks, then we should run it immediately. + if (this.ranDeferredHooks) { + plugins.forEach(callback); + } else { + this.deferredHooks.push({ plugins, callback }); + } + } + + /** + * Calls all deferred hooks. + */ + runDeferred() { + this.deferredHooks.forEach(({ plugins, callback }) => + plugins.forEach(callback) + ); + this.ranDeferredHooks = true; } /** diff --git a/plugins/talk-plugin-auth/client/login/containers/Main.js b/plugins/talk-plugin-auth/client/login/containers/Main.js index 05778133a..235bd6cde 100644 --- a/plugins/talk-plugin-auth/client/login/containers/Main.js +++ b/plugins/talk-plugin-auth/client/login/containers/Main.js @@ -4,10 +4,6 @@ import Main from '../components/Main'; import { connect } from 'plugin-api/beta/client/hocs'; import { bindActionCreators } from 'redux'; import { setView } from '../actions'; -import { - setAuthToken, - handleSuccessfulLogin, -} from 'plugin-api/beta/client/actions/auth'; import * as views from '../enums/views'; class MainContainer extends React.Component { @@ -24,7 +20,6 @@ class MainContainer extends React.Component { componentDidMount() { this.resizeHeight(); - this.listenToStorageChanges(); } componentDidUpdate(prevProps) { @@ -33,40 +28,6 @@ class MainContainer extends React.Component { } } - componentWillUnmount() { - this.unlisten(); - } - - listenToStorageChanges() { - window.addEventListener('storage', this.handleAuth); - } - - unlisten() { - window.removeEventListener('storage', this.handleAuth); - } - - // External logins store auth data into `auth`, we use it to detect - // a successful sign in. - handleAuth = e => { - if (e.key === 'auth') { - const { err, data } = JSON.parse(e.newValue); - if (err) { - console.error(err); - } else if (data && data.token) { - if (data.user) { - this.props.handleSuccessfulLogin(data.user, data.token); - } else { - this.props.setAuthToken(data.token); - } - this.unlisten(); - localStorage.removeItem('auth'); - window.close(); - } else { - console.error('auth was set, but did not contain a token'); - } - } - }; - render() { return
; } @@ -75,8 +36,6 @@ class MainContainer extends React.Component { MainContainer.propTypes = { view: PropTypes.string.isRequired, setView: PropTypes.func.isRequired, - handleSuccessfulLogin: PropTypes.func.isRequired, - setAuthToken: PropTypes.func.isRequired, }; const mapStateToProps = ({ talkPluginAuth: state }) => ({ @@ -87,8 +46,6 @@ const mapDispatchToProps = dispatch => bindActionCreators( { setView, - handleSuccessfulLogin, - setAuthToken, }, dispatch ); diff --git a/plugins/talk-plugin-facebook-auth/client/actions.js b/plugins/talk-plugin-facebook-auth/client/actions.js index 5a9ebc66f..79f2d2a6a 100644 --- a/plugins/talk-plugin-facebook-auth/client/actions.js +++ b/plugins/talk-plugin-facebook-auth/client/actions.js @@ -1,7 +1,3 @@ export const loginWithFacebook = () => (dispatch, _, { rest }) => { - window.open( - `${rest.uri}/auth/facebook`, - 'Continue with Facebook', - 'menubar=0,resizable=0,width=500,height=500,top=200,left=500' - ); + window.location = `${rest.uri}/auth/facebook`; }; diff --git a/plugins/talk-plugin-facebook-auth/server/router.js b/plugins/talk-plugin-facebook-auth/server/router.js index 3e890ec89..10d2469da 100644 --- a/plugins/talk-plugin-facebook-auth/server/router.js +++ b/plugins/talk-plugin-facebook-auth/server/router.js @@ -1,24 +1,31 @@ module.exports = router => { - const { passport, HandleAuthPopupCallback } = require('services/passport'); - /** * Facebook auth endpoint, this will redirect the user immediately to Facebook * for authorization. */ - router.get( - '/api/v1/auth/facebook', - passport.authenticate('facebook', { + router.get('/api/v1/auth/facebook', (req, res, next) => { + const { + connectors: { services: { Passport: { passport } } }, + } = req.context; + + return passport.authenticate('facebook', { display: 'popup', authType: 'rerequest', scope: ['public_profile'], - }) - ); + })(req, res, next); + }); /** * Facebook callback endpoint, this will send the user a HTML page designed to * send back the user credentials upon successful login. */ router.get('/api/v1/auth/facebook/callback', (req, res, next) => { + const { + connectors: { + services: { Passport: { passport, HandleAuthPopupCallback } }, + }, + } = req.context; + // Perform the facebook login flow and pass the data back through the opener. passport.authenticate( 'facebook', diff --git a/plugins/talk-plugin-google-auth/client/actions.js b/plugins/talk-plugin-google-auth/client/actions.js index 6519d9f2b..8b49bf39e 100644 --- a/plugins/talk-plugin-google-auth/client/actions.js +++ b/plugins/talk-plugin-google-auth/client/actions.js @@ -1,7 +1,3 @@ export const loginWithGoogle = () => (dispatch, _, { rest }) => { - window.open( - `${rest.uri}/auth/google`, - 'Continue with Google', - 'menubar=0,resizable=0,width=500,height=500,top=200,left=500' - ); + window.location = `${rest.uri}/auth/google`; }; diff --git a/plugins/talk-plugin-notifications-category-featured/client/.eslintrc.json b/plugins/talk-plugin-notifications-category-featured/client/.eslintrc.json new file mode 100644 index 000000000..c8a6db18a --- /dev/null +++ b/plugins/talk-plugin-notifications-category-featured/client/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "@coralproject/eslint-config-talk/client" +} diff --git a/plugins/talk-plugin-notifications-category-featured/client/containers/Toggle.js b/plugins/talk-plugin-notifications-category-featured/client/containers/Toggle.js new file mode 100644 index 000000000..ec7586b16 --- /dev/null +++ b/plugins/talk-plugin-notifications-category-featured/client/containers/Toggle.js @@ -0,0 +1,69 @@ +import React from 'react'; +import PropTypes from 'prop-types'; +import { compose, gql } from 'react-apollo'; +import Toggle from 'talk-plugin-notifications/client/components/Toggle'; +import { t } from 'plugin-api/beta/client/services'; +import { withFragments } from 'plugin-api/beta/client/hocs'; + +class ToggleContainer extends React.Component { + constructor(props) { + super(props); + props.setTurnOffInputFragment({ onFeatured: false }); + + if (this.getOnFeaturedSetting()) { + props.indicateOn(); + } + } + + componentWillReceiveProps(nextProps) { + const prevSetting = this.getOnFeaturedSetting(this.props); + const nextSetting = this.getOnFeaturedSetting(nextProps); + if (prevSetting && !nextSetting) { + nextProps.indicateOff(); + } else if (!prevSetting && nextSetting) { + nextProps.indicateOn(); + } + } + + getOnFeaturedSetting = (props = this.props) => + props.root.me.notificationSettings.onFeatured; + + toggle = () => { + this.props.updateNotificationSettings({ + onFeatured: !this.getOnFeaturedSetting(), + }); + }; + + render() { + return ( + + {t('talk-plugin-notifications-category-featured.toggle_description')} + + ); + } +} + +ToggleContainer.propTypes = { + data: PropTypes.object, + root: PropTypes.object, + indicateOn: PropTypes.func.isRequired, + indicateOff: PropTypes.func.isRequired, + setTurnOffInputFragment: PropTypes.func.isRequired, + updateNotificationSettings: PropTypes.func.isRequired, +}; + +const enhance = compose( + withFragments({ + root: gql` + fragment TalkNotificationsCategoryFeatured_Toggle_root on RootQuery { + me { + notificationSettings { + onFeatured + } + } + } + `, + }) +); + +export default enhance(ToggleContainer); diff --git a/plugins/talk-plugin-notifications-category-featured/client/graphql.js b/plugins/talk-plugin-notifications-category-featured/client/graphql.js new file mode 100644 index 000000000..440a6f7fa --- /dev/null +++ b/plugins/talk-plugin-notifications-category-featured/client/graphql.js @@ -0,0 +1,33 @@ +import { gql } from 'react-apollo'; + +export default { + mutations: { + UpdateNotificationSettings: ({ + variables: { input }, + state: { auth: { user: { id } } }, + }) => ({ + update: proxy => { + if (input.onFeatured === undefined) { + return; + } + + const fragment = gql` + fragment TalkNotificationsCategoryFeatured_User_Fragment on User { + notificationSettings { + onFeatured + } + } + `; + const fragmentId = `User_${id}`; + const data = { + __typename: 'User', + notificationSettings: { + __typename: 'NotificationSettings', + onFeatured: input.onFeatured, + }, + }; + proxy.writeFragment({ fragment, id: fragmentId, data }); + }, + }), + }, +}; diff --git a/plugins/talk-plugin-notifications-category-featured/client/index.js b/plugins/talk-plugin-notifications-category-featured/client/index.js new file mode 100644 index 000000000..1e22c3a93 --- /dev/null +++ b/plugins/talk-plugin-notifications-category-featured/client/index.js @@ -0,0 +1,11 @@ +import Toggle from './containers/Toggle'; +import translations from './translations.yml'; +import graphql from './graphql'; + +export default { + slots: { + notificationSettings: [Toggle], + }, + translations, + ...graphql, +}; diff --git a/plugins/talk-plugin-notifications-category-featured/client/translations.yml b/plugins/talk-plugin-notifications-category-featured/client/translations.yml new file mode 100644 index 000000000..7077943ef --- /dev/null +++ b/plugins/talk-plugin-notifications-category-featured/client/translations.yml @@ -0,0 +1,3 @@ +en: + talk-plugin-notifications-category-featured: + toggle_description: My comment is featured diff --git a/plugins/talk-plugin-notifications-category-featured/index.js b/plugins/talk-plugin-notifications-category-featured/index.js new file mode 100644 index 000000000..802c37a9a --- /dev/null +++ b/plugins/talk-plugin-notifications-category-featured/index.js @@ -0,0 +1,118 @@ +const { graphql } = require('graphql'); +const { get } = require('lodash'); +const path = require('path'); + +const handle = async (ctx, { comment }) => { + const { connectors: { graph: { schema } } } = ctx; + + // Check to see if this is a reply to an existing comment. + const commentID = get(comment, 'id', null); + if (commentID === null) { + ctx.log.debug('could not get comment id'); + return; + } + + // Execute the graph request. + const reply = await graphql( + schema, + ` + query GetAuthorUserMetadata($comment_id: ID!) { + comment(id: $comment_id) { + id + user { + id + notificationSettings { + onFeatured + } + } + } + } + `, + {}, + ctx, + { comment_id: commentID } + ); + if (reply.errors) { + ctx.log.error({ err: reply.errors }, 'could not query for author metadata'); + return; + } + + // Check if the user has notifications enabled. + const enabled = get( + reply, + 'data.comment.user.notificationSettings.onFeatured', + false + ); + if (!enabled) { + return; + } + + const userID = get(reply, 'data.comment.user.id', null); + if (!userID) { + ctx.log.debug('could not get comment user id'); + return; + } + + // The user does have notifications for featured comments enabled, queue the + // notification to be sent. + return { userID, date: comment.created_at, context: comment.id }; +}; + +const hydrate = async (ctx, category, context) => { + const { connectors: { graph: { schema } } } = ctx; + + const reply = await graphql( + schema, + ` + query GetNotificationData($context: ID!) { + comment(id: $context) { + id + asset { + title + url + } + } + } + `, + {}, + ctx, + { context } + ); + if (reply.errors) { + throw reply.errors; + } + + const comment = get(reply, 'data.comment'); + const headline = get(comment, 'asset.title', null); + const assetURL = get(comment, 'asset.url', null); + const permalink = `${assetURL}?commentId=${comment.id}`; + + return [headline, permalink]; +}; + +const handler = { + handle, + category: 'featured', + event: 'commentFeatured', + hydrate, +}; + +module.exports = { + typeDefs: ` + type NotificationSettings { + onFeatured: Boolean! + } + + input NotificationSettingsInput { + onFeatured: Boolean + } + `, + resolvers: { + NotificationSettings: { + // onFeatured returns false by default if not specified. + onFeatured: settings => get(settings, 'onFeatured', false), + }, + }, + translations: path.join(__dirname, 'translations.yml'), + notifications: [handler], +}; diff --git a/plugins/talk-plugin-notifications-category-featured/translations.yml b/plugins/talk-plugin-notifications-category-featured/translations.yml new file mode 100644 index 000000000..bd0d7412f --- /dev/null +++ b/plugins/talk-plugin-notifications-category-featured/translations.yml @@ -0,0 +1,6 @@ +en: + talk-plugin-notifications: + categories: + featured: + subject: "One of your comments was featured on [{0}]" + body: "{0}\nA member of our team has selected this comment to be featured for other readers: {1}" \ No newline at end of file diff --git a/plugins/talk-plugin-notifications-category-reply/client/.eslintrc.json b/plugins/talk-plugin-notifications-category-reply/client/.eslintrc.json new file mode 100644 index 000000000..c8a6db18a --- /dev/null +++ b/plugins/talk-plugin-notifications-category-reply/client/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "@coralproject/eslint-config-talk/client" +} diff --git a/plugins/talk-plugin-notifications-category-reply/client/containers/Toggle.js b/plugins/talk-plugin-notifications-category-reply/client/containers/Toggle.js new file mode 100644 index 000000000..61600a29f --- /dev/null +++ b/plugins/talk-plugin-notifications-category-reply/client/containers/Toggle.js @@ -0,0 +1,69 @@ +import React from 'react'; +import PropTypes from 'prop-types'; +import { compose, gql } from 'react-apollo'; +import Toggle from 'talk-plugin-notifications/client/components/Toggle'; +import { t } from 'plugin-api/beta/client/services'; +import { withFragments } from 'plugin-api/beta/client/hocs'; + +class ToggleContainer extends React.Component { + constructor(props) { + super(props); + props.setTurnOffInputFragment({ onReply: false }); + + if (this.getOnReplySetting()) { + props.indicateOn(); + } + } + + componentWillReceiveProps(nextProps) { + const prevSetting = this.getOnReplySetting(this.props); + const nextSetting = this.getOnReplySetting(nextProps); + if (prevSetting && !nextSetting) { + nextProps.indicateOff(); + } else if (!prevSetting && nextSetting) { + nextProps.indicateOn(); + } + } + + getOnReplySetting = (props = this.props) => + props.root.me.notificationSettings.onReply; + + toggle = () => { + this.props.updateNotificationSettings({ + onReply: !this.getOnReplySetting(), + }); + }; + + render() { + return ( + + {t('talk-plugin-notifications-category-reply.toggle_description')} + + ); + } +} + +ToggleContainer.propTypes = { + data: PropTypes.object, + root: PropTypes.object, + indicateOn: PropTypes.func.isRequired, + indicateOff: PropTypes.func.isRequired, + setTurnOffInputFragment: PropTypes.func.isRequired, + updateNotificationSettings: PropTypes.func.isRequired, +}; + +const enhance = compose( + withFragments({ + root: gql` + fragment TalkNotificationsCategoryReply_Toggle_root on RootQuery { + me { + notificationSettings { + onReply + } + } + } + `, + }) +); + +export default enhance(ToggleContainer); diff --git a/plugins/talk-plugin-notifications-category-reply/client/graphql.js b/plugins/talk-plugin-notifications-category-reply/client/graphql.js new file mode 100644 index 000000000..623e72366 --- /dev/null +++ b/plugins/talk-plugin-notifications-category-reply/client/graphql.js @@ -0,0 +1,33 @@ +import { gql } from 'react-apollo'; + +export default { + mutations: { + UpdateNotificationSettings: ({ + variables: { input }, + state: { auth: { user: { id } } }, + }) => ({ + update: proxy => { + if (input.onReply === undefined) { + return; + } + + const fragment = gql` + fragment TalkNotificationsCategoryReply_User_Fragment on User { + notificationSettings { + onReply + } + } + `; + const fragmentId = `User_${id}`; + const data = { + __typename: 'User', + notificationSettings: { + __typename: 'NotificationSettings', + onReply: input.onReply, + }, + }; + proxy.writeFragment({ fragment, id: fragmentId, data }); + }, + }), + }, +}; diff --git a/plugins/talk-plugin-notifications-category-reply/client/index.js b/plugins/talk-plugin-notifications-category-reply/client/index.js new file mode 100644 index 000000000..1e22c3a93 --- /dev/null +++ b/plugins/talk-plugin-notifications-category-reply/client/index.js @@ -0,0 +1,11 @@ +import Toggle from './containers/Toggle'; +import translations from './translations.yml'; +import graphql from './graphql'; + +export default { + slots: { + notificationSettings: [Toggle], + }, + translations, + ...graphql, +}; diff --git a/plugins/talk-plugin-notifications-category-reply/client/translations.yml b/plugins/talk-plugin-notifications-category-reply/client/translations.yml new file mode 100644 index 000000000..703891de5 --- /dev/null +++ b/plugins/talk-plugin-notifications-category-reply/client/translations.yml @@ -0,0 +1,3 @@ +en: + talk-plugin-notifications-category-reply: + toggle_description: My comment receives a reply diff --git a/plugins/talk-plugin-notifications-category-reply/index.js b/plugins/talk-plugin-notifications-category-reply/index.js new file mode 100644 index 000000000..32d90e05d --- /dev/null +++ b/plugins/talk-plugin-notifications-category-reply/index.js @@ -0,0 +1,124 @@ +const { graphql } = require('graphql'); +const { get } = require('lodash'); +const path = require('path'); + +const handle = async (ctx, comment) => { + const { connectors: { graph: { schema } } } = ctx; + + // Check to see if this is a reply to an existing comment. + const parentID = get(comment, 'parent_id', null); + if (parentID === null) { + ctx.log.debug('could not get parent comment id'); + return; + } + + // Execute the graph request. + const reply = await graphql( + schema, + ` + query GetAuthorUserMetadata($comment_id: ID!) { + comment(id: $comment_id) { + id + user { + id + notificationSettings { + onReply + } + } + } + } + `, + {}, + ctx, + { comment_id: parentID } + ); + if (reply.errors) { + ctx.log.error({ err: reply.errors }, 'could not query for author metadata'); + return; + } + + // Check if the user has notifications enabled. + const enabled = get( + reply, + 'data.comment.user.notificationSettings.onReply', + false + ); + if (!enabled) { + return; + } + + const userID = get(reply, 'data.comment.user.id', null); + if (!userID) { + ctx.log.debug('could not get parent comment user id'); + return; + } + + // Check to see if this is yourself replying to yourself, if that's the case + // don't send a notification. + if (userID === get(comment, 'author_id')) { + ctx.log.debug('user id of parent comment is the same as the new comment'); + return; + } + + // The user does have notifications for replied comments enabled, queue the + // notification to be sent. + return { userID, date: comment.created_at, context: comment.id }; +}; + +const hydrate = async (ctx, category, context) => { + const { connectors: { graph: { schema } } } = ctx; + + const reply = await graphql( + schema, + ` + query GetNotificationData($context: ID!) { + comment(id: $context) { + id + asset { + title + url + } + user { + username + } + } + } + `, + {}, + ctx, + { context } + ); + if (reply.errors) { + throw reply.errors; + } + + const comment = get(reply, 'data.comment'); + const headline = get(comment, 'asset.title', null); + const replier = get(comment, 'user.username', null); + const assetURL = get(comment, 'asset.url', null); + const permalink = `${assetURL}?commentId=${comment.id}`; + + return [headline, replier, permalink]; +}; + +const handler = { handle, category: 'reply', event: 'commentAdded', hydrate }; + +module.exports = { + typeDefs: ` + type NotificationSettings { + onReply: Boolean! + } + + input NotificationSettingsInput { + onReply: Boolean + } + `, + resolvers: { + NotificationSettings: { + // onReply returns false by default if not specified. + onReply: settings => get(settings, 'onReply', false), + }, + }, + translations: path.join(__dirname, 'translations.yml'), + notifications: [handler], +}; diff --git a/plugins/talk-plugin-notifications-category-reply/translations.yml b/plugins/talk-plugin-notifications-category-reply/translations.yml new file mode 100644 index 000000000..0f28ca105 --- /dev/null +++ b/plugins/talk-plugin-notifications-category-reply/translations.yml @@ -0,0 +1,6 @@ +en: + talk-plugin-notifications: + categories: + reply: + subject: "Someone has replied to your comment on {0}" + body: "{0}\n{1} replied to your comment: {2}" \ No newline at end of file diff --git a/plugins/talk-plugin-notifications-category-staff/client/.eslintrc.json b/plugins/talk-plugin-notifications-category-staff/client/.eslintrc.json new file mode 100644 index 000000000..c8a6db18a --- /dev/null +++ b/plugins/talk-plugin-notifications-category-staff/client/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "@coralproject/eslint-config-talk/client" +} diff --git a/plugins/talk-plugin-notifications-category-staff/client/containers/Toggle.js b/plugins/talk-plugin-notifications-category-staff/client/containers/Toggle.js new file mode 100644 index 000000000..44d6d5b3c --- /dev/null +++ b/plugins/talk-plugin-notifications-category-staff/client/containers/Toggle.js @@ -0,0 +1,69 @@ +import React from 'react'; +import PropTypes from 'prop-types'; +import { compose, gql } from 'react-apollo'; +import Toggle from 'talk-plugin-notifications/client/components/Toggle'; +import { t } from 'plugin-api/beta/client/services'; +import { withFragments } from 'plugin-api/beta/client/hocs'; + +class ToggleContainer extends React.Component { + constructor(props) { + super(props); + props.setTurnOffInputFragment({ onStaffReply: false }); + + if (this.getOnReplySetting()) { + props.indicateOn(); + } + } + + componentWillReceiveProps(nextProps) { + const prevSetting = this.getOnReplySetting(this.props); + const nextSetting = this.getOnReplySetting(nextProps); + if (prevSetting && !nextSetting) { + nextProps.indicateOff(); + } else if (!prevSetting && nextSetting) { + nextProps.indicateOn(); + } + } + + getOnReplySetting = (props = this.props) => + props.root.me.notificationSettings.onStaffReply; + + toggle = () => { + this.props.updateNotificationSettings({ + onStaffReply: !this.getOnReplySetting(), + }); + }; + + render() { + return ( + + {t('talk-plugin-notifications-category-staff.toggle_description')} + + ); + } +} + +ToggleContainer.propTypes = { + data: PropTypes.object, + root: PropTypes.object, + indicateOn: PropTypes.func.isRequired, + indicateOff: PropTypes.func.isRequired, + setTurnOffInputFragment: PropTypes.func.isRequired, + updateNotificationSettings: PropTypes.func.isRequired, +}; + +const enhance = compose( + withFragments({ + root: gql` + fragment TalkNotificationsCategoryStaffReply_User_Fragment on RootQuery { + me { + notificationSettings { + onStaffReply + } + } + } + `, + }) +); + +export default enhance(ToggleContainer); diff --git a/plugins/talk-plugin-notifications-category-staff/client/graphql.js b/plugins/talk-plugin-notifications-category-staff/client/graphql.js new file mode 100644 index 000000000..2e8007d4f --- /dev/null +++ b/plugins/talk-plugin-notifications-category-staff/client/graphql.js @@ -0,0 +1,33 @@ +import { gql } from 'react-apollo'; + +export default { + mutations: { + UpdateNotificationSettings: ({ + variables: { input }, + state: { auth: { user: { id } } }, + }) => ({ + update: proxy => { + if (input.onStaffReply === undefined) { + return; + } + + const fragment = gql` + fragment TalkNotificationsCategoryStaffReply_User_Fragment on User { + notificationSettings { + onStaffReply + } + } + `; + const fragmentId = `User_${id}`; + const data = { + __typename: 'User', + notificationSettings: { + __typename: 'NotificationSettings', + onStaffReply: input.onStaffReply, + }, + }; + proxy.writeFragment({ fragment, id: fragmentId, data }); + }, + }), + }, +}; diff --git a/plugins/talk-plugin-notifications-category-staff/client/index.js b/plugins/talk-plugin-notifications-category-staff/client/index.js new file mode 100644 index 000000000..1e22c3a93 --- /dev/null +++ b/plugins/talk-plugin-notifications-category-staff/client/index.js @@ -0,0 +1,11 @@ +import Toggle from './containers/Toggle'; +import translations from './translations.yml'; +import graphql from './graphql'; + +export default { + slots: { + notificationSettings: [Toggle], + }, + translations, + ...graphql, +}; diff --git a/plugins/talk-plugin-notifications-category-staff/client/translations.yml b/plugins/talk-plugin-notifications-category-staff/client/translations.yml new file mode 100644 index 000000000..ba831cf37 --- /dev/null +++ b/plugins/talk-plugin-notifications-category-staff/client/translations.yml @@ -0,0 +1,3 @@ +en: + talk-plugin-notifications-category-staff: + toggle_description: A staff member replies to my comment diff --git a/plugins/talk-plugin-notifications-category-staff/index.js b/plugins/talk-plugin-notifications-category-staff/index.js new file mode 100644 index 000000000..c5a59253d --- /dev/null +++ b/plugins/talk-plugin-notifications-category-staff/index.js @@ -0,0 +1,151 @@ +const { graphql } = require('graphql'); +const { get } = require('lodash'); +const path = require('path'); + +const handle = async (ctx, comment) => { + const { connectors: { graph: { schema } } } = ctx; + + // Check to see if this is a reply to an existing comment. + const parentID = get(comment, 'parent_id', null); + if (parentID === null) { + ctx.log.debug('could not get parent comment id'); + return; + } + + const authorID = get(comment, 'author_id', null); + if (authorID === null) { + ctx.log.error('could not get author id'); + return; + } + + // Execute the graph request. + const reply = await graphql( + schema, + ` + query GetAuthorUserMetadata($comment_id: ID!, $author_id: ID!) { + author: user(id: $author_id) { + role + } + comment(id: $comment_id) { + id + user { + id + notificationSettings { + onStaffReply + } + } + } + } + `, + {}, + ctx, + { comment_id: parentID, author_id: authorID } + ); + if (reply.errors) { + ctx.log.error({ err: reply.errors }, 'could not query for author metadata'); + return; + } + + // Check if the user has notifications enabled. + const enabled = get( + reply, + 'data.comment.user.notificationSettings.onStaffReply', + false + ); + if (!enabled) { + ctx.log.debug('onStaffReply is false, will not send the notification'); + return; + } + + const userID = get(reply, 'data.comment.user.id', null); + if (!userID) { + ctx.log.debug('could not get parent comment user id'); + return; + } + + // Check to see if this is yourself replying to yourself, if that's the case + // don't send a notification. + if (userID === authorID) { + ctx.log.debug('user id of parent comment is the same as the new comment'); + return; + } + + // Check to see that this comment was indeed from a staff member. + const role = get(reply, 'data.author.role'); + if (!['ADMIN', 'MODERATOR', 'STAFF'].includes(role)) { + ctx.log.debug({ role }, 'reply author is not a staff member'); + return; + } + + // The user does have notifications for replied comments enabled, queue the + // notification to be sent. + return { userID, date: comment.created_at, context: comment.id }; +}; + +const hydrate = async (ctx, category, context) => { + const { connectors: { graph: { schema } } } = ctx; + + const reply = await graphql( + schema, + ` + query GetNotificationData($context: ID!) { + comment(id: $context) { + id + asset { + title + url + } + user { + username + } + } + settings { + organizationName + } + } + `, + {}, + ctx, + { context } + ); + if (reply.errors) { + throw reply.errors; + } + + const comment = get(reply, 'data.comment'); + const headline = get(comment, 'asset.title', null); + const replier = get(comment, 'user.username', null); + const assetURL = get(comment, 'asset.url', null); + const permalink = `${assetURL}?commentId=${comment.id}`; + const organizationName = get(reply, 'data.settings.organizationName', null); + + return [headline, replier, organizationName, permalink]; +}; + +const handler = { + handle, + category: 'staff', + event: 'commentAdded', + hydrate, + supersedesCategories: ['reply'], +}; + +module.exports = { + typeDefs: ` + type NotificationSettings { + onStaffReply: Boolean! + } + + input NotificationSettingsInput { + onStaffReply: Boolean + } + `, + resolvers: { + NotificationSettings: { + // onStaffReply returns false by default if not specified. + onStaffReply: settings => get(settings, 'onStaffReply', false), + }, + }, + translations: path.join(__dirname, 'translations.yml'), + notifications: [handler], +}; diff --git a/plugins/talk-plugin-notifications-category-staff/translations.yml b/plugins/talk-plugin-notifications-category-staff/translations.yml new file mode 100644 index 000000000..38b534e1d --- /dev/null +++ b/plugins/talk-plugin-notifications-category-staff/translations.yml @@ -0,0 +1,6 @@ +en: + talk-plugin-notifications: + categories: + staff: + subject: "Someone at {0} has replied to your comment" + body: "{0}\n{1} works for {2} and has replied to your comment: {3}" \ No newline at end of file diff --git a/plugins/talk-plugin-notifications/client/.eslintrc.json b/plugins/talk-plugin-notifications/client/.eslintrc.json new file mode 100644 index 000000000..c8a6db18a --- /dev/null +++ b/plugins/talk-plugin-notifications/client/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "@coralproject/eslint-config-talk/client" +} diff --git a/plugins/talk-plugin-notifications/client/components/Settings.css b/plugins/talk-plugin-notifications/client/components/Settings.css new file mode 100644 index 000000000..12a7233e1 --- /dev/null +++ b/plugins/talk-plugin-notifications/client/components/Settings.css @@ -0,0 +1,27 @@ +.root { + margin-bottom: 20px; +} + +.innerSettings { + padding-left: 12px; +} + +.subtitle { + margin: 0; + margin-bottom: 8px; +} + +.turnOffButton { + padding: 2px 0; + color: #2099d6; + border-bottom: 1px solid #2099d6; + + &:disabled { + color: #e5e5e5; + border-bottom: 1px solid #e5e5e5; + } +} + +.notifcationSettingsSlot { + margin-bottom: 3px; +} diff --git a/plugins/talk-plugin-notifications/client/components/Settings.js b/plugins/talk-plugin-notifications/client/components/Settings.js new file mode 100644 index 000000000..dad6b2bed --- /dev/null +++ b/plugins/talk-plugin-notifications/client/components/Settings.js @@ -0,0 +1,68 @@ +import React from 'react'; +import PropTypes from 'prop-types'; +import { IfSlotIsNotEmpty } from 'plugin-api/beta/client/components'; +import { Slot } from 'plugin-api/beta/client/components'; +import { t } from 'plugin-api/beta/client/services'; +import styles from './Settings.css'; +import { BareButton } from 'plugin-api/beta/client/components/ui'; + +class Settings extends React.Component { + childFactory = el => { + const pluginName = el.type.talkPluginName; + const props = { + indicateOn: () => this.props.indicateOn(pluginName), + indicateOff: () => this.props.indicateOff(pluginName), + }; + return React.cloneElement(el, props); + }; + + render() { + const { + root, + setTurnOffInputFragment, + updateNotificationSettings, + turnOffAll, + turnOffButtonDisabled, + } = this.props; + + return ( + +
+

{t('talk-plugin-notifications.settings_title')}

+

+ {t('talk-plugin-notifications.settings_subtitle')} +

+
+ + + {t('talk-plugin-notifications.turn_off_all')} + +
+
+ + ); + } +} + +Settings.propTypes = { + root: PropTypes.object, + indicateOn: PropTypes.func.isRequired, + indicateOff: PropTypes.func.isRequired, + setTurnOffInputFragment: PropTypes.func.isRequired, + updateNotificationSettings: PropTypes.func.isRequired, + turnOffAll: PropTypes.func.isRequired, + turnOffButtonDisabled: PropTypes.bool.isRequired, +}; + +export default Settings; diff --git a/plugins/talk-plugin-notifications/client/components/Toggle.css b/plugins/talk-plugin-notifications/client/components/Toggle.css new file mode 100644 index 000000000..f888da616 --- /dev/null +++ b/plugins/talk-plugin-notifications/client/components/Toggle.css @@ -0,0 +1,6 @@ +.title { + display: inline-block; + width: 270px; + cursor: pointer; + user-select: none; +} diff --git a/plugins/talk-plugin-notifications/client/components/Toggle.js b/plugins/talk-plugin-notifications/client/components/Toggle.js new file mode 100644 index 000000000..dbabbea52 --- /dev/null +++ b/plugins/talk-plugin-notifications/client/components/Toggle.js @@ -0,0 +1,29 @@ +import React from 'react'; +import PropTypes from 'prop-types'; +import { Checkbox } from 'plugin-api/beta/client/components/ui'; +import styles from './Toggle.css'; +import uuid from 'uuid/v4'; + +class Toggle extends React.Component { + id = uuid(); + + render() { + const { checked, onChange, children } = this.props; + return ( +
+ + +
+ ); + } +} + +Toggle.propTypes = { + checked: PropTypes.bool, + onChange: PropTypes.func, + children: PropTypes.node, +}; + +export default Toggle; diff --git a/plugins/talk-plugin-notifications/client/containers/Settings.js b/plugins/talk-plugin-notifications/client/containers/Settings.js new file mode 100644 index 000000000..e987bafa2 --- /dev/null +++ b/plugins/talk-plugin-notifications/client/containers/Settings.js @@ -0,0 +1,68 @@ +import React from 'react'; +import PropTypes from 'prop-types'; +import { compose, gql } from 'react-apollo'; +import Settings from '../components/Settings'; +import { withFragments } from 'plugin-api/beta/client/hocs'; +import { getSlotFragmentSpreads } from 'plugin-api/beta/client/utils'; +import { withUpdateNotificationSettings } from '../mutations'; + +const slots = ['notificationSettings']; + +class SettingsContainer extends React.Component { + state = { + hasNotifications: [], + turnOffInput: {}, + }; + + indicateOn = plugin => + this.setState({ + hasNotifications: this.state.hasNotifications.concat(plugin), + }); + indicateOff = plugin => + this.setState({ + hasNotifications: this.state.hasNotifications.filter(i => i !== plugin), + }); + setTurnOffInputFragment = fragment => + this.setState(state => ({ + turnOffInput: { ...state.turnOffInput, ...fragment }, + })); + + turnOffAll = () => { + this.props.updateNotificationSettings(this.state.turnOffInput); + }; + + render() { + return ( + + ); + } +} + +SettingsContainer.propTypes = { + data: PropTypes.object, + root: PropTypes.object, + updateNotificationSettings: PropTypes.func.isRequired, +}; + +const enhance = compose( + withFragments({ + root: gql` + fragment TalkNotifications_Settings_root on RootQuery { + __typename + ${getSlotFragmentSpreads(slots, 'root')} + } + `, + }), + withUpdateNotificationSettings +); + +export default enhance(SettingsContainer); diff --git a/plugins/talk-plugin-notifications/client/graphql.js b/plugins/talk-plugin-notifications/client/graphql.js new file mode 100644 index 000000000..b48b63668 --- /dev/null +++ b/plugins/talk-plugin-notifications/client/graphql.js @@ -0,0 +1,23 @@ +import { gql } from 'react-apollo'; + +export default { + fragments: { + UpdateNotificationSettingsResponse: gql` + fragment Talk_UpdateNotificationSettingsResponse on UpdateNotificationSettingsResponse { + errors { + translation_key + } + } + `, + }, + mutations: { + UpdateNotificationSettings: () => ({ + optimisticResponse: { + updateNotificationSettings: { + __typename: 'UpdateNotificationSettingsResponse', + errors: null, + }, + }, + }), + }, +}; diff --git a/plugins/talk-plugin-notifications/client/index.js b/plugins/talk-plugin-notifications/client/index.js new file mode 100644 index 000000000..8d3b9a08a --- /dev/null +++ b/plugins/talk-plugin-notifications/client/index.js @@ -0,0 +1,11 @@ +import Settings from './containers/Settings'; +import translations from './translations.yml'; +import graphql from './graphql'; + +export default { + slots: { + profileSettings: [Settings], + }, + translations, + ...graphql, +}; diff --git a/plugins/talk-plugin-notifications/client/mutations.js b/plugins/talk-plugin-notifications/client/mutations.js new file mode 100644 index 000000000..83d50fc1f --- /dev/null +++ b/plugins/talk-plugin-notifications/client/mutations.js @@ -0,0 +1,23 @@ +import { withMutation } from 'plugin-api/beta/client/hocs'; +import { gql } from 'react-apollo'; + +export const withUpdateNotificationSettings = withMutation( + gql` + mutation UpdateNotificationSettings($input: NotificationSettingsInput!) { + updateNotificationSettings(input: $input) { + ...UpdateNotificationSettingsResponse + } + } + `, + { + props: ({ mutate }) => ({ + updateNotificationSettings: input => { + return mutate({ + variables: { + input, + }, + }); + }, + }), + } +); diff --git a/plugins/talk-plugin-notifications/client/translations.yml b/plugins/talk-plugin-notifications/client/translations.yml new file mode 100644 index 000000000..9088e6493 --- /dev/null +++ b/plugins/talk-plugin-notifications/client/translations.yml @@ -0,0 +1,5 @@ +en: + talk-plugin-notifications: + settings_title: Notifications + settings_subtitle: Receive notifications when + turn_off_all: I do not want to receive notifications diff --git a/plugins/talk-plugin-notifications/index.js b/plugins/talk-plugin-notifications/index.js new file mode 100644 index 000000000..b84647777 --- /dev/null +++ b/plugins/talk-plugin-notifications/index.js @@ -0,0 +1 @@ +module.exports = require('./server'); diff --git a/plugins/talk-plugin-notifications/package.json b/plugins/talk-plugin-notifications/package.json new file mode 100644 index 000000000..fbf9657fb --- /dev/null +++ b/plugins/talk-plugin-notifications/package.json @@ -0,0 +1,11 @@ +{ + "name": "@coralproject/talk-plugin-notifications", + "version": "1.0.0", + "description": "Adds notification support for Talk", + "main": "index.js", + "license": "Apache-2.0", + "private": false, + "dependencies": { + "linkifyjs": "^2.1.5" + } +} diff --git a/plugins/talk-plugin-notifications/server/NotificationManager.js b/plugins/talk-plugin-notifications/server/NotificationManager.js new file mode 100644 index 000000000..6c1d2556d --- /dev/null +++ b/plugins/talk-plugin-notifications/server/NotificationManager.js @@ -0,0 +1,188 @@ +const { groupBy, forEach, property } = require('lodash'); +const debug = require('debug')('talk-plugin-notifications'); +const uuid = require('uuid/v4'); +const { UNSUBSCRIBE_SUBJECT } = require('./config'); + +// handleHandlers will call the handle method on each handler to determine if a +// notification should be sent for it. +const handleHandlers = (ctx, handlers, ...args) => + Promise.all( + handlers.map(async handler => { + // Grab the handler reference. + const { handle, category, event } = handler; + + try { + // Attempt to create a notification out of it. + const notification = await handle(ctx, ...args); + if (!notification) { + ctx.log.debug('no notification deemed by event handler'); + return; + } + + // Send the notification back. + ctx.log.debug({ category, event }, 'notification detected for event'); + return { handler, notification }; + } catch (err) { + ctx.log.error({ err }, 'could not handle the event'); + return; + } + }) + ); + +// filterSuperseded will filter all the possible notifications and only send +// those notifications that are not superseded by another type of notification. +const filterSuperseded = ({ handler: { category } }, index, notifications) => + !notifications.some(({ handler: { supersedesCategories = [] } }) => + supersedesCategories.some( + supersededCategory => supersededCategory === category + ) + ); + +class NotificationManager { + constructor(context) { + this.context = context; + this.registry = []; + } + + /** + * register will include the notification handlers on the manager. + * + * @param {Array} handlers notification handlers to register + */ + register(...handlers) { + this.registry.push(...handlers); + } + + /** + * attach will setup the notifications by walking the registry and loading all + * the notification types onto the handler. + * + * @param {Object} broker the event emitter for the Talk events + */ + attach(broker) { + const events = groupBy(this.registry, 'event'); + + forEach(events, (handlers, event) => { + debug( + `will now notify the [${handlers + .map(({ category }) => category) + .join(', ')}] handlers when the '${event}' event is emitted` + ); + broker.on(event, this.handle(handlers)); + }); + } + + /** + * handle will wrap a notification handler and attach it to the notification + * stream system. + * + * @param {Object} handler a notification handler + */ + handle(handlers) { + return async (...args) => { + // Create a system context to send down. + const ctx = this.context.forSystem(); + + // Get all the notifications to load. + let notifications = await handleHandlers(ctx, handlers, ...args); + + // Only let handlers past that have a notification to send. + notifications = notifications.filter(property('notification')); + + // Check to see if some of the other notifications that are queued + // had this notification superseded. + notifications = notifications.filter(filterSuperseded); + + // Send the remaining notifications. + return Promise.all( + notifications.map( + ({ handler, notification: { userID, date, context } }) => + this.send(ctx, userID, date, handler, context) + ) + ); + }; + } + + async send(ctx, userID, date, handler, context) { + const { + connectors: { + secrets: { jwt }, + config: { JWT_ISSUER, JWT_AUDIENCE }, + services: { Mailer, I18n: { t } }, + }, + loaders: { Settings }, + } = ctx; + const { category } = handler; + + try { + // Get the settings. + const { organizationName = null } = await Settings.load( + 'organizationName' + ); + if (organizationName === null) { + ctx.log.debug( + 'could not send the notification, organization name not in settings' + ); + return; + } + + // unsubscribeToken is the token used to perform the one-click + // unsubscribe. + const unsubscribeToken = jwt.sign({ + jti: uuid(), + iss: JWT_ISSUER, + aud: JWT_AUDIENCE, + sub: UNSUBSCRIBE_SUBJECT, + user: userID, + }); + + // Compose the subject for the email. + const subject = t( + `talk-plugin-notifications.categories.${category}.subject`, + organizationName + ); + + // Load the content into the comment. + const body = await this.getBody(ctx, handler, context); + + // Send the notification to the user. + const task = await Mailer.send({ + template: 'notification', + locals: { body, organizationName, unsubscribeToken }, + subject, + user: userID, + }); + + ctx.log.debug(`Sent the notification for Job.ID[${task.id}]`); + } catch (err) { + ctx.log.error( + { err, message: err.message }, + 'could not send the notification, an error occurred' + ); + return; + } + } + + /** + * getBody will return the body for the notification payload. + * + * @param {Object} ctx the graph context + * @param {Object} handler the notification handler + * @param {Mixed} context the notification context + */ + async getBody(ctx, handler, context) { + const { connectors: { services: { I18n: { t } } } } = ctx; + const { category } = handler; + + // Get the body replacement variables for the translation key. + const replacements = await handler.hydrate(ctx, category, context); + + // Generate the body. + return t( + `talk-plugin-notifications.categories.${category}.body`, + ...replacements + ); + } +} + +module.exports = NotificationManager; diff --git a/plugins/talk-plugin-notifications/server/config.js b/plugins/talk-plugin-notifications/server/config.js new file mode 100644 index 000000000..17bd94bf9 --- /dev/null +++ b/plugins/talk-plugin-notifications/server/config.js @@ -0,0 +1,3 @@ +module.exports = { + UNSUBSCRIBE_SUBJECT: 'nunsub', +}; diff --git a/plugins/talk-plugin-notifications/server/connect.js b/plugins/talk-plugin-notifications/server/connect.js new file mode 100644 index 000000000..497025a5e --- /dev/null +++ b/plugins/talk-plugin-notifications/server/connect.js @@ -0,0 +1,72 @@ +const debug = require('debug')('talk-plugin-notifications'); +const path = require('path'); +const linkify = require('linkifyjs/html'); +const NotificationManager = require('./NotificationManager'); + +module.exports = connectors => { + const { + graph: { subscriptions: { getBroker }, Context }, + services: { Mailer, Plugins }, + } = connectors; + + // Setup the mailer. Other plugins registered before this one can replace the + // notification template by passing the same name + format for the template + // registration. + Mailer.templates.register( + path.join(__dirname, 'emails', 'notification.html.ejs'), + 'notification', + 'html' + ); + Mailer.templates.register( + path.join(__dirname, 'emails', 'notification.txt.ejs'), + 'notification', + 'txt' + ); + + // Register the mail helpers. You can register your own helpers by calling + // this function in another plugin. + Mailer.registerHelpers({ linkify }); + + // Get the handle for the broker to attach to notifications. + const broker = getBroker(); + + // Create a NotificationManager to handle notifications. + const manager = new NotificationManager(Context); + + // Get all the notification handlers. Additional plugins registered before + // this one can expose a `notifications` hook, that contains an array of + // notification handlers. + // + // A notification handler has the following form: + // + // { + // event // the graph event to listen for + // handle // the function called when the event is fired. It is called with + // // the (ctx, arg1, arg2, ...) where arg1, arg2 are args from the + // // event. + // category // the name representing the notification type (like 'reply') + // hydrate // returns the replacement parameters (in order!) to be used + // // in the translation. + // } + // + const notificationHandlers = Plugins.get('server', 'notifications').reduce( + (handlers, { plugin, notifications }) => { + debug( + `registered the ${ + plugin.name + } plugin for notifications ${notifications.map( + ({ category }) => category + )}` + ); + handlers.push(...notifications); + return handlers; + }, + [] + ); + + // Attach all the notification handlers. + manager.register(...notificationHandlers); + + // Attach the broker to the manager so it can listen for the events. + manager.attach(broker); +}; diff --git a/plugins/talk-plugin-notifications/server/emails/notification.html.ejs b/plugins/talk-plugin-notifications/server/emails/notification.html.ejs new file mode 100644 index 000000000..acc67a849 --- /dev/null +++ b/plugins/talk-plugin-notifications/server/emails/notification.html.ejs @@ -0,0 +1,3 @@ +

<%= linkify(body, {nl2br: true}) %>

+

<%= t('talk-plugin-notifications.templates.footer', organizationName) %>

+

<%= t('talk-plugin-notifications.templates.links.unsubscribe') %>

\ No newline at end of file diff --git a/plugins/talk-plugin-notifications/server/emails/notification.txt.ejs b/plugins/talk-plugin-notifications/server/emails/notification.txt.ejs new file mode 100644 index 000000000..dd6dc0ba3 --- /dev/null +++ b/plugins/talk-plugin-notifications/server/emails/notification.txt.ejs @@ -0,0 +1,7 @@ +<%= body %> + +<%= t('talk-plugin-notifications.templates.footer', organizationName) %> + +<%= t('talk-plugin-notifications.templates.links.unsubscribe') %> + + <%= BASE_URL %>account/unsubscribe-notifications#<%= unsubscribeToken %> \ No newline at end of file diff --git a/plugins/talk-plugin-notifications/server/index.js b/plugins/talk-plugin-notifications/server/index.js new file mode 100644 index 000000000..0c7e993b9 --- /dev/null +++ b/plugins/talk-plugin-notifications/server/index.js @@ -0,0 +1,16 @@ +const path = require('path'); +const connect = require('./connect'); +const typeDefs = require('./typeDefs'); +const resolvers = require('./resolvers'); +const router = require('./router'); +const mutators = require('./mutators'); +const translations = path.join(__dirname, 'translations.yml'); + +module.exports = { + translations, + typeDefs, + resolvers, + mutators, + connect, + router, +}; diff --git a/plugins/talk-plugin-notifications/server/mutators.js b/plugins/talk-plugin-notifications/server/mutators.js new file mode 100644 index 000000000..5c0db9c8d --- /dev/null +++ b/plugins/talk-plugin-notifications/server/mutators.js @@ -0,0 +1,46 @@ +const { reduce, isNull, isEmpty } = require('lodash'); + +/** + * Reduce the settings to dotize the settings. + */ +function reduceSettings(newSettings, newValue, key) { + if (!isNull(newValue)) { + newSettings[`metadata.notifications.settings.${key}`] = newValue; + } + + return newSettings; +} + +/** + * Update the user notification settings. + */ +async function updateNotificationSettings(ctx, settings) { + const { connectors: { models: { User } }, user } = ctx; + + // Generate the settings set object, and just exit if we haven't changed + // anything. + const $set = reduce(settings, reduceSettings, {}); + if (isEmpty($set)) { + return; + } + + // Update the user. + return User.updateOne({ id: user.id }, { $set }); +} + +module.exports = ctx => { + let mutators = { + User: { + updateNotificationSettings: () => + Promise.reject(ctx.connectors.errors.ErrNotAuthorized), + }, + }; + + if (ctx.user) { + // TODO: check to see if the user is verified? + mutators.User.updateNotificationSettings = settings => + updateNotificationSettings(ctx, settings); + } + + return mutators; +}; diff --git a/plugins/talk-plugin-notifications/server/resolvers.js b/plugins/talk-plugin-notifications/server/resolvers.js new file mode 100644 index 000000000..0254361de --- /dev/null +++ b/plugins/talk-plugin-notifications/server/resolvers.js @@ -0,0 +1,19 @@ +const { get } = require('lodash'); + +module.exports = { + User: { + notificationSettings(user, args, { user: currentUser }) { + if ( + currentUser && + (currentUser.id === user.id || currentUser.can('VIEW_USER_STATUS')) + ) { + return get(user, 'metadata.notifications.settings', {}); + } + }, + }, + RootMutation: { + async updateNotificationSettings(obj, { input }, { mutators: { User } }) { + await User.updateNotificationSettings(input); + }, + }, +}; diff --git a/plugins/talk-plugin-notifications/server/router.js b/plugins/talk-plugin-notifications/server/router.js new file mode 100644 index 000000000..68919a936 --- /dev/null +++ b/plugins/talk-plugin-notifications/server/router.js @@ -0,0 +1,95 @@ +const path = require('path'); +const { UNSUBSCRIBE_SUBJECT } = require('./config'); +const { get, isEmpty, reduce } = require('lodash'); + +module.exports = router => { + router.get('/account/unsubscribe-notifications', (req, res) => { + res.render(path.join(__dirname, 'views/unsubscribe-notifications')); + }); + + /** + * Verifies that the token is valid. + */ + const verifyToken = (req, res, next) => { + const { + connectors: { secrets: { jwt }, config: { JWT_ISSUER, JWT_AUDIENCE } }, + } = req.context; + const { token: tokenString = '' } = req.body; + if (!tokenString) { + return res.status(400).end(); + } + + jwt.verify( + tokenString, + { + issuer: JWT_ISSUER, + subject: UNSUBSCRIBE_SUBJECT, + audience: JWT_AUDIENCE, + }, + (err, token) => { + if (err) { + return res.status(400).end(); + } + + req.token = token; + next(); + } + ); + }; + + // Verifies that a token is valid. + router.post( + '/api/v1/account/unsubscribe-notifications/verify', + verifyToken, + (req, res) => { + res.status(204).end(); + } + ); + + router.post( + '/api/v1/account/unsubscribe-notifications', + verifyToken, + async (req, res, next) => { + const { connectors: { models: { User } } } = req.context; + const { user: userID } = req.token; + + try { + const user = await User.findOne({ id: userID }); + if (!user) { + return res.status(400).end(); + } + + // Get the notification settings. + const settings = get(user, 'metadata.notifications.settings', {}); + + // If they have no notification settings set to true, then we're done. + if (isEmpty(settings)) { + return res.status(204).end(); + } + + const update = reduce( + settings, + (updates, value, key) => { + if (value) { + updates[`metadata.notifications.settings.${key}`] = false; + } + + return updates; + }, + {} + ); + + if (isEmpty(update)) { + return res.status(204).end(); + } + + // Save the user. + await User.update({ id: userID }, { $set: update }); + + res.status(204).end(); + } catch (err) { + res.status(400).end(); + } + } + ); +}; diff --git a/plugins/talk-plugin-notifications/server/translations.yml b/plugins/talk-plugin-notifications/server/translations.yml new file mode 100644 index 000000000..97c931a91 --- /dev/null +++ b/plugins/talk-plugin-notifications/server/translations.yml @@ -0,0 +1,12 @@ +en: + talk-plugin-notifications: + templates: + footer: "You received this notification because you are a commenter on {0} and you opted in to receive notifications." + links: + unsubscribe: "Unsubscribe from comment notifications" + unsubscribe_page: + unsubscribe: "Unsubscribe from comment notifications" + click_to_confirm: "Click below to confirm that you would like to unsubscribe from all notifications" + confirm: "Confirm" + are_unsubscribed: "You are now unsubscribed from all notifications." + token_invalid: "Unsubscribe link is invalid, click the link from a more recent email or visit a comment stream and login to change your notification preferences" \ No newline at end of file diff --git a/plugins/talk-plugin-notifications/server/typeDefs.graphql b/plugins/talk-plugin-notifications/server/typeDefs.graphql new file mode 100644 index 000000000..6b2a43b2e --- /dev/null +++ b/plugins/talk-plugin-notifications/server/typeDefs.graphql @@ -0,0 +1,21 @@ +# NotificationSettings stores all the preferences related to notifications. +type NotificationSettings { } + +type User { + notificationSettings: NotificationSettings +} + +type UpdateNotificationSettingsResponse implements Response { + # An array of errors relating to the mutation that occurred. + errors: [UserError!] +} + +input NotificationSettingsInput { + +} + +type RootMutation { + # updateNotificationSettings will update the current user's notification + # settings. + updateNotificationSettings(input: NotificationSettingsInput!): UpdateNotificationSettingsResponse +} \ No newline at end of file diff --git a/plugins/talk-plugin-notifications/server/typeDefs.js b/plugins/talk-plugin-notifications/server/typeDefs.js new file mode 100644 index 000000000..7ab1954e1 --- /dev/null +++ b/plugins/talk-plugin-notifications/server/typeDefs.js @@ -0,0 +1,7 @@ +const fs = require('fs'); +const path = require('path'); + +module.exports = fs.readFileSync( + path.join(__dirname, 'typeDefs.graphql'), + 'utf8' +); diff --git a/plugins/talk-plugin-notifications/server/views/unsubscribe-notifications.ejs b/plugins/talk-plugin-notifications/server/views/unsubscribe-notifications.ejs new file mode 100644 index 000000000..a34a45dbb --- /dev/null +++ b/plugins/talk-plugin-notifications/server/views/unsubscribe-notifications.ejs @@ -0,0 +1,64 @@ + + + + + <%= t('talk-plugin-notifications.unsubscribe_page.unsubscribe') %> + + + <%- include(root + '/partials/head') %> + + +
+
<%= t('talk-plugin-notifications.unsubscribe_page.token_invalid') %>
+ +
+ <%= t('talk-plugin-notifications.unsubscribe_page.click_to_confirm') %> + +
+
+ + + + \ No newline at end of file diff --git a/routes/index.js b/routes/index.js index 3727f76bb..143ceefd8 100644 --- a/routes/index.js +++ b/routes/index.js @@ -1,7 +1,6 @@ const SetupService = require('../services/setup'); const authentication = require('../middleware/authentication'); const cookieParser = require('cookie-parser'); -const debug = require('debug')('talk:routes'); const enabled = require('debug').enabled; const errors = require('../errors'); const express = require('express'); @@ -14,6 +13,7 @@ const staticMiddleware = require('express-static-gzip'); const { DISABLE_STATIC_SERVER } = require('../config'); const { passport } = require('../services/passport'); const { MOUNT_PATH } = require('../url'); +const context = require('../middleware/context'); const router = express.Router(); @@ -101,9 +101,12 @@ plugins.get('server', 'passport').forEach(plugin => { // Setup the PassportJS Middleware. router.use(passport.initialize()); +// Setup the Graph Context on the router. +router.use(authentication, context); + // Attach the authentication middleware, this will be responsible for decoding // (if present) the JWT on the request. -router.use('/api', authentication, require('./api')); +router.use('/api', require('./api')); //============================================================================== // DEVELOPMENT ROUTES @@ -136,17 +139,8 @@ if (process.env.NODE_ENV !== 'production') { }); } -//============================================================================== -// PLUGIN ROUTES -//============================================================================== - -// Inject server route plugins. -plugins.get('server', 'router').forEach(plugin => { - debug(`added plugin '${plugin.plugin.name}'`); - - // Pass the root router to the plugin to mount it's routes. - plugin.router(router); -}); +// Mount the plugin routes. +router.use(require('./plugins')); //============================================================================== // ERROR HANDLING diff --git a/routes/plugins.js b/routes/plugins.js new file mode 100644 index 000000000..647acdb75 --- /dev/null +++ b/routes/plugins.js @@ -0,0 +1,23 @@ +const express = require('express'); +const debug = require('debug')('talk:routes:plugins'); +const plugins = require('../services/plugins'); +const staticTemplate = require('../middleware/staticTemplate'); + +const router = express.Router(); + +// Routes mounted from plugins won't have access to our internal partials +// directory, so we should make that available. +router.use(staticTemplate, (req, res, next) => { + res.locals.root = res.app.get('views'); + next(); +}); + +// Inject server route plugins. +plugins.get('server', 'router').forEach(plugin => { + debug(`added plugin '${plugin.plugin.name}'`); + + // Pass the root router to the plugin to mount it's routes. + plugin.router(router); +}); + +module.exports = router; diff --git a/scripts/docker.sh b/scripts/docker.sh index 06f0cb279..f11aeb208 100755 --- a/scripts/docker.sh +++ b/scripts/docker.sh @@ -61,11 +61,11 @@ docker build -t coralproject/talk:latest-onbuild -f Dockerfile.onbuild . if [ "$1" = "deploy" ] then - if [[ -n "$DOCKER_EMAIL" && -n "$DOCKER_USER" && -n "$DOCKER_PASS" ]] + if [[ -n "$DOCKER_USER" && -n "$DOCKER_PASS" ]] then # Log the Docker Daemon in - docker login -e $DOCKER_EMAIL -u $DOCKER_USER -p $DOCKER_PASS + docker login -u $DOCKER_USER -p $DOCKER_PASS fi # deploy based on the env diff --git a/scripts/e2e.js b/scripts/e2e.js index fb010f9e5..37ada228a 100755 --- a/scripts/e2e.js +++ b/scripts/e2e.js @@ -139,61 +139,81 @@ async function runBrowserTests( return Object.keys(succeeded).length === browsers.length; } -async function start(program) { - const localIdentifier = uuid(); - let browsers = program.browsers.split(','); - const retries = Number.parseInt(program.retries); - const browserstack = {}; - const date = new Date() - .toISOString() - .replace(/[T.]/g, '-') - .replace(/:/g, ''); - const timeout = program.timeout; - const reportsFolder = `${program.reportsFolder}/${date}`; - let exitCode = 0; - let config = 'nightwatch.conf.js'; - try { - if (program.tunnel && program.bsKey) { - await startTunnel(program.bsKey, localIdentifier); +class E2E { + constructor(opts) { + this.browserstackEnabled = Boolean(opts.bsKey && opts.browserstack); + if (this.browserstackEnabled && opts.headless) { + console.error('--browserstack and --headless cannot be combined'); + process.exit(1); } - console.log('Dropping test database'); - await mongoose.connection.dropDatabase(); - await serve(); - - if (program.bsKey) { - config = 'nightwatch-browserstack.conf.js'; - browserstack.localIdentifier = localIdentifier; - browserstack.key = program.bsKey; - browserstack.user = program.bsUser; - } else { - // Install selenium standalone. - await seleniumInstall(); - if (program.headless) { - browsers = browsers.map(b => `${b}-headless`); + this.localIdentifier = uuid(); + this.retries = Number.parseInt(opts.retries); + this.browserstack = {}; + this.date = new Date() + .toISOString() + .replace(/[T.]/g, '-') + .replace(/:/g, ''); + this.browsers = opts.browsers.split(',').map(browser => { + if (opts.headless) { + return `${browser}-headless`; } - } - const succeeded = await runBrowserTests( - browsers, - config, - retries, - reportsFolder, - browserstack, - timeout - ); - if (!succeeded) { - exitCode = 1; + return browser; + }); + this.timeout = opts.timeout; + this.reportsFolder = `${opts.reportsFolder}/${this.date}`; + this.config = this.browserstackEnabled + ? 'nightwatch-browserstack.conf.js' + : 'nightwatch.conf.js'; + this.tunnel = opts.tunnel; + this.bsKey = opts.bsKey; + this.bsUser = opts.bsUser; + } + + async start() { + let exitCode = 0; + try { + if (this.tunnel && this.bsKey) { + await startTunnel(this.bsKey, this.localIdentifier); + } + + console.log('Dropping test database'); + await mongoose.connection.dropDatabase(); + console.log('Starting the server'); + await serve(); + + if (this.browserstackEnabled) { + browserstack.localIdentifier = this.localIdentifier; + browserstack.key = this.bsKey; + browserstack.user = this.bsUser; + } else { + // Install selenium standalone. + await seleniumInstall(); + } + + // Run the tests. + const succeeded = await runBrowserTests( + this.browsers, + this.config, + this.retries, + this.reportsFolder, + browserstack, + this.timeout + ); + if (!succeeded) { + exitCode = 1; + } + } catch (err) { + console.log('There was an error:\n\n'); + process.stderr.write(`${err.stack}\n`); + process.exit(2); + } finally { + console.log('Shutting down'); + shutdown(); + process.exit(exitCode); } - } catch (ex) { - console.log('There was an error:\n\n'); - process.stderr.write(`${ex.stack}\n`); - process.exit(2); - } finally { - console.log('Shutting down'); - shutdown(); } - process.exit(exitCode); } program @@ -202,7 +222,12 @@ program 'Perform e2e testing locally or if browserstack credentials are provided on browserstack.' ) .option('-u, --bs-user [user]', 'Browserstack user', 'coralproject2') - .option('-k, --bs-key [key]', 'Browserstack api key') + .option( + '-k, --bs-key [key]', + 'Browserstack api key', + process.env.BROWSERSTACK_KEY + ) + .option('--browserstack', 'Enables Browserstack testing') .option('--no-tunnel', 'Dont start browserstack-local') .option('-b, --browsers [list of browsers]', 'Browsers to test', 'chrome') .option('-r, --retries [number]', 'Number of retries before failing', '1') @@ -211,4 +236,5 @@ program .option('--timeout [number]', 'Timeout for WaitForConditions', '10000') .parse(process.argv); -start(program); +const e2e = new E2E(program); +e2e.start(); diff --git a/serve.js b/serve.js index 77de110cf..a96b12202 100644 --- a/serve.js +++ b/serve.js @@ -2,10 +2,10 @@ const app = require('./app'); const debug = require('debug')('talk:cli:serve'); const errors = require('./errors'); const { createServer } = require('http'); -const scraper = require('./services/scraper'); -const mailer = require('./services/mailer'); +const jobs = require('./jobs'); const MigrationService = require('./services/migration'); const SetupService = require('./services/setup'); +const PluginsService = require('./services/plugins'); const kue = require('./services/kue'); const mongoose = require('./services/mongoose'); const cache = require('./services/cache'); @@ -78,7 +78,10 @@ async function onListening() { /** * Start the app. */ -async function serve({ jobs = false, websockets = false } = {}) { +async function serve({ jobs: processJobs = false, websockets = false } = {}) { + // Run the deferred plugins. + PluginsService.runDeferred(); + // Start the cache instance. await cache.init(); @@ -132,19 +135,16 @@ async function serve({ jobs = false, websockets = false } = {}) { }); // Enable job processing on the thread if enabled. - if (jobs) { - // Start the scraper processor. - scraper.process(); - + if (processJobs) { // Start the mail processor. - mailer.process(); + jobs.process(); } // Define a safe shutdown function to call in the event we need to shutdown // because the node hooks are below which will interrupt the shutdown process. // Shutdown the mongoose connection, the app server, and the scraper. util.onshutdown([ - () => (jobs ? kue.Task.shutdown() : null), + () => (processJobs ? kue.Task.shutdown() : null), () => mongoose.disconnect(), () => server.close(), ]); diff --git a/services/actions.js b/services/actions.js index 055a812f8..1c95e5128 100644 --- a/services/actions.js +++ b/services/actions.js @@ -3,8 +3,34 @@ const CommentModel = require('../models/comment'); const UserModel = require('../models/user'); const _ = require('lodash'); const errors = require('../errors'); -const events = require('./events'); -const { ACTIONS_NEW, ACTIONS_DELETE } = require('./events/constants'); + +const incrActionCounts = async (action, value) => { + const ACTION_TYPE = action.action_type.toLowerCase(); + + const query = { id: action.item_id }; + const update = { + [`action_counts.${ACTION_TYPE}`]: value, + }; + + if (action.group_id && action.group_id.length > 0) { + const GROUP_ID = action.group_id.toLowerCase(); + + update[`action_counts.${ACTION_TYPE}_${GROUP_ID}`] = value; + } + + switch (action.item_type) { + case 'USERS': + return UserModel.update(query, { + $inc: update, + }); + case 'COMMENTS': + return CommentModel.update(query, { + $inc: update, + }); + default: + return; + } +}; /** * findOnlyOneAndUpdate will perform a fondOneAndUpdate on the mongo collection @@ -58,14 +84,12 @@ module.exports = class ActionsService { /** * Inserts an action. * - * @param {String} item_id identifier of the item (uuid) - * @param {String} user_id user id of the action (uuid) * @param {String} action the new action to the item * @return {Promise} */ static async create(action) { - // Actions are made unique by using a query that can be reproducable, i.e., - // not containing user inputable values. + // Actions are made unique by using a query that can be reproducible, i.e., + // not containing user modifiable values. let foundAction = await findOnlyOneAndUpdate( { action_type: action.action_type, @@ -80,8 +104,7 @@ module.exports = class ActionsService { } ); - // Emit that there was a new action created. - await events.emitAsync(ACTIONS_NEW, foundAction); + await incrActionCounts(action, 1); return foundAction; } @@ -119,19 +142,6 @@ module.exports = class ActionsService { }); } - /** - * Finds all comments for a specific action. - * - * @param {String} action_type type of action - * @param {String} item_type type of item the action is on - */ - static findByType(action_type, item_type) { - return ActionModel.find({ - action_type: action_type, - item_type: item_type, - }); - } - /** * delete will remove the record from the collection if it exists. Otherwise * it will do nothing. This will then return the deleted action. @@ -148,8 +158,7 @@ module.exports = class ActionsService { return; } - // Emit that the action was deleted. - await events.emitAsync(ACTIONS_DELETE, action); + await incrActionCounts(action, -1); return action; } @@ -170,68 +179,3 @@ module.exports = class ActionsService { ); } }; - -const incrActionCounts = async (action, value) => { - const ACTION_TYPE = action.action_type.toLowerCase(); - - const update = { - [`action_counts.${ACTION_TYPE}`]: value, - }; - - if (action.group_id && action.group_id.length > 0) { - const GROUP_ID = action.group_id.toLowerCase(); - - update[`action_counts.${ACTION_TYPE}_${GROUP_ID}`] = value; - } - - try { - switch (action.item_type) { - case 'USERS': - return UserModel.update( - { - id: action.item_id, - }, - { - $inc: update, - } - ); - case 'COMMENTS': - return CommentModel.update( - { - id: action.item_id, - }, - { - $inc: update, - } - ); - default: - throw new Error('Invalid item type for action summary monitoring'); - } - } catch (err) { - console.error(`Can't mutate the action_counts.${ACTION_TYPE}:`, err); - } -}; - -// When a new action is created, modify the comment. -events.on(ACTIONS_NEW, async action => { - if ( - !action || - (action.item_type !== 'COMMENTS' && action.item_type !== 'USERS') - ) { - return; - } - - return incrActionCounts(action, 1); -}); - -// When an action is deleted, remove the action count on the comment. -events.on(ACTIONS_DELETE, async action => { - if ( - !action || - (action.item_type !== 'COMMENTS' && action.item_type !== 'USERS') - ) { - return; - } - - return incrActionCounts(action, -1); -}); diff --git a/services/comments.js b/services/comments.js index d7e151938..43cd5c259 100644 --- a/services/comments.js +++ b/services/comments.js @@ -1,23 +1,41 @@ const CommentModel = require('../models/comment'); const debug = require('debug')('talk:services:comments'); -const ActionsService = require('./actions'); const SettingsService = require('./settings'); const cloneDeep = require('lodash/cloneDeep'); const errors = require('../errors'); -const events = require('./events'); const merge = require('lodash/merge'); +<<<<<<< HEAD const { dotize } = require('./utils'); const { COMMENTS_NEW, COMMENTS_EDIT } = require('./events/constants'); +======= +>>>>>>> 8d147dbf47104cdcfb8c3bc2ebb02b6c73c7b8ab -module.exports = class CommentsService { +const incrReplyCount = async (comment, value) => { + try { + await CommentModel.update( + { + id: comment.parent_id, + }, + { + $inc: { + reply_count: value, + }, + } + ); + } catch (err) { + console.error("Can't mutate the reply count:", err); + } +}; + +module.exports = { /** * Creates a new Comment that came from a public source. * @param {Object} input either a single comment or an array of comments. * @return {Promise} */ - static async publicCreate(input) { + publicCreate: async input => { // Extract the parent_id from the comment, if there is one. const { status = 'NONE', parent_id = null } = input; const created_at = new Date(); @@ -55,27 +73,10 @@ module.exports = class CommentsService { ); // Emit that the comment was created! - await events.emitAsync(COMMENTS_NEW, comment); + await incrReplyCount(comment, 1); return comment; - } - - /** - * lastUnmoderatedStatus will retrieve the last status before this one. - * - * @param {Object} comment the comment to get the last status of - */ - static lastUnmoderatedStatus(comment) { - const UNMODERATED_STATUSES = ['NONE', 'PREMOD']; - - for (let i = comment.status_history.length - 1; i >= 0; i--) { - const { type } = comment.status_history[i]; - - if (UNMODERATED_STATUSES.includes(type)) { - return type; - } - } - } + }, /** * Edit a Comment. @@ -85,7 +86,11 @@ module.exports = class CommentsService { * @param {String} body the new Comment body * @param {String} status the new Comment status */ +<<<<<<< HEAD static async edit({ id, author_id, body, status, metadata = {} }) { +======= + edit: async ({ id, author_id, body, status }) => { +>>>>>>> 8d147dbf47104cdcfb8c3bc2ebb02b6c73c7b8ab const EDITABLE_STATUSES = ['NONE', 'PREMOD', 'ACCEPTED']; const created_at = new Date(); @@ -127,7 +132,7 @@ module.exports = class CommentsService { if (originalComment == null) { // Try to get the comment. - const comment = await CommentsService.findById(id); + const comment = await CommentModel.findOne({ id }); if (comment == null) { debug('rejecting comment edit because comment was not found'); throw errors.ErrNotFound; @@ -172,88 +177,15 @@ module.exports = class CommentsService { created_at, }); +<<<<<<< HEAD editedComment.metadata = metadata; await events.emitAsync(COMMENTS_EDIT, originalComment, editedComment); +======= +>>>>>>> 8d147dbf47104cdcfb8c3bc2ebb02b6c73c7b8ab return editedComment; - } - - /** - * Finds a comment by the id. - * @param {String} id identifier of comment (uuid) - * @return {Promise} - */ - static findById(id) { - return CommentModel.findOne({ id }); - } - - /** - * Finds ALL the comments by the asset_id. - * @param {String} asset_id identifier of the asset which owns this comment (uuid) - * @return {Promise} - */ - static findByAssetId(asset_id) { - return CommentModel.find({ - asset_id, - }); - } - - /** - * findByAssetIdWithStatuses finds all the comments where the asset id matches - * what's provided and the status is one of the ones listed in the statuses - * array. - * @param {String} asset_id the asset id to search by - * @param {Array} [statuses=[]] the array of statuses to search by - * @return {Promise} resolves to an array of comments - */ - static findByAssetIdWithStatuses(asset_id, statuses = []) { - return CommentModel.find({ - asset_id, - status: { - $in: statuses, - }, - }); - } - - /** - * Find comments by an action that was performed on them. - * @param {String} action_type the type of action that was performed on the comment - * @return {Promise} - */ - static findByActionType(action_type) { - return ActionsService.findCommentsIdByActionType( - action_type, - 'COMMENTS' - ).then(actions => - CommentModel.find({ - id: { - $in: actions.map(a => a.item_id), - }, - }) - ); - } - - /** - * Find comment id's where the action type matches the argument. - * @param {String} action_type the type of action that was performed on the comment - * @return {Promise} - */ - static findIdsByActionType(action_type) { - return ActionsService.findCommentsIdByActionType( - action_type, - 'COMMENTS' - ).then(actions => actions.map(a => a.item_id)); - } - - /** - * Find comments by current status - * @param {String} status status of the comment to search for - * @return {Promise} resovles to comment array - */ - static findByStatus(status = 'NONE') { - return CommentModel.find({ status }); - } + }, /** * Pushes a new status in for the user. @@ -263,7 +195,7 @@ module.exports = class CommentsService { * moderation action * @return {Promise} */ - static async pushStatus(id, status, assigned_by = null) { + pushStatus: async (id, status, assigned_by = null) => { const created_at = new Date(); const originalComment = await CommentModel.findOneAndUpdate( { id }, @@ -291,83 +223,16 @@ module.exports = class CommentsService { }); editedComment.status = status; - // Emit that the comment was edited, and pass the original comment and the - // edited comment. - await events.emitAsync(COMMENTS_EDIT, originalComment, editedComment); + // If the comment was visible before, and now it isn't, decrement the count; + if (originalComment.visible && !editedComment.visible) { + await incrReplyCount(editedComment, -1); + } + + // If the comment was not visible before, and now it is, increment the count. + if (!originalComment.visible && editedComment.visible) { + await incrReplyCount(editedComment, 1); + } return editedComment; - } - - /** - * Add an action to the comment. - * @param {String} item_id identifier of the comment (uuid) - * @param {String} user_id user id of the action (uuid) - * @param {String} action the new action to the comment - * @return {Promise} - */ - static addAction(item_id, user_id, action_type, metadata = {}) { - return ActionsService.create({ - item_id, - item_type: 'COMMENTS', - user_id, - action_type, - metadata, - }); - } + }, }; - -//============================================================================== -// Event Hooks -//============================================================================== - -const incrReplyCount = async (comment, value) => { - try { - await CommentModel.update( - { - id: comment.parent_id, - }, - { - $inc: { - reply_count: value, - }, - } - ); - } catch (err) { - console.error("Can't mutate the reply count:", err); - } -}; - -// When a comment is created, if it is a reply, increment the reply count on the -// parent's document. -events.on(COMMENTS_NEW, async comment => { - if ( - !comment || // Check that the comment is defined. - (!comment.parent_id || comment.parent_id.length === 0) || // Check that the comment has a parent (is a reply). - !(comment.status === 'NONE' || comment.status === 'ACCEPTED') // Check that the comment is visible. - ) { - return; - } - - return incrReplyCount(comment, 1); -}); - -// When a comment is edited, if the visability changed publicly, then modify the -// comment. -events.on(COMMENTS_EDIT, async (originalComment, editedComment) => { - if ( - !editedComment || // Check that the comment is defined. - (!editedComment.parent_id || editedComment.parent_id.length === 0) // Check that the comment has a parent (is a reply). - ) { - return; - } - - // If the comment was visible before, and now it isn't, decrement the count; - if (originalComment.visible && !editedComment.visible) { - return incrReplyCount(editedComment, -1); - } - - // If the comment was not visible before, and now it is, increment the count. - if (!originalComment.visible && editedComment.visible) { - return incrReplyCount(editedComment, 1); - } -}); diff --git a/services/events/constants.js b/services/events/constants.js deleted file mode 100644 index f3aa84d62..000000000 --- a/services/events/constants.js +++ /dev/null @@ -1,10 +0,0 @@ -module.exports = { - USERS_NEW: 'USERS_NEW', - ACTIONS_DELETE: 'ACTIONS_DELETE', - ACTIONS_NEW: 'ACTIONS_NEW', - COMMENTS_NEW: 'COMMENTS_NEW', - COMMENTS_EDIT: 'COMMENTS_EDIT', - USERS_SUSPENSION_CHANGE: 'USERS_SUSPENSION_CHANGE', - USERS_BAN_CHANGE: 'USERS_BAN_CHANGE', - USERS_USERNAME_STATUS_CHANGE: 'USERS_USERNAME_STATUS_CHANGE', -}; diff --git a/services/events/index.js b/services/events/index.js deleted file mode 100644 index 2698df653..000000000 --- a/services/events/index.js +++ /dev/null @@ -1,36 +0,0 @@ -const { EventEmitter2 } = require('eventemitter2'); -const constants = require('./constants'); -const debug = require('debug')('talk:services:events'); -const enabled = require('debug').enabled('talk:services:events'); - -const emitter = new EventEmitter2({ - wildcard: true, -}); - -// If event debugging is enabled, bind the debugger to all events being emitted -// and log a debug message. -if (enabled) { - emitter.onAny(function(event) { - debug( - `[${event}] ${arguments.length - 1} argument${ - arguments.length - 1 === 1 ? '' : 's' - }` - ); - }); -} - -// Allow any number of listeners to attach to this. -emitter.setMaxListeners(0); - -// The default error handler. -emitter.on('error', err => { - console.error('events error:', err); -}); - -emitter.on('newListener', event => { - if (!(event in constants)) { - throw new Error(`Event[${event}] not a valid event name`); - } -}); - -module.exports = emitter; diff --git a/services/jwt.js b/services/jwt.js index 356adbb62..c36ea4c97 100644 --- a/services/jwt.js +++ b/services/jwt.js @@ -101,9 +101,12 @@ class Secret { jwt.verify( token, this.verifiyingKey, - Object.assign({}, options, { - algorithms: [this.algorithm], - }), + omitBy( + merge({}, options, { + algorithms: [this.algorithm], + }), + isUndefined + ), callback ); } diff --git a/services/logging.js b/services/logging.js new file mode 100644 index 000000000..48367f834 --- /dev/null +++ b/services/logging.js @@ -0,0 +1,16 @@ +const { version } = require('../package.json'); +const Logger = require('bunyan'); +const uuid = require('uuid/v1'); + +// Create the logging instance that all logger's are branched from. +function createLogger(name, id = uuid()) { + return new Logger({ + src: true, + name, + id, + version, + serializers: { req: Logger.stdSerializers.req }, + }); +} + +module.exports = { createLogger }; diff --git a/services/mailer.js b/services/mailer.js deleted file mode 100644 index 67cb188be..000000000 --- a/services/mailer.js +++ /dev/null @@ -1,148 +0,0 @@ -const debug = require('debug')('talk:services:mailer'); -const nodemailer = require('nodemailer'); -const kue = require('./kue'); -const i18n = require('./i18n'); -const path = require('path'); -const fs = require('fs-extra'); -const _ = require('lodash'); -const { TEMPLATE_LOCALS } = require('../middleware/staticTemplate'); - -const { - SMTP_HOST, - SMTP_USERNAME, - SMTP_PORT, - SMTP_PASSWORD, - SMTP_FROM_ADDRESS, - EMAIL_SUBJECT_PREFIX, -} = require('../config'); - -// load all the templates as strings -const templates = { - data: {}, -}; - -// load the templates per request during development -templates.render = async (name, format = 'txt', context) => { - if (process.env.NODE_ENV === 'production') { - // If we are in production mode, check the view cache. - const view = _.get(templates.data, [name, format], null); - if (view !== null) { - return view(context); - } - } - - const filename = path.join( - __dirname, - 'email', - [name, format, 'ejs'].join('.') - ); - const file = await fs.readFile(filename, 'utf8'); - const view = _.template(file); - - if (process.env.NODE_ENV === 'production') { - // If we are in production mode, fill the view cache. - _.set(templates.data, [name, format], view); - } - - return view(context); -}; - -const mailer = {}; - -// enabled is true when the required configuration is available. When testing -// is enabled, we will be simulating that emails are being sent, because in a -// production system, emails should and would be sent. -mailer.enabled = - Boolean(SMTP_HOST && SMTP_USERNAME && SMTP_PASSWORD && SMTP_FROM_ADDRESS) || - process.env.NODE_ENV === 'test'; - -if (mailer.enabled) { - const options = { - host: SMTP_HOST, - auth: { - user: SMTP_USERNAME, - pass: SMTP_PASSWORD, - }, - }; - - if (SMTP_PORT) { - try { - options.port = parseInt(SMTP_PORT); - } catch (e) { - throw new Error('TALK_SMTP_PORT is not an integer'); - } - } else { - options.port = 25; - } - - mailer.transport = nodemailer.createTransport(options); -} - -/** - * Create the new Task kue. - */ -mailer.task = new kue.Task({ - name: 'mailer', -}); - -/** - * send will create a new message and send it. - */ -mailer.send = async options => { - if (!mailer.enabled) { - const err = new Error( - 'sending email is not enabled because required configuration is not available' - ); - console.warn(err); - return; - } - - // Create the new locals object and attach the static locals and the i18n - // framework. - const locals = _.merge({}, options.locals, TEMPLATE_LOCALS, { t: i18n.t }); - - // Render the templates. - const [html, text] = await Promise.all( - ['html', 'txt'].map(fmt => { - return templates.render(options.template, fmt, locals); - }) - ); - - // Create the job to send the email later. - return mailer.task.create({ - title: 'Mail', - message: { - to: options.to, - subject: `${EMAIL_SUBJECT_PREFIX} ${options.subject}`, - text, - html, - }, - }); -}; - -/** - * Start the queue processor for the mailer job. - */ -mailer.process = () => { - debug(`Now processing ${mailer.task.name} jobs`); - - return mailer.task.process(({ id, data }, done) => { - debug(`Starting to send mail for Job[${id}]`); - - // Set the `from` field. - data.message.from = SMTP_FROM_ADDRESS; - - // Actually send the email. - mailer.transport.sendMail(data.message, err => { - if (err) { - debug(`Failed to send mail for Job[${id}]:`, err); - return done(err); - } - - debug(`Finished sending mail for Job[${id}]`); - return done(); - }); - }); -}; - -module.exports = mailer; diff --git a/services/mailer/index.js b/services/mailer/index.js new file mode 100644 index 000000000..5f6adedef --- /dev/null +++ b/services/mailer/index.js @@ -0,0 +1,112 @@ +const kue = require('../kue'); +const i18n = require('../i18n'); +const { get, merge, isObject } = require('lodash'); +const { TEMPLATE_LOCALS } = require('../../middleware/staticTemplate'); +const debug = require('debug')('talk:services:mailer'); +const { SMTP_FROM_ADDRESS, EMAIL_SUBJECT_PREFIX } = require('../../config'); +const templates = require('./templates'); + +// createRecipient will extract the recipient details from the options. +const createRecipient = options => { + // Try to get the email if it was explicitly provided. + const email = get(options, 'email'); + if (email) { + return { email }; + } + + // Try to get the user if the email wasn't explicitly provided. + const user = isObject(options.user) ? get(options.user, 'id') : options.user; + if (user) { + return { user }; + } + + // If we don't have a user or a email, we can't send an email. + throw new Error('user/email not provided'); +}; + +// createMessage creates a message payload to send a email to a user. +const createMessage = async options => { + // Create the new locals object and attach the static locals and the i18n + // framework. + const locals = merge({}, mailer.helpers, options.locals, TEMPLATE_LOCALS, { + t: i18n.t, + }); + + // Render the templates. + const [html, text] = await Promise.all( + ['html', 'txt'].map(fmt => { + return mailer.templates.render(options.template, fmt, locals); + }) + ); + + const subject = EMAIL_SUBJECT_PREFIX + ? `${EMAIL_SUBJECT_PREFIX} ${options.subject}` + : options.subject; + + return { + html, + text, + subject, + from: SMTP_FROM_ADDRESS, + }; +}; + +const mailer = { templates, helpers: {} }; + +/** + * Create the new Task kue. + */ +mailer.task = new kue.Task({ + name: 'mailer', +}); + +/** + * registerHelpers will register the helpers on the mailer. + * + * @param {Object} helpers the helpers in object form that should be used by the + * mailer. + */ +mailer.registerHelpers = helpers => { + mailer.helpers = merge(mailer.helpers, helpers); +}; + +/** + * queue will add the message to the sending queue. + * + * @param {Object} message the message to be sent + * @param {Object} recipient the recipient to send it to + */ +mailer.queue = async (message, recipient) => { + debug('Creating Job'); + + // Create the job to send the email later. + const job = await mailer.task.create( + merge( + { + title: 'Mail', + message, + }, + recipient + ) + ); + + debug(`Created Job[${job.id}]`); + + return job; +}; + +/** + * send will prepare the message and queue the message to be sent. + */ +mailer.send = async options => { + // Create the recipient to sent the message to. + const recipient = createRecipient(options); + + // Create the message to send. + const message = await createMessage(options); + + // Create the job to send the message. + return mailer.queue(message, recipient); +}; + +module.exports = mailer; diff --git a/services/mailer/templates.js b/services/mailer/templates.js new file mode 100644 index 000000000..59bcdda5a --- /dev/null +++ b/services/mailer/templates.js @@ -0,0 +1,58 @@ +const path = require('path'); +const fs = require('fs-extra'); +const { get, set, template } = require('lodash'); + +// load all the templates as strings +const templates = { + cache: {}, + registered: {}, +}; + +// Registers a template with the given filename and format. +templates.register = async (filename, name, format) => { + // Check to see if this template was already registered. + if (get(templates.registered, [name, format], null) !== null) { + return; + } + + const file = await fs.readFile(filename, 'utf8'); + const view = template(file); + + set(templates.registered, [name, format], view); +}; + +// load the templates per request during development +templates.render = async (name, format = 'txt', context) => { + // Check to see if the template is a registered template (provided by a plugin + // ) and prefer that first. + let view = get(templates.registered, [name, format], null); + if (view !== null) { + return view(context); + } + + if (process.env.NODE_ENV === 'production') { + // If we are in production mode, check the view cache. + const view = get(templates.cache, [name, format], null); + if (view !== null) { + return view(context); + } + } + + // Template was not registered and was not cached. Let's try and find it! + const filename = path.join( + __dirname, + 'templates', + [name, format, 'ejs'].join('.') + ); + const file = await fs.readFile(filename, 'utf8'); + view = template(file); + + if (process.env.NODE_ENV === 'production') { + // If we are in production mode, fill the view cache. + set(templates.cache, [name, format], view); + } + + return view(context); +}; + +module.exports = templates; diff --git a/services/email/email-confirm.html.ejs b/services/mailer/templates/email-confirm.html.ejs similarity index 100% rename from services/email/email-confirm.html.ejs rename to services/mailer/templates/email-confirm.html.ejs diff --git a/services/email/email-confirm.txt.ejs b/services/mailer/templates/email-confirm.txt.ejs similarity index 100% rename from services/email/email-confirm.txt.ejs rename to services/mailer/templates/email-confirm.txt.ejs diff --git a/services/email/password-reset.html.ejs b/services/mailer/templates/password-reset.html.ejs similarity index 100% rename from services/email/password-reset.html.ejs rename to services/mailer/templates/password-reset.html.ejs diff --git a/services/email/password-reset.txt.ejs b/services/mailer/templates/password-reset.txt.ejs similarity index 100% rename from services/email/password-reset.txt.ejs rename to services/mailer/templates/password-reset.txt.ejs diff --git a/services/email/plain.html.ejs b/services/mailer/templates/plain.html.ejs similarity index 100% rename from services/email/plain.html.ejs rename to services/mailer/templates/plain.html.ejs diff --git a/services/email/plain.txt.ejs b/services/mailer/templates/plain.txt.ejs similarity index 100% rename from services/email/plain.txt.ejs rename to services/mailer/templates/plain.txt.ejs diff --git a/services/pubsub.js b/services/pubsub.js deleted file mode 100644 index 3bfb9aaa3..000000000 --- a/services/pubsub.js +++ /dev/null @@ -1,24 +0,0 @@ -const { RedisPubSub } = require('graphql-redis-subscriptions'); -const { createClient } = require('./redis'); - -/** - * getClient returns the pubsub singleton for this instance. - */ -let pubsub = null; -const getClient = () => { - if (pubsub !== null) { - return pubsub; - } - - // Create the new PubSub client, we only need one per instance of Talk. - pubsub = new RedisPubSub({ - publisher: createClient(), - subscriber: createClient(), - }); - - return pubsub; -}; - -module.exports = { - getClient, -}; diff --git a/services/scraper.js b/services/scraper.js index 36f935876..daba96a99 100644 --- a/services/scraper.js +++ b/services/scraper.js @@ -1,9 +1,5 @@ const kue = require('./kue'); const debug = require('debug')('talk:services:scraper'); -const AssetModel = require('../models/asset'); -const AssetsService = require('./assets'); - -const metascraper = require('metascraper'); /** * Exposes a service object to allow operations to execute against the scraper. @@ -20,93 +16,17 @@ const scraper = { /** * Creates a new scraper job and scrapes the url when it gets processed. */ - create(asset) { + async create(asset) { debug(`Creating job for Asset[${asset.id}]`); - return scraper.task - .create({ - title: `Scrape for asset ${asset.id}`, - asset_id: asset.id, - }) - .then(job => { - debug(`Created Job[${job.id}] for Asset[${asset.id}]`); - - return job; - }); - }, - - /** - * Scrapes the given asset for metadata. - */ - async scrape(asset) { - return metascraper.scrapeUrl( - asset.url, - Object.assign({}, metascraper.RULES, { - section: $ => $('meta[property="article:section"]').attr('content'), - modified: $ => $('meta[property="article:modified"]').attr('content'), - }) - ); - }, - - /** - * Updates an Asset based on scraped asset metadata. - */ - update(id, meta) { - return AssetModel.update( - { id }, - { - $set: { - title: meta.title || '', - description: meta.description || '', - image: meta.image ? meta.image : '', - author: meta.author || '', - publication_date: meta.date || '', - modified_date: meta.modified || '', - section: meta.section || '', - scraped: new Date(), - }, - } - ); - }, - - /** - * Start the queue processor for the scraper job. - */ - process() { - debug(`Now processing ${scraper.task.name} jobs`); - - scraper.task.process(async (job, done) => { - debug(`Starting on Job[${job.id}] for Asset[${job.data.asset_id}]`); - - try { - // Find the asset, or complain that it doesn't exist. - const asset = await AssetsService.findById(job.data.asset_id); - if (!asset) { - return done(new Error('asset not found')); - } - - // Scrape the metadata from the asset. - const meta = await scraper.scrape(asset); - - debug( - `Scraped ${JSON.stringify(meta)} on Job[${job.id}] for Asset[${ - job.data.asset_id - }]` - ); - - // Assign the metadata retrieved for the asset to the db. - await scraper.update(job.data.asset_id, meta); - } catch (err) { - debug( - `Failed to scrape on Job[${job.id}] for Asset[${job.data.asset_id}]:`, - err - ); - return done(err); - } - - debug(`Finished on Job[${job.id}] for Asset[${job.data.asset_id}]`); - done(); + const job = await scraper.task.create({ + title: `Scrape for asset ${asset.id}`, + asset_id: asset.id, }); + + debug(`Created Job[${job.id}] for Asset[${asset.id}]`); + + return job; }, }; diff --git a/services/users.js b/services/users.js index a8a6b292b..f5319122c 100644 --- a/services/users.js +++ b/services/users.js @@ -1,28 +1,13 @@ const uuid = require('uuid'); const bcrypt = require('bcryptjs'); const errors = require('../errors'); -const some = require('lodash/some'); -const merge = require('lodash/merge'); - -const { - USERS_NEW, - USERS_SUSPENSION_CHANGE, - USERS_BAN_CHANGE, - USERS_USERNAME_STATUS_CHANGE, -} = require('./events/constants'); -const events = require('./events'); - +const { some, merge } = require('lodash'); const { ROOT_URL } = require('../config'); - const { jwt: JWT_SECRET } = require('../secrets'); - const debug = require('debug')('talk:services:users'); - const UserModel = require('../models/user'); - const RECAPTCHA_WINDOW = '10m'; // 10 minutes. const RECAPTCHA_INCORRECT_TRIGGER = 5; // after 5 incorrect attempts, recaptcha will be required. - const ActionsService = require('./actions'); const mailer = require('./mailer'); const i18n = require('./i18n'); @@ -125,12 +110,16 @@ class UsersService { ); } - // Emit that the user username status was changed. - await events.emitAsync(USERS_SUSPENSION_CHANGE, user, { - until, - message, - assignedBy, - }); + // Check to see if the user was suspended now and is currently suspended. + if (user.suspended && message && message.length > 0) { + await UsersService.sendEmail(user, { + template: 'plain', + locals: { + body: message, + }, + subject: 'Your account has been suspended', + }); + } return user; } @@ -174,12 +163,16 @@ class UsersService { throw new Error('ban status change edit failed for an unknown reason'); } - // Emit that the user ban status was changed. - await events.emitAsync(USERS_BAN_CHANGE, user, { - status, - assignedBy, - message, - }); + // Check to see if the user was banned now and is currently banned. + if (user.banned && status && message && message.length > 0) { + await UsersService.sendEmail(user, { + template: 'plain', + locals: { + body: message, + }, + subject: 'Your account has been banned', + }); + } return user; } @@ -223,12 +216,6 @@ class UsersService { ); } - // Emit that the user username status was changed. - await events.emitAsync(USERS_USERNAME_STATUS_CHANGE, user, { - status, - assignedBy, - }); - return user; } @@ -286,9 +273,6 @@ class UsersService { throw new Error('edit username failed for an unexpected reason'); } - // Emit that the user username status was changed. - await events.emitAsync(USERS_USERNAME_STATUS_CHANGE, user, toStatus); - return user; } catch (err) { if (err.code === 11000) { @@ -404,16 +388,14 @@ class UsersService { // Save the user in the database. await user.save(); - // Emit that the user was created. - await events.emitAsync(USERS_NEW, user); - return user; } /** * sendEmailConfirmation sends a confirmation email to the user. + * * @param {String} user the user to send the email to - * @param {String} email the email for the user to send the email to + * @param {String} email the email for the user to send the email to */ static async sendEmailConfirmation(user, email, redirectURI = ROOT_URL) { let token = await UsersService.createEmailConfirmToken( @@ -430,21 +412,14 @@ class UsersService { email, }, subject: i18n.t('email.confirm.subject'), - to: email, + email, }); } static async sendEmail(user, options) { - const email = user.firstEmail; - if (!email) { - // Rather than throwing an error here, we'll - console.warn(new Error('user does not have an email')); - return; - } - return mailer.send( merge({}, options, { - to: email, + user: user.id, }) ); } @@ -578,9 +553,6 @@ class UsersService { throw err; } - // Emit that the user was created. - await events.emitAsync(USERS_NEW, user); - return user; } @@ -952,38 +924,6 @@ class UsersService { module.exports = UsersService; -events.on(USERS_BAN_CHANGE, async (user, { status, message }) => { - // Check to see if the user was banned now and is currently banned. - if (user.banned && status && message && message.length > 0) { - await UsersService.sendEmail(user, { - template: 'plain', - locals: { - body: message, - }, - subject: 'Your account has been banned', - }); - } -}); - -events.on(USERS_SUSPENSION_CHANGE, async (user, { until, message }) => { - // Check to see if the user was suspended now and is currently suspended. - if ( - user.suspended && - until !== null && - until > Date.now() && - message && - message.length > 0 - ) { - await UsersService.sendEmail(user, { - template: 'plain', - locals: { - body: message, - }, - subject: 'Your account has been suspended', - }); - } -}); - // Extract all the tokenUserNotFound plugins so we can integrate with other // providers. let tokenUserNotFoundHooks = null; diff --git a/test/server/graph/context.js b/test/server/graph/context.js index f1244c3e8..a788f509b 100644 --- a/test/server/graph/context.js +++ b/test/server/graph/context.js @@ -39,7 +39,7 @@ describe('graph.Context', () => { }); it('creates a context without a user', done => { - expect(c).to.not.have.property('user'); + expect(c.user).to.be.falsy; done(); }); diff --git a/test/server/graph/mutations/addTag.js b/test/server/graph/mutations/addTag.js index d93c7fa44..fe22c498f 100644 --- a/test/server/graph/mutations/addTag.js +++ b/test/server/graph/mutations/addTag.js @@ -3,6 +3,7 @@ const { graphql } = require('graphql'); const schema = require('../../../../graph/schema'); const Context = require('../../../../graph/context'); const AssetModel = require('../../../../models/asset'); +const CommentModel = require('../../../../models/comment'); const UserModel = require('../../../../models/user'); const SettingsService = require('../../../../services/settings'); const CommentsService = require('../../../../services/comments'); @@ -50,7 +51,7 @@ describe('graph.mutations.addTag', () => { expect(res.errors).to.be.empty; - let { tags } = await CommentsService.findById(comment.id); + let { tags } = await CommentModel.findOne({ id: comment.id }); expect(tags).to.have.length(1); }); diff --git a/test/server/graph/mutations/createComment.js b/test/server/graph/mutations/createComment.js index 058b19a41..fbbbf4d38 100644 --- a/test/server/graph/mutations/createComment.js +++ b/test/server/graph/mutations/createComment.js @@ -3,12 +3,12 @@ const { graphql } = require('graphql'); const schema = require('../../../../graph/schema'); const Context = require('../../../../graph/context'); -const UserModel = require('../../../../models/user'); -const AssetModel = require('../../../../models/asset'); const ActionModel = require('../../../../models/action'); +const AssetModel = require('../../../../models/asset'); +const CommentModel = require('../../../../models/comment'); +const UserModel = require('../../../../models/user'); const SettingsService = require('../../../../services/settings'); -const CommentsService = require('../../../../services/comments'); const { expect } = require('chai'); @@ -336,9 +336,9 @@ describe('graph.mutations.createComment', () => { expect(data.createComment).to.have.property('comment').not.null; expect(data.createComment).to.have.property('errors').null; - const { tags } = await CommentsService.findById( - data.createComment.comment.id - ); + const { tags } = await CommentModel.findOne({ + id: data.createComment.comment.id, + }); if (tag) { expect(tags).to.have.length(1); expect(tags[0].tag.name).to.have.equal(tag); diff --git a/test/server/graph/mutations/editComment.js b/test/server/graph/mutations/editComment.js index 67c81a5d5..476279ae8 100644 --- a/test/server/graph/mutations/editComment.js +++ b/test/server/graph/mutations/editComment.js @@ -1,12 +1,13 @@ const { graphql } = require('graphql'); const timekeeper = require('timekeeper'); -const schema = require('../../../../graph/schema'); -const Context = require('../../../../graph/context'); -const UsersService = require('../../../../services/users'); const AssetModel = require('../../../../models/asset'); -const SettingsService = require('../../../../services/settings'); +const CommentModel = require('../../../../models/comment'); const CommentsService = require('../../../../services/comments'); +const Context = require('../../../../graph/context'); +const schema = require('../../../../graph/schema'); +const SettingsService = require('../../../../services/settings'); +const UsersService = require('../../../../services/users'); const { expect } = require('chai'); @@ -70,7 +71,7 @@ describe('graph.mutations.editComment', () => { expect(response.data.editComment.errors).to.be.null; // assert body has changed - const commentAfterEdit = await CommentsService.findById(comment.id); + const commentAfterEdit = await CommentModel.findOne({ id: comment.id }); expect(commentAfterEdit.body).to.equal(newBody); expect(commentAfterEdit.body_history).to.be.instanceOf(Array); expect(commentAfterEdit.body_history.length).to.equal(2); @@ -110,7 +111,7 @@ describe('graph.mutations.editComment', () => { expect(response.data.editComment.errors[0].translation_key).to.equal( 'EDIT_WINDOW_ENDED' ); - const commentAfterEdit = await CommentsService.findById(comment.id); + const commentAfterEdit = await CommentModel.findOne({ id: comment.id }); // it *hasn't* changed from the original expect(commentAfterEdit.body).to.equal(comment.body); @@ -142,7 +143,7 @@ describe('graph.mutations.editComment', () => { expect(response.data.editComment.errors[0].translation_key).to.equal( 'NOT_AUTHORIZED' ); - const commentAfterEdit = await CommentsService.findById(comment.id); + const commentAfterEdit = await CommentModel.findOne({ id: comment.id }); // it *hasn't* changed from the original expect(commentAfterEdit.body).to.equal(comment.body); @@ -274,7 +275,7 @@ describe('graph.mutations.editComment', () => { console.error(response.data.editComment.errors); } expect(response.data.editComment.errors).to.be.null; - const commentAfterEdit = await CommentsService.findById(comment.id); + const commentAfterEdit = await CommentModel.findOne({ id: comment.id }); expect(commentAfterEdit.body).to.equal(newBody); expect(commentAfterEdit.status).to.equal(afterEdit.status); } diff --git a/test/server/graph/mutations/removeTag.js b/test/server/graph/mutations/removeTag.js index f1de90f5c..ccd5e95f5 100644 --- a/test/server/graph/mutations/removeTag.js +++ b/test/server/graph/mutations/removeTag.js @@ -6,8 +6,9 @@ const UserModel = require('../../../../models/user'); const SettingModel = require('../../../../models/setting'); const AssetModel = require('../../../../models/asset'); -const SettingsService = require('../../../../services/settings'); +const CommentModel = require('../../../../models/comment'); const CommentsService = require('../../../../services/comments'); +const SettingsService = require('../../../../services/settings'); const TagsService = require('../../../../services/tags'); const { expect } = require('chai'); @@ -59,7 +60,7 @@ describe('graph.mutations.removeTag', () => { expect(response.errors).to.be.empty; expect(response.data.removeTag).to.be.null; - let retrievedComment = await CommentsService.findById(comment.id); + let retrievedComment = await CommentModel.findOne({ id: comment.id }); expect(retrievedComment.tags).to.have.length(0); }); diff --git a/test/server/graph/queries/user.js b/test/server/graph/queries/user.js index c5727987e..3ec8abaf9 100644 --- a/test/server/graph/queries/user.js +++ b/test/server/graph/queries/user.js @@ -22,6 +22,53 @@ describe('graph.queries.user', () => { ); }); + describe('email', () => { + const query = ` + query User($user_id: ID!) { + user(id: $user_id) { + id + email + } + } + `; + + it('can query for your own email', async () => { + const ctx = new Context({ user }); + + const { data, errors } = await graphql(schema, query, {}, ctx, { + user_id: user.id, + }); + + expect(errors).to.be.undefined; + expect(data.user).to.not.be.null; + expect(data.user.email).to.be.equal(user.firstEmail); + }); + + [ + { role: 'COMMENTER', can: false }, + { role: 'STAFF', can: false }, + { role: 'MODERATOR', can: true }, + { role: 'ADMIN', can: true }, + ].forEach(({ role, can }) => { + it(`${can ? 'can' : 'can not'} query with role = ${role}`, async () => { + const actor = new UserModel({ role }); + const ctx = new Context({ user: actor }); + + const { data, errors } = await graphql(schema, query, {}, ctx, { + user_id: user.id, + }); + + expect(errors).to.be.undefined; + if (!can) { + expect(data.user).to.be.null; + } else { + expect(data.user).to.not.be.null; + expect(data.user.email).to.be.equal(user.firstEmail); + } + }); + }); + }); + describe('state', () => { const meQuery = ` query Me { diff --git a/test/server/services/actions.js b/test/server/services/actions.js index 96170338e..0615e55df 100644 --- a/test/server/services/actions.js +++ b/test/server/services/actions.js @@ -6,14 +6,6 @@ const chai = require('chai'); chai.use(require('chai-as-promised')); const expect = chai.expect; -const events = require('../../../services/events'); -const { - ACTIONS_NEW, - ACTIONS_DELETE, -} = require('../../../services/events/constants'); - -const sinon = require('sinon'); - describe('services.ActionsService', () => { let mockActions = []; let comment; @@ -78,30 +70,6 @@ describe('services.ActionsService', () => { expect(retrievedAction).has.property('id', createdAction.id); expect(retrievedAction).has.property('item_id', comment.id); }); - - it('fires the callback successfully', async () => { - const srcAction = { - action_type: 'LIKE', - item_type: 'COMMENTS', - item_id: comment.id, - }; - - const spy = sinon.spy(); - events.once(ACTIONS_NEW, spy); - - const createdAction = await ActionsService.create(srcAction); - - expect(createdAction).is.not.null; - expect(createdAction).has.property('id'); - expect(createdAction).has.property('item_id', comment.id); - - expect(spy).to.have.been.calledWith(createdAction); - - const retrievedComment = await CommentModel.findOne({ id: comment.id }); - - expect(retrievedComment).to.have.property('action_counts'); - expect(retrievedComment.action_counts).to.have.property('like', 1); - }); }); describe('#delete', () => { @@ -116,21 +84,6 @@ describe('services.ActionsService', () => { expect(retrievedAction).is.null; }); - - it('fires the callback successfully', async () => { - const spy = sinon.spy(); - events.once(ACTIONS_DELETE, spy); - - const deletedAction = await ActionsService.delete(mockActions[0]); - - expect(deletedAction).has.property('id', mockActions[0].id); - expect(spy).to.have.been.calledWith(deletedAction); - - const retrievedComment = await CommentModel.findOne({ id: comment.id }); - - expect(retrievedComment).to.have.property('action_counts'); - expect(retrievedComment.action_counts).to.have.property('flag', -1); - }); }); describe('#findById()', () => { diff --git a/test/server/services/comments.js b/test/server/services/comments.js index e0fc6da67..0c1a72ab7 100644 --- a/test/server/services/comments.js +++ b/test/server/services/comments.js @@ -1,8 +1,6 @@ const CommentModel = require('../../../models/comment'); const ActionModel = require('../../../models/action'); -const events = require('../../../services/events'); -const { COMMENTS_EDIT } = require('../../../services/events/constants'); const UsersService = require('../../../services/users'); const SettingsService = require('../../../services/settings'); const CommentsService = require('../../../services/comments'); @@ -17,8 +15,6 @@ const chai = require('chai'); chai.use(require('sinon-chai')); const expect = chai.expect; -const sinon = require('sinon'); - describe('services.CommentsService', () => { const comments = [ { @@ -214,7 +210,9 @@ describe('services.CommentsService', () => { await CommentsService.pushStatus(originalComment.id, 'ACCEPTED'); - let retrivedComment = await CommentsService.findById(originalComment.id); + let retrivedComment = await CommentModel.findOne({ + id: originalComment.id, + }); expect(retrivedComment).to.have.property('status', 'ACCEPTED'); expect(retrivedComment.status_history).to.have.length(2); @@ -237,7 +235,7 @@ describe('services.CommentsService', () => { 'PREMOD' ); - retrivedComment = await CommentsService.findById(originalComment.id); + retrivedComment = await CommentModel.findOne({ id: originalComment.id }); expect(retrivedComment).to.have.property('status', 'PREMOD'); expect(retrivedComment.status_history).to.have.length(3); @@ -248,41 +246,13 @@ describe('services.CommentsService', () => { }); }); - describe('#findById()', () => { - it('should find a comment by id', async () => { - const comment = await CommentsService.findById('1'); - expect(comment).to.not.be.null; - expect(comment).to.have.property('body', 'comment 10'); - }); - }); - - describe('#findByAssetId()', () => { - it('should find an array of all comments by asset id', async () => { - const comments = await CommentsService.findByAssetId('123'); - expect(comments).to.have.length(3); - comments.sort((a, b) => { - if (a.body < b.body) { - return -1; - } else { - return 1; - } - }); - expect(comments[0]).to.have.property('body', 'comment 10'); - expect(comments[1]).to.have.property('body', 'comment 20'); - expect(comments[2]).to.have.property('body', 'comment 40'); - }); - }); - describe('#changeStatus', () => { it('should change the status of a comment from no status', async () => { let comment_id = comments[0].id; - let c = await CommentsService.findById(comment_id); + let c = await CommentModel.findOne({ id: comment_id }); expect(c.status).to.be.equal('NONE'); - const spy = sinon.spy(); - events.once(COMMENTS_EDIT, spy); - let c2 = await CommentsService.pushStatus(comment_id, 'REJECTED', '123'); expect(c2).to.have.property('status'); expect(c2.status).to.equal('REJECTED'); @@ -290,9 +260,7 @@ describe('services.CommentsService', () => { expect(c2.status_history[0]).to.have.property('type', 'REJECTED'); expect(c2.status_history[0]).to.have.property('assigned_by', '123'); - expect(spy).to.have.been.called; - - let c3 = await CommentsService.findById(comment_id); + let c3 = await CommentModel.findOne({ id: comment_id }); expect(c3).to.have.property('status'); expect(c3.status).to.equal('REJECTED'); expect(c3.status_history).to.have.length(1); @@ -302,7 +270,7 @@ describe('services.CommentsService', () => { it('should change the status of a comment from accepted', async () => { await CommentsService.pushStatus(comments[1].id, 'REJECTED', '123'); - const c = await CommentsService.findById(comments[1].id); + const c = await CommentModel.findOne({ id: comments[1].id }); expect(c).to.have.property('status_history'); expect(c).to.have.property('status'); expect(c.status).to.equal('REJECTED'); diff --git a/test/server/services/tags.js b/test/server/services/tags.js index eb3144114..92e566f7c 100644 --- a/test/server/services/tags.js +++ b/test/server/services/tags.js @@ -1,4 +1,3 @@ -const CommentsService = require('../../../services/comments'); const TagsService = require('../../../services/tags'); const UsersService = require('../../../services/users'); const SettingsService = require('../../../services/settings'); @@ -40,7 +39,7 @@ describe('services.TagsService', () => { assigned_by, }); - const { tags } = await CommentsService.findById(id); + const { tags } = await CommentModel.findOne({ id }); expect(tags.length).to.equal(1); expect(tags[0].tag.name).to.equal(name); expect(tags[0].assigned_by).to.equal(assigned_by); @@ -59,7 +58,7 @@ describe('services.TagsService', () => { }); { - let { tags } = await CommentsService.findById(id); + let { tags } = await CommentModel.findOne({ id }); expect(tags.length).to.equal(1); } @@ -71,7 +70,7 @@ describe('services.TagsService', () => { }); { - let { tags } = await CommentsService.findById(id); + let { tags } = await CommentModel.findOne({ id }); expect(tags.length).to.equal(1); } }); @@ -91,7 +90,7 @@ describe('services.TagsService', () => { }); { - const { tags } = await CommentsService.findById(id); + const { tags } = await CommentModel.findOne({ id }); expect(tags.length).to.equal(1); } @@ -104,7 +103,7 @@ describe('services.TagsService', () => { }); { - const { tags } = await CommentsService.findById(id); + const { tags } = await CommentModel.findOne({ id }); expect(tags.length).to.equal(0); } }); @@ -128,7 +127,7 @@ describe('services.TagsService', () => { }); { - const { tags } = await CommentsService.findById(id); + const { tags } = await CommentModel.findOne({ id }); expect(tags.length).to.equal(2); } @@ -141,7 +140,7 @@ describe('services.TagsService', () => { }); { - const { tags } = await CommentsService.findById(id); + const { tags } = await CommentModel.findOne({ id }); expect(tags.length).to.equal(1); expect(tags[0].tag.name).to.equal('ANOTHER'); } diff --git a/url.js b/url.js index e855859de..294095d48 100644 --- a/url.js +++ b/url.js @@ -18,9 +18,12 @@ const MOUNT_PATH = ROOT_URL_MOUNT_PATH ? BASE_PATH : '/'; // The STATIC_URL is the url where static assets should be loaded from. const STATIC_URL = trailingSlash(STATIC_URI); +const STATIC_ORIGIN = new URL(STATIC_URI).origin; + module.exports = { BASE_URL, BASE_PATH, MOUNT_PATH, STATIC_URL, + STATIC_ORIGIN, }; diff --git a/views/auth-callback.ejs b/views/auth-callback.ejs index 25603bda4..424889065 100644 --- a/views/auth-callback.ejs +++ b/views/auth-callback.ejs @@ -1,5 +1,8 @@ + + <%- include partials/data %> + diff --git a/views/partials/data.ejs b/views/partials/data.ejs new file mode 100644 index 000000000..f0bbf5925 --- /dev/null +++ b/views/partials/data.ejs @@ -0,0 +1,3 @@ +<%_ if (data != null) { _%> + +<%_ } _%> \ No newline at end of file diff --git a/views/partials/head.ejs b/views/partials/head.ejs index bc8b949d3..555f5689e 100644 --- a/views/partials/head.ejs +++ b/views/partials/head.ejs @@ -18,7 +18,5 @@ <%_ if (locals.customCssUrl) { _%> <%_ } _%> -<%_ if (data != null) { _%> - -<%_ } _%> +<%- include data %> \ No newline at end of file diff --git a/webpack.config.js b/webpack.config.js index 428bbf117..2027061da 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -8,6 +8,7 @@ const _ = require('lodash'); const Copy = require('copy-webpack-plugin'); const webpack = require('webpack'); const UglifyJsPlugin = require('uglifyjs-webpack-plugin'); +const HardSourceWebpackPlugin = require('hard-source-webpack-plugin'); const debug = require('debug')('talk:webpack'); // Possibly load the config from the .env file (if there is one). @@ -75,7 +76,7 @@ const config = { }, }, { - loader: 'json-loader', + loader: 'hjson-loader', test: /\.(json|yml)$/, exclude: /node_modules/, }, @@ -136,6 +137,7 @@ const config = { TALK_DEFAULT_LANG: 'en', }), new webpack.IgnorePlugin(/^\.\/locale$/, /moment$/), + new HardSourceWebpackPlugin(), ], resolveLoader: { modules: [ diff --git a/yarn.lock b/yarn.lock index cdf07560c..5d44cf687 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1584,6 +1584,15 @@ builtin-status-codes@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/builtin-status-codes/-/builtin-status-codes-3.0.0.tgz#85982878e21b98e1c66425e03d0174788f569ee8" +bunyan@^1.8.12: + version "1.8.12" + resolved "https://registry.yarnpkg.com/bunyan/-/bunyan-1.8.12.tgz#f150f0f6748abdd72aeae84f04403be2ef113797" + optionalDependencies: + dtrace-provider "~0.8" + moment "^2.10.6" + mv "~2" + safe-json-stringify "~1" + bytes@3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/bytes/-/bytes-3.0.0.tgz#d32815404d689699f85a4ea4fa8755dd13a96048" @@ -2674,6 +2683,10 @@ detect-indent@^4.0.0: dependencies: repeating "^2.0.0" +detect-indent@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/detect-indent/-/detect-indent-5.0.0.tgz#3871cc0a6a002e8c3e5b3cf7f336264675f06b9d" + detect-libc@^0.2.0: version "0.2.0" resolved "https://registry.yarnpkg.com/detect-libc/-/detect-libc-0.2.0.tgz#47fdf567348a17ec25fcbf0b9e446348a76f9fb5" @@ -2817,6 +2830,12 @@ double-ended-queue@^2.1.0-0: version "2.1.0-0" resolved "https://registry.yarnpkg.com/double-ended-queue/-/double-ended-queue-2.1.0-0.tgz#103d3527fd31528f40188130c841efdd78264e5c" +dtrace-provider@~0.8: + version "0.8.6" + resolved "https://registry.yarnpkg.com/dtrace-provider/-/dtrace-provider-0.8.6.tgz#428a223afe03425d2cd6d6347fdf40c66903563d" + dependencies: + nan "^2.3.3" + duplexer3@^0.1.4: version "0.1.4" resolved "https://registry.yarnpkg.com/duplexer3/-/duplexer3-0.1.4.tgz#ee01dd1cac0ed3cbc7fdbea37dc0a8f1ce002ce2" @@ -3973,6 +3992,16 @@ glob@^5.0.3: once "^1.3.0" path-is-absolute "^1.0.0" +glob@^6.0.1: + version "6.0.4" + resolved "https://registry.yarnpkg.com/glob/-/glob-6.0.4.tgz#0f08860f6a155127b2fadd4f9ce24b1aab6e4d22" + dependencies: + inflight "^1.0.4" + inherits "2" + minimatch "2 || 3" + once "^1.3.0" + path-is-absolute "^1.0.0" + glob@^7.0.0, glob@^7.0.3, glob@^7.0.5, glob@^7.1.1, glob@^7.1.2: version "7.1.2" resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.2.tgz#c19c9df9a028702d678612384a6552404c636d15" @@ -4216,6 +4245,19 @@ har-validator@~5.0.3: ajv "^5.1.0" har-schema "^2.0.0" +hard-source-webpack-plugin@^0.6.0: + version "0.6.0" + resolved "https://registry.yarnpkg.com/hard-source-webpack-plugin/-/hard-source-webpack-plugin-0.6.0.tgz#ec2f60068a8d1f358439b7b1587f1c64fe642eda" + dependencies: + lodash "^4.15.0" + mkdirp "^0.5.1" + node-object-hash "^1.2.0" + rimraf "^2.6.2" + tapable "^1.0.0-beta.5" + webpack-core "~0.6.0" + webpack-sources "^1.0.1" + write-json-file "^2.3.0" + harmony-reflect@^1.4.6: version "1.5.1" resolved "https://registry.yarnpkg.com/harmony-reflect/-/harmony-reflect-1.5.1.tgz#b54ca617b00cc8aef559bbb17b3d85431dc7e329" @@ -4358,6 +4400,16 @@ history@^3.0.0: query-string "^4.2.2" warning "^3.0.0" +hjson-loader@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/hjson-loader/-/hjson-loader-1.0.0.tgz#d6547d77eebbfc8ab9df45c1db90c6c061cc88fc" + dependencies: + loader-utils "^0.2.12" + +hjson@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/hjson/-/hjson-3.1.1.tgz#eaab95eebc6c0c749442219a817d9b4ff0070dd2" + hmac-drbg@^1.0.0: version "1.0.1" resolved "https://registry.yarnpkg.com/hmac-drbg/-/hmac-drbg-1.0.1.tgz#d2745701025a6c775a6c545793ed502fc0c649a1" @@ -5351,6 +5403,14 @@ jest-jasmine2@^22.4.2: jest-util "^22.4.1" source-map-support "^0.5.0" +jest-junit@^3.6.0: + version "3.6.0" + resolved "https://registry.yarnpkg.com/jest-junit/-/jest-junit-3.6.0.tgz#f4c4358e5286364a4324dc14abddd526aadfbd38" + dependencies: + mkdirp "^0.5.1" + strip-ansi "^4.0.0" + xml "^1.0.1" + jest-matcher-utils@^21.2.1: version "21.2.1" resolved "https://registry.yarnpkg.com/jest-matcher-utils/-/jest-matcher-utils-21.2.1.tgz#72c826eaba41a093ac2b4565f865eb8475de0f64" @@ -5682,7 +5742,7 @@ jsmin@1.x: version "1.0.1" resolved "https://registry.yarnpkg.com/jsmin/-/jsmin-1.0.1.tgz#e7bd0dcd6496c3bf4863235bf461a3d98aa3b98c" -json-loader@^0.5.4, json-loader@^0.5.7: +json-loader@^0.5.4: version "0.5.7" resolved "https://registry.yarnpkg.com/json-loader/-/json-loader-0.5.7.tgz#dca14a70235ff82f0ac9a3abeb60d337a365185d" @@ -6048,7 +6108,7 @@ loader-runner@^2.3.0: version "2.3.0" resolved "https://registry.yarnpkg.com/loader-runner/-/loader-runner-2.3.0.tgz#f482aea82d543e07921700d5a46ef26fdac6b8a2" -loader-utils@^0.2.15: +loader-utils@^0.2.12, loader-utils@^0.2.15: version "0.2.17" resolved "https://registry.yarnpkg.com/loader-utils/-/loader-utils-0.2.17.tgz#f86e6374d43205a6e6c60e9196f17c0299bfb348" dependencies: @@ -6708,7 +6768,7 @@ moment@^2.10.3: version "2.19.1" resolved "https://registry.yarnpkg.com/moment/-/moment-2.19.1.tgz#56da1a2d1cbf01d38b7e1afc31c10bcfa1929167" -moment@^2.18.1: +moment@^2.10.6, moment@^2.18.1: version "2.20.1" resolved "https://registry.yarnpkg.com/moment/-/moment-2.20.1.tgz#d6eb1a46cbcc14a2b2f9434112c1ff8907f313fd" @@ -6749,7 +6809,7 @@ moo-server@*, moo-server@1.3.x: version "1.3.0" resolved "https://registry.yarnpkg.com/moo-server/-/moo-server-1.3.0.tgz#5dc79569565a10d6efed5439491e69d2392e58f1" -morgan@1.9.0: +morgan@^1.9.0: version "1.9.0" resolved "https://registry.yarnpkg.com/morgan/-/morgan-1.9.0.tgz#d01fa6c65859b76fcf31b3cb53a3821a311d8051" dependencies: @@ -6811,7 +6871,15 @@ mute-stream@0.0.7: version "0.0.7" resolved "https://registry.yarnpkg.com/mute-stream/-/mute-stream-0.0.7.tgz#3075ce93bc21b8fab43e1bc4da7e8115ed1e7bab" -nan@^2.3.0, nan@^2.6.2: +mv@~2: + version "2.1.1" + resolved "https://registry.yarnpkg.com/mv/-/mv-2.1.1.tgz#ae6ce0d6f6d5e0a4f7d893798d03c1ea9559b6a2" + dependencies: + mkdirp "~0.5.1" + ncp "~2.0.0" + rimraf "~2.4.0" + +nan@^2.3.0, nan@^2.3.3, nan@^2.6.2: version "2.8.0" resolved "https://registry.yarnpkg.com/nan/-/nan-2.8.0.tgz#ed715f3fe9de02b57a5e6252d90a96675e1f085a" @@ -6857,6 +6925,10 @@ nconf@^0.8.4: secure-keys "^1.0.0" yargs "^3.19.0" +ncp@~2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/ncp/-/ncp-2.0.0.tgz#195a21d6c46e361d2fb1281ba38b91e9df7bdbb3" + nearley@^2.7.10: version "2.11.0" resolved "https://registry.yarnpkg.com/nearley/-/nearley-2.11.0.tgz#5e626c79a6cd2f6ab9e7e5d5805e7668967757ae" @@ -7000,6 +7072,10 @@ node-notifier@^5.0.2: shellwords "^0.1.0" which "^1.2.12" +node-object-hash@^1.2.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/node-object-hash/-/node-object-hash-1.3.0.tgz#7f294f5afec6b08d713e40d40a95ec793e05baf3" + node-pre-gyp@^0.6.36, node-pre-gyp@^0.6.39: version "0.6.39" resolved "https://registry.yarnpkg.com/node-pre-gyp/-/node-pre-gyp-0.6.39.tgz#c00e96860b23c0e1420ac7befc5044e1d78d8649" @@ -9183,7 +9259,7 @@ right-align@^0.1.1: dependencies: align-text "^0.1.1" -rimraf@2, rimraf@^2.5.1, rimraf@^2.5.4, rimraf@^2.6.1: +rimraf@2, rimraf@^2.5.1, rimraf@^2.5.4, rimraf@^2.6.1, rimraf@^2.6.2: version "2.6.2" resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-2.6.2.tgz#2ed8150d24a16ea8651e6d6ef0f47c4158ce7a36" dependencies: @@ -9195,6 +9271,12 @@ rimraf@^2.2.8, rimraf@~2.5.2: dependencies: glob "^7.0.5" +rimraf@~2.4.0: + version "2.4.5" + resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-2.4.5.tgz#ee710ce5d93a8fdb856fb5ea8ff0e2d75934b2da" + dependencies: + glob "^6.0.1" + ripemd160@^2.0.0, ripemd160@^2.0.1: version "2.0.1" resolved "https://registry.yarnpkg.com/ripemd160/-/ripemd160-2.0.1.tgz#0f4584295c53a3628af7e6d79aca21ce57d1c6e7" @@ -9241,6 +9323,10 @@ safe-buffer@5.1.1, safe-buffer@^5.0.1, safe-buffer@^5.1.0, safe-buffer@^5.1.1, s version "5.1.1" resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.1.tgz#893312af69b2123def71f57889001671eeb2c853" +safe-json-stringify@~1: + version "1.1.0" + resolved "https://registry.yarnpkg.com/safe-json-stringify/-/safe-json-stringify-1.1.0.tgz#bd2b6dad1ebafab3c24672a395527f01804b7e19" + safe-regex@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/safe-regex/-/safe-regex-1.1.0.tgz#40a3669f3b077d1e943d44629e157dd48023bf2e" @@ -9637,10 +9723,20 @@ sort-keys@^1.0.0: dependencies: is-plain-obj "^1.0.0" +sort-keys@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/sort-keys/-/sort-keys-2.0.0.tgz#658535584861ec97d730d6cf41822e1f56684128" + dependencies: + is-plain-obj "^1.0.0" + source-list-map@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/source-list-map/-/source-list-map-2.0.0.tgz#aaa47403f7b245a92fbc97ea08f250d6087ed085" +source-list-map@~0.1.7: + version "0.1.8" + resolved "https://registry.yarnpkg.com/source-list-map/-/source-list-map-0.1.8.tgz#c550b2ab5427f6b3f21f5afead88c4f5587b2106" + source-map-resolve@^0.5.0: version "0.5.1" resolved "https://registry.yarnpkg.com/source-map-resolve/-/source-map-resolve-0.5.1.tgz#7ad0f593f2281598e854df80f19aae4b92d7a11a" @@ -9673,7 +9769,7 @@ source-map@0.1.x: dependencies: amdefine ">=0.0.4" -source-map@0.4.x, source-map@^0.4.4: +source-map@0.4.x, source-map@^0.4.4, source-map@~0.4.1: version "0.4.4" resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.4.4.tgz#eba4f5da9c0dc999de68032d8b4f76173652036b" dependencies: @@ -10051,6 +10147,10 @@ tapable@^0.2.7: version "0.2.8" resolved "https://registry.yarnpkg.com/tapable/-/tapable-0.2.8.tgz#99372a5c999bf2df160afc0d74bed4f47948cd22" +tapable@^1.0.0-beta.5: + version "1.0.0" + resolved "https://registry.yarnpkg.com/tapable/-/tapable-1.0.0.tgz#cbb639d9002eed9c6b5975eb20598d7936f1f9f2" + tar-fs@^1.13.0: version "1.16.0" resolved "https://registry.yarnpkg.com/tar-fs/-/tar-fs-1.16.0.tgz#e877a25acbcc51d8c790da1c57c9cf439817b896" @@ -10674,6 +10774,13 @@ webidl-conversions@^4.0.0, webidl-conversions@^4.0.1, webidl-conversions@^4.0.2: version "4.0.2" resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-4.0.2.tgz#a855980b1f0b6b359ba1d5d9fb39ae941faa63ad" +webpack-core@~0.6.0: + version "0.6.9" + resolved "https://registry.yarnpkg.com/webpack-core/-/webpack-core-0.6.9.tgz#fc571588c8558da77be9efb6debdc5a3b172bdc2" + dependencies: + source-list-map "~0.1.7" + source-map "~0.4.1" + webpack-sources@^1.0.1, webpack-sources@^1.0.2, webpack-sources@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-1.1.0.tgz#a101ebae59d6507354d71d8013950a3a8b7a5a54" @@ -10854,6 +10961,17 @@ write-file-atomic@^2.0.0, write-file-atomic@^2.1.0: imurmurhash "^0.1.4" signal-exit "^3.0.2" +write-json-file@^2.3.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/write-json-file/-/write-json-file-2.3.0.tgz#2b64c8a33004d54b8698c76d585a77ceb61da32f" + dependencies: + detect-indent "^5.0.0" + graceful-fs "^4.1.2" + make-dir "^1.0.0" + pify "^3.0.0" + sort-keys "^2.0.0" + write-file-atomic "^2.0.0" + write@^0.2.1: version "0.2.1" resolved "https://registry.yarnpkg.com/write/-/write-0.2.1.tgz#5fc03828e264cea3fe91455476f7a3c566cb0757" @@ -10891,7 +11009,7 @@ xml-name-validator@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/xml-name-validator/-/xml-name-validator-3.0.0.tgz#6ae73e06de4d8c6e47f9fb181f78d648ad457c6a" -xml@^1.0.0: +xml@^1.0.0, xml@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/xml/-/xml-1.0.1.tgz#78ba72020029c5bc87b8a81a3cfcd74b4a2fc1e5"