Merge pull request #42 from polywrap/nk/recursive-resolver-test

feat: add infinite loop error test for recursive resolver

Author: dOrgJelli

packages/uri-resolvers/src/__tests__/recursive-resolver/histories/infinite-loop.json

@@ -0,0 +1,5 @@
+[
+  "wrap://test/1 => InfiniteRedirectResolver => uri (wrap://test/2)",
+  "wrap://test/2 => InfiniteRedirectResolver => uri (wrap://test/3)",
+  "wrap://test/3 => InfiniteRedirectResolver => uri (wrap://test/1)"
+]

packages/uri-resolvers/src/__tests__/recursive-resolver/recursive-resolver.spec.ts

@@ -46,6 +46,38 @@ class SimpleRedirectResolver implements IUriResolver<Error> {
   }
 }
 
+class InfiniteRedirectResolver implements IUriResolver<Error> {
+  async tryResolveUri(
+    uri: Uri,
+    client: CoreClient,
+    resolutionContext: IUriResolutionContext
+  ): Promise<Result<UriPackageOrWrapper, Error>> {
+    let result: Result<UriPackageOrWrapper, Error>;
+
+    switch (uri.uri) {
+      case "wrap://test/1":
+        result = UriResolutionResult.ok(Uri.from("test/2"));
+        break;
+      case "wrap://test/2":
+        result = UriResolutionResult.ok(Uri.from("test/3"));
+        break;
+      case "wrap://test/3":
+        result = UriResolutionResult.ok(Uri.from("test/1"));
+        break;
+      default:
+        result = UriResolutionResult.ok(uri);
+    }
+
+    resolutionContext.trackStep({
+      sourceUri: uri,
+      result,
+      description: "InfiniteRedirectResolver",
+    });
+
+    return result;
+  }
+}
+
 describe("RecursiveResolver", () => {
   it("can recursively resolve a URI", async () => {
     const uri = new Uri("test/1");
@@ -100,4 +132,28 @@ describe("RecursiveResolver", () => {
 
     expect(result.value.uri.uri).toEqual("wrap://test/not-a-match");
   });
+
+  it("should raise an error if infinite loop detected during URI Resolution", async () => {
+    const uri = new Uri("test/1");
+
+    const client = new PolywrapCoreClient({
+      resolver: RecursiveResolver.from(new InfiniteRedirectResolver()),
+    });
+
+    let resolutionContext = new UriResolutionContext();
+    let result = await client.tryResolveUri({ uri, resolutionContext });
+
+    await expectHistory(
+      resolutionContext.getHistory(),
+      "recursive-resolver",
+      "infinite-loop"
+    );
+
+    if (result.ok) {
+      fail(`Expected an error got value: ${result.value}`);
+    }
+
+    // @ts-ignore
+    expect(result.error!.message).toMatch("An infinite loop was detected while resolving the URI: wrap://test/1");
+  })
 });