diff --git a/.clang-format b/.clang-format new file mode 100644 index 00000000..6959bdf7 --- /dev/null +++ b/.clang-format @@ -0,0 +1,8 @@ +BasedOnStyle: LLVM +IndentWidth: 4 + +BinPackArguments: false +BinPackParameters: false + +ExperimentalAutoDetectBinPacking: false +AllowAllParametersOfDeclarationOnNextLine: false diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000..3adb7469 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,16 @@ +.python-version +.gitignore +.clang-format +README.md +setup.py + +.benchmarks +.git/ +.github/ +.pytest_cache/ +assets/ +docs/ +pg_graphql.egg-info/ +site/ +venv/ + diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..f762deac --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +results/ +.python-version +venv/ +site/ +regression.* +__pycache__/ +*.egg-info/ diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..74fbc219 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,22 @@ +FROM postgres:13 + +RUN apt-get update +RUN apt-get install build-essential git cmake curl -y +RUN apt-get install postgresql-server-dev-13 -y +# Required by libgraphql +RUN apt-get install python2 -y +RUN curl https://bootstrap.pypa.io/pip/2.7/get-pip.py --output get-pip.py +RUN python2 get-pip.py +RUN pip install ctypesgen + +RUN git clone https://github.com/graphql/libgraphqlparser.git \ + && cd libgraphqlparser \ + && cmake . \ + && make install + +ENV LD_LIBRARY_PATH="/usr/local/lib:${PATH}" +#ENV PATH="/usr/local/lib:${PATH}" + +COPY . pg_graphql +WORKDIR pg_graphql +RUN make install diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..8c33ac14 --- /dev/null +++ b/LICENSE @@ -0,0 +1,190 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2021 Supabase + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..bd9d0df9 --- /dev/null +++ b/Makefile @@ -0,0 +1,12 @@ +EXTENSION = pg_net +DATA = $(wildcard sql/*--*.sql) + +#PG_LDFLAGS= -I/usr/local/lib/libgraphqlparser.so +PG_CONFIG = pg_config +SHLIB_LINK = -lgraphqlparser + +MODULE_big = pg_net +OBJS = src/worker.o + +PGXS := $(shell $(PG_CONFIG) --pgxs) +include $(PGXS) diff --git a/README.md b/README.md new file mode 100644 index 00000000..97d36baa --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# `pg_net` + +

+ +PostgreSQL version +License +Tests + +

