@stepzen/graphiql-proxy 0.20.0-beta.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# @stepzen/graphiql-proxy

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@stepzen/graphiql-proxy",
+  "version": "0.20.0-beta.2",
+  "author": "Darren Waddell <darren@stepzen.com>",
+  "license": "MIT",
+  "homepage": "https://stepzen.com",
+  "files": [
+    "/src/server",
+    "/src/ui/build"
+  ],
+  "engines": {
+    "node": ">=14.0.1",
+    "npm": ">=6.14"
+  },
+  "main": "src/server",
+  "scripts": {
+    "dev:server": "nodemon src/dev --watch src/dev --watch src/server",
+    "dev:ui": "cd src/ui && REACT_APP_IS_DEVELOPMENT=1 npm start",
+    "prepack": "cd src/ui && npm run build",
+    "prepare": "cd src/ui && npm install",
+    "start": "concurrently \"npm run dev:server\" \"npm run dev:ui\"",
+    "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "posttest": "prettier . --check"
+  },
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "cors": "^2.8.5",
+    "cross-spawn": "^7.0.3",
+    "debug": "^4.3.4",
+    "express": "^4.17.3",
+    "express-promise-router": "^4.1.1",
+    "node-fetch": "^2.6.7",
+    "open": "^8.4.0",
+    "prettier": "^2.6.2"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.2.12",
+    "@types/cors": "^2.8.10",
+    "@types/cross-spawn": "^6.0.2",
+    "@types/debug": "^4.1.6",
+    "@types/express": "^4.17.9",
+    "@types/glob": "^7.2.0",
+    "@types/license-checker": "^25.0.1",
+    "@types/mocha": "^5.2.7",
+    "@types/node-fetch": "^2.5.7",
+    "@types/sinon-chai": "3.2.8",
+    "chai": "^4.2.0",
+    "concurrently": "^6.0.2",
+    "dotenv": "^8.2.0",
+    "fancy-test": "^1.4.10",
+    "license-checker": "^25.0.1",
+    "mocha": "^5.2.0",
+    "nock": "^13.0.4",
+    "nodemon": "^2.0.7",
+    "nyc": "^14.1.1",
+    "sinon": "13.0.1",
+    "sinon-chai": "3.7.0",
+    "ts-node": "^10.8.2"
+  },
+  "gitHead": "91f8c64c009806c94de0495c45dc5d9e6015787d"
+}

package/src/server/api/debugging.js

@@ -0,0 +1,19 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+const debugging = async (req, res) => {
+  const {debugging} = req.stepzen
+
+  if (req.method === 'POST') {
+    const {enabled} = req.body
+
+    if (debugging.enabled !== enabled) {
+      debugging.onToggleDebugging()
+    }
+
+    debugging.enabled = enabled
+  }
+
+  res.json(debugging)
+}
+
+module.exports = debugging

package/src/server/api/details.js

@@ -0,0 +1,15 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+const details = async (req, res) => {
+  const {account, domain, predicates, workspace} = req.stepzen
+
+  const endpoint = `https://${account}.${domain}/${workspace.endpoint}/__graphql`
+
+  res.json({
+    endpoint,
+    predicates,
+    workspace,
+  })
+}
+
+module.exports = details

package/src/server/api/ping.js

@@ -0,0 +1,9 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+const ping = async (req, res) => {
+  res.json({
+    status: 'ok',
+  })
+}
+
+module.exports = ping

package/src/server/api/predicates.js

@@ -0,0 +1,23 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+const predicates = async (req, res) => {
+  const {predicates} = req.stepzen
+
+  if (req.method === 'POST') {
+    const {enabled, headers} = req.body
+
+    predicates.headers = headers
+
+    if (predicates.enabled !== enabled) {
+      predicates.onTogglePredicates()
+    }
+
+    predicates.enabled = enabled
+  }
+
+  res.json({
+    predicates,
+  })
+}
+
+module.exports = predicates

package/src/server/api/proxy.js

