Updated index.mjs file to be modified for Apollo subgraph Federation 2 features

Author: flora-jin

CHANGELOG.md

@@ -116,4 +116,6 @@ permissions and limitations under the License.
   option ([#117](https://github.com/aws/amazon-neptune-for-graphql/pull/117))
 * Fixed invalid schema generation when AWS AppSync scalar types are used in 
   an input 
-  schema ([#118](https://github.com/aws/amazon-neptune-for-graphql/pull/118))
+  schema ([#118](https://github.com/aws/amazon-neptune-for-graphql/pull/118))
+* Updated index.mjs file to be modified for Apollo subgraph Federation 2 
+  features ([#126](https://github.com/aws/amazon-neptune-for-graphql/pull/126))

src/zipPackage.js

@@ -49,7 +49,7 @@ async function createZip({targetZipFilePath, includePaths = [], includeContent =
         output.on('close', () => resolve());
         archive.on('error', err => reject(err));
     });
-    
+
     archive.pipe(output);
 
     includePaths.forEach(includePath => {
@@ -144,4 +144,4 @@ export async function createApolloDeploymentPackage({zipFilePath, resolverFilePa
 
 export function getModulePath() {
     return path.dirname(fileURLToPath(import.meta.url));
-}
+}

templates/ApolloServer/index.mjs

@@ -8,7 +8,15 @@ import dotenv from 'dotenv';
 
 dotenv.config();
 
-const typeDefs = parse(readFileSync('./output.schema.graphql', 'utf-8'));
+const fileContent = readFileSync('./output.schema.graphql', 'utf-8');
+let schema = fileContent;
+if (process.env.SUBGRAPH === 'true') {
+    schema = `extend schema @link(
+        url: "https://specs.apollo.dev/federation/v2.0"
+        import: ["@key", "@shareable"]
+    )${fileContent}`;
+}
+const typeDefs = parse(schema);
 const queryDefinition = typeDefs.definitions.find(
     definition => definition.kind === 'ObjectTypeDefinition' && definition.name.value === 'Query'
 );

test/TestCases/Case09/Case09.02.test.js

@@ -6,6 +6,7 @@ const testCase = readJSONFile('./test/TestCases/Case09/apollo-subgraph.json');
 const testDbInfo = parseNeptuneEndpoint(testCase.host + ':' + testCase.port);
 
 const outputFolderPath = './test/TestCases/Case09/apollo-subgraph-output';
+const outputReferencePath = './test/TestCases/Case09/outputReference';
 describe('Validate Apollo Server Subgraph output artifacts', () => {
     afterAll(() => {
         fs.rmSync(outputFolderPath, {recursive: true});
@@ -19,5 +20,5 @@ describe('Validate Apollo Server Subgraph output artifacts', () => {
         `${testDbInfo.graphName}.source.schema.graphql`
     ]);
 
-    testApolloArtifacts(outputFolderPath, testDbInfo, true);
+    testApolloArtifacts(outputFolderPath, outputReferencePath, testDbInfo, true);
 });

test/TestCases/Case09/Case09.04.test.js

@@ -5,11 +5,12 @@ import {parseNeptuneEndpoint} from "../../../src/util.js";
 const testCase = readJSONFile('./test/TestCases/Case09/apollo-subgraph-input-schema.json');
 const testDbInfo = parseNeptuneEndpoint(testCase.host + ':' + testCase.port);
 const outputFolderPath = './test/TestCases/Case09/apollo-subgraph-input-schema-output';
+const outputReferencePath = './test/TestCases/Case09/outputReference';
 
 describe('Validate Apollo Server Subgraph output artifacts are created when using an input schema file', () => {
     afterAll(async () => {
         fs.rmSync(outputFolderPath, {recursive: true});
     });
 
-    testApolloArtifacts(outputFolderPath, testDbInfo, true);
+    testApolloArtifacts(outputFolderPath, outputReferencePath, testDbInfo, true);
 });

test/TestCases/Case09/outputReference/index.mjs

@@ -0,0 +1,78 @@
+import {ApolloServer} from '@apollo/server';
+import {startStandaloneServer} from '@apollo/server/standalone';
+import {buildSubgraphSchema} from '@apollo/subgraph';
+import {readFileSync} from 'fs';
+import {parse} from 'graphql';
+import {resolveEvent} from './neptune.mjs'
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+const source = readFileSync('./output.schema.graphql', 'utf-8');
+const schema = `extend schema @link(
+        url: "https://specs.apollo.dev/federation/v2.0"
+        import: ["@key", "@shareable"]
+    )${source}`;
+const typeDefs = parse(schema);
+const queryDefinition = typeDefs.definitions.find(
+    definition => definition.kind === 'ObjectTypeDefinition' && definition.name.value === 'Query'
+);
+const queryNames = queryDefinition ? queryDefinition.fields.map(field => field.name.value) : [];
+
+const mutationDefinition = typeDefs.definitions.find(
+    definition => definition.kind === 'ObjectTypeDefinition' && definition.name.value === 'Mutation'
+);
+const mutationNames = mutationDefinition ? mutationDefinition.fields.map(field => field.name.value) : [];
+
+/**
+ * Resolves GraphQL queries and mutations by processing the info object and arguments.
+ *
+ * @param {Object} info - GraphQLResolveInfo object
+ * @param {Object} args - graphQL query arguments
+ * @returns {Promise<*>} Resolved data from the event processor
+ */
+function resolve(info, args) {
+    if (!info?.fieldName) {
+        throw new Error('Missing fieldName on GraphQLResolveInfo');
+    }
+    if (!Array.isArray(info.fieldNodes) || info.fieldNodes.length !== 1) {
+        throw new Error('Invalid fieldNodes on GraphQLResolveInfo');
+    }
+    const event = {
+        field: info.fieldName,
+        arguments: args,
+        selectionSet: info.fieldNodes[0].selectionSet,
+        variables: info.variableValues,
+        fragments: info.fragments
+    };
+
+    return resolveEvent(event).then((result) => {
+        return result;
+    });
+}
+
+const resolvers = {
+    Query: queryNames.reduce((accumulator, queryName) => {
+        accumulator[queryName] = (parent, args, context, info) => {
+            return resolve(info, args);
+        };
+        return accumulator;
+    }, {}),
+
+    Mutation: mutationNames.reduce((accumulator, mutationName) => {
+        accumulator[mutationName] = (parent, args, context, info) => {
+            return resolve(info, args);
+        };
+        return accumulator;
+    }, {}),
+};
+
+const server = process.env.SUBGRAPH === 'true' ? new ApolloServer({
+    schema: buildSubgraphSchema([{
+        typeDefs,
+        resolvers
+    }])
+}) : new ApolloServer({typeDefs, resolvers});
+
+const {url} = await startStandaloneServer(server);
+console.log(`🚀 Server ready at ${url}`);

test/testLib.js

@@ -185,6 +185,7 @@ async function testResolverQueriesResults(resolverFile, queriesReferenceFolder,
  * Validates that an apollo zip contains the correct content.
  * 
  * @param {string} outputFolderPath the test output folder path that contains the apollo zip file to validate
+ * @param outputReferencePath the test output reference folder path that contains apollo files for content validation
  * @param {object} testDbInfo object that contains info about the neptune db/graph used to generate the apollo zip file
  * @param {string} testDbInfo.graphName neptune db/graph name
  * @param {string} testDbInfo.neptuneType neptune-db or neptune-graph
@@ -194,7 +195,7 @@ async function testResolverQueriesResults(resolverFile, queriesReferenceFolder,
  * @param {boolean} subgraph true if the apollo zip contents should be for a subgraph
  * @returns {Promise<void>}
  */
-async function testApolloArtifacts(outputFolderPath, testDbInfo, subgraph = false) {
+async function testApolloArtifacts(outputFolderPath, outputReferencePath, testDbInfo, subgraph = false) {
     test('Validate Apollo zip contents', () => {
         const expectedFiles = [
             '.env',
@@ -226,6 +227,10 @@ async function testApolloArtifacts(outputFolderPath, testDbInfo, subgraph = fals
         ];
         const actualEnvContent = fs.readFileSync(path.join(outputFolderPath, 'unzipped', '.env'), 'utf8');
         expect(actualEnvContent).toEqual(expectedEnvContent.join('\n'));
+
+        const expectedIndexFileContent = fs.readFileSync(path.join(outputReferencePath, 'index.mjs'), 'utf8');
+        const actualIndexFileContent = fs.readFileSync(path.join(outputFolderPath, 'unzipped', 'index.mjs'), 'utf8');
+        expect(actualIndexFileContent).toEqual(expectedIndexFileContent);
     });
 }