+ +--- + +**Documentation**: https://supabase.github.io/pg_net + +**Source Code**: https://github.com/supabase/pg_net + +--- + +pg_net is a PostgreSQL extension exposing a SQL interface for async networking with a focus on scalability and UX. + +Features: + +- async http GET requests +- async http POST requests with a JSON payload diff --git a/pg_net.control b/pg_net.control new file mode 100644 index 00000000..d6ac1f2e --- /dev/null +++ b/pg_net.control @@ -0,0 +1,3 @@ +comment = 'Async HTTP' +default_version = '0.1' +relocatable = false diff --git a/setup.py b/setup.py new file mode 100644 index 00000000..4842e4f3 --- /dev/null +++ b/setup.py @@ -0,0 +1,51 @@ +#!/usr/bin/env python + +"""Setup script for the package.""" + +import sys + +import setuptools + +PACKAGE_NAME = "pg_graphql" +MINIMUM_PYTHON_VERSION = "3.6" + + +def check_python_version(): + """Exit when the Python version is too low.""" + if sys.version < MINIMUM_PYTHON_VERSION: + sys.exit("Python {0}+ is required.".format(MINIMUM_PYTHON_VERSION)) + + +check_python_version() + + +DEV_REQUIRES = [ + "pytest", + "pytest-benchmark", + "pre-commit", + "pylint", + "black", + "psycopg2", + "sqlalchemy", + "pre-commit", +] + + +setuptools.setup( + name="pg_graphql", + version="0.0.1", + #packages=setuptools.find_packages("src/python", exclude=("tests",)), + #package_dir={"": "src/python"}, + classifiers=[ + "Development Status :: 4 - Beta", + "Natural Language :: English", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + ], + install_requires=DEV_REQUIRES, +) diff --git a/sql/pg_net--0.1.sql b/sql/pg_net--0.1.sql new file mode 100644 index 00000000..88f536a0 --- /dev/null +++ b/sql/pg_net--0.1.sql @@ -0,0 +1,14 @@ +create schema if not exists net; + +create or replace function net.sql_to_ast(text) returns text +as 'pg_net' +language C strict; + + +create or replace function net.parse(text) returns text +as 'pg_net' +language C strict; + + +grant all on schema net to postgres; +grant all on all tables in schema net to postgres; diff --git a/src/worker.c b/src/worker.c new file mode 100644 index 00000000..310c47fa --- /dev/null +++ b/src/worker.c @@ -0,0 +1,64 @@ +// clang-format off +#include "postgres.h" +// clang-format on +#include "graphqlparser/c/GraphQLParser.h" +#include "tcop/utility.h" +#include "miscadmin.h" +#include "utils/varlena.h" +#include "utils/acl.h" + +#include "parser/parser.h" +#include "utils/builtins.h" +#include "nodes/print.h" + +#define PG13_GTE (PG_VERSION_NUM >= 130000) + +// required macro for extension libraries to work +PG_MODULE_MAGIC; + +PG_FUNCTION_INFO_V1(sql_to_ast); + +Datum sql_to_ast(PG_FUNCTION_ARGS) { + // Read argument 0 from the sql function call as text + // and convert to a c string + char *query = text_to_cstring(PG_GETARG_TEXT_PP(0)); + List *tree; + char *tree_str; + char *tree_str_pretty; + text *t; + + // List of AST node as c structs + tree = raw_parser(query); + // Compact stringified AST + tree_str = nodeToString(tree); + // Stringified AST with space for readability + tree_str_pretty = pretty_format_node_dump(tree_str); + // Convert back to a postgres text type + t = cstring_to_text(tree_str_pretty); + + pfree(tree); + pfree(tree_str); + pfree(tree_str_pretty); + + // Return the text from the sql function + PG_RETURN_TEXT_P(t); +} + +PG_FUNCTION_INFO_V1(parse); + +Datum parse(PG_FUNCTION_ARGS) { + // Read argument 0 from the sql function call as text + // and convert to a c string + char *query = text_to_cstring(PG_GETARG_TEXT_PP(0)); + const char **error; + text *t; + struct GraphQLAstNode *node; + + // Parse + node = graphql_parse_string(query, error); + + t = cstring_to_text(query); + + // Return the text from the sql function + PG_RETURN_TEXT_P(t); +} diff --git a/test/conftest.py b/test/conftest.py new file mode 100644 index 00000000..234936dc --- /dev/null +++ b/test/conftest.py @@ -0,0 +1,129 @@ +# pylint: disable=redefined-outer-name,no-member +import json +import os +import subprocess +import time + +import pytest +import sqlalchemy +from sqlalchemy import create_engine, text +from sqlalchemy.orm import Session + +CONTAINER_NAME = "pg_graphql_dev" +IMAGE_NAME = "olirice/pg_graphql" +DB_NAME = "gqldb" +PORT = 5402 + + +@pytest.fixture(scope="session") +def build_docker_image() -> None: + # Delete existing image + + # Build image + subprocess.call( + [ + "docker", + "build", + CONTAINER_NAME, + "-t", + IMAGE_NAME, + ] + ) + + +@pytest.fixture(scope="session") +def dockerize_database(build_docker_image: None): + + # Skip if we're using github actions CI + if not "GITHUB_SHA" in os.environ: + subprocess.call( + [ + "docker", + "run", + "--rm", + "--name", + CONTAINER_NAME, + "-p", + f"{PORT}:5432", + "-d", + "-e", + f"POSTGRES_DB={DB_NAME}", + "-e", + "POSTGRES_PASSWORD=password", + "-e", + "POSTGRES_USER=postgres", + "--health-cmd", + "pg_isready", + "--health-interval", + "3s", + "--health-timeout", + "3s", + "--health-retries", + "15", + IMAGE_NAME, + "-c", + "fsync=off", + ] + ) + # Wait for postgres to become healthy + for _ in range(10): + out = subprocess.check_output(["docker", "inspect", CONTAINER_NAME]) + container_info = json.loads(out) + container_health_status = container_info[0]["State"]["Health"]["Status"] + if container_health_status == "healthy": + break + else: + time.sleep(1) + else: + raise Exception("Container never became healthy") + yield + subprocess.call(["docker", "stop", CONTAINER_NAME]) + return + yield + + +@pytest.fixture(scope="session") +def engine(dockerize_database): + eng = create_engine(f"postgresql://postgres:password@localhost:{PORT}/{DB_NAME}") + eng.execute( + text( + """ + create extension pg_net; + """ + ) + ) + yield eng + eng.dispose() + + +@pytest.fixture(scope="function") +def sess(engine): + conn = engine.connect() + + # Begin a transaction directly against the connection + transaction = conn.begin() + + # Bind a session to the top level transaction + _session = Session(bind=conn) + + # Start a savepoint that we can rollback to in the transaction + _session.begin_nested() + + @sqlalchemy.event.listens_for(_session, "after_transaction_end") + def restart_savepoint(sess, trans): + """Register event listener to clean up the sqla objects of a session after a transaction ends""" + if trans.nested and not trans._parent.nested: + # Expire all objects registered against the session + sess.expire_all() + sess.begin_nested() + + yield _session + # Close the session object + _session.close() + + # Rollback to the savepoint, eliminating everything that happend to the _session + # while it was yielded, cleaning up any newly committed objects + transaction.rollback() + + # Close the connection + conn.close() diff --git a/test/test_engine.py b/test/test_engine.py new file mode 100644 index 00000000..5c589b25 --- /dev/null +++ b/test/test_engine.py @@ -0,0 +1,3 @@ +def test_connect(sess): + (x,) = sess.execute("select 1").fetchone() + assert x == 1 diff --git a/test/test_temp.py b/test/test_temp.py new file mode 100644 index 00000000..11f85362 --- /dev/null +++ b/test/test_temp.py @@ -0,0 +1,42 @@ +from sqlalchemy import text, func, select + + +def test_select_one(sess): + + (one,) = sess.execute(text( + """ + select 1; + """ + )).fetchone() + + assert one == 1 + + +def test_select_sql_to_ast(sess): + + (ast,) = sess.execute(text( + """ + select net.sql_to_ast('select 1') + """ + )).fetchone() + + assert 'RAWSTMT' in ast + + +def test_parse(sess): + + query = """ + query { + account { + name + } + } + """ + + (ast,) = sess.execute(select([func.net.parse(query)])).fetchone() + + print(ast) + assert False + + +