Skip to main content

Part-2 Ionic&Vue JWT(JSON Web Token) Authentication(Refresh Token Implementation)

In Part-1 we have learned about user authentication using the jwt access token in the Ionic&Vue application. This is the continuation article here our main goal to use refresh token on the expiration of the access token.

NestJS(Nodejs) Todos API:

In Part-1 we discussed steps to set up the Nestjs API. In that API we have a secured endpoint called 'Todos'. In the next step, we are going to consume this 'Todo' API from our angular application.
http://localhost:3000/todos

Use Access Token As Authorization Header To Secured Endpoint:

Now we will consume the secured endpoint(in our sample 'Todos' endpoint) by sending the access token value as the authorization header.

So to work with the todos endpoint let's create a separate store module as below.
src/store/modules/todo.js:
import axios from "axios";

const store = () => ({
  todos: [],
});

const getters = {
  getAllTodos(state) {
    return state.todos;
  },
};

const actions = {
  async fetchTodos({ commit }) {
    var response = await axios.get("http://localhost:3000/todos");
    commit("saveAllTodos", response.data);
  },
};

const mutations = {
  saveAllTodos(state, payload) {
    state.todos = payload;
  },
};

export default {
  namespaced: true,
  store,
  getters,
  actions,
  mutations,
};
  • (Line: 1) Imported Axios library.
  • (Line: 3-5) Initialized the todos store state.
  • (Line: 7-11) Todo getter where we created a function that will return all the todos from the state. This getter function will be consumed by the vue components.
  • (Line: 13-18) Todo actions where we created a function that will call the todos endpoint and response will be passed to the mutation function.
  • (Line: 20-24) Mutation function that updates our store state.
Regist our 'todo.js' store module inside of root module
src/store/index.js:
import {createStore} from 'vuex';
import AuthModule from './modules/auth';
import TodoModule from './modules/todo';

const store = createStore({
    modules:{
        auth:AuthModule,
        todo:TodoModule
    }
});

export default store;
Now update our 'Dashboard.vue' page vue component to display the todos
src/pages/Dashboard.vue:
<template>
  <master-layout pageTitle="Dashboard">
    <ion-card>
      <ion-card-header>
        <ion-card-title>Welcome!</ion-card-title>
      </ion-card-header>
      <ion-card-content>
        <ion-item>
          <ion-label>Owner Name:</ion-label>
          <ion-label>{{ authData.userName }}</ion-label>
        </ion-item>
      </ion-card-content>
    </ion-card>
    <ion-card>
      <ion-card-header>
        <ion-button expand="full" @click="showTodos()">Show Todos</ion-button>
        <ion-card-title>Here all your todos</ion-card-title>
      </ion-card-header>
      <ion-card-content>
        <ion-item v-for="(todo,index) in allTodos" :key="index">
          <ion-label>{{todo}}</ion-label>
        </ion-item>
      </ion-card-content>
    </ion-card>
  </master-layout>
</template>
  • Here we added one more 'ion-card' component inside of its added button, now on clicking the button we are going to invoke todos secured endpoint and then bind the results.
src/pages/Dashboard.js: 
<script>
import {
  IonCard,IonCardHeader,IonCardTitle,IonCardContent,IonItem,IonLabel,IonButton
} from "@ionic/vue";
import { mapGetters, mapActions } from "vuex";
export default {
  components: {
    IonCard,IonCardHeader,IonCardTitle,IonCardContent,IonItem,IonLabel,IonButton
  },
  computed: {
    ...mapGetters("auth", {
      authData: "getAuthData",
    }),
    ...mapGetters("todo",{
      allTodos:"getAllTodos"
    })
  },
  methods:{
    ...mapActions('todo',{
      fetchTodos:"fetchTodos"
    }),
    async showTodos(){
      await this.fetchTodos();
    }
  }
};
</script>
  • (Line: 14-16) The todos 'mapGetters' defined to fetch all todos
  • (Line: 19-21) The todos 'mapActions' defined.
  • (Line: 22-24) This is a button callback method that invoking the action method to call a secured endpoint.
Now let's test to access the secured endpoint we will get the result as unauthorized because we haven't appended our access token as an authorization header.
Now to fix this issue we need to add our access token value as an authorization header. So to add the authorization request for the required secured endpoints we are going to create a custom Axios instance with interceptor configuration.
src/shared/jwtInterceptor.js:
import axios from "axios";
import store from '../store/index';
 
const jwtInterceptor = axios.create({});
 