@@ -0,0 +1,59 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+const debug = require('debug')
+const fetch = require('node-fetch')
+
+const {version} = require('../../../package.json')
+
+const proxy = async (req, res) => {
+  const {account, adminkey, debugging, domain, predicates, workspace} =
+    req.stepzen
+
+  let endpoint = workspace.endpoint
+
+  let headers = {}
+
+  if (predicates.available && predicates.enabled) {
+    try {
+      const others = JSON.parse(JSON.stringify(predicates.headers))
+      headers = {
+        ...others,
+      }
+    } catch {}
+  } else {
+    headers = {
+      Authorization: `Apikey ${adminkey}`,
+    }
+  }
+
+  if (debugging.enabled) {
+    headers = {
+      'StepZen-Debug-Level': 1,
+      ...headers,
+    }
+  }
+
+  const url = `https://${account}.${domain.replace(
+    '.io',
+    '.net',
+  )}/${endpoint}/__graphql`
+
+  debug('stepzen:dashboard')(`proxy headers: ${JSON.stringify(headers)}`)
+  debug('stepzen:dashboard')(`proxy url: ${url}`)
+
+  const response = await fetch(url, {
+    body: JSON.stringify(req.body),
+    headers: {
+      ...headers,
+      'Content-Type': 'application/json',
+      'stepzen-cli-version': version,
+      'user-agent': `stepzen-cli/${version}`,
+    },
+    method: 'POST',
+  })
+  const json = await response.json()
+
+  res.json(json)
+}
+
+module.exports = proxy

package/src/server/api/samples.js

@@ -0,0 +1,26 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+const fs = require('fs')
+const prettier = require('prettier')
+
+const samples = async (req, res) => {
+  const {workspace} = req.stepzen
+
+  const folder = workspace.schema
+  const file = `${workspace.schema}/sample-queries.graphql`
+
+  if (!fs.existsSync(folder) || !fs.existsSync(file)) {
+    return res.json({
+      samples: false,
+    })
+  }
+
+  const samples = fs.readFileSync(file, 'utf8')
+  const formatted = prettier.format(samples, {parser: 'graphql'})
+
+  return res.json({
+    samples: formatted,
+  })
+}
+
+module.exports = samples

package/src/server/index.js

@@ -0,0 +1,100 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+const cors = require('cors')
+const debug = require('debug')
+const express = require('express')
+const fs = require('fs')
+const router = require('express-promise-router')()
+
+const openBrowser = require('./utils/open-browser')
+
+const _debugging = require('./api/debugging')
+const details = require('./api/details')
+const ping = require('./api/ping')
+const _predicates = require('./api/predicates')
+const proxy = require('./api/proxy')
+const samples = require('./api/samples')
+
+module.exports = async ({
+  account,
+  adminkey,
+  apikey,
+  cli = {version: ''},
+  domain = 'stepzen.io',
+  port = 5000,
+  predicates = {
+    available: false,
+    enabled: false,
+    onTogglePredicates: async () => {},
+  },
+  debugging = {
+    enabled: false,
+    onToggleDebugging: async () => {},
+  },
+  workspace,
+}) => {
+  const app = express()
+
+  app.use(express.json())
+  app.use(cors())
+
+  app.use(express.static(`${__dirname}/../ui/build`))
+  app.use((req, res, next) => {
+    req.stepzen = {
+      account,
+      adminkey,
+      apikey,
+      cli,
+      debugging,
+      domain,
+      predicates,
+      workspace,
+    }
+    next()
+  })
+
+  router.all('/api/predicates', _predicates)
+  router.all('/api/debugging', _debugging)
+  router.get('/api/details', details)
+  router.get('/api/ping', ping)
+  router.get('/api/samples', samples)
+  router.post('*', proxy)
+
+  const dashboard = fs.readFileSync(
+    `${__dirname}/../ui/build/index.html`,
+    'utf8',
+  )
+  router.get('*', (req, res) => res.send(dashboard))
+
+  // generic failsafe error handler
+  // (to avoid printing 'unhandled promise rejection' errors to the console)
+  router.use((err, req, res, next) => {
+    debug('stepzen:dashboard')('router error', err)
+
+    err.statusCode = err.statusCode || 500
+    err.status = err.status || 'error'
+
+    res.status(err.statusCode).json({
+      status: err.status,
+      message: err.message,
+    })
+  })
+
+  app.use(router)
+
+  const open = () =>
+    openBrowser(`http://localhost:${port}/${workspace.endpoint}`)
+
+  const start = async () =>
+    new Promise(resolve => {
+      let server = app.listen(port, () => {
+        resolve(server)
+      })
+    })
+
+  return {
+    app,
+    open,
+    start,
+  }
+}

