From e71be29d2904a92777c8fa72b8f816d9b0af715d Mon Sep 17 00:00:00 2001 From: Carina Ursu Date: Thu, 14 Apr 2022 15:19:16 -0700 Subject: [PATCH] feat: cleanup Signed-off-by: Carina Ursu --- CONTRIBUTING.md | 19 ------------------- Dockerfile | 2 +- README.md | 24 ------------------------ corsProxy.js | 49 ------------------------------------------------- index.js | 2 -- 5 files changed, 1 insertion(+), 95 deletions(-) delete mode 100644 corsProxy.js diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8e9e0482..f0c5e563a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -134,25 +134,6 @@ asdf install yarn install ``` -## CORS Proxying: Recommended Setup - -In the common hosting arrangement, all API requests will be to the same origin -serving the client application, making CORS unnecessary. However, if you would like -to setup your local dev enviornment to target a FlyteAdmin service running on a different -domain you will need to configure your enviornment to support CORS. One example would be -hosting the Admin API on a different domain than the console. Another example is -when fetching execution data from external storage such as S3. - -The fastest (recommended) way to setup a CORS solution is to do so within the browser. -If you would like to handle this at the Node level you will need to disable authentication -(see below). - -_NOTE:_ Do not configure for both browser and Node solutions. - -These instructions require using Google Chrome. You will also need to identify the -URL of your target FlyteAdmin API instance. These instructions will use -`https://different.admin.service.com` as an example. - 1. Set `ADMIN_API_URL` and `ADMIN_API_USE_SSL` ``` diff --git a/Dockerfile b/Dockerfile index 693a34687..10bff339a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -17,7 +17,7 @@ RUN : \ # build && make build_prod \ # place the runtime application in /app - && mv dist corsProxy.js index.js env.js plugins.js /app + && mv dist index.js env.js plugins.js /app FROM gcr.io/distroless/nodejs LABEL org.opencontainers.image.source https://github.com/lyft/flyteconsole diff --git a/README.md b/README.md index e8f5f0b90..c047de553 100644 --- a/README.md +++ b/README.md @@ -88,10 +88,6 @@ For help with installing dependencies look into `/api/v1` and `/console` for example). For local development, this is usually not needed, so the default behavior is to run without a prefix. -* `CORS_PROXY_PREFIX` (default: `/cors_proxy`) - - Sets the local endpoint for [CORS request proxying](CONTRIBUTING.md#cors-proxying-recommended-setup). - ### Running from docker image as localhost To run flyteconsole directly from your docker image as localhost you must set a @@ -140,26 +136,6 @@ For continious development we are using: More info on each section could be found at [CONTRIBUTING.md](CONTRIBUTING.md) -### CORS Proxying: Recommended setup - -In the common hosting arrangement, all API requests will be to the same origin -serving the client application, making CORS unnecessary. However, if you would like -to setup your local dev enviornment to target a FlyteAdmin service running on a different -domain you will need to configure your enviornment support CORS. One example would be -hosting the Admin API on a different domain than the console. Another example is -when fetching execution data from external storage such as S3. - -The fastest (recommended) way to setup a CORS solution is to do so within the browser. -If you would like to handle this at the Node level you will need to disable authentication -(see below) - -> Do not configure for both browser and Node solutions. - -These instructions require using Google Chrome. You will also need to identify the -URL of your target FlyteAdmin API instance. These instructions will use -`https://different.admin.service.com` as an example. - - * Set `ADMIN_API_URL` and `ADMIN_API_USE_SSL` ```bash diff --git a/corsProxy.js b/corsProxy.js deleted file mode 100644 index 3ddfdfe94..000000000 --- a/corsProxy.js +++ /dev/null @@ -1,49 +0,0 @@ -const http = require('http'); -const https = require('https'); -const url = require('url'); - -/** Mounts a proxy at `basePath` such that requests of the form - * `${basePath}/http://www.example.com?queryString=value` will be converted to - * `http://www.example.com?queryString=value`, preserving any request headers. - * The response is piped directly to the client with no processing. - */ -module.exports = function corsProxy(basePath) { - const pathOffset = basePath.length; - return function (req, res, next) { - const pathIndex = req.url.indexOf(basePath); - // base path doesn't match, ignore - if (pathIndex < 0) { - return next(); - } - - const targetUrl = req.url.substring(pathIndex + pathOffset + 1); - const config = url.parse(targetUrl); - config.method = req.method; - - // We need to use a different request class depending on the - // protocol - const handler = config.protocol === 'https:' ? https : http; - - const proxyReq = handler.request(config, function (proxyRes) { - res.writeHead(proxyRes.statusCode, proxyRes.headers); - proxyRes.pipe(res, { - end: true, - }); - }); - - proxyReq.on('error', (err) => res.status(500).send(err)); - - // Copy over all headers except for 'Host', since that value would - // point to *this* server, and not the remote server. - Object.keys(req.headers).forEach((key) => { - if (key.toLowerCase() === 'host') { - return; - } - proxyReq.setHeader(key, req.headers[key]); - }); - - req.pipe(proxyReq, { - end: true, - }); - }; -}; diff --git a/index.js b/index.js index fd487f746..b25891527 100644 --- a/index.js +++ b/index.js @@ -8,7 +8,6 @@ const morgan = require('morgan'); const express = require('express'); const env = require('./env'); const { applyMiddleware } = require('./plugins'); -const corsProxy = require('./corsProxy.js'); const app = express(); @@ -16,7 +15,6 @@ const app = express(); app.use(morgan('combined')); app.use(express.json()); app.get(`${env.BASE_URL}/healthz`, (_req, res) => res.status(200).send()); -app.use(corsProxy(`${env.BASE_URL}${env.CORS_PROXY_PREFIX}`)); if (typeof applyMiddleware === 'function') { console.log('Found middleware plugins, applying...');