Skip to main content

GraphQL Subscriptions In Angular Using Apollo Angular Library

In this article, we are going to understand GraphQL Subscriptions in an angular application using the Apollo Angular Library.

Graphql Subscription:

GraphQL subscriptions are a way to push data from the server to the clients that listen to real-time messages or payload or data from the server. Subscriptions are similar to queries in that they specify a set of fields to be delivered to the client, but instead of immediately returning a single response, a result is sent every time a particular event happens on the server.

So for this demo, I have created a GraphQL endpoint in .Net5. So I'm going to use that as my server.



So above 2 images like 'Publisher' and 'Subscriber' are tested using the browser. Now we will implement those publisher and subscriber functionalities into the angular application.

Create An Angular Application:

Let's begin our demo by creating an angular sample application.
Command To Install Angular CLI:(If not installed on your system previously)
npm install -g @angular/cli
Angular CLI Command To Create Angular App:
ng new your_project_name
Command To Run App:
ng serve

Install Required Apollo Angular Packages:

Apollo Angular provides us an easy way to install and configure it into our application with a simple 'ng' command below.
Command To Install And Setup Apollo Angular :
ng add apollo-angular
The above command installs 3 different libraries like 'apollo-angular', '@apollo/client', 'graphql'.
The 'graphql.module.ts' a new file will be created with all startup configurations regarding GraphQL.

Subscriptions need a persistent connection, so we are going to use WebSockets. To work with WebSockets we need the following libraries.
npm install --save subscriptions-transport-ws
npm i --save-dev @types/ws 

Configure HTTP And WebSocket Url In GraphQL Module:

GraphQL 'Queries', 'Mutations' are carried over the HTTP URL.

GraphqQL 'Subscriptions' need persistent connection, so subscriptions carried over WebSockets.

Now in the GraphQL module, we have to manage the URL by switching them based on GraphQL operation. So let's update the 'createApollo' method inside of the 'graphql.module.ts'.
import {NgModule} from '@angular/core';
import {APOLLO_OPTIONS} from 'apollo-angular';
import {ApolloClientOptions, InMemoryCache, split} from '@apollo/client/core';
import {HttpLink} from 'apollo-angular/http';
import {WebSocketLink} from '@apollo/client/link/ws';
import {getMainDefinition} from '@apollo/client/utilities';

