Merge pull request #33 from oslabs-beta/dev

Merging in 3rd Party API compatibility feature

Author: alexchao26

package-lock.json

@@ -4,7 +4,7 @@
 	"description": "Welcome to a new era of GraphQL API development.",
 	"icon": "DOCUMENTATION/graphquill-logo.png",
 	"publisher": "sproutdeveloping",
-	"version": "0.14.0",
+	"version": "0.15.0",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/oslabs-beta/GraphQuill.git"

package.json

@@ -8,6 +8,13 @@
  * - updating variables in the event of changes in the config files
  * @changelog : Austin Ruby, Nov. 15th: passed invocation of RFSRWR function within doc
  * save listener into debounce function to avoid overquerying API if user mashes save
+ * @changelog : Austin Ruby, Nov. 22nd:
+ * - added instructions for adding external server url to config file comments
+ * - added logic to not invoke serverOn if using external server
+ * - added logic to call RFSRWR if using external server
+ * - added url argument to RFSRWR -- undefined if locally hosted server, otherwise
+ * will be the url of the server
+ * - accounted for external url on deactivation
  * * */
 
 // eslint-disable-next-line import/no-unresolved
@@ -96,10 +103,11 @@ export function activate(context: vscode.ExtensionContext) {
     // Check ONCE if the port is open (also this does not need the third param)
     // will resolve to a true or false value
     const serverOnFromUser = await checkForRunningServer(portNumber, true);
-    // console.log('--serverOnFromUser after once check is:', serverOnFromUser);
+    const externalURL = entryPoint.slice(0, 4) === 'http';
 
     // trigger serverOn if the user does not already have the server running
-    if (!serverOnFromUser) {
+    // AND if the server is not hosted at an external URL
+    if (!serverOnFromUser && !externalURL) {
       // start up the user's server, pass in the gqChannel to log any error messages
       serverOn(entryPoint, gqChannel);
 
@@ -133,16 +141,20 @@ export function activate(context: vscode.ExtensionContext) {
       }
     }
 
-    // if the server is on from either the user or graphquill, continue
-    // send first query & setup on save listener
-    if (serverOnFromUser || serverTurnedOnByGraphQuill) {
-      // update isOnToggle (refers to state of GraphQuill extension running or not)
+    // if the server is on from either the user or graphquill,
+    // or the user is querying an external URL,
+    // continue and send first query & setup on save listener
+    if (serverOnFromUser || serverTurnedOnByGraphQuill || externalURL) {
+      let url: (undefined|string);
+      // if user's server is running at external url, set url to their specified entryPoint
+      if (externalURL) url = entryPoint;
+      // make isOnToggle true regardless of url to enable deactivation functionality
       isOnToggle = true;
 
       // get the fileName of the open file when the extension is FIRST fired
       const currOpenEditorPath: string = vscode.window.activeTextEditor!.document.fileName;
       // send that request from the currentopeneditor
-      readFileSendReqAndWriteResponse(currOpenEditorPath, gqChannel, portNumber, rootPath);
+      readFileSendReqAndWriteResponse(currOpenEditorPath, gqChannel, portNumber, rootPath, url);
 
 
       const debouncedRFSRWR = debounce(
@@ -171,7 +183,7 @@ export function activate(context: vscode.ExtensionContext) {
         }
 
         // send the filename and channel to the readFileSRAWR function
-        debouncedRFSRWR(event.fileName, gqChannel, portNumber, rootPath);
+        debouncedRFSRWR(event.fileName, gqChannel, portNumber, rootPath, url);
 
         // satisfying linter
         return null;
@@ -193,6 +205,7 @@ export function activate(context: vscode.ExtensionContext) {
     // console.log('--deactivate functionality triggered');
 
     // check isontoggle boolean
+    // as long as user isn't querying external URL
     if (!isOnToggle) {
       // server is already off
       // console.log('server is already off');
@@ -261,7 +274,7 @@ export function activate(context: vscode.ExtensionContext) {
     // if it does not already exist, write to a new file
     fs.writeFileSync(graphQuillConfigPath,
       // string to populate the file with
-      'module.exports = {\n  // change "./server/index.js" to the relative path from the root directory to\n  // the file that starts your server\n  entry: \'./server/index.js\',\n\n  // change 3000 to the port number that your server runs on\n  portNumber: 3000,\n\n  // to increase the amount of time allowed for the server to startup, add a time\n  // in milliseconds (integer) to the "serverStartupTimeAllowed"\n  // serverStartupTimeAllowed: 5000,\n};\n',
+      'module.exports = {\n  // change "./server/index.js" to the relative path from the root directory to\n  // the file that starts your server.\n  // if you\'re connecting to an external server,\n  // change "./server/index.js" to its URL in the following format:\n  // "https://yourserverurl.com"\n  entry: \'./server/index.js\',\n\n  // change 3000 to the port number that your server runs on\n  portNumber: 3000,\n\n  // to increase the amount of time allowed for the server to startup, add a time\n  // in milliseconds (integer) to the "serverStartupTimeAllowed"\n  // serverStartupTimeAllowed: 5000,\n};\n',
       'utf-8');
 
     // open the file in vscode
@@ -276,6 +289,9 @@ export function activate(context: vscode.ExtensionContext) {
   // push it to the subscriptions
   context.subscriptions.push(disposableCreateConfigFile);
 
+  /** **************************************************************************
+   * * Fifth GraphQuill option in command palette to SHOW THE SCHEMA
+   ************************************************************************** */
   const disposableShowGraphQLSchema = vscode.commands.registerCommand('extension.showGraphQLSchema', async () => {
     // console.log('show schema running');
     // show output channel, clear any old stuff off of it
@@ -300,11 +316,13 @@ export function activate(context: vscode.ExtensionContext) {
     // Check ONCE if the port is open (also this does not need the third param)
     // will resolve to a true or false value
     const serverOnAlready = await checkForRunningServer(portNumber, true);
+    const externalURL = entryPoint.slice(0, 4) === 'http';
     // console.log('--serverOnFromUser after once check is:', serverOnFromUser);
     let serverTurnedOnBySchemaOutputter = false;
 
     // trigger serverOn if the user does not already have the server running
-    if (!serverOnAlready) {
+    // or if user is requesting data from external server
+    if (!serverOnAlready && !externalURL) {
       // start up the user's server, pass in the gqChannel to log any error messages
       serverOn(entryPoint, gqChannel);
 
@@ -337,12 +355,14 @@ export function activate(context: vscode.ExtensionContext) {
         return setTimeout(() => serverOff(portNumber), 5000);
       }
     }
-
+    let url: (undefined|string);
+    if (externalURL) url = entryPoint;
+    // console.log('before invoking showSchema: ', url);
     // clear the channel off?
     gqChannel.clear();
 
     // run required in functionality here, required in
-    showGraphqlSchema(serverOnAlready, serverTurnedOnBySchemaOutputter, gqChannel, portNumber);
+    showGraphqlSchema(serverOnAlready, serverTurnedOnBySchemaOutputter, gqChannel, portNumber, url);
 
     // turn the server off if the extension turned it on
     // eslint-disable-next-line max-len

src/extension.ts

@@ -8,7 +8,8 @@
  * @function : return an object with the entryPoint and the allowServerTimeoutConfigSetting
  * @param : none
  * @returns : an array with the root directory AND the entryPoint strings
- * @changelog : ##WHOEVER CHANGES THE FILE, date, details
+ * @changelog : Austin Ruby, Nov. 22nd, 2019: added logic to not append rootpath to
+ * entrypoint if entrypoint is external url
  * * */
 
 // eslint-disable-next-line import/no-unresolved
@@ -35,8 +36,11 @@ function parseConfigFile(rootPath: string) {
     const configObject = require(`${gqConfigFilePath}`);
     // console.log('config object in parseconfigfile.ts', configObject);
 
-    // set the entry point to the absolute path (root + relative entry path)
-    entryPoint = path.resolve(rootPath, configObject.entry);
+    // if the entrypoint is an external url, set entryPoint to that url
+    // otherwise set the entry point to the absolute path (root + relative entry path)
+    entryPoint = configObject.entry.slice(0, 4) === 'http'
+      ? configObject.entry
+      : path.resolve(rootPath, configObject.entry);
 
     // set the portnumber
     portNumber = configObject.portNumber;

src/modules/client/parseConfigFile.ts

@@ -15,6 +15,8 @@
  * @changelog : Alex Chao, November 5th, 2019, merge conflict handling and server additions
  * @changelog : Alex Chao, November 6th, 2019, dynamic port number for fetching, coming from
  * the extension.ts file
+ * @changelog : Austin Ruby, November 22nd, 2019, added url parameter to hold external server's
+ * url or be undefined. if undefined, use localhost string with port from config file
  * * */
 
 // eslint-disable-next-line import/no-unresolved
@@ -30,9 +32,14 @@ function readFileSendReqAndWriteResponse(
   channel: vscode.OutputChannel,
   portNumber: number,
   rootPath: string, // passing the root path in to control the function def. injection
+  url: (undefined|string),
 ) {
   // parse the contents of the entire filePath file to a string
   const copy = fs.readFileSync(filePath).toString();
+  // if url is not undefined, user is querying external server
+  // and url will be the correct url
+  // otherwise use localhost with port number specified in config file
+  const validatedURL: string = url || `http://localhost:${portNumber}/graphql`;
   // check if the file is within the root directory, otherwise we don't want to inject the
   // function defintion
   if (filePath.includes(rootPath) && !copy.includes('function graphQuill')) {
@@ -75,23 +82,22 @@ function readFileSendReqAndWriteResponse(
       // wrapping queries in Promise.all to ensure all fetches resolve before appending to channel
       const finalReqResObj = await Promise.all(
         // using map to generate array of promises
-        queriesWithoutQuotes.map((reqResObj) => {
+        queriesWithoutQuotes.map((reqResObj, index) => {
           // confirm object exists
           if (reqResObj) {
             // copy reqResObj to avoid mutating argument object
             const newReqResObj = { ...reqResObj };
             // destructure query off of object
             const { query } = newReqResObj;
             // using return here to return promise into Promise.all
-            return fetch(`http://localhost:${portNumber}/graphql`, {
+            return fetch(validatedURL, {
               method: 'POST',
               headers: { 'Content-Type': 'application/json' },
               body: JSON.stringify({ query }),
             })
               .then((response: Response) => response.json())
             // adding parsed API response to newReqResObject
               .then((parsedResponse: {data: Object, errors: Object}) => {
-                // console.log('parsedResponse is: ', parsedResponse);
                 newReqResObj.response = parsedResponse.data || parsedResponse.errors;
                 return newReqResObj;
               })
@@ -105,7 +111,6 @@ function readFileSendReqAndWriteResponse(
         }),
       );
 
-      // console.log('finalReqResObj: ', finalReqResObj);
       channel.clear();
       channel.append('GraphQuill results:');
       channel.show(true);

src/modules/client/readFileSendReqAndWriteResponse.ts

@@ -7,7 +7,7 @@
  * @param : portNumber: number for the portnumber to send the introspection query to
  * @returns : nothing
  * @exports : the function that will append to the output channel when invoked
- * @changelog : ##WHOEVER CHANGES THE FILE, date, details
+ * @changelog : Austin Ruby, Nov. 23rd, 2019: accounted for external urls
  * * */
 
 /* eslint-disable no-unused-vars */
@@ -50,14 +50,15 @@ function schemaToStringQueryAndMutation(schemaPiece: any) {
     // remove the last comma of the arguments, place a closing paren
     queriesStr = queriesStr.slice(0, queriesStr.length - 2);
     if (one.args.length) queriesStr += '\n  )';
-
-    // place the returned type at the end of the answer string
-    if (one.type.ofType.kind !== 'LIST') {
-      // if it's not a list, just put the type on the end, and an ! if it's non-nullable
-      queriesStr += `: ${one.type.ofType.name}${one.type.kind === 'NON_NULL' ? '!' : ''}\n`;
-    } else {
-      // similar for a list but extra check for non-nullable elements as well
-      queriesStr += `: [${one.type.ofType.ofType.ofType.name}${one.type.ofType.ofType === 'NON_NULL' ? '!' : ''}]${one.type.kind === 'NON_NULL' ? '!' : ''}\n`;
+    if (one.type.ofType) {
+      // place the returned type at the end of the answer string
+      if (one.type.ofType.kind !== 'LIST') {
+        // if it's not a list, just put the type on the end, and an ! if it's non-nullable
+        queriesStr += `: ${one.type.ofType.name}${one.type.kind === 'NON_NULL' ? '!' : ''}\n`;
+      } else {
+        // similar for a list but extra check for non-nullable elements as well
+        queriesStr += `: [${one.type.ofType.ofType.ofType.name}${one.type.ofType.ofType === 'NON_NULL' ? '!' : ''}]${one.type.kind === 'NON_NULL' ? '!' : ''}\n`;
+      }
     }
   });
   return queriesStr;
@@ -101,12 +102,16 @@ async function showGraphqlSchema(
   serverTurnedOnByGraphQuill: boolean,
   gqChannel: vscode.OutputChannel,
   portNumber: number,
+  url: (undefined|string),
 ) {
+  // if not using external url, send req to portNumber from config file
+  const validatedURL = url || `http://localhost:${portNumber}/graphql`;
+  console.log('validatedURL: ', validatedURL);
   // if the server is on from either the user or graphquill, continue
   // send the __schema query & setup on save listener
-  if (serverOnFromUser || serverTurnedOnByGraphQuill) {
+  if (serverOnFromUser || serverTurnedOnByGraphQuill || url) {
   // send that request ot get back the entire schema...
-    const all = await fetch(`http://localhost:${portNumber}/graphql`, {
+    const all = await fetch(validatedURL, {
       method: 'POST',
       headers: { 'Content-Type': 'application/json' },
       body: JSON.stringify({ // this beautiful string literal is the introspection query
@@ -174,7 +179,7 @@ async function showGraphqlSchema(
       }),
     }).then((res: Response) => res.json())
       .then((json: {data: {__schema: {types: Object[]}}}) => (
-      // eslint-disable-next-line no-underscore-dangle
+        // eslint-disable-next-line no-underscore-dangle
         json.data.__schema.types.filter((e: any) => ( // can't figure out this any...
           e.kind !== 'SCALAR')) // filter out the scalar types ('BOOLEAN', 'STRING')
         // this will cause problems for graphql apis that have custom scalar types... but mvp :)
@@ -189,8 +194,10 @@ async function showGraphqlSchema(
 
     // same thing for the mutations
     const mutations = all.filter((e: {name: string}) => e.name === 'Mutation');
-    const parsedMutations = schemaToStringQueryAndMutation(mutations);
-    gqChannel.append(`\nMUTATIONS:\n${parsedMutations}\n`);
+    if (mutations.length) {
+      const parsedMutations = schemaToStringQueryAndMutation(mutations);
+      gqChannel.append(`\nMUTATIONS:\n${parsedMutations}\n`);
+    }
 
     // almost the same thing for the types
     const types = all.filter((e: {name: string}) => e.name !== 'Mutation' && e.name !== 'Query' && e.name.slice(0, 2) !== '__');