Refactor & cleanup toxic-comments plugin

plugins/talk-plugin-toxic-comments/client/components/CheckToxicityHook.js

@@ -1,10 +1,19 @@
 import React from 'react';
 
+/**
+ * CheckToxicityHook adds hooks to the `commentBox`
+ * that handles checking a comment for toxicity.
+ */
 export default class CheckToxicityHook extends React.Component {
+
+  // checked signifies if we already sent a request with the `checkToxicity` set to true.
   checked = false;
 
   componentDidMount() {
     this.toxicityPreHook = this.props.registerHook('preSubmit', (input) => {
+
+      // If we haven't check the toxicity yet, make sure to include `checkToxicity=true` in the mutation.
+      // Otherwise post comment without checking the toxicity.
       if (!this.checked) {
         input.checkToxicity = true;
         this.checked = true;
@@ -12,6 +21,8 @@ export default class CheckToxicityHook extends React.Component {
     });
 
     this.toxicityPostHook = this.props.registerHook('postSubmit', () => {
+
+      // Reset `checked` after comment was successfully posted.
       this.checked = false;
     });
   }

plugins/talk-plugin-toxic-comments/client/index.js

@@ -1,11 +1,6 @@
 import translations from './translations.yml';
 import CheckToxicityHook from './components/CheckToxicityHook';
 
-/**
- * coral-plugin-offtopic depends on coral-plugin-viewing-options
- * in other to display filter and use the streamViewingOptions slot
- */
-
 export default {
   translations,
   slots: {

plugins/talk-plugin-toxic-comments/server/apiKey.js

@@ -1,6 +0,0 @@
-const apiKey = process.env.TALK_PERSPECTIVE_API_KEY;
-if(!apiKey) {
-  throw new Error('Please set the TALK_PERSPECTIVE_API_KEY environment variable to use the toxic-comments plugin. Visit https://www.perspectiveapi.com/ to request API access.');
-}
-
-module.exports = apiKey;

plugins/talk-plugin-toxic-comments/server/config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  API_ENDPOINT: 'https://commentanalyzer.googleapis.com/v1alpha1',
+  API_KEY: process.env.NODE_ENV !== 'test' ? process.env.TALK_PERSPECTIVE_API_KEY : '',
+  TOXICITY_THRESHOLD: process.env.TALK_TOXICITY_THRESHOLD || 0.8,
+};

plugins/talk-plugin-toxic-comments/server/constants.js

@@ -1,3 +0,0 @@
-module.exports = {
-  TOXICITY_THRESHOLD: 0.85,
-};

plugins/talk-plugin-toxic-comments/server/errors.js

@@ -1,5 +1,8 @@
-const {APIError} = require('../../../errors');
+const {APIError} = require('errors');
 
+// ErrToxic is sent during a `CreateComment` mutation where
+// `input.checkToxicity` is set to true and the comment contains
+// toxic language as determined by the perspective service.
 const ErrToxic = new APIError('Comment is toxic', {
   status: 400,
   translation_key: 'COMMENT_IS_TOXIC',

plugins/talk-plugin-toxic-comments/server/hooks.js

@@ -1,49 +1,44 @@
-const perspective = require('./perspective');
+const {getScores, isToxic} = require('./perspective');
 const {ErrToxic} = require('./errors');
-const {TOXICITY_THRESHOLD} = require('./constants');
 const ActionsService = require('../../../services/actions');
 
+// We don't add the hooks during _test_ as the perspective API is not available.
+if (process.env.NODE_ENV === 'test') {
+  return null;
+}
+
 module.exports = {
   RootMutation: {
     createComment: {
       async pre(_, {input}, _context, _info) {
 
-        // Don't call out to perspective when running tests.
-        if (process.env.NODE_ENV === 'test') {
-          return;
-        }
-
-        const apiKey = require('./apiKey');
-
         // TODO: handle timeouts.
-        const scores = await perspective.getScores(apiKey, input.body);
+        const scores = await getScores(input.body);
+        const commentIsToxic = isToxic(scores);
 
-        const isToxic = scores.SEVERE_TOXICITY.summaryScore > TOXICITY_THRESHOLD;
-        if (input.checkToxicity && isToxic) {
+        if (input.checkToxicity && commentIsToxic) {
           throw ErrToxic;
         }
+
+        // attach scores to metadata.
         input.metadata = Object.assign({}, input.metadata, {
           perspective: scores,
         });
 
-        if (isToxic) {
+        if (commentIsToxic) {
+
+          // TODO: this should have a different status than Premod.
           input.status = 'PREMOD';
         }
       },
       async post(_, _input, _context, _info, result) {
-
-        // Perspective is not available when running tests.
-        if (process.env.NODE_ENV === 'test') {
-          return result;
-        }
-
-        const score = result.comment.metadata.perspective.SEVERE_TOXICITY.summaryScore;
-        const isToxic = score > TOXICITY_THRESHOLD;
-        if (isToxic) {
+        if (isToxic(result.comment.metadata.perspective)) {
 
           // TODO: this is kind of fragile, we should refactor this to resolve
           // all these const's that we're using like 'COMMENTS', 'FLAG' to be
           // defined in a checkable schema.
+
+          // Add a flag to the comment.
           await ActionsService.create({
             item_id: result.comment.id,
             item_type: 'COMMENTS',

plugins/talk-plugin-toxic-comments/server/perspective.js

@@ -1,9 +1,13 @@
 const fetch = require('node-fetch');
+const {API_ENDPOINT, API_KEY, TOXICITY_THRESHOLD} = require ('./config');
 
-const API_ENPOINT = 'https://commentanalyzer.googleapis.com/v1alpha1';
-
-async function getScores(apiKey, text) {
-  const response = await fetch(`${API_ENPOINT}/comments:analyze?key=${apiKey}`, {
+/**
+ * Get scores from the perspective api
+ * @param  {string} text to be anaylized
+ * @return {object} object containing toxicity scores
+ */
+async function getScores(text) {
+  const response = await fetch(`${API_ENDPOINT}/comments:analyze?key=${API_KEY}`, {
     method: 'POST',
     headers: {
       'Content-Type': 'application/json',
@@ -32,6 +36,29 @@ async function getScores(apiKey, text) {
   };
 }
 
+/**
+ * Get toxicity probability
+ * @param  {object} scores as returned by `getScores`
+ * @return {number} toxicity probability from 0 - 1.0
+ */
+function getProbability(scores) {
+  return scores.SEVERE_TOXICITY.summaryScore;
+}
+
+/**
+ * isToxics determines if given probabilty or scores meets the toxicity threshold.
+ * @param  {object|number} scores or probability
+ * @return {boolean}
+ */
+function isToxic(scoresOrProbability) {
+  const probability = typeof scoresOrProbability === 'object'
+    ? getProbability(scoresOrProbability)
+    : scoresOrProbability;
+  return probability > TOXICITY_THRESHOLD;
+}
+
 module.exports = {
   getScores,
+  getProbability,
+  isToxic,
 };

plugins/talk-plugin-toxic-comments/server/typeDefs.graphql

@@ -1,4 +1,7 @@
 input CreateCommentInput {
+
+  # If true, the mutation will fail when the
+  # body contains toxic language.
   checkToxicity: Boolean
 }