only use matterWrapper

lib/matter.ts

@@ -0,0 +1,24 @@
+import matter from 'gray-matter';
+
+interface MatterResult {
+  data: any;
+  content: string;
+}
+
+export function matterWrapper(document: string): MatterResult {
+  const { data, content } = matter(document || '', {
+    engines: {
+      javascript: {
+        parse: function () {
+          console.log('Parsing JavaScript is not allowed');
+          return {};
+        },
+        stringify: function () {
+          console.log('Stringifying JavaScript is not allowed');
+          return '';
+        }
+      }
+    }
+  });
+  return { data, content };
+}

modules/avcs/api/fetchAvcs.ts

@@ -16,7 +16,7 @@ import { allGithubAvcs } from 'modules/gql/queries/allGithubAvcs';
 import logger from 'lib/logger';
 import { GraphQlQueryResponseData } from '@octokit/graphql';
 import { RepositoryInfo } from 'modules/delegates/api/getDelegatesRepositoryInfo';
-import matter from 'gray-matter';
+import { matterWrapper } from 'lib/matter';
 import { markdownToHtml } from 'lib/markdown';
 import { AvcOrderByEnum } from '../avcs.constants';
 import { fetchDelegatesPaginated } from 'modules/delegates/api/fetchDelegates';
@@ -50,7 +50,7 @@ async function extractGithubInformationGraphQL(
       const {
         content,
         data: { external_profile_url, avc_name }
-      } = matter(profileMdDoc);
+      } = matterWrapper(profileMdDoc);
       const html = await markdownToHtml(content);
       const avcDescription = html.split('<h1>$delegate_name</h1>')[0];
 

modules/delegates/api/fetchGithubDelegates.ts

@@ -6,7 +6,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
 
 */
 
-import matter from 'gray-matter';
+import { matterWrapper } from 'lib/matter';
 import { GraphQlQueryResponseData } from '@octokit/graphql';
 import { SupportedNetworks } from 'modules/web3/constants/networks';
 import { cacheGet, cacheSet } from 'modules/cache/cache';
@@ -45,13 +45,13 @@ async function extractGithubInformation(
     const {
       content,
       data: { name, external_profile_url, tags, avc_name }
-    } = matter(profileMdDoc);
+    } = matterWrapper(profileMdDoc);
 
     let metricsMdDoc;
     let metricsData;
     if (metricsMd) {
       metricsMdDoc = await (await fetch(metricsMd?.download_url)).text();
-      const { data } = matter(metricsMdDoc);
+      const { data } = matterWrapper(metricsMdDoc);
       metricsData = data;
     }
 
@@ -110,10 +110,10 @@ async function extractGithubInformationGraphQL(
       const {
         content,
         data: { name, external_profile_url, tags, avc_name }
-      } = matter(profileMdDoc);
+      } = matterWrapper(profileMdDoc);
 
       const metricsMdDoc = metricsMd?.object?.text;
-      const { data } = matter(metricsMdDoc);
+      const { data } = matterWrapper(metricsMdDoc);
       const metricsData = data;
 
       let cuMember = false;

modules/executive/api/parseExecutive.ts

@@ -6,7 +6,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
 
 */
 
-import matter from 'gray-matter';
+import { matterWrapper } from 'lib/matter';
 import { CMSProposal } from 'modules/executive/types';
 import { ethers } from 'ethers';
 import { slugify } from 'lib/utils';
