Cloud-enabled Amplify DataStore workshop using Vue

In this workshop we'll learn how to use Amplify DataStore to create Chatty a single room realtime multi-user chat app using Vue & AWS Amplify.

Topics we'll be covering:

• Authentication
• GraphQL API with AWS AppSync
• Setup Amplify DataStore
• Deploying via the Amplify Console
• Removing services
• Appendix and trobleshooting

Pre-requisites

• Node: 14.7.0. Visit Node
• npm: 6.14.7. Packaged with Node otherwise run upgrade

npm install -g npm

Getting Started - Creating the Application

To get started, we first need to create a new Vue project & change into the new directory using the Vue CLI.

If you already have it installed, skip to the next step. If not, either install the CLI & create the app or create a new app using:

npm install -g @vue/cli
vue create amplify-datastore

Vue CLI

• ? Please pick a preset: default (babel, eslint)

Now change into the new app directory and make sure it runs

cd amplify-datastore
npm run serve

Installing the CLI & initializing a new AWS Amplify project

Let's now install the AWS Amplify API & AWS Amplify Vue library:

npm install --save aws-amplify @aws-amplify/ui-vue moment

If you have issues related to EACCESS try using sudo: sudo npm <command>.

Installing the AWS Amplify CLI

Next, we'll install the AWS Amplify CLI:

npm install -g @aws-amplify/cli

Now we need to configure the CLI with our credentials:

amplify configure

If you'd like to see a video walkthrough of this configuration process, click here.

Here we'll walk through the amplify configure setup. Once you've signed in to the AWS console, continue:

• Specify the AWS Region: eu-central-1 (Frankfurt)
• Specify the username of the new IAM user: amplify-datastore

In the AWS Console, click Next: Permissions, Next: Tags, Next: Review, & Create User to create the new IAM user. Then, return to the command line & press Enter.

• Enter the access key of the newly created user:
  accessKeyId: (<YOUR_ACCESS_KEY_ID>)
  secretAccessKey: (<YOUR_SECRET_ACCESS_KEY>)
• Profile Name: default

To view the new created IAM User go to the dashboard at https://console.aws.amazon.com/iam/home#/users/. Also be sure that your region matches your selection.

Initializing a new project

amplify init

• Enter a name for the project: amplify-datastore
• Enter a name for the environment: dev
• Choose your default editor: Visual Studio Code
• Please choose the type of app that you're building javascript
• What javascript framework are you using vue
• Source Directory Path: src
• Distribution Directory Path: dist
• Build Command: npm run-script build
• Start Command: npm run-script serve
• Do you want to use an AWS profile? Yes
• Please choose the profile you want to use default

Now, the AWS Amplify CLI has iniatilized a new project & you will see a new folder: amplify. The files in this folder hold your project configuration.

<amplify-app>
    |_ amplify
      |_ .config
      |_ #current-cloud-backend
      |_ backend
      team-provider-info.json

Adding authentication

To add authentication to our Amplify project, we can use the following command:

amplify add auth

When prompted choose

• Do you want to use default authentication and security configuration?: Default configuration
• How do you want users to be able to sign in when using your Cognito User Pool?: Username
• Do you want to configure advanced settings? Yes, I want to make some additional changes.
• What attributes are required for signing up? (Press <space> to select, <a> to toggle all, <i> to invert selection): Email
• Do you want to enable any of the following capabilities? (Press <space> to select, <a> to toggle all, <i> to invert selection): None

To select none just press Enter in the last option.

Now, we'll run the push command and the cloud resources will be created in our AWS account.

amplify push

Current Environment: dev

| Category | Resource name      | Operation | Provider plugin   |
| -------- | ------------------ | --------- | ----------------- |
| Auth     | amplifyappuuid     | Create    | awscloudformation |
? Are you sure you want to continue? Yes

To quickly check your newly created Cognito User Pool you can run

amplify status

To access the AWS Cognito Console at any time, go to the dashboard at https://console.aws.amazon.com/cognito/. Also be sure that your region is set correctly.

Configuring the Vue application

Now, our resources are created & we can start using them!

The first thing we need to do is to configure our Vue application to be aware of our new AWS Amplify project. We can do this by referencing the auto-generated aws-exports.js file that is now in our src folder.

To configure the app, open main.js and add the following code below the last import:

import Vue from 'vue'
import App from './App.vue'

import Amplify from 'aws-amplify';
import '@aws-amplify/ui-vue';
import aws_exports from './aws-exports';

Amplify.configure(aws_exports);

Vue.config.productionTip = false

