confluentinc / ksqldb-graphql Goto Github PK

View Code? Open in Web Editor NEW

55.0 144.0 18.0 871 KB

Node.js GraphQL integration for ksqlDB

Home Page: https://ksqldb.io/

License: Other

JavaScript 8.63% TypeScript 88.21% HTML 3.17%

ksqldb-graphql's Introduction

ℹ️ This project is a proof of concept

ksqldb-graphql

GraphQL integration for ksqlDB to facilitate easier app creation by abstracting ksqlDB syntax and protocol.

Background

KLIP-15 creates a new API with which to interact. This repository contains packages to generate graphQL as well as handle the ksqlDB protocol.

Installation

yarn add @confluentinc/ksqldb-graphql

Integration

For statements to be executed against ksqDB, RequestOptions must be provided, both at startup and in the context of the graphQL resolvers.

The prebuild step, generateGraphQL, returns a promise and should be called prior to starting a graphQL server.

Usage

import { connect } from 'http2';
import { ApolloServer } from 'apollo-server';
import { generateGraphQL } from '@confluentinc/ksqldb-graphql';
import { addResolveFunctionsToSchema } from 'graphql-tools';

const session = connect(`http://localhost:8088`);
const options = {
  hostname: 'localhost',
  port: 8088,
};

generateGraphQL({ options }).then(
  ({ schemas, queryResolvers, subscriptionResolvers, mutationResolvers }) => {
    const server = new ApolloServer({
      context: async () => ({
        ksqlDB: {
          options,
          session,
        },
      }),
      schema: addResolveFunctionsToSchema({
        schema: schemas,
        resolvers: {
          Subscription: subscriptionResolvers,
          Query: queryResolvers,
          Mutation: mutationResolvers,
        }
      }),
      subscriptions: {
        keepAlive: 1000,
      },
    });
    server.listen();
  }
);

Packages

@confluentinc/ksqldb-graphql

Generates the schema and resolvers based on an existing ksqlDB cluster.

@confluentinc/ksqldb-client

Resolves the ksqlDB protocol and executes ksqlDB statements

ksqldb-graphql's People

Contributors

Stargazers

Watchers

Forkers

jrea davemaier colinhicks vlolla fernandocyder vtereshyn isabella232 insidin gklijs jkao97 pauloscarin-dev vrdate 0xlaguna xjin the-redhood adaptivefailure

ksqldb-graphql's Issues

Make sure it works with references.

I have a demo setup where I use references, but it fails to configure the schema, likely because the same reference is used multiple times.
This is the error I get

Could not generate schemas: Schema must contain uniquely named types but contains multiple types named "ADDRESS".
(node:27) UnhandledPromiseRejectionWarning: Error: Error: Unable to create schemas and resolvers
    at /root/app/dist/node_modules/@confluentinc/ksqldb-graphql/src/schema.js:201:27
    at Generator.next (<anonymous>)
    at fulfilled (/root/app/dist/node_modules/@confluentinc/ksqldb-graphql/src/schema.js:5:58)

Demo can be found at https://github.com/gklijs/ksqlDB-GraphQL-poc you probably need to restart the js-graphql-endpoint container to see the error.

Is this project dead?

Graphql and kafka is something we really want to be using with a library such as this. Is this still actively being maintained/developed?

Publish transpiled npm packages

At the moment the @confluentinc/ksqldb-graphql and @confluentinc/ksqldb-client packages are pushed to npm as TypeScript. This makes it very hard to use the packages. Basically, the only solution is to add TypeScript to the project, and to then set it to transpile the module from node_modules.

The reasons it works in the rideshare demo are that the packages are used through yarn workspaces locally, and that rideshare itself is written in TypeScript.

Instead, I would expect the npm package to contain the JavaScript version, while it could still export the TypeScript types.

This seems like a good article explaining how to do it: https://medium.com/cameron-nokes/the-30-second-guide-to-publishing-a-typescript-package-to-npm-89d93ff7bccd

"This endpoint is only available when using HTTP2"

I'm trying to launch the RIDESHARE project with my own ksqldb server, but I'm running through this error whenever I try to test a query through the playground on the server side
** {"error":
{"name": "Error",
"message": "This endpoint is only available when using HTTP2"}
}**
Also on the client side, I can't see the cars while getting this error
client. t's: 545 WebSocket connection to 'ws://ec2-54-187-136-198.us-west-2.compute.amazonaws.com:3010/graphql' failed: Error in connection establishment: net:: ERR_CONNECTION_REFUSED .
I should mention that all the data gets saved in the Ksqldb server

link to blog post in the readme

Drop a link to https://www.confluent.io/blog/intro-to-graphql-an-api-for-kafka-data/ in the readme :-)