@graphprotocol/graph-cli 0.37.3 → 0.37.4

package/src/commands/test.ts

@@ -1,369 +0,0 @@
-import { exec, spawn } from 'child_process';
-import os from 'os';
-import path from 'path';
-import { Binary } from 'binary-install-raw';
-import chalk from 'chalk';
-import { filesystem, GluegunToolbox, patching, print, system } from 'gluegun';
-import yaml from 'js-yaml';
-import fetch from 'node-fetch';
-import semver from 'semver';
-import { fixParameters } from '../command-helpers/gluegun';
-
-const HELP = `
-${chalk.bold('graph test')} ${chalk.dim('[options]')} ${chalk.bold('<datasource>')}
-
-${chalk.dim('Options:')}
-  -c, --coverage                Run the tests in coverage mode
-  -d, --docker                  Run the tests in a docker container(Note: Please execute from the root folder of the subgraph)
-  -f  --force                   Binary - overwrites folder + file when downloading. Docker - rebuilds the docker image
-  -h, --help                    Show usage information
-  -l, --logs                    Logs to the console information about the OS, CPU model and download url (debugging purposes)
-  -r, --recompile               Force-recompile tests
-  -v, --version <tag>           Choose the version of the rust binary that you want to be downloaded/used
-  `;
-
-export interface TestOptions {
-  coverage?: boolean;
-  docker?: boolean;
-  force?: boolean;
-  help?: boolean;
-  logs?: boolean;
-  recompile?: boolean;
-  version?: string;
-  // not a cli arg
-  testsFolder: string;
-  cachePath: string;
-  latestVersion?: string;
-}
-
-export default {
-  description: 'Runs rust binary for subgraph testing',
-  run: async (toolbox: GluegunToolbox) => {
-    // Read CLI parameters
-    const { c, coverage, d, docker, f, force, h, help, l, logs, r, recompile, v, version } =
-      toolbox.parameters.options;
-
-    const testsFolder = './tests';
-    const opts: TestOptions = {
-      testsFolder,
-      cachePath: path.join(testsFolder, '.latest.json'),
-    };
-    // Support both long and short option variants
-    opts.coverage = coverage || c;
-    opts.docker = docker || d;
-    opts.force = force || f;
-    opts.help = help || h;
-    opts.logs = logs || l;
-    opts.recompile = recompile || r;
-    opts.version = version || v;
-    // Fix if a boolean flag (e.g -c, --coverage) has an argument
-    try {
-      fixParameters(toolbox.parameters, {
-        h,
-        help,
-        c,
-        coverage,
-        d,
-        docker,
-        f,
-        force,
-        l,
-        logs,
-        r,
-        recompile,
-      });
-    } catch (e) {
-      print.error(e.message);
-      process.exitCode = 1;
-      return;
-    }
-
-    const datasource = toolbox.parameters.first || toolbox.parameters.array?.[0];
-    // Show help text if requested
-    if (opts.help) {
-      print.info(HELP);
-      return;
-    }
-
-    // Check if matchstick.yaml config exists
-    if (filesystem.exists('matchstick.yaml')) {
-      try {
-        // Load the config
-        const config = await yaml.load(filesystem.read('matchstick.yaml', 'utf8')!);
-
-        // Check if matchstick.yaml and testsFolder not null
-        if (config?.testsFolder) {
-          // assign test folder from matchstick.yaml if present
-          opts.testsFolder = config.testsFolder;
-        }
-      } catch (error) {
-        print.info(
-          'A problem occurred while reading matchstick.yaml. Please attend to the errors below:',
-        );
-        print.error(error.message);
-        process.exit(1);
-      }
-    }
-
-    setVersionFromCache(opts);
-
-    // Fetch the latest version tag if version is not specified with -v/--version or if the version is not cached
-    if (opts.force || (!opts.version && !opts.latestVersion)) {
-      print.info('Fetching latest version tag');
-      const result = await fetch(
-        'https://api.github.com/repos/LimeChain/matchstick/releases/latest',
-      );
-      const json = await result.json();
-      opts.latestVersion = json.tag_name;
-
-      filesystem.file(opts.cachePath, {
-        content: {
-          version: json.tag_name,
-          timestamp: Date.now(),
-        },
-      });
-    }
-
-    if (opts.docker) {
-      runDocker(datasource, opts);
-    } else {
-      runBinary(datasource, opts);
-    }
-  },
-};
-
-async function setVersionFromCache(opts: TestOptions) {
-  if (filesystem.exists(opts.cachePath) == 'file') {
-    const cached = filesystem.read(opts.cachePath, 'json');
-    // Get the cache age in days
-    const cacheAge = (Date.now() - cached.timestamp) / (1000 * 60 * 60 * 24);
-    // If cache age is less than 1 day, use the cached version
-    if (cacheAge < 1) {
-      opts.latestVersion = cached.version;
-    }
-  }
-}
-
-async function runBinary(datasource: string | undefined, opts: TestOptions) {
-  const coverageOpt = opts.coverage;
-  const forceOpt = opts.force;
-  const logsOpt = opts.logs;
-  const versionOpt = opts.version;
-  const latestVersion = opts.latestVersion;
-  const recompileOpt = opts.recompile;
-
-  const platform = await getPlatform(logsOpt);
-
-  const url = `https://github.com/LimeChain/matchstick/releases/download/${
-    versionOpt || latestVersion
-  }/${platform}`;
-
-  if (logsOpt) {
-    print.info(`Download link: ${url}`);
-  }
-
-  const binary = new Binary(platform, url, versionOpt || latestVersion);
-  forceOpt ? await binary.install(true) : await binary.install(false);
-  const args = [];
-
-  if (coverageOpt) args.push('-c');
-  if (recompileOpt) args.push('-r');
-  if (datasource) args.push(datasource);
-  args.length > 0 ? binary.run(...args) : binary.run();
-}
-
-async function getPlatform(logsOpt: boolean | undefined) {
-  const type = os.type();
-  const arch = os.arch();
-  const cpuCore = os.cpus()[0];
-  const isAppleSilicon = arch === 'arm64' && /Apple (M1|M2|processor)/.test(cpuCore.model);
-  const linuxInfo = type === 'Linux' ? await getLinuxInfo() : {};
-  const linuxDistro = linuxInfo.name;
-  const release = linuxInfo.version || os.release();
-  const majorVersion = parseInt(linuxInfo.version || '', 10) || semver.major(release);
-
-  if (logsOpt) {
-    print.info(
-      `OS type: ${
-        linuxDistro || type
-      }\nOS arch: ${arch}\nOS release: ${release}\nOS major version: ${majorVersion}\nCPU model: ${
-        cpuCore.model
-      }`,
-    );
-  }
-
-  if (arch === 'x64' || isAppleSilicon) {
-    if (type === 'Darwin') {
-      if (majorVersion === 18 || majorVersion === 19) {
-        return 'binary-macos-10.15'; // GitHub dropped support for macOS 10.14 in Actions, but it seems 10.15 binary works on 10.14 too
-      }
-      if (isAppleSilicon) {
-        return 'binary-macos-11-m1';
-      }
-      return 'binary-macos-11';
-    }
-    if (type === 'Linux') {
-      if (majorVersion === 18) {
-        return 'binary-linux-18';
-      }
-      if (majorVersion === 22) {
-        return 'binary-linux-22';
-      }
-      return 'binary-linux-20';
-    }
-  }
-
-  throw new Error(`Unsupported platform: ${type} ${arch} ${majorVersion}`);
-}
-
-/**
- * The result of running `cat /etc/*-release | grep -E '(^VERSION|^NAME)='`
- *
- * May look like this:
- * ```sh
- * NAME="Ubuntu"
- * VERSION="16.04.7 LTS (Xenial Xerus)"
- * ```
- */
-interface LinuxInfo {
-  name?: string;
-  version?: string;
-}
-
-async function getLinuxInfo(): Promise<LinuxInfo> {
-  try {
-    const result = await system.run("cat /etc/*-release | grep -E '(^VERSION|^NAME)='", {
-      trim: true,
-    });
-    const infoArray = result
-      .replace(/['"]+/g, '')
-      .split('\n')
-      .map(p => p.split('='));
-    const linuxInfo: LinuxInfo = {};
-
-    infoArray.forEach(val => {
-      linuxInfo[val[0].toLowerCase() as keyof LinuxInfo] = val[1];
-    });
-
-    return linuxInfo;
-  } catch (error) {
-    print.error(`Error fetching the Linux version:\n ${error}`);
-    process.exit(1);
-  }
-}
-
-async function runDocker(datasource: string | undefined, opts: TestOptions) {
-  const coverageOpt = opts.coverage;
-  const forceOpt = opts.force;
-  const versionOpt = opts.version;
-  const latestVersion = opts.latestVersion;
-  const recompileOpt = opts.recompile;
-
-  // Remove binary-install-raw binaries, because docker has permission issues
-  // when building the docker images
-  filesystem.remove('./node_modules/binary-install-raw/bin');
-
-  // Get current working directory
-  const current_folder = filesystem.cwd();
-
-  // Declate dockerfilePath with default location
-  const dockerfilePath = path.join(opts.testsFolder || 'tests', '.docker/Dockerfile');
-
-  // Check if the Dockerfil already exists
-  const dockerfileExists = filesystem.exists(dockerfilePath);
-
-  // Generate the Dockerfile only if it doesn't exists,
-  // version flag and/or force flag is passed.
-  if (!dockerfileExists || versionOpt || forceOpt) {
-    await dockerfile(dockerfilePath, versionOpt, latestVersion);
-  }
-
-  // Run a command to check if matchstick image already exists
-  exec('docker images -q matchstick', (_error, stdout, _stderr) => {
-    // Collect all(if any) flags and options that have to be passed to the matchstick binary
-    let testArgs = '';
-    if (coverageOpt) testArgs = testArgs + ' -c';
-    if (recompileOpt) testArgs = testArgs + ' -r';
-    if (datasource) testArgs = testArgs + ' ' + datasource;
-
-    // Build the `docker run` command options and flags
-    const dockerRunOpts = [
-      'run',
-      '-it',
-      '--rm',
-      '--mount',
-      `type=bind,source=${current_folder},target=/matchstick`,
-    ];
-
-    if (testArgs !== '') {
-      dockerRunOpts.push('-e');
-      dockerRunOpts.push(`ARGS=${testArgs.trim()}`);
-    }
-
-    dockerRunOpts.push('matchstick');
-
-    // If a matchstick image does not exists, the command returns an empty string,
-    // else it'll return the image ID. Skip `docker build` if an image already exists
-    // Delete current image(if any) and rebuild.
-    // Use spawn() and {stdio: 'inherit'} so we can see the logs in real time.
-    if (!dockerfileExists || stdout === '' || versionOpt || forceOpt) {
-      if (stdout !== '') {
-        exec('docker image rm matchstick', (_error, stdout, _stderr) => {
-          print.info(chalk.bold(`Removing matchstick image\n${stdout}`));
-        });
-      }
-      // Build a docker image. If the process has executed successfully
-      // run a container from that image.
-      spawn('docker', ['build', '-f', dockerfilePath, '-t', 'matchstick', '.'], {
-        stdio: 'inherit',
-      }).on('close', code => {
-        if (code === 0) {
-          spawn('docker', dockerRunOpts, { stdio: 'inherit' });
-        }
-      });
-    } else {
-      print.info('Docker image already exists. Skipping `docker build` command.');
-      // Run the container from the existing matchstick docker image
-      spawn('docker', dockerRunOpts, { stdio: 'inherit' });
-    }
-  });
-}
-
-// Downloads Dockerfile template from the demo-subgraph repo
-// Replaces the placeholders with their respective values
-async function dockerfile(
-  dockerfilePath: string,
-  versionOpt: string | undefined,
-  latestVersion: string | undefined,
-) {
-  const spinner = print.spin('Generating Dockerfile...');
-
-  try {
-    // Fetch the Dockerfile template content from the demo-subgraph repo
-    const content = await fetch(
-      'https://raw.githubusercontent.com/LimeChain/demo-subgraph/main/Dockerfile',
-    ).then(response => {
-      if (response.ok) {
-        return response.text();
-      }
-      throw new Error(`Status Code: ${response.status}, with error: ${response.statusText}`);
-    });
-
-    // Write the Dockerfile
-    filesystem.write(dockerfilePath, content);
-
-    // Replaces the version placeholders
-    await patching.replace(
-      dockerfilePath,
-      '<MATCHSTICK_VERSION>',
-      versionOpt || latestVersion || 'unknown',
-    );
-  } catch (error) {
-    spinner.fail(
-      `A problem occurred while generating the Dockerfile. Please attend to the errors below:\n ${error.message}`,
-    );
-    process.exit(1);
-  }
-
-  spinner.succeed('Successfully generated Dockerfile.');
-}

package/src/compiler/asc.ts

@@ -1,77 +0,0 @@
-import * as asc from 'assemblyscript/cli/asc';
-
-const createExitHandler = (inputFile: string) => () => {
-  throw new Error(`The AssemblyScript compiler crashed when compiling this file: '${inputFile}'
-Suggestion: try to comment the whole file and uncomment it little by little while re-running the graph-cli until you isolate the line where the problem happens.
-Also, please contact us so we can make the CLI better by handling errors like this. You can reach out in any of these links:
-- Discord channel: https://discord.gg/eM8CA6WA9r
-- Github issues: https://github.com/graphprotocol/graph-cli/issues`);
-};
-
-const setupExitHandler = (exitHandler: (code: number) => void) =>
-  process.addListener('exit', exitHandler);
-
-const removeExitHandler = (exitHandler: (code: number) => void) =>
-  process.removeListener('exit', exitHandler);
-
-// Important note, the `asc.main` callback function parameter is synchronous,
-// that's why this function doesn't need to be `async` and the throw works properly.
-const assemblyScriptCompiler = (argv: string[], options: asc.APIOptions) =>
-  asc.main(argv, options, err => {
-    if (err) {
-      throw err;
-    }
-    return 0;
-  });
-
-const compilerDefaults = {
-  stdout: process.stdout,
-  stderr: process.stdout,
-};
-
-// You MUST call this function once before compiling anything.
-// Internally it just delegates to the AssemblyScript compiler
-// which just delegates to the binaryen lib.
-export const ready = async () => {
-  await asc.ready;
-};
-
-export interface CompileOptions {
-  inputFile: string;
-  global: string;
-  baseDir: string;
-  libs: string;
-  outputFile: string;
-}
-
-// For now this function doesn't check if `asc` is ready, because
-// it requires an asynchronous wait. Whenever you call this function,
-// it doesn't matter how many times, just make sure you call `ready`
-// once before everything..
-export const compile = ({ inputFile, global, baseDir, libs, outputFile }: CompileOptions) => {
-  const exitHandler = createExitHandler(inputFile);
-
-  setupExitHandler(exitHandler);
-
-  const compilerArgs = [
-    '--explicitStart',
-    '--exportRuntime',
-    '--runtime',
-    'stub',
-    inputFile,
-    global,
-    '--baseDir',
-    baseDir,
-    '--lib',
-    libs,
-    '--outFile',
-    outputFile,
-    '--optimize',
-    '--debug',
-  ];
-
-  assemblyScriptCompiler(compilerArgs, compilerDefaults);
-
-  // only if compiler succeded, that is, when the line above doesn't throw
-  removeExitHandler(exitHandler);
-};