Merge pull request #1482 from polywrap/chore/separate-deploy-from-polywrap-project

chore: separate deploy from polywrap project

Author: dOrgJelli

packages/cli/src/__tests__/e2e/deploy.spec.ts

@@ -18,7 +18,8 @@ Deploys Polywrap Projects
 
 Options:
   -m, --manifest-file <path>  Path to the Polywrap Deploy manifest file
-                              (default: polywrap.yaml | polywrap.yml)
+                              (default: polywrap.deploy.yaml |
+                              polywrap.deploy.yml)
   -o, --output-file <path>    Output file path for the deploy result
   -v, --verbose               Verbose output (default: false)
   -q, --quiet                 Suppress output (default: false)

packages/cli/src/commands/deploy.ts

@@ -2,33 +2,25 @@
 import { Command, Program, BaseCommandOptions } from "./types";
 import { createLogger } from "./utils/createLogger";
 import {
-  defaultPolywrapManifest,
-  DeployPackage,
   intlMsg,
   parseManifestFileOption,
-  PolywrapProject,
-  DeployJob,
-  DeployStep,
   parseLogFileOption,
+  Deployer,
+  defaultDeployManifest,
 } from "../lib";
 
-import { DeployManifest } from "@polywrap/polywrap-manifest-types-js";
 import fs from "fs";
-import nodePath from "path";
+import path from "path";
 import yaml from "yaml";
-import { validate } from "jsonschema";
 
-const defaultManifestStr = defaultPolywrapManifest.join(" | ");
+const defaultManifestStr = defaultDeployManifest.join(" | ");
 const pathStr = intlMsg.commands_deploy_options_o_path();
 
 export interface DeployCommandOptions extends BaseCommandOptions {
   manifestFile: string;
   outputFile: string | false;
 }
 
