fix: added trust proxy config (#2751)

Explains how to create a Slack App and hook it into
Coral as well as how to re-find your webhook URLs
if you have lost them.

CORL-645

app.js

@@ -11,7 +11,12 @@ const { HELMET_CONFIGURATION } = require('./config');
 const { MOUNT_PATH } = require('./url');
 const routes = require('./routes');
 const debug = require('debug')('talk:app');
-const { ENABLE_TRACING, APOLLO_ENGINE_KEY, PORT } = require('./config');
+const {
+  ENABLE_TRACING,
+  APOLLO_ENGINE_KEY,
+  PORT,
+  TRUST_PROXY,
+} = require('./config');
 
 const app = express();
 
@@ -58,7 +63,26 @@ if (ENABLE_TRACING && APOLLO_ENGINE_KEY) {
 
 // Trust the first proxy in front of us, this will enable us to trust the fact
 // that SSL was terminated correctly.
-app.set('trust proxy', 1);
+app.set(
+  'trust proxy',
+  (function() {
+    if (!TRUST_PROXY) {
+      return null;
+    }
+
+    const lowercase = TRUST_PROXY.toLowerCase();
+    if (lowercase === 'true' || lowercase === 'false') {
+      return lowercase === 'true';
+    }
+
+    const parsed = Number(TRUST_PROXY);
+    if (!isNaN(parsed)) {
+      return parsed;
+    }
+
+    return TRUST_PROXY;
+  })()
+);
 
 // Enable a suite of security good practices through helmet. We disable
 // frameguard to allow crossdomain injection of the embed.

config.js

@@ -85,6 +85,9 @@ const CONFIG = {
   // as report CSP violations.
   ENABLE_STRICT_CSP: process.env.TALK_ENABLE_STRICT_CSP === 'TRUE',
 
+  // TRUST_PROXY allows control over the `trust proxy` configuration on express.
+  TRUST_PROXY: process.env.TALK_TRUST_PROXY || '1',
+
   // LOGGING_LEVEL specifies the logging level used by the bunyan logger.
   LOGGING_LEVEL: ['fatal', 'error', 'warn', 'info', 'debug', 'trace'].includes(
     process.env.TALK_LOGGING_LEVEL

docs/_config.yml

@@ -94,8 +94,12 @@ sidebar:
               url: /v5/integrating/cms/
             - title: Single Sign On
               url: /v5/integrating/sso/
+            - title: GDPR
+              url: /v5/integrating/gdpr/
             - title: Comment Count
               url: /v5/integrating/counts/
+            - title: Slack
+              url: /v5/integrating/slack/
         - title: API
           children:
             - title: GraphQL Overview

docs/source/version-5-development.md

@@ -6,7 +6,7 @@ permalink: /v5/developing/
 Running Coral for development is very similar to installing Coral via Source as
 described above.
 
-Coral requires NodeJS >=10, we recommend using `nvm` to help manage node
+Coral requires NodeJS >=12, we recommend using `nvm` to help manage node
 versions: https://github.com/creationix/nvm.
 
 ```bash

docs/source/version-5-gdpr.md

@@ -0,0 +1,39 @@
+---
+title: GDPR Compliance
+permalink: /v5/integrating/gdpr/
+---
+
+In order to facilitate compliance with the
+[EU General Data Protection Regulation (GDPR)](https://www.eugdpr.org/), Coral
+provides features so your users can change and manage their own data.
+
+Even if GDPR will not apply to you, it is recommended to enable these
+features as a best practice to provide your users with control over their own
+data.
+
+## GDPR Feature Overview
+
+Integrating our GDPR tools will give your users and organizations the following benefits:
+
+- **Download my comment data**: Users can request a download of their comments. An email with a link is emailed to them to download a CSV with each comment they've made, what story it was made on, and the comment's ID and timestamp.
+- **Delete my account**: Users can request deletion of their account. Deleted account requests are pending for 24 hours to allow the user to download their comments, or to change their mind and reactivate their account before the expiry. Account deletions remove all of their comments from the site, all their comments and actions from the database, and their account info from our system.
+- **Add an email to an OAuth/external account**: Users are prompted to add an email to their non-Coral account (Facebook, Google, external, etc) so that they can take part in GDPR and other features requiring email communication.
+- **Change my username**: Users can update their username. This is capped at once every 2 weeks.
+- **Change my email**: Users can change their email.
+- **Change my password**: Users can change their password.
+
+## GDPR with SSO
+
+As many newsrooms often implement their own [SSO solutions](/talk/v5/integrating/sso/),
+we also provide API support to manage GDPR features directly from your own Account or My Profile page.
+
+We provide the following GraphQL mutations designed to allow you to integrate it into your existing user
+interfaces or exports.
+
+- `requestUserCommentsDownload` - lets you grab the direct link to download a users
+  account in a zip format. From there, you can integrate it into your existing
+  data export or simply proxy it to the user to allow them to download it
+  elsewhere in your UI.
+- `deleteUserAccount` - lets you delete the specified user
+
+**Note: These mutations require an administrative token**

docs/source/version-5-installation.md

@@ -22,7 +22,7 @@ Try out a test version of Coral by running it via a Heroku App:
 
 - MongoDB >=4.2
 - Redis >=3.2
-- NodeJS >=10
+- NodeJS >=12
 - NPM >=6.7
 
 ## Running
@@ -79,7 +79,7 @@ Then head on over to http://localhost:3000 to install Coral!
 
 ### Source
 
-Coral requires NodeJS >=10, we recommend using `nvm` to help manage node
+Coral requires NodeJS >=12, we recommend using `nvm` to help manage node
 versions: https://github.com/creationix/nvm.
 
 ```bash

docs/source/version-5-slack.md

@@ -0,0 +1,28 @@
+---
+title: Slack
+permalink: /v5/integrating/slack/
+---
+
+Coral version 5 supports built-in Slack integration to help you forward comments from your moderation queues into appropriate Slack channels.
+
+## Creating a Slack App
+
+To enable web hooks that we will use to forward comments, you'll need to create an App and give it permissions over a channel.
+
+For details on how to create a Slack app with webhooks, please go to:
+
+https://slack.com/intl/en-ca/help/articles/115005265063-incoming-webhooks-for-slack
+
+After you have created a Slack app with a webhook, you can use it in your Coral configuration.
+
+1. Sign into the administration side of your Coral deployment.
+2. Select _Configure_ from the top navigation.
+3. Select _Slack_ from the side navigation for the configuration area.
+4. Here you can configure a Slack channel.
+5. Paste in the webhook URL you created for your Slack app and select which comment categories you want to receive notifications for.
+
+## I need to find the webhook URL again, where is it?
+
+Webhooks options are tied to a Slack app and can be found under your app settings at:
+
+https://api.slack.com/apps

docs/source/version-5-sso.md

@@ -7,47 +7,43 @@ In order to allow seamless connection to an existing authentication system,
 Coral utilizes the industry standard [JWT Token](https://jwt.io/) to connect. To
 learn more about how to create a JWT token, see [this introduction](https://jwt.io/introduction/).
 
-1. Visit: `https://{{ CORAL_DOMAIN_NAME }}/admin/configure/auth`
+1. Visit: ```https://{{ CORAL_DOMAIN_NAME }} /admin/configure/auth```
 2. Scroll to the `Login with Single Sign On` section
 3. Enable the Single Sign On Authentication Integration
 4. Enable `Allow Registration`
 5. Copy the string in the `Key` box
 6. Click Save
 
-> **NOTE:** Replace the value of `{{ CORAL_DOMAIN_NAME }}` with the location of your running instance of Coral.
+> **NOTE:** Replace the value of ```{{ CORAL_DOMAIN_NAME }}``` with the location of your running instance of Coral.
 
 You will then have to generate a JWT with the following claims:
 
-- `jti` (_optional_) - A unique ID for this particular JWT token. We recommend
+- `jti` _(optional)_ - A unique ID for this particular JWT token. We recommend
   using a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier)
   for this value. Without this parameter, the logout functionality inside the
   embed stream will not work and you will need to call logout on the embed
   itself.
-- `exp` (_optional_) - When the given SSO token should expire. This is
+- `exp` _(optional)_ - When the given SSO token should expire. This is
   specified as a unix time stamp in seconds. Once the token has expired, a new
   token should be generated and passed into Coral. Without this parameter, the
   logout functionality inside the embed stream will not work and you will need
   to call logout on the embed itself.
-- `iat` (_optional_) - When the given SSO token was issued. This is required to
+- `iat` _(optional)_ - When the given SSO token was issued. This is required to
   utilize the automatic user detail update system. If this time is newer than
   the time we received the last update, the contents of the token will be used
   to update the user.
-- `user.id` (**required**) - the ID of the user from your authentication system.
+- `user.id` **(required)** - the ID of the user from your authentication system.
   This is required to connect the user in your system to allow a seamless
   connection to Coral.
-- `user.email` (**required**) - the email address of the user from your
+- `user.email` **(required)** - the email address of the user from your
   authentication system. This is required to facilitate notification email's
   about status changes on a user account such as bans or suspensions.
-- `user.username` (**required**) - the username that should be used when being
-  presented inside Coral to moderators and other users. The following restrictions apply :
-  - Can only contain letter (`a-zA-Z`), number (`0-9`), underscore (`_`) or period (`.`) characters. Spaces and other special characters are not allowed.
-  - Min length = 3
-  - Max length = 30
-
-- `user.badges` (_optional_) - array of strings to be displayed as badges beside
+- `user.username` **(required)** - the username that should be used when being
+  presented inside Coral to moderators and other users. There are no username validations or restrictions enforced by Coral when you're using SSO.
+- `user.badges` _(optional)_ - array of strings to be displayed as badges beside
   username inside Coral, visible to other users and moderators. For example, to indicate
   a user's subscription status.
-- `user.role` (_optional_) - one of "COMMENTER", "STAFF", "MODERATOR", "ADMIN". Will create/update
+- `user.role` _(optional)_ - one of "COMMENTER", "STAFF", "MODERATOR", "ADMIN". Will create/update
   Coral user with this role.
 
 An example of the claims for this token would be:

models/schema/action.js

@@ -41,4 +41,7 @@ const Action = new Schema(
   }
 );
 
+// Indexes for listing users actions.
+Action.index({ user_id: 1, item_type: 1 }, { background: true });
+
 module.exports = Action;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "talk",
-  "version": "4.11.1",
+  "version": "4.11.3",
   "description": "A better commenting experience from Vox Media.",
   "main": "app.js",
   "private": true,

services/scraper/index.js

@@ -75,6 +75,12 @@ const scraper = {
     });
     const html = await res.text();
 
+    if (!res.ok) {
+      let err = new Error(res.statusText);
+      err.response = res;
+      throw err;
+    }
+
     // Get the metadata from the scraped html.
     const meta = await metascraper({
       html,