new Vue({
  render: h => h(App),
}).$mount('#app')

Now, our app is ready to start using our AWS services.

Using the Authenticator Component

AWS Amplify provides UI components that you can use in your App. Let's add these components to the project

In order to use the Authenticator Component add it to src/App.vue:

<template>
  <div id="app">
    <amplify-authenticator>
      <div>
        <h1>Hey, {{user.username}}!</h1>
        <amplify-sign-out></amplify-sign-out>
      </div>
    </amplify-authenticator>
  </div>
</template>

Now, we can run the app and see that an Authentication flow has been added in front of our App component. This flow gives users the ability to sign up & sign in.

To view any users that were created, go back to the Cognito dashboard at https://console.aws.amazon.com/cognito/. Also be sure that your region is set correctly.

Alternatively we can also use

amplify console auth

Accessing User Data

By listening to authentication state changes using onAuthUIStateChange we can access the user's info once they are signed in as shown below.

<script>
import { AuthState, onAuthUIStateChange } from '@aws-amplify/ui-components'

export default {
  name: 'app',
  data() {
    return {
      user: { },
    }
  },
  created() {
    // authentication state managament
    onAuthUIStateChange((state, user) => {
      // set current user and load data after login
      if (state === AuthState.SignedIn) {
        this.user = user;
      }
    })
  }
}
</script>

Adding a GraphQL API

To add a GraphQL API, we can use the following command:

amplify add api

Answer the following questions

• Please select from one of the below mentioned services GraphQL
• Provide API name: ChattyAPI
• Choose the default authorization type for the API API key
• Enter a description for the API key: (empty)
• After how many days from now the API key should expire (1-365): 180
• Do you want to configure advanced settings for the GraphQL API Yes, I want to make some additional changes.
• Configure additional auth types? N
• Configure conflict detection? Y
• Select the default resolution strategy Auto Merge
• Do you want to override default per model settings? N
• Do you have an annotated GraphQL schema? N
• Do you want a guided schema creation? Y
• What best describes your project: Single object with fields (e.g. “Todo” with ID, name, description)
• Do you want to edit the schema now? Y

To select none just press Enter.

When prompted, update the schema to the following:

type Chatty @model {
  id: ID!
  user: String!
  message: String!
  createdAt: AWSDateTime
}

This will allow us to display each user messages together with the creation date and time.

Note: Don't forget to save the changes to the schema file!

Next, let's push the configuration to our account:

amplify push

• Are you sure you want to continue? Yes
• Do you want to generate code for your newly created GraphQL API Yes
• Choose the code generation language target javascript
• Enter the file name pattern of graphql queries, mutations and subscriptions src/graphql/**/*.js
• Do you want to generate/update all possible GraphQL operations - queries, mutations and subscriptions Yes
• Enter maximum statement depth [increase from default if your schema is deeply nested] 2

Notice your GraphQL endpoint and API KEY.

This step created a new AWS AppSync API. Use the command below to access the AWS AppSync dashboard. Make sure that your region is correct.

amplify console api

• Please select from one of the below mentioned services GraphQL

Setup Amplify DataStore

Installing the Amplify DataStore

Next, we'll install the necessary dependencies:

npm install --save @aws-amplify/core @aws-amplify/datastore

Data model generation

Next, we'll generate the models to access our messages from our ChattyAPI

amplify codegen models

Important: DO NOT forget to generate models every time you introduce a change in your schema.

Now, the AWS Amplify CLI has generated the necessary data models and you will see a new folder in your source: models. The files in this folder hold your data model classes and schema.

<amplify-app>
    |_ src
      |_ models

Creating a message

Now that the GraphQL API and Data Models are created we can begin interacting with them!

The first thing we'll do is create a new message using the generated Data Models and save.

import { DataStore } from "@aws-amplify/datastore";
import { Chatty } from "./models";

await DataStore.save(new Chatty({
  user: "amplify-user",
  message: "Hi everyone!",
  createdAt: new Date().toISOString()
}))

This will create a record locally in your browser and synchronise it in the background using the underlying GraphQL API.

Querying data

Let's now see how we can query data using Amplify DataStore. In order to query our Data Model we will use a query and a predicate to indicate that we want all records.

import { DataStore, Predicates } from "@aws-amplify/datastore";
import { Chatty } from "./models";

const messages = await DataStore.query(Chatty, Predicates.ALL);

This will return an array of messages that we can display in our UI.

Predicates also support filters for common types like Strings, Numbers and Lists.

Find all supported filters at Query with Predicates

Creating the UI

Now, let's look at how we can create the UI to create and display messages for our chat.