package/src/server/utils/open-browser.js

@@ -0,0 +1,144 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+// Original code from https://github.com/facebook/create-react-app/blob/0f6fc2bc71d78f0dcae67f3f08ce98a42fc0a57c/packages/react-dev-utils/openChrome.applescript
+
+const chalk = require('chalk')
+const {execSync} = require('child_process')
+const open = require('open')
+const spawn = require('cross-spawn')
+
+// https://github.com/sindresorhus/open#app
+const OSX_CHROME = 'google chrome'
+
+const Actions = Object.freeze({
+  NONE: 0,
+  BROWSER: 1,
+  SCRIPT: 2,
+})
+
+function getBrowserEnv() {
+  // Attempt to honor this environment variable.
+  // It is specific to the operating system.
+  // See https://github.com/sindresorhus/open#app for documentation.
+  const value = process.env.BROWSER
+  const args = process.env.BROWSER_ARGS
+    ? process.env.BROWSER_ARGS.split(' ')
+    : []
+  let action
+  if (!value) {
+    // Default.
+    action = Actions.BROWSER
+  } else if (value.toLowerCase().endsWith('.js')) {
+    action = Actions.SCRIPT
+  } else if (value.toLowerCase() === 'none') {
+    action = Actions.NONE
+  } else {
+    action = Actions.BROWSER
+  }
+  return {action, value, args}
+}
+
+function executeNodeScript(scriptPath, url) {
+  const extraArgs = process.argv.slice(2)
+  const child = spawn(process.execPath, [scriptPath, ...extraArgs, url], {
+    stdio: 'inherit',
+  })
+  child.on('close', code => {
+    if (code !== 0) {
+      console.log()
+      console.log(
+        chalk.red(
+          'The script specified as BROWSER environment variable failed.',
+        ),
+      )
+      console.log(chalk.cyan(scriptPath) + ' exited with code ' + code + '.')
+      console.log()
+    }
+  })
+  return true
+}
+
+function startBrowserProcess(browser, url, args) {
+  // If we're on OS X, the user hasn't specifically
+  // requested a different browser, we can try opening
+  // Chrome with AppleScript. This lets us reuse an
+  // existing tab when possible instead of creating a new one.
+  const shouldTryOpenChromiumWithAppleScript =
+    process.platform === 'darwin' &&
+    (typeof browser !== 'string' || browser === OSX_CHROME)
+
+  if (shouldTryOpenChromiumWithAppleScript) {
+    // Will use the first open browser found from list
+    const supportedChromiumBrowsers = [
+      'Google Chrome Canary',
+      'Google Chrome',
+      'Microsoft Edge',
+      'Brave Browser',
+      'Vivaldi',
+      'Chromium',
+    ]
+
+    for (const chromiumBrowser of supportedChromiumBrowsers) {
+      try {
+        // Try our best to reuse existing tab
+        // on OSX Chromium-based browser with AppleScript
+        execSync('ps cax | grep "' + chromiumBrowser + '"')
+        execSync(
+          `osascript ${__dirname}/open-chrome.applescript "` +
+            encodeURI(url) +
+            '" "' +
+            chromiumBrowser +
+            '"',
+          {
+            cwd: __dirname,
+            stdio: 'ignore',
+          },
+        )
+        return true
+      } catch (error) {
+        // Ignore errors.
+      }
+    }
+  }
+
+  // Another special case: on OS X, check if BROWSER has been set to "open".
+  // In this case, instead of passing `open` to `opn` (which won't work),
+  // just ignore it (thus ensuring the intended behavior, i.e. opening the system browser):
+  // https://github.com/facebook/create-react-app/pull/1690#issuecomment-283518768
+  if (process.platform === 'darwin' && browser === 'open') {
+    browser = undefined
+  }
+
+  // If there are arguments, they must be passed as array with the browser
+  if (typeof browser === 'string' && args.length > 0) {
+    browser = [browser].concat(args)
+  }
+
+  // Fallback to open
+  // (It will always open new tab)
+  try {
+    const options = {app: browser, wait: false, url: true}
+    open(url, options).catch(() => null) // Prevent `unhandledRejection` error.
+    return true
+  } catch (error) {
+    return false
+  }
+}
+
+// Reads the BROWSER environment variable and decides what to do with it. Returns
+// true if it opened a browser or ran a node.js script, otherwise false.
+function openBrowser(url) {
+  const {action, value, args} = getBrowserEnv()
+  switch (action) {
+    case Actions.NONE:
+      // Special case: BROWSER="none" will prevent opening completely.
+      return false
+    case Actions.SCRIPT:
+      return executeNodeScript(value, url)
+    case Actions.BROWSER:
+      return startBrowserProcess(value, url, args)
+    default:
+      throw new Error('Not implemented.')
+  }
+}
+
+module.exports = openBrowser