@@ -22,7 +22,7 @@ export function parseExecutive(
   const {
     content,
     data: { title, summary, address, date }
-  } = matter(proposalDoc);
+  } = matterWrapper(proposalDoc);
   // Remove empty docs
   if (!(content && title && summary && address && date)) {
     logger.warn(

modules/polling/api/fetchPollMetadata.ts

@@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
 import { Poll, PartialPoll } from '../types/poll';
 
 import { backoffRetry, timeoutPromise } from 'lib/utils';
-import matter from 'gray-matter';
+import { matterWrapper } from 'lib/matter';
 import { parsePollMetadata } from '../helpers/parsePollMetadata';
 import logger from 'lib/logger';
 
@@ -22,7 +22,7 @@ async function fetchPollGithubDocument(url: string): Promise<string> {
       return resp?.text();
     });
 
-    if (!(document.length > 0 && Object.keys(matter(document).data?.options)?.length > 0)) {
+    if (!(document.length > 0 && Object.keys(matterWrapper(document).data?.options)?.length > 0)) {
       throw new Error('Invalid poll document');
     }
 

modules/polling/helpers/__tests__/parsePollMetadata.spec.ts

@@ -10,7 +10,7 @@ import { parsePollMetadata, spockPollToPartialPoll } from '../parsePollMetadata'
 import pollJson327 from './__helpers__/poll-327.js';
 import pollJson431 from './__helpers__/poll-431.js';
 import fs from 'fs';
-import matter from 'gray-matter';
+import { matterWrapper } from 'lib/matter';
 import { PollSpock } from '../../types/pollSpock';
 import { getPollTags, getPollTagsMapping } from 'modules/polling/api/getPollTags';
 import { PollInputFormat, PollResultDisplay, PollVictoryConditions } from 'modules/polling/polling.constants';
@@ -76,7 +76,7 @@ describe('Parse poll metadata', () => {
       })
     );
 
-    expect(actual.content).toEqual(matter(pollMetadata431).content);
+    expect(actual.content).toEqual(matterWrapper(pollMetadata431).content);
   });
 
   test('return the expected values for an old uncategorized poll', async () => {
@@ -111,6 +111,6 @@ describe('Parse poll metadata', () => {
       })
     );
 
-    expect(actual.content).toEqual(matter(pollMetadata327).content);
+    expect(actual.content).toEqual(matterWrapper(pollMetadata327).content);
   });
 });

modules/polling/helpers/__tests__/validatePollParameters.spec.ts

@@ -6,7 +6,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
 
 */
 
-import matter from 'gray-matter';
+import { matterWrapper } from 'lib/matter';
 import { POLL_VOTE_TYPE } from 'modules/polling/polling.constants';
 import {
   ERRORS_VALIDATE_POLL_PARAMETERS,
@@ -22,7 +22,7 @@ parameters:
 ---
         `;
 
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -39,7 +39,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -57,7 +57,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -76,7 +76,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -97,7 +97,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -120,7 +120,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -142,7 +142,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -162,7 +162,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -182,7 +182,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -202,7 +202,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -222,7 +222,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toEqual({
@@ -248,7 +248,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -268,7 +268,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toEqual({
@@ -293,7 +293,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -313,7 +313,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
 
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -333,7 +333,7 @@ parameters:
 # hello
 
     `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toBe(null);
@@ -355,7 +355,7 @@ parameters:
 # hello
 
         `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toEqual({
@@ -384,7 +384,7 @@ parameters:
 # hello
 
         `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toEqual({
@@ -413,7 +413,7 @@ parameters:
 # hello
 
             `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toEqual(null);
@@ -434,7 +434,7 @@ parameters:
 # hello
 
             `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toEqual(null);
@@ -455,7 +455,7 @@ parameters:
 # hello
 
             `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toEqual(null);
@@ -478,7 +478,7 @@ parameters:
 # hello
 
             `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toEqual(null);
@@ -503,7 +503,7 @@ parameters:
 # hello
 
             `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toEqual(null);
@@ -525,7 +525,7 @@ parameters:
 # hello
 
             `;
-    const parametersMarkdown = matter(parameters);
+    const parametersMarkdown = matterWrapper(parameters);
     // Returns correct if is correct
     const [parsed, errors] = validatePollParameters(parametersMarkdown.data.parameters);
     expect(parsed).toEqual(null);
@@ -543,7 +543,7 @@ parameters:
   //     - { type : default, options : [2] }
   //   result_display: single-vote-breakdown
   // `;
-  //     const parametersMarkdown = matter(parameters);
+  //     const parametersMarkdown = matterWrapper(parameters);
   //     // Returns correct if is correct
   //     const [parsed, errors] = validatePollParameters(parametersMarkdown.data);
   //   });

modules/polling/helpers/__tests__/validator.spec.ts

@@ -24,7 +24,6 @@ test('reject a blank document', () => {
 test('reject null', () => {
   const result = validatePollMarkdown(null);
   expect(result.valid).toBeFalsy();
-  expect(result.errors).toContain('expected input to be a string or buffer');
 });
 
 test('reject a document with no options', () => {