-type ManifestJob = DeployManifest["jobs"][number];
-type ManifestStep = ManifestJob["steps"][number];
-
 export const deploy: Command = {
   setup: (program: Program) => {
     program
@@ -55,7 +47,7 @@ export const deploy: Command = {
         await run({
           manifestFile: parseManifestFileOption(
             options.manifestFile,
-            defaultPolywrapManifest
+            defaultDeployManifest
           ),
           outputFile: options.outputFile || false,
           verbose: options.verbose || false,
@@ -70,81 +62,11 @@ async function run(options: Required<DeployCommandOptions>): Promise<void> {
   const { manifestFile, outputFile, verbose, quiet, logFile } = options;
   const logger = createLogger({ verbose, quiet, logFile });
 
-  const project = new PolywrapProject({
-    rootDir: nodePath.dirname(manifestFile),
-    polywrapManifestPath: manifestFile,
-    logger,
-  });
-  await project.validate();
-
-  const deployManifest = await project.getDeployManifest();
-
-  if (!deployManifest) {
-    throw new Error("No deploy manifest found.");
-  }
-
-  const allStepsFromAllJobs = Object.entries(deployManifest.jobs).flatMap(
-    ([jobName, job]) => {
-      return job.steps.map((step) => ({
-        jobName,
-        ...step,
-      }));
-    }
-  );
-
-  const packageNames = [
-    ...new Set(allStepsFromAllJobs.map((step) => step.package)),
-  ];
-
-  sanitizePackages(packageNames);
-
-  await project.cacheDeployModules(packageNames);
-
-  const packageMapEntries = await Promise.all(
-    packageNames.map(async (packageName) => {
-      const deployerPackage = await project.getDeployModule(packageName);
-      return [packageName, deployerPackage];
-    })
-  );
-
-  const packageMap = Object.fromEntries(packageMapEntries);
-
-  const stepToPackageMap: Record<
-    string,
-    DeployPackage & { jobName: string }
-  > = {};
-
-  for (const step of allStepsFromAllJobs) {
-    stepToPackageMap[step.name] = {
-      ...packageMap[step.package],
-      jobName: step.jobName,
-    };
-  }
-
-  validateManifestWithExts(deployManifest, stepToPackageMap);
-
-  const jobs = Object.entries(deployManifest.jobs).map(([jobName, job]) => {
-    const steps: DeployStep[] = job.steps.map((step) => {
-      return new DeployStep({
-        name: step.name,
-        uriOrStepResult: step.uri,
-        deployer: stepToPackageMap[step.name].deployer,
-        config: step.config ?? {},
-      });
-    });
-
-    return new DeployJob({
-      name: jobName,
-      steps,
-      config: job.config ?? {},
-      logger,
-    });
-  });
-
-  const jobResults = await Promise.all(jobs.map((job) => job.run()));
+  const deployer = await Deployer.create(manifestFile, logger);
+  const jobResults = await deployer.run();
 
   if (outputFile) {
-    const outputFileExt = nodePath.extname(outputFile).substring(1);
+    const outputFileExt = path.extname(outputFile).substring(1);
     if (!outputFileExt) throw new Error("Require output file extension");
     switch (outputFileExt) {
       case "yaml":
@@ -164,61 +86,3 @@ async function run(options: Required<DeployCommandOptions>): Promise<void> {
   }
   process.exit(0);
 }
-
-function sanitizePackages(packages: string[]) {
-  const unrecognizedPackages: string[] = [];
-
-  const availableDeployers = fs.readdirSync(
-    nodePath.join(__dirname, "..", "lib", "defaults", "deploy-modules")
-  );
-
-  packages.forEach((p) => {
-    if (!availableDeployers.includes(p)) {
-      unrecognizedPackages.push(p);
-    }
-  });
-
-  if (unrecognizedPackages.length) {
-    throw new Error(
-      `Unrecognized packages: ${unrecognizedPackages.join(", ")}`
-    );
-  }
-}
-
-function validateManifestWithExts(
-  deployManifest: DeployManifest,
-  stepToPackageMap: Record<string, DeployPackage & { jobName: string }>
-) {
-  const errors = Object.entries(stepToPackageMap).flatMap(
-    ([stepName, step]) => {
-      const jobEntry = Object.entries(deployManifest.jobs).find(
-        ([jobName]) => jobName === step.jobName
-      ) as [string, ManifestJob];
-
-      const job = jobEntry[1];
-
-      const stepToValidate = job.steps.find(
-        (s) => s.name === stepName
-      ) as ManifestStep;
-
-      return step.manifestExt
-        ? validate(
-            {
-              ...job.config,
-              ...stepToValidate.config,
-            },
-            step.manifestExt
-          ).errors
-        : [];
-    }
-  );
-
-  if (errors.length) {
-    throw new Error(
-      [
-        `Validation errors encountered while sanitizing DeployManifest format ${deployManifest.format}`,
-        ...errors.map((error) => error.toString()),
-      ].join("\n")
-    );
-  }
-}

packages/cli/src/lib/defaults/deploy-modules/ens-recursive-name-register/index.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-require-imports */
 /* eslint-disable @typescript-eslint/no-var-requires */
-import { Deployer } from "../../../deploy";
+import { DeployModule } from "../../../deploy";
 
 import { Wallet } from "@ethersproject/wallet";
 import { JsonRpcProvider } from "@ethersproject/providers";
@@ -13,7 +13,7 @@ import {
 import { embeddedWrappers } from "@polywrap/test-env-js";
 import { PolywrapClient } from "@polywrap/client-js";
 
-class ENSRecursiveNameRegisterPublisher implements Deployer {
+class ENSRecursiveNameRegisterPublisher implements DeployModule {
   async execute(
     uri: Uri,
     config: {

packages/cli/src/lib/defaults/deploy-modules/ens/index.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-require-imports */
 /* eslint-disable @typescript-eslint/no-var-requires */
-import { Deployer } from "../../../deploy";
+import { DeployModule } from "../../../deploy";
 
 import { Wallet } from "@ethersproject/wallet";
 import { JsonRpcProvider } from "@ethersproject/providers";
@@ -15,7 +15,7 @@ import { PolywrapClient } from "@polywrap/client-js";
 
 const contentHash = require("content-hash");
 
-class ENSPublisher implements Deployer {
+class ENSPublisher implements DeployModule {
   async execute(
     uri: Uri,
     config: {

packages/cli/src/lib/defaults/deploy-modules/http/index.ts

@@ -1,4 +1,4 @@
-import { Deployer } from "../../../deploy/deployer";
+import { DeployModule } from "../../../deploy";
 
 import { Uri } from "@polywrap/core-js";
 import FormData from "form-data";
@@ -33,7 +33,7 @@ const dirToFormData = (baseDirPath: string) => {
   return formData;
 };
 
-class HTTPDeployer implements Deployer {
+class HTTPDeployer implements DeployModule {
   async execute(uri: Uri, config?: { postUrl: string }): Promise<Uri> {
     if (!isValidUri(uri)) {
       throw new Error(

packages/cli/src/lib/defaults/deploy-modules/ipfs-test/index.ts

@@ -1,8 +1,8 @@
-import { Deployer } from "../../../deploy/deployer";
+import { DeployModule } from "../../../deploy";
 
 import { Uri } from "@polywrap/core-js";
 
-class IPFSDeployer implements Deployer {
+class IPFSDeployer implements DeployModule {
   // eslint-disable-next-line @typescript-eslint/naming-convention
   async execute(_: Uri, __: unknown): Promise<Uri> {
     return new Uri(`ipfs/Qm`);

packages/cli/src/lib/defaults/deploy-modules/ipfs/index.ts

@@ -1,4 +1,4 @@
-import { Deployer } from "../../../deploy/deployer";
+import { DeployModule } from "../../../deploy";
 
 import { Uri } from "@polywrap/core-js";
 
@@ -8,7 +8,7 @@ const { globSource } = IPFSClient;
 
 const isValidUri = (uri: Uri) => uri.authority === "fs";
 
-class IPFSDeployer implements Deployer {
+class IPFSDeployer implements DeployModule {
   async execute(uri: Uri, config?: { gatewayUri: string }): Promise<Uri> {
     if (!isValidUri(uri)) {
       throw new Error(

packages/cli/src/lib/defaults/infra-modules/http/server/package.json

@@ -19,7 +19,8 @@
     "file-saver": "2.0.5",
     "jszip": "3.10.1",
     "fs-extra": "7.0.1",
-    "multer": "1.4.5-lts.1"
+    "multer": "1.4.5-lts.1",
+    "sanitize-filename": "1.6.3"
   },
   "devDependencies": {
     "@types/express": "4.17.13",

packages/cli/src/lib/defaults/infra-modules/http/server/src/utils/zip.ts

@@ -1,5 +1,7 @@
 import JSZip from "jszip";
+import sanitize from "sanitize-filename";
 import fse from "fs-extra";
+import path from "path";
 
 export class Zip {
   private _zip: JSZip;
@@ -8,7 +10,7 @@ export class Zip {
     this._zip = new JSZip();
   }
 
-  private generateNodeZip(filePath: string) {
+  private _generateNodeZip(filePath: string) {
     return new Promise<boolean>((res, rej) => {
       this._zip.generateNodeStream({ type: 'nodebuffer', streamFiles: true })
           .pipe(fse.createWriteStream(filePath))
@@ -25,6 +27,6 @@ export class Zip {
     fse.readdirSync(sourceDir).forEach(file => {
       this._zip.file(file, fse.readFileSync(`${sourceDir}/${file}`))
     })
-    return this.generateNodeZip(outputPath);
+    return this._generateNodeZip(outputPath);
   }
 }

packages/cli/src/lib/deploy/job.ts packages/cli/src/lib/deploy/DeployJob.tspackages/cli/src/lib/deploy/job.ts renamed to packages/cli/src/lib/deploy/DeployJob.ts

@@ -1,4 +1,9 @@
-import { DeployStep, StepName, StepResult, UriOrPrevStepResult } from "./step";
+import {
+  DeployStep,
+  StepName,
+  StepResult,
+  UriOrPrevStepResult,
+} from "./DeployStep";
 import { Logger } from "../logging";
 
 import { Uri } from "@polywrap/core-js";