Merge pull request #32 from wayfair-incubator/mk228f_revert-fix-no-partial-shareable-types

Author: Maheswari6

CHANGELOG.md

@@ -6,13 +6,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [v3.2.3] - 2025-09-29
-
-### Fix
-
-- The `FroidSchema` class does not include all shareable value type fields found
-  across subgraphs.
-
 ## [v3.2.2] - 2024-08-20
 
 ### Fixed

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wayfair/node-froid",
-  "version": "3.2.3",
+  "version": "3.2.4",
   "description": "Federated GQL Relay Object Identification implementation",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/schema/FroidSchema.ts

@@ -20,7 +20,6 @@ import {ObjectTypeNode} from './types';
 import {
   CONTRACT_DIRECTIVE_NAME,
   DEFAULT_FEDERATION_LINK_IMPORTS,
-  Directive,
   DirectiveName,
   FED2_OPT_IN_URL,
   FED2_VERSION_PREFIX,
@@ -185,15 +184,10 @@ export class FroidSchema {
     this.generateFroidDependencies();
 
     // build schema
-    const imports = [...DEFAULT_FEDERATION_LINK_IMPORTS];
-    if (this.hasShareableTypes()) {
-      imports.push(Directive.Shareable);
-    }
-
     this.froidAst = sortDocumentAst({
       kind: Kind.DOCUMENT,
       definitions: [
-        this.createLinkSchemaExtension(imports),
+        this.createLinkSchemaExtension(),
         this.createQueryDefinition(),
         this.createNodeInterface(),
         ...this.createCustomReturnTypes(),
@@ -248,14 +242,7 @@ export class FroidSchema {
         )
       );
 
-      const isShareableValueType = node.directives?.some(
-        (directive) => directive.name.value === DirectiveName.Shareable
-      );
-
-      if (
-        isException ||
-        (!FroidSchema.isEntity(node) && !isShareableValueType)
-      ) {
+      if (isException || !FroidSchema.isEntity(node)) {
         return;
       }
 
@@ -875,15 +862,4 @@ export class FroidSchema {
   private static parseSchema(schema: string): DocumentNode {
     return parse(schema, {noLocation: true});
   }
-
-  /**
-   * Checks if there are any shareable types in the FROID object types.
-   *
-   * @returns {boolean} True if there are shareable types, false otherwise.
-   */
-  private hasShareableTypes(): boolean {
-    return Object.values(this.froidObjectTypes).some(
-      (objectType) => objectType.isShareable
-    );
-  }
 }

src/schema/ObjectType.ts

@@ -10,7 +10,7 @@ import {DirectiveName, EXTERNAL_DIRECTIVE_AST} from './constants';
 import {ObjectTypeNode} from './types';
 import {FroidSchema, KeySorter, NodeQualifier} from './FroidSchema';
 import {KeyField} from './KeyField';
-import {implementsNodeInterface, shareableDirective} from './astDefinitions';
+import {implementsNodeInterface} from './astDefinitions';
 
 const FINAL_KEY_MAX_DEPTH = 100;
 
@@ -360,20 +360,6 @@ export class ObjectType {
     return this.getFinalKey();
   }
 
-  /**
-   * Checks if the type is shareable by looking for @shareable directive
-   * on any of its occurrences across subgraphs.
-   *
-   * @returns {boolean} True if any occurrence has the @shareable directive
-   */
-  public get isShareable(): boolean {
-    return this.occurrences.some((occurrence) =>
-      occurrence.directives?.some(
-        (directive) => directive.name.value === DirectiveName.Shareable
-      )
-    );
-  }
-
   /**
    * Generates the final key for the node based on all descendant types and their keys (if they have keys).
    *
@@ -526,22 +512,10 @@ export class ObjectType {
    * @returns {FieldDefinitionNode[]} The final fields
    */
   private getFinalFields(finalKey: Key | undefined): FieldDefinitionNode[] {
-    // If the type is shareable, include all fields from the supergraph
-    if (this.isShareable) {
-      return this.allFields.map((field) => ({
-        ...field,
-        description: undefined,
-        directives: [],
-      }));
-    }
-
-    const shareableFields = this.getShareableFields();
-    // Original behavior for non-shareable types, plus shareable fields
     const fieldsList = [
       ...new Set([
         ...(finalKey?.fieldsList || []),
         ...this._externallySelectedFields,
-        ...shareableFields.map((field) => field.name.value),
       ]),
     ];
     const fields = fieldsList
@@ -564,32 +538,6 @@ export class ObjectType {
     return fields;
   }
 
-  /**
-   * Gets all fields that have @shareable directive across all occurrences.
-   *
-   * @returns {FieldDefinitionNode[]} Fields with @shareable directive
-   */
-  private getShareableFields(): FieldDefinitionNode[] {
-    const shareableFields: FieldDefinitionNode[] = [];
-
-    this.occurrences.forEach((occurrence) => {
-      occurrence?.fields?.forEach((field) => {
-        const hasShareableDirective = field.directives?.some(
-          (directive) => directive.name.value === DirectiveName.Shareable
-        );
-
-        if (hasShareableDirective) {
-          // Only add if we haven't already added this field
-          if (!shareableFields.some((f) => f.name.value === field.name.value)) {
-            shareableFields.push(field);
-          }
-        }
-      });
-    });
-
-    return shareableFields;
-  }
-
   /**
    * Get contract @tag directives for an ID field. Returns all occurrences of unique @tag
    * directives used across all fields included in the node's @key directive
@@ -670,16 +618,11 @@ export class ObjectType {
     }
 
     const fields = [...froidFields, ...this.getFinalFields(finalKey)];
-    const directives = [
-      ...(finalKeyDirective ? [finalKeyDirective] : []),
-      ...(this.isShareable ? [shareableDirective] : []),
-    ];
-
     return {
       ...this.node,
       description: undefined,
       interfaces: froidInterfaces,
-      directives,
+      directives: [...(finalKeyDirective ? [finalKeyDirective] : [])],
       fields,
     };
   }

src/schema/__tests__/FroidSchema.test.ts

@@ -1347,143 +1347,6 @@ describe('FroidSchema class', () => {
     );
   });
 
-  it('applies the @shareable directive to types marked with @shareable and includes all fields from supergraph', () => {
-    const bookSchema = gql`
-      type Book @key(fields: "isbn") {
-        isbn: String!
-        title: String!
-        author: Author!
-      }
-
-      type Author @shareable {
-        authorId: Int!
-      }
-    `;
-
-    const authorSchema = gql`
-      type Author @shareable {
-        authorId: Int!
-        name: String!
-        email: String!
-        age: Int
-      }
-    `;
-
-    const subgraphs = new Map();
-    subgraphs.set('book-subgraph', bookSchema);
-    subgraphs.set('author-subgraph', authorSchema);
-
-    const actual = generateSchema({
-      subgraphs,
-      froidSubgraphName: 'relay-subgraph',
-      contractTags: ['storefront', 'internal'],
-      federationVersion: FED2_DEFAULT_VERSION,
-    });
-
-    expect(actual).toEqual(
-      // prettier-ignore
-      gql`
-        extend schema @link(url: "https://specs.apollo.dev/federation/v2.0", import: ["@key", "@tag", "@external", "@shareable"])
-
-        type Author @shareable {
-          age: Int
-          authorId: Int!
-          email: String!
-          name: String!
-        }
-
-        type Book implements Node @key(fields: "isbn") {
-          "The globally unique identifier."
-          id: ID!
-          isbn: String!
-        }
-
-        "The global identification interface implemented by all entities."
-        interface Node @tag(name: "internal") @tag(name: "storefront") {
-          "The globally unique identifier."
-          id: ID!
-        }
-
-        type Query {
-          "Fetches an entity by its globally unique identifier."
-          node(
-            "A globally unique entity identifier."
-            id: ID!
-          ): Node @tag(name: "internal") @tag(name: "storefront")
-        }
-      `
-    );
-  });
-
-  it('applies the @external directive to fields marked with @shareable and includes them in froid schema', () => {
-    const bookSchema = gql`
-      type Book @key(fields: "isbn") {
-        isbn: String!
-        title: String!
-        edition: Edition
-      }
-
-      type Edition @key(fields: "isbn") {
-        isbn: String!
-        publicationYear: Int @shareable
-      }
-    `;
-
-    const editionsSchema = gql`
-      type Edition @key(fields: "isbn") {
-        isbn: String!
-        format: String!
-        pageCount: Int!
-        publicationYear: Int @shareable
-      }
-    `;
-
-    const subgraphs = new Map();
-    subgraphs.set('book-subgraph', bookSchema);
-    subgraphs.set('editions-subgraph', editionsSchema);
-
-    const actual = generateSchema({
-      subgraphs,
-      froidSubgraphName: 'relay-subgraph',
-      contractTags: ['storefront', 'internal'],
-      federationVersion: FED2_DEFAULT_VERSION,
-    });
-
-    expect(actual).toEqual(
-      // prettier-ignore
-      gql`
-        extend schema @link(url: "https://specs.apollo.dev/federation/v2.0", import: ["@key", "@tag", "@external"])
-
-        type Book implements Node @key(fields: "isbn") {
-          "The globally unique identifier."
-          id: ID!
-          isbn: String!
-        }
-
-        type Edition implements Node @key(fields: "isbn") {
-          "The globally unique identifier."
-          id: ID!
-          isbn: String!
-          publicationYear: Int @external
-        }
-
-        "The global identification interface implemented by all entities."
-        interface Node @tag(name: "internal") @tag(name: "storefront") {
-          "The globally unique identifier."
-          id: ID!
-        }
-
-        type Query {
-          "Fetches an entity by its globally unique identifier."
-          node(
-            "A globally unique entity identifier."
-            id: ID!
-          ): Node @tag(name: "internal") @tag(name: "storefront")
-        }
-      `
-    );
-  });
-
   it('uses a custom qualifier to prefer fields', () => {
     const bookSchema = gql`
       type Book @key(fields: "isbn") {

src/schema/astDefinitions.ts

@@ -1,5 +1,5 @@
 import {ConstDirectiveNode, Kind, NamedTypeNode} from 'graphql';
-import {EXTERNAL_DIRECTIVE, SHAREABLE_DIRECTIVE} from './constants';
+import {EXTERNAL_DIRECTIVE} from './constants';
 
 /**
  * Represents AST for `implements Node`
@@ -22,14 +22,3 @@ export const externalDirective: ConstDirectiveNode = {
     value: EXTERNAL_DIRECTIVE,
   },
 };
-
-/**
- * Represents AST for `@shareable` directive
- */
-export const shareableDirective: ConstDirectiveNode = {
-  kind: Kind.DIRECTIVE,
-  name: {
-    kind: Kind.NAME,
-    value: SHAREABLE_DIRECTIVE,
-  },
-};

src/schema/constants.ts

@@ -13,7 +13,6 @@ export enum Directive {
   External = '@external',
   InterfaceObject = '@interfaceObject',
   Key = '@key',
-  Shareable = '@shareable',
   Tag = '@tag',
 }
 
@@ -22,7 +21,6 @@ export enum DirectiveName {
   External = 'external',
   InterfaceObject = 'interfaceObject',
   Key = 'key',
-  Shareable = 'shareable',
   Tag = 'tag',
 }
 
@@ -36,18 +34,12 @@ export const EXTENDS_DIRECTIVE = DirectiveName.Extends;
 export const TAG_DIRECTIVE = DirectiveName.Tag;
 export const KEY_DIRECTIVE = DirectiveName.Key;
 export const INTERFACE_OBJECT_DIRECTIVE = DirectiveName.InterfaceObject;
-export const SHAREABLE_DIRECTIVE = DirectiveName.Shareable;
 
 export const EXTERNAL_DIRECTIVE_AST = {
   kind: Kind.DIRECTIVE,
   name: {kind: Kind.NAME, value: DirectiveName.External},
 } as ConstDirectiveNode;
 
-export const SHAREABLE_DIRECTIVE_AST = {
-  kind: Kind.DIRECTIVE,
-  name: {kind: Kind.NAME, value: DirectiveName.Shareable},
-} as ConstDirectiveNode;
-
 export const DEFAULT_FEDERATION_LINK_IMPORTS = [
   Directive.Key,
   Directive.Tag,