Skip to main content

A Demo On HotChocolate GraphQL Subscriptions(Pub/Sub) Using Application InMemory Storage

This article will implement a small demo on subscriptions in Hot Chocolate Graphql using the application In-Memory storage.

Since our target storage is application In-Memory, so this approach only apt for a single server hosted application. For applications with multiple servers then we have to use Redis Store.

GraphQL Subscription Flow:

In general, events raising or publishing will be triggered from the GraphQL mutation resolvers. Inside mutation resolvers raise the event to store the data into application in-memory storage. In GraphQL 'Subscriptions' is one of the root definitions like 'Query', Mutation'. So the subscription resolvers will always receive the data from in-memory storage. So the subscription resolvers can also be called subscribers whose job always watches the data send by the raised events.

So the event raised from the mutation resolver will be received by all subscribers.

Create A .Net5 Web API App:

Now let's begin our journey by creating a .Net5 Web API sample application.

Install Hot Chocolate GraphQL Library:

Package Manager Command:
Install-Package HotChocolate.AspNetCore -Version 11.0.9
.Net CLI Command:
dotnet add package HotChocolate.AspNetCore --version 11.0.9

Register GrapqhQL Server And Endpoint:

In 'Startup.cs' we have to register the GraphQL server.
Startup.cs:(ConfigureService Method)
services.AddGraphQLServer();
In 'Startup.cs' we have to register the GraphQL endpoint.
Startup.cs:(Configure Method)
app.UseEndpoints(endpoints =>
{
	endpoints.MapGraphQL();
	endpoints.MapControllers();
});

Register In-Memory Subscription Service:

Application In-Memory storage used by the GraphQL Subscriptions. So need to register the in-memory subscription service.
Startup.cs:(ConfigureService Method)
services
.AddGraphQLServer()
.AddInMemorySubscriptions();

Register WebSockets Middleware:

GraphQL subscriptions by default work over WebSockets. So let's add the WebSockets middleware.
Startup.cs:(Configure Method) 
app.UseWebSockets();
app.UseRouting();

Create Subscription Type:

Now we will create a subscription type and resolver method that will give a response to the client subscribers.

Let's create a sample response model class like 'Product.cs' into the new folder 'Models'.
Models/Product.cs:
using System;

namespace Hc.PubSub.Models
{
    public class Product
    {
        public string Name { get; set; }
        public decimal Price { get; set; }
        public DateTime CreatedDate { get; set; }
    }
}
Now create a folder like 'Core' and add our new class that defines the subscriptions type.
Core/SubscriptionObjectType.cs:
using HotChoco.Pub.Sub.InMemo.Models;
using HotChocolate;
using HotChocolate.Types;

namespace HotChoco.Pub.Sub.InMemo.Core
{
    public class SubscriptionObjectType
    {

        [Topic]
        [Subscribe]
        public Product SubscribeProduct([EventMessage] Product product)
        {
            return product;
        }
    }
}
  • (Line: 10) Decorated with 'HotChocolate.Types.Topic' attribute. This attribute makes the resolver method name 'SubscribeProduct' as the pub/sub channel name.
  • (Line: 11) Decorated with 'HotChocolate.Types.Subscribe'. This makes our resolver as listner of the pub/sub channel.
  • The 'EventMessage' attribute injects the payload data into our subscribe resolver method.
  • Finally simply returning the 'Product' object as output. So all subscriber client apps will receive the 'Product' payload.
Now register the 'SubscriptionObjectType' in the 'Startup.cs'.
Startup.cs:
services
.AddGraphQLServer()
.AddInMemorySubscriptions()
.AddSubscriptionType<SubscriptionObjectType>();

Create Mutation Type And Invoke EventSender:

Now we have to create mutation resolver method in which we are going to invoke the event sender of the pub/sub.

Now let's create a new mutation type like 'MutationObjectType.cs'.
Core/MutationObjectType.cs:
using System.Threading.Tasks;
using HotChoco.Pub.Sub.InMemo.Models;
using HotChocolate;
using HotChocolate.Subscriptions;

namespace HotChoco.Pub.Sub.InMemo.Core
{
    public class MutationObjectType
    {
        public async Task<string> AddProduct(
            [Service] ITopicEventSender eventSender,
            Product model)
        {
            // add your own logic to saving data into some data store.
            model.CreatedDate = DateTime.Now;
            await eventSender.SendAsync(nameof(SubscriptionObjectType.SubscribeProduct), model);
            return model.Name;
        }
    }
}
  • Here injecting 'HotChocolate.Subscriptions.ITopicEventSender', to raise the pub/sub channel sender event. So for sending here we have 2 input params like 'topic'(which can be called as channel name) and 'model'(payload object). Here channel name or topic value is our subscription resolver method name.
Now register our mutation type into the 'Startup.cs'.
Startup.cs:
services
.AddGraphQLServer()
.AddInMemorySubscriptions()
.AddSubscriptionType<SubscriptionObjectType>()
.AddMutationType<MutationObjectType>();

Create A Query Type:

Actually for our demo sample we don't have any work with query type, but without query type we will encounter the error to start our application.. so let's create some dummy query resolver.
src/QueryObjectType.cs:
namespace HotChoco.Pub.Sub.InMemo.Core
{
    public class QueryObjectType
    {
        public string Test()
        {
            return "hello";
        }
    }
}
Register query type in the 'Startup.cs'.
Startup.cs:
services
.AddGraphQLServer()
.AddInMemorySubscriptions()
.AddSubscriptionType<SubscriptionObjectType>()
.AddMutationType<MutationObjectType>()
.AddQueryType<QueryObjectType>();

Test Pub/Sub:

