Merge pull request #1851 from polywrap/origin-0.11-dev

Prep Origin 0.11.1 | /workflows/release-pr

Author: dOrgJelli

CHANGELOG.md

@@ -1,3 +1,9 @@
+# Polywrap Origin (0.11.1)
+## Bugs
+**`polywrap` CLI:**
+* [PR-1847](https://github.com/polywrap/cli/pull/1847) **Fix IPFS deployer subdirectory duplication issue**
+  * Fixed the IPFS deployer subdirectory issue described in IPFS Deployer possibly duplicates subdirectory paths when deploying (https://github.com/polywrap/cli/issues/1846)
+
 # Polywrap Origin (0.11.0)
 ## Features
 **`polywrap` CLI:**

VERSION

@@ -1 +1 @@
-0.11.0
+0.11.1

packages/cli/src/__tests__/unit/ipfs-deployer.spec.ts

@@ -0,0 +1,33 @@
+import { GetPathToCliTestFiles } from "@polywrap/test-cases";
+import { readDirContents } from "../../lib/defaults/deploy-modules/ipfs/utils";
+import path from "path";
+
+describe("IPFS Deployer", () => {
+  const sampleBuildDir = path.join(
+    GetPathToCliTestFiles(),
+    "lib",
+    "deployers",
+    "mock-build-output"
+  );
+
+  it("properly reads build dir contents and builds out an IPFS-compatible directory entry", async () => {
+    const dirents = await readDirContents(sampleBuildDir, "");
+
+    expect(dirents).toMatchObject({
+      name: "",
+      files: [{ name: "wrap.info" }, { name: "wrap.wasm" }],
+      directories: [
+        {
+          name: "docs",
+          files: [{ name: "polywrap.docs.json" }],
+          directories: [
+            {
+              name: "pages",
+              files: [{ name: "readme.md" }],
+            },
+          ],
+        },
+      ],
+    });
+  });
+});

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

@@ -1,74 +1,15 @@
 import { DeployModule } from "../../../deploy";
+import { AddResult, ArgsAddDir, DirectoryEntry } from "./types";
+import { readDirContents } from "./utils";
 
 import { Uri } from "@polywrap/core-js";
 import { PolywrapClient } from "@polywrap/client-js";
 import * as Sys from "@polywrap/sys-config-bundle-js";
 import { PolywrapClientConfigBuilder } from "@polywrap/client-config-builder-js";
-import fs from "fs";
 
 const isValidUri = (uri: Uri) =>
   uri.authority === "fs" || uri.authority === "file";
 
-interface FileEntry {
-  name: string;
-  data: Uint8Array;
-}
-
-interface DirectoryEntry {
-  name: string;
-  directories?: DirectoryEntry[];
-  files?: FileEntry[];
-}
-
-interface AddOptions {
-  pin?: boolean;
-  onlyHash?: boolean;
-  wrapWithDirectory?: boolean;
-}
-
-interface AddResult {
-  name: string;
-  hash: string;
-  size: string;
-}
-
-interface ArgsAddDir {
-  data: DirectoryEntry;
-  ipfsProvider: string;
-  timeout?: number;
-  addOptions?: AddOptions;
-}
-
-const readDirContents = async (
-  path: string,
-  dirName: string
-): Promise<DirectoryEntry> => {
-  const dirents: fs.Dirent[] = await fs.promises.readdir(path, {
-    withFileTypes: true,
-  });
-  const data: DirectoryEntry = { name: dirName };
-
-  for (const dirent of dirents) {
-    if (dirent.isDirectory()) {
-      const subDir = await readDirContents(
-        `${path}/${dirent.name}`,
-        `${dirName}/${dirent.name}`
-      );
-      data.directories = data.directories ?? [];
-      data.directories?.push(subDir);
-    } else {
-      const fileData = await fs.promises.readFile(`${path}/${dirent.name}`);
-      data.files = data.files ?? [];
-      data.files?.push({
-        name: dirent.name,
-        data: fileData,
-      });
-    }
-  }
-
-  return data;
-};
-
 class IPFSDeployer implements DeployModule {
   async execute(uri: Uri, config?: { gatewayUri: string }): Promise<Uri> {
     if (!isValidUri(uri)) {

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

@@ -0,0 +1,29 @@
+export interface FileEntry {
+  name: string;
+  data: Uint8Array;
+}
+
+export interface DirectoryEntry {
+  name: string;
+  directories?: DirectoryEntry[];
+  files?: FileEntry[];
+}
+
+export interface AddOptions {
+  pin?: boolean;
+  onlyHash?: boolean;
+  wrapWithDirectory?: boolean;
+}
+
+export interface AddResult {
+  name: string;
+  hash: string;
+  size: string;
+}
+
+export interface ArgsAddDir {
+  data: DirectoryEntry;
+  ipfsProvider: string;
+  timeout?: number;
+  addOptions?: AddOptions;
+}

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

@@ -0,0 +1,33 @@
+import { DirectoryEntry } from "./types";
+
+import fs from "fs";
+
+export const readDirContents = async (
+  path: string,
+  dirName: string
+): Promise<DirectoryEntry> => {
+  const dirents: fs.Dirent[] = await fs.promises.readdir(path, {
+    withFileTypes: true,
+  });
+  const data: DirectoryEntry = { name: dirName };
+
+  for (const dirent of dirents) {
+    if (dirent.isDirectory()) {
+      const subDir = await readDirContents(
+        `${path}/${dirent.name}`,
+        `${dirent.name}`
+      );
+      data.directories = data.directories ?? [];
+      data.directories?.push(subDir);
+    } else {
+      const fileData = await fs.promises.readFile(`${path}/${dirent.name}`);
+      data.files = data.files ?? [];
+      data.files?.push({
+        name: dirent.name,
+        data: fileData,
+      });
+    }
+  }
+
+  return data;
+};