vscode-apollo 2.5.6 → 2.6.0

package/sampleWorkspace/connectors-community/file-new/index.js

@@ -0,0 +1,520 @@
+import {config} from "dotenv";
+config({ override: true });
+
+import prompts from "prompts";
+import { copyFile, cp, mkdir, readdir, readFile, writeFile } from "fs/promises";
+import { resolve } from "path";
+import { gql, request } from "graphql-request";
+import { faker } from "@faker-js/faker";
+import { existsSync, readFileSync } from "fs";
+import { dump, load } from "js-yaml";
+
+const userApiKey = process.env.APOLLO_KEY;
+const graphosURL = "https://graphql.api.apollographql.com/api/graphql";
+const graphosHeaders = {
+  "x-api-key": userApiKey,
+  "apollographql-client-name": "connectors-community",
+  "apollographql-client-version": "1",
+};
+
+async function main() {
+  if(!userApiKey) throw new Error("No User API key found in .env")
+  if (userApiKey && userApiKey.includes("service"))
+    throw new Error(
+      "You muse use a user API key from https://studio.apollographql.com/user-settings/api-keys"
+    );
+
+
+  let graphId = process.env.APOLLO_KEY?.split(":")[1];
+  let graphVariant = process.env.APOLLO_GRAPH_VARIANT;
+  let graphApiKey;
+
+  let clonePath = process.argv[2];
+  if (!clonePath) {
+    const pathPrompt = await prompts({
+      type: "text",
+      name: "path",
+      message: "Where would you like to setup your new connector environment?",
+    });
+
+    clonePath = pathPrompt.path.replace(/['"]+/g, "").replace(/[']+/g, "").trim();
+  }
+
+  const graphPrompt =
+    graphId && graphVariant
+      ? { type: 1 }
+      : await prompts({
+          name: "type",
+          type: "select",
+          choices: ["new", "existing"],
+          message: "Is this for a new or existing graph?",
+        });
+
+  let connectorName;
+  let folderToClone = ".template";
+  const modules = [];
+  const prebuild = await prompts({
+    type: "confirm",
+    name: "use",
+    message: "Do you want to use a pre-built connector?",
+  });
+
+  if (prebuild.use) {
+    const directory = await readdir("connectors", {
+      encoding: "utf-8",
+    });
+    const connectors = directory.filter(
+      (item) => !/(^|\/)\.[^\/\.]/g.test(item)
+    );
+    const prebuiltPrompt = await prompts({
+      name: "connector",
+      type: "select",
+      choices: connectors,
+      message: "Which connector would you like to use?",
+    });
+
+    if (prebuiltPrompt.connector == undefined)
+      throw new Error("User cancelled");
+
+    folderToClone = connectors[prebuiltPrompt.connector];
+    connectorName = folderToClone;
+    //Prompt for modules
+    const connectorDirectory = await readdir(
+      resolve("connectors", folderToClone),
+      {
+        encoding: "utf-8",
+      }
+    );
+    const schemaFiles = connectorDirectory.filter((f) =>
+      f.includes(".graphql")
+    );
+    const choices = schemaFiles.map((s) => s.split(".graphql")[0]);
+
+    if (choices.length === 1) {
+      modules.push(schemaFiles[0]);
+    }else if (choices.length > 1) {
+      const schemaModulesPrompt = await prompts({
+        name: "modules",
+        type: "multiselect",
+        choices,
+        message: `What portions of the ${connectorName} connector would you like to use?`,
+      });
+      schemaModulesPrompt.modules.forEach((i) => modules.push(schemaFiles[i]));
+    }
+  } else {
+    const connectorNamePrompt = await prompts({
+      name: "name",
+      type: "text",
+      message: "What would you like to name your connector?",
+    });
+
+    if (!connectorNamePrompt.name) userCancelled();
+
+    connectorName = connectorNamePrompt.name;
+  }
+
+  //Get user orgs and have them select if there is more than one
+  //We want to filter orgs that don't have any graphs in them yet
+  const org = await getUserOrgId(graphPrompt.type == 1);
+  const orgId = org.id;
+  if(org.graphId) graphId = org.graphId;
+  if(org.graphVariant) graphVariant = org.graphVariant;
+
+  //Create graph in GraphOS
+  if (graphPrompt.type == 0) {
+    //3. Create graph id
+    let idIsValid = false;
+    let newGraphId;
+    while (!idIsValid) {
+      newGraphId =
+        connectorName +
+        "-" +
+        faker.string
+          .uuid()
+          .replace(/[^A-Za-z0-9_]+/g, "-")
+          .toLowerCase()
+          .substring(0, 6);
+      const idValidResults = await request(
+        graphosURL,
+        gql`
+          query CC_IsGraphIdValid($graphId: ID!, $accountId: ID!) {
+            account(id: $accountId) {
+              graphIDAvailable(id: $graphId)
+            }
+          }
+        `,
+        {
+          graphId: newGraphId,
+          accountId: orgId,
+        },
+        graphosHeaders
+      );
+
+      idIsValid = idValidResults?.account?.graphIDAvailable ?? false;
+    }
+    //4. Create graph - return API key
+    const createGraphResults = await request(
+      graphosURL,
+      gql`
+        mutation CC_CreateGraph(
+          $graphType: GraphType!
+          $hiddenFromUninvitedNonAdmin: Boolean!
+          $createGraphId: ID!
+          $title: String!
+          $accountId: ID!
+        ) {
+          account(id: $accountId) {
+            createGraph(
+              graphType: $graphType
+              hiddenFromUninvitedNonAdmin: $hiddenFromUninvitedNonAdmin
+              id: $createGraphId
+              title: $title
+            ) {
+              ... on Service {
+                id
+                apiKeys {
+                  token
+                }
+              }
+              ...on GraphCreationError {
+                message
+              }
+            }
+          }
+        }
+      `,
+      {
+        graphType: "SELF_HOSTED_SUPERGRAPH",
+        hiddenFromUninvitedNonAdmin: false,
+        createGraphId: newGraphId,
+        title: connectorName,
+        accountId: orgId,
+      },
+      graphosHeaders
+    );
+
+    if(createGraphResults.account.message){
+      throw new Error(`Unable to create graph in GraphOS: ${createGraphResults.account.message}`)
+    }
+
+    graphId = createGraphResults.account.createGraph.id;
+    graphVariant = "dev";
+    graphApiKey = createGraphResults.account.createGraph.apiKeys[0].token;
+
+    let sdl= await readFile(
+      resolve("connectors", ".template", "connector.graphql"),
+      { encoding: "utf-8" }
+    );
+
+    const publishSchemaDoc = gql`
+      mutation CC_PublishSubgraphSchema(
+        $graphId: ID!
+        $variantName: String!
+        $subgraphName: String!
+        $schemaDocument: PartialSchemaInput!
+        $url: String
+        $revision: String!
+      ) {
+        graph(id: $graphId) {
+          publishSubgraph(
+            graphVariant: $variantName
+            activePartialSchema: $schemaDocument
+            name: $subgraphName
+            url: $url
+            revision: $revision
+          ) {
+            launchUrl
+            updatedGateway
+            wasCreated
+          }
+        }
+      }
+    `;
+    const variables = {
+      graphId: graphId,
+      variantName: graphVariant,
+      subgraphName: connectorName,
+      schemaDocument: {
+        sdl
+      },
+      url: `http://${connectorName}`,
+      revision: "initial",
+    };
+    const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
+    
+    if(prebuild.use){
+      // need to publish modules
+      for(var i = 0; i<modules.length;i++){
+        const module = modules[i];
+        const moduleName = module.split(".")[0];
+
+        variables.url = `http://${connectorName}`;
+        variables.subgraphName = moduleName
+        variables.schemaDocument.sdl = await readFile(
+          resolve("connectors", folderToClone, module),
+          { encoding: "utf-8" }
+        );
+
+        await request(
+          graphosURL,
+          publishSchemaDoc,
+          variables,
+          graphosHeaders
+        );
+        await sleep(1000);
+      }
+    } else {
+      await request(
+        graphosURL,
+        publishSchemaDoc,
+        variables,
+        graphosHeaders
+      );
+    }
+
+    await sleep(1000);
+    await request(
+      graphosURL,
+      gql`
+        mutation CC_ChangeBuildPipeline(
+          $graphId: ID!
+          $variantName: String!
+          $fedVersion: BuildPipelineTrack!
+        ) {
+          graph(id: $graphId) {
+            variant(name: $variantName) {
+              buildConfig(version: $fedVersion) {
+                id
+              }
+            }
+          }
+        }
+      `,
+      {
+        graphId: graphId,
+        variantName: graphVariant,
+        fedVersion: "FED_NEXT",
+      },
+      graphosHeaders
+    );
+  }
+  //Use graph in GraphOS
+  else if (graphPrompt.type == 1) {
+    const newApiKeyResults = await request(
+      graphosURL,
+      gql`
+        mutation CC_CreateGraphKey($graphId: ID!, $keyName: String) {
+          graph(id: $graphId) {
+            newKey(keyName: $keyName) {
+              token
+            }
+          }
+        }
+      `,
+      {
+        graphId,
+        keyName: `connectors-community-${faker.string
+          .uuid()
+          .replace(/[^A-Za-z0-9_]+/g, "-")
+          .toLowerCase()
+          .substring(0, 6)}`,
+      },
+      graphosHeaders
+    );
+    graphApiKey = newApiKeyResults.graph.newKey.token;
+  }
+
+  if (!graphId || !graphVariant)
+    throw new Error("You muse use a graph ref from GraphOS to use connectors");
+
+  if (!existsSync(clonePath)) await mkdir(clonePath);
+
+  if (modules.length > 0) {
+    await copyFile(
+      resolve("connectors", folderToClone, "router.yaml"),
+      resolve(clonePath, "router.yaml")
+    );
+    let supergraph = load(
+      readFileSync(resolve("connectors", folderToClone, "supergraph.yaml"))
+    );
+    supergraph.subgraphs = {};
+    modules.forEach(async (module) => {
+      const moduleName = module.split(".")[0];
+      supergraph.subgraphs[`${connectorName}-${moduleName}`] = {
+        routing_url: `http:${moduleName}`,
+        schema: {
+          file: module,
+        },
+      };
+      await copyFile(
+        resolve("connectors", folderToClone, module),
+        resolve(clonePath, module)
+      );
+    });
+    await writeFile(resolve(clonePath, "supergraph.yaml"), dump(supergraph), {
+      encoding: "utf-8",
+    });
+  } else {
+    //Only one module so we can clone the folder
+    await cp(resolve("connectors", folderToClone), clonePath, {
+      recursive: true,
+    });
+  }
+
+  await mkdir(resolve(clonePath, ".vscode"));
+  await cp(".vscode", resolve(clonePath, ".vscode"), {
+    recursive: true,
+  });
+  await copyFile(
+    "apollo.config.json",
+    resolve(clonePath, "apollo.config.json")
+  );
+
+  await writeFile(
+    resolve(clonePath, ".env"),
+    `APOLLO_KEY=${graphApiKey}\nAPOLLO_GRAPH_REF=${graphId}@${graphVariant}`,
+    { encoding: "utf-8" }
+  );
+  await writeFile(
+    resolve(clonePath, ".vscode", "settings.json"),
+    `{
+  "terminal.integrated.profiles.osx": {
+    "graphos": {
+      "path": "zsh",
+      "args": ["-l"],
+      "env": { 
+        "APOLLO_KEY": "${graphApiKey}",
+        "APOLLO_GRAPH_REF": "${graphId}@${graphVariant}",
+        "APOLLO_ROVER_DEV_ROUTER_VERSION": "2.0.0",
+      }
+    }
+  },
+  "terminal.integrated.defaultProfile.osx": "graphos"
+}`
+  );
+
+  console.log(
+    `Project ready 🚀\! To open in VS Code, run: \n\ncode ${clonePath}`
+  );
+}
+
+main();
+
+function userCancelled() {
+  throw new Error("User cancelled");
+}
+
+async function getUserOrgId(promptForGraph = false) {
+  //Get user orgs and have them select if there is more than one
+  const orgResults = await request(
+    graphosURL,
+    gql`
+      query CC_UserMemberships {
+        me {
+          id
+          ... on User {
+            memberships {
+              account {
+                id
+                graphs {
+                  id
+                  name
+                }
+              }
+            }
+          }
+        }
+      }
+    `,
+    {},
+    graphosHeaders
+  );
+  let graphId;
+  let graphVariant;
+  let orgId = orgResults.me.memberships[0].account.id;
+  if (orgResults.me.memberships.length > 1 && orgId) {
+    let membershipChoices = orgResults.me.memberships;
+    if (promptForGraph)
+      membershipChoices = membershipChoices.filter(
+        (m) => m.account.graphs.length > 0
+      );
+    const orgPrompt = await prompts({
+      name: "org",
+      type: "select",
+      choices: membershipChoices.map((m) => m.account.id),
+      message: promptForGraph ? "Which org would you like to use? (filtered to orgs that havecd  graphs in them)" : "Which org would you like to use?",
+    });
+    if (typeof orgPrompt.org === 'number')
+      orgId = membershipChoices[orgPrompt.org].account.id;
+    else userCancelled();
+
+    if(promptForGraph){
+      const graphs = membershipChoices[orgPrompt.org].account.graphs;
+      const graphPrompt = await prompts({
+        name: "graph",
+        type: "select",
+        choices: graphs.map((m) => m.name),
+        message: "Which graph would you like to use?",
+      });
+
+      graphId = graphs[graphPrompt.graph].id;
+
+      const variantResults = await request(
+        graphosURL,
+        gql`
+          query CC_GetGraphVariants($graphId: ID!) {
+            graph(id: $graphId) {
+              variants {
+                name
+              }
+            }
+          }
+        `,
+        { graphId },
+        graphosHeaders
+      );
+
+      const variants = variantResults.graph.variants;
+      if (variants.length == 1) {
+        graphVariant = variants[0].name;
+      } else {
+        const variantPrompt = await prompts({
+          name: "variant",
+          type: "select",
+          choices: variants.map((m) => m.name),
+          message: "Which variant would you like to use?",
+        });
+        graphVariant = variants[variantPrompt.variant].name;
+      }
+    }
+  }
+  
+  return { id: orgId, graphId, graphVariant };
+}
+
+async function updateFedVersion(graphId, graphVariant) {
+  await request(
+    graphosURL,
+    gql`
+      mutation CC_PublishSubgraphSchema(
+        $graphId: ID!
+        $variantName: String!
+        $fedVersion: BuildPipelineTrack!
+      ) {
+        graph(id: $graphId) {
+          variant(name: $variantName) {
+            buildConfig(version: $fedVersion) {
+              id
+            }
+          }
+        }
+      }
+    `,
+    {
+      graphId: graphId,
+      variantName: graphVariant,
+      fedVersion: "FED_NEXT",
+    },
+    graphosHeaders
+  );
+}