export function createApollo(httpLink: HttpLink): ApolloClientOptions<any> {

  const http = httpLink.create({

  const ws = new WebSocketLink({

  const link = split(
    ({query}) => {
      const data = getMainDefinition(query);
      return (
        data.kind === 'OperationDefinition' && data.operation === 'subscription'

  return {
    link: link,
    cache: new InMemoryCache(),

  providers: [
      provide: APOLLO_OPTIONS,
      useFactory: createApollo,
      deps: [HttpLink],
export class GraphQLModule {}
  • (Line: 10-12) Creating the HTTP instance with its URL registering.
  • (Line: 14-19) Creating the WebSocket instance with its URL registering.
  • (Line: 21-30) The 'split' function loads from '@apollo/client/core'. This 'split' function works conditional loader where based on the operations('query', 'mutation', 'subscriptions') triggered from our angular app appropriate URL instance will be loaded.

Basic Components Creation:

In our sample, we will create 2 components. One component will have a user form, here we will invoke GraphQL mutation to send the data to the server. Another component is the subscription component where we implement our GraphQL subscription logic to continuously receive data from the server.

So let's create components like 'create.product.ts' and 'subscribe.product.ts'.
Now configure the routing for our components.
Now import our newly added components into the 'app.module.ts'.

Mutation Operation:

Now we have to implement a mutation operation that sends data to the server. So we are going to create a small form to post the data to the server in 'subscribe.product.ts'. So 'subscribe.product.ts' component will our publisher.

<h3>Products Form</h3>
  <div class="mb-3">
    <label for="productName" class="form-label">Name</label>
    <input class="form-control" name="productName" [(ngModel)]="" type="text"  />
  <div class="mb-3">
    <label for="productPrice" class="form-label">Price</label>
    <input class="form-control" name="productPrice" type="text" [(ngModel)]="productsForm.cost" />
  <button type="button" (click)="send()" class="btn btn-warning">Send</button>
import { Component } from '@angular/core';
import { Apollo, gql } from 'apollo-angular';

const post_Product = gql`
  mutation($myProduct: ProductInput) {
    addProduct(model: $myProduct)

  templateUrl: 'create.product.html',
export class CreateProduct {
   productsForm = {
    name: '',
    cost: '',

  constructor(private apollo: Apollo) {}

  send() {
        mutation: post_Product,
        variables: {
          myProduct: {
              cost:  Number(this.productsForm.cost)
      .subscribe(({ data }) => {
  • (Line: 4-8) Framed GraphQL mutation.
  • (Line: 14-17) The 'productForm' variable declared to enable data binding with the form.
  • (Line: 19) Injecting 'Apollo' instance.
  • (Line: 21-35) Invoking the GraphQL endpoint. Our form data is assigned to the GraphQL variable.

Subscription Operation:

GraphQL subscription is similar to the query, but the query is like single time receiving response whereas the subscription is like continuous listening for responses from the server.

So in the Apollo Angular library implementing subscription is not straightforward like in query or mutations. So to enable subscription initially we need to create the instance of the query, so from the query instance, we will enable our subscription. 

For example, need to fetch record automatically from the server without calling it manually, in that case initially data will be fetched by using the GraphQL query, next we will derive subscription so that all other latest record automatically received from the server continuously. In some cases, we don't have initial data to load and we need to enable subscriptions, then we can create a fake query instance(never read the result here) and then derive the subscription.

Now in 'subscription.product.ts' implement the GraphQL subscription logic. So 'subscription.product.ts' component will be the subscriber.

<h3>Subscription To Fetch Latest Product</h3>
<ul *ngIf="productData">
    <li><span>Name</span>  {{}}</li>
    <li><span>Cost</span>  {{productData.cost}}</li>
    <li><span>Date</span>  {{productData.createdDate}}</li>
import { Component, OnInit } from "@angular/core";
import { Apollo, gql, QueryRef } from "apollo-angular";

const dummy = gql`query{fakequery}`;

const sub = gql`subscription{

export class SubscribeProduct implements OnInit{
    queryRef: QueryRef<any>;

    constructor(private apollo:Apollo){
        this.queryRef = this.apollo.watchQuery({
    ngOnInit(): void {


            document: sub,
            updateQuery:(prev, {subscriptionData})  =>{
                this.productData =;
  • (Line: 4) Added some fake GraphQL query commands. (If you want to load data initially with GraphQL query command then give the valid command, in my case I want only subscription and don't care about the initial data)
  • (Line: 6-12) Added the subscription command.
  • (Line: 20) Declared 'QueryRef<any>' variable.
  • (Line: 23-25) Here I'm framing the GraphQL query operation and assigning its reference to 'queryRef' variable. Here I'm not making calls to API.
  • (Line: 34-40) Here using 'queryRef' variable memory we are enabling our subscription by calling the 'subscribeToMore' method. To the 'document' property we need to pass the subscription command. To the 'updateQuery' property we have to register the callback method, which gets executed on every response send by the server. So the subscription is a persistent connection carried over WebSocket.
Now to test run both server and angular application. Now in the browser tab open the angular page "http://localhost:4200/subscribe-product" which is our subscriber. (you can open this page in the n-number of a browser tab, all will listen for server response)
Now in the open angular home page which is the publisher. Enter some data and submit.
Now check all subscriber page browser tabs.
So that's all about implementing GraphQL Subscription in angular application.

Video Session:

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on implementing GraphQL Subscription in the angular application using Apollo Angular library. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:


  1. When using SubscribeToMore in an angular component, this code fires multiple times. How can it be made to fire only once, or how can that code be unsubscribed?


Post a Comment

Popular posts from this blog

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http

GraphQL API Integration In Asp.Net Core Application

Introduction: GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data. How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions. HTTP-POST is the only Http verb recommended by the GraphQL. The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API: The main building blocks of GraphQL API is Schemas and Types.  A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc. T

ASP.NET Core Web API Versioning

Introduction: An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API. When To Use Versioning: Any API response changes. Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production. Deprecating an API which means API going to be removed or upgraded by a version within a short period. Versioning Types: Query String Versioning Url Path Versioning Media Type Versioning API Version Nuget: To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.              Install-Package Microsoft.A

Blazor Server CRUD Operations

Introduction: Blazor Server is a web framework to develop server-side single-page applications. Blazor is made up of components with the combinations on C#, Html, CSS.  Blazor Server is production-ready from the .Net Core 3.0.  Blazor Server Working Mechanism: Blazor Server is a very light-weight web development framework.  In Blazor Server, not all code gets downloaded to the client browsers. Blazor Server made of components these components can be a block of code or page with respective navigation.  Blazor server application communicates with the server with a SignalR background connection which is inbuilt functionality. Application click,  form submission, change events, application page navigation every operation is carried out by the SignalR connection by communicating with the server.  Blazor updates the Html DOM very gently on every data update without any overhead. Blazor Server application maintains a nice intelligent tree structure to update the required inform