refactor: Improve data source extraction

Author: evaporei

src/command-helpers/data-sources.js

@@ -1,43 +1,38 @@
 const immutable = require('immutable')
 const { loadManifest } = require('../migrations/util/load-manifest')
 
-// From file path
-const getDataSourcesAndTemplates = async manifestPath => {
+// Loads manifest from file path and returns all:
+// - data sources
+// - templates
+// In a single list.
+const fromFilePath = async manifestPath => {
   const { dataSources = [], templates = [] } = await loadManifest(manifestPath)
 
   return dataSources.concat(templates)
 }
 
-// From in memory immutable data structure
-const collectDataSources = (manifest, protocolName) =>
+const extractDataSourceByType = (manifest, dataSourceType, protocolName) =>
   manifest
-    .get('dataSources')
+    .get(dataSourceType, immutable.List())
     .reduce(
       (dataSources, dataSource, dataSourceIndex) =>
       dataSource.get('kind') === protocolName
       ? dataSources.push(
-        immutable.Map({ path: ['dataSources', dataSourceIndex], dataSource }),
+        immutable.Map({ path: [dataSourceType, 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(),
-  )
+// Extracts data sources and templates from a immutable manifest data structure
+const fromManifest = (manifest, protocolName) => {
+  const dataSources = extractDataSourceByType(manifest, 'dataSources', protocolName)
+  const templates = extractDataSourceByType(manifest, 'templates', protocolName)
+
+  return dataSources.concat(templates)
+}
 
 module.exports = {
-  getDataSourcesAndTemplates,
-  collectDataSources,
-  collectDataSourceTemplates,
+  fromFilePath,
+  fromManifest,
 }

src/commands/build.js

@@ -2,7 +2,7 @@ const chalk = require('chalk')
 
 const { createCompiler } = require('../command-helpers/compiler')
 const { fixParameters } = require('../command-helpers/gluegun')
-const { getDataSourcesAndTemplates } = require('../command-helpers/data-sources')
+const DataSourcesExtractor = require('../command-helpers/data-sources')
 const Protocol = require('../protocols')
 
 const HELP = `
@@ -77,7 +77,7 @@ module.exports = {
 
     let protocol
     try {
-      const dataSourcesAndTemplates = await getDataSourcesAndTemplates(manifest)
+      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
 
       protocol = Protocol.fromDataSources(dataSourcesAndTemplates)
     } catch (e) {

src/commands/codegen.js

@@ -4,7 +4,7 @@ const path = require('path')
 const TypeGenerator = require('../type-generator')
 const Protocol = require('../protocols')
 const { fixParameters } = require('../command-helpers/gluegun')
-const { getDataSourcesAndTemplates } = require('../command-helpers/data-sources')
+const DataSourcesExtractor = require('../command-helpers/data-sources')
 const { assertManifestApiVersion, assertGraphTsVersion } = require('../command-helpers/version')
 
 const HELP = `
@@ -73,7 +73,7 @@ module.exports = {
       await assertManifestApiVersion(manifest, '0.0.5')
       await assertGraphTsVersion(path.dirname(manifest), '0.22.0')
 
-      const dataSourcesAndTemplates = await getDataSourcesAndTemplates(manifest)
+      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
 
       protocol = Protocol.fromDataSources(dataSourcesAndTemplates)
     } catch (e) {

src/commands/deploy.js

@@ -11,7 +11,7 @@ const { withSpinner } = require('../command-helpers/spinner')
 const { validateSubgraphName } = require('../command-helpers/subgraph')
 const { DEFAULT_IPFS_URL } = require('../command-helpers/ipfs')
 const { assertManifestApiVersion, assertGraphTsVersion } = require('../command-helpers/version')
-const { getDataSourcesAndTemplates } = require('../command-helpers/data-sources')
+const DataSourcesExtractor = require('../command-helpers/data-sources')
 const { validateStudioNetwork } = require('../command-helpers/studio')
 const Protocol = require('../protocols')
 
@@ -129,7 +129,7 @@ module.exports = {
         : filesystem.resolve('subgraph.yaml')
 
     try {
-      const dataSourcesAndTemplates = await getDataSourcesAndTemplates(manifest)
+      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
 
       for (const { network } of dataSourcesAndTemplates) {
         validateStudioNetwork({ studio, product, network })
@@ -200,7 +200,7 @@ module.exports = {
       await assertManifestApiVersion(manifest, '0.0.5')
       await assertGraphTsVersion(path.dirname(manifest), '0.22.0')
 
-      const dataSourcesAndTemplates = await getDataSourcesAndTemplates(manifest)
+      const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifest)
 
       protocol = Protocol.fromDataSources(dataSourcesAndTemplates)
     } catch (e) {

src/commands/init.js

@@ -9,7 +9,7 @@ const {
   getSubgraphBasename,
   validateSubgraphName,
 } = require('../command-helpers/subgraph')
-const { getDataSourcesAndTemplates } = require('../command-helpers/data-sources')
+const DataSourcesExtractor = require('../command-helpers/data-sources')
 const { validateStudioNetwork } = require('../command-helpers/studio')
 const { withSpinner, step } = require('../command-helpers/spinner')
 const { fixParameters } = require('../command-helpers/gluegun')
@@ -614,7 +614,7 @@ const initSubgraphFromExample = async (
   try {
     // It doesn't matter if we changed the URL we clone the YAML,
     // we'll check it's network anyway. If it's a studio subgraph we're dealing with.
-    const dataSourcesAndTemplates = await getDataSourcesAndTemplates(path.join(directory, 'subgraph.yaml'))
+    const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(path.join(directory, 'subgraph.yaml'))
 
     for (const { network } of dataSourcesAndTemplates) {
       validateStudioNetwork({ studio, product, network })

src/protocols/ethereum/subgraph.js

@@ -1,6 +1,6 @@
 const immutable = require('immutable')
 const ABI = require('./abi')
-const { collectDataSources, collectDataSourceTemplates } = require('../../command-helpers/data-sources')
+const DataSourceExtractor = require('../../command-helpers/data-sources')
 const { validateContractAddresses } = require('../../validation')
 
 module.exports = class EthereumSubgraph {
@@ -17,10 +17,9 @@ module.exports = class EthereumSubgraph {
   }
 
   validateAbis() {
-    let dataSources = collectDataSources(this.manifest, 'ethereum/contract')
-    let dataSourceTemplates = collectDataSourceTemplates(this.manifest, 'ethereum/contract')
+    const dataSourcesAndTemplates = DataSourceExtractor.fromManifest(this.manifest, 'ethereum/contract')
 
-    return dataSources.concat(dataSourceTemplates).reduce(
+    return dataSourcesAndTemplates.reduce(
       (errors, dataSourceOrTemplate) =>
         errors.concat(
           this.validateDataSourceAbis(
@@ -84,11 +83,9 @@ ${abiNames
   }
 
   validateEvents() {
-    let dataSources = collectDataSources(this.manifest, 'ethereum/contract')
-    let dataSourceTemplates = collectDataSourceTemplates(this.manifest, 'ethereum/contract')
+    const dataSourcesAndTemplates = DataSourceExtractor.fromManifest(this.manifest, 'ethereum/contract')
 
-    return dataSources
-      .concat(dataSourceTemplates)
+    return dataSourcesAndTemplates
       .reduce((errors, dataSourceOrTemplate) => {
         return errors.concat(
           this.validateDataSourceEvents(