jwtInterceptor.interceptors.request.use((config) => {
  const authData = store.getters["auth/getAuthData"];
  config.headers.common["Authorization"] = `bearer ${authData.token}`;
  return config;
});
export default jwtInterceptor;
  • (Line:4) Creating an instance of Axios and assigned to variable 'jwtInterceptor'. Now, 'jwtInterceptor' works exactly as 'Axios'.
  • (Line: 6) Configuring interceptor for the 'jwtInterceptor' instance.
  • (Line: 7) Fetching token data from the store.
  • (Line: 8) Adding an authorization header. so if we make calls suing the 'jwtInterceptor' the authorization header will be added to the request.
Now update our todos store action method to use the 'jwtInterceptor' to invoke the secured endpoint as below.
src/store/modules/todo.js:
import jwtInterceptor from '../../shared/jwtInterceptor';

const actions = {
  async fetchTodos({ commit }) {
    var response = await jwtInterceptor.get("http://localhost:3000/todos");
    commit("saveAllTodos", response.data);
  },
};

Refresh Token Flow:

  • Refresh Token is a random string key that will be created along with the JWT access token and return to the valid client on successful logging in.
  • Now for all subsequent requests will use the access token, but the access token is a short-lived token whereas the refresh token lives more time than the access token.
  • On the expiration of the access token, the user instead of authenticating himself again passing his user name and password, the user can send the refresh token.
  • The server on receiving a refresh token first validates against the storage(database, cache, etc).
  • For a valid refresh token server will create a new access token and refresh token(like when authenticate using user name and password) return it to the user.

Integrate Refresh Token Endpoint:

Now in our interceptor we need to update logic in such a way that if the access token expires then we need to invoke the refresh token endpoint after receiving new 'access' and 'refresh' tokens we need to update them in browser local storage and also need to restore our vuex state management after that we need to invoke our secured endpoint with a valid access token as its authorization header.
NestJS API Refresh Token Endpoint
URL:- http://localhost:3000/auth/refreshtoken
Payload:{
"access_token":"",
"refresh_token":""
}
Now let's create an action method that uses the token endpoint response to update the token values
src/store/modules/auth.js:
async saveTokensToStorage({commit}, payload){
    await Storage.set({
      key: "access_token",
      value: payload.access_token,
    });
    await Storage.set({
      key: "refresh_token",
      value: payload.refresh_token,
    });
    commit("saveTokenData", payload);
  }
  • On the successful response from the endpoint, a new access token and refresh token will be updated in both device storage and in the vuex store as well.
Now let's update our interceptor to invoke the refresh token.
src/shared/jwtInterceptors.js:
import axios from "axios";
import store from "../store/index";

const jwtInterceptor = axios.create({});

jwtInterceptor.interceptors.request.use((config) => {
  const authData = store.getters["auth/getAuthData"];
  if (authData == null) {
    return config;
  }

  config.headers.common["Authorization"] = `bearer ${authData.token}`;
  return config;
});

jwtInterceptor.interceptors.response.use(
  (response) => {
    return response;
  },
  async (error) => {
    if (error.response.status === 401) {
      const authData = store.getters["auth/getAuthData"];
      const payload = {
        access_token: authData.token,
        refresh_token: authData.refreshToken,
      };

      var response = await axios.post(
        "http://localhost:3000/auth/refreshtoken",
        payload
      );
      await store.dispatch("auth/saveTokensToStorage", response.data);
      error.config.headers[
        "Authorization"
      ] = `bearer ${response.data.access_token}`;
      return axios(error.config);
    } else {
      return Promise.reject(error);
    }
  }
);

export default jwtInterceptor;
  • Here on the response of the interceptor, we are handling our logic to invoke the refresh token endpoint. Here in the error response check for the status of '401', if so then we invoke the refresh token endpoint and refresh our expired application token.
Now if we try to access our secure endpoint, the output looks as below.


That's all about the steps to implement the refresh token in the Ionic&Vue application.

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on access token implementation in the Ionic&Vue application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Labels:

Comments

  1. KentAugust 27, 2021 at 7:10 AM

    Excellent tutorial. Thank you for contributing such great content.

    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'
3 comments
Read more

.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
3 comments
Read more

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
3 comments
Read more

.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
6 comments
Read more

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
8 comments
Read more

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
5 comments
Read more

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
7 comments
Read more

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
Post a Comment
Read more

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
Post a Comment
Read more

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
8 comments
Read more