Float subgraph uncrashable integration as a package (#987)

* Float subgraph uncrashable integration as a package

* review changes

* Update to latest package

* final latest version for integration

Author: MJYoung114

package.json

@@ -11,6 +11,7 @@
     "debug": "4.3.1",
     "docker-compose": "0.23.4",
     "dockerode": "2.5.8",
+    "@float-capital/float-subgraph-uncrashable": "^0.0.0-alpha.4",
     "fs-extra": "9.0.0",
     "glob": "7.1.6",
     "gluegun": "https://github.com/edgeandnode/gluegun#v4.3.1-pin-colors-dep",

src/commands/codegen.js

@@ -5,18 +5,21 @@ const TypeGenerator = require('../type-generator')
 const Protocol = require('../protocols')
 const { fixParameters } = require('../command-helpers/gluegun')
 const DataSourcesExtractor = require('../command-helpers/data-sources')
-const { assertManifestApiVersion, assertGraphTsVersion } = require('../command-helpers/version')
+const {
+  assertManifestApiVersion,
+  assertGraphTsVersion,
+} = require('../command-helpers/version')
 
 const HELP = `
 ${chalk.bold('graph codegen')} [options] ${chalk.bold('[<subgraph-manifest>]')}
-
 Options:
-
   -h, --help                    Show usage information
   -o, --output-dir <path>       Output directory for generated types (default: generated/)
-      --skip-migrations         Skip subgraph migrations (default: false)
+  --skip-migrations         Skip subgraph migrations (default: false)
   -w, --watch                   Regenerate types when subgraph files change (default: false)
-`
+  -u, --uncrashable            Generate Float Subgraph Uncrashable helper file
+  -uc, --uncrashable-config <path>  Directory for uncrashable config (default: ./uncrashable-config.yaml)
+  `
 
 module.exports = {
   description: 'Generates AssemblyScript types for a subgraph',
@@ -25,12 +28,26 @@ module.exports = {
     let { filesystem, print, system } = toolbox
 
     // Read CLI parameters
-    let { h, help, o, outputDir, skipMigrations, w, watch } = toolbox.parameters.options
+    let {
+      h,
+      help,
+      o,
+      outputDir,
+      skipMigrations,
+      w,
+      watch,
+      u,
+      uncrashable,
+      uc,
+      uncrashableConfig,
+    } = toolbox.parameters.options
 
     // Support both long and short option variants
     help = help || h
     outputDir = outputDir || o
     watch = watch || w
+    uncrashable = uncrashable || u
+    uncrashable_config = uncrashableConfig || uc
 
     let manifest
     try {
@@ -39,6 +56,8 @@ module.exports = {
         help,
         w,
         watch,
+        u,
+        uncrashable,
       })
     } catch (e) {
       print.error(e.message)
@@ -56,6 +75,11 @@ module.exports = {
         ? manifest
         : filesystem.resolve('subgraph.yaml')
 
+    uncrashable_config =
+      uncrashable_config !== undefined && uncrashable_config !== ''
+        ? uncrashable_config
+        : filesystem.resolve('uncrashable-config.yaml')
+
     // Show help text if requested
     if (help) {
       print.info(HELP)
@@ -87,6 +111,8 @@ module.exports = {
       outputDir: outputDir,
       skipMigrations,
       protocol,
+      uncrashable,
+      uncrashableConfig: uncrashable_config,
     })
 
     // Watch working directory for file updates or additions, trigger

src/type-generator.js

@@ -14,6 +14,7 @@ const { step, withSpinner } = require('./command-helpers/spinner')
 const { applyMigrations } = require('./migrations')
 const { GENERATED_FILE_NOTE } = require('./codegen/typescript')
 const { displayPath } = require('./command-helpers/fs')
+const uncrashable = require('../node_modules/@float-capital/float-subgraph-uncrashable/src/Index.bs.js')
 
 module.exports = class TypeGenerator {
   constructor(options) {
@@ -53,20 +54,48 @@ module.exports = class TypeGenerator {
 
       // Not all protocols support/have ABIs.
       if (this.protocol.hasABIs()) {
-        const templateAbis = await this.protocolTypeGenerator.loadDataSourceTemplateABIs(subgraph)
-        await this.protocolTypeGenerator.generateTypesForDataSourceTemplateABIs(templateAbis)
+        const templateAbis = await this.protocolTypeGenerator.loadDataSourceTemplateABIs(
+          subgraph,
+        )
+        await this.protocolTypeGenerator.generateTypesForDataSourceTemplateABIs(
+          templateAbis,
+        )
       }
 
       let schema = await this.loadSchema(subgraph)
       await this.generateTypesForSchema(schema)
 
       toolbox.print.success('\nTypes generated successfully\n')
+
+      if (this.options.uncrashable && this.options.uncrashableConfig) {
+        await this.generateUncrashableEntities(schema)
+        toolbox.print.success('\nUncrashable Helpers generated successfully\n')
+      }
       return true
     } catch (e) {
       return false
     }
   }
 
+  async generateUncrashableEntities(graphSchema) {
+    let ast = graphql.parse(graphSchema.document)
+    let entityDefinitions = ast['definitions']
+    return await withSpinner(
+      `Generate Uncrashable Entity Helpers`,
+      `Failed to generate Uncrashable Entity Helpers`,
+      `Warnings while generating Uncrashable Entity Helpers`,
+      async spinner => {
+        uncrashable.run(
+          entityDefinitions,
+          this.options.uncrashableConfig,
+          this.options.outputDir,
+        )
+        let outputFile = path.join(this.options.outputDir, 'UncrashableEntityHelpers.ts')
+        step(spinner, 'Save uncrashable entities to', displayPath(outputFile))
+      },
+    )
+  }
+
   async loadSubgraph({ quiet } = { quiet: false }) {
     const subgraphLoadOptions = { protocol: this.protocol, skipValidation: false }
 
@@ -148,7 +177,10 @@ module.exports = class TypeGenerator {
               `${template.get('name')}`,
             )
 
-            let codeGenerator = new DataSourceTemplateCodeGenerator(template, this.protocol)
+            let codeGenerator = new DataSourceTemplateCodeGenerator(
+              template,
+              this.protocol,
+            )
 
             // Only generate module imports once, because they are identical for
             // all types generated for data source templates.

yarn.lock

@@ -478,6 +478,16 @@
     "@ethersproject/properties" "^5.5.0"
     "@ethersproject/strings" "^5.5.0"
 
+"@float-capital/float-subgraph-uncrashable@^0.0.0-alpha.4":
+  version "0.0.0-alpha.4"
+  resolved "https://registry.yarnpkg.com/@float-capital/float-subgraph-uncrashable/-/float-subgraph-uncrashable-0.0.0-alpha.4.tgz#0605d10aa97e1ba7d26cc095afb23eda9ffdfb37"
+  integrity sha512-3DPy66rMvGAFDDv7craf/Vgz1fLfuU0QSJ16HB1CRZyFQFqICFHbDL7h04zqG8i255z8cfBcgYq+zSxVzeEyLw==
+  dependencies:
+    graphql "^16.6.0"
+    graphql-import-node "^0.0.5"
+    js-yaml "^4.1.0"
+    rescript "^9.1.4"
+
 "@istanbuljs/load-nyc-config@^1.0.0":
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/@istanbuljs/load-nyc-config/-/load-nyc-config-1.0.0.tgz#10602de5570baea82f8afbfa2630b24e7a8cfe5b"
@@ -1024,6 +1034,11 @@ argparse@^1.0.7:
   dependencies:
     sprintf-js "~1.0.2"
 
+argparse@^2.0.1:
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38"
+  integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==
+
 arr-diff@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/arr-diff/-/arr-diff-4.0.0.tgz#d6461074febfec71e7e15235761a329a5dc7c520"
@@ -2746,11 +2761,21 @@ graceful-fs@^4.2.4:
   resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.4.tgz#2256bde14d3632958c465ebc96dc467ca07a29fb"
   integrity sha512-WjKPNJF79dtJAVniUlGGWHYGz2jWxT6VhN/4m1NdkbZ2nOsEF+cI1Edgql5zCRhs/VsQYRvrXctxktVXZUkixw==
 
+graphql-import-node@^0.0.5:
+  version "0.0.5"
+  resolved "https://registry.yarnpkg.com/graphql-import-node/-/graphql-import-node-0.0.5.tgz#caf76a6cece10858b14f27cce935655398fc1bf0"
+  integrity sha512-OXbou9fqh9/Lm7vwXT0XoRN9J5+WCYKnbiTalgFDvkQERITRmcfncZs6aVABedd5B85yQU5EULS4a5pnbpuI0Q==
+
 [email protected]:
   version "15.5.0"
   resolved "https://registry.yarnpkg.com/graphql/-/graphql-15.5.0.tgz#39d19494dbe69d1ea719915b578bf920344a69d5"
   integrity sha512-OmaM7y0kaK31NKG31q4YbD2beNYa6jBBKtMFT6gLYJljHLJr42IqJ8KX08u3Li/0ifzTU5HjmoOOrwa5BRLeDA==
 
+graphql@^16.6.0:
+  version "16.6.0"
+  resolved "https://registry.yarnpkg.com/graphql/-/graphql-16.6.0.tgz#c2dcffa4649db149f6282af726c8c83f1c7c5fdb"
+  integrity sha512-KPIBPDlW7NxrbT/eh4qPXz5FiFdL5UbaA0XUNz2Rp3Z3hqBSkbj0GVjwFDztsWVauZUWsbKHgMg++sk8UX0bkw==
+
 growly@^1.3.0:
   version "1.3.0"
   resolved "https://registry.yarnpkg.com/growly/-/growly-1.3.0.tgz#f10748cbe76af964b7c96c93c6bcc28af120c081"
@@ -3833,6 +3858,13 @@ [email protected], js-yaml@^3.13.1:
     argparse "^1.0.7"
     esprima "^4.0.0"
 
+js-yaml@^4.1.0:
+  version "4.1.0"
+  resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.0.tgz#c1fb65f8f5017901cdd2c951864ba18458a10602"
+  integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==
+  dependencies:
+    argparse "^2.0.1"
+
 jsbn@~0.1.0:
   version "0.1.1"
   resolved "https://registry.yarnpkg.com/jsbn/-/jsbn-0.1.1.tgz#a5e654c2e5a2deb5f201d96cefbca80c0ef2f513"
@@ -5218,6 +5250,11 @@ require-main-filename@^2.0.0:
   resolved "https://registry.yarnpkg.com/require-main-filename/-/require-main-filename-2.0.0.tgz#d0b329ecc7cc0f61649f62215be69af54aa8989b"
   integrity sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==
 
+rescript@^9.1.4:
+  version "9.1.4"
+  resolved "https://registry.yarnpkg.com/rescript/-/rescript-9.1.4.tgz#1eb126f98d6c16942c0bf0df67c050198e580515"
+  integrity sha512-aXANK4IqecJzdnDpJUsU6pxMViCR5ogAxzuqS0mOr8TloMnzAjJFu63fjD6LCkWrKAhlMkFFzQvVQYaAaVkFXw==
+
 resolve-cwd@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/resolve-cwd/-/resolve-cwd-3.0.0.tgz#0f0075f1bb2544766cf73ba6a6e2adfebcb13f2d"