Now run the application and navigate to '/graphql'. Open 2 different tabs on the browser one act as publisher and another tab act as subscriber.

The publisher tab, must work with mutation which raises the sender event. So let's frame the mutation like below.
Mutation:
mutation($myProduct: ProductInput){
  addProduct(model:$myProduct)
}
Variable:
{
  "myProduct":{
      "name":"tt",
      "cost": 1000
  }
}

The subscriber tab,must work with our graphql subscription, which watches for the data from the server. So lets frame the subscription request like below.
Subscriptions:
subscription{
  subscribeProduct{
    name,
    cost,
    createdDate
  }
}
So that all about the implementation steps for pub/sub flow in GraphQL.

Video Session:

 

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on pub/sub flow in GraphQL endpoint using in-memory storage. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Comments

  1. Your website is not showing the examples, as what is written is the same color as the background.

    ReplyDelete
    Replies
    1. It showing
      Might taking long time for you, so please wait or reload the page

      Delete
  2. Is it possible to publish subscription messages without having to go through a mutation first?

    I have background services mutating data that I would like to push out via subs.

    ReplyDelete
    Replies
    1. trigering only subscription not possible as for as i know

      Delete
  3. I've got error: The specified operation kind is not allowed.

    ReplyDelete
    Replies
    1. Sorry, GET method was selected accidentally

      Delete
    2. i am also getting this error. how did u resolve it?

      Delete
  4. Anyone who is getting error "The specified operation kind is not allowed", make sure to turn off Banana Cake Pop's "Use Http Get". Otherwise it'll send get for both get, and post requests.

    ReplyDelete

Post a Comment

Popular posts from this blog

Angular 14 Reactive Forms Example

In this article, we will explore the Angular(14) reactive forms with an example. Reactive Forms: Angular reactive forms support model-driven techniques to handle the form's input values. The reactive forms state is immutable, any form filed change creates a new state for the form. Reactive forms are built around observable streams, where form inputs and values are provided as streams of input values, which can be accessed synchronously. Some key notations that involve in reactive forms are like: FormControl - each input element in the form is 'FormControl'. The 'FormControl' tracks the value and validation status of form fields. FormGroup - Track the value and validate the state of the group of 'FormControl'. FormBuilder - Angular service which can be used to create the 'FormGroup' or FormControl instance quickly. Form Array - That can hold infinite form control, this helps to create dynamic forms. Create An Angular(14) Application: Let'

.NET 7 Web API CRUD Using Entity Framework Core

In this article, we are going to implement a sample .NET 7 Web API CRUD using the Entity Framework Core. Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, and desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains programming functions that can be requested via HTTP calls either to fetch or update data for their respective clients. Some of the Key Characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build the REST full services. Install The SQL Server And SQL Management Studio: Let's install the SQL server on our l

ReactJS(v18) JWT Authentication Using HTTP Only Cookie

In this article, we will implement the ReactJS application authentication using the HTTP-only cookie. HTTP Only Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing the JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-ONly cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use the authentication with HTTP-only JWT cookie then we no need to implement the custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To authenticate our client application with JWT HTTP-only cookie, I developed a NetJS(which is a node) Mock API. Check the GitHub link and read the document on G

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Angular 14 State Management CRUD Example With NgRx(14)

In this article, we are going to implement the Angular(14) state management CRUD example with NgRx(14) NgRx Store For State Management: In an angular application to share consistent data between multiple components, we use NgRx state management. Using NgRx state helps to avoid unwanted API calls, easy to maintain consistent data, etc. The main building blocks for the NgRx store are: Actions - NgRx actions represents event to trigger the reducers to save the data into the stores. Reducer - Reducer's pure function, which is used to create a new state on data change. Store - The store is the model or entity that holds the data. Selector - Selector to fetch the slices of data from the store to angular components. Effects - Effects deals with external network calls like API. The effect gets executed based the action performed Ngrx State Management flow: The angular component needs data for binding.  So angular component calls an action that is responsible for invoking the API call.  Aft

Angular 14 Crud Example

In this article, we will implement CRUD operation in the Angular 14 application. Angular: Angular is a framework that can be used to build a single-page application. Angular applications are built with components that make our code simple and clean. Angular components compose of 3 files like TypeScript File(*.ts), Html File(*.html), CSS File(*.cs) Components typescript file and HTML file support 2-way binding which means data flow is bi-directional Component typescript file listens for all HTML events from the HTML file. Create Angular(14) Application: Let's create an Angular(14) application to begin our sample. Make sure to install the Angular CLI tool into our local machine because it provides easy CLI commands to play with the angular application. Command To Install Angular CLI npm install -g @angular/cli Run the below command to create the angular application. Command To Create Angular Application ng new name_of_your_app Note: While creating the app, you will see a noti

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

ReactJS(v18) Authentication With JWT AccessToken And Refresh Token

In this article, we are going to do ReactJS(v18) application authentication using the JWT Access Token and Refresh Token. JSON Web Token(JWT): JSON Web Token is a digitally signed and secured token for user validation. The JWT is constructed with 3 important parts: Header Payload Signature Create ReactJS Application: Let's create a ReactJS application to accomplish our demo. npx create-react-app name-of-your-app Configure React Bootstrap Library: Let's install the React Bootstrap library npm install react-bootstrap bootstrap Now add the bootstrap CSS reference in 'index.js'. src/index.js: import 'bootstrap/dist/css/bootstrap.min.css' Create A React Component 'Layout': Let's add a React component like 'Layout' in 'components/shared' folders(new folders). src/components/shared/Layout.js: import Navbar from "react-bootstrap/Navbar"; import { Container } from "react-bootstrap"; import Nav from "react-boot

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually