Disallow non ethereum mainnet networks on studio (#743)

* command-helpers: Add validator for studio network

* init: Disallow non ethereum mainnet on studio

* deploy: Disallow non ethereum mainnet on studio

Author: evaporei

src/command-helpers/studio.js

@@ -0,0 +1,12 @@
+const validateStudioNetwork = ({ studio, product, network }) => {
+  let isStudio = studio || product === 'subgraph-studio'
+  let isEthereumMainnet = network === 'mainnet'
+
+  if (isStudio && !isEthereumMainnet) {
+    throw new Error(`Non Ethereum mainnet subgraphs should not be deployed to the studio`)
+  }
+}
+
+module.exports = {
+  validateStudioNetwork,
+}

src/command-helpers/studio.test.js

@@ -0,0 +1,44 @@
+const { validateStudioNetwork } = require('./studio')
+
+describe('Version Command Helpers', () => {
+  describe('validateStudioNetwork', () => {
+    describe("When it's studio", () => {
+      test("And it's Ethereum mainnet", () => {
+        expect(() => validateStudioNetwork({
+          studio: true,
+          network: 'mainnet',
+        }))
+          .not
+          .toThrow(new Error('Non Ethereum mainnet subgraphs should not be deployed to the studio'))
+      })
+
+      test("And it's NOT Ethereum mainnet", () => {
+        expect(() => validateStudioNetwork({
+          product: 'subgraph-studio',
+          network: 'xdai',
+        }))
+          .toThrow(new Error('Non Ethereum mainnet subgraphs should not be deployed to the studio'))
+      })
+    })
+
+    describe("When it's NOT studio", () => {
+      test("And it's Ethereum mainnet", () => {
+        expect(() => validateStudioNetwork({
+          studio: false,
+          network: 'mainnet',
+        }))
+          .not
+          .toThrow(new Error('Non Ethereum mainnet subgraphs should not be deployed to the studio'))
+      })
+
+      test("And it's NOT Ethereum mainnet", () => {
+        expect(() => validateStudioNetwork({
+          product: 'hosted-service',
+          network: 'xdai',
+        }))
+          .not
+          .toThrow(new Error('Non Ethereum mainnet subgraphs should not be deployed to the studio'))
+      })
+    })
+  })
+})

src/commands/deploy.js

@@ -11,6 +11,8 @@ 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 { validateStudioNetwork } = require('../command-helpers/studio')
+const { loadManifest } = require('../migrations/util/load-manifest')
 
 const HELP = `
 ${chalk.bold('graph deploy')} [options] ${chalk.bold('<subgraph-name>')} ${chalk.bold(
@@ -125,6 +127,22 @@ module.exports = {
         ? manifest
         : filesystem.resolve('subgraph.yaml')
 
+    try {
+      let manifestFile = await loadManifest(manifest)
+
+      for (const { network } of manifestFile.dataSources || []) {
+        validateStudioNetwork({ studio, product, network })
+      }
+
+      for (const { network } of manifestFile.templates || []) {
+        validateStudioNetwork({ studio, product, network })
+      }
+    } catch (e) {
+      print.error(e.message)
+      process.exitCode = 1
+      return
+    }
+
     // Show help text if requested
     if (help) {
       print.info(HELP)

src/commands/init.js

@@ -9,9 +9,11 @@ const {
   getSubgraphBasename,
   validateSubgraphName,
 } = require('../command-helpers/subgraph')
+const { validateStudioNetwork } = require('../command-helpers/studio')
 const { withSpinner, step } = require('../command-helpers/spinner')
 const { fixParameters } = require('../command-helpers/gluegun')
 const { chooseNodeUrl } = require('../command-helpers/node')
+const { loadManifest } = require('../migrations/util/load-manifest')
 const { abiEvents, generateScaffold, writeScaffold } = require('../scaffold')
 const ABI = require('../abi')
 
@@ -381,7 +383,7 @@ module.exports = {
     if (fromExample && subgraphName && directory) {
       return await initSubgraphFromExample(
         toolbox,
-        { allowSimpleName, directory, subgraphName },
+        { allowSimpleName, directory, subgraphName, studio, product },
         { commands },
       )
     }
@@ -421,7 +423,9 @@ module.exports = {
           network,
           subgraphName,
           contractName,
-          node
+          node,
+          studio,
+          product,
         },
         { commands },
       )
@@ -455,6 +459,8 @@ module.exports = {
         {
           subgraphName: inputs.subgraphName,
           directory: inputs.directory,
+          studio: inputs.studio,
+          product: inputs.product,
         },
         { commands },
       )
@@ -476,7 +482,9 @@ module.exports = {
           address: inputs.address,
           indexEvents,
           contractName: inputs.contractName,
-          node
+          node,
+          studio: inputs.studio,
+          product: inputs.product,
         },
         { commands },
       )
@@ -567,7 +575,7 @@ Make sure to visit the documentation on https://thegraph.com/docs/ for further i
 
 const initSubgraphFromExample = async (
   toolbox,
-  { allowSimpleName, subgraphName, directory },
+  { allowSimpleName, subgraphName, directory, studio, product },
   { commands },
 ) => {
   let { filesystem, print, system } = toolbox
@@ -602,6 +610,24 @@ const initSubgraphFromExample = async (
     return
   }
 
+  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.
+    let manifestFile = await loadManifest(path.join(directory, 'subgraph.yaml'))
+
+    for (const { network } of manifestFile.dataSources || []) {
+      validateStudioNetwork({ studio, product, network })
+    }
+
+    for (const { network } of manifestFile.templates || []) {
+      validateStudioNetwork({ studio, product, network })
+    }
+  } catch (e) {
+    print.error(e.message)
+    process.exitCode = 1
+    return
+  }
+
   // Update package.json to match the subgraph name
   let prepared = await withSpinner(
     `Update subgraph name and commands in package.json`,
@@ -661,7 +687,19 @@ const initSubgraphFromExample = async (
 
 const initSubgraphFromContract = async (
   toolbox,
-  {allowSimpleName, subgraphName, directory, abi, network, address, indexEvents, contractName, node},
+  {
+    allowSimpleName,
+    subgraphName,
+    directory,
+    abi,
+    network,
+    address,
+    indexEvents,
+    contractName,
+    node,
+    studio,
+    product,
+  },
   { commands },
 ) => {
   let { print } = toolbox
@@ -686,6 +724,17 @@ const initSubgraphFromContract = async (
     return
   }
 
+  // We can validate this before the scaffold because we receive
+  // the network from the form or via command line argument.
+  // We don't need to read the manifest in this case.
+  try {
+    validateStudioNetwork({ studio, product, network })
+  } catch (e) {
+    print.error(e.message)
+    process.exitCode = 1
+    return
+  }
+
   // Scaffold subgraph from ABI
   let scaffold = await withSpinner(
     `Create subgraph scaffold`,