lots of comments few changes

VanceWallace · VanceWallace · commit 5bcdeee03bb7 · 2019-08-31T14:02:03.000-07:00
diff --git a/index.html b/index.html
@@ -1,3 +1,4 @@
+<!--This is the index file that is necessary for the electron app-->
 <!DOCTYPE html>
 <html>
 
@@ -18,8 +19,8 @@
 </head>
 
 <body>
+
   <div id="root"></div>
   <script src="./public/bundle.js"></script>
 </body>
-
 </html>
diff --git a/main.js b/main.js
@@ -37,7 +37,6 @@ function createWindow() {
     win = null;
   });
 
-  // app.server = createServer(app);
 }
 
 // Creates our window when electron has initialized for the first time
@@ -81,7 +80,7 @@ function showExportDialog(event, gqlSchema, gqlResolvers, sqlScripts, env, queri
       createApolloFile('db/createTables.sql', sqlScripts);
       createApolloFile('.env', env);
       //generate test-suite
-      createTestFile('tests/tests.js', buildExportTestSuite.createTest(queries[0], queries[1]));
+      createApolloFile('tests/tests.js', buildExportTestSuite.createTest(queries[0], queries[1]));
       
 
       const output = fs.createWriteStream(result + '/apollo-server.zip', 
@@ -122,7 +121,7 @@ function showExportDialog(event, gqlSchema, gqlResolvers, sqlScripts, env, queri
         createApolloFile('graphql/resolvers.js', '');
         createApolloFile('db/createTables.sql', '');
         createApolloFile('.env', '');
-        createTestFile('tests/tests.js','')
+        createApolloFile('tests/tests.js','')
 
         dialog.showMessageBox(win,
           {
@@ -151,7 +150,7 @@ const createTestFile = (filePath, data) => {
 //---------------------TEST EXPORT -------------------//
 
 
-//function to run when user clicks export
+//function to run when user clicks "Export Tests"
 function showTestExportDialog(event, queries) {
   dialog.showOpenDialog(
     {
@@ -171,52 +170,10 @@ function showTestExportDialog(event, queries) {
       //changed this to the root of the folder "test-suite" rather than "tests" within the folder -VW
       createTestFile('tests.js', buildExportTestSuite.createTest(queries[0], queries[1]));
 
-      //creating a function "output" that opens a write stream for our zip file. NOW COMMENTED OUT
-      // const output = fs.createWriteStream(result + '/test-suite.zip', 
-      //   // { autoClose: false }
-      // );
-
       //make a new output function that is an fs WRITE with the same data.
      fs.writeFile(result + 'tests.js', buildExportTestSuite.createTest(queries[0], queries[1]),function (err) {
           if (err) throw err;}); 
-       
-      // function "archive" that uses the "archiver" node module to make a zip format file level 9 NOW COMMENTED OUT
-      // const archive = archiver('zip', {
-      //   zlib: { level: 9 } // Sets the compression level.
-      // });
-
-      // using the "on" meathod to start the compression 
-      //good practice to catch warnings (ie stat failures and other non-blocking errors) NOW COMMENTED OUT
-      // archive.on('warning', function (err) {
-      //   if (err.code === 'ENOENT') console.error(err)
-      //   else throw err;
-      // });
-
-      // archive.on('error', function (err) {
-      //   throw err;
-      // });
-
-      // append files from test-suite directory and naming it `test-suite` within the archive NOW COMMENTED OUT
-      // archive.directory(__dirname + '/test-suite/', 'test-suite');
-
-      // pipe the archive details to our zip file -> pushes files into the zip NOW COMMENTED OUT
-      // archive.pipe(output);
-
-      // finalize the archive (ie we are done appending files but streams have to finish yet) NOW COMMENTED OUT 
-      // 'close' will be fired afterwards
-      // archive.finalize();
-
 
-      // listen for all archive data to be written and output associated details NOW COMMENTED OUT
-      // output.on('close', function () {
-      //   console.log('Zip file size is ', archive.pointer() + ' total bytes');
-      //   console.log('Archived zip file is complete.');
-
-      //instead, simply call "outputSingle" -VW
-        //outputSingle();
-
-        //reverts templates to empty files for future use
-        createTestFile('.env', '');
          //changed this to the root of the folder "test-suite" rather than "tests" within the folder -VW
         createTestFile('tests.js','')
 
@@ -230,8 +187,6 @@ function showTestExportDialog(event, queries) {
         )
       });
     }
-  //); TOO MANY BRACKETS
-//}
 
 //listener for Apollo Server export button being clicked
 ipcMain.on('show-export-dialog', (event, gqlSchema, gqlResolvers, sqlScripts, env, queries) => {
diff --git a/palette.css b/palette.css
@@ -1,3 +1,5 @@
+/* This is just a reference file not actually imported anywhere  */
+
 /* Coolors Exported Palette - coolors.co/b7cadc-e5e7e9-324353-fefefe-dd399c */
 
 /* HSL */
diff --git a/public/index.html b/public/index.html
@@ -1,3 +1,5 @@
+<!--This file does not appear to be necessary for electron at least-->
+
 <!DOCTYPE html>
 <html>
 <head>
diff --git a/src/components/popup/welcome.jsx b/src/components/popup/welcome.jsx
@@ -1,3 +1,5 @@
+// This is also the readme. 
+
 /* eslint-disable no-unused-vars */
 import React, { useContext } from "react";
 import {
diff --git a/src/components/sideBar/navSidebar.jsx b/src/components/sideBar/navSidebar.jsx
@@ -97,18 +97,6 @@ function NavSideBar() {
           document.querySelector("svg") ? document.querySelector("svg").remove() : "";
         }}
       />
-      {/* comments out button for removed component */}
-      {/* <NavButton
-        key='NavButton5'
-        className='fas fa-project-diagram'
-        view='GraphiQL'
-        click={(e) => {
-          dispatch({ type: SET_VIEW, payload: 'graphiql' })
-          dispatch({ type: SET_POP_UP, payload: '' })
-          changeButtonStyleOnClick("GraphiQL")
-          document.querySelector("svg") ? document.querySelector("svg").remove() : "";
-        }}
-      /> */}
       <NavButton
         key='NavButton6'
         className='fas fa-clipboard-check'
diff --git a/src/components/sideBar/noTableButton.jsx b/src/components/sideBar/noTableButton.jsx
@@ -30,7 +30,7 @@ const ButtonContainer = styled.div`
   cursor: pointer;
   animation: ${fontColor} 2s;
   animation-fill-mode: both;
-  animation-iteration-count: 5;
+  animation-iteration-count: 20;
 `;
 
 // styles the 'Add Table' button and surrounding space
diff --git a/src/components/view/mainView.jsx b/src/components/view/mainView.jsx
@@ -20,8 +20,6 @@ function MainView() {
       {view === 'code' && <CodeView />}
       {view === 'schema' && <SchemaView />}
       {view === 'visualize' && <VisualizeView />}
-      {/* comment out unused component */}
-      {/* {view === 'graphiql' && <GraphiqlView />} */}
       {view === 'tests' && <TestsView />}
       {popUp === 'table' && <TableForm />}
     </div>
diff --git a/src/components/view/testsView.jsx b/src/components/view/testsView.jsx
@@ -1,36 +1,19 @@
 import React, { useContext } from 'react';
 import styled from 'styled-components';
 import { Store } from '../../state/store';
-import { UPDATE_QUERIES } from '../../actions/actionTypes';
-import { ADD_APOLLO_SERVER_URI } from '../../actions/actionTypes';
-
-
-const electron = window.require('electron');
-const ipc = electron.ipcRenderer;
+import { UPDATE_QUERIES, ADD_APOLLO_SERVER_URI } from '../../actions/actionTypes';
 
 import { ApolloClient } from 'apollo-client';
 import { InMemoryCache } from 'apollo-cache-inmemory';
 import { gql, HttpLink } from 'apollo-boost';
 
+const electron = window.require('electron');
+const ipc = electron.ipcRenderer;
 
 /*-------------------- Styled Components --------------------*/
+/* The following styles mimic the styles in codeView */
 
-// const Title = styled.h1`
-// font-size: 1.5em;
-// text-align: center;
-// color: palevioletred;
-// `;
-
-// const Response = styled.div`
-//     margin: 13px;
-//     font-family: Courier New, Consolas, Monaco, Lucida Console;
-//     font-size: 15px;
-//     background-color: #EFF0F1;
-//     display: grid;
-//     height: calc(100vh - 26px - 64px);
-// `;
 
-/* The following styles mimic the styles in codeView */
 const Code = styled.div`
   margin: 13px;
   font-family: Courier New, Consolas, Monaco, Lucida Console;
@@ -117,28 +100,36 @@ const Textbox = styled.textarea`
 function TestsView() {
     const { dispatch, state: { queries, apolloServerURI }} = useContext(Store);
     
+    //Gets the new HttpLink when state is updated 
+    //note: initial state is localhost:3000/GraphQL 
     const link = new HttpLink({
         uri: apolloServerURI
       })
-      
+      //Creates a new ApolloClient connection using the link above 
       const client = new ApolloClient({
         cache: new InMemoryCache(),
         link: link
       });
 
+      //Add the query to state 
     function addQuery() {
+      //"q" represents the user defined query 
         let q = document.getElementById("query").value;
+        //"r" represents the response from the GraphQL endpoint
         let r;
 
-        //creates query to graphQL enpoint
-        //saves stringified result to state in the "queries" array
-        //writes response from GraphQL to "Response" text box in DOM
+        //packages and sends query to send to the graphQL enpoint through the client established above        
         client.query({
             query: gql`${q}`
         }).then(result => {;
             console.log('apollo server result: ',result);
+            //saves stringified result to state in the "queries" array
             r = JSON.stringify(result.data);
+            //writes response from GraphQL to "Response" text box in DOM
             document.getElementById("response").value = r;
+            //FOR FUTURE IMPLEMENTATION we determine the entirety of the data that is sent in a response and parse accordingly
+            //currently we only use "data" to update r"
+            //updating state
             dispatch({ type: UPDATE_QUERIES, payload: [[q], [r]] });
         })
         
@@ -149,6 +140,8 @@ function TestsView() {
         dispatch({ type: ADD_APOLLO_SERVER_URI, payload: url });
         console.log('test updateURL', apolloServerURI);
     }
+    //FOR FUTURE IMPLEMENTATION: Check the user input and maybe ping the endpoint to check that it is live. 
+
 
     return(
         <div>
@@ -162,13 +155,14 @@ function TestsView() {
               <div style={{ width: "95%", marginLeft: "auto", marginRight: "auto" }}>
               <Button onClick={addQuery}>Add Query</Button>
                 <Button onClick={(e) => {
+                  //Electron meathod to initiate the export dialog. 
                     ipc.send('show-test-export-dialog',queries)
                 }}> Export Tests </Button>
                 <p>{console.log("queries: ",queries)}</p>
             </div>
             </Column>
             <Column style={{ gridColumn: "1 / 3", gridRow: "3 / span 1" }}>
-                  <Title>Apollo Server URL</Title>
+                  <Title>GraphQL Endpoint URL</Title>
                   <Input type='text' id='url' placeholder='Enter URL here'></Input><Button style={{ width: "20%" }} onClick={updateURL}>Add URL</Button>
               </Column>
           </Code>
diff --git a/src/schema.js b/src/schema.js
diff --git a/src/state/initialState.jsx b/src/state/initialState.jsx
@@ -73,9 +73,10 @@ export const gqlResolvers = `const pool = require('../db/sqlPool');\n\nmodule.ex
 
 export const sqlScripts = ``;
 
+//An array of arrays index 0 is the queries. index 1 is the responses to the queries 
 export const queries = [[], []];
 
-export const displayError = { displayStatus: false, throttleStatus: true, relatedTable: -1, relatedField: -1 };
-
 // stores the Apollo server URI input by the user in tests view
 export const apolloServerURI = 'http://localhost:3000/GraphQL';
+
+export const displayError = { displayStatus: false, throttleStatus: true, relatedTable: -1, relatedField: -1 };
diff --git a/src/state/store.jsx b/src/state/store.jsx
diff --git a/src/utils/buildExportTestSuite.js b/src/utils/buildExportTestSuite.js

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+/* This is just a reference file not actually imported anywhere */`
	`2`	`+`
`1`	`3`	`/* Coolors Exported Palette - coolors.co/b7cadc-e5e7e9-324353-fefefe-dd399c */`
`2`	`4`
`3`	`5`	`/* HSL */`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+<!--This file does not appear to be necessary for electron at least-->`
	`2`	`+`
`1`	`3`	`<!DOCTYPE html>`
`2`	`4`	`<html>`
`3`	`5`	`<head>`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// This is also the readme.`
	`2`	`+`
`1`	`3`	`/* eslint-disable no-unused-vars */`
`2`	`4`	`import React, { useContext } from "react";`
`3`	`5`	`import {`