Source: octokit/index.js

  1. /**
  2.  * @module octokit
  3.  */
  4. const {request} = require("@octokit/request");
  5. const log = require("../../util/log");
  6. const digest = require("../digest");
  8. /**
  9.  * Cryptographically anonymise the data of an issue body
  10.  * to ensure privacy of users.
  11.  * Anonymise the following parameters (if present):
  12.  * email, ip, name, reCAPTCHA response.
  13.  * The anonymised data can be used for reference by server
  14.  * admins with the possession of the server's secret.
  15.  * @param {Object} data
  16.  * @return {Object} anonymised data
  17.  */
  18. const anonymiseData = (data) => {
  19.     if (data.email) {
  20.         const anonId = digest.hashPassWithSaltInHex(
  21.             data.email,
  22.             process.env.SERVER_SECRET,
  23.         );
  24.         data.email = anonId;
  25.     }
  26.     if (data.ip) {
  27.         const anonIp = digest.hashPassWithSaltInHex(
  28.             data.ip,
  29.             process.env.SERVER_SECRET,
  30.         );
  31.         data.ip = anonIp;
  32.     }
  33.     if (data.name) {
  34.         const anonName = digest.hashPassWithSaltInHex(
  35.             data.name,
  36.             process.env.SERVER_SECRET,
  37.         );
  38.         data.name = anonName;
  39.     }
  40.     if (data['g-recaptcha-response']) {
  41.         const anonRes = digest.hashPassWithSaltInHex(
  42.             data['g-recaptcha-response'],
  43.             process.env.SERVER_SECRET,
  44.         );
  45.         data['g-recaptcha-response'] = anonRes;
  46.     }
  47.     if (data['_csrf']) {
  48.         const anonRes = digest.hashPassWithSaltInHex(
  49.             data['_csrf'],
  50.             process.env.SERVER_SECRET,
  51.         );
  52.         data['_csrf'] = anonRes;
  53.     }
  54.     return data;
  55. };
  57. /**
  58.  * Create markdown formatted issue body string
  59.  * from pretty printed issue data and metadata.
  60.  * @param {Object} data
  61.  * @return {String} markdown formatted issue body
  62.  */
  63. const createIssueBody = (data) => {
  64.     return `### ${data.subject ? data.subject : 'Route ' + data.originalUrl}\n\n` +
  65.         `${data.report ? data.report : data.message}\n\n` +
  66.         'Metadata:\n```yaml\n' +
  67.         JSON.stringify(data, null, 4) +
  68.         '\n```';
  69. };
  71. /**
  72.  * Create bugreport Github issue:
  73.  * Anonymise PII in bugreport, create
  74.  * formatted issue body and post the
  75.  * issue to Github via Github API.
  76.  * @param {Object} bugreport
  77.  */
  78. const createBugreportIssue = async (bugreport) => {
  79.     await createIssue(
  80.         `[bugreport] ${bugreport.subject ? bugreport.subject : 'Auto bugreport for route ' + bugreport.originalUrl}`,
  81.         createIssueBody(anonymiseData(bugreport)),
  82.         "bugreport",
  83.     );
  84. };
  86. /**
  87.  * Create feature request Github issue:
  88.  * Anonymise PII in feature request, create
  89.  * formatted issue body and post the
  90.  * issue to Github via Github API.
  91.  * @param {Object} featureRequest
  92.  */
  93. const createFeatureRequestIssue = async (featureRequest) => {
  94.     await createIssue(
  95.         `[feature request] ${featureRequest.subject}`,
  96.         createIssueBody(anonymiseData(featureRequest)),
  97.         "feature request",
  98.     );
  99. };
  101. /**
  102.  * Create an issue on Github via Github API
  103.  * with given issue title, body and label.
  104.  * @param {String} title
  105.  * @param {String} body
  106.  * @param {String} label
  107.  */
  108. const createIssue = async (title, body, label) => {
  109.     try {
  110.         if (process.env.CREATE_GITHUB_ISSUES === '0') {
  111.             log.info("Skipping creation of Github Issue - %s", title);
  112.             return;
  113.         }
  114.         log.info("Creating Github Issue - %s", title);
  115.         await request("POST /repos/almasen/rdf-mapped/issues", {
  116.             headers: {
  117.                 authorization: `token ${process.env.GITHUB_TOKEN}`,
  118.             },
  119.             title,
  120.             body,
  121.             labels: [label],
  122.         });
  123.         log.info("Successfully created Github Issue - %s", title);
  124.     } catch (error) {
  125.         log.error("Github Issue creation FAILED, err: " + error.message);
  126.     };
  127. };
  129. module.exports = {
  130.     createBugreportIssue,
  131.     createFeatureRequestIssue,
  132. };