package/sampleWorkspace/connectors-community/package-lock.json

@@ -0,0 +1,119 @@
+{
+    "name": "connectors-community",
+    "version": "1.0.0",
+    "lockfileVersion": 3,
+    "requires": true,
+    "packages": {
+        "": {
+            "name": "connectors-community",
+            "version": "1.0.0",
+            "license": "MIT",
+            "dependencies": {
+                "@faker-js/faker": "^9.0.3",
+                "dotenv": "^16.4.5",
+                "graphql": "^16.9.0",
+                "graphql-request": "^7.1.0",
+                "js-yaml": "^4.1.0",
+                "prompts": "^2.4.2"
+            }
+        },
+        "node_modules/@faker-js/faker": {
+            "version": "9.7.0",
+            "resolved": "https://registry.npmjs.org/@faker-js/faker/-/faker-9.7.0.tgz",
+            "integrity": "sha512-aozo5vqjCmDoXLNUJarFZx2IN/GgGaogY4TMJ6so/WLZOWpSV7fvj2dmrV6sEAnUm1O7aCrhTibjpzeDFgNqbg==",
+            "funding": [
+                {
+                    "type": "opencollective",
+                    "url": "https://opencollective.com/fakerjs"
+                }
+            ],
+            "license": "MIT",
+            "engines": {
+                "node": ">=18.0.0",
+                "npm": ">=9.0.0"
+            }
+        },
+        "node_modules/@graphql-typed-document-node/core": {
+            "version": "3.2.0",
+            "resolved": "https://registry.npmjs.org/@graphql-typed-document-node/core/-/core-3.2.0.tgz",
+            "integrity": "sha512-mB9oAsNCm9aM3/SOv4YtBMqZbYj10R7dkq8byBqxGY/ncFwhf2oQzMV+LCRlWoDSEBJ3COiR1yeDvMtsoOsuFQ==",
+            "peerDependencies": {
+                "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0"
+            }
+        },
+        "node_modules/argparse": {
+            "version": "2.0.1",
+            "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
+            "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
+        },
+        "node_modules/dotenv": {
+            "version": "16.5.0",
+            "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.5.0.tgz",
+            "integrity": "sha512-m/C+AwOAr9/W1UOIZUo232ejMNnJAJtYQjUbHoNTBNTJSvqzzDh7vnrei3o3r3m9blf6ZoDkvcw0VmozNRFJxg==",
+            "license": "BSD-2-Clause",
+            "engines": {
+                "node": ">=12"
+            },
+            "funding": {
+                "url": "https://dotenvx.com"
+            }
+        },
+        "node_modules/graphql": {
+            "version": "16.11.0",
+            "resolved": "https://registry.npmjs.org/graphql/-/graphql-16.11.0.tgz",
+            "integrity": "sha512-mS1lbMsxgQj6hge1XZ6p7GPhbrtFwUFYi3wRzXAC/FmYnyXMTvvI3td3rjmQ2u8ewXueaSvRPWaEcgVVOT9Jnw==",
+            "license": "MIT",
+            "engines": {
+                "node": "^12.22.0 || ^14.16.0 || ^16.0.0 || >=17.0.0"
+            }
+        },
+        "node_modules/graphql-request": {
+            "version": "7.1.2",
+            "resolved": "https://registry.npmjs.org/graphql-request/-/graphql-request-7.1.2.tgz",
+            "integrity": "sha512-+XE3iuC55C2di5ZUrB4pjgwe+nIQBuXVIK9J98wrVwojzDW3GMdSBZfxUk8l4j9TieIpjpggclxhNEU9ebGF8w==",
+            "license": "MIT",
+            "dependencies": {
+                "@graphql-typed-document-node/core": "^3.2.0"
+            },
+            "peerDependencies": {
+                "graphql": "14 - 16"
+            }
+        },
+        "node_modules/js-yaml": {
+            "version": "4.1.0",
+            "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
+            "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
+            "dependencies": {
+                "argparse": "^2.0.1"
+            },
+            "bin": {
+                "js-yaml": "bin/js-yaml.js"
+            }
+        },
+        "node_modules/kleur": {
+            "version": "3.0.3",
+            "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz",
+            "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==",
+            "engines": {
+                "node": ">=6"
+            }
+        },
+        "node_modules/prompts": {
+            "version": "2.4.2",
+            "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz",
+            "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==",
+            "dependencies": {
+                "kleur": "^3.0.3",
+                "sisteransi": "^1.0.5"
+            },
+            "engines": {
+                "node": ">= 6"
+            }
+        },
+        "node_modules/sisteransi": {
+            "version": "1.0.5",
+            "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz",
+            "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg=="
+        }
+    }
+}

package/sampleWorkspace/connectors-community/package.json

@@ -0,0 +1,20 @@
+{
+    "name": "connectors-community",
+    "version": "1.0.0",
+    "description": "A simple repository designed share connectors in the community and ensure they follow a specific standard.",
+    "type": "module",
+    "main": "file-new/index.js",
+    "author": "Apollo GraphQL",
+    "license": "MIT",
+    "scripts": {
+        "start": "node file-new/index.js"
+    },
+    "dependencies": {
+        "@faker-js/faker": "^9.0.3",
+        "dotenv": "^16.4.5",
+        "graphql": "^16.9.0",
+        "graphql-request": "^7.1.0",
+        "js-yaml": "^4.1.0",
+        "prompts": "^2.4.2"
+    }
+}

package/sampleWorkspace/connectors-community/supergraph.yaml

@@ -0,0 +1,6 @@
+federation_version: =2.11.0
+subgraphs:
+  connector:
+    routing_url: http://connector
+    schema:
+      file: connector.graphql