remove well known worlds and simplify package configuration

Signed-off-by: karthik2804 <[email protected]>

Author: karthik2804

package-lock.json

@@ -1,4 +1,4 @@
-import { getPackagesWithWasiDeps, processWasiDeps, processWellKnownWorlds } from "../../dist/wasiDepsParser.js";
+import { getPackagesWithWasiDeps, processWasiDeps } from "../../dist/wasiDepsParser.js";
 class SpinSdkPlugin {
     constructor() {
         this.externals = {};
@@ -9,14 +9,7 @@ class SpinSdkPlugin {
         let plugin = new SpinSdkPlugin();
 
         let wasiDeps = getPackagesWithWasiDeps(process.cwd(), new Set(), true);
-        let { witPaths, targetWorlds, wellKnownWorlds } = processWasiDeps(wasiDeps)
-        let { witPaths: wellKnownWitPaths, targetWorlds: wellKnownTargetWorlds } = await processWellKnownWorlds(wellKnownWorlds);
-        wellKnownWitPaths.forEach((path) => {
-            witPaths.push(path)
-        })
-        wellKnownTargetWorlds.forEach((target) => {
-            targetWorlds.push(target)
-        })
+        let { witPaths, targetWorlds } = processWasiDeps(wasiDeps)
 
         let imports = getWitImports(witPaths, targetWorlds);
 

packages/build-tools/plugins/webpack/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import { componentize } from "@bytecodealliance/componentize-js";
-import { getPackagesWithWasiDeps, processWasiDeps, processWellKnownWorlds } from "./wasiDepsParser.js";
+import { getPackagesWithWasiDeps, processWasiDeps } from "./wasiDepsParser.js";
 import { basename } from 'node:path';
 
 import { calculateChecksum, getPackageVersion, saveBuildData } from "./utils.js";
@@ -30,17 +30,10 @@ async function main() {
     // generate wit world string
     let wasiDeps = getPackagesWithWasiDeps(process.cwd(), new Set(), true);
 
-    let { witPaths, targetWorlds, wellKnownWorlds } = processWasiDeps(wasiDeps)
-    let { witPaths: wellKnownWitPaths, targetWorlds: wellKnownTargetWorlds } = await processWellKnownWorlds(wellKnownWorlds);
-    wellKnownWitPaths.forEach((path) => {
-      witPaths.push(path)
-    })
-    wellKnownTargetWorlds.forEach((target) => {
-      targetWorlds.push(target)
-    })
+    let { witPaths, targetWorlds } = processWasiDeps(wasiDeps);
 
     // Get inline wit by merging the wits specified by all the dependencies
-    let inlineWit = mergeWit(witPaths, targetWorlds, "combined", "combined-wit:[email protected]")
+    let inlineWit = mergeWit(witPaths, targetWorlds, "combined", "combined-wit:[email protected]");
 
     const source = await readFile(src, 'utf8');
 

packages/build-tools/src/index.ts

@@ -1,23 +1,16 @@
 import fs from "fs";
 import { TargetWorld } from "../lib/wit_tools.js";
 import path from "path";
-import { setupWellKnownWits } from "./wellKnownWits.js"
 
 
 // Define the structure of a package.json file
 // Includes dependencies and an optional config section for 'knitwit'
 type PackageJson = {
     name: string,
     dependencies?: Record<string, string>;
-    devDependencies?: Record<string, string>;
-    peerDependencies?: Record<string, string>;
-    optionalDependencies?: Record<string, string>;
     config?: {
-        wasiDep?: {
-            witDeps?: witDep[];
-            wellKnownWorlds?: string[];
-        };
-    };
+        witDeps?: witDep[];
+    }
 };
 
 type witDep = {
@@ -30,11 +23,8 @@ type witDep = {
 type DependencyResult = {
     name: string;
     config: {
-        wasiDep: {
-            witDeps?: witDep[];
-            wellKnownWorlds?: string[];
-        }
-    };
+        witDeps?: witDep[];
+    }
 }[];
 
 // Reads and parses a package.json file
@@ -68,8 +58,8 @@ export function resolveDependencyPath(
 
 // Converts the 'witPath' inside the config section to an absolute path if it is relative
 function absolutizeWitPath(depPackageJsonPath: string, depPackageJson: PackageJson): void {
-    if (depPackageJson.config?.wasiDep?.witDeps) {
-        depPackageJson.config.wasiDep.witDeps.forEach((witDep) => {
+    if (depPackageJson.config?.witDeps) {
+        depPackageJson.config.witDeps.forEach((witDep) => {
             if (!path.isAbsolute(witDep.witPath)) {
                 witDep.witPath = path.resolve(depPackageJsonPath, witDep.witPath);
             }
@@ -96,19 +86,16 @@ export function getPackagesWithWasiDeps(
     const result: DependencyResult = [];
 
     if (topLevel) {
-        if (packageJson.config?.wasiDep) {
-            if (packageJson.config.wasiDep.witDeps || packageJson.config.wasiDep.wellKnownWorlds) {
-                if (packageJson.config.wasiDep.witDeps) {
+        if (packageJson.config?.witDeps) {
+            if (packageJson.config.witDeps) {
+                if (packageJson.config.witDeps) {
                     absolutizeWitPath(dir, packageJson);
                 }
 
                 result.push({
                     name: packageJson.name,
                     config: {
-                        wasiDep: {
-                            ...(packageJson.config.wasiDep.witDeps && { witDeps: packageJson.config.wasiDep.witDeps }),
-                            ...(packageJson.config.wasiDep.wellKnownWorlds && { wellKnownWorlds: packageJson.config.wasiDep.wellKnownWorlds }),
-                        }
+                        witDeps: packageJson.config.witDeps
                     }
                 });
             }
@@ -129,14 +116,12 @@ export function getPackagesWithWasiDeps(
             absolutizeWitPath(depPath, depPackageJson);
 
             // If the package has a 'knitwit' config, add it to the result
-            if (depPackageJson.config?.wasiDep) {
+            if (depPackageJson.config?.witDeps) {
                 result.push({
                     name: dep,
                     config: {
-                        wasiDep: {
-                            witDeps: depPackageJson.config.wasiDep.witDeps ?? undefined,
-                            wellKnownWorlds: depPackageJson.config.wasiDep.wellKnownWorlds ?? undefined,
-                        }
+                        witDeps:
+                            depPackageJson.config.witDeps ?? [],
                     }
                 });
             }
@@ -153,32 +138,15 @@ export function getPackagesWithWasiDeps(
 export function processWasiDeps(wasiDeps: DependencyResult) {
     let witPaths: string[] = [];
     let targetWorlds: TargetWorld[] = [];
-    let wellKnownWorlds: string[] = [];
 
     wasiDeps.forEach((dep) => {
-        if (dep.config?.wasiDep?.witDeps) {
-            dep.config.wasiDep.witDeps.forEach((witDep) => {
+        if (dep.config?.witDeps) {
+            dep.config.witDeps.forEach((witDep) => {
                 witPaths.push(witDep.witPath!);
-                targetWorlds.push({ packageName: witDep.package, worldName: witDep.world });
+                targetWorlds.push({ packageName: witDep.package, worldName: witDep.world })
             });
         }
-        if (dep.config?.wasiDep?.wellKnownWorlds) {
-            wellKnownWorlds.push(...dep.config.wasiDep.wellKnownWorlds);
-        }
     });
 
-    return { witPaths, targetWorlds, wellKnownWorlds };
-}
-
-export async function processWellKnownWorlds(wellKnownWorlds: string[]) {
-    let witPaths: string[] = [];
-    let targetWorlds: TargetWorld[] = [];
-
-    for (let wellKnownWorld of wellKnownWorlds) {
-        let { withPath, targetWorld } = await setupWellKnownWits(wellKnownWorld);
-        witPaths.push(withPath);
-        targetWorlds.push(targetWorld);
-    }
-
     return { witPaths, targetWorlds };
 }

packages/build-tools/src/wasiDepsParser.ts

@@ -1,5 +1,5 @@
 import fs from "fs";
-import { getPackagesWithWasiDeps, processWasiDeps, processWellKnownWorlds, readPackageJson, resolveDependencyPath } from "../dist/wasiDepsParser.js";
+import { getPackagesWithWasiDeps, processWasiDeps, readPackageJson, resolveDependencyPath } from "../dist/wasiDepsParser.js";
 import { expect } from "chai";
 import sinon from "sinon";
 
@@ -64,10 +64,7 @@ describe("getPackagesWithWasiDeps", () => {
         const packageJson = {
             name: "test-package",
             config: {
-                wasiDep: {
-                    witDeps: [{ witPath: "./test.wit", package: "test-pkg", world: "test-world" }],
-                    wellKnownWorlds: ["world-1"]
-                }
+                witDeps: [{ witPath: "./test.wit", package: "test-pkg", world: "test-world" }],
             }
         };
         existsSyncStub.returns(true);
@@ -76,11 +73,7 @@ describe("getPackagesWithWasiDeps", () => {
             {
                 name: "test-package",
                 config: {
-                    wasiDep: {
-                        // WitPath is resolved to an absolute path
-                        wellKnownWorlds: ["world-1"],
-                        witDeps: [{ witPath: "/project/test.wit", package: "test-pkg", world: "test-world" }]
-                    }
+                    witDeps: [{ witPath: "/project/test.wit", package: "test-pkg", world: "test-world" }]
                 }
             }
         ]);
@@ -93,31 +86,17 @@ describe("processWasiDeps", () => {
             {
                 name: "test-package",
                 config: {
-                    wasiDep: {
-                        witDeps: [{ witPath: "./test.wit", package: "test-pkg", world: "test-world" }],
-                        wellKnownWorlds: ["world-1"]
-                    }
+                    witDeps: [{ witPath: "./test.wit", package: "test-pkg", world: "test-world" }],
                 }
             }
         ];
         expect(processWasiDeps(wasiDeps)).to.deep.equal({
             witPaths: ["./test.wit"],
             targetWorlds: [{ packageName: "test-pkg", worldName: "test-world" }],
-            wellKnownWorlds: ["world-1"]
         });
     });
 });
 
-describe("processWellKnownWorlds", () => {
-
-    it("should call setupWellKnownWits for each world", async () => {
-        const result = await processWellKnownWorlds(["[email protected]"]);
-        // get absolutized directory path from setupWellKnownWits module
-        let absolutePath = path.resolve(__dirname, '../dist/');
-        expect(result).to.deep.equal({ witPaths: [path.resolve(absolutePath, "../well-known-wits/[email protected]")], targetWorlds: [{ packageName: "spinframework:[email protected]", worldName: "http-trigger" }] });
-    });
-});
-
 describe("getPackagesWithWasiDeps (recursive)", () => {
     let existsSyncStub, readFileSyncStub;
 
@@ -138,9 +117,7 @@ describe("getPackagesWithWasiDeps (recursive)", () => {
                 "package-2": "^1.0.0"
             },
             config: {
-                wasiDep: {
-                    witDeps: [{ witPath: "./test1.wit", package: "test-pkg-1", world: "world-1" }],
-                }
+                witDeps: [{ witPath: "./test1.wit", package: "test-pkg-1", world: "world-1" }],
             }
         };
 
@@ -153,9 +130,7 @@ describe("getPackagesWithWasiDeps (recursive)", () => {
                 "package-4": "^1.0.0"
             },
             config: {
-                wasiDep: {
-                    witDeps: [{ witPath: "./test2.wit", package: "test-pkg-2", world: "world-2" }],
-                }
+                witDeps: [{ witPath: "./test2.wit", package: "test-pkg-2", world: "world-2" }],
             }
         };
 
@@ -166,27 +141,21 @@ describe("getPackagesWithWasiDeps (recursive)", () => {
                 "package-5": "^1.0.0"
             },
             config: {
-                wasiDep: {
-                    witDeps: [{ witPath: "./test3.wit", package: "test-pkg-3", world: "world-3" }],
-                }
+                witDeps: [{ witPath: "./test3.wit", package: "test-pkg-3", world: "world-3" }],
             }
         };
 
         const packageJson4 = {
             name: "package-4",
             config: {
-                wasiDep: {
-                    witDeps: [{ witPath: "./test4.wit", package: "test-pkg-4", world: "world-4" }],
-                }
+                witDeps: [{ witPath: "./test4.wit", package: "test-pkg-4", world: "world-4" }],
             }
         };
 
         const packageJson5 = {
             name: "package-5",
             config: {
-                wasiDep: {
-                    witDeps: [{ witPath: "./test5.wit", package: "test-pkg-5", world: "world-5" }],
-                }
+                witDeps: [{ witPath: "./test5.wit", package: "test-pkg-5", world: "world-5" }],
             }
         };
 
@@ -214,15 +183,11 @@ describe("getPackagesWithWasiDeps (recursive)", () => {
         let visited: Set<string> = new Set()
         let result = getPackagesWithWasiDeps("/project", visited, true);
 
-        let { witPaths, targetWorlds, wellKnownWorlds } = processWasiDeps(result);
-        let { witPaths: wellKnownWitPaths, targetWorlds: wellKnownTargetWorlds } = await processWellKnownWorlds(wellKnownWorlds);
-        wellKnownWitPaths.forEach((witPath) => witPaths.push(witPath));
-        wellKnownTargetWorlds.forEach((targetWorld) => targetWorlds.push(targetWorld));
+        let { witPaths, targetWorlds } = processWasiDeps(result);
 
 
         expect(witPaths.length).to.equal(5);
         expect(targetWorlds.length).to.equal(5);
-        expect(wellKnownWitPaths.length).to.equal(0);
         expect(witPaths).to.deep.equal([
             "/project/test1.wit",
             "/project/node_modules/package-2/test2.wit",