Move tests outside src; fix compatibility check; add tests

Author: jdolle

packages/libraries/federation-link-utils/src/__tests__/linkable-spec.spec.ts

@@ -78,6 +78,33 @@ export class FederatedLinkUrl {
     return this.isCompatibleVersion(major, minor);
   }
 
+  isSupportedBy(version: string): boolean;
+  isSupportedBy(major: number, minor: number): boolean;
+  isSupportedBy(version: FederatedLinkUrl): boolean;
+  isSupportedBy(version: null): boolean;
+  isSupportedBy(...args: [string] | [number, number] | [FederatedLinkUrl] | [null]): boolean {
+    const majorOrVersion = args[0];
+    let major: number, minor: number;
+    if (typeof majorOrVersion === 'string') {
+      [major, minor] = parseVersion(majorOrVersion);
+    } else if (typeof majorOrVersion === 'number') {
+      [major, minor] = args as [number, number];
+    } else if (majorOrVersion instanceof FederatedLinkUrl) {
+      // check that it is the same spec
+      if (majorOrVersion.identity !== this.identity) {
+        return false;
+      }
+      major = majorOrVersion.major;
+      minor = majorOrVersion.minor;
+    } else if (majorOrVersion === null) {
+      // handles null case
+      return majorOrVersion === this.version;
+    } else {
+      throw new Error(`Unsupported version argument: ${JSON.stringify(args)} [${typeof args}].`);
+    }
+    return this.isSupportedByVersion(major, minor);
+  }
+
   private isCompatibleVersion(major: number, minor: number): boolean {
     if (this.major === major) {
       if (this.major === 0) {
@@ -87,4 +114,14 @@ export class FederatedLinkUrl {
     }
     return false;
   }
+
+  private isSupportedByVersion(major: number, minor: number): boolean {
+    if (this.major === major) {
+      if (this.major === 0) {
+        return this.minor === minor;
+      }
+      return this.minor <= minor;
+    }
+    return false;
+  }
 }

packages/libraries/federation-link-utils/src/link-url.ts

@@ -104,6 +104,15 @@ export class FederatedLink {
     return this.url.supports(...args);
   }
 
+  isSupportedBy(version: string): boolean;
+  isSupportedBy(major: number, minor: number): boolean;
+  isSupportedBy(version: FederatedLinkUrl): boolean;
+  isSupportedBy(version: null): boolean;
+  isSupportedBy(...args: [string] | [number, number] | [FederatedLinkUrl] | [null]): boolean {
+    /** @ts-expect-error: ignore tuple error. These are tuples and can be spread. tsc is wrong. */
+    return this.url.isSupportedBy(...args);
+  }
+
   /**
    * Given the name of an element in a linked schema, this returns the name of that element
    * as it has been imported. This accounts for aliasing and namespacing unreferenced imports.

packages/libraries/federation-link-utils/src/link.ts

@@ -48,12 +48,14 @@ export class LinkableSpec<T> {
   private detectLinkVersion(link: FederatedLink): string | null | undefined {
     // for every link, find the highest supported version
     if (link.identity === this.identity) {
+      // This should be flipped so that it finds the first version (ascending) of this spec that supports
+      // the link.
       return (
         this.sortedVersionKeys.find(minVersion =>
-          link.supports(minVersion.split[0], minVersion.split[1]),
+          link.isSupportedBy(minVersion.split[0], minVersion.split[1]),
         )?.key ||
         // check null last since Object.keys doesnt include symbols.
-        (link.supports(null) && this.versions[NULL_VERSION] ? null : undefined)
+        (link.isSupportedBy(null) && this.versions[NULL_VERSION] ? null : undefined)
       );
     }
     return undefined;
@@ -71,9 +73,9 @@ export class LinkableSpec<T> {
         const activeVersion = this.versions[version || NULL_VERSION];
         return activeVersion?.(maybeLink.resolveImportName.bind(maybeLink));
       }
-      console.warn(
-        `Cannot apply @link due to unsupported version found for "${this.identity}". ` +
-          `Available versions: ${this.sortedVersionKeys.map(v => `${v.split.join('.')}`).join(', ')} and any version these are compatible compatible with.`,
+      throw new Error(
+        `Cannot apply @link due to unsupported version found for "${maybeLink}". ` +
+          `Available versions: ${this.sortedVersionKeys.map(v => `${v.split.join('.')}`).join(', ')} and any version these are compatible compatible with. Try downgrading the link version to match these versions.`,
       );
     }
   }

packages/libraries/federation-link-utils/src/linkable-spec.ts

@@ -1,5 +1,5 @@
 import { DocumentNode, parse, StringValueNode, visit } from 'graphql';
-import { detectLinkedImplementations, FEDERATION_V1, LinkableSpec } from '../index';
+import { detectLinkedImplementations, FEDERATION_V1, LinkableSpec } from '../src/index';
 
 const metaSpec = new LinkableSpec('https://specs.graphql-hive.com/metadata', {
   [FEDERATION_V1]: _resolveImportName => (_typeDefs: DocumentNode) => {
@@ -76,7 +76,7 @@ test('LinkableSpec and detectLinkedImplementations can be used to apply linked s
   expect(linked.map(link => link(typeDefs))).toMatchInlineSnapshot(`
     [
       running on v0.1.
-    Found metadata: {"ping":{"name":"owner","content":"hive-console-team"},"pong":{"eg":"1...2...3... Pong"}}},
+    Found metadata: {"ping":{"name":"owner","content":"hive-console-team"},"pong":{"eg":"1...2...3... Pong"}},
     ]
   `);
 });

packages/libraries/federation-link-utils/src/__tests__/index.spec.ts renamed to packages/libraries/federation-link-utils/tests/index.spec.ts

@@ -1,4 +1,4 @@
-import { FederatedLinkUrl } from '../link-url';
+import { FederatedLinkUrl } from '../src/link-url';
 
 describe('FederatedLinkUrl', () => {
   test.each([

packages/libraries/federation-link-utils/src/__tests__/link-url.spec.ts renamed to packages/libraries/federation-link-utils/tests/link-url.spec.ts

@@ -1,5 +1,5 @@
 import { parse } from 'graphql';
-import { FederatedLink } from '../link';
+import { FederatedLink } from '../src/link';
 
 function trimMultiline(str: string): string {
   return str

packages/libraries/federation-link-utils/src/__tests__/link.spec.ts renamed to packages/libraries/federation-link-utils/tests/link.spec.ts

@@ -0,0 +1,67 @@
+import { parse } from 'graphql';
+import { FederatedLink } from '../src/link';
+import { LinkableSpec, NULL_VERSION } from '../src/linkable-spec';
+
+describe('LinkableSpec', () => {
+  const spec = new LinkableSpec('https://specs.graphql-hive.com/example', {
+    'v2.3': _resolveImportName => 'Version 2.3 used.',
+    'v1.0': _resolveImportName => 'Version 1.0 used.',
+    [NULL_VERSION]: _resolveImportName => 'null version used.',
+  });
+
+  describe('#detectImplementation', () => {
+    test('returns an exact version.', () => {
+      const sdl = `
+        extend schema
+          @link(url: "https://specs.graphql-hive.com/example/v1.0")
+      `;
+
+      const links = FederatedLink.fromTypedefs(parse(sdl));
+      const specImpl = spec.detectImplementation(links);
+      expect(specImpl).toBe('Version 1.0 used.');
+    });
+
+    test('returns a compatible version.', () => {
+      const sdl = `
+        extend schema
+          @link(url: "https://specs.graphql-hive.com/example/v2.1")
+      `;
+
+      const links = FederatedLink.fromTypedefs(parse(sdl));
+      const specImpl = spec.detectImplementation(links);
+      expect(specImpl).toBe('Version 2.3 used.');
+    });
+
+    test('throws when the identity is supported but the version is outside what the implementation supports.', () => {
+      const sdl = `
+        extend schema
+          @link(url: "https://specs.graphql-hive.com/example/v2.9")
+      `;
+
+      const links = FederatedLink.fromTypedefs(parse(sdl));
+      expect(() => spec.detectImplementation(links)).toThrow();
+    });
+
+    test('can return a null version.', () => {
+      const sdl = `
+        extend schema
+          @link(url: "https://specs.graphql-hive.com/example")
+      `;
+
+      const links = FederatedLink.fromTypedefs(parse(sdl));
+      const specImpl = spec.detectImplementation(links);
+      expect(specImpl).toBe('null version used.');
+    });
+
+    test('returns undefined when identities do not match.', () => {
+      const sdl = `
+        extend schema
+          @link(url: "https://specs.graphql-hive.com/not-example")
+      `;
+
+      const links = FederatedLink.fromTypedefs(parse(sdl));
+      const specImpl = spec.detectImplementation(links);
+      expect(specImpl).toBe(undefined);
+    });
+  });
+});