serverless-cloud

Example Project from A First Look at Serverless Cloud

Serverless Cloud is a new serverless app platform from Serverless, Inc. Unlike the company's initial product, the Serverless Framework, it does not deploy your application directly to AWS. Instead, your apps are instantly deployed and live on a new hosting service in the cloud with a dashboard and real-time logs.

Clone Repo and Navigate to Project

git clone https://github.com/ajcwebdev/a-first-look.git
cd deployment/serverless-cloud

Setup

Install Cloud CLI

Install @serverless/cloud from npm.

npm i -g @serverless/cloud

Initialize Service

Initialize your Serverless Cloud service with the cloud command.

cloud

Your browser will open automatically and log you in via the CLI or provide a login link in the terminal. Once you are connected you will be given an activation code to enter when prompted.

Deploy to staging environment

Give you service a name and deploy it with deploy dev in the interactive terminal.

deploy dev

You can also use cloud deploy dev if you want to clone this project from the repo and immediately deploy it.

cloud deploy dev

You will be given a deployed endpoint with a sample todo app.

Project Code

package.json

The @serverless/cloud package is included by default in the cloud runtime, so it does not need to be included as a dependency in package.json.

{
  "name": "ajcwebdev-serverless-cloud",
  "version": "1.0.0",
  "description": "Serverless Cloud todo api",
  "main": "index.js",
  "type": "module",
  "scripts": {
    "start": "cloud",
    "test": "cloud test"
  },
  "devDependencies": {
    "@jest/globals": "^27.1.0",
    "@serverless/cloud": "^0.0.22"
  },
  "serverless": {
    "org": "ajcwebdev",
    "service": "ajcwebdev-serverless-cloud"
  }
}

index.js

We import a handful of modules from @serverless/cloud at the top of our index.js file.

// index.js

import {
  api,
  data,
  schedule,
  params
} from '@serverless/cloud'

• api is used to build REST APIs.
  • api.get - GET method
  • api.post - POST method
  • api.delete - DELETE method
  • api.use - Middleware
• data is used to access Serverless Data.
  • data.get - Reads the data
  • data.getByLabel - Reads the data with a specified label
  • data.set - Writes the data to storage
  • data.remove - Deletes the data
• schedule is used to create scheduled tasks.
  • schedule.every - Runs on a specified interval of time such as every 60 minutes

getTodos function

This function can be reused in different API paths to get all the todos or to get a specific todo based on its label.

// index.js

const getTodos = async (status, meta) => {
  let result

  if (status === 'all') {
    result = await data.get('todo:*', meta)
  } else if (status === 'complete') {
    result =  await data.getByLabel('label1','complete:*', meta)
  } else {
    result = await data.getByLabel('label1','incomplete:*', meta)
  }

  return {
    items: result.items.map(
      item => item.value
    )
  }
}

GET todo items - /todos

This function calls our getTodos function with the status and returns the results.

// index.js

api.get('/todos', async (req, res) => {
  let result = await getTodos(
    req.query.status,
    req.query.meta ? true : {}
  )
  
  console.log(params.CLOUD_URL)

  res.send({
    items: result.items
  })
})

POST updates to a todo item - '/todos/:id'

This function takes the body of the request and sets it to data. The body can include a duedate. It also includes an id, createdAt date, and status that can be complete or incomplete. After setting the todo, the getTodos query is run again on all the todos and the updated list is returned.

// index.js

api.post('/todos/:id', async (req, res) => {
  console.log(new Date().toISOString())

  let body = req.body
  if (body.duedate) {
    body.duedate = new Date(body.duedate).toISOString()
  }

  await data.set(
    `todo:${req.params.id}`,
    {
      ...body,
      createdAt: Date.now()
    },
    Object.assign({},
      req.body.status ? 
        { 
          label1: body.status === 'complete'
            ? `complete:${new Date().toISOString()}` 
            : `incomplete:${body.duedate ? body.duedate : '9999' }` }
        : null
    )
  )
  
  let result = await getTodos(
    req.query.status
  )

  res.send({
    items: result.items
  })
})

DELETE a todo item - '/todos/:id'

This function deletes the todo with data.remove and then queries and returns the remaining todos in the list.

// index.js

api.delete('/todos/:id', async (req, res) => {
  await data.remove(`todo:${req.params.id}`)
  
  let result = await getTodos(req.query.status)

  res.send({
    items: result.items
  })
})

Custom error handler middleware

This function provides middleware for error handling. Errors are also streamed live to your terminal in dev mode.

// index.js

api.use((err, req, res, next) => {
  console.error(err.stack)

  if (!err.statusCode) {
    err.statusCode = 500
  }

  const error = {
    name: err.name,
    statusCode: err.statusCode,
    message: err.message,
  }

  res.status(err.statusCode).json(error)
})

Check for overdue todos hourly with schedule.every

Sometimes you might want to run code on a schedule, like if you want to send alerts when items are overdue. This function looks for items that are overdue, loops through the overdue items, and sends an alert if necessary.

// index.js

schedule.every("60 minutes", async () => {
  console.log(`Checking for overdue TODOs...`)

  let overdueItems = await data.getByLabel(
    'label1',
    `incomplete:<${new Date().toISOString()}`
  )

  if (overdueItems.items.length === 0) {
    console.log(`Nothing overdue!`)
  }

  for (let item of overdueItems.items) {
    console.log(
      `ALERT: '${item.value.name}' is overdue!!!`
    )
  }
})

Sample todos in data.json

{
  "key": "todo:1",

  "value": { 
    "id": "1", 
    "name": "Deploy an amazing Serverless Cloud app",
    "status": "complete",
    "completed": "2021-07-01T12:00:00.000Z",
    "createdAt": 1627316142196
  },

  "label1": "complete:2021-07-01T012:00:00.000Z"
},

Static assets

You can serve up static assets from the static folder. The folder currently contains:

• assets folder for images
• index.html to serve the main page
• styles.css for styling
• todos.js for all the React code so you can scare the backend developers on your team

Deploy to production with cloud deploy prod or deploy prod in the interactive terminal session.

cloud deploy prod

The link will be automatically pasted to your clipboard.

Dashboard

Since this is a cloud that means it has to have a dashboard.

Services - Serverless Cloud allows you to build services within your team's organization. You can create as many services as you want for different use cases or applications.

Instances - Each instance is completely separate from all the other instances in a service and store their own copy of the data. The environments within instances are identical, so you can ensure that your application will behave exactly the same across all of them.

Metrics - Invocations, errors, average latency, and throttles

Resources

• Documentation
• GitHub repository