package/src/server/utils/open-chrome.applescript

@@ -0,0 +1,93 @@
+(*
+Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+Original code from https://github.com/facebook/create-react-app/blob/0f6fc2bc71d78f0dcae67f3f08ce98a42fc0a57c/packages/react-dev-utils/openChrome.applescript
+*)
+
+property targetTab: null
+property targetTabIndex: -1
+property targetWindow: null
+property theProgram: "Google Chrome"
+
+on run argv
+  set theURL to item 1 of argv
+
+  -- Allow requested program to be optional,
+  -- default to Google Chrome
+  if (count of argv) > 1 then
+    set theProgram to item 2 of argv
+  end if
+
+  using terms from application "Google Chrome"
+    tell application theProgram
+
+      if (count every window) = 0 then
+        make new window
+      end if
+
+      -- 1: Looking for tab running debugger
+      -- then, Reload debugging tab if found
+      -- then return
+      set found to my lookupTabWithUrl(theURL)
+      if found then
+        set targetWindow's active tab index to targetTabIndex
+        tell targetTab to reload
+        tell targetWindow to activate
+        set index of targetWindow to 1
+        return
+      end if
+
+      -- 2: Looking for Empty tab
+      -- In case debugging tab was not found
+      -- We try to find an empty tab instead
+      set found to my lookupTabWithUrl("chrome://newtab/")
+      if found then
+        set targetWindow's active tab index to targetTabIndex
+        set URL of targetTab to theURL
+        tell targetWindow to activate
+        return
+      end if
+
+      -- 3: Create new tab
+      -- both debugging and empty tab were not found
+      -- make a new tab with url
+      tell window 1
+        activate
+        make new tab with properties {URL:theURL}
+      end tell
+    end tell
+  end using terms from
+end run
+
+-- Function:
+-- Lookup tab with given url
+-- if found, store tab, index, and window in properties
+-- (properties were declared on top of file)
+on lookupTabWithUrl(lookupUrl)
+  using terms from application "Google Chrome"
+    tell application theProgram
+      -- Find a tab with the given url
+      set found to false
+      set theTabIndex to -1
+      repeat with theWindow in every window
+        set theTabIndex to 0
+        repeat with theTab in every tab of theWindow
+          set theTabIndex to theTabIndex + 1
+          if (theTab's URL as string) contains lookupUrl then
+            -- assign tab, tab index, and window to properties
+            set targetTab to theTab
+            set targetTabIndex to theTabIndex
+            set targetWindow to theWindow
+            set found to true
+            exit repeat
+          end if
+        end repeat
+
+        if found then
+          exit repeat
+        end if
+      end repeat
+    end tell
+  end using terms from
+  return found
+end lookupTabWithUrl

package/src/ui/README.md

@@ -0,0 +1,72 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+Note: `npm start` runs two sub-commands simultaneously, `npm run dev:ui` and `npm run dev:server`. If you wish to run these processes separately, you can also run these command separately.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+### Code Splitting
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
+
+### Analyzing the Bundle Size
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
+
+### Making a Progressive Web App
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
+
+### Advanced Configuration
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
+
+### Deployment
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
+
+### `npm run build` fails to minify
+
+This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)