subgraph: Remove circular dependency

Author: evaporei

src/command-helpers/data-sources.js

@@ -1,11 +1,43 @@
+const immutable = require('immutable')
 const { loadManifest } = require('../migrations/util/load-manifest')
 
+// From file path
 const getDataSourcesAndTemplates = async manifestPath => {
   const { dataSources = [], templates = [] } = await loadManifest(manifestPath)
 
   return dataSources.concat(templates)
 }
 
+// From in memory immutable data structure
+const collectDataSources = (manifest, protocolName) =>
+  manifest
+    .get('dataSources')
+    .reduce(
+      (dataSources, dataSource, dataSourceIndex) =>
+      dataSource.get('kind') === protocolName
+      ? dataSources.push(
+        immutable.Map({ path: ['dataSources', dataSourceIndex], dataSource }),
+      )
+      : dataSources,
+      immutable.List(),
+    )
+
+const collectDataSourceTemplates = (manifest, protocolName) =>
+  manifest.get('templates', immutable.List()).reduce(
+    (templates, template, templateIndex) =>
+    template.get('kind') === protocolName
+    ? templates.push(
+      immutable.Map({
+        path: ['templates', templateIndex],
+        dataSource: template,
+      }),
+    )
+    : templates,
+    immutable.List(),
+  )
+
 module.exports = {
   getDataSourcesAndTemplates,
+  collectDataSources,
+  collectDataSourceTemplates,
 }

src/protocols/ethereum/subgraph.js

@@ -1,6 +1,7 @@
 const immutable = require('immutable')
 const ABI = require('./abi')
-const Subgraph = require('../../subgraph')
+const { collectDataSources, collectDataSourceTemplates } = require('../../command-helpers/data-sources')
+const { validateContractAddresses } = require('../../validation')
 
 module.exports = class EthereumSubgraph {
   constructor(options = {}) {
@@ -16,8 +17,8 @@ module.exports = class EthereumSubgraph {
   }
 
   validateAbis() {
-    let dataSources = Subgraph.collectDataSources(this.manifest, 'ethereum/contract')
-    let dataSourceTemplates = Subgraph.collectDataSourceTemplates(this.manifest, 'ethereum/contract')
+    let dataSources = collectDataSources(this.manifest, 'ethereum/contract')
+    let dataSourceTemplates = collectDataSourceTemplates(this.manifest, 'ethereum/contract')
 
     return dataSources.concat(dataSourceTemplates).reduce(
       (errors, dataSourceOrTemplate) =>
@@ -74,7 +75,7 @@ ${abiNames
   validateContractAddresses() {
     const ethereumAddressPattern = /^(0x)?[0-9a-fA-F]{40}$/
 
-    return Subgraph.validateContractAddresses(
+    return validateContractAddresses(
       this.manifest,
       'ethereum/contract',
       address => ethereumAddressPattern.test(address),
@@ -83,8 +84,8 @@ ${abiNames
   }
 
   validateEvents() {
-    let dataSources = Subgraph.collectDataSources(this.manifest, 'ethereum/contract')
-    let dataSourceTemplates = Subgraph.collectDataSourceTemplates(this.manifest, 'ethereum/contract')
+    let dataSources = collectDataSources(this.manifest, 'ethereum/contract')
+    let dataSourceTemplates = collectDataSourceTemplates(this.manifest, 'ethereum/contract')
 
     return dataSources
       .concat(dataSourceTemplates)

src/protocols/near/subgraph.js

@@ -1,5 +1,5 @@
 const immutable = require('immutable')
-const Subgraph = require('../../subgraph')
+const { validateContractAddresses } = require('../../validation')
 
 module.exports = class NearSubgraph {
   constructor(options = {}) {
@@ -20,7 +20,7 @@ module.exports = class NearSubgraph {
       accountId.length <= MAXIMUM_ACCOUNT_ID_LENGTH
     const nearAccountIdPattern = /^(([a-z\d]+[\-_])*[a-z\d]+\.)*([a-z\d]+[\-_])*[a-z\d]+$/
 
-    return Subgraph.validateContractAddresses(
+    return validateContractAddresses(
       this.manifest,
       'near',
       accountId => validateLength(accountId) && nearAccountIdPattern.test(accountId),

src/subgraph.js

@@ -87,64 +87,6 @@ module.exports = class Subgraph {
     }
   }
 
-  static collectDataSources(manifest, protocolName) {
-    return manifest
-      .get('dataSources')
-      .reduce(
-        (dataSources, dataSource, dataSourceIndex) =>
-          dataSource.get('kind') === protocolName
-            ? dataSources.push(
-                immutable.Map({ path: ['dataSources', dataSourceIndex], dataSource }),
-              )
-            : dataSources,
-        immutable.List(),
-      )
-  }
-
-  static collectDataSourceTemplates(manifest, protocolName) {
-    return manifest.get('templates', immutable.List()).reduce(
-      (templates, template, templateIndex) =>
-        template.get('kind') === protocolName
-          ? templates.push(
-              immutable.Map({
-                path: ['templates', templateIndex],
-                dataSource: template,
-              }),
-            )
-          : templates,
-      immutable.List(),
-    )
-  }
-
-  static validateContractAddresses(manifest, protocolName, validator, errorMessage) {
-    return manifest
-      .get('dataSources')
-      .filter(dataSource => dataSource.get('kind') === protocolName)
-      .reduce((errors, dataSource, dataSourceIndex) => {
-        let path = ['dataSources', dataSourceIndex, 'source', 'address']
-
-        // No need to validate if the source has no contract address
-        if (!dataSource.get('source').has('address')) {
-          return errors
-        }
-
-        let address = dataSource.getIn(['source', 'address'])
-
-        // Validate whether the address is valid
-        if (validator(address)) {
-          return errors
-        } else {
-          return errors.push(
-            immutable.fromJS({
-              path,
-              message: `\
-Contract address is invalid: ${address}${errorMessage ? `\n${errorMessage}` : ''}`,
-            }),
-          )
-        }
-      }, immutable.List())
-  }
-
   static validateRepository(manifest, { resolveFile }) {
     return manifest.get('repository') !==
       'https://github.com/graphprotocol/example-subgraph'

src/validation/index.js

@@ -1,4 +1,5 @@
 module.exports = {
   validateSchema: require('./schema').validateSchema,
   validateManifest: require('./manifest').validateManifest,
+  validateContractAddresses: require('./manifest').validateContractAddresses,
 }

src/validation/manifest.js

@@ -290,4 +290,35 @@ const validateManifest = (value, type, schema, { resolveFile }) => {
   return validateDataSourceNetworks(value)
 }
 
-module.exports = { validateManifest }
+const validateContractAddresses = (manifest, protocolName, validator, errorMessage) =>
+  manifest
+    .get('dataSources')
+    .filter(dataSource => dataSource.get('kind') === protocolName)
+    .reduce((errors, dataSource, dataSourceIndex) => {
+      let path = ['dataSources', dataSourceIndex, 'source', 'address']
+
+      // No need to validate if the source has no contract address
+      if (!dataSource.get('source').has('address')) {
+        return errors
+      }
+
+      let address = dataSource.getIn(['source', 'address'])
+
+      // Validate whether the address is valid
+      if (validator(address)) {
+        return errors
+      } else {
+        return errors.push(
+          immutable.fromJS({
+            path,
+            message: `\
+Contract address is invalid: ${address}${errorMessage ? `\n${errorMessage}` : ''}`,
+          }),
+        )
+      }
+    }, immutable.List())
+
+module.exports = {
+  validateManifest,
+  validateContractAddresses,
+}