<template>
  <div v-for="message of sorted" :key="message.id">
    <div>{{ message.user }} - {{ moment(message.createdAt).format('YYYY-MM-DD HH:mm:ss')}})</div>
    <div>{{ message.message }}</div>
  </div>
</template>
<script>
import { Auth } from "aws-amplify";
import { DataStore, Predicates } from "@aws-amplify/datastore";
import { Chatty } from "./models";
import moment from "moment";

export default {
  name: 'app',
  data() {
    return {
      user: {},
      messages: [],
    }
  },
  computed: {
    sorted() {
      return [...this.messages].sort((a, b) => -a.createdAt.localeCompare(b.createdAt));
    }
  },
  created() {
    this.currentUser();
  },
  methods: {
    moment: () => moment(),
    currentUser() {
      Auth.currentAuthenticatedUser().then(user => {
        this.user = user;
        this.loadMessages();
      });
    },
    loadMessages() {
      DataStore.query(Chatty, Predicates.ALL).then(messages => {
        this.messages = messages;
      });
    },
  }
}
</script>

Creating a message

Now, let's look at how we can create new messages.

<template>
  <form v-on:submit.prevent>
    <input v-model="form.message" placeholder="Enter your message..." />
    <button @click="sendMessage">Send</button>
  </form>
</template>
<script>
export default {
  data() {
    return {
      form: {},
    };
  }, 
  methods: {
    sendMessage() {
      const { message } = this.form
      if (!message) return;
      DataStore.save(new Chatty({
        user: this.user.username,
        message: message,
        createdAt: new Date().toISOString()
      })).then(() => {
        this.form = { message: '' };
        this.loadMessages();
      }).catch(e => {
        console.log('error creating message...', e);
      });
    },
  }
}
</script>

Deleting all messages

One of the main advantages of working using Amplify DataStore is being able to run batch mutations without having to use a series of individual operations.

See below how we can use delete together with a predicate to remove all messages.

DataStore.delete(Chatty, Predicates.ALL).then(() => {
  console.log('messages deleted!');
});

GraphQL subscriptions

Next, let's see how we can create a subscription to subscribe to changes of data in our API.

To do so, we need to listen to the subscription, & update the state whenever a new piece of data comes in through the subscription.

When the component is destroyed we will unsubscribe to avoid memory leaks.

<script>
export default {
  data() {
    return {
      subscription: undefined;
    };
  },
  created() {
    //Subscribe to changes
    this.subscription = DataStore.observe(Chatty).subscribe(msg => {
      console.log(msg.model, msg.opType, msg.element);
      this.loadMessages();
    });
  }, 
  destroyed() {
    if (!this.subscription) return;
    this.subscription.unsubscribe();
  },
}
</script>

Deploying via the Amplify Console

We have looked at deploying via the Amplify CLI hosting category, but what about if we wanted continous deployment? For this, we can use the Amplify Console to deploy the application.

The first thing we need to do is create a new GitHub repo for this project. Once we've created the repo, we'll copy the URL for the project to the clipboard & initialize git in our local project:

git init

git remote add origin git@github.com:username/project-name.git

git add .

git commit -m 'initial commit'

git push origin master

Next we'll visit the Amplify Console in our AWS account at https://eu-central-1.console.aws.amazon.com/amplify/home.

Here, we'll click Get Started to create a new deployment. Next, authorize Github as the repository service.

Next, we'll choose the new repository & branch for the project we just created & click Next.

In the next screen, we'll create a new role & use this role to allow the Amplify Console to deploy these resources & click Next.

Finally, we can click Save and Deploy to deploy our application!

Now, we can push updates to Master to update our application.

Removing services

If at any time, or at the end of this workshop, you would like to delete a service from your project & your account, you can do this by running the amplify remove command:

amplify remove auth

amplify push

If you are unsure of what services you have enabled at any time, you can run the amplify status command:

amplify status

amplify status will give you the list of resources that are currently enabled in your app.

Appendix

Setting up your AWS Account

In order to follow this workshop you need to create and activate an Amazon Web Services account.

Follow the steps here

Trobleshooting

Message: The AWS Access Key Id needs a subscription for the service

Solution: Make sure you are subscribed to the free plan. Subscribe

Message: TypeError: fsevents is not a constructor

Solution: npm audit fix --force

Behaviour: data seems not to be synchronising with the cloud and or viceversa

Solution:

amplify update api
amplify push

Make sure you answer the following questions as

• Configure conflict detection? Y
• Select the default resolution strategy Auto Merge
• Do you want to override default per model settings? N