mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-15 17:31:56 +03:00
504f13725f
> High-Level TODO: * [x] Code Changes * [x] Tests * [x] Check that pro/multitenant build ok * [x] Documentation Changes * [x] Updating this PR with full details * [ ] Reviews * [ ] Ensure code has all FIXMEs and TODOs addressed * [x] Ensure no files are checked in mistakenly * [x] Consider impact on console, cli, etc. ### Description > This PR adds support for adding set-cookie header on the response from the auth webhook. If the set-cookie header is sent by the webhook, it will be forwarded in the graphQL engine response. Fixes a bug in test-server.sh: testing of get-webhook tests was done by POST method and vice versa. To fix, the parameters were swapped. ### Changelog - [x] `CHANGELOG.md` is updated with user-facing content relevant to this PR. ### Affected components - [x] Server - [ ] Console - [ ] CLI - [x] Docs - [ ] Community Content - [ ] Build System - [x] Tests - [ ] Other (list it) ### Related Issues -> Closes [#2269](https://github.com/hasura/graphql-engine/issues/2269) ### Solution and Design > ### Steps to test and verify > Please refer to the docs to see how to send the set-cookie header from webhook. ### Limitations, known bugs & workarounds > - Support for only set-cookie header forwarding is added - the value forwarded in the set-cookie header cannot be validated completely, the [Cookie](https://hackage.haskell.org/package/cookie) package has been used to parse the header value and any unnecessary information is stripped off before forwarding the header. The standard given in [RFC6265](https://datatracker.ietf.org/doc/html/rfc6265) has been followed for the Set-Cookie format. ### Server checklist #### Catalog upgrade Does this PR change Hasura Catalog version? - [x] No - [ ] Yes - [ ] Updated docs with SQL for downgrading the catalog #### Metadata Does this PR add a new Metadata feature? - [x] No #### GraphQL - [x] No new GraphQL schema is generated - [ ] New GraphQL schema is being generated: - [ ] New types and typenames are correlated #### Breaking changes - [x] No Breaking changes PR-URL: https://github.com/hasura/graphql-engine-mono/pull/2538 Co-authored-by: Robert <132113+robx@users.noreply.github.com> GitOrigin-RevId: d9047e997dd221b7ce4fef51911c3694037e7c3f
145 lines
5.3 KiB
Python
145 lines
5.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
Helper module which exposes abstractions to write webservers easily
|
|
"""
|
|
|
|
from abc import ABC, abstractmethod
|
|
import socket
|
|
import http.server as http
|
|
from http import HTTPStatus
|
|
from urllib.parse import parse_qs, urlparse
|
|
import json
|
|
|
|
|
|
class Response():
|
|
""" Represents a HTTP `Response` object """
|
|
def __init__(self, status, body=None, headers=None):
|
|
if not isinstance(status, HTTPStatus):
|
|
raise TypeError('status has to be of type http.HTTPStatus')
|
|
if body and not isinstance(body, (str, dict)):
|
|
raise TypeError('body has to be of type str or dict')
|
|
if headers and not (isinstance(headers, (list, dict))):
|
|
raise TypeError('headers has to be of type list or dict')
|
|
self.status = status
|
|
self.body = body
|
|
self.headers = headers
|
|
|
|
def get_body(self):
|
|
if not self.body:
|
|
return ''
|
|
if isinstance(self.body, dict):
|
|
return json.dumps(self.body)
|
|
return self.body
|
|
|
|
class Request():
|
|
""" Represents a HTTP `Request` object """
|
|
def __init__(self, path, qs=None, body=None, json=None, headers=None):
|
|
self.path = path
|
|
self.qs = qs
|
|
self.body = body
|
|
self.json = json
|
|
self.headers = headers
|
|
|
|
|
|
class RequestHandler(ABC):
|
|
"""
|
|
The class that users should sub-class and provide implementation. Each of
|
|
these functions **should** return an instance of the `Response` class
|
|
"""
|
|
@abstractmethod
|
|
def get(self, request):
|
|
pass
|
|
@abstractmethod
|
|
def post(self, request):
|
|
pass
|
|
|
|
|
|
def MkHandlers(handlers):
|
|
class HTTPHandler(http.BaseHTTPRequestHandler):
|
|
def not_found(self):
|
|
self.send_response(HTTPStatus.NOT_FOUND)
|
|
self.end_headers()
|
|
self.wfile.write('<h1> Not Found </h1>'.encode('utf-8'))
|
|
|
|
def parse_path(self):
|
|
return urlparse(self.path)
|
|
|
|
def append_headers(self, headers):
|
|
if isinstance(headers, dict):
|
|
for k, v in headers.items():
|
|
self.send_header(k, v)
|
|
# Duplicate headers can be sent as a list of pairs
|
|
if isinstance(headers, list):
|
|
for (k, v) in headers:
|
|
self.send_header(k, v)
|
|
|
|
def do_GET(self):
|
|
try:
|
|
raw_path = self.parse_path()
|
|
path = raw_path.path
|
|
handler = handlers[path]()
|
|
qs = parse_qs(raw_path.query)
|
|
req = Request(path, qs, None, None, self.headers)
|
|
resp = handler.get(req)
|
|
self.send_response(resp.status)
|
|
if resp.headers:
|
|
self.append_headers(resp.headers)
|
|
self.end_headers()
|
|
self.wfile.write(resp.get_body().encode('utf-8'))
|
|
except KeyError:
|
|
self.not_found()
|
|
|
|
def do_POST(self):
|
|
try:
|
|
raw_path = self.parse_path()
|
|
path = raw_path.path
|
|
handler = handlers[path]()
|
|
content_len = self.headers.get('Content-Length')
|
|
qs = None
|
|
req_body = self.rfile.read(int(content_len)).decode("utf-8")
|
|
req_json = None
|
|
if self.headers.get('Content-Type') == 'application/json':
|
|
req_json = json.loads(req_body)
|
|
req = Request(self.path, qs, req_body, req_json, self.headers)
|
|
resp = handler.post(req)
|
|
self.send_response(resp.status)
|
|
if resp.headers:
|
|
self.append_headers(resp.headers)
|
|
#Required for graphiql to work with the graphQL test server
|
|
self.send_header('Access-Control-Allow-Origin', self.headers['Origin'])
|
|
self.send_header('Access-Control-Allow-Credentials', 'true')
|
|
self.send_header('Access-Control-Allow-Methods', 'GET,POST,PUT,PATCH,DELETE,OPTIONS')
|
|
self.end_headers()
|
|
self.wfile.write(resp.get_body().encode('utf-8'))
|
|
except KeyError:
|
|
self.not_found()
|
|
|
|
def do_OPTIONS(self):
|
|
self.send_response(204)
|
|
#Required for graphiql to work with the graphQL test server
|
|
self.send_header('Access-Control-Allow-Methods', 'GET, POST, OPTIONS')
|
|
self.send_header('Access-Control-Max-Age', '1728000')
|
|
self.send_header('Access-Control-Allow-Headers', 'content-type,x-apollo-tracing')
|
|
self.send_header('Content-Type', 'text/plain charset=UTF-8')
|
|
self.send_header('Access-Control-Allow-Credentials', 'true')
|
|
self.send_header('Access-Control-Allow-Origin', self.headers['Origin'])
|
|
self.send_header('Access-Control-Allow-Methods', 'GET,POST,PUT,PATCH,DELETE,OPTIONS')
|
|
self.end_headers()
|
|
|
|
def log_message(self, format, *args):
|
|
return
|
|
|
|
return HTTPHandler
|
|
|
|
|
|
class WebServer(http.HTTPServer):
|
|
def __init__(self, server_address, handler):
|
|
super().__init__(server_address, handler)
|
|
|
|
def server_bind(self):
|
|
print('Running http server on {0}:{1}'.format(self.server_address[0],
|
|
self.server_address[1]))
|
|
self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
|
self.socket.bind(self.server_address)
|